Files
clean-architecture-frontend…/tests/unit/two-feature-install-typecheck.test.ts
T
DongHyeonka 12f3bb7862 refactor(contracts)!: V2 API 행을 지우고 FE-REG-API를 HTTP descriptor에서 뽑는다
문제
기능 하나가 같은 HTTP API를 두 번 적는다. *-api-contract.ts의 V2 행
(defineRestOperation)은 check:registries(FE-REG-API)가 검사하는 선언이고,
contract contribution의 V3 descriptor가 실제로 실행된다. 둘이 어긋나지 않게
http-operation-v2-v3-parity 테스트를 따로 둔다. 048f490으로 V2 클라이언트가
없어져 V2 행을 읽는 실행 코드는 없고, 검사만 남은 두 번째 사본이다. V2 행을
위한 기능별 runtimeSchemas·mappers 레지스트리와 V2 보안 프로필 해석
(resolveRestSecurityProfiles)도 같이 남아 있다. 사용자 지시: 최신 경로 하나만
남기고, 레지스트리 기준선 재승인을 승인했다.

고른 방법
- src/contracts/api-operations.ts를 projectApiOperationRows 하나로 바꿨다.
  조립된 contribution의 descriptor마다 operationId, featureId, method, path,
  authProfileId, retrySemantics, requestBody, responseBody, responseEnvelope,
  request/response/problemSchema(검증기 schemaId) 행을 만든다. FE-REG-API는
  같은 export(API_OPERATIONS)를 읽고, governance 정의를 이 필드로 바꿨다.
  requestSchema·responseSchema는 그대로 FE-REG-SCHEMA를 참조한다.
- FeatureRuntime은 apiContract 대신 schemas(FE-REG-SCHEMA 행)만 받는다.
  installed-feature-runtime-registries는 schemas로 스키마 레지스트리를 만들고
  FE-REG-API 행을 descriptor에서 뽑는다. RUNTIME_SCHEMA_CODECS, MAPPER_REGISTRY,
  REST_PROFILE_BINDINGS_VALID, API_RUNTIME_BINDINGS_VALID를 지웠다.
- realtime snapshot 바인딩은 ApiOperationRow를 받고 method GET과
  retrySemantics SAFE·IDEMPOTENT를 본다(V2의 contractVersion·semantics·
  replayPolicy 대신).
- rest-profiles.ts에서 V2 행용 provider·CSRF 프로필 해석을 지웠다. V3는 조립
  때 auth profile을 검사하고 자격증명 헤더를 프로필로 거른다.
- 참조 기능: reference-api-contract.ts를 reference-schema-metadata.ts로
  바꾸고(스키마 행만), V2 runtime codec·operation mapper·레지스트리 mapper를
  지웠다. V3 descriptor가 쓰지 않는 NoRequest 스키마 행도 지웠다.
- create:feature: <base>-api-contract.ts 대신 <base>-schema-metadata.ts를
  만든다. codec·mapper 레지스트리 행과 그 테스트를 만들지 않는다.
- 레지스트리 기준선을 update:registry-baseline으로 다시 만들고 승인했다
  (digest 16f72742…, 승인자 DongHyeonka, 이유에 사용자 승인을 적음).
- 매뉴얼 01·02·reference, starter-experience, 계약 문서의 V2 설명을 지웠다.

버린 대안
- V2 행을 남기고 V3에서 생성하기: 생성 단계와 생성물이 하나 더 생긴다. 행은
  실행되지 않으므로 메모리에서 뽑아 검사하면 충분하다.
- 스키마 메타데이터(FE-REG-SCHEMA 행)도 검증기에서 뽑기: boundary·
  unknownFieldPolicy·owner는 검증기에 없고, 라우트 스키마도 같은 레지스트리를
  쓴다. 이 행은 V2가 아니라 스키마 레지스트리라 남겼다.

위험·한계
- BREAKING: FeatureRuntime 모양, contracts·rest-profiles·loaded-feature-runtimes
  의 이름이 바뀌거나 없어졌다. memento-frontend의 memento-web이 V2 행을 쓴다.
  옮기는 법은 CHANGELOG에 적는다.
- V2 보안 프로필 일관성 검사(auth "none"과 ANONYMOUS, 쿠키 프로필의 CSRF
  모드)가 사라졌다. V3 descriptor에는 그 칸이 없다.
