fix(service-worker): SW 빌드가 public/을 다시 복사하지 않게 한다 (0929/06-01)
문제: SW를 ACTIVE로 켜면 build-frontend 6단계의 SW Vite 빌드가 Vite 기본값대로 public/을 dist에 다시 복사한다. 4단계가 프로필로 만든 dist/config.json이 public/config.json(local, demo 인증, http://localhost:8080/, 루트 release manifest)으로 덮어써진다. 빌드와 verify-release는 통과하고 release admission만 거절한다. 그래서 SW를 켠 제품은 local이 아닌 릴리스를 만들 수 없다. VITE_ROUTER_BASE_PATH를 쓰면 RELEASE_MANIFEST_URL도 base를 잃는다. 고른 방법: vite.service-worker.config.ts에 publicDir: false를 넣는다. dist에는 3단계 앱 빌드가 이미 public/을 복사해 두었고, 워커 번들은 public/ 파일을 쓰지 않는다. 같은 repo의 다른 두 번째 Vite 빌드 (scripts/lib/optional-recipe-bundle.ts)도 같은 설정이다. build-frontend.ts 6단계 주석에 이 조건을 한 줄 적었다. 버린 대안: - build.copyPublicDir: false. 복사만 끄고 public 디렉터리는 계속 설정에 남는다. 워커 빌드는 public/을 쓸 일이 없어 publicDir: false가 의도를 바로 말한다. - 앱 빌드 plugin의 closeBundle에서 워커를 만들기, 또는 Vite build()를 configFile: false로 부르는 스크립트. 둘 다 리뷰 5.2절의 대안이다. two-pass 구조를 바꾸거나 파일이 늘어 이 결함에 비해 범위가 크다. 테스트: tests/unit/service-worker-build-output.test.ts는 임시 복사본에서 SW ACTIVE + APP_PROFILE=production + VITE_ROUTER_BASE_PATH=/app/로 실제 build-frontend.ts를 돌린다. 그리고 dist/config.json이 generateRuntimeConfig("production", env) 결과와 같은지 본다(리뷰의 완료 기준). 설정 객체에서 publicDir === false를 보는 테스트는 수정을 다시 적을 뿐이고, 설정이 5단계 생성물 없이는 로드되지 않아 버렸다. 빌드 1회가 약 2초라 unit 계층에 둔다(build-environment-bundle.test.ts와 같은 방식, docs/testing/taxonomy.md의 짧은 child process 규칙). 복사와 빌드는 e2e 도우미 prepareFixtureBuilds를 재사용하고, 빌드별 env 옵션만 추가했다(기존 호출은 그대로). 이 테스트로 0925/06-10(SW Vite 설정의 dist/config.json 읽기 테스트 없음)도 닫힌다. 위험·한계: 하위 경로에서 사전 캐시 URL이 base를 잃는 문제(0929/06-02)와 워커의 runtime config URL 기본값은 그대로다. 이 테스트는 /app/ 빌드의 설정 문서만 보고 워커 설치는 보지 않는다. Vite 8.1.5 동작 기준이다. check:architecture는 pnpm 스크립트로만 돌아서 실행하지 않았다(src는 바꾸지 않았다). 검증: - RED(수정 전): 새 테스트 실패. APP_ENV local(기대 production), AUTH_MODE demo(기대 external), API_BASE_URL http://localhost:8080/, RELEASE_MANIFEST_URL /release-manifest.json(기대 /app/...) - GREEN: 새 테스트 통과(1.9초) - 수정 전후 production + /app/ 빌드 비교: dist 파일 34개로 같음. 수정 후 RELEASE_TARGET=production check-release-admission ADMITTED, 수정 전 rc 1 - node scripts/run-vitest.ts run tests/unit(pnpm을 띄우는 2파일 제외): 164파일 2343건 통과 - tsc tsconfig.test.json, tsconfig.node.json 통과. 바꾼 4파일 eslint 통과 Refs: docs/reviews/2026-11-01-maturity-review/06-adapters-service-worker-push.md 2절, 13-build-release-supply-chain.md 실험 E-B
This commit is contained in:
@@ -18,7 +18,8 @@ import { SELF_UNREGISTERING_SERVICE_WORKER } from "./lib/self-unregistering-serv
|
||||
* 3. Vite app build (emptyOutDir = true)
|
||||
* 4. materialize dist/config.json from the declared APP_PROFILE
|
||||
* 5. scan app dist and generate the static asset source
|
||||
* 6. ACTIVE only: Vite Service Worker build (emptyOutDir = false)
|
||||
* 6. ACTIVE only: Vite Service Worker build (emptyOutDir = false,
|
||||
* publicDir = false: it must not copy `public/` over step 4, 0929/06-01)
|
||||
* REMOVE_REGISTRATION only: write the self-unregistering worker (06-03)
|
||||
* 7. generate Release Manifest V2 and the build manifest
|
||||
* 8. make every dist file readable by other users (13-02)
|
||||
|
||||
@@ -29,6 +29,8 @@ const skipped = new Set([
|
||||
export type FixtureBuild<Name extends string> = Readonly<{
|
||||
name: Name;
|
||||
edit?: (root: string) => Promise<void>;
|
||||
/** Extra build variables for this build only (e.g. `APP_PROFILE`). */
|
||||
env?: Readonly<Record<string, string>>;
|
||||
}>;
|
||||
|
||||
export type FixtureBuilds<Name extends string> = Readonly<{
|
||||
@@ -49,11 +51,16 @@ export async function editOnce(
|
||||
await writeFile(file, source.replace(search, replacement));
|
||||
}
|
||||
|
||||
function run(cwd: string, script: string, buildId: string): void {
|
||||
function run(
|
||||
cwd: string,
|
||||
script: string,
|
||||
buildId: string,
|
||||
env: Readonly<Record<string, string>> = {},
|
||||
): void {
|
||||
const result = spawnSync("node", [script], {
|
||||
cwd,
|
||||
encoding: "utf8",
|
||||
env: { ...process.env, VITE_BUILD_ID: buildId, RELEASE_ID: buildId },
|
||||
env: { ...process.env, ...env, VITE_BUILD_ID: buildId, RELEASE_ID: buildId },
|
||||
});
|
||||
if (result.status !== 0) {
|
||||
throw new Error(
|
||||
@@ -78,8 +85,8 @@ export async function prepareFixtureBuilds<Name extends string>(
|
||||
for (const build of builds) {
|
||||
await build.edit?.(root);
|
||||
const buildId = `${prefix}-${build.name}`;
|
||||
run(root, "scripts/generate-product-feature-index.ts", buildId);
|
||||
run(root, "scripts/build-frontend.ts", buildId);
|
||||
run(root, "scripts/generate-product-feature-index.ts", buildId, build.env);
|
||||
run(root, "scripts/build-frontend.ts", buildId, build.env);
|
||||
dist[build.name] = path.join(root, `dist-${build.name}`);
|
||||
await rename(path.join(root, "dist"), dist[build.name]);
|
||||
}
|
||||
|
||||
@@ -0,0 +1,71 @@
|
||||
import { access, readFile } from "node:fs/promises";
|
||||
import path from "node:path";
|
||||
|
||||
import { afterAll, describe, expect, it } from "vitest";
|
||||
|
||||
import { generateRuntimeConfig } from "../../scripts/generate-runtime-config.ts";
|
||||
import {
|
||||
editOnce,
|
||||
type FixtureBuilds,
|
||||
prepareFixtureBuilds,
|
||||
removeFixtureBuilds,
|
||||
} from "../e2e/support/fixture-builds.ts";
|
||||
import { ACTIVE_SELECTION } 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;
|
||||
|
||||
afterAll(async () => {
|
||||
await removeFixtureBuilds(builds);
|
||||
});
|
||||
|
||||
describe("Service Worker build output (0929/06-01)", () => {
|
||||
it("keeps the profile runtime config step 4 wrote", async () => {
|
||||
builds = await prepareFixtureBuilds("sw-profile", [
|
||||
{
|
||||
name: "active",
|
||||
env: PROFILE,
|
||||
edit: (root) =>
|
||||
editOnce(
|
||||
path.join(root, "src/features/installed-runtime-capabilities.ts"),
|
||||
"const SERVICE_WORKER: InstalledServiceWorkerSelection | null = null;",
|
||||
ACTIVE_SELECTION,
|
||||
),
|
||||
},
|
||||
]);
|
||||
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,
|
||||
}),
|
||||
);
|
||||
}, 180_000);
|
||||
});
|
||||
@@ -67,6 +67,10 @@ const buildInput = resolveServiceWorkerBuildInput({
|
||||
});
|
||||
|
||||
export default defineConfig({
|
||||
// 0929/06-01. `dist` already holds the app build, `public/` included. Copying
|
||||
// `public/` again would put the local `public/config.json` back over the
|
||||
// profile document step 4 wrote.
|
||||
publicDir: false,
|
||||
build: {
|
||||
// §17.2.2: exactly one input, exactly one output, no additional chunk.
|
||||
emptyOutDir: false,
|
||||
|
||||
Reference in New Issue
Block a user