SW e2e는 템플릿의 `= null;` 줄만 바꿔 worker를 켰다. 제품이 이미 ACTIVE로 켠 트리에서는 2건이 실패하고 4건이 실행되지 않았다. 사전 캐시 목록도 템플릿 기준으로 고정돼 있어 해시 파일을 더하면 2건이 실패했다. 선택을 지금 값과 상관없이 고치되, 이미 ACTIVE면 제품의 handler를 그대로 두는 `turnOnServiceWorker` 하나로 모았다. 빌드가 만든 사전 캐시 목록을 `precached`로 돌려주고 spec이 그 목록과 비교한다. 같은 문제를 고친 0929/06-04(`96a4f68`)의 `selectActiveServiceWorker`는 ACTIVE 선택을 템플릿 값으로 덮어써 제품 handler가 빠지므로 이 함수로 바꿨고, 실패한 준비 단계에서 임시 복사본을 지우는 처리는 유지했다(두 브랜치 병합 때 오케스트레이터가 충돌을 풀었다). 위험: 테스트 도우미만 바뀐다. 0929/06-04 단위 테스트의 기대값이 "ACTIVE 선택도 템플릿 값으로 덮어쓴다"에서 "ACTIVE 선택은 그대로 둔다"로 바뀐다. 검증: ACTIVE 선택과 해시 파일 추가 트리 모두 6 passed(에이전트). 병합 뒤 service-worker-build-output 단위 테스트 5/5, SW e2e chromium·webkit 12/12, tsc(test), eslint 통과.
336 lines
12 KiB
TypeScript
336 lines
12 KiB
TypeScript
import { spawnSync } from "node:child_process";
|
|
import { existsSync } from "node:fs";
|
|
import {
|
|
cp,
|
|
mkdtemp,
|
|
readFile,
|
|
rename,
|
|
rm,
|
|
writeFile,
|
|
} from "node:fs/promises";
|
|
import { createServer, type Server } from "node:http";
|
|
import type { AddressInfo } from "node:net";
|
|
import { tmpdir } from "node:os";
|
|
import path from "node:path";
|
|
import { pathToFileURL } from "node:url";
|
|
import { gzipSync } from "node:zlib";
|
|
|
|
import { SERVICE_WORKER_ASSETS_OUTPUT } from "../../../scripts/generate-service-worker-assets.ts";
|
|
import { linkFixtureNodeModules } from "../../../scripts/lib/fixture-node-modules.ts";
|
|
import type { StaticAssetManifestV1 } from "../../../src/contracts/service-worker.ts";
|
|
|
|
/**
|
|
* R3-6 test helper: two real production builds with the Service Worker on,
|
|
* and a static server that can switch which one it serves.
|
|
*
|
|
* The template ships with `serviceWorker: null`. The supported way to turn the
|
|
* worker on is the static capability selection in
|
|
* `src/features/installed-runtime-capabilities.ts` (`mode: "ACTIVE"` with the
|
|
* `PWA_STATIC_ASSETS` handler); `scripts/build-frontend.ts` then runs the
|
|
* two-pass worker build. Runtime Config can only disable it. So the helper
|
|
* copies the repo to a temp dir, edits the selection there, and runs the
|
|
* repo's own build scripts twice with different `VITE_BUILD_ID`s. The working
|
|
* tree and its `dist` (served by the e2e preview server) are never touched.
|
|
*
|
|
* The app composes the worker host but nothing subscribes to it yet, and it is
|
|
* not reachable from outside. The copy therefore also wraps
|
|
* `createServiceWorkerRuntimeHost` so the page records the host's own
|
|
* `onUpdateWaiting` / `onReloadRequired` callbacks and `start()` outcome on
|
|
* `globalThis.__caServiceWorkerTest`. Only the temp copy is edited.
|
|
*
|
|
* 0929/11-03. What the copy relies on, and where to change it when a product
|
|
* changes that code:
|
|
* 1. `src/features/installed-runtime-capabilities.ts` has one
|
|
* `const SERVICE_WORKER: InstalledServiceWorkerSelection | null = …;`.
|
|
* A selection that is already `ACTIVE` (a product that turned the worker
|
|
* on) is kept as it is; anything else becomes `ACTIVE_VALUE`.
|
|
* 2. `src/bootstrap/register-service-worker.ts` declares
|
|
* `export function createServiceWorkerRuntimeHost(` once (the probe).
|
|
* 3. The build writes its precache list to `SERVICE_WORKER_ASSETS_OUTPUT`.
|
|
* `precached` is read from there, so a product that precaches more than
|
|
* `dist/assets` still compares against what its worker installs.
|
|
* A broken premise fails `prepareServiceWorkerBuilds` with the file and the
|
|
* text it expected.
|
|
*/
|
|
|
|
const repoRoot = path.resolve(import.meta.dirname, "../../..");
|
|
const skipped = new Set([
|
|
"node_modules",
|
|
".git",
|
|
".claude",
|
|
".generated",
|
|
"dist",
|
|
"artifacts",
|
|
"graphify-out",
|
|
]);
|
|
|
|
export type BuildName = "a" | "b";
|
|
export type ServiceWorkerBuilds = Readonly<{
|
|
root: string;
|
|
dist: Readonly<Record<BuildName, string>>;
|
|
/** Sorted URLs of each build's generated precache list (premise 3). */
|
|
precached: Readonly<Record<BuildName, readonly string[]>>;
|
|
}>;
|
|
|
|
const SELECTION_FILE = "src/features/installed-runtime-capabilities.ts";
|
|
const SELECTION_DECLARATION =
|
|
/(const SERVICE_WORKER: InstalledServiceWorkerSelection \| null = )([\s\S]*?);\n/gu;
|
|
|
|
export const ACTIVE_VALUE = `{
|
|
mode: "ACTIVE",
|
|
scriptPath: "service-worker.js",
|
|
handlers: ["PWA_STATIC_ASSETS"],
|
|
}`;
|
|
|
|
const HOST_PROBE = `
|
|
export function createServiceWorkerRuntimeHost(
|
|
input: ServiceWorkerHostInput,
|
|
): ServiceWorkerRuntimeHost | null {
|
|
const host = createServiceWorkerRuntimeHostUnobserved(input);
|
|
if (!host) return host;
|
|
const events: string[] = [];
|
|
host.onUpdateWaiting(() => events.push("update-waiting"));
|
|
host.onReloadRequired(() => events.push("reload-required"));
|
|
const observed: ServiceWorkerRuntimeHost = Object.freeze({
|
|
...host,
|
|
start: async () => {
|
|
const outcome = await host.start();
|
|
events.push("start:" + JSON.stringify(outcome));
|
|
return outcome;
|
|
},
|
|
});
|
|
Object.assign(globalThis, { __caServiceWorkerTest: { host: observed, events } });
|
|
return observed;
|
|
}
|
|
`;
|
|
|
|
export async function replaceOnce(
|
|
file: string,
|
|
search: string,
|
|
replacement: string,
|
|
): Promise<void> {
|
|
const source = await readFile(file, "utf8");
|
|
if (source.split(search).length !== 2) {
|
|
throw new Error(`Expected exactly one "${search}" in ${file}.`);
|
|
}
|
|
await writeFile(file, source.replace(search, replacement));
|
|
}
|
|
|
|
/**
|
|
* Premise 1. Replaces the value of the one `SERVICE_WORKER` declaration in
|
|
* the temp copy with `next(current)`, whatever the value is now.
|
|
*/
|
|
export async function setServiceWorkerSelection(
|
|
root: string,
|
|
next: (current: string) => string,
|
|
): Promise<void> {
|
|
const file = path.join(root, SELECTION_FILE);
|
|
const source = await readFile(file, "utf8");
|
|
if ([...source.matchAll(SELECTION_DECLARATION)].length !== 1) {
|
|
throw new Error(
|
|
`Expected exactly one "const SERVICE_WORKER: InstalledServiceWorkerSelection | null = …;" in ${file} (premise 1 of tests/e2e/support/service-worker-builds.ts).`,
|
|
);
|
|
}
|
|
await writeFile(
|
|
file,
|
|
source.replace(
|
|
SELECTION_DECLARATION,
|
|
(_declaration, head: string, current: string) =>
|
|
`${head}${next(current)};\n`,
|
|
),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* 0929/06-04, 0929/11-03. Turns the copy's worker on whatever the selection is
|
|
* now, but keeps a selection a product already set to `ACTIVE`, so the specs
|
|
* exercise that product's own handlers rather than the template's.
|
|
*/
|
|
export async function turnOnServiceWorker(root: string): Promise<void> {
|
|
await setServiceWorkerSelection(root, (current) =>
|
|
/\bmode:\s*"ACTIVE"/u.test(current) ? current : ACTIVE_VALUE,
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Premise 3. The build wrote this list; the worker installs exactly it. A
|
|
* build without an `ACTIVE` worker (06-03's `REMOVE_REGISTRATION` release)
|
|
* writes none and precaches nothing: `scripts/build-frontend.ts` deletes the
|
|
* directory before every build, so a missing file is that build's answer.
|
|
*/
|
|
async function precachedUrls(root: string, name: BuildName): Promise<string[]> {
|
|
const file = path.join(root, SERVICE_WORKER_ASSETS_OUTPUT);
|
|
if (!existsSync(file)) return [];
|
|
const generated = pathToFileURL(file);
|
|
// Both builds write the same file; the query keeps B from reusing A's module.
|
|
generated.search = `build=${name}`;
|
|
const { SERVICE_WORKER_ASSETS } = (await import(generated.href)) as {
|
|
SERVICE_WORKER_ASSETS: StaticAssetManifestV1;
|
|
};
|
|
return SERVICE_WORKER_ASSETS.assets.map((asset) => asset.url).sort();
|
|
}
|
|
|
|
function run(cwd: string, script: string, buildId: string): void {
|
|
const result = spawnSync("node", [script], {
|
|
cwd,
|
|
encoding: "utf8",
|
|
env: { ...process.env, VITE_BUILD_ID: buildId, RELEASE_ID: buildId },
|
|
});
|
|
if (result.status !== 0) {
|
|
throw new Error(
|
|
`${script} failed for ${buildId}:\n${result.stdout}\n${result.stderr}`,
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* `beforeBuild` edits the temp copy right before build `name` (06-03: a
|
|
* broken worker A, then a `REMOVE_REGISTRATION` release B). Edits persist
|
|
* into the later build.
|
|
*/
|
|
export async function prepareServiceWorkerBuilds(
|
|
options: Readonly<{
|
|
beforeBuild?: (name: BuildName, root: string) => Promise<void>;
|
|
}> = {},
|
|
): Promise<ServiceWorkerBuilds> {
|
|
const root = await mkdtemp(path.join(tmpdir(), "ca-sw-builds-"));
|
|
try {
|
|
await cp(repoRoot, root, {
|
|
recursive: true,
|
|
filter: (source) =>
|
|
!skipped.has(path.relative(repoRoot, source).split(path.sep)[0]!),
|
|
});
|
|
await linkFixtureNodeModules(root, repoRoot);
|
|
await turnOnServiceWorker(root);
|
|
const hostFile = path.join(root, "src/bootstrap/register-service-worker.ts");
|
|
await replaceOnce(
|
|
hostFile,
|
|
"export function createServiceWorkerRuntimeHost(",
|
|
"function createServiceWorkerRuntimeHostUnobserved(",
|
|
);
|
|
await writeFile(hostFile, (await readFile(hostFile, "utf8")) + HOST_PROBE);
|
|
|
|
const dist = { a: path.join(root, "dist-a"), b: path.join(root, "dist-b") };
|
|
const precached: Record<BuildName, readonly string[]> = { a: [], b: [] };
|
|
for (const name of ["a", "b"] as const) {
|
|
await options.beforeBuild?.(name, root);
|
|
run(root, "scripts/generate-product-feature-index.ts", `sw-e2e-${name}`);
|
|
run(root, "scripts/build-frontend.ts", `sw-e2e-${name}`);
|
|
await rename(path.join(root, "dist"), dist[name]);
|
|
precached[name] = await precachedUrls(root, name);
|
|
}
|
|
return { root, dist, precached };
|
|
} catch (error) {
|
|
// The spec never receives `root` from a failed setup, so afterAll cannot
|
|
// remove it.
|
|
await rm(root, { recursive: true, force: true });
|
|
throw error;
|
|
}
|
|
}
|
|
|
|
export async function removeServiceWorkerBuilds(
|
|
builds: ServiceWorkerBuilds | undefined,
|
|
): Promise<void> {
|
|
if (builds) await rm(builds.root, { recursive: true, force: true });
|
|
}
|
|
|
|
export type AssetHeaders = Readonly<{
|
|
/** Sent for every `.js` file, the worker script included. */
|
|
javascriptContentType: string;
|
|
/** gzip every `/assets/*` body; Content-Length is the compressed size. */
|
|
gzip: boolean;
|
|
}>;
|
|
|
|
export type ServedResponse = Readonly<{
|
|
path: string;
|
|
contentType: string;
|
|
contentEncoding: string | null;
|
|
contentLength: number;
|
|
decodedLength: number;
|
|
}>;
|
|
|
|
const CONTENT_TYPES: Readonly<Record<string, string>> = {
|
|
".html": "text/html; charset=utf-8",
|
|
".css": "text/css",
|
|
".json": "application/json",
|
|
".svg": "image/svg+xml",
|
|
".png": "image/png",
|
|
".webp": "image/webp",
|
|
".woff2": "font/woff2",
|
|
};
|
|
|
|
/**
|
|
* Serves one dist directory at a time from an ephemeral 127.0.0.1 port, so
|
|
* every test gets its own origin (and its own Service Worker registration).
|
|
* Paths without an extension get `index.html`; a missing file is a plain 404,
|
|
* never the SPA fallback, so a chunk that the served build lacks really 404s.
|
|
*/
|
|
export async function startBuildServer(
|
|
dist: Readonly<Record<BuildName, string>>,
|
|
headers: AssetHeaders = {
|
|
javascriptContentType: "text/javascript",
|
|
gzip: false,
|
|
},
|
|
) {
|
|
let current: BuildName = "a";
|
|
const served: ServedResponse[] = [];
|
|
const server: Server = createServer((request, response) => {
|
|
void (async () => {
|
|
const pathname = decodeURIComponent(
|
|
new URL(request.url ?? "/", "http://127.0.0.1").pathname,
|
|
);
|
|
const root = dist[current];
|
|
const file = path.extname(pathname)
|
|
? path.join(root, path.normalize(pathname))
|
|
: path.join(root, "index.html");
|
|
let body: Buffer;
|
|
try {
|
|
if (!file.startsWith(root + path.sep)) throw new Error("outside root");
|
|
body = await readFile(file);
|
|
} catch {
|
|
response.writeHead(404, { "cache-control": "no-store" }).end();
|
|
return;
|
|
}
|
|
const extension = path.extname(file);
|
|
const contentType =
|
|
extension === ".js"
|
|
? headers.javascriptContentType
|
|
: (CONTENT_TYPES[extension] ?? "application/octet-stream");
|
|
const encoded = headers.gzip && pathname.startsWith("/assets/");
|
|
const payload = encoded ? gzipSync(body) : body;
|
|
served.push({
|
|
path: pathname,
|
|
contentType,
|
|
contentEncoding: encoded ? "gzip" : null,
|
|
contentLength: payload.byteLength,
|
|
decodedLength: body.byteLength,
|
|
});
|
|
response
|
|
.writeHead(200, {
|
|
"content-type": contentType,
|
|
"content-length": String(payload.byteLength),
|
|
"cache-control": "no-cache",
|
|
...(encoded
|
|
? { "content-encoding": "gzip", vary: "Accept-Encoding" }
|
|
: {}),
|
|
})
|
|
.end(request.method === "HEAD" ? undefined : payload);
|
|
})();
|
|
});
|
|
await new Promise<void>((resolve) =>
|
|
server.listen(0, "127.0.0.1", () => resolve()),
|
|
);
|
|
const { port } = server.address() as AddressInfo;
|
|
return {
|
|
origin: `http://127.0.0.1:${port}`,
|
|
served,
|
|
serve(name: BuildName) {
|
|
current = name;
|
|
},
|
|
async close() {
|
|
server.closeAllConnections();
|
|
await new Promise<void>((resolve) => server.close(() => resolve()));
|
|
},
|
|
};
|
|
}
|