- BoundedPollOperationContract(realtime polling recipe)는 contractVersion: 2
  필드를 갖지만 자체 계약이라 바꾸지 않았다.

검증
- check:types, lint, check:architecture, check:registries(11 registries PASS,
  compatibility=none), check:ci, check:diagnostics, check:adapter-inventory,
  verify:documentation 통과.
- test:unit 2,566(새 tests/unit/api-operation-rows.test.ts 3건 포함),
  test:integration 114, test:component 245, test:contract 23,
  test:runtime-schema 56, tests/features 99 통과.
- tests/unit/second-api-feature-registries.test.ts: V3 descriptor만 가진 두
  번째 기능을 복사본에 넣으면 기준선을 고치지 않고 check:registries가 통과한다.
- check:bundle 통과. 초기 JS 201,598 → 200,911 B.
- test:feature-scaffold 16개, test:sample-removal 23개 검사 통과.

BREAKING CHANGE: FeatureRuntime이 apiContract 대신 schemas를 받는다.
defineRestOperation, ApiOperation, RestOperationV2, composeApiOperations,
validateApiRuntimeBindings, getApiOperation, contracts의 API_OPERATIONS,
createRestProviderProfile, RestProviderProfile, resolveRestSecurityProfiles,
validateRestProfileBindings, REST_CSRF_PROFILES, RestCsrfProfile,
loaded-feature-runtimes의 RUNTIME_SCHEMA_CODECS, MAPPER_REGISTRY,
REST_PROFILE_BINDINGS_VALID, API_RUNTIME_BINDINGS_VALID가 없어졌다. 기능은
operation을 contract contribution에만 적고, schemas 행을 feature-runtime에
넘긴다.
2026-11-03 21:37:48 +09:00

190 lines
6.5 KiB
TypeScript

