루트 항목 하나를 옮기려면 코드 7곳의 루트 경로 목록을 같이 고쳐야 했다(복사 대상, 비밀값 검사 범위, 공급망 시험의 필수 입력, 이력 문서 검사, 규모 입력, vite 입력, TS 전용 규칙). 서로 다른 부분집합이고 한 곳에서 선언하지 않았다. 목록이 갈라져 공급망 생성이 깨진 적도 있다 (removal-fixture.ts 주석). 루트에는 JSON Schema 5개만 담은 `schemas/`가 `config/` 옆에 따로 있었다. `artifacts/`(출력 폴더)에는 사람이 쓴 수동 a11y 기록이, `config/hosting/`(호스트 계약)에는 시험 fixture가 섞였다. 고른 방법(design-docs repo-structure/04-frontend-layout.md 9.2절 3단계, 11절 R1·R2, 소유자 승인 2026-11-07): - `config/repository-layout.json`이 루트 항목마다 종류·역할·읽는 곳과 들어가는 목록(`sets`, 항목 안 경로는 `setPaths`)을 적는다. `scripts/lib/repository-layout.ts`가 읽고 검증한다. 6곳은 이름 붙은 집합을 고른다. JSON인 비밀값 검사 정책은 집합의 사본을 두고 시험이 같은지 본다(정책 파일은 릴리스 후보에 실려 형식을 바꾸지 않았다). 공급망 시험의 필수 입력 목록은 그 시험으로 대신한다. - `tests/unit/repository-layout.test.ts`: 등록부에 없는 루트 항목이 추적되면 실패(R1). 7곳이 등록부 모듈을 쓰고 루트 이름 둘 이상의 문자열 배열을 갖지 않는지(R2). - `schemas/artifacts/` → `config/schemas/artifacts/`, recipe 카탈로그 스키마 → `config/schemas/recipes/`. 정책 입력 순서(ASCII)에 맞춰 `config/schemas/`가 `config/security/` 앞에 온다. - 수동 a11y 기록 3개 → `docs/accessibility/route-reviews/`. `artifacts/`는 `.gitkeep`만 추적한다. 기록은 단위 시험이 읽어서 drill 사본에도 복사한다(`fixture-copy` 집합의 `docs/accessibility/route-reviews`). - `config/hosting/response-headers.fixture.json` → `tests/fixtures/hosting/response-headers.json`. 버린 것: 비밀값 검사 정책이 집합 이름을 참조하게 바꾸는 방법. 정책 파일은 릴리스 후보와 로컬 증거 평가가 읽는 형식이라 바꾸면 릴리스 증거 계약이 바뀐다. 루트 항목이 지워졌는데 등록부에 남는 경우는 시험하지 않았다. drill 사본은 일부만 복사해 그 방향을 볼 수 없다. 그런 항목은 그 집합을 쓰는 곳(복사, 비밀값 검사)에서 실패한다. 위험: 하네스 작업(fe-c)이 더할 `AGENTS.md`·`.claude/`를 미리 등록했다 (optional). 등록부가 이력 문서(`SPEC.md`)와 `CLAUDE.md` 이름을 적어서 이력 문서 검사에서 등록부 파일은 뺐다. 다운스트림은 자기 루트 항목을 등록부에 더해야 한다(CHANGELOG). CI 계약 기준선을 다시 받았다(a11y 기록 산출물 id·경로). 검증(desktop): 아래 4단계 커밋까지 쌓은 트리에서 test:unit, check:types, check:ci, lint, verify:documentation을 돌렸다(그 커밋에 적음). 이 커밋 단독으로 test:unit·check:ci·check:types를 돌렸다. Refs: design-docs repo-structure/04-frontend-layout.md 2.4·9.2·11절, README.md 3.4절
195 lines
6.9 KiB
TypeScript
195 lines
6.9 KiB
TypeScript
import { spawnSync } from "node:child_process";
|
|
import {
|
|
access,
|
|
mkdir,
|
|
mkdtemp,
|
|
readFile,
|
|
rm,
|
|
symlink,
|
|
writeFile,
|
|
} from "node:fs/promises";
|
|
import { tmpdir } from "node:os";
|
|
import path from "node:path";
|
|
|
|
import { afterAll, beforeAll, describe, expect, it } from "vitest";
|
|
|
|
import { generateRuntimeConfig } from "../../scripts/generate-runtime-config.ts";
|
|
import {
|
|
type FixtureBuilds,
|
|
prepareFixtureBuilds,
|
|
removeFixtureBuilds,
|
|
} from "../e2e/support/fixture-builds.ts";
|
|
import {
|
|
ACTIVE_VALUE,
|
|
turnOnServiceWorker,
|
|
} from "../e2e/support/service-worker-builds.ts";
|
|
|
|
/**
|
|
* 0929/06-01. Step 6 of `scripts/build-frontend.ts`, the Service Worker Vite
|
|
* build, must not change the app output. Vite copies `public/` into `outDir`
|
|
* unless the config turns it off, so the worker build replaced the profile
|
|
* `dist/config.json` from step 4 with `public/config.json` (local, demo auth,
|
|
* loopback API, root release manifest). The build and `verify-release` passed;
|
|
* only release admission refused it.
|
|
*
|
|
* The defect is in how two Vite runs share `dist`, not in one function, so this
|
|
* runs the real build over a temp copy with the worker on (one build, ~2s).
|
|
* A check of `publicDir === false` on the config object would only restate the
|
|
* fix, and the config cannot load without the inputs step 5 generates.
|
|
*/
|
|
const PROFILE = Object.freeze({
|
|
APP_PROFILE: "production",
|
|
VITE_ROUTER_BASE_PATH: "/app/",
|
|
});
|
|
// prepareFixtureBuilds sets VITE_BUILD_ID and RELEASE_ID to `<prefix>-<name>`.
|
|
const BUILD_ID = "sw-profile-active";
|
|
|
|
let builds: FixtureBuilds<"active"> | undefined;
|
|
|
|
beforeAll(async () => {
|
|
builds = await prepareFixtureBuilds("sw-profile", [
|
|
{
|
|
name: "active",
|
|
env: PROFILE,
|
|
edit: turnOnServiceWorker,
|
|
},
|
|
]);
|
|
}, 180_000);
|
|
|
|
afterAll(async () => {
|
|
await removeFixtureBuilds(builds);
|
|
});
|
|
|
|
describe("Service Worker build output (0929/06-01, 0929/06-02)", () => {
|
|
it("keeps the profile runtime config step 4 wrote", async () => {
|
|
const dist = builds!.dist.active;
|
|
// The worker build really ran; otherwise nothing below tests step 6.
|
|
await access(path.join(dist, "service-worker.js"));
|
|
|
|
const shipped: unknown = JSON.parse(
|
|
await readFile(path.join(dist, "config.json"), "utf8"),
|
|
);
|
|
expect(shipped).toEqual(
|
|
await generateRuntimeConfig("production", {
|
|
...process.env,
|
|
...PROFILE,
|
|
VITE_BUILD_ID: BUILD_ID,
|
|
RELEASE_ID: BUILD_ID,
|
|
}),
|
|
);
|
|
});
|
|
|
|
// 0929/06-02. Under /app/ the worker must precache /app/assets/... and know
|
|
// /app/config.json; root URLs 404 at install and the worker never installs.
|
|
it("gives the worker URLs under the router base path", async () => {
|
|
const generated = (await import(
|
|
path.join(
|
|
builds!.root,
|
|
".generated/frontend-runtime/service-worker-assets.ts",
|
|
)
|
|
)) as { SERVICE_WORKER_ASSETS: { assets: readonly { url: string }[] } };
|
|
const urls = generated.SERVICE_WORKER_ASSETS.assets.map((asset) => asset.url);
|
|
expect(urls.length).toBeGreaterThan(0);
|
|
expect(urls.filter((url) => !url.startsWith("/app/assets/"))).toEqual([]);
|
|
|
|
const worker = await readFile(
|
|
path.join(builds!.dist.active, "service-worker.js"),
|
|
"utf8",
|
|
);
|
|
// Property names survive minification; the quote style does not.
|
|
expect(
|
|
/runtimeConfigUrl:\s*["'`]([^"'`]*)["'`]/u.exec(worker)?.[1],
|
|
).toBe("/app/config.json");
|
|
});
|
|
});
|
|
|
|
// 0929/06-05. A new worker and the self-unregistering one are the only way to
|
|
// recover a client without a page. Served from an edge that caches root `.js`
|
|
// for long, they stay out of reach for that TTL, so a build that ships a
|
|
// worker has its script's Cache-Control checked like the page's.
|
|
describe("worker script hosting headers (0929/06-05)", () => {
|
|
async function verifyHosting(workerCacheControl: string) {
|
|
const root = builds!.root;
|
|
await rm(path.join(root, "dist"), { recursive: true, force: true });
|
|
await symlink(builds!.dist.active, path.join(root, "dist"));
|
|
const fixture = JSON.parse(
|
|
await readFile("tests/fixtures/hosting/response-headers.json", "utf8"),
|
|
) as { responses: Record<string, Record<string, string>> };
|
|
fixture.responses["serviceWorker"]!["cache-control"] = workerCacheControl;
|
|
await writeFile(
|
|
path.join(root, "tests/fixtures/hosting/response-headers.json"),
|
|
JSON.stringify(fixture),
|
|
);
|
|
const env: NodeJS.ProcessEnv = { ...process.env };
|
|
delete env["HOSTING_BASE_URL"];
|
|
const result = spawnSync(process.execPath, ["scripts/verify-hosting-headers.ts"], {
|
|
cwd: root,
|
|
encoding: "utf8",
|
|
env,
|
|
});
|
|
const record = JSON.parse(
|
|
await readFile(path.join(root, "artifacts/release/hosting-headers.json"), "utf8"),
|
|
) as { results: { surface: string; header: string; passed: boolean }[] };
|
|
return {
|
|
status: result.status,
|
|
stderr: result.stderr,
|
|
failed: record.results
|
|
.filter((entry) => !entry.passed)
|
|
.map((entry) => `${entry.surface} ${entry.header}`),
|
|
};
|
|
}
|
|
|
|
it("leaves the declared worker headers UNVERIFIED, not failed", async () => {
|
|
const result = await verifyHosting("no-cache");
|
|
expect(result.failed, result.stderr).toEqual([]);
|
|
expect(result.status).toBe(3);
|
|
});
|
|
|
|
it("fails when the worker script is served with a long TTL", async () => {
|
|
const result = await verifyHosting("public, max-age=31536000, immutable");
|
|
expect(result.failed).toEqual(["serviceWorker cache-control"]);
|
|
expect(result.status).toBe(1);
|
|
});
|
|
});
|
|
|
|
// 0929/06-04, 0929/11-03. The worker fixtures must also run in a product that
|
|
// already ships the worker: an inactive selection is turned on, and an ACTIVE
|
|
// one is kept so the specs exercise that product's own handlers.
|
|
describe("turnOnServiceWorker (0929/06-04, 0929/11-03)", () => {
|
|
const productActive = `{
|
|
mode: "ACTIVE",
|
|
scriptPath: "service-worker.js",
|
|
handlers: ["PWA_STATIC_ASSETS", "OFFLINE_SYNC_WAKEUP"],
|
|
}`;
|
|
it.each([
|
|
["null", "null", ACTIVE_VALUE],
|
|
[
|
|
"REMOVE_REGISTRATION",
|
|
`{
|
|
mode: "REMOVE_REGISTRATION",
|
|
scriptPath: "service-worker.js",
|
|
}`,
|
|
ACTIVE_VALUE,
|
|
],
|
|
["ACTIVE", productActive, productActive],
|
|
])("turns a %s selection on", async (_label, value, expected) => {
|
|
const root = await mkdtemp(path.join(tmpdir(), "sw-select-"));
|
|
try {
|
|
const file = path.join(
|
|
root,
|
|
"src/features/product-capabilities.ts",
|
|
);
|
|
await mkdir(path.dirname(file), { recursive: true });
|
|
const around = (selection: string) =>
|
|
`const WEB_WORKERS = Object.freeze([]);\n\nconst SERVICE_WORKER: InstalledServiceWorkerSelection | null = ${selection};\n\nconst OFFLINE_COMMANDS: X | null = null;\n`;
|
|
await writeFile(file, around(value));
|
|
|
|
await turnOnServiceWorker(root);
|
|
|
|
expect(await readFile(file, "utf8")).toBe(around(expected));
|
|
} finally {
|
|
await rm(root, { recursive: true, force: true });
|
|
}
|
|
});
|
|
});
|