CI / verify (pull_request) Successful in 49s
CI / infrastructure-smoke (pull_request) Successful in 13s
CI / migration-smoke (pull_request) Successful in 1m47s
CI / image-build (pull_request) Successful in 19s
CI / deploy-smoke (same-origin) (pull_request) Successful in 49s
CI / deploy-smoke (split) (pull_request) Successful in 1m4s
An installation can now serve the Dashboard and the API on sibling hostnames (dash./api.) beside the default same-origin topology, from one image and with configuration alone. - The Dashboard learns its API origin at run time: the built page carries one empty <meta name="ekklesia-api-origin">, which the API fills with its identity base URL's origin at startup, before computing the page's ETag. The shell accepts only a canonical http(s) origin and otherwise fails closed without making a request. The build-time EKKLESIA_API_BASE_URL is gone from the bundle; the development server injects the same element. - The display host stays on the API's origin, so its device cookies, requests, and offline cache are unchanged. - The API trusts its own origin (trusted origins plus the identity base URL), as Better Auth already does, so the display page's mutations pass the origin check without operators listing it. - Doctor validates EKKLESIA_DASHBOARD_ORIGIN exactly as the API's startup does (it previously skipped it), reports the topology without printing hostnames, and warns when split hostnames are not siblings. - The module UI contract states the CORS header limit (safelisted headers plus Content-Type, safelisted response headers only). - Reference deployment: Caddyfile.split.example (Dashboard hostname serves / and its script; API hostname serves /api/*, /display/*, and the display script; each refuses the other's paths) and EKKLESIA_DASHBOARD_HOSTNAME in the proxy overlay and env examples. - The deploy smoke test runs either topology (CI runs both). The split run installs the module template as a test-only module, checks per-hostname routing and exact CORS, then drives a digest-pinned headless Chromium over the DevTools protocol, with no added dependency: sign-in on the Dashboard hostname, the session cookie host-only on the API hostname, the module UI imported cross-origin and its credentialed request succeeding, the display and its service worker on the API hostname, and sign-out. ADR 0045 is marked Accepted. Co-Authored-By: Claude Opus 5.5 <[email protected]>
132 lines
5.0 KiB
TypeScript
132 lines
5.0 KiB
TypeScript
import { createHash } from "node:crypto";
|
|
import { beforeEach, describe, expect, it, vi } from "vitest";
|
|
|
|
const readFileMock = vi.hoisted(() => vi.fn());
|
|
|
|
vi.mock("node:fs/promises", () => ({ readFile: readFileMock }));
|
|
vi.mock("@ekklesia/shell/dashboard-assets", () => ({
|
|
dashboardHostAssetUrls: Object.freeze({
|
|
html: "file:///surface/browser/index.html",
|
|
script: "file:///surface/browser/assets/ekklesia-dashboard/app.js",
|
|
}),
|
|
}));
|
|
|
|
import {
|
|
createDashboardHostAssets,
|
|
DASHBOARD_API_ORIGIN_PLACEHOLDER,
|
|
DashboardHostAssetError,
|
|
loadDashboardHostAssets,
|
|
renderDashboardPage,
|
|
} from "../src/dashboard-host-assets.js";
|
|
|
|
const API_ORIGIN = "https://api.example.test";
|
|
|
|
function sha256Etag(text: string): string {
|
|
return `"${createHash("sha256").update(text).digest("base64url")}"`;
|
|
}
|
|
|
|
describe("Dashboard host asset loading", () => {
|
|
beforeEach(() => readFileMock.mockReset());
|
|
|
|
it("reads only the two declared file URLs in order and freezes one consistent snapshot", async () => {
|
|
const html = `<!doctype html>${DASHBOARD_API_ORIGIN_PLACEHOLDER}<div id="ekklesia-host"></div>`;
|
|
const script = "export const dashboardHost = true;\n";
|
|
readFileMock.mockResolvedValueOnce(html).mockResolvedValueOnce(script);
|
|
|
|
const assets = await loadDashboardHostAssets(API_ORIGIN);
|
|
|
|
expect(readFileMock.mock.calls).toEqual([
|
|
[new URL("file:///surface/browser/index.html"), "utf8"],
|
|
[new URL("file:///surface/browser/assets/ekklesia-dashboard/app.js"), "utf8"],
|
|
]);
|
|
const rendered = `<!doctype html><meta content="${API_ORIGIN}" name="ekklesia-api-origin" /><div id="ekklesia-host"></div>`;
|
|
expect(assets).toEqual({
|
|
html: rendered,
|
|
htmlEtag: sha256Etag(rendered),
|
|
script,
|
|
scriptEtag: sha256Etag(script),
|
|
});
|
|
expect(Object.isFrozen(assets)).toBe(true);
|
|
});
|
|
|
|
it("fails deterministically without attempting a neighboring file or exposing the read error", async () => {
|
|
readFileMock.mockRejectedValueOnce(
|
|
new Error("ENOENT /home/operator/private/surface-build secret-token"),
|
|
);
|
|
|
|
const failure = await loadDashboardHostAssets(API_ORIGIN).catch((error: unknown) => error);
|
|
|
|
expect(readFileMock).toHaveBeenCalledTimes(1);
|
|
expect(failure).toBeInstanceOf(DashboardHostAssetError);
|
|
expect(failure).toMatchObject({
|
|
code: "DASHBOARD_HOST_ASSET_UNAVAILABLE",
|
|
message: "The Dashboard host browser assets are unavailable.",
|
|
name: "DashboardHostAssetError",
|
|
});
|
|
expect((failure as Error).stack).toBe(
|
|
"DashboardHostAssetError: The Dashboard host browser assets are unavailable.",
|
|
);
|
|
const publicText = `${String(failure)}\n${JSON.stringify(failure)}\n${(failure as Error).stack}`;
|
|
for (const secret of ["/home/", "operator", "ENOENT", "secret-token"]) {
|
|
expect(publicText).not.toContain(secret);
|
|
}
|
|
});
|
|
|
|
it("fails when the script is missing even though the page was read", async () => {
|
|
readFileMock
|
|
.mockResolvedValueOnce(`<!doctype html>${DASHBOARD_API_ORIGIN_PLACEHOLDER}`)
|
|
.mockRejectedValueOnce(new Error("ENOENT app.js"));
|
|
|
|
await expect(loadDashboardHostAssets(API_ORIGIN)).rejects.toBeInstanceOf(
|
|
DashboardHostAssetError,
|
|
);
|
|
expect(readFileMock).toHaveBeenCalledTimes(2);
|
|
});
|
|
|
|
it("rejects an empty page or script as an unavailable shell build", () => {
|
|
for (const [html, script] of [
|
|
["", "export {};"],
|
|
["<html></html>", " \n"],
|
|
] as const) {
|
|
expect(() => createDashboardHostAssets(html, script)).toThrow(DashboardHostAssetError);
|
|
}
|
|
});
|
|
|
|
it("fails startup on a page without exactly one empty API-origin element (ADR 0045)", async () => {
|
|
for (const html of [
|
|
"<!doctype html>",
|
|
`<!doctype html>${DASHBOARD_API_ORIGIN_PLACEHOLDER}${DASHBOARD_API_ORIGIN_PLACEHOLDER}`,
|
|
'<!doctype html><meta content="https://elsewhere.test" name="ekklesia-api-origin" />',
|
|
]) {
|
|
readFileMock.mockReset();
|
|
readFileMock.mockResolvedValueOnce(html).mockResolvedValueOnce("export {};\n");
|
|
await expect(loadDashboardHostAssets(API_ORIGIN)).rejects.toBeInstanceOf(
|
|
DashboardHostAssetError,
|
|
);
|
|
}
|
|
});
|
|
});
|
|
|
|
describe("Dashboard page API origin (ADR 0045)", () => {
|
|
const page = `<head>${DASHBOARD_API_ORIGIN_PLACEHOLDER}</head>`;
|
|
|
|
it("writes the API's origin into the one placeholder, in either topology", () => {
|
|
expect(renderDashboardPage(page, "https://api.example.test")).toBe(
|
|
'<head><meta content="https://api.example.test" name="ekklesia-api-origin" /></head>',
|
|
);
|
|
expect(renderDashboardPage(page, "http://127.0.0.1:3000")).toBe(
|
|
'<head><meta content="http://127.0.0.1:3000" name="ekklesia-api-origin" /></head>',
|
|
);
|
|
});
|
|
|
|
it.each([
|
|
"https://api.example.test/",
|
|
"https://api.example.test/api",
|
|
'https://api.example.test"><script>',
|
|
"javascript:alert(1)",
|
|
"",
|
|
])("refuses a value that is not a canonical http(s) origin: %s", (origin) => {
|
|
expect(() => renderDashboardPage(page, origin)).toThrow(DashboardHostAssetError);
|
|
});
|
|
});
|