Files
clean-architecture-frontend…/tests/architecture/observability-boundaries.test.ts
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

115 lines
4.4 KiB
TypeScript

import { readFile, readdir } from "node:fs/promises";
import path from "node:path";
import { describe, expect, it } from "vitest";
/**
* scale-architecture.md §17 / §24 / §50. Observability boundary gates:
* - feature (and every non-adapter) code never imports a vendor telemetry SDK,
* - no global union of every feature error or telemetry payload exists,
* - the dependency rule that enforces the first point stays configured.
*/
const ROOT = path.resolve(".");
async function productionSources(directory = path.join(ROOT, "src")): Promise<string[]> {
const files: string[] = [];
for (const entry of await readdir(directory, { withFileTypes: true })) {
const target = path.join(directory, entry.name);
if (entry.isDirectory()) files.push(...(await productionSources(target)));
else if (/\.tsx?$/u.test(entry.name) && !/\.d\.ts$/u.test(entry.name)) {
files.push(target);
}
}
return files;
}
async function readProductionSources(): Promise<string> {
const files = await productionSources();
const sources = await Promise.all(files.map((file) => readFile(file, "utf8")));
return sources.join("\n");
}
type DependencyRule = Readonly<{
name: string;
from: Readonly<{ path?: string; pathNot?: string }>;
to: Readonly<{ path?: string }>;
}>;
async function dependencyRules(): Promise<readonly DependencyRule[]> {
const config = JSON.parse(
await readFile(path.join(ROOT, ".dependency-cruiser.json"), "utf8"),
) as { forbidden: DependencyRule[] };
return config.forbidden;
}
const VENDOR_SDKS = [
"@sentry/browser",
"@sentry/react",
"@datadog/browser-rum",
"@datadog/browser-logs",
"@opentelemetry/api",
"@newrelic/browser-agent",
"logrocket",
"posthog-js",
];
describe("observability boundaries", () => {
it("configures a rule that rejects vendor SDK imports outside adapters", async () => {
const rule = (await dependencyRules()).find(
({ name }) => name === "observability-vendors-live-behind-adapters",
);
expect(rule).toBeDefined();
const from = new RegExp(rule?.from.path ?? "$^", "u");
const fromNot = new RegExp(rule?.from.pathNot ?? "$^", "u");
const to = new RegExp(rule?.to.path ?? "$^", "u");
const applies = (source: string, target: string) =>
from.test(source) && !fromNot.test(source) && to.test(target);
for (const vendor of VENDOR_SDKS) {
expect(applies("src/features/catalog/application/x.ts", vendor), vendor).toBe(true);
expect(applies("src/platform/telemetry/x.ts", vendor), vendor).toBe(true);
expect(applies("src/adapters/telemetry/vendor-transport.ts", vendor), vendor).toBe(false);
}
expect(applies("src/features/a/x.ts", "react")).toBe(false);
expect(applies("src/features/a/x.ts", "@sentry-like/other")).toBe(false);
});
it("finds no vendor telemetry SDK import in production sources outside adapters", async () => {
const offenders: string[] = [];
const vendorImport =
/from\s+["'](@sentry|@datadog|@opentelemetry|@newrelic|newrelic|logrocket|posthog-js|mixpanel-browser|@amplitude|@bugsnag)(\/[^"']*)?["']/u;
for (const file of await productionSources()) {
const relative = path.relative(ROOT, file).split(path.sep).join("/");
if (relative.startsWith("src/adapters/")) continue;
if (vendorImport.test(await readFile(file, "utf8"))) offenders.push(relative);
}
expect(offenders).toEqual([]);
});
it("does not define installed/global unions of all feature errors or telemetry payloads", async () => {
const source = await readProductionSources();
expect(source).not.toMatch(
/AllFeatureErrors|GlobalFeatureErrors|GlobalApplicationError|InstalledFeatureErrors|AllTelemetryEvents|AllFeatureTelemetry/u,
);
});
it("keeps the platform kernel independent of concrete product modules", async () => {
const rule = (await dependencyRules()).find(
({ name }) => name === "platform-kernel-is-product-neutral",
);
expect(rule).toBeDefined();
const offenders: string[] = [];
for (const file of await productionSources(path.join(ROOT, "src/platform"))) {
const relative = path.relative(ROOT, file).split(path.sep).join("/");
if (relative.startsWith("src/platform/routing/")) continue;
const source = await readFile(file, "utf8");
if (/from\s+["']\.\.\/\.\.\/(features|contexts|apps|adapters|bootstrap|presentation|application)\//u.test(source)) {
offenders.push(relative);
}
}
expect(offenders).toEqual([]);
});
});