Files
clean-architecture-frontend…/tests/unit/service-worker-build-output.test.ts
T
DongHyeonka 91962e24e3 test(setup): 자식 프로세스를 띄우는 시험이 잰 시간으로 timeout을 정한다
자식 프로세스를 띄우는 Vitest 시험 91개(24파일)가 기본 timeout 10초에
기대고 있었다. 셋은 FE-GATE-013에서만 도는 tests/system 시험이다.
기본값은 프로세스 안에서 도는 시험에 맞춘 값이다. 부하가 높은
desktop에서는 자식 프로세스 시험이 평소보다 크게 느려진다.
FE-GATE-020 drill 사본에서 평소 0.4~1.2초인 문서 시험이 10.6초 걸려
실패했다(2026-11-12). 가장 위험한 것은 tests/architecture/app-build-input
.test.ts로, desktop에서 이미 5.7초까지 걸렸다.

무엇을 고칠지는 desktop 계측으로 정했다.
- test:coverage 묶음(maxWorkers=4)과 test:unit을 세 번씩 돌렸다. 시험마다
  띄운 자식 프로세스는 child_process 함수를 감싸 기록했고, 소요 시간은
  JSON reporter로 받았다.
- 시험마다 실제 timeout은 task.timeout으로 기록했다.
- 자식 프로세스를 띄우는 시험 140개 중 88개가 기본값이었다. tests/system은
  그 묶음에 없어서, 아래 검사가 잡은 셋을 따로 세 번 쟀다.

고친 것:
- tests/helpers/child-process-timeout.ts의 childProcessTimeout(<잰 최대
  ms>)는 그 15배를 30초 단위로 올린 값이다. 15배는 위 0.7초 → 10.6초에서
  왔다. 시험마다 자기가 잰 최대값을 인자로 적어 근거가 호출 자리에 남는다.
- describe 안의 기본값 시험이 모두 자식 프로세스를 띄우면 describe에,
  일부만 띄우면 그 시험에 준다. 프로세스 안에서 도는 시험의 hang을 늦게
  잡지 않으려는 것이다.
- tests/setup.ts가 child_process 함수를 감싼다. 기본 timeout인 시험이
  자식 프로세스를 띄우면 그 호출에서 실패시키고, helper 이름을 알린다.
  helper나 시험이 import한 스크립트가 띄워도 잡는다. util.promisify가
  읽는 속성은 원래 함수에서 옮긴다.
- docs/work/reference/testing.md 2절에 값 정하는 법과 이 검사를 적었다.

버린 것:
- 전역 testTimeout 올리기: 프로세스 안 시험의 hang을 늦게 잡는다.
- 시험마다 손으로 정한 숫자: 근거가 남지 않고, 이미 있는 값도
  60_000·120_000처럼 근거가 없었다.
- 자식 프로세스를 띄우지 않게 바꾸기: 검사 스크립트를 CLI 그대로 시험하는
  것이 이 시험들의 목적이라 범위가 커진다.
- 파일에 timeout 선언이 있는지만 보는 정적 검사: helper가 띄우는 경우와
  같은 파일의 다른 시험을 놓친다.

위험:
- hook(beforeAll 등)에서 띄우는 프로세스는 검사하지 않는다. 계측에서
  hook이 띄운 곳은 둘이고, 둘 다 180초를 선언했다.
- 같은 파일 안에서 it.concurrent로 도는 시험이 섞이면 어느 시험의
  timeout인지 틀릴 수 있다. 지금은 그런 시험이 없다.
- 다운스트림 시험이 기본값으로 자식 프로세스를 띄우면 test:unit 등이
  실패한다. 메시지가 helper를 알린다.

검증(desktop):
- 다섯 검사(test:unit·check:types·check:ci·lint·verify:documentation)
  rc=0.
- 자식 프로세스를 띄우는 시험 파일 40개와 tests/scale: rc=0, 검사 위반 0.
- tests/system: 115개 중 18개 실패. 모두 bwrap 호스트 제약이고 검사
  위반은 0이다.
- 변이: 검사를 끄면 tests/unit/child-process-timeout.test.ts가 실패한다.
  tracked-artifacts describe의 timeout을 지우면 그 시험이 검사 메시지로
  실패한다.
- 재현: CPU 10% 제한에서 app-build-input·registry-governance·hosting-probe
  ·design-system-rules를 돌렸다. main 650d22fa는 11개가 10초 timeout으로
  실패했다. 이 커밋은 71개 모두 통과했고, 가장 긴 시험은 17.7초였다.
2026-11-12 11:22:59 +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,
},
]);
}, 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)", { 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 });
}
});
});