문제 - 기능 생성 명령(U7)은 계약 패키지 인자가 없으면 자리표시자 신원으로 기능을 만든다. 이 신원은 형식 검사(external-contract-runtime.ts의 패키지 신원 검사)를 모두 통과한다. 계약 집합 검사도 같은 목록을 자기 자신과 비교한다. 그래서 자리표시자를 그대로 둔 빌드가 staging· production 승인까지 통과한다. 고른 방법 (오케스트레이터 결정 2) - 자리표시자를 src/contracts/deployment-admission.ts에 상수로 둔다. digest는 sha256: 뒤에 0 64개, version 0.0.0, revision 0000000이다. 생성 명령이 이 상수를 import해 쓰므로 코드에서 자리표시자임이 보인다. - findAdmissionViolations에 세 번째 인자로 빌드가 컴파일한 계약 패키지 목록을 받는다. 대상이 PUBLIC(staging, production)이면 digest가 자리표시자인 패키지마다 contractPackages.<packageId> 위반을 낸다. BUILD_ID·RELEASE_ID의 PLACEHOLDER_IDENTIFIERS 검사와 같은 꼴이다. - check-release-admission.ts는 EXPECTED_CONTRACT_SET_PACKAGES를 넘긴다. 이미 COMPILED_PRODUCT_FEATURE_IDS를 같은 방식으로 읽는다. - 배포된 config.json의 수정본 검사(--config, 1101/13-05)는 패키지를 보지 않는다. 수정본은 비상 스위치만 바꿀 수 있고, 패키지는 빌드 필드라 빌드 승인 때 이미 검사했다. - APP_PROFILE 테스트의 production 행은 컴파일된 계약 집합에 자리표시자가 있으면 거절(그 이유로만)을, 없으면 승인을 기대한다. 생성 명령으로 기능을 하나 만들면 저장소 자체 빌드가 production 승인을 받지 못하는 것이 의도한 동작이기 때문이다. - 버린 대안: 계약 형식 검사에서 거절하기. 그러면 생성한 기능이 로컬에서 부팅·테스트되지 않는다. dist/release-manifest.json을 읽어 비교하기. 릴리스 일관성 검사가 이미 manifest와 컴파일된 목록이 같은지 보므로 같은 값을 한 번 더 읽고, 이 스크립트를 실행하는 테스트마다 manifest를 써야 한다. 위험·한계 - digest만 본다. version이나 revision만 자리표시자이고 digest는 진짜인 신원은 거절하지 않는다. 결정이 digest 하나를 자리표시자로 정했다. - local·development 대상은 거절하지 않는다. 의도한 동작이다. - 새 코드는 앱 번들에 들어가지 않는다(빌드 후 dist에서 거절 문구와 상수 이름 grep 0건). 앱은 이 모듈에서 isLoopbackHostname만 쓴다. 검증 - RED: 상수만 넣고 거절 전 코드로 새 테스트를 돌리면 실패한다. "staging: expected [] to deeply equal [ Array(1) ]" - RED(수정본·APP_PROFILE): 생성 명령으로 기능 하나를 만든 상태에서 두 테스트가 "contractPackages.@org-contracts/order: pins the placeholder identity ..."로 실패했다. - GREEN: tests/unit/deployment-admission.test.ts 25/25, feature-override-diagnostics.test.ts(스크립트 실행) 통과. 생성한 기능이 있을 때와 없을 때 모두 통과. 생성한 기능이 있을 때 production 대상 스크립트 실행은 rc=1과 위 위반 한 줄을 낸다. - npx tsc app·node·test rc=0, 바꾼 3파일 eslint rc=0.
429 lines
16 KiB
TypeScript
429 lines
16 KiB
TypeScript
import { spawnSync } from "node:child_process";
|
|
import { mkdir, mkdtemp, readFile, readdir, rm, writeFile } from "node:fs/promises";
|
|
import { tmpdir } from "node:os";
|
|
import path from "node:path";
|
|
|
|
import { describe, expect, it } from "vitest";
|
|
|
|
import {
|
|
DEPLOYMENT_TARGETS,
|
|
findAdmissionViolations,
|
|
isDeploymentTarget,
|
|
PLACEHOLDER_CONTRACT_PACKAGE_DIGEST,
|
|
type AdmissionInput,
|
|
} from "../../src/contracts/deployment-admission.ts";
|
|
import { ENV_REGISTRY, getBuildConfig } from "../../src/contracts/env.ts";
|
|
import { EXPECTED_CONTRACT_SET_PACKAGES } from "../../src/features/installed-contract-contributions.ts";
|
|
import { runtimeConfigV2ArtifactSchema } from "../../src/contracts/release-artifacts.ts";
|
|
import { generateRuntimeConfig } from "../../scripts/generate-runtime-config.ts";
|
|
|
|
const PRODUCTION_ARTIFACT: AdmissionInput = Object.freeze({
|
|
APP_ENV: "production",
|
|
API_BASE_URL: "https://api.my-product.kr/",
|
|
REQUEST_TIMEOUT_MS: 10_000,
|
|
MAX_RETRY_ATTEMPTS: 2,
|
|
TELEMETRY_ENABLED: false,
|
|
AUTH_MODE: "external",
|
|
CONFIG_SCHEMA_VERSION: "2.0",
|
|
RELEASE_MANIFEST_URL: "/release-manifest.json",
|
|
BUILD_ID: "20260815.42",
|
|
RELEASE_ID: "r-2026.08.15-1",
|
|
CAPABILITY_OVERRIDES: Object.freeze({
|
|
REALTIME: "DEFAULT",
|
|
WEB_WORKER: "DEFAULT",
|
|
SERVICE_WORKER: "DEFAULT",
|
|
OFFLINE_COMMANDS: "DEFAULT",
|
|
}),
|
|
}) as AdmissionInput;
|
|
|
|
const LOCAL_ARTIFACT: AdmissionInput = Object.freeze({
|
|
...PRODUCTION_ARTIFACT,
|
|
APP_ENV: "local",
|
|
API_BASE_URL: "http://localhost:8080/",
|
|
AUTH_MODE: "demo",
|
|
BUILD_ID: "local-build",
|
|
RELEASE_ID: "local-release",
|
|
}) as AdmissionInput;
|
|
|
|
describe("deployment admission", () => {
|
|
it("admits an artifact only to the environment it declares", () => {
|
|
expect(findAdmissionViolations("production", PRODUCTION_ARTIFACT)).toEqual([]);
|
|
expect(findAdmissionViolations("local", LOCAL_ARTIFACT)).toEqual([]);
|
|
});
|
|
|
|
// U7 (decision 2). `create:feature` pins this digest when no contract
|
|
// package is given. It passes every format check, so a public target is
|
|
// where it stops; local and development builds keep working with it.
|
|
it("refuses a contract package that pins the placeholder digest for a public target", () => {
|
|
const placeholder = Object.freeze({
|
|
packageId: "@org-contracts/orders",
|
|
digest: PLACEHOLDER_CONTRACT_PACKAGE_DIGEST,
|
|
});
|
|
const published = Object.freeze({
|
|
packageId: "@org-contracts/billing",
|
|
digest: `sha256:${"a".repeat(64)}` as const,
|
|
});
|
|
expect(PLACEHOLDER_CONTRACT_PACKAGE_DIGEST).toBe(`sha256:${"0".repeat(64)}`);
|
|
for (const target of ["staging", "production"] as const) {
|
|
expect(
|
|
findAdmissionViolations(
|
|
target,
|
|
{ ...PRODUCTION_ARTIFACT, APP_ENV: target },
|
|
[placeholder, published],
|
|
).map((violation) => violation.field),
|
|
target,
|
|
).toEqual(["contractPackages.@org-contracts/orders"]);
|
|
}
|
|
for (const target of ["local", "development"] as const) {
|
|
expect(
|
|
findAdmissionViolations(target, { ...LOCAL_ARTIFACT, APP_ENV: target }, [
|
|
placeholder,
|
|
]),
|
|
target,
|
|
).toEqual([]);
|
|
}
|
|
});
|
|
|
|
it("refuses the exact local build that release coherence used to approve", () => {
|
|
// The review's strongest reproduction: FE-GATE-015 passed on a build whose
|
|
// runtime document was APP_ENV=local / AUTH_MODE=demo / loopback API. Each
|
|
// of those is now an independent refusal, so fixing one does not admit it.
|
|
const violations = findAdmissionViolations("production", LOCAL_ARTIFACT);
|
|
const fields = violations.map((violation) => violation.field);
|
|
expect(fields).toContain("APP_ENV");
|
|
expect(fields).toContain("AUTH_MODE");
|
|
expect(fields).toContain("API_BASE_URL");
|
|
expect(fields).toContain("BUILD_ID");
|
|
expect(fields).toContain("RELEASE_ID");
|
|
});
|
|
|
|
it("refuses endpoints a browser on the public internet cannot reach", () => {
|
|
for (const host of [
|
|
"http://api.example.com/",
|
|
"https://localhost/",
|
|
"https://127.0.0.1/",
|
|
"https://10.0.0.5/",
|
|
"https://192.168.1.10/",
|
|
"https://172.16.4.4/",
|
|
"https://169.254.169.254/",
|
|
"https://[::1]/",
|
|
]) {
|
|
const violations = findAdmissionViolations("production", {
|
|
...PRODUCTION_ARTIFACT,
|
|
API_BASE_URL: host,
|
|
} as AdmissionInput);
|
|
expect(violations.map((violation) => violation.field), host).toContain(
|
|
"API_BASE_URL",
|
|
);
|
|
}
|
|
});
|
|
|
|
it("refuses IPv6, mapped, CGNAT, 0/8 and internal-name hosts (Q-6.7-10)", () => {
|
|
for (const host of [
|
|
"https://[::ffff:127.0.0.1]/",
|
|
"https://[::ffff:8.8.8.8]/",
|
|
"https://[fd00::1]/",
|
|
"https://[fc12:3456::1]/",
|
|
"https://[fe80::1]/",
|
|
"https://[febf::1]/",
|
|
"https://[0:0:0:0:0:0:0:1]/",
|
|
"https://100.64.0.1/",
|
|
"https://100.127.255.254/",
|
|
"https://0.1.2.3/",
|
|
"https://api.internal/",
|
|
"https://printer.local/",
|
|
"https://localhost./",
|
|
"https://api.internal./",
|
|
]) {
|
|
const violations = findAdmissionViolations("production", {
|
|
...PRODUCTION_ARTIFACT,
|
|
API_BASE_URL: host,
|
|
} as AdmissionInput);
|
|
expect(violations.map((violation) => violation.field), host).toContain(
|
|
"API_BASE_URL",
|
|
);
|
|
}
|
|
});
|
|
|
|
it("permits a routable public host", () => {
|
|
for (const host of [
|
|
"https://api.172.16.my-product.kr/",
|
|
"https://100.128.0.1/",
|
|
"https://100.63.255.255/",
|
|
"https://[2001:db8::1]/",
|
|
"https://[fec0::1]/",
|
|
"https://internal.my-product.kr/",
|
|
"https://local.my-product.kr/",
|
|
"https://myexample.com/",
|
|
"https://example.com.my-product.kr/",
|
|
"https://tested.kr/",
|
|
]) {
|
|
expect(
|
|
findAdmissionViolations("production", {
|
|
...PRODUCTION_ARTIFACT,
|
|
API_BASE_URL: host,
|
|
} as AdmissionInput),
|
|
host,
|
|
).toEqual([]);
|
|
}
|
|
});
|
|
|
|
// 1101/13-02. RFC 2606 and RFC 6761 reserve these names for examples and
|
|
// tests, so an endpoint on one is a template value that was never replaced.
|
|
it("refuses names reserved for examples and tests", () => {
|
|
for (const host of [
|
|
"https://example.com/",
|
|
"https://api.example.com/",
|
|
"https://telemetry.staging.example.net/",
|
|
"https://example.org./",
|
|
"https://api.example/",
|
|
"https://api.invalid/",
|
|
"https://desktop.test/",
|
|
"https://API.EXAMPLE.COM/",
|
|
]) {
|
|
const violations = findAdmissionViolations("production", {
|
|
...PRODUCTION_ARTIFACT,
|
|
API_BASE_URL: host,
|
|
} as AdmissionInput);
|
|
expect(violations, host).toEqual([
|
|
{ field: "API_BASE_URL", reason: expect.stringContaining("reserved") },
|
|
]);
|
|
}
|
|
});
|
|
|
|
it("refuses a placeholder identity on a public target", () => {
|
|
for (const buildId of ["local-build", "local", "dev", "unknown", ""]) {
|
|
const violations = findAdmissionViolations("production", {
|
|
...PRODUCTION_ARTIFACT,
|
|
BUILD_ID: buildId,
|
|
} as AdmissionInput);
|
|
expect(violations.map((violation) => violation.field), buildId).toContain(
|
|
"BUILD_ID",
|
|
);
|
|
}
|
|
});
|
|
|
|
it("treats an unknown target as not a target at all", () => {
|
|
for (const value of ["prod", "PRODUCTION", "", undefined, null, 1]) {
|
|
expect(isDeploymentTarget(value), String(value)).toBe(false);
|
|
}
|
|
for (const target of DEPLOYMENT_TARGETS) {
|
|
expect(isDeploymentTarget(target)).toBe(true);
|
|
}
|
|
});
|
|
});
|
|
|
|
const IDENTITY = Object.freeze({
|
|
VITE_BUILD_ID: "20260815.42",
|
|
RELEASE_ID: "r-2026.08.15-1",
|
|
});
|
|
// What a project commits to its profile; RUNTIME_* stands in for the edit here.
|
|
const PROJECT_ENDPOINTS = Object.freeze({
|
|
...IDENTITY,
|
|
RUNTIME_API_BASE_URL: "https://api.my-product.kr/",
|
|
RUNTIME_TELEMETRY_ENDPOINT: "https://telemetry.my-product.kr/v1/events",
|
|
});
|
|
|
|
describe("runtime config profiles", () => {
|
|
it("ships one valid profile per deployment target", async () => {
|
|
const files = (await readdir("config/runtime")).sort();
|
|
expect(files).toEqual(
|
|
[...DEPLOYMENT_TARGETS].map((target) => `${target}.json`).sort(),
|
|
);
|
|
for (const target of DEPLOYMENT_TARGETS) {
|
|
const source: unknown = JSON.parse(
|
|
await readFile(path.join("config/runtime", `${target}.json`), "utf8"),
|
|
);
|
|
const parsed = runtimeConfigV2ArtifactSchema.safeParse({
|
|
...(source as Record<string, unknown>),
|
|
BUILD_ID: "20260815.42",
|
|
RELEASE_ID: "r-1",
|
|
});
|
|
expect(parsed.success, `${target}: ${JSON.stringify(parsed.error?.issues)}`).toBe(
|
|
true,
|
|
);
|
|
expect((source as Record<string, unknown>)["APP_ENV"]).toBe(target);
|
|
}
|
|
});
|
|
|
|
// 1101/13-02. The public profiles ship example endpoints. A project that
|
|
// starts from the template and builds without editing them must be refused.
|
|
it("refuses a public build from the unedited profile on both endpoints", async () => {
|
|
for (const target of ["staging", "production"] as const) {
|
|
const config = await generateRuntimeConfig(target, IDENTITY);
|
|
expect(
|
|
findAdmissionViolations(target, config as unknown as AdmissionInput).map(
|
|
(violation) => violation.field,
|
|
),
|
|
target,
|
|
).toEqual(["API_BASE_URL", "TELEMETRY_ENDPOINT"]);
|
|
}
|
|
});
|
|
|
|
it("admits a public build once the project supplies its endpoints", async () => {
|
|
for (const target of ["staging", "production"] as const) {
|
|
const config = await generateRuntimeConfig(target, PROJECT_ENDPOINTS);
|
|
expect(
|
|
findAdmissionViolations(target, config as unknown as AdmissionInput),
|
|
).toEqual([]);
|
|
}
|
|
});
|
|
|
|
it("refuses a deployment override that would make the document unservable", async () => {
|
|
await expect(
|
|
generateRuntimeConfig("production", {
|
|
VITE_BUILD_ID: "20260815.42",
|
|
RELEASE_ID: "r-1",
|
|
RUNTIME_API_BASE_URL: "http://api.example.com/",
|
|
}),
|
|
).rejects.toThrow(/runtime config is invalid/u);
|
|
});
|
|
|
|
it("refuses a staging or production build without VITE_BUILD_ID (F-6)", async () => {
|
|
for (const target of ["staging", "production"] as const) {
|
|
await expect(
|
|
generateRuntimeConfig(target, { RELEASE_ID: "r-1" }),
|
|
).rejects.toThrow(/VITE_BUILD_ID/u);
|
|
await expect(
|
|
generateRuntimeConfig(target, { VITE_BUILD_ID: "", RELEASE_ID: "r-1" }),
|
|
).rejects.toThrow(/VITE_BUILD_ID/u);
|
|
}
|
|
});
|
|
|
|
it("declares the build defaults that getBuildConfig applies (F-6)", () => {
|
|
const applied = getBuildConfig({});
|
|
expect({
|
|
VITE_BUILD_ID: ENV_REGISTRY.VITE_BUILD_ID.defaultValue,
|
|
VITE_COMMIT_SHA: ENV_REGISTRY.VITE_COMMIT_SHA.defaultValue,
|
|
VITE_ROUTER_BASE_PATH: ENV_REGISTRY.VITE_ROUTER_BASE_PATH.defaultValue,
|
|
VITE_RUNTIME_CONFIG_URL: ENV_REGISTRY.VITE_RUNTIME_CONFIG_URL.defaultValue,
|
|
}).toEqual({
|
|
VITE_BUILD_ID: applied.buildId,
|
|
VITE_COMMIT_SHA: applied.commitSha,
|
|
VITE_ROUTER_BASE_PATH: applied.routerBasePath,
|
|
VITE_RUNTIME_CONFIG_URL: applied.runtimeConfigUrl,
|
|
});
|
|
});
|
|
|
|
it("keeps a developer build from carrying a released identity by default", async () => {
|
|
const config = await generateRuntimeConfig("local", {});
|
|
expect(config["BUILD_ID"]).toBe("local-build");
|
|
expect(
|
|
findAdmissionViolations("production", config as unknown as AdmissionInput)
|
|
.length,
|
|
).toBeGreaterThan(0);
|
|
});
|
|
|
|
// F-5 (13-15). `corepack pnpm dev` serves public/config.json while every
|
|
// build writes the local profile instead, so the two copies must not drift.
|
|
it("keeps public/config.json equal to what a local build writes", async () => {
|
|
const served: unknown = JSON.parse(await readFile("public/config.json", "utf8"));
|
|
expect(served).toEqual(await generateRuntimeConfig("local", {}));
|
|
});
|
|
|
|
// 13-01: the build profile and the admission target are two repository
|
|
// variables. A staging profile left in place for a production release has to
|
|
// stop the release, whatever the built document happens to say.
|
|
// U7 (decision 2): the script also refuses the compiled contract set while a
|
|
// feature from create:feature still pins the placeholder package, so with
|
|
// one installed the matching profile is refused for that reason only.
|
|
const placeholderInstalled = EXPECTED_CONTRACT_SET_PACKAGES.some(
|
|
({ digest }) => digest === PLACEHOLDER_CONTRACT_PACKAGE_DIGEST,
|
|
);
|
|
it.each([
|
|
["staging", 1],
|
|
["production", placeholderInstalled ? 1 : 0],
|
|
] as const)("admits a production artifact under APP_PROFILE=%s only when it names the target", async (profile, status) => {
|
|
const root = await mkdtemp(path.join(tmpdir(), "release-admission-profile-"));
|
|
try {
|
|
const config = await generateRuntimeConfig("production", PROJECT_ENDPOINTS);
|
|
await mkdir(path.join(root, "dist"), { recursive: true });
|
|
await writeFile(path.join(root, "dist/config.json"), JSON.stringify(config));
|
|
const result = spawnSync(
|
|
process.execPath,
|
|
[path.resolve("scripts/check-release-admission.ts")],
|
|
{
|
|
cwd: root,
|
|
encoding: "utf8",
|
|
env: { ...process.env, APP_PROFILE: profile, RELEASE_TARGET: "production" },
|
|
},
|
|
);
|
|
expect(result.status, result.stderr).toBe(status);
|
|
if (profile === "staging") {
|
|
expect(result.stderr).toMatch(/APP_PROFILE=staging/u);
|
|
} else {
|
|
expect(result.stderr).not.toMatch(/APP_PROFILE/u);
|
|
}
|
|
} finally {
|
|
await rm(root, { recursive: true, force: true });
|
|
}
|
|
});
|
|
});
|
|
|
|
// 1101/13-05. The emergency switches (CAPABILITY_OVERRIDES, FEATURE_OVERRIDES)
|
|
// are changed in the deployed config.json without a rebuild. A typo there stops
|
|
// every boot, so the edited copy is checked against the deployed one first.
|
|
describe("checking an edited copy of the deployed runtime config", () => {
|
|
async function check(
|
|
edit: (deployed: Record<string, unknown>) => Record<string, unknown>,
|
|
args: readonly string[] = ["--config", "edited.json", "--original", "deployed.json"],
|
|
) {
|
|
const root = await mkdtemp(path.join(tmpdir(), "release-admission-copy-"));
|
|
try {
|
|
const deployed = await generateRuntimeConfig("production", PROJECT_ENDPOINTS);
|
|
await writeFile(path.join(root, "deployed.json"), JSON.stringify(deployed));
|
|
await writeFile(path.join(root, "edited.json"), JSON.stringify(edit(deployed)));
|
|
const result = spawnSync(
|
|
process.execPath,
|
|
[path.resolve("scripts/check-release-admission.ts"), ...args],
|
|
{
|
|
cwd: root,
|
|
encoding: "utf8",
|
|
env: { ...process.env, APP_PROFILE: "production", RELEASE_TARGET: "production" },
|
|
},
|
|
);
|
|
const records = await readdir(path.join(root, "artifacts/release")).catch(() => []);
|
|
return { status: result.status, stderr: result.stderr, stdout: result.stdout, records };
|
|
} finally {
|
|
await rm(root, { recursive: true, force: true });
|
|
}
|
|
}
|
|
const withServiceWorker = (deployed: Record<string, unknown>, value: string) => ({
|
|
...deployed,
|
|
CAPABILITY_OVERRIDES: {
|
|
...(deployed["CAPABILITY_OVERRIDES"] as Record<string, unknown>),
|
|
SERVICE_WORKER: value,
|
|
},
|
|
});
|
|
|
|
it("admits a copy that only flips an emergency switch, without writing the build's record", async () => {
|
|
const result = await check((deployed) => withServiceWorker(deployed, "DISABLED"));
|
|
expect(result.status, result.stderr).toBe(0);
|
|
expect(result.stdout).toContain("edited.json");
|
|
expect(result.records).toEqual([]);
|
|
});
|
|
|
|
it("refuses a typo in a switch value", async () => {
|
|
const result = await check((deployed) => withServiceWorker(deployed, "DISABLE"));
|
|
expect(result.status).toBe(1);
|
|
expect(result.stderr).toMatch(/edited\.json is not a valid runtime config/u);
|
|
});
|
|
|
|
// A valid value, so only the comparison with the deployed copy can refuse it.
|
|
it.each([
|
|
["BUILD_ID", "20260815.43"],
|
|
["RELEASE_ID", "r-2026.08.15-2"],
|
|
["API_BASE_URL", "https://other.my-product.kr/"],
|
|
])("refuses a copy that changes %s, which only a build may change", async (field, value) => {
|
|
const result = await check((deployed) => ({ ...deployed, [field]: value }));
|
|
expect(result.status).toBe(1);
|
|
expect(result.stderr).toContain(`edited.json changes ${field}`);
|
|
});
|
|
|
|
it("refuses --config without the deployed original to compare with", async () => {
|
|
const result = await check((deployed) => deployed, ["--config", "edited.json"]);
|
|
expect(result.status).toBe(1);
|
|
expect(result.stderr).toContain("--original");
|
|
});
|
|
});
|