mirror of
https://github.com/arsvendg/Stirling-PDF.git
synced 2026-09-13 20:25:28 +02:00
## Move editor under `frontend/editor/`
Pure restructure: `frontend/` becomes the workspace, `frontend/editor/`
holds
the PDF editor. 1775 file renames + 40 wiring edits. No logic changes.
### Why
`frontend/` is currently the editor — its `src/`, `public/`,
`src-tauri/`,
config files all sit at the root. Promoting `frontend/` to a
workspace and putting the editor in a sibling folder leaves room for
future
apps to drop in alongside it, sharing one `package.json` /
`node_modules` /
lint config / Storybook.
### What moves
frontend/
├── editor/ ← NEW: everything editor-specific
│ ├── src/ ← was frontend/src/
│ ├── public/ ← was frontend/public/
│ ├── src-tauri/ ← was frontend/src-tauri/
│ ├── index.html, vite.config.ts, vitest.config.ts, playwright.config.ts
│ ├── tsconfig*.json, tailwind.config.js, postcss.config.js
│ ├── scripts/
│ ├── .env, .env.desktop, .env.saas
│ └── DeveloperGuide.md
├── package.json, package-lock.json, node_modules/ ← workspace install
├── eslint.config.mjs, .prettierrc, .prettierignore ← shared tooling
├── .gitignore
└── README.md
### Wiring edits (40 files)
- `.taskfiles/frontend.yml`, `desktop.yml`, `e2e.yml`
- `build.gradle`, `app/core/build.gradle`
- `eslint.config.mjs`, `frontend/package.json`, `.gitignore`,
`.prettierignore`
- `docker/frontend/Dockerfile`
- 8 `.github/workflows/*.yml`, plus `.github/dependabot.yml`,
`.github/config/.files.yaml`, `.github/labeler-config-srvaroa.yml`
- `scripts/translations/**`
- Docs: `AGENTS.md`, `CLAUDE.md`, `ADDING_TOOLS.md`,
`DeveloperGuide.md`,
`WINDOWS_SIGNING.md`, `devGuide/HowToAddNewLanguage.md`,
`frontend/README.md`,
`frontend/editor/DeveloperGuide.md`
Plus 3 renamed + edited: `editor/vite.config.ts` (env path +
node_modules
walk-up), `editor/scripts/setup-env.mts` (renamed from `.ts` for
`import.meta.url`), `editor/scripts/build-provisioner.mjs` (resolve
src-tauri
relative to script).
### Verification
| Check | Result |
|---|---|
| `task frontend:typecheck:all` (6 variants) | exit 0 |
| `task frontend:lint` (eslint + dpdm) | exit 0 |
| `task frontend:format:check` | exit 0 |
| `task frontend:test` | 657 tests pass, 50 files |
| `task frontend:build:{core,proprietary,saas,desktop,prototypes}` | all
green |
| `task desktop:build` | full Tauri pipeline →
`Stirling-PDF_2.11.0_x64_en-US.msi` |
| `playwright test --list --project=stubbed` | 172 tests discovered |
`task desktop:build` exercises the heaviest path — Rust + WiX + MSI
bundle
against the moved `editor/src-tauri/`. If anything in the restructure
was
wrong it wouldn't have built.
### Test plan
- [ ] `frontend-validation.yml` green
- [ ] `e2e-stubbed.yml` green
- [ ] `tauri-build.yml` green on at least one platform
- [ ] `check_toml.yml` runs on a translation-touching PR
---------
Co-authored-by: Claude Opus 4.7 (1M context) <[email protected]>
483 lines
15 KiB
TypeScript
483 lines
15 KiB
TypeScript
import { describe, it, expect, beforeEach, vi, afterEach } from "vitest";
|
|
import {
|
|
consumePostLoginRedirectPath,
|
|
isSafePostLoginRedirect,
|
|
POST_LOGIN_REDIRECT_STORAGE_KEY,
|
|
setPostLoginRedirectPath,
|
|
springAuth,
|
|
} from "@app/auth/springAuthClient";
|
|
import { startOAuthNavigation } from "@app/extensions/oauthNavigation";
|
|
import apiClient from "@app/services/apiClient";
|
|
import {
|
|
AxiosError,
|
|
type AxiosResponse,
|
|
type InternalAxiosRequestConfig,
|
|
} from "axios";
|
|
|
|
// Mock apiClient
|
|
vi.mock("@app/services/apiClient");
|
|
vi.mock("@app/extensions/oauthNavigation", () => ({
|
|
startOAuthNavigation: vi.fn().mockResolvedValue(false),
|
|
}));
|
|
|
|
describe("SpringAuthClient", () => {
|
|
beforeEach(() => {
|
|
// Clear localStorage before each test
|
|
localStorage.clear();
|
|
// Clear all mocks
|
|
vi.clearAllMocks();
|
|
});
|
|
|
|
afterEach(() => {
|
|
vi.restoreAllMocks();
|
|
});
|
|
|
|
describe("getSession", () => {
|
|
it("should return null session when no JWT in localStorage", async () => {
|
|
const result = await springAuth.getSession();
|
|
|
|
expect(result.data.session).toBeNull();
|
|
expect(result.error).toBeNull();
|
|
expect(apiClient.get).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("should validate JWT and return session when JWT exists", async () => {
|
|
const mockToken = "mock-jwt-token";
|
|
const mockUser = {
|
|
id: "123",
|
|
email: "[email protected]",
|
|
username: "testuser",
|
|
role: "USER",
|
|
};
|
|
|
|
localStorage.setItem("stirling_jwt", mockToken);
|
|
|
|
vi.mocked(apiClient.get).mockResolvedValueOnce({
|
|
status: 200,
|
|
data: { user: mockUser },
|
|
} as unknown as AxiosResponse);
|
|
|
|
const result = await springAuth.getSession();
|
|
|
|
expect(apiClient.get).toHaveBeenCalledWith("/api/v1/auth/me", {
|
|
headers: { Authorization: `Bearer ${mockToken}` },
|
|
suppressErrorToast: true,
|
|
skipAuthRedirect: true,
|
|
});
|
|
expect(result.data.session).toBeTruthy();
|
|
expect(result.data.session?.user).toEqual(mockUser);
|
|
expect(result.data.session?.access_token).toBe(mockToken);
|
|
expect(result.error).toBeNull();
|
|
});
|
|
|
|
it("should clear invalid JWT on 401 error", async () => {
|
|
const mockToken = "invalid-jwt-token";
|
|
localStorage.setItem("stirling_jwt", mockToken);
|
|
|
|
const mockError = new AxiosError(
|
|
"Unauthorized",
|
|
"ERR_BAD_REQUEST",
|
|
undefined,
|
|
undefined,
|
|
{
|
|
status: 401,
|
|
statusText: "Unauthorized",
|
|
data: {},
|
|
headers: {},
|
|
config: {} as InternalAxiosRequestConfig,
|
|
},
|
|
);
|
|
|
|
vi.mocked(apiClient.get).mockRejectedValueOnce(mockError);
|
|
|
|
const result = await springAuth.getSession();
|
|
|
|
expect(localStorage.getItem("stirling_jwt")).toBeNull();
|
|
expect(result.data.session).toBeNull();
|
|
// 401 is handled gracefully, so error should be null
|
|
expect(result.error).toBeNull();
|
|
});
|
|
|
|
it("should clear invalid JWT on 403 error", async () => {
|
|
const mockToken = "forbidden-jwt-token";
|
|
localStorage.setItem("stirling_jwt", mockToken);
|
|
|
|
const mockError = new AxiosError(
|
|
"Forbidden",
|
|
"ERR_BAD_REQUEST",
|
|
undefined,
|
|
undefined,
|
|
{
|
|
status: 403,
|
|
statusText: "Forbidden",
|
|
data: {},
|
|
headers: {},
|
|
config: {} as InternalAxiosRequestConfig,
|
|
},
|
|
);
|
|
|
|
vi.mocked(apiClient.get).mockRejectedValueOnce(mockError);
|
|
|
|
const result = await springAuth.getSession();
|
|
|
|
expect(localStorage.getItem("stirling_jwt")).toBeNull();
|
|
expect(result.data.session).toBeNull();
|
|
// 403 is handled gracefully, so error should be null
|
|
expect(result.error).toBeNull();
|
|
});
|
|
});
|
|
|
|
describe("signInWithPassword", () => {
|
|
it("should successfully sign in with email and password", async () => {
|
|
const credentials = {
|
|
email: "[email protected]",
|
|
password: "password123",
|
|
};
|
|
|
|
const mockToken = "new-jwt-token";
|
|
const mockUser = {
|
|
id: "123",
|
|
email: credentials.email,
|
|
username: credentials.email,
|
|
role: "USER",
|
|
};
|
|
|
|
vi.mocked(apiClient.post).mockResolvedValueOnce({
|
|
status: 200,
|
|
data: {
|
|
user: mockUser,
|
|
session: {
|
|
access_token: mockToken,
|
|
expires_in: 3600,
|
|
},
|
|
},
|
|
} as unknown as AxiosResponse);
|
|
|
|
// Spy on window.dispatchEvent
|
|
const dispatchEventSpy = vi.spyOn(window, "dispatchEvent");
|
|
|
|
const result = await springAuth.signInWithPassword(credentials);
|
|
|
|
expect(apiClient.post).toHaveBeenCalledWith(
|
|
"/api/v1/auth/login",
|
|
{
|
|
username: credentials.email,
|
|
password: credentials.password,
|
|
},
|
|
{ withCredentials: true },
|
|
);
|
|
expect(localStorage.getItem("stirling_jwt")).toBe(mockToken);
|
|
expect(dispatchEventSpy).toHaveBeenCalledWith(
|
|
expect.objectContaining({ type: "jwt-available" }),
|
|
);
|
|
expect(result.user).toEqual(mockUser);
|
|
expect(result.session?.access_token).toBe(mockToken);
|
|
expect(result.error).toBeNull();
|
|
});
|
|
|
|
it("should return error on failed login", async () => {
|
|
const credentials = {
|
|
email: "[email protected]",
|
|
password: "wrongpassword",
|
|
};
|
|
|
|
const errorMessage = "Invalid credentials";
|
|
const mockError = Object.assign(new Error(errorMessage), {
|
|
isAxiosError: true,
|
|
response: {
|
|
status: 401,
|
|
data: { message: errorMessage },
|
|
},
|
|
});
|
|
|
|
vi.mocked(apiClient.post).mockRejectedValueOnce(mockError);
|
|
|
|
const result = await springAuth.signInWithPassword(credentials);
|
|
|
|
expect(result.user).toBeNull();
|
|
expect(result.session).toBeNull();
|
|
expect(result.error).toBeTruthy();
|
|
expect(result.error?.message).toBe(errorMessage);
|
|
});
|
|
});
|
|
|
|
describe("signUp", () => {
|
|
it("should successfully register new user", async () => {
|
|
const credentials = {
|
|
email: "[email protected]",
|
|
password: "newpassword123",
|
|
};
|
|
|
|
const mockUser = {
|
|
id: "456",
|
|
email: credentials.email,
|
|
username: credentials.email,
|
|
role: "USER",
|
|
};
|
|
|
|
vi.mocked(apiClient.post).mockResolvedValueOnce({
|
|
status: 200,
|
|
data: { user: mockUser },
|
|
} as unknown as AxiosResponse);
|
|
|
|
const result = await springAuth.signUp(credentials);
|
|
|
|
expect(apiClient.post).toHaveBeenCalledWith(
|
|
"/api/v1/user/register",
|
|
{
|
|
username: credentials.email,
|
|
password: credentials.password,
|
|
},
|
|
{ withCredentials: true },
|
|
);
|
|
expect(result.user).toEqual(mockUser);
|
|
expect(result.session).toBeNull(); // No auto-login on signup
|
|
expect(result.error).toBeNull();
|
|
});
|
|
|
|
it("should return error on failed registration", async () => {
|
|
const credentials = {
|
|
email: "[email protected]",
|
|
password: "password123",
|
|
};
|
|
|
|
const errorMessage = "User already exists";
|
|
const mockError = Object.assign(new Error(errorMessage), {
|
|
isAxiosError: true,
|
|
response: {
|
|
status: 409,
|
|
data: { message: errorMessage },
|
|
},
|
|
});
|
|
|
|
vi.mocked(apiClient.post).mockRejectedValueOnce(mockError);
|
|
|
|
const result = await springAuth.signUp(credentials);
|
|
|
|
expect(result.user).toBeNull();
|
|
expect(result.session).toBeNull();
|
|
expect(result.error).toBeTruthy();
|
|
expect(result.error?.message).toBe(errorMessage);
|
|
});
|
|
});
|
|
|
|
describe("signOut", () => {
|
|
it("should successfully sign out and clear JWT", async () => {
|
|
const mockToken = "jwt-to-clear";
|
|
localStorage.setItem("stirling_jwt", mockToken);
|
|
|
|
vi.mocked(apiClient.post).mockResolvedValueOnce({
|
|
status: 200,
|
|
data: {},
|
|
} as unknown as AxiosResponse);
|
|
|
|
const result = await springAuth.signOut();
|
|
|
|
expect(apiClient.post).toHaveBeenCalledWith(
|
|
"/api/v1/auth/logout",
|
|
null,
|
|
expect.objectContaining({ withCredentials: true }),
|
|
);
|
|
expect(localStorage.getItem("stirling_jwt")).toBeNull();
|
|
expect(result.error).toBeNull();
|
|
});
|
|
|
|
it("should clear JWT even if logout request fails", async () => {
|
|
const mockToken = "jwt-to-clear";
|
|
localStorage.setItem("stirling_jwt", mockToken);
|
|
|
|
vi.mocked(apiClient.post).mockRejectedValueOnce({
|
|
isAxiosError: true,
|
|
response: { status: 500 },
|
|
message: "Server error",
|
|
});
|
|
|
|
const result = await springAuth.signOut();
|
|
|
|
expect(localStorage.getItem("stirling_jwt")).toBeNull();
|
|
expect(result.error).toBeTruthy();
|
|
});
|
|
});
|
|
|
|
describe("refreshSession", () => {
|
|
it("should refresh JWT token successfully", async () => {
|
|
const newToken = "refreshed-jwt-token";
|
|
const mockUser = {
|
|
id: "123",
|
|
email: "[email protected]",
|
|
username: "testuser",
|
|
role: "USER",
|
|
};
|
|
|
|
vi.mocked(apiClient.post).mockResolvedValueOnce({
|
|
status: 200,
|
|
data: {
|
|
user: mockUser,
|
|
session: {
|
|
access_token: newToken,
|
|
expires_in: 3600,
|
|
},
|
|
},
|
|
} as unknown as AxiosResponse);
|
|
|
|
const result = await springAuth.refreshSession();
|
|
|
|
expect(localStorage.getItem("stirling_jwt")).toBe(newToken);
|
|
// Note: refreshSession does not dispatch jwt-available event, only notifies listeners
|
|
expect(result.data.session?.access_token).toBe(newToken);
|
|
expect(result.error).toBeNull();
|
|
});
|
|
|
|
it("should clear JWT and return error on 401", async () => {
|
|
localStorage.setItem("stirling_jwt", "expired-token");
|
|
|
|
vi.mocked(apiClient.post).mockRejectedValueOnce({
|
|
isAxiosError: true,
|
|
response: { status: 401 },
|
|
message: "Token expired",
|
|
});
|
|
|
|
const result = await springAuth.refreshSession();
|
|
|
|
expect(localStorage.getItem("stirling_jwt")).toBeNull();
|
|
expect(result.data.session).toBeNull();
|
|
expect(result.error).toBeTruthy();
|
|
});
|
|
});
|
|
|
|
describe("signInWithOAuth", () => {
|
|
it("should redirect to OAuth provider", async () => {
|
|
const mockAssign = vi.fn();
|
|
Object.defineProperty(window, "location", {
|
|
value: { assign: mockAssign },
|
|
writable: true,
|
|
});
|
|
|
|
vi.mocked(startOAuthNavigation).mockResolvedValueOnce(false);
|
|
|
|
const result = await springAuth.signInWithOAuth({
|
|
provider: "/oauth2/authorization/github",
|
|
options: { redirectTo: "/auth/callback" },
|
|
});
|
|
|
|
expect(startOAuthNavigation).toHaveBeenCalledWith(
|
|
"/oauth2/authorization/github",
|
|
);
|
|
expect(mockAssign).toHaveBeenCalledWith("/oauth2/authorization/github");
|
|
expect(result.error).toBeNull();
|
|
});
|
|
|
|
it("should skip redirect when handled by extension", async () => {
|
|
const mockAssign = vi.fn();
|
|
Object.defineProperty(window, "location", {
|
|
value: { assign: mockAssign },
|
|
writable: true,
|
|
});
|
|
|
|
vi.mocked(startOAuthNavigation).mockResolvedValueOnce(true);
|
|
|
|
const result = await springAuth.signInWithOAuth({
|
|
provider: "/oauth2/authorization/github",
|
|
options: { redirectTo: "/auth/callback" },
|
|
});
|
|
|
|
expect(startOAuthNavigation).toHaveBeenCalledWith(
|
|
"/oauth2/authorization/github",
|
|
);
|
|
expect(mockAssign).not.toHaveBeenCalled();
|
|
expect(result.error).toBeNull();
|
|
});
|
|
});
|
|
|
|
describe("post-login redirect path", () => {
|
|
beforeEach(() => {
|
|
sessionStorage.clear();
|
|
});
|
|
|
|
describe("isSafePostLoginRedirect", () => {
|
|
it("accepts same-origin paths with a single leading slash", () => {
|
|
expect(isSafePostLoginRedirect("/share/abc123")).toBe(true);
|
|
expect(isSafePostLoginRedirect("/workbench")).toBe(true);
|
|
expect(isSafePostLoginRedirect("/share/abc?x=1")).toBe(true);
|
|
});
|
|
|
|
it("rejects empty, null, or non-string values", () => {
|
|
expect(isSafePostLoginRedirect("")).toBe(false);
|
|
expect(isSafePostLoginRedirect(null)).toBe(false);
|
|
expect(isSafePostLoginRedirect(undefined)).toBe(false);
|
|
expect(isSafePostLoginRedirect(42 as unknown)).toBe(false);
|
|
});
|
|
|
|
it("rejects protocol-relative and absolute URLs (open-redirect guard)", () => {
|
|
expect(isSafePostLoginRedirect("//evil.example")).toBe(false);
|
|
expect(isSafePostLoginRedirect("http://evil.example")).toBe(false);
|
|
expect(isSafePostLoginRedirect("https://evil.example/x")).toBe(false);
|
|
expect(isSafePostLoginRedirect("/\\evil")).toBe(false);
|
|
});
|
|
|
|
it("rejects auth-plumbing paths to avoid login loops", () => {
|
|
expect(isSafePostLoginRedirect("/login")).toBe(false);
|
|
expect(isSafePostLoginRedirect("/login?foo=1")).toBe(false);
|
|
expect(isSafePostLoginRedirect("/auth/callback")).toBe(false);
|
|
expect(isSafePostLoginRedirect("/oauth2/authorization/google")).toBe(
|
|
false,
|
|
);
|
|
expect(isSafePostLoginRedirect("/saml2/authenticate/x")).toBe(false);
|
|
});
|
|
});
|
|
|
|
describe("setPostLoginRedirectPath", () => {
|
|
it("stores a safe path in sessionStorage", () => {
|
|
setPostLoginRedirectPath("/share/abc123");
|
|
expect(sessionStorage.getItem(POST_LOGIN_REDIRECT_STORAGE_KEY)).toBe(
|
|
"/share/abc123",
|
|
);
|
|
});
|
|
|
|
it("clears any existing entry when given an unsafe value", () => {
|
|
sessionStorage.setItem(POST_LOGIN_REDIRECT_STORAGE_KEY, "/share/old");
|
|
setPostLoginRedirectPath("//evil.example");
|
|
expect(
|
|
sessionStorage.getItem(POST_LOGIN_REDIRECT_STORAGE_KEY),
|
|
).toBeNull();
|
|
});
|
|
|
|
it("clears any existing entry when given null", () => {
|
|
sessionStorage.setItem(POST_LOGIN_REDIRECT_STORAGE_KEY, "/share/old");
|
|
setPostLoginRedirectPath(null);
|
|
expect(
|
|
sessionStorage.getItem(POST_LOGIN_REDIRECT_STORAGE_KEY),
|
|
).toBeNull();
|
|
});
|
|
});
|
|
|
|
describe("consumePostLoginRedirectPath", () => {
|
|
it("returns the stored path and clears it (single-use)", () => {
|
|
sessionStorage.setItem(
|
|
POST_LOGIN_REDIRECT_STORAGE_KEY,
|
|
"/share/abc123",
|
|
);
|
|
expect(consumePostLoginRedirectPath()).toBe("/share/abc123");
|
|
expect(
|
|
sessionStorage.getItem(POST_LOGIN_REDIRECT_STORAGE_KEY),
|
|
).toBeNull();
|
|
});
|
|
|
|
it("returns null (and still clears) when the stored value is unsafe", () => {
|
|
sessionStorage.setItem(
|
|
POST_LOGIN_REDIRECT_STORAGE_KEY,
|
|
"//evil.example",
|
|
);
|
|
expect(consumePostLoginRedirectPath()).toBeNull();
|
|
expect(
|
|
sessionStorage.getItem(POST_LOGIN_REDIRECT_STORAGE_KEY),
|
|
).toBeNull();
|
|
});
|
|
|
|
it("returns null when nothing is stored", () => {
|
|
expect(consumePostLoginRedirectPath()).toBeNull();
|
|
});
|
|
});
|
|
});
|
|
});
|