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에 넘긴다.
This commit is contained in:
+46
-215
@@ -1,226 +1,57 @@
|
||||
export type ApiOperation = Readonly<{
|
||||
method: string;
|
||||
path: string;
|
||||
import type {
|
||||
HttpMethod,
|
||||
InstalledContractContribution,
|
||||
InstalledHttpContract,
|
||||
ResponseEnvelope,
|
||||
RetrySemantics,
|
||||
} from "./external-contract-runtime.ts";
|
||||
|
||||
/**
|
||||
* FE-REG-API. The governed row of one installed HTTP operation, projected
|
||||
* from its V3 descriptor (`InstalledHttpContract`). A feature writes the
|
||||
* operation once, in its contract contribution; `check:registries` compares
|
||||
* these rows with the approved baseline.
|
||||
*/
|
||||
export type ApiOperationRow = Readonly<{
|
||||
operationId: string;
|
||||
auth: "none" | "external-session";
|
||||
timeoutMs: number | null;
|
||||
idempotency: "safe" | "keyed" | "none";
|
||||
retry: "runtime" | "never";
|
||||
requestSource: "search" | "body" | "none";
|
||||
featureId: string;
|
||||
method: HttpMethod;
|
||||
path: string;
|
||||
authProfileId: string;
|
||||
retrySemantics: RetrySemantics;
|
||||
requestBody: InstalledHttpContract<unknown, unknown, unknown>["contract"]["requestBody"];
|
||||
responseBody: InstalledHttpContract<unknown, unknown, unknown>["contract"]["responseBody"];
|
||||
responseEnvelope: ResponseEnvelope;
|
||||
requestSchema: string;
|
||||
responseSchema: string;
|
||||
owner: string;
|
||||
contractVersion?: 2;
|
||||
protocol?: "REST";
|
||||
semantics?: "QUERY" | "COMMAND";
|
||||
replayPolicy?: "SAFE" | "IDEMPOTENT" | "KEYED_COMMAND" | "NON_REPLAYABLE";
|
||||
idempotencyKeyPolicy?: "NONE" | "REQUIRED";
|
||||
mapperId?: string;
|
||||
successStatuses?: readonly number[];
|
||||
responseMediaTypes?: readonly string[];
|
||||
maxResponseBytes?: number;
|
||||
providerId?: string;
|
||||
authProfileId?: string;
|
||||
csrfProfileId?: string;
|
||||
pathSchema?: string;
|
||||
pathParameterNames?: readonly string[];
|
||||
maxEncodedSearchBytes?: number;
|
||||
problemSchema: string;
|
||||
}>;
|
||||
|
||||
/**
|
||||
* 07-02. A V2 row is the declaration `check:registries` (FE-REG-API) governs;
|
||||
* it is not what executes. The executed copy of the same HTTP API is the V3
|
||||
* descriptor (`InstalledHttpContract`) in the feature's contract contribution.
|
||||
* A feature writes both, and `tests/unit/http-operation-v2-v3-parity.test.ts`
|
||||
* checks they name the same operations, method, path, statuses, limits, auth
|
||||
* profile, replay and write semantics, request body and schema ids. The
|
||||
* deadline is not compared: V2 `timeoutMs` is `null` while V3 always has one.
|
||||
* Pass composed contributions (`composeContractContributions`): composition
|
||||
* already refused duplicate operation ids and snapshotted every row.
|
||||
*/
|
||||
export type RestOperationV2 = ApiOperation &
|
||||
Readonly<{
|
||||
contractVersion: 2;
|
||||
protocol: "REST";
|
||||
semantics: "QUERY" | "COMMAND";
|
||||
replayPolicy:
|
||||
| "SAFE"
|
||||
| "IDEMPOTENT"
|
||||
| "KEYED_COMMAND"
|
||||
| "NON_REPLAYABLE";
|
||||
idempotencyKeyPolicy: "NONE" | "REQUIRED";
|
||||
mapperId: string;
|
||||
successStatuses: readonly number[];
|
||||
responseMediaTypes: readonly string[];
|
||||
maxResponseBytes: number;
|
||||
providerId: string;
|
||||
authProfileId: string;
|
||||
csrfProfileId: string;
|
||||
pathSchema: string;
|
||||
pathParameterNames: readonly string[];
|
||||
maxEncodedSearchBytes: number;
|
||||
}>;
|
||||
|
||||
const MAX_RESPONSE_BYTES = 8 * 1024 * 1024;
|
||||
const OPERATION_ID = /^[A-Z][A-Z0-9_]{2,79}$/;
|
||||
const MEDIA_TYPE = /^[a-z0-9!#$&^_.+-]+\/[a-z0-9!#$&^_.+-]+$/;
|
||||
|
||||
export function defineRestOperation(
|
||||
operation: RestOperationV2,
|
||||
): RestOperationV2 {
|
||||
validateRestOperation(operation);
|
||||
return Object.freeze({
|
||||
...operation,
|
||||
successStatuses: Object.freeze([...operation.successStatuses]),
|
||||
responseMediaTypes: Object.freeze([...operation.responseMediaTypes]),
|
||||
pathParameterNames: Object.freeze([...operation.pathParameterNames]),
|
||||
});
|
||||
}
|
||||
|
||||
export function composeApiOperations(
|
||||
contributions: readonly Readonly<Record<string, ApiOperation>>[],
|
||||
): Readonly<Record<string, ApiOperation>> {
|
||||
const result: Record<string, ApiOperation> = Object.create(null);
|
||||
export function projectApiOperationRows(
|
||||
contributions: readonly InstalledContractContribution[],
|
||||
): Readonly<Record<string, ApiOperationRow>> {
|
||||
const rows: Record<string, ApiOperationRow> = {};
|
||||
for (const contribution of contributions) {
|
||||
for (const [registryId, operation] of Object.entries(contribution)) {
|
||||
if (registryId !== operation.operationId) {
|
||||
throw new TypeError("API operation registry key does not match operationId.");
|
||||
}
|
||||
if (Object.hasOwn(result, registryId)) {
|
||||
throw new TypeError(`Duplicate API operation: ${registryId}`);
|
||||
}
|
||||
if (operation.contractVersion === 2) {
|
||||
validateRestOperation(operation as RestOperationV2);
|
||||
}
|
||||
result[registryId] = operation;
|
||||
for (const { contract, frontend } of contribution.http) {
|
||||
rows[contract.operationId] = Object.freeze({
|
||||
operationId: contract.operationId,
|
||||
featureId: contribution.featureId,
|
||||
method: contract.method,
|
||||
path: contract.pathTemplate,
|
||||
authProfileId: frontend.authProfileId,
|
||||
retrySemantics: contract.retrySemantics,
|
||||
requestBody: contract.requestBody,
|
||||
responseBody: contract.responseBody,
|
||||
responseEnvelope: contract.responseEnvelope ?? "NONE",
|
||||
requestSchema: contract.inputValidator.schemaId,
|
||||
responseSchema: contract.outputValidator.schemaId,
|
||||
problemSchema: contract.problemValidator.schemaId,
|
||||
});
|
||||
}
|
||||
}
|
||||
return Object.freeze(result);
|
||||
}
|
||||
|
||||
export function validateApiRuntimeBindings(
|
||||
operations: Readonly<Record<string, ApiOperation>>,
|
||||
schemaMetadata: Readonly<Record<string, Readonly<{ schemaId: string }>>>,
|
||||
schemaCodecs: Readonly<Record<string, Readonly<{ schemaId: string }>>>,
|
||||
mappers: Readonly<
|
||||
Record<
|
||||
string,
|
||||
Readonly<{ mapperId: string; inputSchemaId: string; maxOutputItems: number }>
|
||||
>
|
||||
>,
|
||||
): true {
|
||||
for (const operation of Object.values(operations)) {
|
||||
if (operation.contractVersion !== 2) continue;
|
||||
for (const schemaId of [
|
||||
operation.pathSchema,
|
||||
operation.requestSchema,
|
||||
operation.responseSchema,
|
||||
]) {
|
||||
if (
|
||||
!schemaId ||
|
||||
schemaMetadata[schemaId]?.schemaId !== schemaId ||
|
||||
schemaCodecs[schemaId]?.schemaId !== schemaId
|
||||
) {
|
||||
throw new TypeError(
|
||||
`Unresolved API schema binding: ${operation.operationId}`,
|
||||
);
|
||||
}
|
||||
}
|
||||
const mapper = mappers[operation.mapperId ?? ""];
|
||||
if (
|
||||
!mapper ||
|
||||
mapper.mapperId !== operation.mapperId ||
|
||||
mapper.inputSchemaId !== operation.responseSchema ||
|
||||
mapper.maxOutputItems < 1
|
||||
) {
|
||||
throw new TypeError(
|
||||
`Unresolved API mapper binding: ${operation.operationId}`,
|
||||
);
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
function validateRestOperation(operation: RestOperationV2): void {
|
||||
if (
|
||||
operation.protocol !== "REST" ||
|
||||
!OPERATION_ID.test(operation.operationId) ||
|
||||
!operation.owner ||
|
||||
!operation.mapperId ||
|
||||
!operation.providerId ||
|
||||
!operation.authProfileId ||
|
||||
!operation.csrfProfileId ||
|
||||
!operation.pathSchema ||
|
||||
!operation.path.startsWith("/") ||
|
||||
operation.path.startsWith("//") ||
|
||||
operation.path.includes("?") ||
|
||||
operation.path.includes("#") ||
|
||||
!Number.isSafeInteger(operation.maxResponseBytes) ||
|
||||
operation.maxResponseBytes < 1 ||
|
||||
operation.maxResponseBytes > MAX_RESPONSE_BYTES ||
|
||||
!Number.isSafeInteger(operation.maxEncodedSearchBytes) ||
|
||||
operation.maxEncodedSearchBytes < 0 ||
|
||||
operation.maxEncodedSearchBytes > 32_768 ||
|
||||
operation.successStatuses.length === 0 ||
|
||||
operation.successStatuses.some(
|
||||
(status) => !Number.isInteger(status) || status < 200 || status > 299,
|
||||
) ||
|
||||
new Set(operation.successStatuses).size !== operation.successStatuses.length ||
|
||||
operation.responseMediaTypes.length === 0 ||
|
||||
operation.responseMediaTypes.some(
|
||||
(value) => !MEDIA_TYPE.test(value) || value !== value.toLowerCase(),
|
||||
)
|
||||
) {
|
||||
throw new TypeError(`Invalid REST operation contract: ${operation.operationId}`);
|
||||
}
|
||||
const placeholders = [
|
||||
...operation.path.matchAll(
|
||||
/:([A-Za-z][A-Za-z0-9_]*)|\{([A-Za-z][A-Za-z0-9_]*)\}/g,
|
||||
),
|
||||
]
|
||||
.map((match) => match[1] ?? match[2] ?? "")
|
||||
.sort();
|
||||
const codecKeys = [...operation.pathParameterNames].sort();
|
||||
if (
|
||||
new Set(codecKeys).size !== codecKeys.length ||
|
||||
placeholders.length !== codecKeys.length ||
|
||||
placeholders.some((name, index) => name !== codecKeys[index])
|
||||
) {
|
||||
throw new TypeError(
|
||||
`REST path codec does not match its template: ${operation.operationId}`,
|
||||
);
|
||||
}
|
||||
const isQuery = operation.semantics === "QUERY";
|
||||
// R-7.4. CSRF need is decided from the method (rest-profiles), so a COMMAND
|
||||
// must use an unsafe method. Same binding as browser-rpc and the V3 runtime.
|
||||
if (
|
||||
!["QUERY", "COMMAND"].includes(operation.semantics) ||
|
||||
!["SAFE", "IDEMPOTENT", "KEYED_COMMAND", "NON_REPLAYABLE"].includes(
|
||||
operation.replayPolicy,
|
||||
) ||
|
||||
(!isQuery && !["POST", "PUT", "PATCH", "DELETE"].includes(operation.method)) ||
|
||||
(isQuery && !["GET", "HEAD"].includes(operation.method)) ||
|
||||
(isQuery && !["SAFE", "IDEMPOTENT"].includes(operation.replayPolicy)) ||
|
||||
(operation.replayPolicy === "KEYED_COMMAND" &&
|
||||
(operation.idempotencyKeyPolicy !== "REQUIRED" ||
|
||||
operation.idempotency !== "keyed")) ||
|
||||
(operation.replayPolicy === "NON_REPLAYABLE" &&
|
||||
(operation.retry !== "never" || operation.idempotency !== "none"))
|
||||
) {
|
||||
throw new TypeError(`Incoherent REST replay contract: ${operation.operationId}`);
|
||||
}
|
||||
}
|
||||
|
||||
export const API_OPERATIONS: Readonly<Record<string, ApiOperation>> =
|
||||
Object.freeze({});
|
||||
|
||||
export function getApiOperation(
|
||||
operationId: string,
|
||||
operations: Readonly<Record<string, ApiOperation>> = API_OPERATIONS,
|
||||
): ApiOperation {
|
||||
const selected = Object.hasOwn(operations, operationId)
|
||||
? operations[operationId]
|
||||
: undefined;
|
||||
if (!selected) {
|
||||
throw new Error(`Unregistered API operation: ${operationId}`);
|
||||
}
|
||||
return selected;
|
||||
return Object.freeze(rows);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user