Files
clean-architecture-frontend…/tests/unit/service-worker-build-output.test.ts
T
DongHyeonka 1b6c9a5c95 test(hosting): 워커를 싣는 빌드의 SW 스크립트 헤더 검사를 고정한다 (0929/06-05)
문제
새 워커와 자기 해제 워커는 페이지 없이 클라이언트를 복구하는 유일한
경로다. edge가 루트 `.js`를 길게 캐시하면 그 TTL 동안 롤백과 비상 해제가
늦어진다. 0929/06-05는 SW 선택이 ACTIVE·REMOVE_REGISTRATION인 구성에서
cache policy에 `service-worker.js`(no-cache, JS MIME) 항목과 live probe
확인을 요구했다.

이미 된 것(629c8f0, 1101/13-04)
- config/hosting/cache-policy.json의 `serviceWorker` 표면: path
  `/service-worker.js`, `no-cache`, `text/javascript`·
  `application/javascript`, `requiredWhen: "service-worker-shipped"`
- verify-hosting-headers.ts는 shipsServiceWorker(ACTIVE,
  REMOVE_REGISTRATION)일 때만 이 표면을 요구하고, live 모드에서는
  probeLiveRelease가 그 경로를 요청해 같은 헤더 검사를 거친다
- 그 커밋은 SW null 트리에서만 돌려 "serviceWorker 헤더 검사는 건너뜀"으로
  기록했다. 워커를 켠 구성에서 이 검사가 실제로 실패하는지는 아무도
  확인하지 않았다.

고른 방법
남은 부분은 완료 기준의 증명이다. service-worker-build-output.test.ts가
이미 만드는 SW ACTIVE 빌드(임시 복사본, 추가 빌드 없음)에서
verify-hosting-headers.ts를 fixture 모드로 돌린다.
- 선언대로의 fixture: 실패 0, UNVERIFIED(rc=3)
- `serviceWorker` Cache-Control을 `public, max-age=31536000, immutable`로
  바꾼 fixture: `serviceWorker cache-control` 하나로 FAIL(rc=1)

버린 대안
- 헤더 검사 루프를 함수로 빼서 단위 테스트: 스크립트 구조를 바꾸고도
  INSTALLED_RUNTIME_CAPABILITIES를 거치는 실제 경로는 증명하지 못한다.
- 산출물 스키마가 워커를 싣는 빌드에 serviceWorker 헤더 결과를 요구:
  정책 파일의 항목은 hosting-probe.test.ts가 이미 고정한다. 같은 것을
  두 곳에서 지키게 된다.

위험·한계
- REMOVE_REGISTRATION 빌드는 따로 돌리지 않았다. 표면 요구 조건은
  ACTIVE와 같은 shipsServiceWorker 한 함수이고, 그 함수의 두 모드는
  hosting-probe.test.ts가 확인한다.
- 실제 CDN·호스트 응답은 확인하지 않았다(live 모드 미실행).

검증
- RED(629c8f0 이전 상태 재현: cache-policy.json에서 serviceWorker 항목을
  지움): node scripts/run-vitest.ts run
  tests/unit/service-worker-build-output.test.ts → 1 failed / 6 passed,
  "expected [] to deeply equal [ 'serviceWorker cache-control' ]"
- GREEN(항목 복원): 같은 파일과 hosting-probe.test.ts 29 passed
- tsc(test) 0, eslint 바뀐 파일 0

Refs: docs/reviews/2026-09-29-maturity-review/06-adapters-service-worker-push.md 06-05
2026-11-03 00:56:00 +09:00

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("config/hosting/response-headers.fixture.json", "utf8"),
) as { responses: Record<string, Record<string, string>> };
fixture.responses["serviceWorker"]!["cache-control"] = workerCacheControl;
await writeFile(
path.join(root, "config/hosting/response-headers.fixture.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/installed-runtime-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 });
}
});
});