Files
clean-architecture-frontend…/tests/unit/service-worker-build-output.test.ts
DongHyeonka ceaf316f65
frontend-quality-gates / merge / static checks (pull_request) Canceled after 0s
frontend-quality-gates / merge / tests (pull_request) Canceled after 0s
frontend-quality-gates / merge / browser tests (pull_request) Canceled after 0s
frontend-quality-gates / FE-GATE-014 / config-compatibility (pull_request) Canceled after 0s
frontend-quality-gates / FE-GATE-026 / lab-performance (pull_request) Canceled after 0s
frontend-quality-gates / FE-GATE-028 / manual-accessibility-review (pull_request) Canceled after 0s
frontend-quality-gates / FE-GATE-015 / immutable-release-candidate (pull_request) Canceled after 0s
frontend-quality-gates / external-vulnerability-provider (pull_request) Canceled after 0s
frontend-quality-gates / external-provenance-provider (pull_request) Canceled after 0s
frontend-quality-gates / promote-verified-immutable-candidate (pull_request) Canceled after 0s
frontend-quality-gates / deploy-promoted-release (pull_request) Canceled after 0s
frontend-quality-gates / main / self-tests and removal drills (pull_request) Canceled after 0s
frontend-quality-gates / FE-GATE-019 / hosting-header (pull_request) Canceled after 0s
frontend-quality-gates / FE-GATE-021 / runbook-boot-config (pull_request) Canceled after 0s
frontend-quality-gates / FE-GATE-022 / runbook-chunk-mismatch (pull_request) Canceled after 0s
frontend-quality-gates / FE-GATE-023 / runbook-api-degradation (pull_request) Canceled after 0s
frontend-quality-gates / FE-GATE-024 / runbook-telemetry (pull_request) Canceled after 0s
frontend-quality-gates / FE-GATE-025 / runbook-release-rollback (pull_request) Canceled after 0s
frontend-quality-gates / FE-GATE-018 / field-web-vitals (pull_request) Canceled after 0s
frontend-quality-gates / FE-GATE-017 / diagram-review (pull_request) Canceled after 0s
test(setup): 시험 timeout을 모두 desktop 실측값으로 주고 손 숫자를 거절한다
문제: 자식 프로세스 시험의 timeout은 `childProcessTimeout(<잰 ms>)`로
정한다(docs/work/reference/testing.md 2절). 그런데 기본값이 아니라서
`tests/setup.ts` 검사에 걸리지 않는 손 숫자가 남았다. 리뷰가 센 54곳 중
둘(`browser-soak.contract.test.ts`의 `evaluateSoak` 인자)은 timeout이 아니고,
AST로 다시 세면 80곳이다: 시험·describe·hook에 쓴 숫자, `VERIFY_TIMEOUT`·
`PROCESS_HEAVY_TIMEOUT_MS`(파일 넷에 따로)·`PROVIDER_BASE_FIXTURE_TIMEOUT_MS`
같은 상수, `PROCESS_WATCHDOG_MS * 3` 같은 식. taxonomy는 옛 상수를 예로
들었다. 실측으로 보면 손 숫자 하나가 모자랐다: system 시험의 provider 묶음
30초는 desktop 여섯 번 중 두 번 넘겼다.

고친 것:
- 80곳을 desktop에서 잰 가장 긴 실행으로 `childProcessTimeout(<ms>)`에
  넘긴다. coverage 묶음(maxWorkers=4)·test:unit 각 9회, integration 3회,
  scale(traffic·session·composition·global-local) 3회, 시스템 컨테이너의
  tests/system 6회, JSON reporter로 받았다. hook은 파일 시간에서 시험 합을
  뺀 값이다. 시간 초과로 끝난 실행은 그 시간을 하한으로 넣었다.
- 상수 사본은 지운다. 한 파일 안에서 여럿이 쓰는 값만
  `const X = childProcessTimeout(...)`로 둔다(`VERIFY_TIMEOUT`). guardian
  시험의 lease는 시험 timeout이 아니라 `childProcessTimeout(0)`(helper의 최소
  30초)로 둔다.
- `tests/unit/test-timeout-declarations.test.ts`가 tests/의 Vitest 파일을
  Babel로 읽어 시험·describe·hook의 timeout 인자가 helper 호출(또는 그것을
  담은 파일 상수)이 아니면 파일과 줄로 실패한다. 프로세스 안에서 도는 긴
  시험(scale tier)도 같은 helper를 쓴다.
- taxonomy 예시, testing.md 2절, `.claude/rules/tests.md` 9번, helper 머리
  주석을 같은 방법으로 맞춘다.

버린 대안:
- `tests/setup.ts` 검사를 「helper가 만든 값이 아닌 timeout」까지 넓히기.
  helper 값은 30초 단위 숫자라 손으로 쓴 60_000과 가릴 수 없고, hook과
  프로세스 안 시험은 보지 못한다.
- 프로세스 안 시험은 손 숫자 그대로 두기. 근거 없는 숫자가 남고 검사가
  예외를 가져야 한다.

위험·한계:
- 값이 커진 곳이 있다(15배 규칙): `manual-code-blocks` 300초 → 900초,
  provider 묶음 30초 → 480초 등. hang을 늦게 잡는다. 줄어든 곳도 있다
  (scale traffic 60초 → 30초 등, 잰 값의 15배 안).
- 측정은 desktop 부하 6~35에서 했다. runner가 더 느리면 다시 잰다.
- 검사 시험은 Vitest 파일 전부를 파싱해 coverage 묶음에서 최대 13.5초
  걸렸고, 그 값으로 자기 timeout을 준다. 이름 있는 함수를 콜백으로 넘긴
  시험(`it("x", run, 30_000)`)은 못 찾는다.
- 다운스트림: 손 숫자 timeout이 있는 제품 시험은 test:unit에서 이 검사에
  걸린다. 메시지가 helper를 알린다.

검증(desktop):
- RED: 검사 시험이 고치기 전 80곳을 파일·줄로 내고 실패. GREEN: 검사·
  child-process-timeout 6개 통과. check:types·eslint(바뀐 34파일) rc=0,
  verify:documentation PASS_SCOPED, 노트북 `scripts/verify.sh docs` OK.
- 측정 원자료: /tmp/claude-gates/w2fe2-t08m, -t08m2, -t08m3.
- 게이트 결과는 PR 본문에 적는다.

Refs: 1112/03-08
2026-11-13 06:47:02 +09:00

196 lines
7.0 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";
import { childProcessTimeout } from "../helpers/child-process-timeout.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,
},
]);
}, childProcessTimeout(21_402));
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)", { timeout: childProcessTimeout(934) }, () => {
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 });
}
});
});