From c1a98e97434c64f66a4a5d52f21c053ec8f8ae8b Mon Sep 17 00:00:00 2001 From: DongHyeonka Date: Fri, 13 Nov 2026 19:32:08 +0900 Subject: [PATCH] =?UTF-8?q?fix(build):=20=EB=B9=8C=EB=93=9C=20=EC=8B=9D?= =?UTF-8?q?=EB=B3=84=EA=B0=92=EC=9D=98=20=EA=B8=B0=EB=B3=B8=EA=B0=92?= =?UTF-8?q?=EC=9D=84=20=ED=95=9C=20=ED=95=A8=EC=88=98=EB=A1=9C=20=EC=9D=BD?= =?UTF-8?q?=EB=8A=94=EB=8B=A4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 문제: 빌드 ID·커밋·release ID의 기본값을 일곱 곳에서 따로 계산하고 `||`와 `??`가 섞였다. 그래서 VITE_BUILD_ID=""이면 runtime config는 local-build가 되고, build manifest·Service Worker·재현 빌드 기록은 ""가 된다(R-2). 고른 방법: src/contracts/env.ts에 BUILD_IDENTITY_PLACEHOLDERS와 readBuildIdentity(environment)를 두고(빈 값은 없는 것과 같다), 페이지의 getBuildConfig와 빌드 스크립트 다섯·vite.service-worker.config.ts가 모두 그것을 쓴다. ENV_REGISTRY 기본값과 LOCAL_BUILD_IDENTITY도 같은 상수에서 나온다. 시험이 빈 값 규칙과, 읽는 파일마다 자기 기본값을 다시 쓰지 않는지를 본다. 버린 대안: 빈 값을 거절하기 — local 빌드가 쓰는 placeholder 규칙을 바꾸고 admission이 이미 placeholder를 공개 대상에서 거절한다. 위험·한계: generate-build-manifest.ts·verify-reproducible-build.ts는 그룹 C도 고치는 파일이다. 줄은 겹치지 않는다. 검증: desktop 결과는 PR 본문. Refs: R-2 --- scripts/generate-build-manifest.ts | 5 +-- scripts/generate-runtime-config.ts | 4 +- scripts/generate-service-worker-assets.ts | 5 +-- scripts/lib/build-environment.ts | 8 ++-- scripts/verify-reproducible-build.ts | 5 +-- src/contracts/deployment-admission.ts | 6 +-- src/contracts/env.ts | 39 +++++++++++++++-- src/presentation/routes/app-router.tsx | 3 +- tests/unit/build-identity.test.ts | 52 +++++++++++++++++++++++ vite.service-worker.config.ts | 5 +-- 10 files changed, 107 insertions(+), 25 deletions(-) create mode 100644 tests/unit/build-identity.test.ts diff --git a/scripts/generate-build-manifest.ts b/scripts/generate-build-manifest.ts index 2d47f7d7..de1700da 100644 --- a/scripts/generate-build-manifest.ts +++ b/scripts/generate-build-manifest.ts @@ -3,6 +3,7 @@ import { mkdir, readFile, rm } from "node:fs/promises"; import process from "node:process"; import { z } from "zod"; +import { readBuildIdentity } from "../src/contracts/env.ts"; import { ROUTE_REGISTRY, ROUTE_RUNTIME_CONTRACT, @@ -39,9 +40,7 @@ const packageJson = parsePackageMetadata( JSON.parse(await readFile("package.json", "utf8")), ); const packageManagerVersion = packageJson.packageManager.split("@").at(-1); -const buildId = process.env.VITE_BUILD_ID ?? "local-build"; -const commitSha = process.env.VITE_COMMIT_SHA ?? "local"; -const releaseId = process.env.RELEASE_ID ?? "local-release"; +const { buildId, commitSha, releaseId } = readBuildIdentity(process.env); const runnerImage = process.env.CI_RUNNER_IMAGE ?? `${process.platform}-${process.arch}`; const buildTime = buildDate(process.env); const builtAt = buildTime.toISOString(); diff --git a/scripts/generate-runtime-config.ts b/scripts/generate-runtime-config.ts index 96cd9e3e..6995dd0d 100644 --- a/scripts/generate-runtime-config.ts +++ b/scripts/generate-runtime-config.ts @@ -8,6 +8,7 @@ import { PUBLIC_TARGETS, type DeploymentTarget, } from "../src/contracts/deployment-admission.ts"; +import { readBuildIdentity } from "../src/contracts/env.ts"; import { runtimeConfigV2ArtifactSchema } from "../src/contracts/release-artifacts.ts"; import { runOutputPath } from "./lib/run-isolation.ts"; @@ -72,8 +73,7 @@ export async function generateRuntimeConfig( if (PUBLIC_TARGETS.has(target) && !environment["VITE_BUILD_ID"]) { throw new Error(`${profilePath}: a ${target} build requires VITE_BUILD_ID`); } - const buildId = environment["VITE_BUILD_ID"] || "local-build"; - const releaseId = environment["RELEASE_ID"] ?? "local-release"; + const { buildId, releaseId } = readBuildIdentity(environment); draft["BUILD_ID"] = buildId; draft["RELEASE_ID"] = releaseId; diff --git a/scripts/generate-service-worker-assets.ts b/scripts/generate-service-worker-assets.ts index 7f949d13..73acd62f 100644 --- a/scripts/generate-service-worker-assets.ts +++ b/scripts/generate-service-worker-assets.ts @@ -9,7 +9,7 @@ import { import { mkdir, readFile, readdir, stat, writeFile } from "node:fs/promises"; import path from "node:path"; -import { getBuildConfig } from "../src/contracts/env.ts"; +import { getBuildConfig, readBuildIdentity } from "../src/contracts/env.ts"; import { BUILD_ASSET_DIRECTORY, HASHED_STATIC_ASSET_NAME, @@ -175,8 +175,7 @@ async function walk(root: string, current: string): Promise { async function main(): Promise { const distDirectory = process.argv[2] ?? runOutputPath("dist"); const output = runOutputPath(SERVICE_WORKER_ASSETS_OUTPUT); - const buildId = process.env.VITE_BUILD_ID ?? "local-build"; - const releaseId = process.env.RELEASE_ID ?? "local-release"; + const { buildId, releaseId } = readBuildIdentity(process.env); const manifest = await collectStaticAssets( distDirectory, buildId, diff --git a/scripts/lib/build-environment.ts b/scripts/lib/build-environment.ts index a7242109..39a1d30f 100644 --- a/scripts/lib/build-environment.ts +++ b/scripts/lib/build-environment.ts @@ -1,3 +1,5 @@ +import { BUILD_IDENTITY_PLACEHOLDERS } from "../../src/contracts/env.ts"; + export const CI_BUILD_ENVIRONMENT_VARIABLES = Object.freeze([ "VITE_BUILD_ID", "VITE_COMMIT_SHA", @@ -53,9 +55,9 @@ export function ciBuildEnvironmentFailures( */ export const LOCAL_BUILD_IDENTITY = Object.freeze({ CI: "", - VITE_BUILD_ID: "local-build", - VITE_COMMIT_SHA: "local", - RELEASE_ID: "local-release", + VITE_BUILD_ID: BUILD_IDENTITY_PLACEHOLDERS.buildId, + VITE_COMMIT_SHA: BUILD_IDENTITY_PLACEHOLDERS.commitSha, + RELEASE_ID: BUILD_IDENTITY_PLACEHOLDERS.releaseId, }); export function localBuildEnvironment( diff --git a/scripts/verify-reproducible-build.ts b/scripts/verify-reproducible-build.ts index dbf2ec31..93c65f05 100644 --- a/scripts/verify-reproducible-build.ts +++ b/scripts/verify-reproducible-build.ts @@ -2,6 +2,7 @@ import { spawnSync } from "node:child_process"; import { mkdir, readFile, readdir } from "node:fs/promises"; import path from "node:path"; +import { readBuildIdentity } from "../src/contracts/env.ts"; import { reproducibleBuildArtifactSchema } from "./contracts/release-artifacts.ts"; import { assertCiBuildEnvironment } from "./lib/build-environment.ts"; import { supplyChainDigest } from "./lib/supply-chain.ts"; @@ -62,9 +63,7 @@ await writeValidatedJsonArtifact({ value: { schemaVersion: 1, sourceDateEpoch: deterministicEnvironment.SOURCE_DATE_EPOCH, - buildId: process.env.VITE_BUILD_ID ?? "local-build", - commitSha: process.env.VITE_COMMIT_SHA ?? "local", - releaseId: process.env.RELEASE_ID ?? "local-release", + ...readBuildIdentity(process.env), runnerImage: process.env.CI_RUNNER_IMAGE ?? `${process.platform}-${process.arch}`, firstDigest, diff --git a/src/contracts/deployment-admission.ts b/src/contracts/deployment-admission.ts index 289d6a0c..1d046fdd 100644 --- a/src/contracts/deployment-admission.ts +++ b/src/contracts/deployment-admission.ts @@ -1,3 +1,4 @@ +import { BUILD_IDENTITY_PLACEHOLDERS } from "./env.ts"; import type { RuntimeConfigArtifact } from "./release-artifacts.ts"; /** @@ -38,9 +39,8 @@ export const PUBLIC_TARGETS: ReadonlySet = new Set([ /** Placeholder identifiers a developer build emits when nothing supplied one. */ const PLACEHOLDER_IDENTIFIERS: ReadonlySet = new Set([ - "local-build", - "local-release", - "local", + // R-2. The values a build without identity carries, from their one source. + ...Object.values(BUILD_IDENTITY_PLACEHOLDERS), "dev", "unknown", ]); diff --git a/src/contracts/env.ts b/src/contracts/env.ts index 363bf00f..a34ccc01 100644 --- a/src/contracts/env.ts +++ b/src/contracts/env.ts @@ -33,6 +33,38 @@ const SEMANTIC_KEY_ALLOWLIST = Object.freeze( */ const FEATURE_ID_KEYED_MAPS = Object.freeze(new Set(["FEATURE_OVERRIDES"])); +/** + * R-2. The identity a build carries when its environment gives none: a local + * or development build, never a public one (admission refuses these values, + * `deployment-admission.ts`). Every reader of the build identity, the page + * and the build scripts alike, goes through `readBuildIdentity`, so an empty + * value reads as unset everywhere: the runtime config, the build manifest, + * the Service Worker and the reproducible-build record used to disagree on + * `VITE_BUILD_ID=""` (`||` in some, `??` in others). Admission's placeholder + * list reads these values too (`deployment-admission.ts`). + */ +export const BUILD_IDENTITY_PLACEHOLDERS = Object.freeze({ + buildId: "local-build", + commitSha: "local", + releaseId: "local-release", +}); + +export function readBuildIdentity( + environment: Readonly>, +): Readonly<{ buildId: string; commitSha: string; releaseId: string }> { + // Blank (empty or whitespace) is unset, as the CI identity check reads it + // (`scripts/lib/build-environment.ts`). + const read = (name: string, placeholder: string) => { + const value = environment[name]?.trim(); + return value === undefined || value === "" ? placeholder : value; + }; + return Object.freeze({ + buildId: read("VITE_BUILD_ID", BUILD_IDENTITY_PLACEHOLDERS.buildId), + commitSha: read("VITE_COMMIT_SHA", BUILD_IDENTITY_PLACEHOLDERS.commitSha), + releaseId: read("RELEASE_ID", BUILD_IDENTITY_PLACEHOLDERS.releaseId), + }); +} + export type EnvironmentPhase = "build" | "runtime"; export type EnvironmentDefinition = Readonly<{ phase: EnvironmentPhase; @@ -51,8 +83,8 @@ export const ENV_REGISTRY = Object.freeze(withProductRows({ // F-6. Required: a staging or production build fails without it // (scripts/generate-runtime-config.ts). Local and development builds fall // back to the placeholder, which admission refuses for public targets. - VITE_BUILD_ID: build("public-metadata", true, "local-build"), - VITE_COMMIT_SHA: build("public-metadata", false, "local"), + VITE_BUILD_ID: build("public-metadata", true, BUILD_IDENTITY_PLACEHOLDERS.buildId), + VITE_COMMIT_SHA: build("public-metadata", false, BUILD_IDENTITY_PLACEHOLDERS.commitSha), VITE_ROUTER_BASE_PATH: build("compile-time", true, "/"), VITE_RUNTIME_CONFIG_URL: build("compile-time", true, "/config.json"), APP_ENV: runtime("public", true, null), @@ -201,8 +233,7 @@ export function getBuildConfig( VITE_RUNTIME_CONFIG_URL: import.meta.env.VITE_RUNTIME_CONFIG_URL, }, ) { - const buildId = environment.VITE_BUILD_ID || "local-build"; - const commitSha = environment.VITE_COMMIT_SHA || "local"; + const { buildId, commitSha } = readBuildIdentity(environment); const routerBasePath = environment.VITE_ROUTER_BASE_PATH || "/"; // 13-07. dist is served under the base path, so the default follows it. const runtimeConfigUrl = diff --git a/src/presentation/routes/app-router.tsx b/src/presentation/routes/app-router.tsx index d391d1a8..8369b96c 100644 --- a/src/presentation/routes/app-router.tsx +++ b/src/presentation/routes/app-router.tsx @@ -33,6 +33,7 @@ import { UNREGISTERED_ROUTE_ID, } from "../../contracts/routes.ts"; import { TEMPLATE_APP_MODULE } from "../../apps/template-app.ts"; +import { BUILD_IDENTITY_PLACEHOLDERS } from "../../contracts/env.ts"; import { createAppRouteModules, type ContextRouteModule, @@ -737,7 +738,7 @@ function createRegisteredRoutes(buildId: string): RouteObject[] { */ export function AppRouter({ basename = "/", - buildId = "local-build", + buildId = BUILD_IDENTITY_PLACEHOLDERS.buildId, }: Readonly<{ basename?: string; buildId?: string }>) { const [router, setRouter] = useState { + it("reads an empty value as unset, like a missing one", () => { + expect(readBuildIdentity({ VITE_BUILD_ID: "", VITE_COMMIT_SHA: "", RELEASE_ID: "" })).toEqual( + BUILD_IDENTITY_PLACEHOLDERS, + ); + expect(readBuildIdentity({})).toEqual(BUILD_IDENTITY_PLACEHOLDERS); + expect( + readBuildIdentity({ VITE_BUILD_ID: "b-1", VITE_COMMIT_SHA: "abc", RELEASE_ID: "r-1" }), + ).toEqual({ buildId: "b-1", commitSha: "abc", releaseId: "r-1" }); + }); + + it("treats a blank value as unset, as the CI identity check does", () => { + expect(readBuildIdentity({ VITE_BUILD_ID: " " }).buildId).toBe( + BUILD_IDENTITY_PLACEHOLDERS.buildId, + ); + }); + + it("leaves getBuildConfig on the same rule", () => { + const source = readFileSync("src/contracts/env.ts", "utf8"); + const getBuildConfig = source.slice(source.indexOf("export function getBuildConfig")); + expect(getBuildConfig).toContain("readBuildIdentity(environment)"); + expect(getBuildConfig).not.toMatch(OWN_FALLBACK); + }); + + it.each(READERS)("%s reads the identity through readBuildIdentity", (file) => { + const source = readFileSync(file, "utf8"); + expect(source).toContain("readBuildIdentity("); + expect(source).not.toMatch(OWN_FALLBACK); + }); +}); diff --git a/vite.service-worker.config.ts b/vite.service-worker.config.ts index b03e92cb..76305d74 100644 --- a/vite.service-worker.config.ts +++ b/vite.service-worker.config.ts @@ -1,7 +1,7 @@ import { readFile } from "node:fs/promises"; import { defineConfig } from "vite"; -import { getBuildConfig } from "./src/contracts/env.ts"; +import { getBuildConfig, readBuildIdentity } from "./src/contracts/env.ts"; import { SERVICE_WORKER_CACHE_SCHEMA_VERSION, SERVICE_WORKER_PROTOCOL_VERSION, @@ -58,8 +58,7 @@ const runtimeConfig = JSON.parse( await readFile(runOutputPath("dist/config.json"), "utf8"), ) as Record; -const buildId = process.env.VITE_BUILD_ID ?? "local-build"; -const releaseId = process.env.RELEASE_ID ?? "local-release"; +const { buildId, releaseId } = readBuildIdentity(process.env); const buildInput = resolveServiceWorkerBuildInput({ selection, assets,