Files
clean-architecture-frontend…/scripts/scale/check-scale-baseline.ts
T
DongHyeonka b26517e6f2 fix(docs): 설계 주석에 문서 이름을 붙이고 지운 뒤 끊기는 링크를 없앤다 (1101/14-01)
문제: 코드 주석 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 필요).
2026-11-03 07:17:49 +09:00

114 lines
4.4 KiB
TypeScript

import { spawnSync } from "node:child_process";
import { mkdir, readFile, writeFile } from "node:fs/promises";
import path from "node:path";
import { collectTscScale } from "./collect-tsc-diagnostics.ts";
import { runCompositionScale } from "./run-composition-scale.ts";
import {
approveBaseline,
compareToBaseline,
currentEnvironment,
snapshotMetrics,
type ScaleBaseline,
} from "./scale-baseline.ts";
/**
* scale-architecture.md §48–§49. Relative regression gate against the stored, approved scale
* baseline (`config/scale/benchmark-baseline.json`).
*
* node scripts/scale/check-scale-baseline.ts compare, fail on regression
* SCALE_BASELINE_OWNER=... SCALE_BASELINE_REASON=... \
* node scripts/scale/check-scale-baseline.ts --update re-measure and re-approve
*
* The comparison is written to artifacts/scale/baseline-comparison.json (or
* `--artifact=`). Updating is an explicit, attributed act; the check never
* rewrites the baseline.
*/
export const BASELINE_PATH = "config/scale/benchmark-baseline.json";
export const LOCAL_TSC_SIZES = Object.freeze([25, 100, 400]);
function typescriptVersion(): string {
const result = spawnSync(path.resolve("node_modules/.bin/tsc"), ["-v"], { encoding: "utf8" });
const match = /Version\s+(\S+)/u.exec(result.stdout ?? "");
if (!match?.[1]) throw new Error("cannot determine TypeScript version");
return match[1];
}
async function measure() {
const composition = await runCompositionScale(["S0", "S1", "S2"], { samples: 9, warmup: 2 });
const compiler = await collectTscScale(LOCAL_TSC_SIZES);
return snapshotMetrics(composition.results, compiler);
}
async function main(): Promise<void> {
const update = process.argv.includes("--update");
const artifact = path.resolve(
process.argv.find((entry) => entry.startsWith("--artifact="))?.slice("--artifact=".length) ??
"artifacts/scale/baseline-comparison.json",
);
const environment = currentEnvironment(typescriptVersion());
const metrics = await measure();
if (update) {
const owner = process.env["SCALE_BASELINE_OWNER"];
const reason = process.env["SCALE_BASELINE_REASON"];
if (!owner || !reason) {
process.stderr.write("SCALE_BASELINE_OWNER and SCALE_BASELINE_REASON are required.\n");
process.exit(1);
}
const baseline = approveBaseline(environment, metrics, {
owner,
reason,
approvedAt: new Date().toISOString(),
});
await mkdir(path.dirname(BASELINE_PATH), { recursive: true });
await writeFile(BASELINE_PATH, `${JSON.stringify(baseline, null, 2)}\n`);
process.stdout.write(`scale baseline approved: ${baseline.approval.metricsDigest}\n`);
return;
}
let baseline: ScaleBaseline;
try {
baseline = JSON.parse(await readFile(BASELINE_PATH, "utf8")) as ScaleBaseline;
} catch {
process.stderr.write(`missing or unreadable ${BASELINE_PATH}; run update:scale-baseline\n`);
process.exit(1);
}
const comparison = compareToBaseline(baseline, environment, metrics);
await mkdir(path.dirname(artifact), { recursive: true });
await writeFile(
artifact,
`${JSON.stringify(
{ schemaVersion: 1, generatedAt: new Date().toISOString(), environment, baselineApproval: baseline.approval, ...comparison },
null,
2,
)}\n`,
);
const { compatibility } = comparison;
process.stdout.write(
`compatibility: structural=${compatibility.structural.ok} compiler=${compatibility.compiler.ok} timing=${compatibility.timing.ok}\n`,
);
if (!compatibility.timing.ok) {
process.stdout.write(
`timing regression NOT compared (incomplete): ${compatibility.timing.reasons.join("; ")}\n`,
);
}
process.stdout.write(
`axes: absolute ${comparison.absolute.findings.length} (${comparison.absolute.passed ? "ok" : "FAIL"}), ` +
`growth ${comparison.growth.findings.length} (${comparison.growth.passed ? "ok" : "FAIL"}), ` +
`relative ${comparison.compiler.length} compiler + ${comparison.timing.length} timing\n`,
);
for (const failure of comparison.failures) process.stdout.write(`FAIL ${failure}\n`);
process.stdout.write(
`scale baseline gate: ${comparison.status.toUpperCase()} (${path.relative(process.cwd(), artifact)})\n`,
);
if (comparison.status === "failed") process.exitCode = 1;
else if (comparison.status === "incomplete" && process.env["SCALE_ALLOW_INCOMPLETE"] !== "1") {
process.exitCode = 1;
}
}
if (import.meta.url === `file://${process.argv[1]}`) {
await main();
}