A misspelt kill-switch key was ignored without a trace, so the feature kept running. Boot now records feature.override.unknown once per such key, and release admission lists them as warnings in its record without refusing the artifact (a shared document may still name another build's features). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
135 lines
4.7 KiB
TypeScript
135 lines
4.7 KiB
TypeScript
import { mkdir, readFile, writeFile } from "node:fs/promises";
|
|
import process from "node:process";
|
|
|
|
import {
|
|
DEPLOYMENT_TARGETS,
|
|
findAdmissionViolations,
|
|
isDeploymentTarget,
|
|
type AdmissionInput,
|
|
} from "../src/contracts/deployment-admission.ts";
|
|
import { unknownProductFeatureOverrides } from "../src/contracts/product-features.ts";
|
|
import { parseRuntimeConfigArtifact } from "../src/contracts/release-artifacts.ts";
|
|
import { COMPILED_PRODUCT_FEATURE_IDS } from "../src/features/installed-product-manifest.ts";
|
|
|
|
/**
|
|
* §6.4 / FE-GATE-027. Refuses to admit an artifact to an environment it was not
|
|
* built for.
|
|
*
|
|
* Release coherence already proves the artifacts agree with each other. It
|
|
* cannot prove they belong in production, because a local build is coherent
|
|
* with itself: `APP_ENV: local`, `AUTH_MODE: demo` and a loopback API pass
|
|
* every existing gate. This gate closes that by making the destination an
|
|
* explicit, declared input and refusing anything that does not match it.
|
|
*
|
|
* It fails closed in both directions. An undeclared destination is a refusal,
|
|
* not a default, so an artifact can never be admitted by omission; and every
|
|
* rule is stated as a reason to refuse, so an unreadable field cannot pass.
|
|
*/
|
|
|
|
const RUNTIME_CONFIG_PATH = "dist/config.json";
|
|
const RECORD_PATH = "artifacts/release/deployment-admission.json";
|
|
|
|
async function main(): Promise<void> {
|
|
const declared = process.env["RELEASE_TARGET"];
|
|
if (!isDeploymentTarget(declared)) {
|
|
process.stderr.write(
|
|
"release admission refused: RELEASE_TARGET must be declared as one of " +
|
|
`${DEPLOYMENT_TARGETS.join(", ")}; received ${
|
|
declared === undefined ? "nothing" : declared
|
|
}.\n` +
|
|
"An artifact is never admitted by default — name the environment it is for.\n",
|
|
);
|
|
process.exitCode = 1;
|
|
return;
|
|
}
|
|
// 13-01: the build profile and the admission target are separate repository
|
|
// variables; a profile left on staging must not ship to production.
|
|
const profile = process.env["APP_PROFILE"];
|
|
if (profile !== undefined && profile !== declared) {
|
|
process.stderr.write(
|
|
`release admission refused: the artifact was built with APP_PROFILE=${profile} ` +
|
|
`but RELEASE_TARGET=${declared}. Set both to the same environment.\n`,
|
|
);
|
|
process.exitCode = 1;
|
|
return;
|
|
}
|
|
|
|
let document: unknown;
|
|
try {
|
|
document = JSON.parse(await readFile(RUNTIME_CONFIG_PATH, "utf8"));
|
|
} catch (error) {
|
|
process.stderr.write(
|
|
`release admission refused: ${RUNTIME_CONFIG_PATH} is unreadable: ${
|
|
error instanceof Error ? error.message : String(error)
|
|
}\n`,
|
|
);
|
|
process.exitCode = 1;
|
|
return;
|
|
}
|
|
|
|
let config: AdmissionInput;
|
|
try {
|
|
config = parseRuntimeConfigArtifact(document) as AdmissionInput;
|
|
} catch (error) {
|
|
process.stderr.write(
|
|
`release admission refused: ${RUNTIME_CONFIG_PATH} is not a valid runtime config: ${
|
|
error instanceof Error ? error.message : String(error)
|
|
}\n`,
|
|
);
|
|
process.exitCode = 1;
|
|
return;
|
|
}
|
|
|
|
const violations = findAdmissionViolations(declared, config);
|
|
// 09-09. Inert by design (a shared document may name another build's
|
|
// features), so this warns instead of refusing.
|
|
const warnings = unknownProductFeatureOverrides(
|
|
COMPILED_PRODUCT_FEATURE_IDS,
|
|
"FEATURE_OVERRIDES" in config ? config.FEATURE_OVERRIDES : undefined,
|
|
).map((featureId) => ({
|
|
field: `FEATURE_OVERRIDES.${featureId}`,
|
|
reason: `names no feature this build declares (${COMPILED_PRODUCT_FEATURE_IDS.join(", ") || "none"}); the override does nothing`,
|
|
}));
|
|
for (const warning of warnings) {
|
|
process.stderr.write(`release admission warning: ${warning.field} ${warning.reason}\n`);
|
|
}
|
|
await mkdir("artifacts/release", { recursive: true });
|
|
await writeFile(
|
|
RECORD_PATH,
|
|
`${JSON.stringify(
|
|
{
|
|
schemaVersion: 1,
|
|
target: declared,
|
|
appEnv: config.APP_ENV,
|
|
authMode: config.AUTH_MODE,
|
|
apiBaseUrl: config.API_BASE_URL,
|
|
buildId: config.BUILD_ID ?? null,
|
|
releaseId: config.RELEASE_ID ?? null,
|
|
status: violations.length === 0 ? "ADMITTED" : "REFUSED",
|
|
violations,
|
|
warnings,
|
|
},
|
|
null,
|
|
2,
|
|
)}\n`,
|
|
"utf8",
|
|
);
|
|
|
|
if (violations.length > 0) {
|
|
process.stderr.write(
|
|
`release admission refused for ${declared}:\n${violations
|
|
.map((violation) => ` ${violation.field}: ${violation.reason}`)
|
|
.join("\n")}\n`,
|
|
);
|
|
process.exitCode = 1;
|
|
return;
|
|
}
|
|
process.stdout.write(
|
|
`release admission: ${declared} ADMITTED ` +
|
|
`(APP_ENV=${config.APP_ENV}, AUTH_MODE=${config.AUTH_MODE}, ` +
|
|
`API=${config.API_BASE_URL}); record at ${RECORD_PATH}\n`,
|
|
);
|
|
}
|
|
|
|
await main();
|