Files
clean-architecture-frontend…/src/contracts/storage-keys.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

219 lines
6.3 KiB
TypeScript

const APP_NAMESPACE = "ca-frontend";
export type StorageBackend =
| "memory"
| "sessionStorage"
| "localStorage"
| "disabled"
| "forbidden"
/**
* Another adapter owns the value format and writes the physical key itself.
* The registry only owns the name, so StoragePort refuses the key.
*/
| "external";
export type StorageValueCodec =
| "color-scheme-v1"
| "opaque-string-v1"
| "none";
export type StorageKeyInput = Readonly<{
logicalName: string;
scope: string;
name: string;
backend: StorageBackend;
classification:
| "public-preference"
| "opaque-cache"
| "sensitive-forbidden";
schemaVersion: number;
valueCodec: StorageValueCodec;
ttl: number | "session" | null;
migration: "discard";
quotaFallback: "memory" | "no-persist" | "feature-disable";
}>;
export type StorageDefinition = Readonly<
StorageKeyInput & { physicalKey: string }
>;
export const STORAGE_REGISTRY = Object.freeze({
COLOR_SCHEME: defineStorageKey({
logicalName: "COLOR_SCHEME",
scope: "preference",
name: "color-scheme",
backend: "localStorage",
classification: "public-preference",
schemaVersion: 1,
valueCodec: "color-scheme-v1",
ttl: null,
migration: "discard",
quotaFallback: "memory",
}),
/** The chosen UI locale. Presentation normalizes whatever it reads back. */
LOCALE: defineStorageKey({
logicalName: "LOCALE",
scope: "preference",
name: "locale",
backend: "localStorage",
classification: "public-preference",
schemaVersion: 1,
valueCodec: "opaque-string-v1",
ttl: null,
migration: "discard",
quotaFallback: "memory",
}),
CHUNK_RELOAD_GUARD: defineStorageKey({
logicalName: "CHUNK_RELOAD_GUARD",
scope: "release",
name: "chunk-reload-guard",
backend: "sessionStorage",
classification: "opaque-cache",
schemaVersion: 1,
valueCodec: "opaque-string-v1",
ttl: "session",
migration: "discard",
quotaFallback: "no-persist",
}),
/**
* scale-architecture.md §45 / release-coherence plan Task 6. One reload-once marker per boot
* release-mismatch key, so a mixed rolling release can recover with one
* fresh HTML fetch but can never reload-loop.
*/
RELEASE_MISMATCH_RECOVERY: defineStorageKey({
logicalName: "RELEASE_MISMATCH_RECOVERY",
scope: "release",
name: "boot-mismatch-recovery",
backend: "sessionStorage",
classification: "opaque-cache",
schemaVersion: 1,
valueCodec: "opaque-string-v1",
ttl: "session",
migration: "discard",
quotaFallback: "no-persist",
}),
QUERY_PERSISTENCE: defineStorageKey({
logicalName: "QUERY_PERSISTENCE",
scope: "cache",
name: "query-persistence",
backend: "disabled",
classification: "sensitive-forbidden",
schemaVersion: 1,
valueCodec: "none",
ttl: null,
migration: "discard",
quotaFallback: "feature-disable",
}),
/**
* 05-01. The cross-context invalidation adapter writes raw wire JSON to this
* localStorage key with no envelope. Only the physical key name lives here.
* The key string is a channel between deployed tabs and must not change.
*/
CACHE_INVALIDATION_PULSE: defineStorageKey({
logicalName: "CACHE_INVALIDATION_PULSE",
scope: "cache-invalidation",
name: "pulse",
backend: "external",
classification: "opaque-cache",
schemaVersion: 1,
valueCodec: "none",
ttl: null,
migration: "discard",
quotaFallback: "no-persist",
}),
AUTH_TOKEN: defineStorageKey({
logicalName: "AUTH_TOKEN",
scope: "auth",
name: "auth-token",
backend: "forbidden",
classification: "sensitive-forbidden",
schemaVersion: 1,
valueCodec: "none",
ttl: null,
migration: "discard",
quotaFallback: "feature-disable",
}),
});
export function defineStorageKey<Definition extends StorageKeyInput>(
definition: Definition,
): Readonly<Definition & { physicalKey: string }> {
if (
!["color-scheme-v1", "opaque-string-v1", "none"].includes(
definition.valueCodec,
)
) {
throw new Error("Unknown client storage value codec");
}
if (definition.migration !== "discard") {
throw new Error("Unsupported client storage migration policy");
}
if (definition.classification === "sensitive-forbidden") {
if (!["disabled", "forbidden"].includes(definition.backend)) {
throw new Error("Sensitive client storage registration is forbidden");
}
if (definition.valueCodec !== "none") {
throw new Error("Sensitive client storage codec is forbidden");
}
} else if (definition.backend === "external") {
if (definition.valueCodec !== "none") {
throw new Error("Externally owned storage keys have no StoragePort codec");
}
} else if (definition.valueCodec === "none") {
throw new Error("Persisted storage keys require a value codec");
}
if (!Number.isInteger(definition.schemaVersion) || definition.schemaVersion < 1) {
throw new Error("Storage schemaVersion must be a positive integer");
}
return Object.freeze({
...definition,
physicalKey: buildPhysicalKey(
definition.scope,
definition.schemaVersion,
definition.name,
),
});
}
export function buildPhysicalKey(
scope: string,
schemaVersion: number,
name: string,
): string {
return `${APP_NAMESPACE}:${scope}:v${schemaVersion}:${name}`;
}
export function getStorageDefinition(logicalName: string): StorageDefinition {
const registry: Readonly<Record<string, StorageDefinition>> = STORAGE_REGISTRY;
const definition = Object.hasOwn(registry, logicalName)
? registry[logicalName]
: undefined;
if (!definition) throw new Error(`Unregistered storage key: ${logicalName}`);
if (definition.classification === "sensitive-forbidden") {
throw new Error(`Forbidden storage key: ${logicalName}`);
}
if (definition.backend === "external") {
throw new Error(`Externally owned storage key: ${logicalName}`);
}
return definition;
}
export function isStorageValueAllowed(
definition: StorageDefinition,
value: unknown,
): boolean {
switch (definition.valueCodec) {
case "color-scheme-v1":
return value === "light" || value === "dark" || value === "system";
case "opaque-string-v1":
return (
typeof value === "string" &&
value.length >= 1 &&
value.length <= 2_048
);
default:
return false;
}
}