문제: 코드 주석 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 필요).
208 lines
7.2 KiB
TypeScript
208 lines
7.2 KiB
TypeScript
import { createHash } from "node:crypto";
|
|
|
|
import { planTopologyCapacity } from "../../src/platform/cardinality/topology-capacity.ts";
|
|
import {
|
|
selectAppIndexes,
|
|
type ContextDeclaration,
|
|
type FeatureDeclaration,
|
|
type TopologyDeclarationSource,
|
|
} from "../../scripts/generate-product-feature-index.ts";
|
|
import {
|
|
APP_CONTEXT_BUDGET,
|
|
CONTEXT_FEATURE_BUDGET,
|
|
SYNTHETIC_APP_SHAPE,
|
|
} from "./scale-profile.ts";
|
|
|
|
/**
|
|
* scale-architecture.md §37. A compact model of a global product topology.
|
|
*
|
|
* Only counts are stored. An app's contexts and feature ids are derived on
|
|
* demand from its index, so a 1,000,000-feature topology costs a handful of
|
|
* numbers plus whatever single app a test actually inspects.
|
|
*/
|
|
export type SyntheticContext = Readonly<{
|
|
id: string;
|
|
routePath: string;
|
|
featureIds: readonly string[];
|
|
}>;
|
|
|
|
export type SyntheticApp = Readonly<{
|
|
id: string;
|
|
localFeatureCount: number;
|
|
contexts: readonly SyntheticContext[];
|
|
}>;
|
|
|
|
export type SyntheticTopology = Readonly<{
|
|
globalFeatures: number;
|
|
appCount: number;
|
|
contextCount: number;
|
|
apps: Readonly<{ length: number; [index: number]: SyntheticApp }>;
|
|
app(id: string): SyntheticApp;
|
|
}>;
|
|
|
|
function contextFor(appIndex: number, contextIndex: number, features: number): SyntheticContext {
|
|
const id = `app${appIndex}-ctx${contextIndex}`;
|
|
return Object.freeze({
|
|
id,
|
|
routePath: `ctx${contextIndex}/*`,
|
|
featureIds: Object.freeze(
|
|
Array.from({ length: features }, (_, featureIndex) => `${id}-f${featureIndex}`),
|
|
),
|
|
});
|
|
}
|
|
|
|
export function createSyntheticTopology(
|
|
options: Readonly<{ globalFeatures: number }>,
|
|
): SyntheticTopology {
|
|
const { contextsPerApp, featuresPerContext } = SYNTHETIC_APP_SHAPE;
|
|
const plan = planTopologyCapacity({
|
|
featureCount: options.globalFeatures,
|
|
maxFeaturesPerContext: featuresPerContext,
|
|
maxContextsPerApp: contextsPerApp,
|
|
});
|
|
const featuresPerApp = contextsPerApp * featuresPerContext;
|
|
const cache = new Map<number, SyntheticApp>();
|
|
|
|
function build(appIndex: number): SyntheticApp {
|
|
const cached = cache.get(appIndex);
|
|
if (cached) return cached;
|
|
const firstFeature = appIndex * featuresPerApp;
|
|
const localFeatureCount = Math.max(
|
|
0,
|
|
Math.min(featuresPerApp, options.globalFeatures - firstFeature),
|
|
);
|
|
const contextCount = Math.ceil(localFeatureCount / featuresPerContext);
|
|
const app = Object.freeze({
|
|
id: `app-${appIndex}`,
|
|
localFeatureCount,
|
|
contexts: Object.freeze(
|
|
Array.from({ length: contextCount }, (_, contextIndex) =>
|
|
contextFor(
|
|
appIndex,
|
|
contextIndex,
|
|
Math.min(featuresPerContext, localFeatureCount - contextIndex * featuresPerContext),
|
|
),
|
|
),
|
|
),
|
|
});
|
|
// Inspecting an app is local work; the cache never exceeds what the test
|
|
// itself asked for.
|
|
cache.set(appIndex, app);
|
|
return app;
|
|
}
|
|
|
|
const apps = new Proxy(Object.freeze({ length: plan.appCount }), {
|
|
get(target, property) {
|
|
if (typeof property === "string" && /^\d+$/u.test(property)) {
|
|
const index = Number(property);
|
|
return index < plan.appCount ? build(index) : undefined;
|
|
}
|
|
return Reflect.get(target, property);
|
|
},
|
|
}) as SyntheticTopology["apps"];
|
|
|
|
return Object.freeze({
|
|
globalFeatures: options.globalFeatures,
|
|
appCount: plan.appCount,
|
|
contextCount: plan.contextCount,
|
|
apps,
|
|
app(id: string) {
|
|
const match = /^app-(\d+)$/u.exec(id);
|
|
const index = match ? Number(match[1]) : Number.NaN;
|
|
if (!Number.isSafeInteger(index) || index >= plan.appCount) {
|
|
throw new RangeError(`unknown synthetic app ${id}`);
|
|
}
|
|
return build(index);
|
|
},
|
|
});
|
|
}
|
|
|
|
export type DeclarationReads = { apps: number; contexts: number; features: number };
|
|
|
|
/**
|
|
* The synthetic topology as a production `TopologyDeclarationSource`: the same
|
|
* ownership-indexed interface the filesystem source implements. It counts how
|
|
* many declarations the production selection actually reads, which is the
|
|
* locality evidence at 1,000,000 logical features.
|
|
*/
|
|
export function declarationSource(
|
|
topology: SyntheticTopology,
|
|
): TopologyDeclarationSource & Readonly<{ reads: DeclarationReads }> {
|
|
const reads: DeclarationReads = { apps: 0, contexts: 0, features: 0 };
|
|
const appIndex = (appId: string) => {
|
|
const match = /^app-(\d+)$/u.exec(appId);
|
|
const index = match ? Number(match[1]) : Number.NaN;
|
|
return Number.isSafeInteger(index) && index < topology.appCount ? index : -1;
|
|
};
|
|
const contextOwner = (contextId: string) => {
|
|
const match = /^app(\d+)-ctx(\d+)$/u.exec(contextId);
|
|
return match ? { app: `app-${match[1]}`, context: Number(match[2]) } : null;
|
|
};
|
|
return Object.freeze({
|
|
reads,
|
|
appIds() {
|
|
// Listing app ids is O(apps), never O(features); the generator only
|
|
// needs it when no app is selected explicitly.
|
|
return Array.from({ length: topology.appCount }, (_, index) => `app-${index}`);
|
|
},
|
|
app(appId: string) {
|
|
if (appIndex(appId) < 0) return undefined;
|
|
reads.apps += 1;
|
|
return { id: appId, maxContexts: APP_CONTEXT_BUDGET };
|
|
},
|
|
contextsOf(appId: string): readonly ContextDeclaration[] {
|
|
if (appIndex(appId) < 0) return [];
|
|
const contexts = topology.app(appId).contexts;
|
|
reads.contexts += contexts.length;
|
|
return contexts.map((context) => ({
|
|
id: context.id,
|
|
appId,
|
|
routePath: context.routePath,
|
|
maxFeatures: CONTEXT_FEATURE_BUDGET,
|
|
}));
|
|
},
|
|
featuresOf(contextId: string): readonly FeatureDeclaration[] {
|
|
const owner = contextOwner(contextId);
|
|
if (!owner || appIndex(owner.app) < 0) return [];
|
|
const context = topology.app(owner.app).contexts[owner.context];
|
|
if (!context) return [];
|
|
reads.features += context.featureIds.length;
|
|
return context.featureIds.map((id) => ({ id, contextId, directory: id }));
|
|
},
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Everything one deployable app compiles and boots with, produced by the
|
|
* production generator's own app selection (`selectAppIndexes`).
|
|
*/
|
|
export function selectAppInputs(topology: SyntheticTopology, appId: string) {
|
|
const source = declarationSource(topology);
|
|
const selected = selectAppIndexes(source, appId);
|
|
const contextIds = [...new Set(selected.entries.map((entry) => entry.contextId))];
|
|
const generated = [selected.featureIndex, selected.contextIndex, selected.appIndex];
|
|
// Every module the generated entries hand to the compiler/bundler (static
|
|
// and lazy imports), resolved from `src/.generated/`.
|
|
const compileInputPaths = [
|
|
...new Set(
|
|
generated.flatMap((text) =>
|
|
[...text.matchAll(/(?:from\s+|import\()\s*"(\.\.\/[^"]+)"/gu)].map((match) =>
|
|
`src/${(match[1] as string).slice("../".length)}`,
|
|
),
|
|
),
|
|
),
|
|
].sort();
|
|
return Object.freeze({
|
|
contextIds,
|
|
featureIds: selected.entries.map((entry) => entry.id),
|
|
routeRootIds: [...new Set(selected.entries.map((entry) => entry.contextRoutePath))],
|
|
generatedFeatureIndex: selected.featureIndex,
|
|
generatedContextIndex: selected.contextIndex,
|
|
generatedAppIndex: selected.appIndex,
|
|
generatedHashes: generated.map((text) => createHash("sha256").update(text).digest("hex")),
|
|
compileInputPaths,
|
|
contextBudget: APP_CONTEXT_BUDGET,
|
|
reads: { ...source.reads },
|
|
});
|
|
}
|