import { spawnSync } from "node:child_process";
import { cp, mkdir, mkdtemp, readFile, rm, writeFile } from "node:fs/promises";
import { tmpdir } from "node:os";
import path from "node:path";
import { afterAll, describe, expect, it } from "vitest";
import { linkFixtureNodeModules } from "../../scripts/lib/fixture-node-modules.ts";
/**
* 09-01. The central composers (`src/features/installed-*`) are typed from the
* generated feature index, so the repository's own typecheck only ever sees
* the features it ships. This installs two more into a copy of `src`, in a
* context of their own so the check survives the sample's removal: one with a
* route, route codecs and both locales but no adapter, and one shaped
* differently on every composed axis (an adapter that needs telemetry, no
* routes, no codecs, one locale). Each declares its executable half in a
* separate \`feature-runtime.ts\` loaded through \`loadRuntime\` (15-01). It
* regenerates the index with the production generator and runs the app
* typecheck over the copy.
*/
const SECOND_FEATURE_MODULE = `import { defineFeatureModule } from "../feature-module.ts";
export const FEATURE_MODULE_ID = "second-feature";
export const FEATURE_CONTEXT_ID = "two-feature-context";
export const FEATURE_MODULE = defineFeatureModule({
id: FEATURE_MODULE_ID,
contracts: {
featureId: FEATURE_MODULE_ID,
routes: {},
routeRuntimeContracts: {},
// Frozen empty arrays type as \`readonly never[]\`, not \`readonly []\`.
invalidation: {
topics: Object.freeze([]),
namespaces: Object.freeze([]),
edges: Object.freeze([]),
},
topicVersions: Object.freeze([]),
contractPackages: Object.freeze([]),
},
routes: {},
messages: { "en-US": { "secondFeature.title": "Second feature" } },
loadRuntime: async () => (await import("./feature-runtime.ts")).FEATURE_RUNTIME,
} as const);
`;
const SECOND_FEATURE_RUNTIME = `import { defineFeatureAdapterContribution } from "../feature-adapter-contribution.ts";
import { defineFeatureRuntime } from "../feature-module.ts";
type SecondFeatureInput = Readonly<{ ping(): string }>;
declare module "../../application/ports/in/application-api.ts" {
interface ApplicationFeatureInputs {
"second-feature": SecondFeatureInput;
}
}
export const FEATURE_RUNTIME = defineFeatureRuntime({
featureId: "second-feature",
schemas: {},
adapters: [
defineFeatureAdapterContribution({
featureId: "second-feature",
needs: ["telemetry"] as const,
createInput: () =>
Object.freeze({
featureId: "second-feature",
input: Object.freeze({ ping: () => "pong" }),
}),
}),
],
contractContributions: [],
} as const);
`;
const SECOND_FEATURE_ROUTES = `import type { RouteObject } from "react-router-dom";
export const FEATURE_CONTEXT_ROUTES: readonly RouteObject[] = Object.freeze([]);
`;
const ROUTED_FEATURE_MODULE = `import { defineFeatureModule } from "../feature-module.ts";
export const FEATURE_MODULE_ID = "routed-feature";
export const FEATURE_CONTEXT_ID = "two-feature-context";
const ROUTES = {
ROUTED_ITEMS: {
routeId: "ROUTED_ITEMS",
path: "/two-feature/items",
paramsSchema: null,
searchSchema: null,
access: "public",
loadingSurface: "routed-items",
errorSurface: "feature-boundary",
chunkId: "route-routed-items",
title: "route.ROUTED_ITEMS.title",
navigationLabel: null,
navigationOrder: null,
},
} as const;
const MESSAGES = {
"route.ROUTED_ITEMS.title": "Routed items",
"route.ROUTED_ITEMS.navigation": "Routed items",
} as const;
export const FEATURE_MODULE = defineFeatureModule({
id: FEATURE_MODULE_ID,
contracts: {
featureId: FEATURE_MODULE_ID,
routes: ROUTES,
routeRuntimeContracts: {
ROUTED_ITEMS: {
routeId: "ROUTED_ITEMS",
moduleId: "routed-items-page",
paramsCodec: "none",
searchCodec: "none",
},
},
invalidation: { topics: [], namespaces: [], edges: [] },
topicVersions: [],
contractPackages: [],
},
routes: ROUTES,
messages: { "ko-KR": MESSAGES, "en-US": MESSAGES },
loadRuntime: async () => ({
featureId: FEATURE_MODULE_ID,
schemas: {},
adapters: [],
contractContributions: [],
}),
} as const);
`;
const CONTEXT_MODULE = `export const CONTEXT_MODULE_ID = "two-feature-context";
export const CONTEXT_APP_ID = "template-app";
export const CONTEXT_ROUTE_PATH = "two-feature/*";
export const CONTEXT_MAX_FEATURES = 2;
`;
const roots: string[] = [];
afterAll(async () => {
await Promise.all(roots.map((root) => rm(root, { recursive: true, force: true })));
});
describe("installing a second feature (09-01)", () => {
it("keeps the app typecheck green with two differently shaped features", async () => {
const root = await mkdtemp(path.join(tmpdir(), "two-feature-install-"));
roots.push(root);
await cp(path.resolve("src"), path.join(root, "src"), { recursive: true });
for (const config of ["tsconfig.base.json", "tsconfig.app.json"]) {
await cp(path.resolve(config), path.join(root, config));
}
await linkFixtureNodeModules(root);
const files: Readonly<Record<string, string>> = {
"src/contexts/two-feature-context/context-module.ts": CONTEXT_MODULE,
"src/features/routed-feature/feature-module.ts": ROUTED_FEATURE_MODULE,
"src/features/routed-feature/context-routes.ts": SECOND_FEATURE_ROUTES,
"src/features/second-feature/feature-module.ts": SECOND_FEATURE_MODULE,
"src/features/second-feature/feature-runtime.ts": SECOND_FEATURE_RUNTIME,
"src/features/second-feature/context-routes.ts": SECOND_FEATURE_ROUTES,
};
for (const [file, content] of Object.entries(files)) {
await mkdir(path.dirname(path.join(root, file)), { recursive: true });
await writeFile(path.join(root, file), content);
}
const generated = spawnSync(
process.execPath,
[path.resolve("scripts/generate-product-feature-index.ts"), `--root=${root}`],
{ encoding: "utf8" },
);
expect(generated.stderr).toBe("");
expect(generated.status).toBe(0);
const index = await readFile(path.join(root, "src/.generated/product-feature-index.ts"), "utf8");
expect(index).toContain("../features/second-feature/feature-module.ts");
expect(index).toContain("../features/routed-feature/feature-module.ts");
const typecheck = spawnSync(
path.resolve("node_modules/.bin/tsc"),
["--project", path.join(root, "tsconfig.app.json")],
{ encoding: "utf8" },
);
expect(typecheck.stdout + typecheck.stderr).toBe("");
expect(typecheck.status).toBe(0);
}, 60_000);
});