문제: 코드 주석 87곳(74파일, .dependency-cruiser.json 포함)이 "Spec §N" 처럼 문서 이름 없이 절 번호만 적는다(대문자 83, 소문자 "spec §" 4). 가리키는 설계서는 README가 복사 뒤 지워도 된다고 한 docs/reviews/ 안에 있었다. 지울 수 있는 기록 검사는 경로 문자열만 찾아 이 참조를 잡지 못했다. 현재 계약 문서도 지울 수 있는 파일로 링크한다: docs/reviews/adapters/INVENTORY.md 145행이 옆의 adapter 리뷰로, docs/operations/adapter-remediation-ledger.md가 adapter 리뷰와 docs/superpowers/plans의 계획으로. 고른 방법: - 주석의 "Spec §"/"spec §"를 "scale-architecture.md §"로 바꾼다(앞 커밋이 옮긴 docs/architecture/scale-architecture.md). 설명 문장과 절 번호는 그대로다. 절 번호가 없는 "Spec §"는 없었다. - tests/unit/deletable-history-documents.test.ts에 "spec" + 선택 공백 + "§"(대소문자 무시)를 거부하는 검사를 더하고, 검사 대상에 .dependency-cruiser.json을 넣는다. - README "Files you can delete after copying"에서 INVENTORY.md 한 파일 대신 docs/reviews/adapters/ 폴더를 남기게 하고 이유(INVENTORY 행과 ledger가 그 리뷰로 링크한다)를 적는다. docs/README.md §3도 같게 고친다. INVENTORY의 행 구조는 바꾸지 않는다. - 남긴 adapter 리뷰와 ledger가 docs/superpowers/plans로 거는 링크 5곳은 링크를 풀고 "작업 이력 계획, 복사본은 지울 수 있다"로 적는다. 버린 대안: INVENTORY 145칸의 링크를 그룹 이름으로 바꾸기. 템플릿에서도 상세 리뷰로 가는 길이 없어지고 수정이 145곳이다. 계획 3개도 지우기 목록에서 빼기. 지울 수 있는 폴더 안에 예외가 흩어지고, 계획이 다시 다른 이력을 가리키면 남길 목록이 계속 커진다. 위험·한계: 검사는 "HTML spec §4"처럼 다른 명세를 "spec §"로 부르는 주석도 거부한다. 그때는 "HTML Standard §4"처럼 이름을 쓴다. src/contracts/storage-keys.ts:79의 "release-coherence plan Task 6"처럼 이름 없는 계획 참조는 이 검사가 잡지 않는다. 복사한 프로젝트가 이미 docs/reviews/adapters/를 지웠다면 링크는 계속 끊겨 있다. CHANGELOG.md의 이력 언급 4곳(:15 두 경로, :75 PRODUCT.md, :93)은 고치지 않았다. check:remediation-ledger는 이 변경 전후 같은 4줄로 실패한다(이미 있던 실패, 게이트 밖). tests/unit/telemetry.test.ts의 describe 이름 하나가 바뀐다. 검증: - RED: 치환 전 새 검사가 87줄을 들어 실패(1 failed | 1 passed). - GREEN: 같은 테스트 2 passed. 변이 "// Spec §4. budgets live here"를 src/platform/errors/app-error.ts에 넣으면 그 한 줄로 실패, 되돌림. - 치환 diff: 바뀐 87줄 쌍이 토큰 외에 같음(스크립트 대조, 불일치 0). - 삭제 실험(작업 트리 복사본에서 README 목록대로 지움): 끊긴 링크 148→0, 끊긴 경로 언급 10→4(남은 4는 CHANGELOG.md), 이름 없는 설계 참조 87→0, scale-architecture.md §N 87곳 중 없는 절 0. 같은 복사본에서 verify-documentation-readiness PASS_SCOPED, 지울 수 있는 기록 테스트 2 passed. - node scripts/verify-documentation-readiness.ts: PASS_SCOPED - node scripts/check-adapter-inventory.ts: PASS - node scripts/run-vitest.ts run tests/unit/deletable-history-documents.test.ts tests/unit/documentation-readiness.test.ts tests/unit/telemetry.test.ts: 50 passed. tests/architecture: 39 passed. - npx tsc --noEmit (app·node·test): 모두 통과. 바꾼 TS 74파일 eslint 통과. .dependency-cruiser.json JSON 파싱 통과. - 미실행: check:architecture(pnpm 필요).
144 lines
5.6 KiB
TypeScript
144 lines
5.6 KiB
TypeScript
import { readFile } from "node:fs/promises";
|
|
import path from "node:path";
|
|
|
|
import {
|
|
createFileSystemDeclarationSource,
|
|
type TopologyDeclarationSource,
|
|
} from "./generate-product-feature-index.ts";
|
|
|
|
/**
|
|
* scale-architecture.md §3 / §37. Build-input regression gate for deployable-app isolation.
|
|
*
|
|
* The app being built is the one recorded in `src/.generated/product-app.ts`.
|
|
* Its allowed features are exactly those owned (via their context) by that
|
|
* app's declarations. The gate fails when
|
|
* - a generated index imports a feature or declares a context outside that
|
|
* ownership set (e.g. a regression back to "import every src/features"),
|
|
* - the production bundle's module inventory contains a module of a feature
|
|
* the app does not own.
|
|
*/
|
|
export type AppBuildInputReport = Readonly<{
|
|
appId: string;
|
|
ownedContexts: readonly string[];
|
|
ownedFeatureDirectories: readonly string[];
|
|
generatedFeatureImports: readonly string[];
|
|
generatedContexts: readonly string[];
|
|
bundle: Readonly<{ checked: boolean; featureDirectories: readonly string[] }>;
|
|
violations: readonly string[];
|
|
}>;
|
|
|
|
const GENERATED = [
|
|
"src/.generated/product-feature-index.ts",
|
|
"src/.generated/product-context-index.ts",
|
|
"src/.generated/product-app.ts",
|
|
] as const;
|
|
|
|
function unique(values: Iterable<string>): string[] {
|
|
return [...new Set(values)].sort();
|
|
}
|
|
|
|
export async function inspectAppBuildInput(
|
|
root: string,
|
|
options: Readonly<{
|
|
source?: TopologyDeclarationSource;
|
|
bundleInventory?: string | null;
|
|
}> = {},
|
|
): Promise<AppBuildInputReport> {
|
|
const source = options.source ?? (await createFileSystemDeclarationSource(root));
|
|
const [featureIndex, contextIndex, appIndex] = await Promise.all(
|
|
GENERATED.map((file) => readFile(path.join(root, file), "utf8")),
|
|
);
|
|
const appId = /id:\s*"([^"]+)"/u.exec(appIndex ?? "")?.[1];
|
|
const violations: string[] = [];
|
|
if (!appId || !source.app(appId)) {
|
|
violations.push(`generated app ${appId ?? "<missing>"} is not a declared deployable app`);
|
|
}
|
|
const ownedContexts = appId ? source.contextsOf(appId).map((context) => context.id) : [];
|
|
const ownedFeatureDirectories = unique(
|
|
ownedContexts.flatMap((contextId) => source.featuresOf(contextId).map((feature) => feature.directory)),
|
|
);
|
|
const owned = new Set(ownedFeatureDirectories);
|
|
|
|
const featureDirectoriesIn = (text: string) =>
|
|
unique([...text.matchAll(/\.\.\/features\/([^/"']+)\//gu)].map((match) => match[1] as string));
|
|
const generatedFeatureImports = unique([
|
|
...featureDirectoriesIn(featureIndex ?? ""),
|
|
...featureDirectoriesIn(contextIndex ?? ""),
|
|
]);
|
|
for (const directory of generatedFeatureImports) {
|
|
if (!owned.has(directory)) {
|
|
violations.push(`generated index imports feature "${directory}" not owned by app ${appId}`);
|
|
}
|
|
}
|
|
const generatedContexts = unique(
|
|
[...(contextIndex ?? "").matchAll(/defineBoundedContextModule\(\{\s*id:\s*"([^"]+)"/gu)].map(
|
|
(match) => match[1] as string,
|
|
),
|
|
);
|
|
const ownedContextSet = new Set(ownedContexts);
|
|
for (const contextId of generatedContexts) {
|
|
if (!ownedContextSet.has(contextId)) {
|
|
violations.push(`generated index declares context "${contextId}" not owned by app ${appId}`);
|
|
}
|
|
}
|
|
|
|
let bundle: AppBuildInputReport["bundle"] = { checked: false, featureDirectories: [] };
|
|
const inventoryPath =
|
|
options.bundleInventory === undefined
|
|
? path.join(root, "artifacts/quality/vite-module-inventory.json")
|
|
: options.bundleInventory;
|
|
if (inventoryPath) {
|
|
const raw = await readFile(inventoryPath, "utf8").catch(() => null);
|
|
if (raw !== null) {
|
|
const inventory = JSON.parse(raw) as { chunks?: { modules?: string[] }[] };
|
|
const modules = (inventory.chunks ?? []).flatMap((chunk) => chunk.modules ?? []);
|
|
const featureDirectories = unique(
|
|
modules.flatMap((module) => {
|
|
const match = /^src\/features\/([^/]+)\//u.exec(module);
|
|
return match ? [match[1] as string] : [];
|
|
}),
|
|
);
|
|
bundle = { checked: true, featureDirectories };
|
|
for (const directory of featureDirectories) {
|
|
if (!owned.has(directory)) {
|
|
violations.push(`production bundle contains feature "${directory}" not owned by app ${appId}`);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return Object.freeze({
|
|
appId: appId ?? "",
|
|
ownedContexts: unique(ownedContexts),
|
|
ownedFeatureDirectories,
|
|
generatedFeatureImports,
|
|
generatedContexts,
|
|
bundle,
|
|
violations,
|
|
});
|
|
}
|
|
|
|
async function main(): Promise<void> {
|
|
// The bundle inventory is only meaningful right after a build of this tree;
|
|
// without `--require-bundle` the gate checks the generated indexes only, so a
|
|
// stale inventory from another build can never pass or fail it.
|
|
const requireBundle = process.argv.includes("--require-bundle");
|
|
const report = await inspectAppBuildInput(process.cwd(), requireBundle ? {} : { bundleInventory: null });
|
|
if (requireBundle && !report.bundle.checked) {
|
|
process.stderr.write("app build input: no production module inventory; run the build first\n");
|
|
process.exit(1);
|
|
}
|
|
for (const violation of report.violations) process.stderr.write(`FAIL ${violation}\n`);
|
|
process.stdout.write(
|
|
`app build input: app=${report.appId} contexts=${report.ownedContexts.length} ` +
|
|
`features=${report.ownedFeatureDirectories.length} generatedImports=${report.generatedFeatureImports.length} ` +
|
|
`bundle=${report.bundle.checked ? `${report.bundle.featureDirectories.length} feature dirs` : "not checked"} ` +
|
|
`${report.violations.length === 0 ? "PASS" : "FAIL"}\n`,
|
|
);
|
|
if (report.violations.length > 0) process.exitCode = 1;
|
|
}
|
|
|
|
if (import.meta.url === `file://${process.argv[1]}`) {
|
|
await main();
|
|
}
|