Compare commits
4
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
98d4fd4960 | ||
|
|
3f634eb655 | ||
|
|
5173b6c8d6 | ||
|
|
2fa0baa577 |
@@ -10,4 +10,7 @@ artifacts/**/*.xml
|
||||
artifacts/**/*.txt
|
||||
artifacts/**/*.sarif
|
||||
artifacts/tests/e2e/
|
||||
artifacts/storybook/
|
||||
artifacts/tests/storybook/
|
||||
artifacts/tests/visual/
|
||||
!artifacts/**/.gitkeep
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
import type { StorybookConfig } from "@storybook/react-vite";
|
||||
|
||||
const config: StorybookConfig = {
|
||||
stories: ["../src/**/*.stories.@(js|jsx|ts|tsx)"],
|
||||
addons: ["@storybook/addon-a11y"],
|
||||
framework: {
|
||||
name: "@storybook/react-vite",
|
||||
options: {},
|
||||
},
|
||||
core: {
|
||||
disableTelemetry: true,
|
||||
},
|
||||
};
|
||||
|
||||
export default config;
|
||||
@@ -0,0 +1,88 @@
|
||||
import type { Preview } from "@storybook/react-vite";
|
||||
import { QueryClientProvider } from "@tanstack/react-query";
|
||||
import { MemoryRouter } from "react-router-dom";
|
||||
|
||||
import { createAnonymousSessionAdapter } from "../src/adapters/auth/external-session-adapter.js";
|
||||
import { createQueryClient } from "../src/adapters/query-cache/tanstack-query-cache.js";
|
||||
import { createApplication } from "../src/application/create-application.js";
|
||||
import { LocaleProvider } from "../src/presentation/i18n/index.js";
|
||||
import { ApplicationProvider } from "../src/presentation/providers/application-provider.js";
|
||||
import { SessionProvider } from "../src/presentation/providers/session-provider.jsx";
|
||||
import { ThemeProvider } from "../src/presentation/providers/theme-provider.jsx";
|
||||
import "../src/presentation/styles/theme.css";
|
||||
|
||||
const preferences = new Map<string, unknown>();
|
||||
const application = createApplication({
|
||||
session: createAnonymousSessionAdapter(),
|
||||
preferences: {
|
||||
read: (name) => ({ ok: true, value: preferences.get(name) }),
|
||||
write: (name, value) => {
|
||||
preferences.set(name, structuredClone(value));
|
||||
return { ok: true };
|
||||
},
|
||||
remove: (name) => {
|
||||
preferences.delete(name);
|
||||
return { ok: true };
|
||||
},
|
||||
},
|
||||
diagnostics: { record() {} },
|
||||
telemetry: { emit() {} },
|
||||
releaseInfo: {
|
||||
getCurrent: async () => ({
|
||||
buildId: "storybook-build",
|
||||
releaseId: "storybook-release",
|
||||
configSchemaVersion: "1",
|
||||
apiContractVersion: "1",
|
||||
assetManifestHash: "storybook-assets",
|
||||
routeChunks: {},
|
||||
}),
|
||||
refresh: async () => ({
|
||||
buildId: "storybook-build",
|
||||
releaseId: "storybook-release",
|
||||
configSchemaVersion: "1",
|
||||
apiContractVersion: "1",
|
||||
assetManifestHash: "storybook-assets",
|
||||
routeChunks: {},
|
||||
}),
|
||||
},
|
||||
navigation: { reload() {} },
|
||||
});
|
||||
const queryClient = createQueryClient();
|
||||
|
||||
const preview: Preview = {
|
||||
decorators: [
|
||||
(Story) => (
|
||||
<ApplicationProvider application={application}>
|
||||
<QueryClientProvider client={queryClient}>
|
||||
<MemoryRouter>
|
||||
<LocaleProvider>
|
||||
<ThemeProvider>
|
||||
<SessionProvider>
|
||||
<div id="portal-root" />
|
||||
<main className="ui-page" style={{ padding: "1rem" }}>
|
||||
<Story />
|
||||
</main>
|
||||
</SessionProvider>
|
||||
</ThemeProvider>
|
||||
</LocaleProvider>
|
||||
</MemoryRouter>
|
||||
</QueryClientProvider>
|
||||
</ApplicationProvider>
|
||||
),
|
||||
],
|
||||
parameters: {
|
||||
a11y: {
|
||||
test: "error",
|
||||
},
|
||||
controls: {
|
||||
expanded: true,
|
||||
},
|
||||
options: {
|
||||
storySort: {
|
||||
order: ["Platform"],
|
||||
},
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
export default preview;
|
||||
+48
-7
@@ -84,7 +84,8 @@
|
||||
{ "script": "check:types:fixture:page-action", "expect": "fail" },
|
||||
{ "script": "check:types:fixture:icon-button", "expect": "fail" },
|
||||
{ "script": "check:types:fixture:i18n-key", "expect": "fail" },
|
||||
{ "script": "check:types:fixture:i18n-params", "expect": "fail" }
|
||||
{ "script": "check:types:fixture:i18n-params", "expect": "fail" },
|
||||
{ "script": "check:types:fixture:diagnostics", "expect": "fail" }
|
||||
],
|
||||
"logPath": "artifacts/quality/check-types.txt",
|
||||
"evidence": ["artifacts/quality/check-types.txt"],
|
||||
@@ -99,9 +100,19 @@
|
||||
},
|
||||
"FE-GATE-005": {
|
||||
"name": "unit",
|
||||
"steps": [{ "script": "test:unit", "expect": "pass" }],
|
||||
"steps": [
|
||||
{ "script": "test:unit", "expect": "pass" },
|
||||
{ "script": "test:coverage", "expect": "pass" },
|
||||
{ "script": "check:coverage:fixture", "expect": "fail" }
|
||||
],
|
||||
"logPath": "artifacts/quality/gates/FE-GATE-005.txt",
|
||||
"evidence": ["artifacts/tests/unit.xml"],
|
||||
"evidence": [
|
||||
"artifacts/tests/unit.xml",
|
||||
"artifacts/tests/coverage.xml",
|
||||
"artifacts/tests/coverage/coverage-summary.json",
|
||||
"artifacts/quality/risk-coverage.json",
|
||||
"artifacts/quality/risk-coverage-fixture.json"
|
||||
],
|
||||
"retentionClass": "merge-cycle"
|
||||
},
|
||||
"FE-GATE-006": {
|
||||
@@ -126,9 +137,24 @@
|
||||
},
|
||||
"FE-GATE-008": {
|
||||
"name": "e2e",
|
||||
"steps": [{ "script": "test:e2e", "expect": "pass" }],
|
||||
"steps": [
|
||||
{ "script": "test:e2e", "expect": "pass" },
|
||||
{ "script": "test:storybook", "expect": "pass" },
|
||||
{ "script": "test:visual", "expect": "pass" },
|
||||
{ "script": "check:test-evidence", "expect": "pass" },
|
||||
{ "script": "check:test-evidence:fixture", "expect": "fail" }
|
||||
],
|
||||
"logPath": "artifacts/quality/gates/FE-GATE-008.txt",
|
||||
"evidence": ["artifacts/tests/e2e/report/index.html"],
|
||||
"evidence": [
|
||||
"artifacts/tests/e2e/report/index.html",
|
||||
"artifacts/tests/e2e/results.xml",
|
||||
"artifacts/tests/storybook/report/index.html",
|
||||
"artifacts/tests/storybook/results.xml",
|
||||
"artifacts/tests/visual/report/index.html",
|
||||
"artifacts/tests/visual/results.xml",
|
||||
"artifacts/quality/test-evidence.json",
|
||||
"artifacts/quality/test-evidence-fixture.json"
|
||||
],
|
||||
"retentionClass": "merge-cycle"
|
||||
},
|
||||
"FE-GATE-009": {
|
||||
@@ -158,7 +184,14 @@
|
||||
{ "script": "check:design-system:fixture", "expect": "fail" },
|
||||
{ "script": "check:i18n", "expect": "pass" },
|
||||
{ "script": "check:i18n:fixture", "expect": "fail" },
|
||||
{ "script": "check:diagnostics", "expect": "pass" },
|
||||
{ "script": "check:diagnostics:fixture", "expect": "fail" },
|
||||
{ "script": "check:registries", "expect": "pass" },
|
||||
{
|
||||
"script": "check:registries:compatibility-fixtures",
|
||||
"expect": "pass"
|
||||
},
|
||||
{ "script": "check:registries:baseline-fixture", "expect": "fail" },
|
||||
{ "script": "check:registries:fixture", "expect": "fail" },
|
||||
{ "script": "check:routes:fixture", "expect": "fail" }
|
||||
],
|
||||
@@ -169,7 +202,11 @@
|
||||
"artifacts/quality/design-system-fixture.json",
|
||||
"artifacts/quality/i18n.json",
|
||||
"artifacts/quality/i18n-fixture.json",
|
||||
"artifacts/quality/diagnostics.json",
|
||||
"artifacts/quality/diagnostics-fixture.json",
|
||||
"artifacts/quality/registries.json",
|
||||
"artifacts/quality/registry-compatibility-fixtures.json",
|
||||
"artifacts/quality/registry-baseline-fixture.json",
|
||||
"artifacts/quality/registry-fixture.json",
|
||||
"artifacts/quality/route-registry-fixture.json"
|
||||
],
|
||||
@@ -177,11 +214,15 @@
|
||||
},
|
||||
"FE-GATE-011": {
|
||||
"name": "build",
|
||||
"steps": [{ "script": "build", "expect": "pass" }],
|
||||
"steps": [
|
||||
{ "script": "build", "expect": "pass" },
|
||||
{ "script": "build:storybook", "expect": "pass" }
|
||||
],
|
||||
"logPath": "artifacts/quality/gates/FE-GATE-011.txt",
|
||||
"evidence": [
|
||||
"artifacts/release/build-manifest.json",
|
||||
"artifacts/release/runtime-config.schema.json"
|
||||
"artifacts/release/runtime-config.schema.json",
|
||||
"artifacts/storybook/static/index.html"
|
||||
],
|
||||
"retentionClass": "release-coherence"
|
||||
},
|
||||
|
||||
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"schemaVersion": 1,
|
||||
"snapshotDigest": "e8448e46bc65326e9b2eb23cdce0870242faedb7a354942389c4a95b0e392d90",
|
||||
"owner": "frontend-platform",
|
||||
"reason": "RP-10 initial approved executable registry baseline",
|
||||
"approvedAt": "2026-07-26T07:53:45.969Z"
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"schemaVersion": 1,
|
||||
"changes": []
|
||||
}
|
||||
@@ -1,13 +1,46 @@
|
||||
{
|
||||
"schemaVersion": 1,
|
||||
"schemaVersion": 2,
|
||||
"sourceDirectories": [
|
||||
"src/application",
|
||||
"src/presentation",
|
||||
"src/domain"
|
||||
],
|
||||
"registries": [
|
||||
{
|
||||
"registryId": "FE-REG-ROUTE",
|
||||
"path": "src/features/installed-feature-contracts.js",
|
||||
"exportName": "ROUTE_REGISTRY",
|
||||
"owner": "feature-routing-navigation-guard-contract",
|
||||
"owner": "feature-frontend-routing-release-recovery-runtime",
|
||||
"keyField": "routeId",
|
||||
"requiredFields": [
|
||||
"routeId",
|
||||
"path",
|
||||
"paramsSchema",
|
||||
"searchSchema",
|
||||
"access",
|
||||
"loadingSurface",
|
||||
"errorSurface",
|
||||
"chunkId",
|
||||
"title",
|
||||
"navigationLabel",
|
||||
"navigationOrder"
|
||||
],
|
||||
"fieldTypes": {
|
||||
"routeId": "string",
|
||||
"path": "string",
|
||||
"paramsSchema": "string|null",
|
||||
"searchSchema": "string|null",
|
||||
"access": "string",
|
||||
"loadingSurface": "string",
|
||||
"errorSurface": "string",
|
||||
"chunkId": "string",
|
||||
"title": "string",
|
||||
"navigationLabel": "string|null",
|
||||
"navigationOrder": "integer|null"
|
||||
},
|
||||
"uniqueFields": ["routeId", "path", "chunkId"],
|
||||
"allowedValues": {
|
||||
"access": ["public", "session-required", "integration-defined"],
|
||||
"paramsSchema": [null, "NotFoundSplat", "ReferenceResourceParams"],
|
||||
"searchSchema": [null, "ReferenceResourceListQuery"],
|
||||
"loadingSurface": [
|
||||
@@ -23,17 +56,6 @@
|
||||
"route-boundary",
|
||||
"feature-boundary",
|
||||
"not-found"
|
||||
],
|
||||
"chunkId": [
|
||||
"route-home",
|
||||
"route-examples-ui",
|
||||
"route-examples-states",
|
||||
"route-examples-auth",
|
||||
"route-reference-resources",
|
||||
"route-reference-resource-detail",
|
||||
"route-reference-resource-form",
|
||||
"route-reference-resource-status",
|
||||
"route-not-found"
|
||||
]
|
||||
},
|
||||
"references": [
|
||||
@@ -41,16 +63,30 @@
|
||||
"field": "routeId",
|
||||
"registryId": "FE-REG-ROUTE-RUNTIME",
|
||||
"targetField": "routeId"
|
||||
},
|
||||
{
|
||||
"field": "paramsSchema",
|
||||
"registryId": "FE-REG-SCHEMA",
|
||||
"targetField": "schemaId"
|
||||
},
|
||||
{
|
||||
"field": "searchSchema",
|
||||
"registryId": "FE-REG-SCHEMA",
|
||||
"targetField": "schemaId"
|
||||
}
|
||||
],
|
||||
"requiredFields": [
|
||||
"consumers": [
|
||||
{
|
||||
"path": "src/presentation/routes/app-router.tsx",
|
||||
"token": "ROUTE_REGISTRY"
|
||||
}
|
||||
],
|
||||
"breakingFields": [
|
||||
"routeId",
|
||||
"path",
|
||||
"paramsSchema",
|
||||
"searchSchema",
|
||||
"access",
|
||||
"loadingSurface",
|
||||
"errorSurface",
|
||||
"chunkId"
|
||||
]
|
||||
},
|
||||
@@ -59,41 +95,56 @@
|
||||
"path": "src/features/installed-feature-contracts.js",
|
||||
"exportName": "ROUTE_RUNTIME_CONTRACT",
|
||||
"owner": "feature-frontend-routing-release-recovery-runtime",
|
||||
"keyField": "routeId",
|
||||
"requiredFields": [
|
||||
"routeId",
|
||||
"moduleId",
|
||||
"paramsCodec",
|
||||
"searchCodec"
|
||||
],
|
||||
"uniqueFields": ["routeId", "moduleId"],
|
||||
"allowedValues": {
|
||||
"moduleId": [
|
||||
"home-page",
|
||||
"ui-gallery-page",
|
||||
"state-gallery-page",
|
||||
"auth-example-page",
|
||||
"reference-resource-page",
|
||||
"reference-resource-detail-page",
|
||||
"reference-resource-form-page",
|
||||
"reference-resource-status-page",
|
||||
"not-found-page"
|
||||
],
|
||||
"paramsCodec": ["none", "NotFoundSplat", "ReferenceResourceParams"],
|
||||
"searchCodec": ["none", "ReferenceResourceListQuery"]
|
||||
"fieldTypes": {
|
||||
"routeId": "string",
|
||||
"moduleId": "string",
|
||||
"paramsCodec": "string",
|
||||
"searchCodec": "string"
|
||||
},
|
||||
"uniqueFields": ["routeId", "moduleId"],
|
||||
"references": [
|
||||
{
|
||||
"field": "routeId",
|
||||
"registryId": "FE-REG-ROUTE",
|
||||
"targetField": "routeId"
|
||||
},
|
||||
{
|
||||
"field": "paramsCodec",
|
||||
"registryId": "FE-REG-SCHEMA",
|
||||
"targetField": "schemaId"
|
||||
},
|
||||
{
|
||||
"field": "searchCodec",
|
||||
"registryId": "FE-REG-SCHEMA",
|
||||
"targetField": "schemaId"
|
||||
}
|
||||
],
|
||||
"consumers": [
|
||||
{
|
||||
"path": "src/presentation/routes/route-codecs.ts",
|
||||
"token": "ROUTE_RUNTIME_CONTRACT"
|
||||
}
|
||||
],
|
||||
"breakingFields": [
|
||||
"routeId",
|
||||
"moduleId",
|
||||
"paramsCodec",
|
||||
"searchCodec"
|
||||
]
|
||||
},
|
||||
{
|
||||
"registryId": "FE-REG-API",
|
||||
"path": "src/features/installed-feature-contracts.js",
|
||||
"exportName": "API_OPERATIONS",
|
||||
"owner": "feature-api-client-response-envelope-contract",
|
||||
"owner": "feature-frontend-api-client-response-envelope-contract",
|
||||
"keyField": "operationId",
|
||||
"requiredFields": [
|
||||
"method",
|
||||
"path",
|
||||
@@ -106,20 +157,127 @@
|
||||
"requestSchema",
|
||||
"responseSchema",
|
||||
"owner"
|
||||
],
|
||||
"fieldTypes": {
|
||||
"method": "string",
|
||||
"path": "string",
|
||||
"operationId": "string",
|
||||
"auth": "string",
|
||||
"timeoutMs": "integer|null",
|
||||
"idempotency": "string",
|
||||
"retry": "string",
|
||||
"requestSource": "string",
|
||||
"requestSchema": "string",
|
||||
"responseSchema": "string",
|
||||
"owner": "string"
|
||||
},
|
||||
"uniqueFields": ["operationId"],
|
||||
"allowedValues": {
|
||||
"method": ["GET", "POST", "PUT", "PATCH", "DELETE"],
|
||||
"auth": ["none", "external-session"],
|
||||
"idempotency": ["safe", "keyed", "none"],
|
||||
"retry": ["runtime", "never"],
|
||||
"requestSource": ["none", "search", "body"]
|
||||
},
|
||||
"references": [
|
||||
{
|
||||
"field": "requestSchema",
|
||||
"registryId": "FE-REG-SCHEMA",
|
||||
"targetField": "schemaId"
|
||||
},
|
||||
{
|
||||
"field": "responseSchema",
|
||||
"registryId": "FE-REG-SCHEMA",
|
||||
"targetField": "schemaId"
|
||||
}
|
||||
],
|
||||
"consumerIdentityField": "operationId",
|
||||
"consumerDirectories": [
|
||||
"src/features/reference-feature/adapters",
|
||||
"src/features/reference-feature/application"
|
||||
],
|
||||
"breakingFields": [
|
||||
"method",
|
||||
"path",
|
||||
"operationId",
|
||||
"auth",
|
||||
"idempotency",
|
||||
"requestSource",
|
||||
"requestSchema",
|
||||
"responseSchema"
|
||||
]
|
||||
},
|
||||
{
|
||||
"registryId": "FE-REG-SCHEMA",
|
||||
"path": "src/features/installed-feature-contracts.js",
|
||||
"exportName": "SCHEMA_REGISTRY",
|
||||
"owner": "feature-frontend-contract-schema-registry",
|
||||
"keyField": "schemaId",
|
||||
"requiredFields": ["schemaId", "boundary", "owner", "runtime"],
|
||||
"fieldTypes": {
|
||||
"schemaId": "string",
|
||||
"boundary": "string",
|
||||
"owner": "string",
|
||||
"runtime": "string"
|
||||
},
|
||||
"uniqueFields": ["schemaId"],
|
||||
"allowedValues": {
|
||||
"boundary": [
|
||||
"route-params",
|
||||
"route-search",
|
||||
"route-search-api-request",
|
||||
"api-request",
|
||||
"api-response"
|
||||
],
|
||||
"runtime": ["zod"]
|
||||
},
|
||||
"consumerIdentityField": "schemaId",
|
||||
"consumerDirectories": [
|
||||
"src/presentation/routes",
|
||||
"src/features/reference-feature/presentation",
|
||||
"src/features/reference-feature/contracts"
|
||||
],
|
||||
"breakingFields": ["schemaId", "boundary", "runtime"]
|
||||
},
|
||||
{
|
||||
"registryId": "FE-REG-ENV",
|
||||
"path": "src/contracts/env.js",
|
||||
"exportName": "ENV_REGISTRY",
|
||||
"owner": "feature-frontend-env-runtime-config-contract",
|
||||
"requiredFields": ["phase", "classification", "required", "defaultValue"]
|
||||
"requiredFields": ["phase", "classification", "required", "defaultValue"],
|
||||
"fieldTypes": {
|
||||
"phase": "string",
|
||||
"classification": "string",
|
||||
"required": "boolean",
|
||||
"defaultValue": "string|integer|boolean|null"
|
||||
},
|
||||
"allowedValues": {
|
||||
"phase": ["build", "runtime"],
|
||||
"classification": [
|
||||
"public",
|
||||
"public-sensitive",
|
||||
"public-metadata",
|
||||
"compile-time"
|
||||
]
|
||||
},
|
||||
"consumers": [
|
||||
{
|
||||
"path": "src/bootstrap/runtime-config-schema.js",
|
||||
"token": "APP_ENV"
|
||||
},
|
||||
{
|
||||
"path": "src/contracts/env.js",
|
||||
"token": "getBuildConfig"
|
||||
}
|
||||
],
|
||||
"breakingFields": ["phase", "classification", "required"]
|
||||
},
|
||||
{
|
||||
"registryId": "FE-REG-STORAGE",
|
||||
"path": "src/contracts/storage-keys.js",
|
||||
"exportName": "STORAGE_REGISTRY",
|
||||
"owner": "feature-frontend-storage-registry-contract",
|
||||
"keyField": "logicalName",
|
||||
"requiredFields": [
|
||||
"logicalName",
|
||||
"physicalKey",
|
||||
@@ -129,6 +287,44 @@
|
||||
"ttl",
|
||||
"migration",
|
||||
"quotaFallback"
|
||||
],
|
||||
"fieldTypes": {
|
||||
"logicalName": "string",
|
||||
"physicalKey": "string",
|
||||
"backend": "string",
|
||||
"classification": "string",
|
||||
"schemaVersion": "integer",
|
||||
"ttl": "integer|string|null",
|
||||
"migration": "string|function",
|
||||
"quotaFallback": "string"
|
||||
},
|
||||
"uniqueFields": ["logicalName", "physicalKey"],
|
||||
"allowedValues": {
|
||||
"backend": [
|
||||
"memory",
|
||||
"sessionStorage",
|
||||
"localStorage",
|
||||
"indexedDB",
|
||||
"disabled",
|
||||
"forbidden"
|
||||
],
|
||||
"classification": [
|
||||
"public-preference",
|
||||
"opaque-cache",
|
||||
"sensitive-forbidden"
|
||||
],
|
||||
"quotaFallback": ["memory", "no-persist", "feature-disable"]
|
||||
},
|
||||
"consumerIdentityField": "logicalName",
|
||||
"consumerDirectories": ["src", "tests"],
|
||||
"orphanExemptRows": ["QUERY_PERSISTENCE", "AUTH_TOKEN"],
|
||||
"breakingFields": [
|
||||
"logicalName",
|
||||
"physicalKey",
|
||||
"backend",
|
||||
"classification",
|
||||
"schemaVersion",
|
||||
"migration"
|
||||
]
|
||||
},
|
||||
{
|
||||
@@ -136,6 +332,7 @@
|
||||
"path": "src/contracts/errors.js",
|
||||
"exportName": "ERROR_REGISTRY",
|
||||
"owner": "feature-frontend-error-classification-boundary-contract",
|
||||
"keyField": "kind",
|
||||
"requiredFields": [
|
||||
"kind",
|
||||
"defaultRetryable",
|
||||
@@ -144,13 +341,41 @@
|
||||
"action",
|
||||
"telemetryEvent",
|
||||
"redaction"
|
||||
]
|
||||
],
|
||||
"fieldTypes": {
|
||||
"kind": "string",
|
||||
"defaultRetryable": "boolean",
|
||||
"severity": "string",
|
||||
"userMessageKey": "string",
|
||||
"action": "string",
|
||||
"telemetryEvent": "string",
|
||||
"redaction": "array"
|
||||
},
|
||||
"uniqueFields": ["kind"],
|
||||
"allowedValues": {
|
||||
"severity": ["info", "warning", "error"],
|
||||
"action": [
|
||||
"retry",
|
||||
"reauth",
|
||||
"navigate",
|
||||
"reload-once",
|
||||
"contact-support",
|
||||
"none"
|
||||
]
|
||||
},
|
||||
"consumers": [
|
||||
{
|
||||
"path": "src/adapters/http/client.js",
|
||||
"token": "failure("
|
||||
}
|
||||
],
|
||||
"breakingFields": ["kind", "userMessageKey", "action", "telemetryEvent"]
|
||||
},
|
||||
{
|
||||
"registryId": "FE-REG-QUERY",
|
||||
"path": "src/features/installed-feature-contracts.js",
|
||||
"exportName": "QUERY_REGISTRY",
|
||||
"owner": "feature-server-state-caching-contract",
|
||||
"owner": "feature-frontend-server-state-caching-contract",
|
||||
"requiredFields": [
|
||||
"namespace",
|
||||
"serialization",
|
||||
@@ -158,13 +383,39 @@
|
||||
"invalidation",
|
||||
"version",
|
||||
"persistence"
|
||||
],
|
||||
"fieldTypes": {
|
||||
"namespace": "array",
|
||||
"serialization": "string",
|
||||
"identity": "string",
|
||||
"invalidation": "string",
|
||||
"version": "integer",
|
||||
"persistence": "string"
|
||||
},
|
||||
"uniqueFields": ["namespace"],
|
||||
"allowedValues": {
|
||||
"persistence": ["disabled"]
|
||||
},
|
||||
"consumers": [
|
||||
{
|
||||
"path": "src/features/reference-feature/contracts/reference-feature-contract.js",
|
||||
"token": "referenceQueryKeys"
|
||||
}
|
||||
],
|
||||
"breakingFields": [
|
||||
"namespace",
|
||||
"serialization",
|
||||
"identity",
|
||||
"version",
|
||||
"persistence"
|
||||
]
|
||||
},
|
||||
{
|
||||
"registryId": "FE-REG-TELEMETRY",
|
||||
"path": "src/contracts/telemetry.js",
|
||||
"exportName": "TELEMETRY_REGISTRY",
|
||||
"owner": "feature-frontend-observability-logging-trace-contract",
|
||||
"owner": "feature-frontend-diagnostics-telemetry-runtime",
|
||||
"keyField": "eventName",
|
||||
"requiredFields": [
|
||||
"eventName",
|
||||
"trigger",
|
||||
@@ -173,6 +424,31 @@
|
||||
"forbiddenAttributes",
|
||||
"sampling",
|
||||
"delivery"
|
||||
],
|
||||
"fieldTypes": {
|
||||
"eventName": "string",
|
||||
"trigger": "string",
|
||||
"requiredAttributes": "array",
|
||||
"optionalAttributes": "array",
|
||||
"forbiddenAttributes": "array",
|
||||
"sampling": "string",
|
||||
"delivery": "string"
|
||||
},
|
||||
"uniqueFields": ["eventName"],
|
||||
"allowedValues": {
|
||||
"delivery": ["best-effort"]
|
||||
},
|
||||
"consumers": [
|
||||
{
|
||||
"path": "scripts/check-diagnostics.mjs",
|
||||
"token": "TELEMETRY_REGISTRY"
|
||||
}
|
||||
],
|
||||
"breakingFields": [
|
||||
"eventName",
|
||||
"requiredAttributes",
|
||||
"forbiddenAttributes",
|
||||
"delivery"
|
||||
]
|
||||
},
|
||||
{
|
||||
@@ -180,11 +456,21 @@
|
||||
"path": "src/contracts/release-tokens.js",
|
||||
"exportName": "RELEASE_TOKEN_REGISTRY",
|
||||
"owner": "feature-frontend-release-cache-rollback-contract",
|
||||
"requiredFields": ["token", "source", "compatibilityRole"]
|
||||
"keyField": "token",
|
||||
"requiredFields": ["token", "source", "compatibilityRole"],
|
||||
"fieldTypes": {
|
||||
"token": "string",
|
||||
"source": "string",
|
||||
"compatibilityRole": "string"
|
||||
},
|
||||
"uniqueFields": ["token"],
|
||||
"consumers": [
|
||||
{
|
||||
"path": "src/bootstrap/load-release-manifest.js",
|
||||
"token": "assetManifestHash"
|
||||
}
|
||||
],
|
||||
"breakingFields": ["token", "source", "compatibilityRole"]
|
||||
}
|
||||
],
|
||||
"compatibilityImpact": {
|
||||
"allowed": ["none", "additive", "behavior-change", "breaking"],
|
||||
"current": "behavior-change"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -0,0 +1,92 @@
|
||||
{
|
||||
"schemaVersion": 1,
|
||||
"summary": {
|
||||
"lines": 80,
|
||||
"statements": 78,
|
||||
"functions": 85,
|
||||
"branches": 68
|
||||
},
|
||||
"criticalModules": [
|
||||
{
|
||||
"path": "src/adapters/http/retry-policy.js",
|
||||
"minimum": {
|
||||
"lines": 80,
|
||||
"statements": 78,
|
||||
"functions": 95,
|
||||
"branches": 78
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "src/adapters/storage/browser-storage-adapter.js",
|
||||
"minimum": {
|
||||
"lines": 60,
|
||||
"statements": 60,
|
||||
"functions": 70,
|
||||
"branches": 60
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "src/adapters/telemetry/best-effort-telemetry.js",
|
||||
"minimum": {
|
||||
"lines": 85,
|
||||
"statements": 85,
|
||||
"functions": 70,
|
||||
"branches": 75
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "src/application/policies/compatibility.js",
|
||||
"minimum": {
|
||||
"lines": 95,
|
||||
"statements": 95,
|
||||
"functions": 95,
|
||||
"branches": 75
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "src/application/policies/performance-budgets.js",
|
||||
"minimum": {
|
||||
"lines": 80,
|
||||
"statements": 80,
|
||||
"functions": 80,
|
||||
"branches": 40
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "src/application/policies/promotion-readiness.js",
|
||||
"minimum": {
|
||||
"lines": 95,
|
||||
"statements": 95,
|
||||
"functions": 95,
|
||||
"branches": 95
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "src/application/use-cases/decide-chunk-recovery.js",
|
||||
"minimum": {
|
||||
"lines": 90,
|
||||
"statements": 90,
|
||||
"functions": 95,
|
||||
"branches": 85
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "src/contracts/diagnostics.ts",
|
||||
"minimum": {
|
||||
"lines": 68,
|
||||
"statements": 68,
|
||||
"functions": 95,
|
||||
"branches": 58
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "scripts/lib/registry-compatibility.mjs",
|
||||
"minimum": {
|
||||
"lines": 80,
|
||||
"statements": 80,
|
||||
"functions": 85,
|
||||
"branches": 60
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,97 @@
|
||||
# VD-07: Diagnostics와 telemetry exporter 경계
|
||||
|
||||
- 상태: Accepted
|
||||
- 결정일: 2026-07-26
|
||||
- 적용 브랜치: `feature-frontend-diagnostics-telemetry-runtime`
|
||||
- 재검토: 실제 운영 sink, consent가 필요한 analytics 또는 분산 tracing provider가
|
||||
선정될 때
|
||||
|
||||
## 배경
|
||||
|
||||
기존 telemetry registry와 best-effort HTTP queue는 있었지만 운영 진단 record와
|
||||
semantic event의 책임이 하나의 telemetry port에 섞여 있었다. boot, HTTP,
|
||||
cache, storage, route와 release failure의 선언도 실제 production producer와
|
||||
완전히 연결되지 않았다. 이 상태에서는 retry attempt마다 같은 사건을 발행하거나
|
||||
raw URL, query, request body와 오류 객체가 queue에 들어갈 위험이 있다.
|
||||
|
||||
반면 skeleton 단계에는 실제 관측 vendor, endpoint의 운영 보안 정책, analytics
|
||||
consent와 보존 기간이 결정되지 않았다. 특정 SDK를 기본 번들에 설치하는 것은
|
||||
vendor 결정 전에는 안전한 기본값이 아니다.
|
||||
|
||||
## 결정
|
||||
|
||||
1. level 기반 운영 진단은 `DiagnosticsPort`, registry 기반 semantic event는
|
||||
`TelemetryPort`로 분리한다. application은 두 port의 concrete adapter나
|
||||
exporter SDK를 알지 못한다.
|
||||
2. diagnostics의 level, event ID와 context key는 닫힌 registry/allowlist다.
|
||||
telemetry도 event별 required/optional attribute와 value policy를 적용한다.
|
||||
등록되지 않은 event·context·고카디널리티 값은 전송하지 않는다.
|
||||
3. 기본 diagnostics adapter는 bounded in-memory evidence이고 telemetry는
|
||||
설정이 없으면 true no-op이다. endpoint가 있을 때만 bounded oldest-drop
|
||||
queue와 best-effort HTTP sink를 사용한다.
|
||||
4. raw path/URL/query/body/response/storage value, credential, cookie, email,
|
||||
stack과 오류 객체 전체는 context에 넣지 않는다. route ID, operation ID,
|
||||
correlation ID, release ID, error kind, status/attempt/duration bucket만
|
||||
허용한다.
|
||||
5. HTTP logical execution은 success, retry recovery, terminal failure 또는
|
||||
abort마다 `http.request.completed` diagnostics를 정확히 한 번 남긴다.
|
||||
`api.request.failed` telemetry는 retry가 끝난 terminal non-abort failure에만
|
||||
정확히 한 번 발행한다.
|
||||
6. `app.boot.failed`, `ui.render.failed`, `release.mismatch.detected`,
|
||||
`telemetry.delivery.dropped`를 production path에 연결한다. cache와 storage
|
||||
실패는 diagnostics로 기록하되 raw key/value를 기록하지 않는다.
|
||||
7. queue full, invalid event/context, serialization과 sink failure는 제한된
|
||||
reason bucket으로 집계한다. drop observer의 failure는 다시 telemetry를
|
||||
발행하지 않는 nonrecursive 경계다.
|
||||
8. diagnostics와 telemetry failure는 제품 흐름, HTTP 결과, route transition,
|
||||
storage/cache fallback과 React error surface를 바꾸지 않는다.
|
||||
9. mount 전 bootstrap failure는 안전한 build/config/error kind만 별도 evidence로
|
||||
만들며 untrusted error message, stack과 support 입력을 serialize하지 않는다.
|
||||
10. 실제 error reporter, RUM, analytics나 tracing SDK는 같은 port 뒤의 외부
|
||||
adapter로만 추가한다. SDK type과 event API를 application/feature/presentation
|
||||
public contract에 노출하지 않는다.
|
||||
|
||||
## 실행 경계
|
||||
|
||||
```text
|
||||
route/application/HTTP/cache/storage/bootstrap
|
||||
-> typed DiagnosticsPort 또는 TelemetryPort
|
||||
-> registry + allowlist + value policy
|
||||
-> bounded memory/no-op 또는 best-effort HTTP adapter
|
||||
-> 프로젝트가 선택한 외부 sink
|
||||
```
|
||||
|
||||
- diagnostics contract: `src/contracts/diagnostics.ts`
|
||||
- telemetry contract: `src/contracts/telemetry.js`
|
||||
- application ports: `src/application/ports/diagnostics-port.ts`,
|
||||
`telemetry-port.ts`
|
||||
- bounded diagnostics: `src/adapters/diagnostics/bounded-diagnostics.ts`
|
||||
- best-effort telemetry: `src/adapters/telemetry/best-effort-telemetry.js`
|
||||
- composition: `src/bootstrap/runtime-adapters.js`
|
||||
|
||||
## 검증
|
||||
|
||||
- `check:diagnostics`는 모든 registry event에 production producer가 있는지와
|
||||
source의 direct console/sensitive context 우회를 검사한다.
|
||||
- negative source fixture는 direct console, unknown event와 raw context를 실제로
|
||||
거절하며 TypeScript fixture는 잘못된 level/event ID를 거절한다.
|
||||
- unit test는 allowlist, hostile/circular error, bounded diagnostics, no-op,
|
||||
queue full, sink/observer failure와 pre-mount boot evidence를 검증한다.
|
||||
- HTTP integration은 success, retry recovery, terminal failure와 abort의 producer
|
||||
횟수, route/operation/correlation context와 요청 값 비노출을 검증한다.
|
||||
- cache/storage/release/application/runtime test는 각 production wiring과
|
||||
diagnostics failure isolation을 검증한다.
|
||||
|
||||
## 한계와 재검토 조건
|
||||
|
||||
기본 adapter는 운영 log 검색, source map 연계, session replay, distributed span,
|
||||
analytics consent, sampling budget과 장기 보존을 제공하지 않는다. 실제 sink를
|
||||
선정할 때 데이터 처리 지역, 보존 기간, consent, CSP, source map 접근 제어,
|
||||
sampling과 비용 상한을 별도 결정해야 한다.
|
||||
|
||||
## Rollback
|
||||
|
||||
telemetry exporter는 runtime 설정을 끄거나 adapter wiring을 `noOpTelemetry`로
|
||||
바꾸어 독립적으로 제거할 수 있다. 이때도 `DiagnosticsPort`, registry,
|
||||
redaction/value policy, producer-count와 negative fixture는 유지한다. 외부 SDK
|
||||
문제로 application producer와 안전 계약을 함께 되돌리지 않는다.
|
||||
@@ -0,0 +1,71 @@
|
||||
# VD-08: 개발용 Storybook과 로컬 시각 회귀 증적
|
||||
|
||||
- 상태: Accepted
|
||||
- 결정일: 2026-07-26
|
||||
- 적용 브랜치: `feature-frontend-test-registry-evidence-hardening`
|
||||
- 재검토: 제품이 cloud visual review, 다중 OS baseline 또는 별도 디자인 시스템
|
||||
배포를 요구할 때
|
||||
|
||||
## 배경
|
||||
|
||||
`/examples/ui`와 `/examples/states`는 실제 application composition 안에서 공통
|
||||
UI와 상태 표면을 보여 주지만, primitive를 격리해 interaction과 접근성을 검증하는
|
||||
workshop은 아니었다. 실패 시 screenshot도 디버깅 증거일 뿐 의도된 UI 기준선과
|
||||
현재 렌더의 차이를 차단하지 못했다.
|
||||
|
||||
외부 visual review 서비스, 별도 Storybook 배포와 브랜드별 baseline은 아직
|
||||
선정되지 않았다. 이 결정을 기다리며 UI 회귀 검증을 비워 두거나 production
|
||||
application bundle에 workshop runtime을 포함하는 것 모두 적절하지 않다.
|
||||
|
||||
## 결정
|
||||
|
||||
1. Storybook은 development dependency와 별도 static artifact로만 사용한다.
|
||||
production entry와 application `dist`에는 Storybook runtime, story 또는
|
||||
테스트 selector를 포함하지 않는다.
|
||||
2. story는 public design-system entry를 소비하고 실제 locale, theme, session,
|
||||
router와 query provider 계약으로 렌더한다. production component를 복제한
|
||||
story 전용 구현을 만들지 않는다.
|
||||
3. interaction과 story-level axe는 Playwright가 정적 Storybook을 대상으로
|
||||
실행한다. unexpected console, page error와 request failure는 테스트 실패다.
|
||||
4. 시각 회귀는 production `build` 후 `preview`를 대상으로 pinned Chromium,
|
||||
locale, color scheme과 viewport에서 `toHaveScreenshot()`으로 실행한다.
|
||||
5. 최초 기준선은 wide shell, compact pseudo-locale drawer, dark design-system
|
||||
gallery, loading/empty/error/access 상태 표면을 포함한다.
|
||||
6. animation과 caret만 결정적으로 비활성화한다. `html`, `body`, `main` 또는
|
||||
application 전체를 mask해 false PASS를 만드는 설정은 gate가 거절한다.
|
||||
7. snapshot 갱신은 `test:visual:update`라는 명시적 명령으로 분리하고 PNG diff를
|
||||
review한다. 일반 `test:visual`은 승인 기준선을 변경하지 않는다.
|
||||
8. local visual threshold는 작은 rasterization 차이만 허용하며 실제 layout,
|
||||
copy, theme 또는 상태 변화가 숨겨지도록 확대하지 않는다.
|
||||
9. `/examples/*`는 production composition smoke로 유지하고 Storybook story의
|
||||
대체물로 취급하지 않는다. 반대로 Storybook만 통과해 application shell
|
||||
integration을 완료 처리하지 않는다.
|
||||
10. cloud service가 선정되지 않아도 repository-local workshop, interaction,
|
||||
a11y와 visual baseline gate는 완전하게 실행 가능해야 한다.
|
||||
|
||||
## 실행과 증적
|
||||
|
||||
- workshop config: `.storybook/main.ts`, `.storybook/preview.tsx`
|
||||
- story: `src/presentation/design-system/design-system.stories.tsx`
|
||||
- interaction/a11y: `tests/storybook/workshop.spec.ts`
|
||||
- visual: `tests/visual/platform.visual.spec.ts`
|
||||
- baseline: `tests/visual/__snapshots__/`
|
||||
- production E2E: `playwright.config.js`
|
||||
- local dev E2E: `playwright.dev.config.js`
|
||||
- evidence policy: `scripts/check-test-evidence.mjs`
|
||||
|
||||
CI는 JUnit, HTML report, failure trace/screenshot, visual baseline 존재 여부와
|
||||
금지된 full-screen mask/무소유 skip fixture를 함께 검사한다.
|
||||
|
||||
## 한계와 재검토 조건
|
||||
|
||||
로컬 기준선은 실제 iOS/Android 기기, 여러 운영체제의 font rasterization,
|
||||
디자인 승인 workflow와 다중 브랜드를 증명하지 않는다. 이를 요구하면 동일
|
||||
public component와 story를 입력으로 사용하는 외부 review adapter를 추가하되,
|
||||
provider 결과가 없을 때 임의 PASS로 대체하지 않는다.
|
||||
|
||||
## Rollback
|
||||
|
||||
Storybook dependency/config, workshop test와 visual config/baseline은 production
|
||||
runtime 변경 없이 독립적으로 제거할 수 있다. rollback 후에도 `/examples/*`,
|
||||
component behavior, automated accessibility와 built-dist E2E는 유지한다.
|
||||
@@ -12,7 +12,7 @@
|
||||
- 기본 번들에 포함할 역량과 필요할 때 설치할 확장 역량을 구분한다.
|
||||
- 특정 벤더를 채택하더라도 제품 코드가 벤더 API에 직접 결합되지 않는지 확인한다.
|
||||
|
||||
최초 검토 기준은 `develop`의 `cb195f8`이며, RP-01~RP-08 구현 결과를 이 문서에
|
||||
최초 검토 기준은 `develop`의 `cb195f8`이며, RP-01~RP-10 구현 결과를 이 문서에
|
||||
누적 반영했다. 이후 구현으로 경로나 세부 내용이 달라질 수 있으므로, 각 항목은
|
||||
문서의 경로뿐 아니라 해당 테스트와 아키텍처 게이트로 계속 검증해야 한다.
|
||||
|
||||
@@ -33,21 +33,22 @@
|
||||
|
||||
특히 다음은 선행 해결이 필요하다.
|
||||
|
||||
RP-01~RP-08에서 TypeScript 도구 안전망, application runtime 주입,
|
||||
RP-01~RP-09에서 TypeScript 도구 안전망, application runtime 주입,
|
||||
query/mutation inbound adapter, HTTP 실행 계약과 executable route/release
|
||||
recovery 계약, 제거 가능한 reference 수직 슬라이스, form/page, design system과
|
||||
i18n 실행 경계는 구현됐다. 현재 선행 해결
|
||||
i18n 실행 경계와 diagnostics/telemetry production wiring은 구현됐다. 현재 선행 해결
|
||||
대상은 다음과 같다.
|
||||
|
||||
1. diagnostics/telemetry 실제 producer 연결
|
||||
2. registry evidence, 공급망과 optional adapter recipe 심화 게이트
|
||||
1. 공급망의 transitive inventory/license/vulnerability/SBOM/provenance 검증
|
||||
2. optional adapter의 opt-in 경계와 제거 가능한 recipe
|
||||
|
||||
따라서 현재 상태를 “프론트 공통부가 모두 구현됐다”고 표현하면 범위가 과장된다.
|
||||
더 정확한 표현은 다음과 같다.
|
||||
|
||||
> 운영·안전 계약과 범용 앱 셸은 갖춰졌지만, 기능 개발자가 사용하는 application
|
||||
> API, 서버 상태, 폼, 라우팅, 페이지 패턴의 표준 수직 경로는 아직 보강이
|
||||
> 필요하다.
|
||||
> application API, 서버 상태, 폼, 라우팅, 페이지, 디자인 시스템과 테스트 증적의
|
||||
> 표준 수직 경로는 갖춰졌다. 현재 남은 저장소 내부 범위는 공급망 검증과
|
||||
> opt-in adapter recipe이며 실제 hosting·IdP·운영 provider는 프로젝트 통합
|
||||
> 범위다.
|
||||
|
||||
## 3. 판정 기준
|
||||
|
||||
@@ -66,7 +67,7 @@ i18n 실행 경계는 구현됐다. 현재 선행 해결
|
||||
| 계층 의존 방향 | 부분 준비 | `.dependency-cruiser.cjs`, `src/application/ports` | inbound/outbound 명명과 `contracts` 소유권까지 집행 |
|
||||
| application facade | 준비됨 | typed input/output catalog, provider, production composition test | feature input use case를 contribution으로 확장 |
|
||||
| HTTP client | 준비됨 | path/search/body projection, runtime timeout/retry, abort/cleanup test | feature gateway 뒤에서 사용 |
|
||||
| retry | 준비됨 | HTTP 단일 소유, runtime max attempts, Query retry off | RP-09에서 telemetry 연결 |
|
||||
| retry | 준비됨 | HTTP 단일 소유, runtime max attempts, Query retry off, logical execution당 bounded diagnostics | terminal event 중복 방지 계약 유지 |
|
||||
| 오류 모델 | 부분 준비 | error registry와 normalization 존재 | typed discriminated union과 계층별 mapper |
|
||||
| 검증 | 준비됨 | runtime/API/route/form Zod parse 결과를 실행 경계에서 사용하고 domain invariant와 분리 | feature별 schema 소유권 유지 |
|
||||
| 인증 연동 | 준비됨/프로젝트 선택 | opaque auth owner와 demo seam 존재 | 인증 방식별 recipe; 기본 token 저장소는 추가하지 않음 |
|
||||
@@ -77,17 +78,17 @@ i18n 실행 경계는 구현됐다. 현재 선행 해결
|
||||
| 앱 셸·반응형 | 준비됨 | native modal Drawer, compact/desktop layout, Escape/link dismiss/focus restore, pseudo reflow와 RTL direction | compact browser matrix 유지 |
|
||||
| 페이지 템플릿 | 준비됨 | Standard/Collection/Detail/Form/Status와 public design-system entry | feature별 slot 조합 유지 |
|
||||
| 디자인 토큰 | 준비됨 | primitive/semantic/component CSS, 48-token 자동 계약, dark/forced-colors/reduced-motion | 제품 brand token은 외부 프로젝트에서 확장 |
|
||||
| 공통 UI | 준비됨 | action/form/feedback/overlay/navigation primitive와 pattern, compatibility export | Storybook/visual은 RP-10 |
|
||||
| 공통 UI | 준비됨 | action/form/feedback/overlay/navigation primitive와 pattern, compatibility export | public story와 visual state matrix 유지 |
|
||||
| 아이콘 | 준비됨 | Lucide static vendor facade와 semantic icon/IconButton 접근성 계약 | 의미 icon 추가 시 bundle/접근성 기준 적용 |
|
||||
| 폼 | 준비됨 | Zod 기반 local facade, error summary/focus, 422 allowlist, dirty/pending/conflict 정책 | 복합 form 요구가 생기면 VD-04 조건으로 vendor adapter 평가 |
|
||||
| 국제화 | 준비됨 | 137-key typed catalog, locale provider, Intl formatter, safe fallback/alias, pseudo·RTL gate | 실제 locale·번역 승인은 프로젝트에서 연결 |
|
||||
| logging/diagnostics | 미제공 | telemetry port는 있으나 logger 없음 | redaction이 적용된 diagnostics/logging 경계 |
|
||||
| telemetry | 부분 준비 | registry, queue, redaction 존재 | HTTP·boot·cache·storage·route 사건에 실제 연결 |
|
||||
| logging/diagnostics | 준비됨 | 별도 `DiagnosticsPort`, 8-event registry, allowlist, bounded/no-op adapter와 production producer | 실제 프로젝트의 remote sink는 port 뒤에서 선택 |
|
||||
| telemetry | 준비됨/프로젝트 선택 | 5-event registry, bounded queue, redaction/value policy, boot·HTTP·render·release·drop producer | analytics/RUM/error vendor와 consent는 프로젝트에서 선택 |
|
||||
| 비동기 상태 불변식 | 준비됨 | 배타적 typed overlay, stale latch, 실제 retry/conflict action | reference 화면에서 전체 상태 전시 |
|
||||
| 단위·통합·E2E | 준비됨 | Vitest, RTL, MSW, Playwright 3엔진 | TS 테스트 검사, 실제 bootstrap 통합, 위험 시나리오 보강 |
|
||||
| UI 회귀 검증 | 미제공 | axe/reflow는 있으나 visual baseline 없음 | Storybook 또는 동급 workshop과 시각 회귀 |
|
||||
| 샘플 제거 | 준비됨 | feature/catalog/test 제거 후 type/architecture/registry/test/home/build 8단계 검증 | 새 contribution도 같은 제거 gate에 포함 |
|
||||
| registry·compatibility 집행 | 부분 준비 | registry와 gate는 있으나 실제 before/after 및 orphan 검사가 제한적 | type/reference/orphan/diff/migration을 자동 검증 |
|
||||
| 단위·통합·E2E | 준비됨 | source/test strict typecheck, shared MSW 19개 scenario, 실제 bootstrap, built-dist 3엔진·compact E2E | 제품별 critical flow를 같은 catalog/gate에 추가 |
|
||||
| UI 회귀 검증 | 준비됨 | dev-only Storybook interaction/axe와 pinned Chromium visual baseline 4종 | cloud review와 다중 OS/device는 프로젝트 선택 |
|
||||
| 샘플 제거 | 준비됨 | feature/catalog/test 제거 후 type/architecture/registry/test/home/build 9단계 검증 | 새 contribution도 같은 제거 gate에 포함 |
|
||||
| registry·compatibility 집행 | 준비됨 | 10개 registry type/reference/consumer/orphan, 승인 digest와 actual semantic diff, breaking evidence | public 계약 변경 시 baseline review 유지 |
|
||||
| 공급망 검사 | 부분 준비 | lockfile·문서·gate는 있으나 실제 transitive 취약점/license/SBOM 깊이가 부족 | pinned scanner와 policy exception/증적 연결 |
|
||||
| realtime·offline·file 등 | 프로젝트 선택 | 현재 없음 | port/adapter recipe와 선택 기준 제공 |
|
||||
|
||||
@@ -217,11 +218,14 @@ guard → browser navigation adapter의 1회 reload로 연결됐다. 일반 rend
|
||||
failure는 이 경로에서 제외되고, 반복 실패·offline·malformed manifest·storage
|
||||
실패는 지원 표면으로 fail-closed된다.
|
||||
|
||||
#### telemetry, registry, 공급망 gate의 실행 깊이가 부족하다
|
||||
#### RP-09에서 diagnostics/telemetry 실행 깊이 보강
|
||||
|
||||
telemetry registry에는 여러 사건이 있지만 실제 production producer는 제한적이다.
|
||||
boot, API attempt/final failure, auth recovery, storage/cache degradation, release/chunk
|
||||
recovery를 registry 사건에 연결해야 한다.
|
||||
`DiagnosticsPort`와 `TelemetryPort`를 분리하고 boot, HTTP logical outcome,
|
||||
render, cache, storage, route, release mismatch와 delivery drop을 production
|
||||
producer에 연결했다. HTTP retry는 attempt별 terminal event를 발행하지 않고
|
||||
logical execution 종료 시 한 번만 bounded outcome을 남긴다. allowlist와
|
||||
value policy가 raw URL/query/body/storage value/error object를 거절하고 queue와
|
||||
sink failure는 nonrecursive drop evidence로 제한된다.
|
||||
|
||||
registry/compatibility 검사는 다음까지 확장한다.
|
||||
|
||||
@@ -243,7 +247,7 @@ known vulnerability, license policy, SBOM/provenance를 pinned tool로 검사해
|
||||
- token → primitive → pattern → template로 이어지는 디자인 시스템
|
||||
- Lucide를 감싼 local icon registry와 `IconButton`
|
||||
- typed message key, locale provider, formatter, pseudo-locale/RTL smoke
|
||||
- redacted structured diagnostics/logger와 telemetry wiring
|
||||
- RP-09에서 완료한 redacted structured diagnostics와 telemetry wiring 유지
|
||||
- Storybook 또는 동급 isolated UI workshop
|
||||
- Playwright visual baseline, shared MSW scenarios, built-dist E2E
|
||||
- React Hooks, JSX accessibility, TanStack Query 관련 lint
|
||||
@@ -380,7 +384,8 @@ bootstrap → React TSX → tests 순서로 이동한다.
|
||||
|
||||
- retry: `src/adapters/http/retry-policy.js`, 부분 준비
|
||||
- API client: `src/adapters/http/client.js`, 부분 준비
|
||||
- logger: 없음. telemetry와 분리하거나 diagnostics port로 합치는 결정 필요
|
||||
- logger: `DiagnosticsPort`로 telemetry와 분리해 구현. closed event/level,
|
||||
allowlist와 bounded/no-op adapter 제공
|
||||
- token manager: 의도적으로 없음. opaque external auth owner가 credential을 소유
|
||||
- error: `src/contracts/errors.js`와 HTTP normalization, 부분 준비
|
||||
- validation: runtime/API Zod는 존재, route/form/domain 분리는 미완성
|
||||
|
||||
@@ -723,6 +723,28 @@ render와 release 사건을 실제 producer에 연결한다.
|
||||
RP-09는 exporter를 제거하고 즉시 no-op adapter로 전환할 수 있어야 한다.
|
||||
diagnostics port와 redaction test는 유지한다.
|
||||
|
||||
**구현 증거 (2026-07-26)**
|
||||
|
||||
- VD-07에서 level/event 기반 `DiagnosticsPort`와 semantic `TelemetryPort`를
|
||||
분리하고 bounded memory/no-op 또는 설정 기반 best-effort HTTP exporter를
|
||||
채택했다.
|
||||
- diagnostics 8종과 telemetry 5종의 registry, context/attribute allowlist,
|
||||
고카디널리티 value policy, timestamp와 status/attempt/duration/queue bucket을
|
||||
구현했다.
|
||||
- boot, route, render, HTTP logical outcome, cache, storage, release mismatch와
|
||||
telemetry drop을 production composition에 연결했다. HTTP는 success/recovery/
|
||||
terminal/abort 각각 logical execution당 diagnostics 한 번, terminal
|
||||
non-abort failure telemetry 한 번만 발행한다.
|
||||
- bounded oldest-drop queue, drop reason 집계, sink/observer failure 격리와
|
||||
nonrecursive delivery evidence를 구현했다. exporter가 없으면 network와 queue
|
||||
side effect가 없는 true no-op이다.
|
||||
- `check:diagnostics`, source negative fixture와 TypeScript negative fixture가
|
||||
producer 누락, direct console, unknown event/context, raw URL/query/body/
|
||||
credential 경계를 거절한다.
|
||||
- unit/integration test가 circular/hostile error, pre-mount boot, queue/sink
|
||||
failure, no-op, cache/storage/release producer, success/retry recovery/terminal/
|
||||
abort 횟수와 reference route/operation/correlation context를 검증한다.
|
||||
|
||||
### 10. `feature-frontend-test-registry-evidence-hardening`
|
||||
|
||||
**목표**
|
||||
@@ -786,6 +808,35 @@ RP-10은 직전 승인 registry snapshot과 test evidence다. flaky visual/brows
|
||||
infrastructure commit은 product behavior와 분리한다. 장기 skip으로 PASS하지 않고
|
||||
owner와 만료 시한이 있는 quarantine만 허용한다.
|
||||
|
||||
**구현 증거 (2026-07-26)**
|
||||
|
||||
- VD-08에서 dev-only Storybook static workshop과 production build를 대상으로 한
|
||||
local Playwright visual baseline을 채택하고 cloud review는 선택 사항으로
|
||||
분리했다.
|
||||
- 10개 registry의 required field, runtime type, enum, unique, cross-reference,
|
||||
consumer와 orphan을 검사하고 승인 snapshot digest와 현재 snapshot의 actual
|
||||
semantic diff를 계산한다. 행·field·type·path뿐 아니라 registry 검증 계약
|
||||
변경도 breaking evidence 대상이다.
|
||||
- ordering-only 변경은 `none`, row addition은 `additive`, 일반 값 변경은
|
||||
`behavior-change`, 제거/type/path/contract 변경은 `breaking`으로 계산한다.
|
||||
breaking에는 version, migration, compatibility window, rollback과 owner를
|
||||
요구하며 digest 변조와 누락 fixture가 실제로 실패한다.
|
||||
- API operation별 19개 shared MSW scenario catalog와 strict unhandled-request
|
||||
server를 제공하고 reference vertical integration이 공통 envelope/handler를
|
||||
사용한다.
|
||||
- 기본 Playwright는 `build` + `preview`의 실제 `dist`를 Chromium, Firefox,
|
||||
WebKit에서 검사하고 별도 compact project를 제공한다. 개발 피드백용 Vite
|
||||
profile은 `playwright.dev.config.js`로 분리했다.
|
||||
- Storybook public primitive story, interaction과 axe test, wide/compact/
|
||||
pseudo/dark/state surface의 pinned Chromium visual baseline 4종을 CI evidence로
|
||||
연결했다.
|
||||
- V8 coverage와 9개 high-risk module을 대상으로 40개 scoped threshold를
|
||||
적용하고 threshold 미달 fixture를 차단한다.
|
||||
- deterministic clock/random/scheduler/storage, unexpected console/page error/
|
||||
request failure 정책, 무소유 skip과 full-screen mask 금지 gate를 제공한다.
|
||||
- JUnit, HTML report, trace/screenshot, coverage, registry와 fixture artifact를
|
||||
기존 26개 blocking gate taxonomy에 연결했다.
|
||||
|
||||
### 11. `feature-frontend-supply-chain-verification`
|
||||
|
||||
**목표**
|
||||
|
||||
@@ -779,22 +779,31 @@ Logger와 telemetry는 같은 것이 아니다.
|
||||
- Telemetry: registry에 정의된 semantic event와 metric
|
||||
- Error reporter: 예외 집계와 release correlation
|
||||
|
||||
기본 `Logger` output port는 safe context만 받는다.
|
||||
VD-07에 따라 기본 구현은 임의 message 문자열을 받는 `Logger`가 아니라 닫힌
|
||||
event ID와 safe context만 받는 `DiagnosticsPort`다.
|
||||
|
||||
```ts
|
||||
export interface Logger {
|
||||
debug(message: string, context?: SafeLogContext): void;
|
||||
info(message: string, context?: SafeLogContext): void;
|
||||
warn(message: string, context?: SafeLogContext): void;
|
||||
error(message: string, context?: SafeLogContext): void;
|
||||
export interface DiagnosticsPort {
|
||||
record(input: {
|
||||
level: DiagnosticLevel;
|
||||
eventId: DiagnosticEventId;
|
||||
context?: DiagnosticContext;
|
||||
}): void;
|
||||
}
|
||||
```
|
||||
|
||||
개발 환경에는 redacted console adapter, production에는 allowlist 기반
|
||||
remote adapter, 테스트에는 recording 또는 no-op adapter를 연결한다.
|
||||
기본 runtime에는 bounded in-memory diagnostics와 설정 기반 best-effort
|
||||
telemetry adapter, 테스트에는 recording 또는 no-op adapter를 연결한다.
|
||||
direct `console`은 redaction 경계를 우회하므로 source gate가 거절한다.
|
||||
민감정보 redaction은 각 호출자의 선의가 아니라 adapter와 contract에서
|
||||
강제한다.
|
||||
|
||||
현재 production producer는 boot, logical HTTP outcome, cache, storage, route,
|
||||
render, release mismatch와 telemetry delivery drop을 포함한다. HTTP terminal
|
||||
telemetry는 모든 retry가 끝난 뒤 한 번만 발행하며 abort에는 발행하지 않는다.
|
||||
raw path/query/body/error 대신 route/operation/correlation ID와
|
||||
status/attempt/duration bucket만 전달한다.
|
||||
|
||||
## 16. Feature 경계와 removable reference feature
|
||||
|
||||
Reference feature는 단순 UI fixture가 아니라 다음 경로를 모두 실행해야
|
||||
@@ -1223,9 +1232,10 @@ contract와 실패 분기를 우선한다.
|
||||
- [ ] runtime timeout/retry 설정이 실제 HTTP transport에 반영된다.
|
||||
- [ ] QueryClient와 feature query bridge가 실제 route에서 동작한다.
|
||||
- [ ] session UI API와 credential attachment가 분리되어 있다.
|
||||
- [ ] logger와 telemetry가 HTTP/render/storage/cache failure 경로에
|
||||
- [x] diagnostics와 telemetry가 HTTP/render/storage/cache failure 경로에
|
||||
연결된다.
|
||||
- [ ] page lifecycle에서 필요한 telemetry flush/cleanup이 수행된다.
|
||||
- [x] `pagehide`에서 bounded telemetry queue를 flush하고 adapter `dispose`가
|
||||
lifecycle listener를 정리한다.
|
||||
|
||||
### 26.3 HTTP와 validation
|
||||
|
||||
|
||||
@@ -468,23 +468,31 @@ raw response body, stack, token, URL query, PII를 사용자 copy나 일반 log
|
||||
|
||||
### 7.3 diagnostics와 telemetry
|
||||
|
||||
현재 telemetry event contract와 별도로 개발·진단용 structured logger가 필요하다.
|
||||
다음 두 설계 중 하나를 ADR로 결정한다.
|
||||
|
||||
1. `DiagnosticsPort`가 log/event/span을 내부 method로 구분
|
||||
2. `LoggerPort`와 `TelemetryPort`를 분리
|
||||
VD-07에서 level/event 기반 `DiagnosticsPort`와 semantic
|
||||
`TelemetryPort`를 분리했다. diagnostics는 8개 event ID와 safe context
|
||||
allowlist를, telemetry는 event별 required/optional attribute와 value policy를
|
||||
사용한다.
|
||||
|
||||
공통 요구:
|
||||
|
||||
- log level과 event key는 닫힌 union
|
||||
- attribute allowlist와 중앙 redaction
|
||||
- dev adapter는 console을 사용하되 동일 redaction 적용
|
||||
- production adapter는 provider SDK를 감싸며 앱 코드는 SDK를 import하지 않음
|
||||
- 기본 adapter는 bounded memory/no-op이고 endpoint가 있을 때만 best-effort
|
||||
HTTP queue를 사용
|
||||
- production provider SDK를 추가할 때도 port 뒤에서 감싸며 앱 코드는 SDK를
|
||||
import하지 않음
|
||||
- 오류 객체 전체를 그대로 serialize하지 않음
|
||||
- trace ID/build ID/route ID/operation ID를 허용된 범위에서 연결
|
||||
- logging failure가 제품 flow를 실패시키지 않음
|
||||
- consent가 필요한 analytics와 essential diagnostics를 분리
|
||||
|
||||
HTTP는 route/operation/correlation ID를 logical execution context로 생성하고
|
||||
success/recovered/failed/aborted 종료 시 diagnostics를 한 번만 기록한다.
|
||||
terminal non-abort failure만 telemetry를 한 번 발행한다. cache/storage와 boot
|
||||
producer는 raw key, value, message, stack을 버리고 error kind와 bounded
|
||||
operation만 남긴다. queue full과 sink failure는 제한된 reason bucket이며 drop
|
||||
observer가 실패해도 재귀 발행하지 않는다.
|
||||
|
||||
### 7.4 locale, message와 표시 값
|
||||
|
||||
RP-08부터 locale은 presentation-owned React context다. server/application
|
||||
|
||||
@@ -43,7 +43,12 @@
|
||||
- `test:unit`
|
||||
- `test:component`
|
||||
- `test:integration`
|
||||
- `test:coverage`
|
||||
- `test:e2e`
|
||||
- `test:e2e:dev`
|
||||
- `build:storybook`
|
||||
- `test:storybook`
|
||||
- `test:visual`
|
||||
- `test:a11y`
|
||||
- `review:a11y-manual`
|
||||
- `test:sample-removal`
|
||||
@@ -67,7 +72,7 @@ field/documentation 단계를 구성한다.
|
||||
- 320px reflow와 mobile navigation을 E2E로 확인한다.
|
||||
- release build의 bundle과 lab performance budget이 별도 gate다.
|
||||
|
||||
### 2.3 확인된 공백
|
||||
### 2.3 RP-10에서 닫힌 공백과 남은 외부 범위
|
||||
|
||||
#### 테스트 TypeScript typecheck 기반
|
||||
|
||||
@@ -76,20 +81,12 @@ field/documentation 단계를 구성한다.
|
||||
검사하되 실패를 의도한 `tests/fixtures`는 별도 negative command가 소유한다.
|
||||
Vitest의 변환 성공을 TypeScript typecheck의 대체물로 취급하지 않는다.
|
||||
|
||||
#### 실제 bootstrap integration test가 없다
|
||||
#### 실제 bootstrap integration
|
||||
|
||||
`tests/component/bootstrap-shell.test.jsx`는 production bootstrap을 import하지
|
||||
않고 테스트 내부의 `<TestShell>`만 렌더링한다. E2E는 실제 entry를 통과하지만,
|
||||
다음 실패를 작은 통합 테스트에서 식별하기 어렵다.
|
||||
|
||||
- runtime config fetch 실패
|
||||
- config/manifest mismatch
|
||||
- adapter composition 실패
|
||||
- provider 순서 또는 누락
|
||||
- external auth owner 유무
|
||||
- product tree를 마운트하기 전 fail-closed
|
||||
- boot error shell의 safe metadata
|
||||
- StrictMode와 unmount cleanup
|
||||
runtime config와 release manifest를 검증한 composition root에서 실제 provider
|
||||
순서와 application input을 연결하는 component/integration test를 제공한다.
|
||||
production Playwright profile은 source fixture가 아니라 `build` + `preview`의
|
||||
실제 entry와 hashed route chunk를 사용한다.
|
||||
|
||||
#### TanStack Query의 React integration test 기반
|
||||
|
||||
@@ -100,53 +97,44 @@ optimistic commit/rollback, conflict 해제와 namespace invalidation이 실제
|
||||
QueryClient 위에서 실행된다. HTTP 자동 retry가 소유자이므로 이 adapter의
|
||||
query/mutation vendor retry는 꺼져 있다.
|
||||
|
||||
#### Form 테스트가 단일 TextField 흐름에 머문다
|
||||
#### Form과 route 위험
|
||||
|
||||
현재 component/E2E는 label, description, error association과 빈 값 submit을
|
||||
검사한다. error summary, 첫 오류 focus, async validation race, 422 field error,
|
||||
double submit, dirty navigation, mutation conflict는 없다.
|
||||
form component/reference feature test가 error summary, 첫 오류 focus, Zod
|
||||
transform, 422 allowlist, double submit, dirty navigation, optimistic rollback과
|
||||
conflict를 검증한다. route registry/runtime 양방향 참조, codec, lazy module,
|
||||
location reset, scroll restoration, blocker와 bounded chunk recovery도
|
||||
unit/component/built artifact 검증에 연결됐다.
|
||||
|
||||
#### Route registry와 실행 tree가 별도로 테스트된다
|
||||
#### Storybook과 시각 회귀
|
||||
|
||||
registry snapshot과 일부 navigation/access policy test는 있으나 다음 계약을
|
||||
강제하지 않는다.
|
||||
public design-system primitive를 실제 platform provider로 렌더하는 dev-only
|
||||
Storybook, interaction/axe test와 production build를 대상으로 한
|
||||
`toHaveScreenshot()` baseline 4종을 제공한다. cloud review, 다중 OS font
|
||||
rasterization과 실제 device farm은 프로젝트가 요구할 때 연결한다.
|
||||
|
||||
- 모든 route ID에 lazy runtime module이 존재하는가
|
||||
- params/search가 실제 codec으로 검증되는가
|
||||
- deep link와 basename refresh가 동작하는가
|
||||
- chunk load failure가 1회 reload/support surface로 연결되는가
|
||||
- route error boundary가 location 변경 시 reset되는가
|
||||
- scroll restoration과 form navigation blocker가 동작하는가
|
||||
#### Shared MSW와 결정성
|
||||
|
||||
#### Storybook과 시각 회귀가 없다
|
||||
operation별 success/empty/slow/network/timeout/content/envelope/schema/auth/
|
||||
403/404/409/422/429/retry/terminal을 포함한 19개 scenario catalog와 strict
|
||||
unhandled-request server를 공유한다. clock/random/scheduler/storage helper와
|
||||
browser console/page/network failure 정책으로 비결정적 우회를 차단한다.
|
||||
|
||||
`/examples/ui`는 통합 gallery지만 component별 모든 state를 격리하지 않는다.
|
||||
Storybook story, interaction story, story-level axe, `toHaveScreenshot()` baseline이
|
||||
없다. `screenshot: "only-on-failure"`는 디버깅 증거이며 시각 회귀 테스트가 아니다.
|
||||
#### Built-dist와 compact E2E
|
||||
|
||||
#### MSW scenario가 공유되지 않는다
|
||||
기본 `test:e2e`는 CI에서 기존 server를 재사용하지 않고 `build` + `preview`를
|
||||
Chromium, Firefox, WebKit과 compact project로 실행한다. 빠른 Vite 개발 profile은
|
||||
`test:e2e:dev`로 분리한다.
|
||||
|
||||
integration file마다 `setupServer`, handler, response body를 다시 정의한다.
|
||||
Node integration, Storybook browser, feature component test, E2E mock service가 같은
|
||||
시나리오 이름과 contract fixture를 공유하지 않는다.
|
||||
#### 위험 기반 coverage
|
||||
|
||||
#### E2E가 개발 서버를 대상으로 한다
|
||||
V8 text/JSON/LCOV를 생성하고 전체 기준과 retry/storage/telemetry/compatibility/
|
||||
performance/promotion/chunk/diagnostics/registry compatibility 9개 high-risk
|
||||
module에 40개 scoped threshold를 적용한다. critical module 누락 또는 threshold
|
||||
미달 fixture는 merge gate를 실패시킨다.
|
||||
|
||||
현재 Playwright web server는 `pnpm dev`다. route behavior 확인에는 유효하지만
|
||||
다음 release 위험은 production build/preview에서만 확인할 수 있다.
|
||||
|
||||
- hashed lazy chunk
|
||||
- source 변환과 tree shaking
|
||||
- base path
|
||||
- deep-link fallback
|
||||
- build-time environment
|
||||
- release manifest와 runtime config 조합
|
||||
- minified code의 chunk failure
|
||||
|
||||
#### Coverage가 실행·차단되지 않는다
|
||||
|
||||
`vitest.config.js`에는 reporter만 선언되어 있고 coverage provider, script,
|
||||
threshold, diff policy가 없다.
|
||||
남은 범위는 실제 device/browser farm, cloud visual approval, 외부 인증·telemetry
|
||||
provider와 production field data다. 이 증거가 없을 때 저장소 내부 test를
|
||||
`PRODUCTION_READY`의 대체물로 사용하지 않는다.
|
||||
|
||||
## 3. 위험 기반 테스트 계층
|
||||
|
||||
@@ -410,6 +398,8 @@ Page / AsyncSurface / Form pattern
|
||||
- filter 순서가 달라도 canonical key가 같다.
|
||||
- route unmount 또는 superseded input에서 request를 abort한다.
|
||||
- aborted request는 terminal error나 telemetry failure로 오분류되지 않는다.
|
||||
- success와 retry recovery는 terminal failure telemetry를 만들지 않고,
|
||||
exhausted retry는 logical execution당 한 번만 발행한다.
|
||||
- offline/paused와 loading을 구분한다.
|
||||
- 401 복구는 한 번만 수행한다.
|
||||
- 재로그인 후 허용된 operation만 다시 실행한다.
|
||||
@@ -1226,8 +1216,9 @@ corepack pnpm build
|
||||
corepack pnpm check:bundle
|
||||
```
|
||||
|
||||
TypeScript test, Storybook, coverage, visual, built-dist 명령이 도입되면 위 목록과
|
||||
CI registry에 추가한다.
|
||||
TypeScript test, Storybook, coverage, visual과 built-dist 명령은
|
||||
`config/ci/gates.json`의 blocking step과 JUnit/HTML/trace/fixture evidence에
|
||||
연결되어 있다.
|
||||
|
||||
## 18. Feature Definition of Done
|
||||
|
||||
@@ -1283,7 +1274,8 @@ CI registry에 추가한다.
|
||||
- [ ] high-risk module branch 목표를 충족한다.
|
||||
- [ ] 신규 코드의 미검증 branch에 승인 없는 예외가 없다.
|
||||
- [ ] bundle/performance budget을 통과한다.
|
||||
- [ ] telemetry/error output에 민감 정보가 없다.
|
||||
- [x] diagnostics/telemetry output의 allowlist, value policy와 negative fixture가
|
||||
raw URL/query/body/storage value/error object를 거절한다.
|
||||
- [ ] 관련 gate와 evidence registry가 갱신되었다.
|
||||
|
||||
## 19. 금지 패턴
|
||||
|
||||
@@ -76,6 +76,7 @@ export default [
|
||||
"artifacts/**",
|
||||
"tests/fixtures/typecheck/**",
|
||||
"tests/fixtures/architecture/forbidden/**",
|
||||
"tests/fixtures/diagnostics/forbidden/**",
|
||||
"tests/fixtures/i18n/forbidden/**",
|
||||
"tests/fixtures/security/forbidden/**",
|
||||
],
|
||||
@@ -116,6 +117,25 @@ export default [
|
||||
"no-unused-vars": "off",
|
||||
},
|
||||
},
|
||||
{
|
||||
files: ["**/*.d.ts"],
|
||||
languageOptions: {
|
||||
...commonLanguageOptions,
|
||||
parser: babelParser,
|
||||
parserOptions: {
|
||||
requireConfigFile: false,
|
||||
babelOptions: {
|
||||
plugins: [
|
||||
["@babel/plugin-syntax-typescript", { dts: true }],
|
||||
],
|
||||
},
|
||||
},
|
||||
},
|
||||
rules: {
|
||||
"no-undef": "off",
|
||||
"no-unused-vars": "off",
|
||||
},
|
||||
},
|
||||
{
|
||||
files: ["**/*.tsx"],
|
||||
languageOptions: {
|
||||
@@ -273,6 +293,12 @@ export default [
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
files: [`tests/support/browser/**/*.${sourceExtensions}`],
|
||||
rules: {
|
||||
"react-hooks/rules-of-hooks": "off",
|
||||
},
|
||||
},
|
||||
{
|
||||
files: [
|
||||
`tests/fixtures/architecture/forbidden/**/*.${sourceExtensions}`,
|
||||
|
||||
+21
-1
@@ -13,12 +13,14 @@
|
||||
"build": "vite build && node scripts/generate-build-manifest.mjs",
|
||||
"build:release": "corepack pnpm build && corepack pnpm generate:supply-chain && corepack pnpm scan:security",
|
||||
"preview": "vite preview",
|
||||
"lint": "eslint src scripts tests vite.config.js vitest.config.js playwright.config.js --max-warnings=0",
|
||||
"lint": "eslint src scripts tests .storybook vite.config.js vitest.config.js playwright*.config.js --max-warnings=0",
|
||||
"check:architecture": "node scripts/check-architecture.mjs",
|
||||
"check:design-system": "node scripts/check-design-system.mjs",
|
||||
"check:design-system:fixture": "node scripts/check-design-system.mjs --fixture",
|
||||
"check:i18n": "node scripts/check-i18n.mjs",
|
||||
"check:i18n:fixture": "node scripts/check-i18n.mjs --fixture",
|
||||
"check:diagnostics": "node scripts/check-diagnostics.mjs",
|
||||
"check:diagnostics:fixture": "node scripts/check-diagnostics.mjs --fixture",
|
||||
"check:types": "corepack pnpm check:types:app && corepack pnpm check:types:node && corepack pnpm check:types:test",
|
||||
"check:types:app": "tsc --project tsconfig.app.json",
|
||||
"check:types:node": "tsc --project tsconfig.node.json",
|
||||
@@ -34,21 +36,35 @@
|
||||
"check:types:fixture:icon-button": "tsc --ignoreConfig --allowJs --checkJs --strict --noEmit --skipLibCheck --target ES2022 --module ESNext --moduleResolution Bundler --jsx react-jsx tests/fixtures/typecheck/invalid-icon-button.tsx",
|
||||
"check:types:fixture:i18n-key": "tsc --ignoreConfig --strict --noEmit --skipLibCheck --target ES2022 --module ESNext --moduleResolution Bundler tests/fixtures/typecheck/invalid-message-key.ts",
|
||||
"check:types:fixture:i18n-params": "tsc --ignoreConfig --strict --noEmit --skipLibCheck --target ES2022 --module ESNext --moduleResolution Bundler tests/fixtures/typecheck/invalid-message-params.ts",
|
||||
"check:types:fixture:diagnostics": "tsc --ignoreConfig --strict --noEmit --skipLibCheck --target ES2022 --module ESNext --moduleResolution Bundler tests/fixtures/typecheck/invalid-diagnostics-port.ts",
|
||||
"test:runtime-schema": "vitest run tests/runtime-schema --reporter=default --reporter=junit --outputFile.junit=artifacts/tests/runtime-schema.xml --passWithNoTests",
|
||||
"test:unit": "vitest run tests/unit --reporter=default --reporter=junit --outputFile.junit=artifacts/tests/unit.xml",
|
||||
"test:component": "vitest run tests/component --reporter=default --reporter=junit --outputFile.junit=artifacts/tests/component.xml",
|
||||
"test:integration": "vitest run tests/integration --reporter=default --reporter=junit --outputFile.junit=artifacts/tests/integration.xml",
|
||||
"test:e2e": "playwright test",
|
||||
"test:e2e:dev": "playwright test --config playwright.dev.config.js",
|
||||
"storybook": "storybook dev -p 6006",
|
||||
"build:storybook": "storybook build -o artifacts/storybook/static",
|
||||
"test:storybook": "playwright test --config playwright.storybook.config.js",
|
||||
"test:visual": "playwright test --config playwright.visual.config.js",
|
||||
"test:visual:update": "playwright test --config playwright.visual.config.js --update-snapshots",
|
||||
"check:test-evidence": "node scripts/check-test-evidence.mjs",
|
||||
"check:test-evidence:fixture": "node scripts/check-test-evidence.mjs --source-root tests/fixtures/test-evidence/forbidden --artifact artifacts/quality/test-evidence-fixture.json",
|
||||
"test:a11y": "playwright test --grep @a11y && node scripts/write-a11y-report.mjs",
|
||||
"review:a11y-manual": "node scripts/verify-a11y-manual.mjs",
|
||||
"test:sample-removal": "node scripts/test-sample-removal.mjs",
|
||||
"test:reference-feature": "vitest run tests/features/reference-feature --reporter=default --reporter=junit --outputFile.junit=artifacts/tests/reference-feature.xml --passWithNoTests",
|
||||
"test:coverage": "vitest run tests/runtime-schema tests/unit tests/component tests/integration tests/features/reference-feature --coverage --reporter=default --reporter=junit --outputFile.junit=artifacts/tests/coverage.xml && node scripts/check-risk-coverage.mjs",
|
||||
"check:coverage:fixture": "node scripts/check-risk-coverage.mjs --summary tests/fixtures/coverage/below-threshold.json --artifact artifacts/quality/risk-coverage-fixture.json",
|
||||
"test:all": "corepack pnpm test:runtime-schema && corepack pnpm test:unit && corepack pnpm test:component && corepack pnpm test:integration && corepack pnpm test:reference-feature",
|
||||
"verify:lockfile": "corepack pnpm install --frozen-lockfile",
|
||||
"generate:supply-chain": "node scripts/generate-supply-chain.mjs",
|
||||
"scan:security": "node scripts/security-scan.mjs",
|
||||
"check:browser-security": "node scripts/check-browser-security.mjs",
|
||||
"check:registries": "node scripts/check-registries.mjs",
|
||||
"check:registries:structure": "node scripts/check-registries.mjs --no-baseline",
|
||||
"check:registries:compatibility-fixtures": "node scripts/check-registry-compatibility-fixtures.mjs",
|
||||
"check:registries:baseline-fixture": "node scripts/check-registries.mjs --approval tests/fixtures/registry/compatibility/tampered-approval.json --artifact artifacts/quality/registry-baseline-fixture.json",
|
||||
"check:registries:fixture": "node scripts/check-registries.mjs --governance tests/fixtures/registry/forbidden/governance.json --artifact artifacts/quality/registry-fixture.json",
|
||||
"check:routes:fixture": "node scripts/check-registries.mjs --governance tests/fixtures/registry/routes/governance.json --artifact artifacts/quality/route-registry-fixture.json",
|
||||
"verify:compatibility": "node scripts/check-compatibility.mjs",
|
||||
@@ -79,6 +95,8 @@
|
||||
"@babel/plugin-syntax-typescript": "8.0.3",
|
||||
"@eslint/js": "10.0.1",
|
||||
"@playwright/test": "1.62.0",
|
||||
"@storybook/addon-a11y": "10.5.4",
|
||||
"@storybook/react-vite": "10.5.4",
|
||||
"@tailwindcss/vite": "4.3.3",
|
||||
"@testing-library/jest-dom": "7.0.0",
|
||||
"@testing-library/react": "16.3.2",
|
||||
@@ -87,12 +105,14 @@
|
||||
"@types/react": "19.2.8",
|
||||
"@types/react-dom": "19.2.3",
|
||||
"@vitejs/plugin-react": "6.0.4",
|
||||
"@vitest/coverage-v8": "4.1.10",
|
||||
"dependency-cruiser": "18.1.0",
|
||||
"eslint": "10.8.0",
|
||||
"eslint-plugin-react-hooks": "7.1.1",
|
||||
"globals": "17.7.0",
|
||||
"jsdom": "29.1.1",
|
||||
"msw": "2.15.0",
|
||||
"storybook": "10.5.4",
|
||||
"tailwindcss": "4.3.3",
|
||||
"typescript": "7.0.2",
|
||||
"vite": "8.1.5",
|
||||
|
||||
+31
-7
@@ -6,20 +6,44 @@ export default defineConfig({
|
||||
reporter: [
|
||||
["list"],
|
||||
["html", { outputFolder: "./artifacts/tests/e2e/report", open: "never" }],
|
||||
["junit", { outputFile: "./artifacts/tests/e2e/results.xml" }],
|
||||
],
|
||||
use: {
|
||||
baseURL: "http://127.0.0.1:5173",
|
||||
baseURL: "http://127.0.0.1:4173",
|
||||
trace: "retain-on-failure",
|
||||
screenshot: "only-on-failure",
|
||||
},
|
||||
webServer: {
|
||||
command: "corepack pnpm dev --host 127.0.0.1",
|
||||
url: "http://127.0.0.1:5173",
|
||||
reuseExistingServer: !process.env.CI,
|
||||
command:
|
||||
"corepack pnpm build && corepack pnpm preview --host 127.0.0.1 --port 4173",
|
||||
url: "http://127.0.0.1:4173",
|
||||
reuseExistingServer: false,
|
||||
},
|
||||
projects: [
|
||||
{ name: "chromium", use: { ...devices["Desktop Chrome"] } },
|
||||
{ name: "firefox", use: { ...devices["Desktop Firefox"] } },
|
||||
{ name: "webkit", use: { ...devices["Desktop Safari"] } },
|
||||
{
|
||||
name: "chromium",
|
||||
testIgnore: "**/compact-smoke.spec.js",
|
||||
use: { ...devices["Desktop Chrome"] },
|
||||
},
|
||||
{
|
||||
name: "firefox",
|
||||
testIgnore: "**/compact-smoke.spec.js",
|
||||
use: { ...devices["Desktop Firefox"] },
|
||||
},
|
||||
{
|
||||
name: "webkit",
|
||||
testIgnore: "**/compact-smoke.spec.js",
|
||||
use: { ...devices["Desktop Safari"] },
|
||||
},
|
||||
{
|
||||
name: "chromium-compact",
|
||||
testMatch: "**/compact-smoke.spec.js",
|
||||
use: {
|
||||
...devices["Desktop Chrome"],
|
||||
viewport: { width: 390, height: 844 },
|
||||
hasTouch: true,
|
||||
isMobile: true,
|
||||
},
|
||||
},
|
||||
],
|
||||
});
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
import { defineConfig } from "@playwright/test";
|
||||
|
||||
import releaseConfig from "./playwright.config.js";
|
||||
|
||||
export default defineConfig({
|
||||
...releaseConfig,
|
||||
use: {
|
||||
...releaseConfig.use,
|
||||
baseURL: "http://127.0.0.1:5173",
|
||||
},
|
||||
webServer: {
|
||||
command: "corepack pnpm dev --host 127.0.0.1",
|
||||
url: "http://127.0.0.1:5173",
|
||||
reuseExistingServer: true,
|
||||
},
|
||||
});
|
||||
@@ -0,0 +1,34 @@
|
||||
import { defineConfig, devices } from "@playwright/test";
|
||||
|
||||
export default defineConfig({
|
||||
testDir: "./tests/storybook",
|
||||
outputDir: "./artifacts/tests/storybook/results",
|
||||
reporter: [
|
||||
["list"],
|
||||
[
|
||||
"html",
|
||||
{
|
||||
outputFolder: "./artifacts/tests/storybook/report",
|
||||
open: "never",
|
||||
},
|
||||
],
|
||||
[
|
||||
"junit",
|
||||
{ outputFile: "./artifacts/tests/storybook/results.xml" },
|
||||
],
|
||||
],
|
||||
use: {
|
||||
baseURL: "http://127.0.0.1:6006",
|
||||
trace: "retain-on-failure",
|
||||
screenshot: "only-on-failure",
|
||||
},
|
||||
webServer: {
|
||||
command:
|
||||
"corepack pnpm build:storybook && node scripts/serve-static.mjs artifacts/storybook/static 6006",
|
||||
url: "http://127.0.0.1:6006",
|
||||
reuseExistingServer: false,
|
||||
},
|
||||
projects: [
|
||||
{ name: "chromium-workshop", use: { ...devices["Desktop Chrome"] } },
|
||||
],
|
||||
});
|
||||
@@ -0,0 +1,37 @@
|
||||
import { defineConfig, devices } from "@playwright/test";
|
||||
|
||||
export default defineConfig({
|
||||
testDir: "./tests/visual",
|
||||
snapshotDir: "./tests/visual/__snapshots__",
|
||||
outputDir: "./artifacts/tests/visual/results",
|
||||
reporter: [
|
||||
["list"],
|
||||
[
|
||||
"html",
|
||||
{ outputFolder: "./artifacts/tests/visual/report", open: "never" },
|
||||
],
|
||||
["junit", { outputFile: "./artifacts/tests/visual/results.xml" }],
|
||||
],
|
||||
expect: {
|
||||
toHaveScreenshot: {
|
||||
animations: "disabled",
|
||||
caret: "hide",
|
||||
maxDiffPixelRatio: 0.002,
|
||||
scale: "css",
|
||||
},
|
||||
},
|
||||
use: {
|
||||
...devices["Desktop Chrome"],
|
||||
baseURL: "http://127.0.0.1:4174",
|
||||
colorScheme: "light",
|
||||
locale: "en-US",
|
||||
trace: "retain-on-failure",
|
||||
},
|
||||
webServer: {
|
||||
command:
|
||||
"corepack pnpm build && corepack pnpm preview --host 127.0.0.1 --port 4174",
|
||||
url: "http://127.0.0.1:4174",
|
||||
reuseExistingServer: false,
|
||||
},
|
||||
projects: [{ name: "chromium-visual" }],
|
||||
});
|
||||
Generated
+1470
-16
File diff suppressed because it is too large
Load Diff
@@ -1,4 +1,5 @@
|
||||
allowBuilds:
|
||||
esbuild: true
|
||||
msw: true
|
||||
minimumReleaseAgeExclude:
|
||||
- '@playwright/test@1.62.0'
|
||||
|
||||
@@ -4,24 +4,49 @@
|
||||
"required": [
|
||||
"schemaVersion",
|
||||
"generatedAt",
|
||||
"compatibilityImpact",
|
||||
"baselineDigest",
|
||||
"currentDigest",
|
||||
"compatibility",
|
||||
"failures",
|
||||
"registries"
|
||||
],
|
||||
"properties": {
|
||||
"schemaVersion": { "const": 1 },
|
||||
"schemaVersion": { "const": 2 },
|
||||
"generatedAt": { "type": "string", "format": "date-time" },
|
||||
"compatibilityImpact": {
|
||||
"enum": ["none", "additive", "behavior-change", "breaking"]
|
||||
"baselineDigest": {
|
||||
"type": "string",
|
||||
"pattern": "^[a-f0-9]{64}$"
|
||||
},
|
||||
"currentDigest": {
|
||||
"type": "string",
|
||||
"pattern": "^[a-f0-9]{64}$"
|
||||
},
|
||||
"compatibility": {
|
||||
"type": "object",
|
||||
"required": ["impact", "changes"],
|
||||
"properties": {
|
||||
"impact": {
|
||||
"enum": ["none", "additive", "behavior-change", "breaking"]
|
||||
},
|
||||
"changes": { "type": "array" }
|
||||
},
|
||||
"additionalProperties": false
|
||||
},
|
||||
"failures": { "type": "array", "maxItems": 0 },
|
||||
"registries": {
|
||||
"type": "array",
|
||||
"minItems": 8,
|
||||
"maxItems": 8,
|
||||
"minItems": 10,
|
||||
"maxItems": 10,
|
||||
"items": {
|
||||
"type": "object",
|
||||
"required": ["registryId", "owner", "source", "rowCount", "rows"]
|
||||
"required": [
|
||||
"registryId",
|
||||
"owner",
|
||||
"source",
|
||||
"rowCount",
|
||||
"contract",
|
||||
"rows"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
@@ -0,0 +1,120 @@
|
||||
import { mkdir, readFile, readdir, writeFile } from "node:fs/promises";
|
||||
import path from "node:path";
|
||||
|
||||
// @ts-expect-error Node 24 executes erasable TypeScript for this build-time gate.
|
||||
import { DIAGNOSTIC_EVENT_REGISTRY } from "../src/contracts/diagnostics.ts";
|
||||
import { TELEMETRY_REGISTRY } from "../src/contracts/telemetry.js";
|
||||
|
||||
const fixtureMode = process.argv.includes("--fixture");
|
||||
const failures = [];
|
||||
const extensions = /\.(?:js|jsx|mjs|ts|tsx|mts)$/;
|
||||
|
||||
/** @param {string} directory @returns {Promise<string[]>} */
|
||||
async function filesBelow(directory) {
|
||||
const result = [];
|
||||
for (const entry of await readdir(directory, { withFileTypes: true })) {
|
||||
const target = path.join(directory, entry.name);
|
||||
if (entry.isDirectory()) result.push(...(await filesBelow(target)));
|
||||
else if (extensions.test(entry.name)) result.push(target);
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
const telemetryProducerFiles =
|
||||
/** @type {Readonly<Record<string, string>>} */ ({
|
||||
"app.boot.failed": "src/adapters/diagnostics/bounded-diagnostics.ts",
|
||||
"api.request.failed": "src/adapters/http/client.js",
|
||||
"ui.render.failed": "src/application/create-application.ts",
|
||||
"release.mismatch.detected": "src/application/create-application.ts",
|
||||
"telemetry.delivery.dropped":
|
||||
"src/adapters/telemetry/best-effort-telemetry.js",
|
||||
});
|
||||
const diagnosticProducerFiles =
|
||||
/** @type {Readonly<Record<string, string>>} */ ({
|
||||
"app.boot.failed": "src/adapters/diagnostics/bounded-diagnostics.ts",
|
||||
"http.request.completed": "src/adapters/http/client.js",
|
||||
"cache.operation.failed":
|
||||
"src/adapters/query-cache/tanstack-query-cache.js",
|
||||
"storage.operation.failed":
|
||||
"src/adapters/storage/browser-storage-adapter.js",
|
||||
"route.changed": "src/application/create-application.ts",
|
||||
"ui.render.failed": "src/application/create-application.ts",
|
||||
"release.mismatch.detected": "src/application/create-application.ts",
|
||||
"telemetry.delivery.dropped": "src/bootstrap/runtime-adapters.js",
|
||||
});
|
||||
|
||||
if (!fixtureMode) {
|
||||
for (const eventName of Object.keys(TELEMETRY_REGISTRY)) {
|
||||
const producer = telemetryProducerFiles[eventName];
|
||||
if (!producer) {
|
||||
failures.push(`telemetry event has no declared producer: ${eventName}`);
|
||||
continue;
|
||||
}
|
||||
const source = await readFile(producer, "utf8");
|
||||
if (!source.includes(`"${eventName}"`)) {
|
||||
failures.push(`telemetry producer is not executable: ${eventName}`);
|
||||
}
|
||||
}
|
||||
for (const eventId of Object.keys(DIAGNOSTIC_EVENT_REGISTRY)) {
|
||||
const producer = diagnosticProducerFiles[eventId];
|
||||
if (!producer) {
|
||||
failures.push(`diagnostic event has no declared producer: ${eventId}`);
|
||||
continue;
|
||||
}
|
||||
const source = await readFile(producer, "utf8");
|
||||
if (!source.includes(`"${eventId}"`)) {
|
||||
failures.push(`diagnostic producer is not executable: ${eventId}`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const sources = fixtureMode
|
||||
? await filesBelow("tests/fixtures/diagnostics/forbidden")
|
||||
: await filesBelow("src");
|
||||
const sensitiveContext =
|
||||
/\b(?:authorization|cookie|access_token|refresh_token|request_body|response_body|raw_url|query_string|email|user_name)\b/i;
|
||||
for (const file of sources) {
|
||||
const source = await readFile(file, "utf8");
|
||||
if (file.includes("contracts/telemetry.js")) continue;
|
||||
if (source.includes("console.")) {
|
||||
failures.push(`direct console diagnostics bypass in ${file}`);
|
||||
}
|
||||
const calls = source.match(
|
||||
/(?:\.record\(\{|\.emit\()[\s\S]{0,700}?(?:\}\)|\}\);)/g,
|
||||
) ?? [];
|
||||
if (calls.some((call) => sensitiveContext.test(call))) {
|
||||
failures.push(`sensitive diagnostic or telemetry context in ${file}`);
|
||||
}
|
||||
if (
|
||||
file.includes("tests/fixtures/diagnostics/forbidden") &&
|
||||
source.includes("UNKNOWN_DIAGNOSTIC_EVENT")
|
||||
) {
|
||||
failures.push(`unknown diagnostic event in ${file}`);
|
||||
}
|
||||
}
|
||||
|
||||
const report = {
|
||||
schemaVersion: 1,
|
||||
mode: fixtureMode ? "negative-fixture" : "source",
|
||||
telemetryEventCount: Object.keys(TELEMETRY_REGISTRY).length,
|
||||
diagnosticEventCount: Object.keys(DIAGNOSTIC_EVENT_REGISTRY).length,
|
||||
checkedFiles: sources.length,
|
||||
failures,
|
||||
passed: failures.length === 0,
|
||||
};
|
||||
await mkdir("artifacts/quality", { recursive: true });
|
||||
await writeFile(
|
||||
fixtureMode
|
||||
? "artifacts/quality/diagnostics-fixture.json"
|
||||
: "artifacts/quality/diagnostics.json",
|
||||
`${JSON.stringify(report, null, 2)}\n`,
|
||||
);
|
||||
if (failures.length > 0) {
|
||||
process.stderr.write(
|
||||
`Diagnostics contract failed:\n${failures.join("\n")}\n`,
|
||||
);
|
||||
process.exit(1);
|
||||
}
|
||||
process.stdout.write(
|
||||
`Diagnostics contract: ${report.diagnosticEventCount} diagnostics and ${report.telemetryEventCount} telemetry producers PASS\n`,
|
||||
);
|
||||
+243
-56
@@ -1,28 +1,65 @@
|
||||
import { access, mkdir, readFile, writeFile } from "node:fs/promises";
|
||||
import {
|
||||
access,
|
||||
mkdir,
|
||||
readFile,
|
||||
readdir,
|
||||
writeFile,
|
||||
} from "node:fs/promises";
|
||||
import path from "node:path";
|
||||
import { pathToFileURL } from "node:url";
|
||||
|
||||
/** @param {string} name @param {string} fallback */
|
||||
import {
|
||||
canonicalizeRegistryValue,
|
||||
diffRegistrySnapshots,
|
||||
registrySnapshotDigest,
|
||||
validateBreakingEvidence,
|
||||
verifyRegistryBaselineApproval,
|
||||
} from "./lib/registry-compatibility.mjs";
|
||||
|
||||
/** @param {string} name @param {string | undefined} fallback */
|
||||
function argumentValue(name, fallback) {
|
||||
const index = process.argv.indexOf(name);
|
||||
return index >= 0 && process.argv[index + 1] ? process.argv[index + 1] : fallback;
|
||||
return index >= 0 && process.argv[index + 1]
|
||||
? process.argv[index + 1]
|
||||
: fallback;
|
||||
}
|
||||
|
||||
const governancePath = argumentValue(
|
||||
"--governance",
|
||||
"config/contracts/registry-governance.json",
|
||||
const defaultGovernancePath = "config/contracts/registry-governance.json";
|
||||
const governancePath =
|
||||
/** @type {string} */ (
|
||||
argumentValue("--governance", defaultGovernancePath)
|
||||
);
|
||||
const artifactPath =
|
||||
/** @type {string} */ (
|
||||
argumentValue("--artifact", "artifacts/quality/registries.json")
|
||||
);
|
||||
const usesRepositoryBaseline =
|
||||
governancePath === defaultGovernancePath &&
|
||||
!process.argv.includes("--no-baseline");
|
||||
const baselinePath = argumentValue(
|
||||
"--baseline",
|
||||
usesRepositoryBaseline
|
||||
? "config/contracts/registry-baseline.json"
|
||||
: undefined,
|
||||
);
|
||||
const artifactPath = argumentValue(
|
||||
"--artifact",
|
||||
"artifacts/quality/registries.json",
|
||||
const approvalPath = argumentValue(
|
||||
"--approval",
|
||||
usesRepositoryBaseline
|
||||
? "config/contracts/registry-baseline.approval.json"
|
||||
: undefined,
|
||||
);
|
||||
const governance = JSON.parse(
|
||||
await readFile(governancePath, "utf8"),
|
||||
const evidencePath = argumentValue(
|
||||
"--compatibility-evidence",
|
||||
usesRepositoryBaseline
|
||||
? "config/contracts/registry-change-evidence.json"
|
||||
: undefined,
|
||||
);
|
||||
const governance = JSON.parse(await readFile(governancePath, "utf8"));
|
||||
const failures = [];
|
||||
const owners = new Map();
|
||||
const snapshots = [];
|
||||
const rowsByRegistry = new Map();
|
||||
const sourcesByRegistry = new Map();
|
||||
const registryExtensions = [".js", ".jsx", ".mjs", ".ts", ".tsx", ".mts"];
|
||||
|
||||
/** @param {string} declaredPath */
|
||||
@@ -38,7 +75,7 @@ async function resolveRegistrySource(declaredPath) {
|
||||
await access(candidate);
|
||||
candidates.push(candidate);
|
||||
} catch {
|
||||
// A migration may legitimately replace the declared extension.
|
||||
// A TypeScript migration may replace the declared extension.
|
||||
}
|
||||
}
|
||||
if (candidates.length > 1) {
|
||||
@@ -50,6 +87,44 @@ async function resolveRegistrySource(declaredPath) {
|
||||
return candidates[0] ?? null;
|
||||
}
|
||||
|
||||
/** @param {unknown} value */
|
||||
function runtimeType(value) {
|
||||
if (value === null) return "null";
|
||||
if (Array.isArray(value)) return "array";
|
||||
if (Number.isInteger(value)) return "integer";
|
||||
return typeof value;
|
||||
}
|
||||
|
||||
/** @param {unknown} value @param {string} declaration */
|
||||
function matchesDeclaredType(value, declaration) {
|
||||
const actual = runtimeType(value);
|
||||
return declaration
|
||||
.split("|")
|
||||
.some(
|
||||
(candidate) =>
|
||||
candidate === actual ||
|
||||
(candidate === "number" && actual === "integer"),
|
||||
);
|
||||
}
|
||||
|
||||
/** @param {string} directory @returns {Promise<string[]>} */
|
||||
async function filesBelow(directory) {
|
||||
try {
|
||||
const entries = await readdir(directory, { withFileTypes: true });
|
||||
const groups = await Promise.all(
|
||||
entries.map((entry) => {
|
||||
const target = path.join(directory, entry.name);
|
||||
return entry.isDirectory() ? filesBelow(target) : [target];
|
||||
}),
|
||||
);
|
||||
return groups.flat().filter((file) =>
|
||||
/\.(?:js|jsx|mjs|ts|tsx|mts)$/.test(file),
|
||||
);
|
||||
} catch {
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
for (const specification of governance.registries) {
|
||||
if (owners.has(specification.registryId)) {
|
||||
failures.push(`duplicate owner for ${specification.registryId}`);
|
||||
@@ -74,6 +149,10 @@ for (const specification of governance.registries) {
|
||||
}
|
||||
|
||||
rowsByRegistry.set(specification.registryId, rows);
|
||||
sourcesByRegistry.set(
|
||||
specification.registryId,
|
||||
sourcePath ?? specification.path,
|
||||
);
|
||||
|
||||
for (const [rowName, row] of Object.entries(rows)) {
|
||||
if (!row || typeof row !== "object" || Array.isArray(row)) {
|
||||
@@ -85,6 +164,26 @@ for (const specification of governance.registries) {
|
||||
failures.push(`${specification.registryId}.${rowName} missing ${field}`);
|
||||
}
|
||||
}
|
||||
for (const [field, declaredType] of Object.entries(
|
||||
specification.fieldTypes ?? {},
|
||||
)) {
|
||||
if (
|
||||
field in row &&
|
||||
!matchesDeclaredType(row[field], String(declaredType))
|
||||
) {
|
||||
failures.push(
|
||||
`${specification.registryId}.${rowName}.${field} expected ${declaredType}, received ${runtimeType(row[field])}`,
|
||||
);
|
||||
}
|
||||
}
|
||||
if (
|
||||
specification.keyField &&
|
||||
row[specification.keyField] !== rowName
|
||||
) {
|
||||
failures.push(
|
||||
`${specification.registryId}.${rowName}.${specification.keyField} must match its registry key`,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
for (const field of specification.uniqueFields ?? []) {
|
||||
@@ -93,12 +192,13 @@ for (const specification of governance.registries) {
|
||||
if (!row || typeof row !== "object" || Array.isArray(row)) continue;
|
||||
const value = row[field];
|
||||
if (value === undefined) continue;
|
||||
if (values.has(value)) {
|
||||
const identity = JSON.stringify(canonicalizeRegistryValue(value));
|
||||
if (values.has(identity)) {
|
||||
failures.push(
|
||||
`${specification.registryId}.${rowName} duplicates ${field}=${String(value)} from ${values.get(value)}`,
|
||||
`${specification.registryId}.${rowName} duplicates ${field}=${String(value)} from ${values.get(identity)}`,
|
||||
);
|
||||
} else {
|
||||
values.set(value, rowName);
|
||||
values.set(identity, rowName);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -121,12 +221,22 @@ for (const specification of governance.registries) {
|
||||
}
|
||||
}
|
||||
|
||||
const contract = Object.freeze({
|
||||
requiredFields: specification.requiredFields,
|
||||
fieldTypes: specification.fieldTypes ?? {},
|
||||
uniqueFields: specification.uniqueFields ?? [],
|
||||
allowedValues: specification.allowedValues ?? {},
|
||||
references: specification.references ?? [],
|
||||
keyField: specification.keyField ?? null,
|
||||
breakingFields: specification.breakingFields ?? [],
|
||||
});
|
||||
snapshots.push({
|
||||
registryId: specification.registryId,
|
||||
owner: specification.owner,
|
||||
source: sourcePath ?? specification.path,
|
||||
rowCount: Object.keys(rows).length,
|
||||
rows,
|
||||
contract,
|
||||
rows: canonicalizeRegistryValue(rows),
|
||||
});
|
||||
}
|
||||
|
||||
@@ -145,18 +255,74 @@ for (const specification of governance.registries) {
|
||||
Object.values(targetRows)
|
||||
.filter((row) => row && typeof row === "object" && !Array.isArray(row))
|
||||
.map((row) => row[reference.targetField])
|
||||
.filter((value) => value !== undefined),
|
||||
.filter((value) => value !== undefined && value !== null),
|
||||
);
|
||||
for (const [rowName, row] of Object.entries(rows)) {
|
||||
if (!row || typeof row !== "object" || Array.isArray(row)) continue;
|
||||
const value = row[reference.field];
|
||||
if (value !== undefined && !targetValues.has(value)) {
|
||||
if (
|
||||
value !== undefined &&
|
||||
value !== null &&
|
||||
!targetValues.has(value)
|
||||
) {
|
||||
failures.push(
|
||||
`${specification.registryId}.${rowName}.${reference.field} references unknown ${reference.registryId}.${reference.targetField}=${String(value)}`,
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
for (const consumer of specification.consumers ?? []) {
|
||||
try {
|
||||
const source = await readFile(consumer.path, "utf8");
|
||||
if (!source.includes(consumer.token)) {
|
||||
failures.push(
|
||||
`${specification.registryId} consumer ${consumer.path} is missing ${consumer.token}`,
|
||||
);
|
||||
}
|
||||
} catch {
|
||||
failures.push(
|
||||
`${specification.registryId} consumer source is missing: ${consumer.path}`,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
if (specification.consumerIdentityField) {
|
||||
const consumerFiles = (
|
||||
await Promise.all(
|
||||
(specification.consumerDirectories ?? []).map(filesBelow),
|
||||
)
|
||||
).flat();
|
||||
const sourcePath = sourcesByRegistry.get(specification.registryId);
|
||||
const consumerText = (
|
||||
await Promise.all(
|
||||
consumerFiles
|
||||
.filter((file) => file !== sourcePath)
|
||||
.map((file) => readFile(file, "utf8")),
|
||||
)
|
||||
).join("\n");
|
||||
const exemptions = new Set(specification.orphanExemptRows ?? []);
|
||||
for (const [rowName, row] of Object.entries(rows)) {
|
||||
if (
|
||||
!row ||
|
||||
typeof row !== "object" ||
|
||||
Array.isArray(row) ||
|
||||
exemptions.has(rowName)
|
||||
) {
|
||||
continue;
|
||||
}
|
||||
const identity = row[specification.consumerIdentityField];
|
||||
if (
|
||||
(typeof identity !== "string" &&
|
||||
typeof identity !== "number") ||
|
||||
!consumerText.includes(String(identity))
|
||||
) {
|
||||
failures.push(
|
||||
`${specification.registryId}.${rowName} has no executable consumer for ${specification.consumerIdentityField}=${String(identity)}`,
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const sourceFiles = governance.sourceDirectories ?? [
|
||||
@@ -166,59 +332,80 @@ const sourceFiles = governance.sourceDirectories ?? [
|
||||
];
|
||||
const adHocPatterns = [
|
||||
{ name: "direct fetch", expression: /\bfetch\s*\(/ },
|
||||
{ name: "direct localStorage", expression: /\blocalStorage\.(?:get|set|remove)Item/ },
|
||||
{
|
||||
name: "direct localStorage",
|
||||
expression: /\blocalStorage\.(?:get|set|remove)Item/,
|
||||
},
|
||||
{ name: "direct import.meta.env", expression: /\bimport\.meta\.env\./ },
|
||||
{ name: "raw API path", expression: /["']\/api\// },
|
||||
];
|
||||
|
||||
/** @param {string} directory */
|
||||
async function scanDirectory(directory) {
|
||||
try {
|
||||
await access(directory);
|
||||
} catch {
|
||||
return;
|
||||
}
|
||||
const entries = await import("node:fs/promises").then(({ readdir }) =>
|
||||
readdir(directory, { withFileTypes: true }),
|
||||
);
|
||||
for (const entry of entries) {
|
||||
const target = path.join(directory, entry.name);
|
||||
if (entry.isDirectory()) {
|
||||
await scanDirectory(target);
|
||||
continue;
|
||||
}
|
||||
if (!/\.(js|jsx|mjs|ts|tsx|mts)$/.test(entry.name)) continue;
|
||||
const content = await readFile(target, "utf8");
|
||||
for (const sourceDirectory of sourceFiles) {
|
||||
for (const file of await filesBelow(sourceDirectory)) {
|
||||
const content = await readFile(file, "utf8");
|
||||
for (const pattern of adHocPatterns) {
|
||||
if (pattern.expression.test(content)) {
|
||||
failures.push(`ad-hoc ${pattern.name} in ${target}`);
|
||||
failures.push(`ad-hoc ${pattern.name} in ${file}`);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
for (const sourceDirectory of sourceFiles) {
|
||||
await scanDirectory(sourceDirectory);
|
||||
const currentSnapshot =
|
||||
/** @type {Readonly<Record<string, unknown>>} */ (
|
||||
canonicalizeRegistryValue({
|
||||
schemaVersion: 2,
|
||||
registries: snapshots,
|
||||
})
|
||||
);
|
||||
let baselineDigest = null;
|
||||
let currentDigest = registrySnapshotDigest(currentSnapshot);
|
||||
let compatibility =
|
||||
/** @type {{impact: string, changes: readonly Record<string, unknown>[]}} */ ({
|
||||
impact: "not-evaluated",
|
||||
changes: [],
|
||||
});
|
||||
|
||||
if (baselinePath && approvalPath && evidencePath) {
|
||||
try {
|
||||
const baseline = JSON.parse(await readFile(baselinePath, "utf8"));
|
||||
const approval = JSON.parse(await readFile(approvalPath, "utf8"));
|
||||
const approvalResult = verifyRegistryBaselineApproval(baseline, approval);
|
||||
baselineDigest = approvalResult.actualDigest;
|
||||
if (!approvalResult.passed) {
|
||||
failures.push(
|
||||
`registry baseline approval digest mismatch: approved=${approvalResult.approvedDigest} actual=${approvalResult.actualDigest}`,
|
||||
);
|
||||
}
|
||||
compatibility = diffRegistrySnapshots(baseline, currentSnapshot);
|
||||
const evidence = JSON.parse(await readFile(evidencePath, "utf8"));
|
||||
const evidenceResult = validateBreakingEvidence(compatibility, evidence);
|
||||
failures.push(...evidenceResult.failures);
|
||||
} catch (error) {
|
||||
failures.push(
|
||||
`registry compatibility evidence unavailable: ${
|
||||
error instanceof Error ? error.name : "unknown"
|
||||
}`,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
await mkdir("artifacts/quality", { recursive: true });
|
||||
await writeFile(
|
||||
artifactPath,
|
||||
`${JSON.stringify(
|
||||
{
|
||||
schemaVersion: 1,
|
||||
generatedAt: new Date().toISOString(),
|
||||
compatibilityImpact: governance.compatibilityImpact.current,
|
||||
failures,
|
||||
registries: snapshots,
|
||||
},
|
||||
null,
|
||||
2,
|
||||
)}\n`,
|
||||
);
|
||||
const report = {
|
||||
schemaVersion: 2,
|
||||
generatedAt: new Date().toISOString(),
|
||||
baselineDigest,
|
||||
currentDigest,
|
||||
compatibility,
|
||||
failures,
|
||||
registries: snapshots,
|
||||
};
|
||||
await mkdir(path.dirname(artifactPath), { recursive: true });
|
||||
await writeFile(artifactPath, `${JSON.stringify(report, null, 2)}\n`);
|
||||
|
||||
if (failures.length > 0) {
|
||||
process.stderr.write(`Registry governance failed:\n${failures.join("\n")}\n`);
|
||||
process.exit(1);
|
||||
}
|
||||
process.stdout.write(`Registry governance: ${snapshots.length} registries PASS\n`);
|
||||
process.stdout.write(
|
||||
`Registry governance: ${snapshots.length} registries PASS; compatibility=${compatibility.impact}\n`,
|
||||
);
|
||||
|
||||
@@ -0,0 +1,63 @@
|
||||
import { mkdir, readFile, writeFile } from "node:fs/promises";
|
||||
|
||||
import {
|
||||
diffRegistrySnapshots,
|
||||
validateBreakingEvidence,
|
||||
verifyRegistryBaselineApproval,
|
||||
} from "./lib/registry-compatibility.mjs";
|
||||
|
||||
const fixtures = JSON.parse(
|
||||
await readFile(
|
||||
"tests/fixtures/registry/compatibility/semantic-diff.json",
|
||||
"utf8",
|
||||
),
|
||||
);
|
||||
const results = [];
|
||||
for (const fixture of fixtures.cases) {
|
||||
const actual = diffRegistrySnapshots(fixture.before, fixture.after);
|
||||
results.push({
|
||||
id: fixture.id,
|
||||
expected: fixture.expected,
|
||||
actual: actual.impact,
|
||||
passed: actual.impact === fixture.expected,
|
||||
});
|
||||
}
|
||||
|
||||
const breaking = diffRegistrySnapshots(
|
||||
fixtures.breakingEvidence.before,
|
||||
fixtures.breakingEvidence.after,
|
||||
);
|
||||
const missingEvidence = validateBreakingEvidence(breaking, {
|
||||
schemaVersion: 1,
|
||||
changes: [],
|
||||
});
|
||||
results.push({
|
||||
id: "breaking-evidence-required",
|
||||
expected: false,
|
||||
actual: missingEvidence.passed,
|
||||
passed: !missingEvidence.passed,
|
||||
});
|
||||
|
||||
const tamperedApproval = verifyRegistryBaselineApproval(
|
||||
fixtures.tamperedApproval.snapshot,
|
||||
fixtures.tamperedApproval.approval,
|
||||
);
|
||||
results.push({
|
||||
id: "tampered-baseline-digest",
|
||||
expected: false,
|
||||
actual: tamperedApproval.passed,
|
||||
passed: !tamperedApproval.passed,
|
||||
});
|
||||
|
||||
await mkdir("artifacts/quality", { recursive: true });
|
||||
await writeFile(
|
||||
"artifacts/quality/registry-compatibility-fixtures.json",
|
||||
`${JSON.stringify({ schemaVersion: 1, results }, null, 2)}\n`,
|
||||
);
|
||||
if (results.some((result) => !result.passed)) {
|
||||
process.stderr.write("Registry compatibility fixture failed.\n");
|
||||
process.exit(1);
|
||||
}
|
||||
process.stdout.write(
|
||||
`Registry compatibility fixtures: ${results.length} PASS\n`,
|
||||
);
|
||||
@@ -0,0 +1,88 @@
|
||||
import { mkdir, readFile, writeFile } from "node:fs/promises";
|
||||
import path from "node:path";
|
||||
|
||||
/** @param {string} name @param {string} fallback */
|
||||
function argumentValue(name, fallback) {
|
||||
const index = process.argv.indexOf(name);
|
||||
return index >= 0 && process.argv[index + 1]
|
||||
? process.argv[index + 1]
|
||||
: fallback;
|
||||
}
|
||||
|
||||
const policyPath = argumentValue(
|
||||
"--policy",
|
||||
"config/testing/risk-coverage.json",
|
||||
);
|
||||
const summaryPath = argumentValue(
|
||||
"--summary",
|
||||
"artifacts/tests/coverage/coverage-summary.json",
|
||||
);
|
||||
const artifactPath = argumentValue(
|
||||
"--artifact",
|
||||
"artifacts/quality/risk-coverage.json",
|
||||
);
|
||||
const policy = JSON.parse(await readFile(policyPath, "utf8"));
|
||||
const summary = JSON.parse(await readFile(summaryPath, "utf8"));
|
||||
const failures = [];
|
||||
/** @type {Array<{
|
||||
* scope: string,
|
||||
* metric: string,
|
||||
* threshold: number,
|
||||
* received: number | undefined,
|
||||
* passed: boolean
|
||||
* }>} */
|
||||
const results = [];
|
||||
|
||||
/**
|
||||
* @param {string} scope
|
||||
* @param {Record<string, {pct: number}>} actual
|
||||
* @param {Record<string, number>} minimum
|
||||
*/
|
||||
function evaluate(scope, actual, minimum) {
|
||||
for (const [metric, threshold] of Object.entries(minimum)) {
|
||||
const received = actual?.[metric]?.pct;
|
||||
const passed =
|
||||
typeof received === "number" &&
|
||||
Number.isFinite(received) &&
|
||||
received >= threshold;
|
||||
results.push({ scope, metric, threshold, received, passed });
|
||||
if (!passed) {
|
||||
failures.push(
|
||||
`${scope}.${metric} expected >= ${threshold}, received ${String(received)}`,
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
evaluate("total", summary.total, policy.summary);
|
||||
for (const modulePolicy of policy.criticalModules) {
|
||||
const key = Object.keys(summary).find(
|
||||
(candidate) =>
|
||||
candidate !== "total" &&
|
||||
candidate.replaceAll("\\", "/").endsWith(`/${modulePolicy.path}`),
|
||||
);
|
||||
if (!key) {
|
||||
failures.push(`critical module missing from coverage: ${modulePolicy.path}`);
|
||||
continue;
|
||||
}
|
||||
evaluate(modulePolicy.path, summary[key], modulePolicy.minimum);
|
||||
}
|
||||
|
||||
const artifact = {
|
||||
schemaVersion: 1,
|
||||
policy: policyPath,
|
||||
summary: summaryPath,
|
||||
status: failures.length === 0 ? "PASS" : "FAIL",
|
||||
results,
|
||||
failures,
|
||||
};
|
||||
await mkdir(path.dirname(artifactPath), { recursive: true });
|
||||
await writeFile(artifactPath, `${JSON.stringify(artifact, null, 2)}\n`);
|
||||
|
||||
if (failures.length > 0) {
|
||||
process.stderr.write(`Risk coverage failed:\n- ${failures.join("\n- ")}\n`);
|
||||
process.exit(1);
|
||||
}
|
||||
process.stdout.write(
|
||||
`Risk coverage: PASS (${results.length} scoped thresholds)\n`,
|
||||
);
|
||||
@@ -0,0 +1,167 @@
|
||||
import { mkdir, readFile, readdir, stat, writeFile } from "node:fs/promises";
|
||||
import path from "node:path";
|
||||
|
||||
/** @param {string} name @param {string} fallback */
|
||||
function argumentValue(name, fallback) {
|
||||
const index = process.argv.indexOf(name);
|
||||
return index >= 0 && process.argv[index + 1]
|
||||
? process.argv[index + 1]
|
||||
: fallback;
|
||||
}
|
||||
|
||||
const sourceRoot = argumentValue("--source-root", "tests");
|
||||
const artifactPath = argumentValue(
|
||||
"--artifact",
|
||||
"artifacts/quality/test-evidence.json",
|
||||
);
|
||||
const fixtureMode = sourceRoot !== "tests";
|
||||
const failures = [];
|
||||
const facts = {
|
||||
scannedFiles: 0,
|
||||
visualBaselines: 0,
|
||||
sharedScenarios: 0,
|
||||
};
|
||||
|
||||
/** @param {string} target @returns {Promise<string[]>} */
|
||||
async function filesBelow(target) {
|
||||
try {
|
||||
const metadata = await stat(target);
|
||||
if (metadata.isFile()) return [target];
|
||||
const entries = await readdir(target, { withFileTypes: true });
|
||||
const groups = await Promise.all(
|
||||
entries.map((entry) => filesBelow(path.join(target, entry.name))),
|
||||
);
|
||||
return groups.flat();
|
||||
} catch {
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
const sourceFiles = (await filesBelow(sourceRoot)).filter(
|
||||
(file) => fixtureMode || !file.split(path.sep).includes("fixtures"),
|
||||
);
|
||||
for (const file of sourceFiles) {
|
||||
if (!/\.(?:js|jsx|mjs|ts|tsx|fixture|txt)$/.test(file)) continue;
|
||||
const source = await readFile(file, "utf8");
|
||||
facts.scannedFiles += 1;
|
||||
const skipPattern =
|
||||
/\b(?:test|it|describe)(?:\.describe)?\.(?:skip|fixme)\s*\(/g;
|
||||
if (skipPattern.test(source)) {
|
||||
const quarantine =
|
||||
/quarantine\(owner=[^)]+,\s*defect=[^)]+,\s*expires=\d{4}-\d{2}-\d{2}\)/;
|
||||
if (!quarantine.test(source)) {
|
||||
failures.push(`${file}: skip/fixme lacks owned expiring quarantine`);
|
||||
}
|
||||
}
|
||||
const wholeUiMask =
|
||||
/\bmask\s*:\s*\[[\s\S]{0,240}(?:locator|getByRole)\s*\(\s*["'](?:html|body|main|application|document)["']/i;
|
||||
if (wholeUiMask.test(source)) {
|
||||
failures.push(`${file}: screenshot mask may not cover the whole UI`);
|
||||
}
|
||||
}
|
||||
|
||||
if (!fixtureMode) {
|
||||
const e2eConfig = await readFile("playwright.config.js", "utf8");
|
||||
for (const token of [
|
||||
"pnpm build",
|
||||
"pnpm preview",
|
||||
"reuseExistingServer: false",
|
||||
'"junit"',
|
||||
'trace: "retain-on-failure"',
|
||||
'"chromium-compact"',
|
||||
'"firefox"',
|
||||
'"webkit"',
|
||||
]) {
|
||||
if (!e2eConfig.includes(token)) {
|
||||
failures.push(`playwright.config.js missing release evidence token ${token}`);
|
||||
}
|
||||
}
|
||||
|
||||
const e2eFiles = (await filesBelow("tests/e2e")).filter((file) =>
|
||||
/\.spec\.(?:js|ts)$/.test(file),
|
||||
);
|
||||
for (const file of e2eFiles) {
|
||||
const source = await readFile(file, "utf8");
|
||||
if (!source.includes("support/browser/strict-browser-test")) {
|
||||
failures.push(`${file}: bypasses strict browser fixture`);
|
||||
}
|
||||
}
|
||||
|
||||
const scenarioCatalog = await readFile(
|
||||
"tests/mocks/scenarios/catalog.ts",
|
||||
"utf8",
|
||||
);
|
||||
const scenarioIdBlock =
|
||||
scenarioCatalog.match(
|
||||
/HTTP_SCENARIO_IDS\s*=\s*Object\.freeze\(\[([\s\S]*?)\]\s*as const\)/,
|
||||
)?.[1] ?? "";
|
||||
facts.sharedScenarios = (scenarioIdBlock.match(/"[^"]+"/g) ?? []).length;
|
||||
if (facts.sharedScenarios < 19) {
|
||||
failures.push("shared MSW catalog must retain all 19 failure scenarios");
|
||||
}
|
||||
const handler = await readFile(
|
||||
"tests/mocks/handlers/reference-resources.ts",
|
||||
"utf8",
|
||||
);
|
||||
if (
|
||||
!handler.includes("assertOperationScenario") ||
|
||||
!handler.includes("../scenarios/catalog.js")
|
||||
) {
|
||||
failures.push("MSW handler bypasses shared scenario catalog");
|
||||
}
|
||||
|
||||
const baselineFiles = (await filesBelow("tests/visual/__snapshots__")).filter(
|
||||
(file) => file.endsWith(".png"),
|
||||
);
|
||||
facts.visualBaselines = baselineFiles.length;
|
||||
if (facts.visualBaselines < 4) {
|
||||
failures.push("visual baseline requires at least four risk surfaces");
|
||||
}
|
||||
for (const required of [
|
||||
"playwright.storybook.config.js",
|
||||
"playwright.visual.config.js",
|
||||
"tests/storybook/workshop.spec.ts",
|
||||
"artifacts/tests/storybook/results.xml",
|
||||
"artifacts/tests/visual/results.xml",
|
||||
]) {
|
||||
if ((await filesBelow(required)).length === 0) {
|
||||
failures.push(`test evidence missing ${required}`);
|
||||
}
|
||||
}
|
||||
|
||||
const requiredBuiltFiles = [
|
||||
"dist/index.html",
|
||||
"dist/config.json",
|
||||
"dist/release-manifest.json",
|
||||
"dist/runtime-config.schema.json",
|
||||
"dist/.vite/manifest.json",
|
||||
];
|
||||
for (const required of requiredBuiltFiles) {
|
||||
if ((await filesBelow(required)).length === 0) {
|
||||
failures.push(`built-dist contract missing ${required}`);
|
||||
}
|
||||
}
|
||||
const sourceMaps = (await filesBelow("dist")).filter((file) =>
|
||||
file.endsWith(".map"),
|
||||
);
|
||||
if (sourceMaps.length > 0) {
|
||||
failures.push(`production dist contains source maps: ${sourceMaps.join(", ")}`);
|
||||
}
|
||||
}
|
||||
|
||||
const report = {
|
||||
schemaVersion: 1,
|
||||
sourceRoot,
|
||||
status: failures.length === 0 ? "PASS" : "FAIL",
|
||||
facts,
|
||||
failures,
|
||||
};
|
||||
await mkdir(path.dirname(artifactPath), { recursive: true });
|
||||
await writeFile(artifactPath, `${JSON.stringify(report, null, 2)}\n`);
|
||||
if (failures.length > 0) {
|
||||
process.stderr.write(`Test evidence failed:\n- ${failures.join("\n- ")}\n`);
|
||||
process.exit(1);
|
||||
}
|
||||
process.stdout.write(
|
||||
`Test evidence: PASS (${facts.scannedFiles} files, ${facts.visualBaselines} baselines, ${facts.sharedScenarios} scenarios)\n`,
|
||||
);
|
||||
@@ -0,0 +1,321 @@
|
||||
import { createHash } from "node:crypto";
|
||||
|
||||
export const COMPATIBILITY_IMPACTS = Object.freeze([
|
||||
"none",
|
||||
"additive",
|
||||
"behavior-change",
|
||||
"breaking",
|
||||
]);
|
||||
|
||||
const impactRank = new Map(
|
||||
COMPATIBILITY_IMPACTS.map((impact, index) => [impact, index]),
|
||||
);
|
||||
|
||||
/** @param {unknown} value @returns {unknown} */
|
||||
export function canonicalizeRegistryValue(value) {
|
||||
if (Array.isArray(value)) {
|
||||
const projected =
|
||||
/** @type {unknown[]} */ (value.map(canonicalizeRegistryValue));
|
||||
return projected.every(
|
||||
(item) =>
|
||||
item === null ||
|
||||
["string", "number", "boolean"].includes(typeof item),
|
||||
)
|
||||
? projected.sort((left, right) =>
|
||||
JSON.stringify(left).localeCompare(JSON.stringify(right)),
|
||||
)
|
||||
: projected;
|
||||
}
|
||||
if (value && typeof value === "object") {
|
||||
return Object.fromEntries(
|
||||
Object.entries(value)
|
||||
.sort(([left], [right]) => left.localeCompare(right))
|
||||
.map(([key, item]) => [key, canonicalizeRegistryValue(item)]),
|
||||
);
|
||||
}
|
||||
return value;
|
||||
}
|
||||
|
||||
/** @param {unknown} value @returns {string} */
|
||||
export function canonicalRegistryJson(value) {
|
||||
return JSON.stringify(canonicalizeRegistryValue(value)) ?? "undefined";
|
||||
}
|
||||
|
||||
/** @param {unknown} snapshot */
|
||||
export function registrySnapshotDigest(snapshot) {
|
||||
return createHash("sha256")
|
||||
.update(canonicalRegistryJson(snapshot))
|
||||
.digest("hex");
|
||||
}
|
||||
|
||||
/** @param {string} current @param {string} candidate */
|
||||
function strongestImpact(current, candidate) {
|
||||
return (impactRank.get(candidate) ?? 0) > (impactRank.get(current) ?? 0)
|
||||
? candidate
|
||||
: current;
|
||||
}
|
||||
|
||||
/** @param {unknown} value */
|
||||
function valueType(value) {
|
||||
if (value === null) return "null";
|
||||
if (Array.isArray(value)) return "array";
|
||||
return typeof value;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {string} registryId
|
||||
* @param {string} rowName
|
||||
* @param {string} field
|
||||
* @param {string} kind
|
||||
*/
|
||||
function changeId(registryId, rowName, field, kind) {
|
||||
return `${registryId}:${rowName}:${field}:${kind}`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Calculates a semantic diff. Object key and primitive-array ordering is
|
||||
* canonicalized before comparison and therefore cannot create a false change.
|
||||
*
|
||||
* @param {Readonly<Record<string, unknown>>} before
|
||||
* @param {Readonly<Record<string, unknown>>} after
|
||||
*/
|
||||
export function diffRegistrySnapshots(before, after) {
|
||||
const changes = /** @type {Array<Record<string, unknown>>} */ ([]);
|
||||
let impact = "none";
|
||||
const beforeRegistries =
|
||||
/** @type {Map<string, Record<string, unknown>>} */ (new Map(
|
||||
/** @type {Array<Record<string, unknown>>} */ (before.registries ?? []).map(
|
||||
(registry) => [String(registry.registryId), registry],
|
||||
),
|
||||
));
|
||||
const afterRegistries =
|
||||
/** @type {Map<string, Record<string, unknown>>} */ (new Map(
|
||||
/** @type {Array<Record<string, unknown>>} */ (after.registries ?? []).map(
|
||||
(registry) => [String(registry.registryId), registry],
|
||||
),
|
||||
));
|
||||
const registryIds = new Set([
|
||||
...beforeRegistries.keys(),
|
||||
...afterRegistries.keys(),
|
||||
]);
|
||||
|
||||
for (const registryId of [...registryIds].sort()) {
|
||||
const previous = beforeRegistries.get(registryId);
|
||||
const current = afterRegistries.get(registryId);
|
||||
if (!previous || !current) {
|
||||
const changeImpact = previous ? "breaking" : "additive";
|
||||
impact = strongestImpact(impact, changeImpact);
|
||||
changes.push({
|
||||
changeId: changeId(registryId, "*", "*", previous ? "removed" : "added"),
|
||||
registryId,
|
||||
rowName: "*",
|
||||
field: "*",
|
||||
kind: previous ? "registry-removed" : "registry-added",
|
||||
impact: changeImpact,
|
||||
});
|
||||
continue;
|
||||
}
|
||||
|
||||
const previousContract =
|
||||
/** @type {Record<string, unknown>} */ (previous.contract ?? {});
|
||||
const currentContract =
|
||||
/** @type {Record<string, unknown>} */ (current.contract ?? {});
|
||||
const contractFields = new Set([
|
||||
...Object.keys(previousContract),
|
||||
...Object.keys(currentContract),
|
||||
]);
|
||||
for (const field of [...contractFields].sort()) {
|
||||
const beforeHas = Object.hasOwn(previousContract, field);
|
||||
const afterHas = Object.hasOwn(currentContract, field);
|
||||
const beforeValue = previousContract[field];
|
||||
const afterValue = currentContract[field];
|
||||
if (
|
||||
beforeHas &&
|
||||
afterHas &&
|
||||
canonicalRegistryJson(beforeValue) ===
|
||||
canonicalRegistryJson(afterValue)
|
||||
) {
|
||||
continue;
|
||||
}
|
||||
const kind = !beforeHas
|
||||
? "contract-field-added"
|
||||
: !afterHas
|
||||
? "contract-field-removed"
|
||||
: "contract-field-changed";
|
||||
impact = strongestImpact(impact, "breaking");
|
||||
changes.push({
|
||||
changeId: changeId(registryId, "$contract", field, kind),
|
||||
registryId,
|
||||
rowName: "$contract",
|
||||
field,
|
||||
kind,
|
||||
impact: "breaking",
|
||||
before: canonicalizeRegistryValue(beforeValue),
|
||||
after: canonicalizeRegistryValue(afterValue),
|
||||
});
|
||||
}
|
||||
|
||||
const breakingFields = new Set(
|
||||
/** @type {string[]} */ (
|
||||
currentContract.breakingFields ?? []
|
||||
),
|
||||
);
|
||||
const beforeRows =
|
||||
/** @type {Record<string, Record<string, unknown>>} */ (
|
||||
previous.rows ?? {}
|
||||
);
|
||||
const afterRows =
|
||||
/** @type {Record<string, Record<string, unknown>>} */ (current.rows ?? {});
|
||||
const rowNames = new Set([
|
||||
...Object.keys(beforeRows),
|
||||
...Object.keys(afterRows),
|
||||
]);
|
||||
for (const rowName of [...rowNames].sort()) {
|
||||
const beforeRow = beforeRows[rowName];
|
||||
const afterRow = afterRows[rowName];
|
||||
if (!beforeRow || !afterRow) {
|
||||
const changeImpact = beforeRow ? "breaking" : "additive";
|
||||
impact = strongestImpact(impact, changeImpact);
|
||||
changes.push({
|
||||
changeId: changeId(
|
||||
registryId,
|
||||
rowName,
|
||||
"*",
|
||||
beforeRow ? "removed" : "added",
|
||||
),
|
||||
registryId,
|
||||
rowName,
|
||||
field: "*",
|
||||
kind: beforeRow ? "row-removed" : "row-added",
|
||||
impact: changeImpact,
|
||||
});
|
||||
continue;
|
||||
}
|
||||
|
||||
const fields = new Set([
|
||||
...Object.keys(beforeRow),
|
||||
...Object.keys(afterRow),
|
||||
]);
|
||||
for (const field of [...fields].sort()) {
|
||||
const beforeHas = Object.hasOwn(beforeRow, field);
|
||||
const afterHas = Object.hasOwn(afterRow, field);
|
||||
const beforeValue = beforeRow[field];
|
||||
const afterValue = afterRow[field];
|
||||
if (
|
||||
beforeHas &&
|
||||
afterHas &&
|
||||
canonicalRegistryJson(beforeValue) ===
|
||||
canonicalRegistryJson(afterValue)
|
||||
) {
|
||||
continue;
|
||||
}
|
||||
let kind;
|
||||
let changeImpact;
|
||||
if (!beforeHas) {
|
||||
kind = "field-added";
|
||||
changeImpact = "additive";
|
||||
} else if (!afterHas) {
|
||||
kind = "field-removed";
|
||||
changeImpact = "breaking";
|
||||
} else if (valueType(beforeValue) !== valueType(afterValue)) {
|
||||
kind = "field-type-changed";
|
||||
changeImpact = "breaking";
|
||||
} else if (
|
||||
Array.isArray(beforeValue) &&
|
||||
Array.isArray(afterValue) &&
|
||||
beforeValue.some(
|
||||
(item) =>
|
||||
!afterValue.some(
|
||||
(candidate) =>
|
||||
canonicalRegistryJson(candidate) ===
|
||||
canonicalRegistryJson(item),
|
||||
),
|
||||
)
|
||||
) {
|
||||
kind = "allowed-value-removed";
|
||||
changeImpact = "breaking";
|
||||
} else {
|
||||
kind = "field-changed";
|
||||
changeImpact = breakingFields.has(field)
|
||||
? "breaking"
|
||||
: "behavior-change";
|
||||
}
|
||||
impact = strongestImpact(impact, changeImpact);
|
||||
changes.push({
|
||||
changeId: changeId(registryId, rowName, field, kind),
|
||||
registryId,
|
||||
rowName,
|
||||
field,
|
||||
kind,
|
||||
impact: changeImpact,
|
||||
before: canonicalizeRegistryValue(beforeValue),
|
||||
after: canonicalizeRegistryValue(afterValue),
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return Object.freeze({
|
||||
impact,
|
||||
changes: Object.freeze(changes),
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {Readonly<Record<string, unknown>>} snapshot
|
||||
* @param {Readonly<Record<string, unknown>>} approval
|
||||
*/
|
||||
export function verifyRegistryBaselineApproval(snapshot, approval) {
|
||||
const actualDigest = registrySnapshotDigest(snapshot);
|
||||
const approvedDigest = approval.snapshotDigest;
|
||||
return Object.freeze({
|
||||
passed:
|
||||
approval.schemaVersion === 1 &&
|
||||
typeof approval.owner === "string" &&
|
||||
approval.owner.length > 0 &&
|
||||
typeof approval.approvedAt === "string" &&
|
||||
approvedDigest === actualDigest,
|
||||
actualDigest,
|
||||
approvedDigest:
|
||||
typeof approvedDigest === "string" ? approvedDigest : "missing",
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {ReturnType<typeof diffRegistrySnapshots>} diff
|
||||
* @param {Readonly<Record<string, unknown>>} evidenceFile
|
||||
*/
|
||||
export function validateBreakingEvidence(diff, evidenceFile) {
|
||||
const evidence = new Map(
|
||||
/** @type {Array<Record<string, unknown>>} */ (
|
||||
evidenceFile.changes ?? []
|
||||
).map((entry) => [entry.changeId, entry]),
|
||||
);
|
||||
const failures = [];
|
||||
for (const change of diff.changes.filter(
|
||||
(entry) => entry.impact === "breaking",
|
||||
)) {
|
||||
const entry = evidence.get(change.changeId);
|
||||
if (!entry) {
|
||||
failures.push(`breaking change missing evidence: ${change.changeId}`);
|
||||
continue;
|
||||
}
|
||||
for (const field of [
|
||||
"versionBump",
|
||||
"migration",
|
||||
"compatibilityWindow",
|
||||
"rollback",
|
||||
"owner",
|
||||
]) {
|
||||
if (typeof entry[field] !== "string" || entry[field].trim().length === 0) {
|
||||
failures.push(
|
||||
`breaking change ${change.changeId} missing non-empty ${field}`,
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
return Object.freeze({
|
||||
passed: failures.length === 0,
|
||||
failures: Object.freeze(failures),
|
||||
});
|
||||
}
|
||||
@@ -0,0 +1,47 @@
|
||||
import { createReadStream } from "node:fs";
|
||||
import { access, stat } from "node:fs/promises";
|
||||
import { createServer } from "node:http";
|
||||
import path from "node:path";
|
||||
|
||||
const root = path.resolve(process.argv[2] ?? "artifacts/storybook/static");
|
||||
const port = Number(process.argv[3] ?? 6006);
|
||||
const contentTypes = /** @type {Readonly<Record<string, string>>} */ ({
|
||||
".css": "text/css; charset=utf-8",
|
||||
".html": "text/html; charset=utf-8",
|
||||
".js": "text/javascript; charset=utf-8",
|
||||
".json": "application/json; charset=utf-8",
|
||||
".svg": "image/svg+xml",
|
||||
".png": "image/png",
|
||||
});
|
||||
|
||||
await access(root);
|
||||
const server = createServer(async (request, response) => {
|
||||
try {
|
||||
const url = new URL(request.url ?? "/", `http://127.0.0.1:${port}`);
|
||||
const decoded = decodeURIComponent(url.pathname);
|
||||
const requested = path.resolve(root, `.${decoded}`);
|
||||
if (requested !== root && !requested.startsWith(`${root}${path.sep}`)) {
|
||||
response.writeHead(403).end();
|
||||
return;
|
||||
}
|
||||
const details = await stat(requested).catch(() => null);
|
||||
const file = details?.isDirectory()
|
||||
? path.join(requested, "index.html")
|
||||
: requested;
|
||||
await access(file);
|
||||
response.writeHead(200, {
|
||||
"Content-Type":
|
||||
contentTypes[path.extname(file)] ?? "application/octet-stream",
|
||||
"Cache-Control": "no-store",
|
||||
});
|
||||
createReadStream(file).pipe(response);
|
||||
} catch {
|
||||
response.writeHead(404).end();
|
||||
}
|
||||
});
|
||||
server.listen(port, "127.0.0.1", () => {
|
||||
process.stdout.write(`Static evidence server: ${root} on ${port}\n`);
|
||||
});
|
||||
for (const signal of ["SIGINT", "SIGTERM"]) {
|
||||
process.on(signal, () => server.close(() => process.exit(0)));
|
||||
}
|
||||
@@ -18,6 +18,7 @@ const featureOwnedPaths = [
|
||||
featureSource,
|
||||
featureTests,
|
||||
"tests/e2e/reference-form.spec.js",
|
||||
"tests/mocks",
|
||||
];
|
||||
const copyTargets = [
|
||||
"src",
|
||||
@@ -41,6 +42,7 @@ const copyTargets = [
|
||||
|
||||
const emptyContracts = `import { PLATFORM_ROUTE_RUNTIME_CONTRACT } from "../contracts/route-runtime-contract.js";
|
||||
import { PLATFORM_ROUTE_REGISTRY } from "../contracts/routes.js";
|
||||
import { PLATFORM_SCHEMA_REGISTRY } from "../contracts/schema-registry.js";
|
||||
|
||||
export const INSTALLED_FEATURE_CONTRACTS =
|
||||
/** @type {readonly unknown[]} */ (Object.freeze([]));
|
||||
@@ -48,6 +50,7 @@ export const ROUTE_REGISTRY = PLATFORM_ROUTE_REGISTRY;
|
||||
export const ROUTE_RUNTIME_CONTRACT = PLATFORM_ROUTE_RUNTIME_CONTRACT;
|
||||
export const API_OPERATIONS = Object.freeze({});
|
||||
export const QUERY_REGISTRY = Object.freeze({});
|
||||
export const SCHEMA_REGISTRY = PLATFORM_SCHEMA_REGISTRY;
|
||||
export const NAVIGATION_ROUTES = Object.freeze(
|
||||
Object.values(ROUTE_REGISTRY)
|
||||
.filter((definition) => definition.navigationOrder !== null)
|
||||
@@ -145,6 +148,39 @@ await writeFile(
|
||||
path.join(fixtureRoot, "src/features/installed-feature-messages.js"),
|
||||
emptyMessages,
|
||||
);
|
||||
const governanceFile = path.join(
|
||||
fixtureRoot,
|
||||
"config/contracts/registry-governance.json",
|
||||
);
|
||||
const removalGovernance = JSON.parse(await readFile(governanceFile, "utf8"));
|
||||
removalGovernance.registries = removalGovernance.registries.map(
|
||||
/** @param {Record<string, unknown>} registry */
|
||||
(registry) => ({
|
||||
...registry,
|
||||
...(Array.isArray(registry.consumers)
|
||||
? {
|
||||
consumers: registry.consumers.filter(
|
||||
/** @param {{path?: string}} consumer */
|
||||
(consumer) =>
|
||||
!consumer.path?.includes("features/reference-feature"),
|
||||
),
|
||||
}
|
||||
: {}),
|
||||
...(Array.isArray(registry.consumerDirectories)
|
||||
? {
|
||||
consumerDirectories: registry.consumerDirectories.filter(
|
||||
/** @param {string} directory */
|
||||
(directory) =>
|
||||
!directory.includes("features/reference-feature"),
|
||||
),
|
||||
}
|
||||
: {}),
|
||||
}),
|
||||
);
|
||||
await writeFile(
|
||||
governanceFile,
|
||||
`${JSON.stringify(removalGovernance, null, 2)}\n`,
|
||||
);
|
||||
|
||||
/** @type {string[]} */
|
||||
const residue = [];
|
||||
@@ -165,7 +201,7 @@ for (const root of ["src", "tests"]) {
|
||||
const checks = [
|
||||
["typecheck", runPnpm("check:types")],
|
||||
["architecture", runPnpm("check:architecture")],
|
||||
["registry", runPnpm("check:registries")],
|
||||
["registry-structure", runPnpm("check:registries:structure")],
|
||||
["unit-integration", runPnpm("test:all")],
|
||||
[
|
||||
"home-smoke",
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
import { mkdir, readFile, writeFile } from "node:fs/promises";
|
||||
import path from "node:path";
|
||||
|
||||
import { registrySnapshotDigest } from "./lib/registry-compatibility.mjs";
|
||||
|
||||
const inputPath =
|
||||
process.argv[2] ?? "artifacts/quality/registry-current-snapshot.json";
|
||||
const outputPath =
|
||||
process.argv[3] ?? "config/contracts/registry-baseline.json";
|
||||
const owner = process.env.REGISTRY_BASELINE_OWNER;
|
||||
const reason = process.env.REGISTRY_BASELINE_REASON;
|
||||
|
||||
if (!owner || !reason) {
|
||||
process.stderr.write(
|
||||
"REGISTRY_BASELINE_OWNER and REGISTRY_BASELINE_REASON are required.\n",
|
||||
);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const input = JSON.parse(await readFile(inputPath, "utf8"));
|
||||
const snapshot = input.registries
|
||||
? { schemaVersion: 2, registries: input.registries }
|
||||
: input;
|
||||
const digest = registrySnapshotDigest(snapshot);
|
||||
await mkdir(path.dirname(outputPath), { recursive: true });
|
||||
await writeFile(outputPath, `${JSON.stringify(snapshot, null, 2)}\n`);
|
||||
await writeFile(
|
||||
"config/contracts/registry-baseline.approval.json",
|
||||
`${JSON.stringify(
|
||||
{
|
||||
schemaVersion: 1,
|
||||
snapshotDigest: digest,
|
||||
owner,
|
||||
reason,
|
||||
approvedAt: new Date().toISOString(),
|
||||
},
|
||||
null,
|
||||
2,
|
||||
)}\n`,
|
||||
);
|
||||
process.stdout.write(`Registry baseline updated: ${digest}\n`);
|
||||
@@ -0,0 +1,102 @@
|
||||
import type { DiagnosticsPort } from "../../application/ports/diagnostics-port.js";
|
||||
import {
|
||||
projectDiagnosticRecord,
|
||||
safeErrorKind,
|
||||
type DiagnosticRecord,
|
||||
type DiagnosticRecordInput,
|
||||
} from "../../contracts/diagnostics.js";
|
||||
import { projectTelemetryEvent } from "../../contracts/telemetry.js";
|
||||
|
||||
export const noOpDiagnostics: DiagnosticsPort = Object.freeze({
|
||||
record() {},
|
||||
});
|
||||
|
||||
export function createDiagnosticsAdapter(
|
||||
options: Readonly<{
|
||||
maxEntries?: number;
|
||||
now?: () => number;
|
||||
sink?: (record: DiagnosticRecord) => void;
|
||||
}> = {},
|
||||
) {
|
||||
const maxEntries = Math.max(1, options.maxEntries ?? 100);
|
||||
const entries: DiagnosticRecord[] = [];
|
||||
const droppedReasons = new Map<string, number>();
|
||||
|
||||
function drop(reason: string) {
|
||||
droppedReasons.set(reason, (droppedReasons.get(reason) ?? 0) + 1);
|
||||
}
|
||||
|
||||
function record(input: DiagnosticRecordInput) {
|
||||
try {
|
||||
const projected = projectDiagnosticRecord(input, options.now);
|
||||
if (!projected.success) {
|
||||
drop(projected.reason);
|
||||
return;
|
||||
}
|
||||
if (entries.length >= maxEntries) {
|
||||
entries.shift();
|
||||
drop("queue-full");
|
||||
}
|
||||
entries.push(projected.record);
|
||||
try {
|
||||
options.sink?.(projected.record);
|
||||
} catch {
|
||||
drop("sink-failure");
|
||||
}
|
||||
} catch {
|
||||
drop("serialization-failure");
|
||||
}
|
||||
}
|
||||
|
||||
return Object.freeze({
|
||||
record,
|
||||
entries: () => structuredClone(entries) as readonly DiagnosticRecord[],
|
||||
dropped: () => Object.freeze(Object.fromEntries(droppedReasons)),
|
||||
});
|
||||
}
|
||||
|
||||
type BootSafeContext = Readonly<{
|
||||
kind?: string;
|
||||
buildId?: string;
|
||||
configSchemaVersion?: string;
|
||||
supportReference?: string;
|
||||
}>;
|
||||
|
||||
let lastBootEvidence:
|
||||
| Readonly<{
|
||||
diagnostic: DiagnosticRecord | null;
|
||||
telemetry: Readonly<Record<string, unknown>> | null;
|
||||
}>
|
||||
| undefined;
|
||||
|
||||
export function recordBootFailure(
|
||||
error: unknown,
|
||||
safe: BootSafeContext,
|
||||
now: () => number = Date.now,
|
||||
) {
|
||||
const errorKind =
|
||||
typeof safe.kind === "string" ? safe.kind : safeErrorKind(error);
|
||||
const attributes = {
|
||||
error_kind: errorKind,
|
||||
build_id: safe.buildId ?? "unknown",
|
||||
config_schema_version: safe.configSchemaVersion ?? "unknown",
|
||||
};
|
||||
const diagnostic = projectDiagnosticRecord(
|
||||
{
|
||||
level: "error",
|
||||
eventId: "app.boot.failed",
|
||||
context: attributes,
|
||||
},
|
||||
now,
|
||||
);
|
||||
const telemetry = projectTelemetryEvent("app.boot.failed", attributes, now);
|
||||
lastBootEvidence = Object.freeze({
|
||||
diagnostic: diagnostic.success ? diagnostic.record : null,
|
||||
telemetry: telemetry.success ? telemetry.event : null,
|
||||
});
|
||||
return lastBootEvidence;
|
||||
}
|
||||
|
||||
export function getLastBootEvidence() {
|
||||
return lastBootEvidence ? structuredClone(lastBootEvidence) : undefined;
|
||||
}
|
||||
+98
-20
@@ -14,6 +14,11 @@ import {
|
||||
validateOperationRequest,
|
||||
} from "./schema-registry.js";
|
||||
import { buildRequestTarget } from "./request-builder.js";
|
||||
import {
|
||||
attemptBucket,
|
||||
durationBucket,
|
||||
statusGroup,
|
||||
} from "../../contracts/diagnostics.js";
|
||||
|
||||
const noAuthSession =
|
||||
/** @type {import("../../application/ports/auth-session-port.js").AuthSessionPort} */ ({
|
||||
@@ -54,7 +59,10 @@ const noAuthSession =
|
||||
* timeoutMs?: number,
|
||||
* maxRetryAttempts?: number,
|
||||
* scheduler?: Scheduler,
|
||||
* getOperation?: typeof getApiOperation
|
||||
* getOperation?: typeof getApiOperation,
|
||||
* diagnostics?: import("../../application/ports/diagnostics-port.js").DiagnosticsPort,
|
||||
* telemetry?: import("../../application/ports/telemetry-port.js").TelemetryPort,
|
||||
* correlationIdFactory?: () => string
|
||||
* }} dependencies
|
||||
*/
|
||||
export function createHttpClient(dependencies) {
|
||||
@@ -72,6 +80,11 @@ export function createHttpClient(dependencies) {
|
||||
const defaultTimeoutMs = dependencies.timeoutMs ?? 10_000;
|
||||
const maxRetryAttempts = dependencies.maxRetryAttempts ?? 2;
|
||||
const selectOperation = dependencies.getOperation ?? getApiOperation;
|
||||
const diagnostics = dependencies.diagnostics;
|
||||
const telemetry = dependencies.telemetry;
|
||||
const correlationIdFactory =
|
||||
dependencies.correlationIdFactory ??
|
||||
(() => `request-${Math.floor(random() * 1_000_000).toString(36)}`);
|
||||
const scheduler =
|
||||
dependencies.scheduler ??
|
||||
/** @type {Scheduler} */ ({
|
||||
@@ -91,7 +104,8 @@ export function createHttpClient(dependencies) {
|
||||
* pathParams?: Record<string, string | number>,
|
||||
* searchParams?: unknown,
|
||||
* signal?: AbortSignal,
|
||||
* idempotencyKey?: string
|
||||
* idempotencyKey?: string,
|
||||
* correlationId?: string
|
||||
* }} [legacyInput]
|
||||
* @returns {Promise<HttpResult>}
|
||||
*/
|
||||
@@ -106,9 +120,55 @@ export function createHttpClient(dependencies) {
|
||||
body: legacyInput.body,
|
||||
signal: legacyInput.signal,
|
||||
idempotencyKey: legacyInput.idempotencyKey,
|
||||
correlationId: legacyInput.correlationId,
|
||||
}
|
||||
: request;
|
||||
const operation = selectOperation(input.operationId);
|
||||
const startedAt = clock.now();
|
||||
const correlationId = input.correlationId ?? correlationIdFactory();
|
||||
/**
|
||||
* @param {HttpResult} outcome
|
||||
* @param {"success" | "recovered" | "failed" | "aborted"} outcomeKind
|
||||
*/
|
||||
function finalize(outcome, outcomeKind) {
|
||||
const error = outcome.ok ? undefined : outcome.error;
|
||||
const context = {
|
||||
route_id: input.routeId,
|
||||
operation_id: input.operationId,
|
||||
correlation_id: correlationId,
|
||||
outcome: outcomeKind,
|
||||
error_kind: error?.kind ?? "NONE",
|
||||
http_status_group: statusGroup(error?.httpStatus),
|
||||
attempt_count_bucket: attemptBucket(
|
||||
error?.attemptCount ?? retryCount + 1,
|
||||
),
|
||||
duration_bucket: durationBucket(clock.now() - startedAt),
|
||||
};
|
||||
try {
|
||||
diagnostics?.record({
|
||||
level: error ? "warn" : "info",
|
||||
eventId: "http.request.completed",
|
||||
context,
|
||||
});
|
||||
} catch {
|
||||
// Diagnostics cannot change the HTTP result.
|
||||
}
|
||||
if (error && outcomeKind !== "aborted") {
|
||||
try {
|
||||
telemetry?.emit("api.request.failed", {
|
||||
error_kind: context.error_kind,
|
||||
http_status_group: context.http_status_group,
|
||||
attempt_count_bucket: context.attempt_count_bucket,
|
||||
route_id: context.route_id,
|
||||
operation_id: context.operation_id,
|
||||
duration_bucket: context.duration_bucket,
|
||||
});
|
||||
} catch {
|
||||
// Telemetry cannot change the HTTP result.
|
||||
}
|
||||
}
|
||||
return outcome;
|
||||
}
|
||||
const logicalIdempotencyKey =
|
||||
operation.idempotency === "keyed"
|
||||
? input.idempotencyKey ?? idempotencyKeyFactory()
|
||||
@@ -126,28 +186,40 @@ export function createHttpClient(dependencies) {
|
||||
idempotencyKey: logicalIdempotencyKey,
|
||||
});
|
||||
|
||||
if (outcome.ok) return outcome;
|
||||
if (outcome.ok) {
|
||||
return finalize(
|
||||
outcome,
|
||||
retryCount > 0 || recoveryUsed ? "recovered" : "success",
|
||||
);
|
||||
}
|
||||
|
||||
if (outcome.error.httpStatus === 401 && !recoveryUsed) {
|
||||
recoveryUsed = true;
|
||||
const recovered = await recoverSession(authSession, operation, outcome.error);
|
||||
if (!recovered.ok) return recovered;
|
||||
const recovered = await recoverSession(
|
||||
authSession,
|
||||
operation,
|
||||
outcome.error,
|
||||
);
|
||||
if (!recovered.ok) return finalize(recovered, "failed");
|
||||
if (operation.idempotency === "none") {
|
||||
return {
|
||||
ok: false,
|
||||
error: {
|
||||
...outcome.error,
|
||||
retryable: false,
|
||||
action: "retry",
|
||||
return finalize(
|
||||
{
|
||||
ok: false,
|
||||
error: {
|
||||
...outcome.error,
|
||||
retryable: false,
|
||||
action: "retry",
|
||||
},
|
||||
},
|
||||
};
|
||||
"failed",
|
||||
);
|
||||
}
|
||||
continue;
|
||||
}
|
||||
|
||||
if (outcome.error.httpStatus === 401 && recoveryUsed) {
|
||||
authSession.onUnauthenticated();
|
||||
return outcome;
|
||||
return finalize(outcome, "failed");
|
||||
}
|
||||
|
||||
if (
|
||||
@@ -158,7 +230,10 @@ export function createHttpClient(dependencies) {
|
||||
maxRetryAttempts,
|
||||
)
|
||||
) {
|
||||
return outcome;
|
||||
return finalize(
|
||||
outcome,
|
||||
outcome.error.kind === "REQUEST_ABORTED" ? "aborted" : "failed",
|
||||
);
|
||||
}
|
||||
|
||||
const delay = retryDelay(outcome.error, retryCount, random, clock.now());
|
||||
@@ -167,12 +242,15 @@ export function createHttpClient(dependencies) {
|
||||
try {
|
||||
await clock.sleep(delay, input.signal);
|
||||
} catch {
|
||||
return {
|
||||
ok: false,
|
||||
error: failure("REQUEST_ABORTED", input.operationId, retryCount, {
|
||||
code: "REQUEST_ABORTED",
|
||||
}),
|
||||
};
|
||||
return finalize(
|
||||
{
|
||||
ok: false,
|
||||
error: failure("REQUEST_ABORTED", input.operationId, retryCount, {
|
||||
code: "REQUEST_ABORTED",
|
||||
}),
|
||||
},
|
||||
"aborted",
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -8,6 +8,7 @@ export type OperationRequestInput = Readonly<{
|
||||
body?: unknown;
|
||||
signal?: AbortSignal;
|
||||
idempotencyKey?: string;
|
||||
correlationId?: string;
|
||||
}>;
|
||||
|
||||
export type RequestTargetResult =
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
import { QueryClient } from "@tanstack/react-query";
|
||||
import { MutationCache, QueryCache, QueryClient } from "@tanstack/react-query";
|
||||
|
||||
import { createFailure } from "../../contracts/errors.js";
|
||||
import { safeErrorKind } from "../../contracts/diagnostics.js";
|
||||
|
||||
export const QUERY_CACHE_DEFAULTS = Object.freeze({
|
||||
staleTime: 30_000,
|
||||
@@ -11,8 +12,32 @@ export const QUERY_CACHE_DEFAULTS = Object.freeze({
|
||||
persistence: false,
|
||||
});
|
||||
|
||||
export function createQueryClient() {
|
||||
/**
|
||||
* @param {{diagnostics?: import("../../application/ports/diagnostics-port.js").DiagnosticsPort}} [dependencies]
|
||||
*/
|
||||
export function createQueryClient(dependencies = {}) {
|
||||
/** @param {string} operation @param {unknown} error */
|
||||
function report(operation, error) {
|
||||
try {
|
||||
dependencies.diagnostics?.record({
|
||||
level: "warn",
|
||||
eventId: "cache.operation.failed",
|
||||
context: {
|
||||
operation,
|
||||
error_kind: safeErrorKind(error),
|
||||
},
|
||||
});
|
||||
} catch {
|
||||
// Query behavior remains independent from diagnostics.
|
||||
}
|
||||
}
|
||||
return new QueryClient({
|
||||
queryCache: new QueryCache({
|
||||
onError: (error) => report("query", error),
|
||||
}),
|
||||
mutationCache: new MutationCache({
|
||||
onError: (error) => report("mutation", error),
|
||||
}),
|
||||
defaultOptions: {
|
||||
queries: {
|
||||
staleTime: QUERY_CACHE_DEFAULTS.staleTime,
|
||||
@@ -29,15 +54,16 @@ export function createQueryClient() {
|
||||
|
||||
/**
|
||||
* @param {QueryClient} queryClient
|
||||
* @param {{diagnostics?: import("../../application/ports/diagnostics-port.js").DiagnosticsPort}} [dependencies]
|
||||
* @returns {import("../../application/ports/query-cache-port.js").QueryCachePort}
|
||||
*/
|
||||
export function createQueryCacheAdapter(queryClient) {
|
||||
export function createQueryCacheAdapter(queryClient, dependencies = {}) {
|
||||
return Object.freeze({
|
||||
read(key) {
|
||||
try {
|
||||
return { ok: true, value: queryClient.getQueryData(key) };
|
||||
} catch {
|
||||
return cacheFailure("read", key);
|
||||
return cacheFailure("read", key, dependencies.diagnostics);
|
||||
}
|
||||
},
|
||||
write(key, value) {
|
||||
@@ -45,7 +71,7 @@ export function createQueryCacheAdapter(queryClient) {
|
||||
queryClient.setQueryData(key, structuredClone(value));
|
||||
return { ok: true };
|
||||
} catch {
|
||||
return cacheFailure("write", key);
|
||||
return cacheFailure("write", key, dependencies.diagnostics);
|
||||
}
|
||||
},
|
||||
async invalidate(namespace) {
|
||||
@@ -53,15 +79,31 @@ export function createQueryCacheAdapter(queryClient) {
|
||||
await queryClient.invalidateQueries({ queryKey: namespace, exact: false });
|
||||
return { ok: true };
|
||||
} catch {
|
||||
return cacheFailure("invalidate", namespace);
|
||||
return cacheFailure("invalidate", namespace, dependencies.diagnostics);
|
||||
}
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
/** @param {string} phase @param {readonly unknown[]} key */
|
||||
function cacheFailure(phase, key) {
|
||||
/**
|
||||
* @param {string} phase
|
||||
* @param {readonly unknown[]} key
|
||||
* @param {import("../../application/ports/diagnostics-port.js").DiagnosticsPort | undefined} diagnostics
|
||||
*/
|
||||
function cacheFailure(phase, key, diagnostics) {
|
||||
const namespace = typeof key[0] === "string" ? key[0] : "unknown";
|
||||
try {
|
||||
diagnostics?.record({
|
||||
level: "warn",
|
||||
eventId: "cache.operation.failed",
|
||||
context: {
|
||||
operation: phase,
|
||||
error_kind: "QUERY_CACHE_FAILURE",
|
||||
},
|
||||
});
|
||||
} catch {
|
||||
// Cache behavior remains independent from diagnostics.
|
||||
}
|
||||
return {
|
||||
ok: /** @type {false} */ (false),
|
||||
error: createFailure("QUERY_CACHE_FAILURE", "QUERY_CACHE", 0, {
|
||||
|
||||
@@ -5,7 +5,8 @@ import { getStorageDefinition } from "../../contracts/storage-keys.js";
|
||||
* @param {{
|
||||
* localStorage?: Storage,
|
||||
* sessionStorage?: Storage,
|
||||
* now?: () => number
|
||||
* now?: () => number,
|
||||
* diagnostics?: import("../../application/ports/diagnostics-port.js").DiagnosticsPort
|
||||
* }} [dependencies]
|
||||
* @returns {import("../../application/ports/storage-port.js").StoragePort}
|
||||
*/
|
||||
@@ -26,7 +27,7 @@ export function createBrowserStorageAdapter(dependencies = {}) {
|
||||
try {
|
||||
definition = getStorageDefinition(logicalName);
|
||||
} catch {
|
||||
return unavailable("read", logicalName);
|
||||
return unavailable("read", logicalName, dependencies.diagnostics);
|
||||
}
|
||||
|
||||
const backend = backendFor(definition.backend);
|
||||
@@ -50,7 +51,7 @@ export function createBrowserStorageAdapter(dependencies = {}) {
|
||||
}
|
||||
return { ok: true, value: structuredClone(envelope.value) };
|
||||
} catch {
|
||||
return unavailable("read", logicalName);
|
||||
return unavailable("read", logicalName, dependencies.diagnostics);
|
||||
}
|
||||
},
|
||||
|
||||
@@ -59,7 +60,7 @@ export function createBrowserStorageAdapter(dependencies = {}) {
|
||||
try {
|
||||
definition = getStorageDefinition(logicalName);
|
||||
} catch {
|
||||
return unavailable("write", logicalName);
|
||||
return unavailable("write", logicalName, dependencies.diagnostics);
|
||||
}
|
||||
|
||||
const expiresAt =
|
||||
@@ -82,12 +83,24 @@ export function createBrowserStorageAdapter(dependencies = {}) {
|
||||
|
||||
if (definition.quotaFallback === "memory") {
|
||||
memory.set(definition.physicalKey, structuredClone(value));
|
||||
recordStorageFailure(
|
||||
dependencies.diagnostics,
|
||||
"write",
|
||||
logicalName,
|
||||
quota,
|
||||
);
|
||||
return {
|
||||
ok: false,
|
||||
error: storageFailure(quota, "write", logicalName),
|
||||
fallback: "memory",
|
||||
};
|
||||
}
|
||||
recordStorageFailure(
|
||||
dependencies.diagnostics,
|
||||
"write",
|
||||
logicalName,
|
||||
quota,
|
||||
);
|
||||
return {
|
||||
ok: false,
|
||||
error: storageFailure(quota, "write", logicalName),
|
||||
@@ -101,14 +114,14 @@ export function createBrowserStorageAdapter(dependencies = {}) {
|
||||
try {
|
||||
definition = getStorageDefinition(logicalName);
|
||||
} catch {
|
||||
return unavailable("remove", logicalName);
|
||||
return unavailable("remove", logicalName, dependencies.diagnostics);
|
||||
}
|
||||
try {
|
||||
backendFor(definition.backend)?.removeItem(definition.physicalKey);
|
||||
memory.delete(definition.physicalKey);
|
||||
return { ok: true };
|
||||
} catch {
|
||||
return unavailable("remove", logicalName);
|
||||
return unavailable("remove", logicalName, dependencies.diagnostics);
|
||||
}
|
||||
},
|
||||
});
|
||||
@@ -128,10 +141,38 @@ function storageFailure(quota, phase, logicalName) {
|
||||
);
|
||||
}
|
||||
|
||||
/** @param {string} phase @param {string} logicalName */
|
||||
function unavailable(phase, logicalName) {
|
||||
/**
|
||||
* @param {string} phase
|
||||
* @param {string} logicalName
|
||||
* @param {import("../../application/ports/diagnostics-port.js").DiagnosticsPort | undefined} diagnostics
|
||||
*/
|
||||
function unavailable(phase, logicalName, diagnostics) {
|
||||
recordStorageFailure(diagnostics, phase, logicalName, false);
|
||||
return {
|
||||
ok: /** @type {false} */ (false),
|
||||
error: storageFailure(false, phase, logicalName),
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {import("../../application/ports/diagnostics-port.js").DiagnosticsPort | undefined} diagnostics
|
||||
* @param {string} phase
|
||||
* @param {string} logicalName
|
||||
* @param {boolean} quota
|
||||
*/
|
||||
function recordStorageFailure(diagnostics, phase, logicalName, quota) {
|
||||
try {
|
||||
diagnostics?.record({
|
||||
level: "warn",
|
||||
eventId: "storage.operation.failed",
|
||||
context: {
|
||||
operation: `${phase}:${logicalName}`,
|
||||
error_kind: quota
|
||||
? "STORAGE_QUOTA_EXCEEDED"
|
||||
: "STORAGE_UNAVAILABLE",
|
||||
},
|
||||
});
|
||||
} catch {
|
||||
// Storage behavior remains independent from diagnostics.
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +1,14 @@
|
||||
import { projectTelemetryEvent } from "../../contracts/telemetry.js";
|
||||
import { queueSizeBucket } from "../../contracts/diagnostics.js";
|
||||
|
||||
export const noOpTelemetry = Object.freeze({
|
||||
emit: () => {},
|
||||
flush: async () => {},
|
||||
pendingCount: () => 0,
|
||||
droppedCount: () => 0,
|
||||
dropReasons: () => Object.freeze({}),
|
||||
deliveryEvidence: () => null,
|
||||
dispose: () => {},
|
||||
});
|
||||
|
||||
/**
|
||||
@@ -10,22 +17,20 @@ export const noOpTelemetry = Object.freeze({
|
||||
* endpoint?: string,
|
||||
* fetcher?: typeof fetch,
|
||||
* maxQueue?: number,
|
||||
* schedule?: (callback: () => void) => void
|
||||
* schedule?: (callback: () => void) => void,
|
||||
* now?: () => number,
|
||||
* onDrop?: (event: Readonly<Record<string, unknown>>) => void,
|
||||
* lifecycle?: Pick<EventTarget, "addEventListener" | "removeEventListener">
|
||||
* }} options
|
||||
*/
|
||||
export function createTelemetryAdapter(options) {
|
||||
if (!options.enabled || !options.endpoint) {
|
||||
return Object.freeze({
|
||||
...noOpTelemetry,
|
||||
flush: async () => {},
|
||||
pendingCount: () => 0,
|
||||
droppedCount: () => 0,
|
||||
});
|
||||
return noOpTelemetry;
|
||||
}
|
||||
|
||||
const endpoint = /** @type {string} */ (options.endpoint);
|
||||
const fetcher = options.fetcher ?? fetch;
|
||||
const maxQueue = options.maxQueue ?? 100;
|
||||
const maxQueue = Math.max(1, options.maxQueue ?? 100);
|
||||
const schedule = options.schedule ?? queueMicrotask;
|
||||
const queue =
|
||||
/** @type {Array<{eventName: string, attributes: Readonly<Record<string, unknown>>}>} */ (
|
||||
@@ -34,18 +39,63 @@ export function createTelemetryAdapter(options) {
|
||||
let scheduled = false;
|
||||
let flushing = false;
|
||||
let dropped = 0;
|
||||
const dropReasons = new Map();
|
||||
let lastDeliveryEvidence =
|
||||
/** @type {Readonly<Record<string, unknown>> | null} */ (null);
|
||||
const lifecycle =
|
||||
options.lifecycle ??
|
||||
(typeof globalThis.addEventListener === "function" &&
|
||||
typeof globalThis.removeEventListener === "function"
|
||||
? globalThis
|
||||
: undefined);
|
||||
|
||||
/** @param {string} reason @param {number} count */
|
||||
function recordDrop(reason, count = 1) {
|
||||
const safeReason =
|
||||
{
|
||||
"queue-full": "queue-full",
|
||||
"sink-failure": "sink-failure",
|
||||
"serialization-failure": "serialization-failure",
|
||||
"unknown-attributes": "invalid-context",
|
||||
"invalid-attribute-value": "invalid-context",
|
||||
"missing-required-attributes": "invalid-context",
|
||||
"unregistered-event": "invalid-event",
|
||||
}[reason] ?? "invalid-event";
|
||||
dropped += count;
|
||||
dropReasons.set(safeReason, (dropReasons.get(safeReason) ?? 0) + count);
|
||||
const internal = projectTelemetryEvent(
|
||||
"telemetry.delivery.dropped",
|
||||
{
|
||||
reason: safeReason,
|
||||
queue_size_bucket: queueSizeBucket(queue.length),
|
||||
},
|
||||
options.now,
|
||||
);
|
||||
if (internal.success) {
|
||||
lastDeliveryEvidence = internal.event;
|
||||
try {
|
||||
options.onDrop?.(internal.event);
|
||||
} catch {
|
||||
// Drop observers are deliberately nonrecursive.
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/** @param {string} eventName @param {Record<string, unknown>} attributes */
|
||||
function emit(eventName, attributes) {
|
||||
const projected = projectTelemetryEvent(eventName, attributes);
|
||||
const projected = projectTelemetryEvent(
|
||||
eventName,
|
||||
attributes,
|
||||
options.now,
|
||||
);
|
||||
if (!projected.success) {
|
||||
dropped += 1;
|
||||
recordDrop(projected.reason);
|
||||
return;
|
||||
}
|
||||
|
||||
if (queue.length >= maxQueue) {
|
||||
queue.shift();
|
||||
dropped += 1;
|
||||
recordDrop("queue-full");
|
||||
}
|
||||
queue.push(projected.event);
|
||||
|
||||
@@ -69,19 +119,32 @@ export function createTelemetryAdapter(options) {
|
||||
body: JSON.stringify({ events: batch }),
|
||||
keepalive: true,
|
||||
});
|
||||
if (!response.ok) dropped += batch.length;
|
||||
if (!response.ok) recordDrop("sink-failure", batch.length);
|
||||
} catch {
|
||||
dropped += batch.length;
|
||||
recordDrop("sink-failure", batch.length);
|
||||
} finally {
|
||||
flushing = false;
|
||||
}
|
||||
}
|
||||
|
||||
const flushBeforePageExit = () => {
|
||||
void flush();
|
||||
};
|
||||
lifecycle?.addEventListener("pagehide", flushBeforePageExit);
|
||||
|
||||
function dispose() {
|
||||
lifecycle?.removeEventListener("pagehide", flushBeforePageExit);
|
||||
}
|
||||
|
||||
return Object.freeze({
|
||||
emit,
|
||||
flush,
|
||||
pendingCount: () => queue.length,
|
||||
droppedCount: () => dropped,
|
||||
dropReasons: () => Object.freeze(Object.fromEntries(dropReasons)),
|
||||
deliveryEvidence: () =>
|
||||
lastDeliveryEvidence ? structuredClone(lastDeliveryEvidence) : null,
|
||||
dispose,
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
@@ -3,6 +3,7 @@ import type {
|
||||
ApplicationApi,
|
||||
ColorSchemePreference,
|
||||
RenderFailureReport,
|
||||
RouteChangedReport,
|
||||
} from "./ports/in/application-api.js";
|
||||
import type { ApplicationOutputPorts } from "./ports/out/application-output-ports.js";
|
||||
import { decideChunkRecovery } from "./use-cases/decide-chunk-recovery.js";
|
||||
@@ -43,7 +44,20 @@ export function createApplication(
|
||||
const diagnostics = Object.freeze({
|
||||
reportRenderFailure(report: RenderFailureReport) {
|
||||
try {
|
||||
outputPorts.diagnostics.emit("ui.render.failed", {
|
||||
outputPorts.diagnostics.record({
|
||||
level: "error",
|
||||
eventId: "ui.render.failed",
|
||||
context: {
|
||||
route_id: report.routeId,
|
||||
build_id: report.buildId,
|
||||
component_boundary: report.boundaryName,
|
||||
},
|
||||
});
|
||||
} catch {
|
||||
// Diagnostics are best-effort and cannot become an application failure.
|
||||
}
|
||||
try {
|
||||
outputPorts.telemetry.emit("ui.render.failed", {
|
||||
route_id: report.routeId,
|
||||
build_id: report.buildId,
|
||||
component_boundary: report.boundaryName,
|
||||
@@ -52,6 +66,20 @@ export function createApplication(
|
||||
// Diagnostics are best-effort and cannot become an application failure.
|
||||
}
|
||||
},
|
||||
reportRouteChanged(report: RouteChangedReport) {
|
||||
try {
|
||||
outputPorts.diagnostics.record({
|
||||
level: "info",
|
||||
eventId: "route.changed",
|
||||
context: {
|
||||
route_id: report.routeId,
|
||||
build_id: report.buildId,
|
||||
},
|
||||
});
|
||||
} catch {
|
||||
// Diagnostics are best-effort and cannot become navigation failure.
|
||||
}
|
||||
},
|
||||
});
|
||||
|
||||
const runtime = Object.freeze({
|
||||
@@ -74,6 +102,37 @@ export function createApplication(
|
||||
try {
|
||||
const current = await outputPorts.releaseInfo.getCurrent();
|
||||
const active = await outputPorts.releaseInfo.refresh();
|
||||
if (
|
||||
current.buildId !== active.buildId ||
|
||||
current.releaseId !== active.releaseId
|
||||
) {
|
||||
const mismatchKind =
|
||||
current.buildId !== active.buildId
|
||||
? "BUILD_MISMATCH"
|
||||
: "RELEASE_MISMATCH";
|
||||
try {
|
||||
outputPorts.diagnostics.record({
|
||||
level: "warn",
|
||||
eventId: "release.mismatch.detected",
|
||||
context: {
|
||||
build_id: current.buildId,
|
||||
active_release_id: active.releaseId,
|
||||
mismatch_kind: mismatchKind,
|
||||
},
|
||||
});
|
||||
} catch {
|
||||
// Recovery remains independent from diagnostics.
|
||||
}
|
||||
try {
|
||||
outputPorts.telemetry.emit("release.mismatch.detected", {
|
||||
build_id: current.buildId,
|
||||
active_release_id: active.releaseId,
|
||||
mismatch_kind: mismatchKind,
|
||||
});
|
||||
} catch {
|
||||
// Recovery remains independent from telemetry.
|
||||
}
|
||||
}
|
||||
if (!active.routeChunks[input.chunkId]) {
|
||||
return {
|
||||
action: "support" as const,
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
import type { DiagnosticRecordInput } from "../../contracts/diagnostics.js";
|
||||
|
||||
export type DiagnosticsPort = Readonly<{
|
||||
record(input: DiagnosticRecordInput): void;
|
||||
}>;
|
||||
@@ -11,6 +11,11 @@ export type RenderFailureReport = Readonly<{
|
||||
boundaryName: "route" | "feature";
|
||||
}>;
|
||||
|
||||
export type RouteChangedReport = Readonly<{
|
||||
routeId: string;
|
||||
buildId: string;
|
||||
}>;
|
||||
|
||||
export type ReleaseSummary = Readonly<{
|
||||
buildId: string;
|
||||
releaseId: string;
|
||||
@@ -34,6 +39,7 @@ export type ApplicationApi = Readonly<{
|
||||
}>;
|
||||
diagnostics: Readonly<{
|
||||
reportRenderFailure(report: RenderFailureReport): void;
|
||||
reportRouteChanged(report: RouteChangedReport): void;
|
||||
}>;
|
||||
runtime: Readonly<{
|
||||
getReleaseSummary(): Promise<ReleaseSummary>;
|
||||
|
||||
@@ -2,6 +2,7 @@ import type { AuthSessionPort } from "../auth-session-port.js";
|
||||
import type { ReleaseInfoPort } from "../release-info-port.js";
|
||||
import type { StoragePort } from "../storage-port.js";
|
||||
import type { TelemetryPort } from "../telemetry-port.js";
|
||||
import type { DiagnosticsPort } from "../diagnostics-port.js";
|
||||
|
||||
/**
|
||||
* Capabilities required by application use cases. Implementations live in
|
||||
@@ -13,7 +14,8 @@ export type ApplicationOutputPorts = Readonly<{
|
||||
"getState" | "subscribe" | "beginSignIn" | "signOut" | "recover"
|
||||
>;
|
||||
preferences: StoragePort;
|
||||
diagnostics: TelemetryPort;
|
||||
diagnostics: DiagnosticsPort;
|
||||
telemetry: TelemetryPort;
|
||||
releaseInfo: ReleaseInfoPort;
|
||||
navigation: Readonly<{ reload(): void }>;
|
||||
}>;
|
||||
|
||||
@@ -9,3 +9,4 @@ export type { QueryCachePort } from "../query-cache-port.js";
|
||||
export type { ReleaseInfoPort } from "../release-info-port.js";
|
||||
export type { StoragePort } from "../storage-port.js";
|
||||
export type { TelemetryPort } from "../telemetry-port.js";
|
||||
export type { DiagnosticsPort } from "../diagnostics-port.js";
|
||||
|
||||
@@ -1,5 +0,0 @@
|
||||
/**
|
||||
* @typedef {{ emit(eventName: string, attributes: Record<string, unknown>): void }} TelemetryPort
|
||||
*/
|
||||
|
||||
export {};
|
||||
@@ -0,0 +1,10 @@
|
||||
import type { TelemetryEventName } from "../../contracts/telemetry.js";
|
||||
|
||||
export type { TelemetryEventName };
|
||||
|
||||
export type TelemetryPort = Readonly<{
|
||||
emit(
|
||||
eventName: TelemetryEventName,
|
||||
attributes: Record<string, unknown>,
|
||||
): void;
|
||||
}>;
|
||||
@@ -1,5 +1,6 @@
|
||||
import { createRoot } from "react-dom/client";
|
||||
|
||||
import { recordBootFailure } from "../adapters/diagnostics/bounded-diagnostics.js";
|
||||
import { BootErrorShell } from "../presentation/boundaries/boot-error-shell.jsx";
|
||||
import { createRuntimeComposition } from "./create-runtime-composition.js";
|
||||
import { initializeColorScheme } from "./initialize-color-scheme.js";
|
||||
@@ -19,6 +20,8 @@ const root = createRoot(rootElement);
|
||||
async function boot() {
|
||||
try {
|
||||
const composition = await createRuntimeComposition();
|
||||
document.documentElement.dataset.buildId = composition.release.buildId;
|
||||
document.documentElement.dataset.releaseId = composition.release.releaseId;
|
||||
initializeColorScheme(composition.application.preferences);
|
||||
root.render(<RuntimeApplication composition={composition} />);
|
||||
} catch (error) {
|
||||
@@ -27,6 +30,7 @@ async function boot() {
|
||||
? error.safe
|
||||
: { supportReference: "boot:unknown" };
|
||||
|
||||
recordBootFailure(error, safe);
|
||||
root.render(<BootErrorShell {...safe} />);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,6 +4,7 @@ import {
|
||||
createUnavailableSessionAdapter,
|
||||
} from "../adapters/auth/external-session-adapter.js";
|
||||
import { createHttpClient } from "../adapters/http/client.js";
|
||||
import { createDiagnosticsAdapter } from "../adapters/diagnostics/bounded-diagnostics.js";
|
||||
import {
|
||||
createQueryClient,
|
||||
} from "../adapters/query-cache/tanstack-query-cache.js";
|
||||
@@ -53,6 +54,8 @@ function storageOrUndefined(value) {
|
||||
* fetcher?: typeof fetch,
|
||||
* clock?: import("../application/ports/clock-port.js").ClockPort,
|
||||
* scheduler?: Parameters<typeof createHttpClient>[0]["scheduler"]
|
||||
* diagnostics?: Parameters<typeof createHttpClient>[0]["diagnostics"],
|
||||
* telemetry?: Parameters<typeof createHttpClient>[0]["telemetry"]
|
||||
* }} context
|
||||
*/
|
||||
export function createRuntimeHttpClient(context, contract = {}) {
|
||||
@@ -64,6 +67,8 @@ export function createRuntimeHttpClient(context, contract = {}) {
|
||||
fetcher: context.fetcher,
|
||||
clock: context.clock,
|
||||
scheduler: context.scheduler,
|
||||
diagnostics: context.diagnostics,
|
||||
telemetry: context.telemetry,
|
||||
...contract,
|
||||
});
|
||||
}
|
||||
@@ -86,15 +91,28 @@ export async function createRuntimeAdapters(context) {
|
||||
: externalOwner
|
||||
? createExternalAuthSessionAdapter(externalOwner)
|
||||
: createUnavailableSessionAdapter();
|
||||
const queryClient = createQueryClient();
|
||||
const storage = createBrowserStorageAdapter({
|
||||
localStorage: storageOrUndefined(host.localStorage),
|
||||
sessionStorage: storageOrUndefined(host.sessionStorage),
|
||||
});
|
||||
const diagnostics = createDiagnosticsAdapter();
|
||||
const telemetry = createTelemetryAdapter({
|
||||
enabled: config.TELEMETRY_ENABLED,
|
||||
endpoint: config.TELEMETRY_ENDPOINT,
|
||||
fetcher: context.fetcher,
|
||||
onDrop(event) {
|
||||
const attributes =
|
||||
event.attributes && typeof event.attributes === "object"
|
||||
? event.attributes
|
||||
: {};
|
||||
diagnostics.record({
|
||||
level: "warn",
|
||||
eventId: "telemetry.delivery.dropped",
|
||||
context: /** @type {Record<string, unknown>} */ (attributes),
|
||||
});
|
||||
},
|
||||
});
|
||||
const queryClient = createQueryClient({ diagnostics });
|
||||
const storage = createBrowserStorageAdapter({
|
||||
localStorage: storageOrUndefined(host.localStorage),
|
||||
sessionStorage: storageOrUndefined(host.sessionStorage),
|
||||
diagnostics,
|
||||
});
|
||||
const releaseInfo = Object.freeze({
|
||||
async getCurrent() {
|
||||
@@ -125,6 +143,8 @@ export async function createRuntimeAdapters(context) {
|
||||
runtime: context.runtime,
|
||||
authSession,
|
||||
fetcher: context.fetcher,
|
||||
diagnostics,
|
||||
telemetry,
|
||||
},
|
||||
contract,
|
||||
),
|
||||
@@ -134,7 +154,8 @@ export async function createRuntimeAdapters(context) {
|
||||
outputPorts: Object.freeze({
|
||||
session: authSession,
|
||||
preferences: storage,
|
||||
diagnostics: telemetry,
|
||||
diagnostics,
|
||||
telemetry,
|
||||
releaseInfo,
|
||||
navigation,
|
||||
}),
|
||||
|
||||
@@ -0,0 +1,183 @@
|
||||
export const DIAGNOSTIC_LEVELS = Object.freeze([
|
||||
"debug",
|
||||
"info",
|
||||
"warn",
|
||||
"error",
|
||||
] as const);
|
||||
export type DiagnosticLevel = (typeof DIAGNOSTIC_LEVELS)[number];
|
||||
|
||||
export const DIAGNOSTIC_EVENT_REGISTRY = Object.freeze({
|
||||
"app.boot.failed": Object.freeze({ level: "error" }),
|
||||
"http.request.completed": Object.freeze({ level: "info" }),
|
||||
"cache.operation.failed": Object.freeze({ level: "warn" }),
|
||||
"storage.operation.failed": Object.freeze({ level: "warn" }),
|
||||
"route.changed": Object.freeze({ level: "info" }),
|
||||
"ui.render.failed": Object.freeze({ level: "error" }),
|
||||
"release.mismatch.detected": Object.freeze({ level: "warn" }),
|
||||
"telemetry.delivery.dropped": Object.freeze({ level: "warn" }),
|
||||
});
|
||||
export type DiagnosticEventId = keyof typeof DIAGNOSTIC_EVENT_REGISTRY;
|
||||
|
||||
export const DIAGNOSTIC_CONTEXT_ALLOWLIST = Object.freeze([
|
||||
"app_version",
|
||||
"build_id",
|
||||
"release_id",
|
||||
"active_release_id",
|
||||
"config_schema_version",
|
||||
"api_contract_version",
|
||||
"route_id",
|
||||
"operation_id",
|
||||
"correlation_id",
|
||||
"error_kind",
|
||||
"outcome",
|
||||
"http_status_group",
|
||||
"attempt_count_bucket",
|
||||
"duration_bucket",
|
||||
"component_boundary",
|
||||
"mismatch_kind",
|
||||
"operation",
|
||||
"reason",
|
||||
"queue_size_bucket",
|
||||
] as const);
|
||||
export type DiagnosticContextKey =
|
||||
(typeof DIAGNOSTIC_CONTEXT_ALLOWLIST)[number];
|
||||
export type DiagnosticContext = Readonly<
|
||||
Partial<Record<DiagnosticContextKey, string | number | boolean>>
|
||||
>;
|
||||
|
||||
export type DiagnosticRecordInput = Readonly<{
|
||||
level: DiagnosticLevel;
|
||||
eventId: DiagnosticEventId;
|
||||
context?: Readonly<Record<string, unknown>>;
|
||||
}>;
|
||||
|
||||
export type DiagnosticRecord = Readonly<{
|
||||
level: DiagnosticLevel;
|
||||
eventId: DiagnosticEventId;
|
||||
timestamp: string;
|
||||
context: DiagnosticContext;
|
||||
}>;
|
||||
|
||||
const SAFE_VALUE = /^[A-Za-z0-9][A-Za-z0-9._:@/-]{0,63}$/;
|
||||
|
||||
function projectDiagnosticRecordUnsafe(
|
||||
input: DiagnosticRecordInput,
|
||||
now: () => number = Date.now,
|
||||
):
|
||||
| Readonly<{ success: true; record: DiagnosticRecord }>
|
||||
| Readonly<{ success: false; reason: string }> {
|
||||
if (!Object.hasOwn(DIAGNOSTIC_EVENT_REGISTRY, input.eventId)) {
|
||||
return { success: false, reason: "unregistered-event" };
|
||||
}
|
||||
if (!DIAGNOSTIC_LEVELS.includes(input.level)) {
|
||||
return { success: false, reason: "invalid-level" };
|
||||
}
|
||||
const contextEntries = Object.entries(input.context ?? {});
|
||||
if (contextEntries.length > DIAGNOSTIC_CONTEXT_ALLOWLIST.length) {
|
||||
return { success: false, reason: "invalid-context" };
|
||||
}
|
||||
const projected: Partial<
|
||||
Record<DiagnosticContextKey, string | number | boolean>
|
||||
> = {};
|
||||
for (const [key, value] of contextEntries) {
|
||||
if (
|
||||
!DIAGNOSTIC_CONTEXT_ALLOWLIST.includes(key as DiagnosticContextKey)
|
||||
) {
|
||||
return { success: false, reason: "unknown-context" };
|
||||
}
|
||||
if (typeof value === "string") {
|
||||
if (!SAFE_VALUE.test(value)) {
|
||||
return { success: false, reason: "invalid-context" };
|
||||
}
|
||||
projected[key as DiagnosticContextKey] = value;
|
||||
} else if (typeof value === "number" && Number.isFinite(value)) {
|
||||
projected[key as DiagnosticContextKey] = value;
|
||||
} else if (typeof value === "boolean") {
|
||||
projected[key as DiagnosticContextKey] = value;
|
||||
} else {
|
||||
return { success: false, reason: "invalid-context" };
|
||||
}
|
||||
}
|
||||
let timestamp: string;
|
||||
try {
|
||||
timestamp = new Date(now()).toISOString();
|
||||
} catch {
|
||||
timestamp = new Date(0).toISOString();
|
||||
}
|
||||
return {
|
||||
success: true,
|
||||
record: Object.freeze({
|
||||
level: input.level,
|
||||
eventId: input.eventId,
|
||||
timestamp,
|
||||
context: Object.freeze(projected),
|
||||
}),
|
||||
};
|
||||
}
|
||||
|
||||
export function projectDiagnosticRecord(
|
||||
input: DiagnosticRecordInput,
|
||||
now: () => number = Date.now,
|
||||
): ReturnType<typeof projectDiagnosticRecordUnsafe> {
|
||||
try {
|
||||
return projectDiagnosticRecordUnsafe(input, now);
|
||||
} catch {
|
||||
return { success: false, reason: "serialization-failure" };
|
||||
}
|
||||
}
|
||||
|
||||
export function safeErrorKind(error: unknown): string {
|
||||
try {
|
||||
if (error && typeof error === "object") {
|
||||
const record = error as Readonly<Record<string, unknown>>;
|
||||
if (
|
||||
typeof record.kind === "string" &&
|
||||
/^[A-Z][A-Z0-9_]{0,63}$/.test(record.kind)
|
||||
) {
|
||||
return record.kind;
|
||||
}
|
||||
if (
|
||||
typeof record.name === "string" &&
|
||||
/^[A-Za-z][A-Za-z0-9]{0,63}$/.test(record.name)
|
||||
) {
|
||||
const normalized = record.name
|
||||
.replace(/([a-z0-9])([A-Z])/g, "$1_$2")
|
||||
.toUpperCase();
|
||||
return /^[A-Z][A-Z0-9_]{0,63}$/.test(normalized)
|
||||
? normalized
|
||||
: "UNKNOWN_FAILURE";
|
||||
}
|
||||
}
|
||||
} catch {
|
||||
return "UNKNOWN_FAILURE";
|
||||
}
|
||||
return "UNKNOWN_FAILURE";
|
||||
}
|
||||
|
||||
export function statusGroup(status: number | undefined): string {
|
||||
return typeof status === "number" && Number.isFinite(status)
|
||||
? `${Math.max(0, Math.min(9, Math.floor(status / 100)))}xx`
|
||||
: "none";
|
||||
}
|
||||
|
||||
export function attemptBucket(attemptCount: number): string {
|
||||
if (attemptCount <= 1) return "1";
|
||||
if (attemptCount === 2) return "2";
|
||||
if (attemptCount <= 4) return "3-4";
|
||||
return "5+";
|
||||
}
|
||||
|
||||
export function durationBucket(durationMs: number): string {
|
||||
if (!Number.isFinite(durationMs) || durationMs < 0) return "unknown";
|
||||
if (durationMs < 100) return "lt100ms";
|
||||
if (durationMs < 500) return "100-499ms";
|
||||
if (durationMs < 2_000) return "500-1999ms";
|
||||
return "gte2000ms";
|
||||
}
|
||||
|
||||
export function queueSizeBucket(size: number): string {
|
||||
if (size <= 0) return "0";
|
||||
if (size <= 10) return "1-10";
|
||||
if (size <= 50) return "11-50";
|
||||
return "51+";
|
||||
}
|
||||
@@ -0,0 +1,27 @@
|
||||
/**
|
||||
* @typedef {{
|
||||
* schemaId: string,
|
||||
* boundary: "route-params" | "route-search" |
|
||||
* "route-search-api-request" | "api-request" | "api-response",
|
||||
* owner: string,
|
||||
* runtime: "zod"
|
||||
* }} SchemaDefinition
|
||||
*/
|
||||
|
||||
export const PLATFORM_SCHEMA_REGISTRY =
|
||||
/** @type {Readonly<Record<string, Readonly<SchemaDefinition>>>} */ (
|
||||
Object.freeze({
|
||||
none: Object.freeze({
|
||||
schemaId: "none",
|
||||
boundary: "route-params",
|
||||
owner: "feature-frontend-routing-release-recovery-runtime",
|
||||
runtime: "zod",
|
||||
}),
|
||||
NotFoundSplat: Object.freeze({
|
||||
schemaId: "NotFoundSplat",
|
||||
boundary: "route-params",
|
||||
owner: "feature-frontend-routing-release-recovery-runtime",
|
||||
runtime: "zod",
|
||||
}),
|
||||
})
|
||||
);
|
||||
Vendored
+36
@@ -0,0 +1,36 @@
|
||||
export type TelemetryEventName =
|
||||
| "app.boot.failed"
|
||||
| "api.request.failed"
|
||||
| "ui.render.failed"
|
||||
| "release.mismatch.detected"
|
||||
| "telemetry.delivery.dropped";
|
||||
|
||||
export type TelemetryDefinition = Readonly<{
|
||||
eventName: TelemetryEventName;
|
||||
trigger: string;
|
||||
requiredAttributes: readonly string[];
|
||||
optionalAttributes: readonly string[];
|
||||
forbiddenAttributes: readonly string[];
|
||||
sampling: string;
|
||||
delivery: "best-effort";
|
||||
}>;
|
||||
|
||||
export type TelemetryEvent = Readonly<{
|
||||
eventName: TelemetryEventName;
|
||||
timestamp: string;
|
||||
attributes: Readonly<Record<string, unknown>>;
|
||||
}>;
|
||||
|
||||
export const TELEMETRY_ATTRIBUTE_ALLOWLIST: readonly string[];
|
||||
export const TELEMETRY_FORBIDDEN_ATTRIBUTES: readonly string[];
|
||||
export const TELEMETRY_REGISTRY: Readonly<
|
||||
Record<TelemetryEventName, TelemetryDefinition>
|
||||
>;
|
||||
|
||||
export function projectTelemetryEvent(
|
||||
eventName: string,
|
||||
attributes: Record<string, unknown>,
|
||||
now?: () => number,
|
||||
):
|
||||
| Readonly<{ success: true; event: TelemetryEvent }>
|
||||
| Readonly<{ success: false; reason: string }>;
|
||||
@@ -81,7 +81,7 @@ export const TELEMETRY_REGISTRY = Object.freeze({
|
||||
"http_status_group",
|
||||
"attempt_count_bucket",
|
||||
"route_id",
|
||||
]),
|
||||
], ["operation_id", "duration_bucket"]),
|
||||
"ui.render.failed": event("ui.render.failed", "React boundary catch", [
|
||||
"route_id",
|
||||
"build_id",
|
||||
@@ -101,11 +101,44 @@ export const TELEMETRY_REGISTRY = Object.freeze({
|
||||
),
|
||||
});
|
||||
|
||||
const SAFE_IDENTIFIER = /^[A-Za-z0-9][A-Za-z0-9._:@/-]{0,63}$/;
|
||||
const ATTRIBUTE_VALUE_POLICIES =
|
||||
/** @type {Readonly<Record<string, (value: string) => boolean>>} */ (
|
||||
Object.freeze({
|
||||
route_id: (value) => /^[A-Z][A-Z0-9_]{0,63}$/.test(value),
|
||||
operation_id: (value) => /^[A-Z][A-Z0-9_]{0,63}$/.test(value),
|
||||
error_kind: (value) => /^[A-Z][A-Z0-9_]{0,63}$/.test(value),
|
||||
http_status_group: (value) => /^(?:[1-5]xx|none)$/.test(value),
|
||||
attempt_count_bucket: (value) => /^(?:1|2|3|3-4|5\+)$/.test(value),
|
||||
duration_bucket: (value) =>
|
||||
/^(?:lt100ms|100-499ms|500-1999ms|gte2000ms|unknown)$/.test(
|
||||
value,
|
||||
),
|
||||
component_boundary: (value) =>
|
||||
/^(?:route|feature|boot)$/.test(value),
|
||||
mismatch_kind: (value) => /^[A-Z][A-Z0-9_]{0,63}$/.test(value),
|
||||
reason: (value) =>
|
||||
/^(?:queue-full|sink-failure|invalid-event|invalid-context|serialization-failure)$/.test(
|
||||
value,
|
||||
),
|
||||
queue_size_bucket: (value) =>
|
||||
/^(?:0|1-10|11-50|51\+)$/.test(value),
|
||||
})
|
||||
);
|
||||
|
||||
/** @param {string} key @param {unknown} value */
|
||||
function validAttributeValue(key, value) {
|
||||
if (typeof value !== "string") return false;
|
||||
const policy = ATTRIBUTE_VALUE_POLICIES[key];
|
||||
return policy ? policy(value) : SAFE_IDENTIFIER.test(value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {string} eventName
|
||||
* @param {Record<string, unknown>} attributes
|
||||
* @param {() => number} [now]
|
||||
*/
|
||||
export function projectTelemetryEvent(eventName, attributes) {
|
||||
function projectTelemetryEventUnsafe(eventName, attributes, now = Date.now) {
|
||||
const registry =
|
||||
/** @type {Record<string, (typeof TELEMETRY_REGISTRY)[keyof typeof TELEMETRY_REGISTRY]>} */ (
|
||||
TELEMETRY_REGISTRY
|
||||
@@ -118,13 +151,47 @@ export function projectTelemetryEvent(eventName, attributes) {
|
||||
};
|
||||
}
|
||||
|
||||
const attributeKeys = Object.keys(attributes);
|
||||
if (
|
||||
attributeKeys.length >
|
||||
TELEMETRY_ATTRIBUTE_ALLOWLIST.length +
|
||||
TELEMETRY_FORBIDDEN_ATTRIBUTES.length
|
||||
) {
|
||||
return {
|
||||
success: /** @type {false} */ (false),
|
||||
reason: "invalid-attribute-value",
|
||||
};
|
||||
}
|
||||
const unknown = attributeKeys.filter(
|
||||
(key) =>
|
||||
!TELEMETRY_ATTRIBUTE_ALLOWLIST.includes(key) &&
|
||||
!TELEMETRY_FORBIDDEN_ATTRIBUTES.includes(key),
|
||||
);
|
||||
if (unknown.length > 0) {
|
||||
return {
|
||||
success: /** @type {false} */ (false),
|
||||
reason: "unknown-attributes",
|
||||
};
|
||||
}
|
||||
const projected = Object.fromEntries(
|
||||
Object.entries(attributes).filter(
|
||||
([key]) =>
|
||||
([key, value]) =>
|
||||
TELEMETRY_ATTRIBUTE_ALLOWLIST.includes(key) &&
|
||||
!TELEMETRY_FORBIDDEN_ATTRIBUTES.includes(key),
|
||||
!TELEMETRY_FORBIDDEN_ATTRIBUTES.includes(key) &&
|
||||
validAttributeValue(key, value),
|
||||
),
|
||||
);
|
||||
const invalid = Object.entries(attributes).filter(
|
||||
([key, value]) =>
|
||||
TELEMETRY_ATTRIBUTE_ALLOWLIST.includes(key) &&
|
||||
!validAttributeValue(key, value),
|
||||
);
|
||||
if (invalid.length > 0) {
|
||||
return {
|
||||
success: /** @type {false} */ (false),
|
||||
reason: "invalid-attribute-value",
|
||||
};
|
||||
}
|
||||
const missing = definition.requiredAttributes.filter(
|
||||
(key) => projected[key] === undefined,
|
||||
);
|
||||
@@ -135,11 +202,34 @@ export function projectTelemetryEvent(eventName, attributes) {
|
||||
};
|
||||
}
|
||||
|
||||
let timestamp;
|
||||
try {
|
||||
timestamp = new Date(now()).toISOString();
|
||||
} catch {
|
||||
timestamp = new Date(0).toISOString();
|
||||
}
|
||||
return {
|
||||
success: /** @type {true} */ (true),
|
||||
event: Object.freeze({
|
||||
eventName,
|
||||
timestamp,
|
||||
attributes: Object.freeze(projected),
|
||||
}),
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {string} eventName
|
||||
* @param {Record<string, unknown>} attributes
|
||||
* @param {() => number} [now]
|
||||
*/
|
||||
export function projectTelemetryEvent(eventName, attributes, now = Date.now) {
|
||||
try {
|
||||
return projectTelemetryEventUnsafe(eventName, attributes, now);
|
||||
} catch {
|
||||
return {
|
||||
success: /** @type {false} */ (false),
|
||||
reason: "serialization-failure",
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
import { PLATFORM_ROUTE_RUNTIME_CONTRACT } from "../contracts/route-runtime-contract.js";
|
||||
import { PLATFORM_ROUTE_REGISTRY } from "../contracts/routes.js";
|
||||
import { PLATFORM_SCHEMA_REGISTRY } from "../contracts/schema-registry.js";
|
||||
import { REFERENCE_FEATURE_CONTRACT } from "./reference-feature/contracts/reference-feature-contract.js";
|
||||
|
||||
export const INSTALLED_FEATURE_CONTRACTS = Object.freeze([
|
||||
@@ -20,6 +21,10 @@ export const API_OPERATIONS = Object.freeze({
|
||||
export const QUERY_REGISTRY = Object.freeze({
|
||||
...REFERENCE_FEATURE_CONTRACT.queryRegistry,
|
||||
});
|
||||
export const SCHEMA_REGISTRY = Object.freeze({
|
||||
...PLATFORM_SCHEMA_REGISTRY,
|
||||
...REFERENCE_FEATURE_CONTRACT.schemas,
|
||||
});
|
||||
|
||||
export const NAVIGATION_ROUTES = Object.freeze(
|
||||
Object.values(ROUTE_REGISTRY)
|
||||
|
||||
@@ -14,6 +14,44 @@ export const referenceQueryKeys = Object.freeze({
|
||||
|
||||
export const REFERENCE_FEATURE_CONTRACT = Object.freeze({
|
||||
featureId: REFERENCE_FEATURE_ID,
|
||||
schemas: Object.freeze({
|
||||
ReferenceResourceParams: Object.freeze({
|
||||
schemaId: "ReferenceResourceParams",
|
||||
boundary: "route-params",
|
||||
owner: "feature-frontend-reference-feature-vertical-slice",
|
||||
runtime: "zod",
|
||||
}),
|
||||
ReferenceResourceListQuery: Object.freeze({
|
||||
schemaId: "ReferenceResourceListQuery",
|
||||
boundary: "route-search-api-request",
|
||||
owner: "feature-frontend-reference-feature-vertical-slice",
|
||||
runtime: "zod",
|
||||
}),
|
||||
CreateReferenceResourceCommand: Object.freeze({
|
||||
schemaId: "CreateReferenceResourceCommand",
|
||||
boundary: "api-request",
|
||||
owner: "feature-frontend-reference-feature-vertical-slice",
|
||||
runtime: "zod",
|
||||
}),
|
||||
NoRequest: Object.freeze({
|
||||
schemaId: "NoRequest",
|
||||
boundary: "api-request",
|
||||
owner: "feature-frontend-reference-feature-vertical-slice",
|
||||
runtime: "zod",
|
||||
}),
|
||||
ReferenceResourceListPayload: Object.freeze({
|
||||
schemaId: "ReferenceResourceListPayload",
|
||||
boundary: "api-response",
|
||||
owner: "feature-frontend-reference-feature-vertical-slice",
|
||||
runtime: "zod",
|
||||
}),
|
||||
ReferenceResourcePayload: Object.freeze({
|
||||
schemaId: "ReferenceResourcePayload",
|
||||
boundary: "api-response",
|
||||
owner: "feature-frontend-reference-feature-vertical-slice",
|
||||
runtime: "zod",
|
||||
}),
|
||||
}),
|
||||
routes: Object.freeze({
|
||||
REFERENCE_RESOURCE_LIST: Object.freeze({
|
||||
routeId: "REFERENCE_RESOURCE_LIST",
|
||||
|
||||
@@ -39,6 +39,7 @@ const payloadSchemas = {
|
||||
|
||||
const requestSchemas = {
|
||||
ReferenceResourceListQuery: referenceResourceListQuerySchema,
|
||||
NoRequest: z.object({}).strict(),
|
||||
CreateReferenceResourceCommand: z
|
||||
.object({
|
||||
name: z.string().trim().min(1).max(120),
|
||||
|
||||
@@ -0,0 +1,128 @@
|
||||
import type { Meta, StoryObj } from "@storybook/react-vite";
|
||||
import { expect, userEvent, within } from "storybook/test";
|
||||
import { useState } from "react";
|
||||
|
||||
import {
|
||||
Alert,
|
||||
Badge,
|
||||
Button,
|
||||
Card,
|
||||
Dialog,
|
||||
Menu,
|
||||
ProgressBar,
|
||||
Skeleton,
|
||||
Tabs,
|
||||
TextArea,
|
||||
TextField,
|
||||
} from "./index.js";
|
||||
|
||||
const meta = {
|
||||
title: "Platform/Design System",
|
||||
component: Button,
|
||||
tags: ["autodocs"],
|
||||
parameters: {
|
||||
layout: "padded",
|
||||
},
|
||||
} satisfies Meta<typeof Button>;
|
||||
|
||||
export default meta;
|
||||
type Story = StoryObj<typeof meta>;
|
||||
|
||||
export const Primitives: Story = {
|
||||
render: () => (
|
||||
<div className="ui-stack">
|
||||
<Card title="Actions and status">
|
||||
<div className="ui-cluster">
|
||||
<Button>Primary</Button>
|
||||
<Button variant="secondary">Secondary</Button>
|
||||
<Button variant="danger">Danger</Button>
|
||||
<Button pending pendingLabel="Processing">
|
||||
Save
|
||||
</Button>
|
||||
</div>
|
||||
<div className="ui-cluster">
|
||||
<Badge variant="neutral">Neutral</Badge>
|
||||
<Badge variant="success">Success</Badge>
|
||||
<Badge variant="warning">Warning</Badge>
|
||||
<Badge variant="danger">Danger</Badge>
|
||||
</div>
|
||||
</Card>
|
||||
<TextField
|
||||
description="A stable accessible description"
|
||||
label="Name"
|
||||
placeholder="Example"
|
||||
/>
|
||||
<TextField error="Enter a name" label="Invalid name" value="" readOnly />
|
||||
<TextArea
|
||||
defaultValue="Long-form content"
|
||||
label="Notes"
|
||||
maxLength={100}
|
||||
/>
|
||||
<Alert title="Platform status" variant="info">
|
||||
The component workshop uses the same tokens and providers as the app.
|
||||
</Alert>
|
||||
<ProgressBar label="Build readiness" value={72} />
|
||||
<Skeleton label="Loading example" />
|
||||
</div>
|
||||
),
|
||||
};
|
||||
|
||||
function OverlayExample() {
|
||||
const [open, setOpen] = useState(false);
|
||||
return (
|
||||
<div className="ui-stack">
|
||||
<Button onClick={() => setOpen(true)}>Open dialog</Button>
|
||||
<Dialog
|
||||
actions={<Button onClick={() => setOpen(false)}>Confirm</Button>}
|
||||
onClose={() => setOpen(false)}
|
||||
open={open}
|
||||
title="Confirm platform action"
|
||||
>
|
||||
Keyboard dismissal must restore focus to the trigger.
|
||||
</Dialog>
|
||||
<Menu
|
||||
items={[
|
||||
{ id: "first", label: "First action", onSelect() {} },
|
||||
{ id: "second", label: "Second action", onSelect() {} },
|
||||
]}
|
||||
triggerLabel="Open menu"
|
||||
/>
|
||||
<Tabs
|
||||
defaultValue="one"
|
||||
label="Example sections"
|
||||
tabs={[
|
||||
{ id: "one", label: "One", panel: "First panel" },
|
||||
{ id: "two", label: "Two", panel: "Second panel" },
|
||||
]}
|
||||
/>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
export const OverlayInteraction: Story = {
|
||||
render: () => <OverlayExample />,
|
||||
play: async ({ canvasElement }) => {
|
||||
const canvas = within(canvasElement);
|
||||
const trigger = canvas.getByRole("button", { name: "Open dialog" });
|
||||
await userEvent.click(trigger);
|
||||
const dialog = within(document.body).getByRole("dialog", {
|
||||
name: "Confirm platform action",
|
||||
});
|
||||
await expect(dialog).toBeVisible();
|
||||
await userEvent.keyboard("{Escape}");
|
||||
await expect(dialog).not.toBeVisible();
|
||||
await expect(trigger).toHaveFocus();
|
||||
},
|
||||
};
|
||||
|
||||
export const LongPseudoLikeContent: Story = {
|
||||
render: () => (
|
||||
<Card title="[!! Ćømƥøñëñţ ţøķëñ åñđ ļøñğ ţëжţ vëŕïƒïćåţïøñ !!]">
|
||||
<p>
|
||||
[!! Ţhïš šţøŕÿ vëŕïƒïëš ţhåţ å ƥŕïmïţïvë ŕëmåïñš ŕëåđåɓļë
|
||||
ïñ å ćømƥåćţ ćøñţåïñëŕ. !!]
|
||||
</p>
|
||||
<Button>[!! Ćøñţïñüë !!]</Button>
|
||||
</Card>
|
||||
),
|
||||
};
|
||||
@@ -341,6 +341,7 @@ export const Dialog = forwardRef<HTMLDialogElement, DialogProps>(
|
||||
const { message } = useLocale();
|
||||
const dialogRef = useRef<HTMLDialogElement | null>(null);
|
||||
const previousFocusRef = useRef<HTMLElement | null>(null);
|
||||
const focusRestoreGenerationRef = useRef(0);
|
||||
const titleId = useId();
|
||||
const descriptionId = useId();
|
||||
useImperativeHandle(forwardedRef, () => dialogRef.current!, []);
|
||||
@@ -348,6 +349,8 @@ export const Dialog = forwardRef<HTMLDialogElement, DialogProps>(
|
||||
useEffect(() => {
|
||||
const dialog = dialogRef.current;
|
||||
if (!dialog) return;
|
||||
const generation = focusRestoreGenerationRef.current + 1;
|
||||
focusRestoreGenerationRef.current = generation;
|
||||
|
||||
if (open) {
|
||||
previousFocusRef.current =
|
||||
@@ -371,9 +374,19 @@ export const Dialog = forwardRef<HTMLDialogElement, DialogProps>(
|
||||
}
|
||||
const previousFocus = previousFocusRef.current;
|
||||
previousFocusRef.current = null;
|
||||
queueMicrotask(() => {
|
||||
if (previousFocus?.isConnected) previousFocus.focus();
|
||||
});
|
||||
const restoreFocus = () => {
|
||||
if (
|
||||
focusRestoreGenerationRef.current === generation &&
|
||||
previousFocus?.isConnected
|
||||
) {
|
||||
previousFocus.focus();
|
||||
}
|
||||
};
|
||||
if (typeof globalThis.requestAnimationFrame === "function") {
|
||||
const frame = globalThis.requestAnimationFrame(restoreFocus);
|
||||
return () => globalThis.cancelAnimationFrame(frame);
|
||||
}
|
||||
queueMicrotask(restoreFocus);
|
||||
}, [open]);
|
||||
|
||||
return (
|
||||
|
||||
@@ -105,9 +105,16 @@ function InvalidRouteSurface({ code }: { code: string }) {
|
||||
);
|
||||
}
|
||||
|
||||
function RouteLifecycle({ definition }: { definition: RouteDefinition }) {
|
||||
function RouteLifecycle({
|
||||
definition,
|
||||
buildId,
|
||||
}: {
|
||||
definition: RouteDefinition;
|
||||
buildId: string;
|
||||
}) {
|
||||
const location = useLocation();
|
||||
const { message, resolve } = useLocale();
|
||||
const { diagnostics } = useApplication();
|
||||
useEffect(() => {
|
||||
document.title = message("route.documentTitle", {
|
||||
title: resolve(`route.${definition.routeId}.title`),
|
||||
@@ -122,7 +129,19 @@ function RouteLifecycle({ definition }: { definition: RouteDefinition }) {
|
||||
} catch {
|
||||
// Non-browser test hosts may not implement scrolling.
|
||||
}
|
||||
}, [definition, location.key, location.pathname, message, resolve]);
|
||||
diagnostics.reportRouteChanged({
|
||||
routeId: definition.routeId,
|
||||
buildId,
|
||||
});
|
||||
}, [
|
||||
buildId,
|
||||
definition,
|
||||
diagnostics,
|
||||
location.key,
|
||||
location.pathname,
|
||||
message,
|
||||
resolve,
|
||||
]);
|
||||
return null;
|
||||
}
|
||||
|
||||
@@ -244,7 +263,7 @@ function RegisteredRoute({
|
||||
const content = (
|
||||
<RouteInputContext.Provider value={parsed.data}>
|
||||
<CanonicalRouteRedirect input={parsed.data} />
|
||||
<RouteLifecycle definition={definition} />
|
||||
<RouteLifecycle definition={definition} buildId={buildId} />
|
||||
<Suspense fallback={<RouteLoadingSurface definition={definition} />}>
|
||||
<ChunkRecoveryBoundary
|
||||
chunkId={definition.chunkId}
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import AxeBuilder from "@axe-core/playwright";
|
||||
import { expect, test } from "@playwright/test";
|
||||
import { expect, test } from "../support/browser/strict-browser-test.js";
|
||||
import { ROUTE_REGISTRY } from "../../src/features/installed-feature-contracts.js";
|
||||
|
||||
for (const route of Object.values(ROUTE_REGISTRY).map((definition) => {
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
import { expect, test } from "@playwright/test";
|
||||
import { expect, test } from "../support/browser/strict-browser-test.js";
|
||||
import { successEnvelope } from "../mocks/contracts/envelopes.js";
|
||||
import { ROUTE_REGISTRY } from "../../src/features/installed-feature-contracts.js";
|
||||
|
||||
test("boots the public app shell", async ({ page }) => {
|
||||
@@ -32,6 +33,19 @@ test("opens the protected integration route through the local demo seam", async
|
||||
(definition) => definition.access === "integration-defined",
|
||||
);
|
||||
if (!protectedRoute) throw new Error("An integration route is required");
|
||||
await page.route(
|
||||
"http://localhost:8080/api/reference-resources?*",
|
||||
(route) =>
|
||||
route.fulfill({
|
||||
json: successEnvelope([
|
||||
{
|
||||
id: "browser-reference",
|
||||
name: "Browser reference",
|
||||
createdAt: "2026-07-26T00:00:00.000Z",
|
||||
},
|
||||
]),
|
||||
}),
|
||||
);
|
||||
await page.goto(protectedRoute.path);
|
||||
await expect(
|
||||
page.getByRole("heading", { name: "세션이 필요합니다." }),
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
import { expect, test } from "../support/browser/strict-browser-test.js";
|
||||
|
||||
test("boots and navigates the compact production shell", async ({ page }) => {
|
||||
await page.goto("/");
|
||||
await expect(page.getByRole("main")).toBeVisible();
|
||||
const menu = page.getByRole("button", { name: "메뉴", exact: true });
|
||||
await expect(menu).toHaveCSS("min-width", "44px");
|
||||
await menu.click();
|
||||
await expect(page.getByRole("navigation", { name: "주요 탐색" })).toBeVisible();
|
||||
await page.getByRole("link", { name: "UI 구성요소" }).click();
|
||||
await expect(page).toHaveURL(/\/examples\/ui$/);
|
||||
await expect(page.locator("html")).toHaveAttribute("data-build-id", "local-build");
|
||||
const overflow = await page.evaluate(
|
||||
() => document.documentElement.scrollWidth - window.innerWidth,
|
||||
);
|
||||
expect(overflow).toBeLessThanOrEqual(1);
|
||||
});
|
||||
@@ -1,4 +1,4 @@
|
||||
import { expect, test } from "@playwright/test";
|
||||
import { expect, test } from "../support/browser/strict-browser-test.js";
|
||||
|
||||
test("runs menu typeahead, tabs and duplicate toast interactions", async ({
|
||||
page,
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { expect, test } from "@playwright/test";
|
||||
import { expect, test } from "../support/browser/strict-browser-test.js";
|
||||
|
||||
test("switches the shell locale and keeps pseudo-locale copy within compact layout", async ({
|
||||
page,
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { expect, test } from "@playwright/test";
|
||||
import { expect, test } from "../support/browser/strict-browser-test.js";
|
||||
|
||||
/** @param {import("@playwright/test").Page} page */
|
||||
async function openReferenceForm(page) {
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { expect, test } from "@playwright/test";
|
||||
import { expect, test } from "../support/browser/strict-browser-test.js";
|
||||
|
||||
test("reflows the UI gallery at the 320px minimum without horizontal overflow", async ({
|
||||
page,
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import AxeBuilder from "@axe-core/playwright";
|
||||
import { expect, test } from "@playwright/test";
|
||||
import { expect, test } from "../support/browser/strict-browser-test.js";
|
||||
|
||||
test("persists an explicit color scheme through the storage contract", async ({
|
||||
page,
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { expect, test } from "@playwright/test";
|
||||
import { expect, test } from "../support/browser/strict-browser-test.js";
|
||||
|
||||
test("validates and reports the common text-field flow", async ({ page }) => {
|
||||
await page.goto("/examples/ui");
|
||||
|
||||
@@ -0,0 +1,67 @@
|
||||
import { describe, expect, it, vi } from "vitest";
|
||||
|
||||
import { createHttpClient } from "../../../src/adapters/http/client.js";
|
||||
import { createReferenceHttpGateway } from "../../../src/features/reference-feature/adapters/reference-http-gateway.js";
|
||||
import { createReferenceFeatureInput } from "../../../src/features/reference-feature/application/reference-feature-api.js";
|
||||
import { REFERENCE_FEATURE_CONTRACT } from "../../../src/features/reference-feature/contracts/reference-feature-contract.js";
|
||||
import { mapReferenceOperation } from "../../../src/features/reference-feature/contracts/reference-mapper.js";
|
||||
import {
|
||||
validateReferencePayload,
|
||||
validateReferenceRequest,
|
||||
} from "../../../src/features/reference-feature/contracts/reference-schemas.js";
|
||||
|
||||
describe("reference feature diagnostics correlation", () => {
|
||||
it("preserves route, operation and request correlation through the vertical path", async () => {
|
||||
const record = vi.fn();
|
||||
const operations =
|
||||
REFERENCE_FEATURE_CONTRACT.apiOperations as Readonly<
|
||||
Record<
|
||||
string,
|
||||
ReturnType<
|
||||
NonNullable<Parameters<typeof createHttpClient>[0]["getOperation"]>
|
||||
>
|
||||
>
|
||||
>;
|
||||
const client = createHttpClient({
|
||||
baseUrl: "https://api.test",
|
||||
fetcher: async () =>
|
||||
Response.json({
|
||||
success: true,
|
||||
data: [{ id: "reference-1", name: "Reference" }],
|
||||
meta: { requestId: "safe-request", traceId: "safe-trace" },
|
||||
}),
|
||||
getOperation(operationId) {
|
||||
const operation = operations[operationId];
|
||||
if (!operation) throw new Error("Unregistered reference operation");
|
||||
return operation;
|
||||
},
|
||||
validatePayload: validateReferencePayload,
|
||||
validateRequest: validateReferenceRequest,
|
||||
mapPayload: mapReferenceOperation,
|
||||
correlationIdFactory: () => "reference-correlation",
|
||||
diagnostics: { record },
|
||||
scheduler: {
|
||||
setTimeout: () => 1,
|
||||
clearTimeout: () => {},
|
||||
},
|
||||
});
|
||||
const application = createReferenceFeatureInput(
|
||||
createReferenceHttpGateway(client),
|
||||
);
|
||||
|
||||
await expect(
|
||||
application.listResources({ limit: 20 }),
|
||||
).resolves.toMatchObject({ ok: true });
|
||||
expect(record).toHaveBeenCalledOnce();
|
||||
expect(record).toHaveBeenCalledWith({
|
||||
level: "info",
|
||||
eventId: "http.request.completed",
|
||||
context: expect.objectContaining({
|
||||
route_id: "REFERENCE_RESOURCE_LIST",
|
||||
operation_id: "LIST_REFERENCE_RESOURCES",
|
||||
correlation_id: "reference-correlation",
|
||||
outcome: "success",
|
||||
}),
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -1,7 +1,5 @@
|
||||
// @vitest-environment jsdom
|
||||
|
||||
import { HttpResponse, http } from "msw";
|
||||
import { setupServer } from "msw/node";
|
||||
import { render, screen } from "@testing-library/react";
|
||||
import userEvent from "@testing-library/user-event";
|
||||
import {
|
||||
@@ -16,6 +14,9 @@ import {
|
||||
|
||||
import { createRuntimeComposition } from "../../../src/bootstrap/create-runtime-composition.js";
|
||||
import { RuntimeApplication } from "../../../src/bootstrap/runtime-application.jsx";
|
||||
import { createBootstrapHandlers } from "../../mocks/handlers/bootstrap.js";
|
||||
import { createReferenceScenarioHandlers } from "../../mocks/handlers/reference-resources.js";
|
||||
import { createStrictMockServer } from "../../mocks/server.js";
|
||||
|
||||
const runtimeConfig = {
|
||||
APP_ENV: "local",
|
||||
@@ -56,41 +57,23 @@ const releaseManifest = {
|
||||
const listRequests = vi.fn();
|
||||
const createRequests = vi.fn();
|
||||
const resources = [{ id: "reference-1", name: "Existing" }];
|
||||
const server = setupServer(
|
||||
http.get("http://app.test/config.json", () =>
|
||||
HttpResponse.json(runtimeConfig),
|
||||
),
|
||||
http.get("http://app.test/release-manifest.json", () =>
|
||||
HttpResponse.json(releaseManifest),
|
||||
),
|
||||
http.get("https://api.test/api/reference-resources", ({ request }) => {
|
||||
listRequests(new URL(request.url).search);
|
||||
return HttpResponse.json({
|
||||
success: true,
|
||||
data: resources,
|
||||
meta: { requestId: "request-list", traceId: "trace-list" },
|
||||
});
|
||||
}),
|
||||
http.post("https://api.test/api/reference-resources", async ({ request }) => {
|
||||
const body = (await request.json()) as { name: string };
|
||||
createRequests(body);
|
||||
const created = { id: "reference-created", name: body.name };
|
||||
resources.push(created);
|
||||
return HttpResponse.json({
|
||||
success: true,
|
||||
data: created,
|
||||
meta: { requestId: "request-create", traceId: "trace-create" },
|
||||
});
|
||||
const mockApi = createStrictMockServer(
|
||||
...createBootstrapHandlers(runtimeConfig, releaseManifest),
|
||||
...createReferenceScenarioHandlers({
|
||||
resources,
|
||||
onList: listRequests,
|
||||
onCreate: createRequests,
|
||||
}),
|
||||
);
|
||||
|
||||
beforeAll(() => server.listen({ onUnhandledRequest: "error" }));
|
||||
beforeAll(mockApi.listen);
|
||||
afterEach(() => {
|
||||
mockApi.reset();
|
||||
listRequests.mockClear();
|
||||
createRequests.mockClear();
|
||||
resources.splice(1);
|
||||
});
|
||||
afterAll(() => server.close());
|
||||
afterAll(mockApi.close);
|
||||
|
||||
const absoluteFetch: typeof fetch = (input, init) => {
|
||||
if (input instanceof Request) return fetch(input, init);
|
||||
|
||||
@@ -0,0 +1,3 @@
|
||||
export function leakToConsole(token: string) {
|
||||
console.error("UNKNOWN_DIAGNOSTIC_EVENT", token);
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
export function leakSensitiveContext(telemetry: {
|
||||
emit(eventName: string, context: Record<string, unknown>): void;
|
||||
}) {
|
||||
telemetry.emit("api.request.failed", {
|
||||
authorization: "Bearer secret",
|
||||
request_body: { email: "private@example.test" },
|
||||
});
|
||||
}
|
||||
@@ -0,0 +1,225 @@
|
||||
{
|
||||
"schemaVersion": 1,
|
||||
"cases": [
|
||||
{
|
||||
"id": "ordering-only",
|
||||
"expected": "none",
|
||||
"before": {
|
||||
"schemaVersion": 2,
|
||||
"registries": [
|
||||
{
|
||||
"registryId": "FE-REG-TEST",
|
||||
"contract": { "breakingFields": ["path"] },
|
||||
"rows": {
|
||||
"A": { "path": "/a", "tags": ["one", "two"] },
|
||||
"B": { "path": "/b", "tags": ["three"] }
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"after": {
|
||||
"registries": [
|
||||
{
|
||||
"rows": {
|
||||
"B": { "tags": ["three"], "path": "/b" },
|
||||
"A": { "tags": ["two", "one"], "path": "/a" }
|
||||
},
|
||||
"contract": { "breakingFields": ["path"] },
|
||||
"registryId": "FE-REG-TEST"
|
||||
}
|
||||
],
|
||||
"schemaVersion": 2
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "row-addition",
|
||||
"expected": "additive",
|
||||
"before": {
|
||||
"schemaVersion": 2,
|
||||
"registries": [
|
||||
{
|
||||
"registryId": "FE-REG-TEST",
|
||||
"contract": { "breakingFields": ["path"] },
|
||||
"rows": { "A": { "path": "/a" } }
|
||||
}
|
||||
]
|
||||
},
|
||||
"after": {
|
||||
"schemaVersion": 2,
|
||||
"registries": [
|
||||
{
|
||||
"registryId": "FE-REG-TEST",
|
||||
"contract": { "breakingFields": ["path"] },
|
||||
"rows": {
|
||||
"A": { "path": "/a" },
|
||||
"B": { "path": "/b" }
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "behavior-change",
|
||||
"expected": "behavior-change",
|
||||
"before": {
|
||||
"schemaVersion": 2,
|
||||
"registries": [
|
||||
{
|
||||
"registryId": "FE-REG-TEST",
|
||||
"contract": { "breakingFields": ["path"] },
|
||||
"rows": { "A": { "path": "/a", "owner": "one" } }
|
||||
}
|
||||
]
|
||||
},
|
||||
"after": {
|
||||
"schemaVersion": 2,
|
||||
"registries": [
|
||||
{
|
||||
"registryId": "FE-REG-TEST",
|
||||
"contract": { "breakingFields": ["path"] },
|
||||
"rows": { "A": { "path": "/a", "owner": "two" } }
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "row-removal",
|
||||
"expected": "breaking",
|
||||
"before": {
|
||||
"schemaVersion": 2,
|
||||
"registries": [
|
||||
{
|
||||
"registryId": "FE-REG-TEST",
|
||||
"contract": { "breakingFields": ["path"] },
|
||||
"rows": {
|
||||
"A": { "path": "/a" },
|
||||
"B": { "path": "/b" }
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"after": {
|
||||
"schemaVersion": 2,
|
||||
"registries": [
|
||||
{
|
||||
"registryId": "FE-REG-TEST",
|
||||
"contract": { "breakingFields": ["path"] },
|
||||
"rows": { "A": { "path": "/a" } }
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "field-type-narrowing",
|
||||
"expected": "breaking",
|
||||
"before": {
|
||||
"schemaVersion": 2,
|
||||
"registries": [
|
||||
{
|
||||
"registryId": "FE-REG-TEST",
|
||||
"contract": { "breakingFields": ["path"] },
|
||||
"rows": { "A": { "limit": 10 } }
|
||||
}
|
||||
]
|
||||
},
|
||||
"after": {
|
||||
"schemaVersion": 2,
|
||||
"registries": [
|
||||
{
|
||||
"registryId": "FE-REG-TEST",
|
||||
"contract": { "breakingFields": ["path"] },
|
||||
"rows": { "A": { "limit": "10" } }
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "route-path-change",
|
||||
"expected": "breaking",
|
||||
"before": {
|
||||
"schemaVersion": 2,
|
||||
"registries": [
|
||||
{
|
||||
"registryId": "FE-REG-TEST",
|
||||
"contract": { "breakingFields": ["path"] },
|
||||
"rows": { "A": { "path": "/before" } }
|
||||
}
|
||||
]
|
||||
},
|
||||
"after": {
|
||||
"schemaVersion": 2,
|
||||
"registries": [
|
||||
{
|
||||
"registryId": "FE-REG-TEST",
|
||||
"contract": { "breakingFields": ["path"] },
|
||||
"rows": { "A": { "path": "/after" } }
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "registry-contract-narrowing",
|
||||
"expected": "breaking",
|
||||
"before": {
|
||||
"schemaVersion": 2,
|
||||
"registries": [
|
||||
{
|
||||
"registryId": "FE-REG-TEST",
|
||||
"contract": {
|
||||
"breakingFields": ["path"],
|
||||
"allowedValues": { "kind": ["one", "two"] }
|
||||
},
|
||||
"rows": { "A": { "path": "/a", "kind": "one" } }
|
||||
}
|
||||
]
|
||||
},
|
||||
"after": {
|
||||
"schemaVersion": 2,
|
||||
"registries": [
|
||||
{
|
||||
"registryId": "FE-REG-TEST",
|
||||
"contract": {
|
||||
"breakingFields": ["path"],
|
||||
"allowedValues": { "kind": ["one"] }
|
||||
},
|
||||
"rows": { "A": { "path": "/a", "kind": "one" } }
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
],
|
||||
"breakingEvidence": {
|
||||
"before": {
|
||||
"schemaVersion": 2,
|
||||
"registries": [
|
||||
{
|
||||
"registryId": "FE-REG-TEST",
|
||||
"contract": { "breakingFields": ["path"] },
|
||||
"rows": { "A": { "path": "/before" } }
|
||||
}
|
||||
]
|
||||
},
|
||||
"after": {
|
||||
"schemaVersion": 2,
|
||||
"registries": [
|
||||
{
|
||||
"registryId": "FE-REG-TEST",
|
||||
"contract": { "breakingFields": ["path"] },
|
||||
"rows": { "A": { "path": "/after" } }
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"tamperedApproval": {
|
||||
"snapshot": {
|
||||
"schemaVersion": 2,
|
||||
"registries": []
|
||||
},
|
||||
"approval": {
|
||||
"schemaVersion": 1,
|
||||
"snapshotDigest": "tampered",
|
||||
"owner": "fixture-owner",
|
||||
"approvedAt": "2026-07-26T00:00:00.000Z"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"schemaVersion": 1,
|
||||
"snapshotDigest": "0000000000000000000000000000000000000000000000000000000000000000",
|
||||
"owner": "negative-fixture",
|
||||
"approvedAt": "2026-07-26T00:00:00.000Z"
|
||||
}
|
||||
@@ -0,0 +1,5 @@
|
||||
test("false visual pass", async ({ page }) => {
|
||||
await expect(page).toHaveScreenshot({
|
||||
mask: [page.locator("body")]
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1 @@
|
||||
test.skip("unowned indefinite quarantine", async () => {});
|
||||
@@ -0,0 +1,11 @@
|
||||
import type { DiagnosticsPort } from "../../../src/application/ports/diagnostics-port.js";
|
||||
import type { TelemetryPort } from "../../../src/application/ports/telemetry-port.js";
|
||||
|
||||
declare const diagnostics: DiagnosticsPort;
|
||||
declare const telemetry: TelemetryPort;
|
||||
|
||||
diagnostics.record({
|
||||
level: "fatal",
|
||||
eventId: "UNKNOWN_DIAGNOSTIC_EVENT",
|
||||
});
|
||||
telemetry.emit("unknown.telemetry.event", {});
|
||||
@@ -5,7 +5,8 @@ import { createApplication } from "../../src/application/create-application.js";
|
||||
* @param {{
|
||||
* session?: import("../../src/application/ports/auth-session-port.js").AuthSessionPort,
|
||||
* preferences?: import("../../src/application/ports/storage-port.js").StoragePort,
|
||||
* diagnostics?: import("../../src/application/ports/telemetry-port.js").TelemetryPort,
|
||||
* diagnostics?: import("../../src/application/ports/diagnostics-port.js").DiagnosticsPort,
|
||||
* telemetry?: import("../../src/application/ports/telemetry-port.js").TelemetryPort,
|
||||
* releaseInfo?: import("../../src/application/ports/release-info-port.js").ReleaseInfoPort,
|
||||
* navigation?: { reload(): void },
|
||||
* featureInputs?: Readonly<Record<string, unknown>>
|
||||
@@ -22,7 +23,8 @@ export function createTestApplication(overrides = {}) {
|
||||
write: () => ({ ok: /** @type {const} */ (true) }),
|
||||
remove: () => ({ ok: /** @type {const} */ (true) }),
|
||||
},
|
||||
diagnostics: overrides.diagnostics ?? { emit: () => {} },
|
||||
diagnostics: overrides.diagnostics ?? { record: () => {} },
|
||||
telemetry: overrides.telemetry ?? { emit: () => {} },
|
||||
releaseInfo:
|
||||
overrides.releaseInfo ??
|
||||
{
|
||||
|
||||
@@ -0,0 +1,193 @@
|
||||
import { describe, expect, it, vi } from "vitest";
|
||||
|
||||
import { createHttpClient } from "../../src/adapters/http/client.js";
|
||||
import type { DiagnosticRecordInput } from "../../src/contracts/diagnostics.js";
|
||||
import { TEST_HTTP_CONTRACT } from "../helpers/http-contract-fixture.js";
|
||||
|
||||
function successResponse(data: unknown) {
|
||||
return Response.json({
|
||||
success: true,
|
||||
data,
|
||||
meta: { requestId: "request-1", traceId: "trace-1" },
|
||||
});
|
||||
}
|
||||
|
||||
function failureResponse(status: number) {
|
||||
return Response.json(
|
||||
{
|
||||
success: false,
|
||||
error: { code: "TEMPORARY" },
|
||||
meta: { requestId: "request-1", traceId: "trace-1" },
|
||||
},
|
||||
{ status },
|
||||
);
|
||||
}
|
||||
|
||||
type EmittedEvent = Readonly<{
|
||||
eventName: string;
|
||||
attributes: Readonly<Record<string, unknown>>;
|
||||
}>;
|
||||
|
||||
function harness(fetcher: typeof fetch, maxRetryAttempts = 1) {
|
||||
const records: DiagnosticRecordInput[] = [];
|
||||
const emitted: EmittedEvent[] = [];
|
||||
let currentTime = 0;
|
||||
const client = createHttpClient({
|
||||
...TEST_HTTP_CONTRACT,
|
||||
baseUrl: "https://api.test",
|
||||
fetcher,
|
||||
maxRetryAttempts,
|
||||
clock: {
|
||||
now: () => currentTime,
|
||||
sleep: async () => {
|
||||
currentTime += 150;
|
||||
},
|
||||
},
|
||||
scheduler: {
|
||||
setTimeout: () => 1,
|
||||
clearTimeout: () => {},
|
||||
},
|
||||
correlationIdFactory: () => "correlation-fixed",
|
||||
diagnostics: {
|
||||
record(input) {
|
||||
records.push(structuredClone(input));
|
||||
},
|
||||
},
|
||||
telemetry: {
|
||||
emit(eventName, attributes) {
|
||||
emitted.push({
|
||||
eventName,
|
||||
attributes: structuredClone(attributes),
|
||||
});
|
||||
},
|
||||
},
|
||||
});
|
||||
return { client, records, emitted };
|
||||
}
|
||||
|
||||
describe("HTTP diagnostics and terminal telemetry", () => {
|
||||
it("records one successful reference route outcome and no failure event", async () => {
|
||||
const { client, records, emitted } = harness(
|
||||
vi.fn(async () => successResponse([])),
|
||||
);
|
||||
|
||||
await expect(
|
||||
client.execute({
|
||||
operationId: "LIST_ENTITIES",
|
||||
routeId: "TEST_ROUTE",
|
||||
}),
|
||||
).resolves.toMatchObject({ ok: true });
|
||||
|
||||
expect(records).toEqual([
|
||||
{
|
||||
level: "info",
|
||||
eventId: "http.request.completed",
|
||||
context: {
|
||||
route_id: "TEST_ROUTE",
|
||||
operation_id: "LIST_ENTITIES",
|
||||
correlation_id: "correlation-fixed",
|
||||
outcome: "success",
|
||||
error_kind: "NONE",
|
||||
http_status_group: "none",
|
||||
attempt_count_bucket: "1",
|
||||
duration_bucket: "lt100ms",
|
||||
},
|
||||
},
|
||||
]);
|
||||
expect(emitted).toEqual([]);
|
||||
});
|
||||
|
||||
it("summarizes retry recovery once without a terminal failure event", async () => {
|
||||
const fetcher = vi
|
||||
.fn<typeof fetch>()
|
||||
.mockResolvedValueOnce(failureResponse(503))
|
||||
.mockResolvedValueOnce(successResponse([]));
|
||||
const { client, records, emitted } = harness(fetcher);
|
||||
|
||||
await expect(
|
||||
client.execute({
|
||||
operationId: "LIST_ENTITIES",
|
||||
routeId: "TEST_ROUTE",
|
||||
}),
|
||||
).resolves.toMatchObject({ ok: true });
|
||||
|
||||
expect(fetcher).toHaveBeenCalledTimes(2);
|
||||
expect(records).toHaveLength(1);
|
||||
expect(records[0]).toMatchObject({
|
||||
eventId: "http.request.completed",
|
||||
context: {
|
||||
outcome: "recovered",
|
||||
correlation_id: "correlation-fixed",
|
||||
duration_bucket: "100-499ms",
|
||||
},
|
||||
});
|
||||
expect(emitted).toEqual([]);
|
||||
});
|
||||
|
||||
it("emits one bounded terminal failure after all attempts", async () => {
|
||||
const fetcher = vi.fn(async () => failureResponse(503));
|
||||
const { client, records, emitted } = harness(fetcher);
|
||||
|
||||
await expect(
|
||||
client.execute({
|
||||
operationId: "CREATE_ENTITY",
|
||||
routeId: "TEST_ROUTE",
|
||||
body: { name: "private user input" },
|
||||
idempotencyKey: "private-idempotency-key",
|
||||
}),
|
||||
).resolves.toMatchObject({
|
||||
ok: false,
|
||||
error: { kind: "SERVER_FAILURE" },
|
||||
});
|
||||
|
||||
expect(fetcher).toHaveBeenCalledTimes(2);
|
||||
expect(records).toHaveLength(1);
|
||||
expect(emitted).toEqual([
|
||||
{
|
||||
eventName: "api.request.failed",
|
||||
attributes: {
|
||||
error_kind: "SERVER_FAILURE",
|
||||
http_status_group: "5xx",
|
||||
attempt_count_bucket: "2",
|
||||
route_id: "TEST_ROUTE",
|
||||
operation_id: "CREATE_ENTITY",
|
||||
duration_bucket: "100-499ms",
|
||||
},
|
||||
},
|
||||
]);
|
||||
expect(JSON.stringify({ records, emitted })).not.toMatch(
|
||||
/private user input|private-idempotency-key/,
|
||||
);
|
||||
});
|
||||
|
||||
it("records navigation abort without failure telemetry", async () => {
|
||||
const caller = new AbortController();
|
||||
caller.abort("navigation");
|
||||
const fetcher = vi.fn(async (request: RequestInfo | URL) => {
|
||||
const signal = (request as Request).signal;
|
||||
if (signal.aborted) throw new DOMException("aborted", "AbortError");
|
||||
return successResponse([]);
|
||||
});
|
||||
const { client, records, emitted } = harness(
|
||||
fetcher as unknown as typeof fetch,
|
||||
);
|
||||
|
||||
await expect(
|
||||
client.execute({
|
||||
operationId: "LIST_ENTITIES",
|
||||
routeId: "TEST_ROUTE",
|
||||
signal: caller.signal,
|
||||
}),
|
||||
).resolves.toMatchObject({
|
||||
ok: false,
|
||||
error: { kind: "REQUEST_ABORTED" },
|
||||
});
|
||||
|
||||
expect(records).toHaveLength(1);
|
||||
expect(records[0]).toMatchObject({
|
||||
eventId: "http.request.completed",
|
||||
context: { outcome: "aborted", error_kind: "REQUEST_ABORTED" },
|
||||
});
|
||||
expect(emitted).toEqual([]);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,30 @@
|
||||
export function successEnvelope<Value>(
|
||||
data: Value,
|
||||
requestId = "fixture-request",
|
||||
) {
|
||||
return Object.freeze({
|
||||
success: true as const,
|
||||
data: structuredClone(data),
|
||||
meta: Object.freeze({
|
||||
requestId,
|
||||
traceId: "fixture-trace",
|
||||
}),
|
||||
});
|
||||
}
|
||||
|
||||
export function failureEnvelope(
|
||||
code: string,
|
||||
details?: Readonly<Record<string, unknown>>,
|
||||
) {
|
||||
return Object.freeze({
|
||||
success: false as const,
|
||||
error: Object.freeze({
|
||||
code,
|
||||
...(details ? { details: structuredClone(details) } : {}),
|
||||
}),
|
||||
meta: Object.freeze({
|
||||
requestId: "fixture-request",
|
||||
traceId: "fixture-trace",
|
||||
}),
|
||||
});
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
import { http, HttpResponse } from "msw";
|
||||
|
||||
export function createBootstrapHandlers(
|
||||
runtimeConfig: Readonly<Record<string, unknown>>,
|
||||
releaseManifest: Readonly<Record<string, unknown>>,
|
||||
baseUrl = "http://app.test",
|
||||
) {
|
||||
return [
|
||||
http.get(`${baseUrl}/config.json`, () =>
|
||||
HttpResponse.json(structuredClone(runtimeConfig)),
|
||||
),
|
||||
http.get(`${baseUrl}/release-manifest.json`, () =>
|
||||
HttpResponse.json(structuredClone(releaseManifest)),
|
||||
),
|
||||
] as const;
|
||||
}
|
||||
@@ -0,0 +1,171 @@
|
||||
import { delay, http, HttpResponse } from "msw";
|
||||
|
||||
import {
|
||||
failureEnvelope,
|
||||
successEnvelope,
|
||||
} from "../contracts/envelopes.js";
|
||||
import type { HttpScenarioId } from "../scenarios/catalog.js";
|
||||
import { assertOperationScenario } from "../scenarios/catalog.js";
|
||||
|
||||
export type ReferenceResourceFixture = Readonly<{
|
||||
id: string;
|
||||
name: string;
|
||||
createdAt?: string;
|
||||
}>;
|
||||
|
||||
type ScenarioOptions = Readonly<{
|
||||
baseUrl?: string;
|
||||
scenarios?: Partial<
|
||||
Record<
|
||||
| "LIST_REFERENCE_RESOURCES"
|
||||
| "CREATE_REFERENCE_RESOURCE"
|
||||
| "GET_REFERENCE_RESOURCE",
|
||||
HttpScenarioId
|
||||
>
|
||||
>;
|
||||
resources?: ReferenceResourceFixture[];
|
||||
onList?(search: string): void;
|
||||
onCreate?(body: Readonly<Record<string, unknown>>): void;
|
||||
}>;
|
||||
|
||||
const DEFAULT_RESOURCE = Object.freeze({
|
||||
id: "reference-1",
|
||||
name: "Reference",
|
||||
createdAt: "2026-07-26T00:00:00.000Z",
|
||||
});
|
||||
|
||||
async function scenarioResponse(
|
||||
scenario: HttpScenarioId,
|
||||
payload: unknown,
|
||||
attempt: number,
|
||||
) {
|
||||
if (scenario === "slow") await delay(50);
|
||||
if (scenario === "timeout") await delay(30_000);
|
||||
if (scenario === "network-error") return HttpResponse.error();
|
||||
if (scenario === "content-type-mismatch") {
|
||||
return new HttpResponse("<html>not json</html>", {
|
||||
headers: { "Content-Type": "text/html" },
|
||||
});
|
||||
}
|
||||
if (scenario === "malformed-json") {
|
||||
return new HttpResponse("{invalid", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
});
|
||||
}
|
||||
if (scenario === "envelope-mismatch") {
|
||||
return HttpResponse.json({ data: payload });
|
||||
}
|
||||
if (scenario === "schema-mismatch") {
|
||||
return HttpResponse.json(successEnvelope({ unexpected: true }));
|
||||
}
|
||||
if (
|
||||
scenario === "auth-persistent-401" ||
|
||||
(scenario === "auth-recover-once" && attempt === 1)
|
||||
) {
|
||||
return HttpResponse.json(failureEnvelope("AUTH_REQUIRED"), {
|
||||
status: 401,
|
||||
});
|
||||
}
|
||||
if (scenario === "forbidden-403") {
|
||||
return HttpResponse.json(failureEnvelope("FORBIDDEN"), { status: 403 });
|
||||
}
|
||||
if (scenario === "not-found-404") {
|
||||
return HttpResponse.json(failureEnvelope("NOT_FOUND"), { status: 404 });
|
||||
}
|
||||
if (scenario === "conflict-409") {
|
||||
return HttpResponse.json(failureEnvelope("CONFLICT"), { status: 409 });
|
||||
}
|
||||
if (scenario === "validation-422") {
|
||||
return HttpResponse.json(
|
||||
failureEnvelope("VALIDATION_REJECTED", {
|
||||
issues: [{ path: "name", code: "too_small" }],
|
||||
}),
|
||||
{ status: 422 },
|
||||
);
|
||||
}
|
||||
if (scenario === "rate-limited-429") {
|
||||
return HttpResponse.json(failureEnvelope("RATE_LIMITED"), {
|
||||
status: 429,
|
||||
headers: { "Retry-After": "1" },
|
||||
});
|
||||
}
|
||||
if (
|
||||
scenario === "server-terminal-500" ||
|
||||
(scenario === "server-retry-success" && attempt === 1)
|
||||
) {
|
||||
return HttpResponse.json(failureEnvelope("SERVER_FAILURE"), {
|
||||
status: 503,
|
||||
});
|
||||
}
|
||||
return HttpResponse.json(successEnvelope(payload));
|
||||
}
|
||||
|
||||
export function createReferenceScenarioHandlers(options: ScenarioOptions = {}) {
|
||||
const baseUrl = options.baseUrl ?? "https://api.test";
|
||||
const resources = options.resources ?? [{ ...DEFAULT_RESOURCE }];
|
||||
const attempts = new Map<string, number>();
|
||||
const scenarioFor = (
|
||||
operationId: keyof NonNullable<ScenarioOptions["scenarios"]>,
|
||||
) =>
|
||||
assertOperationScenario(
|
||||
operationId,
|
||||
options.scenarios?.[operationId] ?? "success",
|
||||
);
|
||||
const nextAttempt = (operationId: string) => {
|
||||
const next = (attempts.get(operationId) ?? 0) + 1;
|
||||
attempts.set(operationId, next);
|
||||
return next;
|
||||
};
|
||||
|
||||
return [
|
||||
http.get(`${baseUrl}/api/reference-resources`, ({ request }) => {
|
||||
options.onList?.(new URL(request.url).search);
|
||||
const scenario = scenarioFor("LIST_REFERENCE_RESOURCES");
|
||||
const payload = scenario === "empty" ? [] : resources;
|
||||
return scenarioResponse(
|
||||
scenario,
|
||||
payload,
|
||||
nextAttempt("LIST_REFERENCE_RESOURCES"),
|
||||
);
|
||||
}),
|
||||
http.post(
|
||||
`${baseUrl}/api/reference-resources`,
|
||||
async ({ request }) => {
|
||||
const rawBody = await request.json();
|
||||
const body =
|
||||
rawBody &&
|
||||
typeof rawBody === "object" &&
|
||||
!Array.isArray(rawBody)
|
||||
? (rawBody as Readonly<Record<string, unknown>>)
|
||||
: {};
|
||||
options.onCreate?.(body);
|
||||
const scenario = scenarioFor("CREATE_REFERENCE_RESOURCE");
|
||||
const created = {
|
||||
id: "reference-created",
|
||||
name: String(body.name ?? "Created"),
|
||||
createdAt: "2026-07-26T00:00:00.000Z",
|
||||
};
|
||||
if (scenario === "success") resources.push(created);
|
||||
return scenarioResponse(
|
||||
scenario,
|
||||
created,
|
||||
nextAttempt("CREATE_REFERENCE_RESOURCE"),
|
||||
);
|
||||
},
|
||||
),
|
||||
http.get(
|
||||
`${baseUrl}/api/reference-resources/:resourceId`,
|
||||
({ params }) => {
|
||||
const scenario = scenarioFor("GET_REFERENCE_RESOURCE");
|
||||
const resource =
|
||||
resources.find((entry) => entry.id === params.resourceId) ??
|
||||
DEFAULT_RESOURCE;
|
||||
return scenarioResponse(
|
||||
scenario,
|
||||
resource,
|
||||
nextAttempt("GET_REFERENCE_RESOURCE"),
|
||||
);
|
||||
},
|
||||
),
|
||||
] as const;
|
||||
}
|
||||
@@ -0,0 +1,45 @@
|
||||
export const HTTP_SCENARIO_IDS = Object.freeze([
|
||||
"success",
|
||||
"empty",
|
||||
"slow",
|
||||
"network-error",
|
||||
"timeout",
|
||||
"aborted",
|
||||
"content-type-mismatch",
|
||||
"malformed-json",
|
||||
"envelope-mismatch",
|
||||
"schema-mismatch",
|
||||
"auth-recover-once",
|
||||
"auth-persistent-401",
|
||||
"forbidden-403",
|
||||
"not-found-404",
|
||||
"conflict-409",
|
||||
"validation-422",
|
||||
"rate-limited-429",
|
||||
"server-retry-success",
|
||||
"server-terminal-500",
|
||||
] as const);
|
||||
|
||||
export type HttpScenarioId = (typeof HTTP_SCENARIO_IDS)[number];
|
||||
|
||||
export const OPERATION_SCENARIO_CATALOG = Object.freeze({
|
||||
LIST_REFERENCE_RESOURCES: HTTP_SCENARIO_IDS,
|
||||
CREATE_REFERENCE_RESOURCE: Object.freeze(
|
||||
HTTP_SCENARIO_IDS.filter(
|
||||
(scenario) => !["empty", "aborted"].includes(scenario),
|
||||
),
|
||||
),
|
||||
GET_REFERENCE_RESOURCE: HTTP_SCENARIO_IDS,
|
||||
} satisfies Readonly<Record<string, readonly HttpScenarioId[]>>);
|
||||
|
||||
export function assertOperationScenario(
|
||||
operationId: keyof typeof OPERATION_SCENARIO_CATALOG,
|
||||
scenario: HttpScenarioId,
|
||||
) {
|
||||
if (!OPERATION_SCENARIO_CATALOG[operationId].includes(scenario)) {
|
||||
throw new Error(
|
||||
`Scenario ${scenario} is not declared for ${operationId}`,
|
||||
);
|
||||
}
|
||||
return scenario;
|
||||
}
|
||||
@@ -0,0 +1,13 @@
|
||||
import { setupServer } from "msw/node";
|
||||
|
||||
export function createStrictMockServer(
|
||||
...handlers: Parameters<typeof setupServer>
|
||||
) {
|
||||
const server = setupServer(...handlers);
|
||||
return Object.freeze({
|
||||
server,
|
||||
listen: () => server.listen({ onUnhandledRequest: "error" }),
|
||||
reset: () => server.resetHandlers(),
|
||||
close: () => server.close(),
|
||||
});
|
||||
}
|
||||
@@ -0,0 +1,24 @@
|
||||
import AxeBuilder from "@axe-core/playwright";
|
||||
|
||||
import {
|
||||
expect,
|
||||
test,
|
||||
} from "../support/browser/strict-browser-test.js";
|
||||
|
||||
test("runs the isolated overlay interaction with blocking accessibility", async ({
|
||||
page,
|
||||
}) => {
|
||||
await page.goto(
|
||||
"/iframe.html?id=platform-design-system--overlay-interaction&viewMode=story",
|
||||
);
|
||||
const trigger = page.getByRole("button", { name: "Open dialog" });
|
||||
await expect(trigger).toBeVisible();
|
||||
await trigger.click();
|
||||
await expect(
|
||||
page.getByRole("dialog", { name: "Confirm platform action" }),
|
||||
).toBeVisible();
|
||||
const results = await new AxeBuilder({ page }).analyze();
|
||||
expect(results.violations).toEqual([]);
|
||||
await page.keyboard.press("Escape");
|
||||
await expect(trigger).toBeFocused();
|
||||
});
|
||||
@@ -0,0 +1,46 @@
|
||||
import {
|
||||
expect,
|
||||
test as base,
|
||||
type ConsoleMessage,
|
||||
type Page,
|
||||
} from "@playwright/test";
|
||||
|
||||
function ignoredConsole(message: ConsoleMessage) {
|
||||
return (
|
||||
message.type() === "warning" &&
|
||||
message.text().includes("NO_COLOR")
|
||||
);
|
||||
}
|
||||
|
||||
export const test = base.extend({
|
||||
page: async ({ page }, use) => {
|
||||
const failures: string[] = [];
|
||||
const onConsole = (message: ConsoleMessage) => {
|
||||
if (
|
||||
["error", "warning"].includes(message.type()) &&
|
||||
!ignoredConsole(message)
|
||||
) {
|
||||
failures.push(`console:${message.type()}:${message.text()}`);
|
||||
}
|
||||
};
|
||||
const onPageError = (error: Error) => {
|
||||
failures.push(`pageerror:${error.name}`);
|
||||
};
|
||||
const onRequestFailed = (request: import("@playwright/test").Request) => {
|
||||
failures.push(
|
||||
`requestfailed:${request.method()}:${new URL(request.url()).pathname}:${request.failure()?.errorText ?? "unknown"}`,
|
||||
);
|
||||
};
|
||||
page.on("console", onConsole);
|
||||
page.on("pageerror", onPageError);
|
||||
page.on("requestfailed", onRequestFailed);
|
||||
await use(page);
|
||||
page.off("console", onConsole);
|
||||
page.off("pageerror", onPageError);
|
||||
page.off("requestfailed", onRequestFailed);
|
||||
expect(failures, "unexpected browser console/page errors").toEqual([]);
|
||||
},
|
||||
});
|
||||
|
||||
export { expect };
|
||||
export type { Page };
|
||||
@@ -0,0 +1,69 @@
|
||||
import { vi } from "vitest";
|
||||
|
||||
export function createDeterministicClock(start = 0) {
|
||||
let current = start;
|
||||
return Object.freeze({
|
||||
now: () => current,
|
||||
sleep: async (milliseconds: number, signal?: AbortSignal) => {
|
||||
if (signal?.aborted) throw new DOMException("aborted", "AbortError");
|
||||
current += Math.max(0, milliseconds);
|
||||
},
|
||||
advance(milliseconds: number) {
|
||||
current += Math.max(0, milliseconds);
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
export function createSeededRandom(seed = 1) {
|
||||
let state = seed >>> 0;
|
||||
return () => {
|
||||
state = (state * 1_664_525 + 1_013_904_223) >>> 0;
|
||||
return state / 0x1_0000_0000;
|
||||
};
|
||||
}
|
||||
|
||||
export function createControlledScheduler() {
|
||||
const callbacks: Array<() => void> = [];
|
||||
return Object.freeze({
|
||||
callbacks,
|
||||
setTimeout: vi.fn((callback: () => void) => {
|
||||
callbacks.push(callback);
|
||||
return callbacks.length - 1;
|
||||
}),
|
||||
clearTimeout: vi.fn(),
|
||||
runNext() {
|
||||
callbacks.shift()?.();
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
export function createRecordingStorage() {
|
||||
const values = new Map<string, string>();
|
||||
const operations: Array<
|
||||
Readonly<{ operation: "get" | "set" | "remove"; key: string }>
|
||||
> = [];
|
||||
const storage: Storage = {
|
||||
getItem(key) {
|
||||
operations.push({ operation: "get", key });
|
||||
return values.get(key) ?? null;
|
||||
},
|
||||
setItem(key, value) {
|
||||
operations.push({ operation: "set", key });
|
||||
values.set(key, value);
|
||||
},
|
||||
removeItem(key) {
|
||||
operations.push({ operation: "remove", key });
|
||||
values.delete(key);
|
||||
},
|
||||
clear() {
|
||||
values.clear();
|
||||
},
|
||||
key(index) {
|
||||
return [...values.keys()][index] ?? null;
|
||||
},
|
||||
get length() {
|
||||
return values.size;
|
||||
},
|
||||
};
|
||||
return Object.freeze({ storage, operations, values });
|
||||
}
|
||||
@@ -36,6 +36,7 @@ describe("application input/output boundary", () => {
|
||||
it("uses fake output ports for preference, session, and safe diagnostics flows", () => {
|
||||
const write = vi.fn(() => ({ ok: true as const }));
|
||||
const emit = vi.fn();
|
||||
const record = vi.fn();
|
||||
const ports = {
|
||||
session: {
|
||||
getState: () => "authenticated" as const,
|
||||
@@ -49,7 +50,8 @@ describe("application input/output boundary", () => {
|
||||
write,
|
||||
remove: () => ({ ok: true as const }),
|
||||
},
|
||||
diagnostics: { emit },
|
||||
diagnostics: { record },
|
||||
telemetry: { emit },
|
||||
releaseInfo: {
|
||||
getCurrent: async () => ({
|
||||
buildId: "build-a",
|
||||
@@ -82,20 +84,43 @@ describe("application input/output boundary", () => {
|
||||
buildId: "build-a",
|
||||
boundaryName: "route",
|
||||
});
|
||||
expect(record).toHaveBeenCalledWith({
|
||||
level: "error",
|
||||
eventId: "ui.render.failed",
|
||||
context: {
|
||||
route_id: "APP_HOME",
|
||||
build_id: "build-a",
|
||||
component_boundary: "route",
|
||||
},
|
||||
});
|
||||
expect(emit).toHaveBeenCalledWith("ui.render.failed", {
|
||||
route_id: "APP_HOME",
|
||||
build_id: "build-a",
|
||||
component_boundary: "route",
|
||||
});
|
||||
application.diagnostics.reportRouteChanged({
|
||||
routeId: "APP_HOME",
|
||||
buildId: "build-a",
|
||||
});
|
||||
expect(record).toHaveBeenCalledWith({
|
||||
level: "info",
|
||||
eventId: "route.changed",
|
||||
context: { route_id: "APP_HOME", build_id: "build-a" },
|
||||
});
|
||||
});
|
||||
|
||||
it("does not let a failing diagnostics output escape into presentation", () => {
|
||||
const application = createTestApplication({
|
||||
diagnostics: {
|
||||
emit() {
|
||||
record() {
|
||||
throw new Error("sink details");
|
||||
},
|
||||
},
|
||||
telemetry: {
|
||||
emit() {
|
||||
throw new Error("telemetry details");
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
expect(() =>
|
||||
|
||||
@@ -3,6 +3,8 @@ import { describe, expect, it, vi } from "vitest";
|
||||
import { createApplication } from "../../src/application/create-application.js";
|
||||
import { createAnonymousSessionAdapter } from "../../src/adapters/auth/external-session-adapter.js";
|
||||
import type { StoragePort } from "../../src/application/ports/storage-port.js";
|
||||
import type { DiagnosticsPort } from "../../src/application/ports/diagnostics-port.js";
|
||||
import type { TelemetryPort } from "../../src/application/ports/telemetry-port.js";
|
||||
|
||||
type ReleaseFixture = {
|
||||
buildId: string;
|
||||
@@ -40,12 +42,15 @@ function applicationWith(options: {
|
||||
storage?: StoragePort;
|
||||
refresh?: () => Promise<ReturnType<typeof release>>;
|
||||
reload?: () => void;
|
||||
diagnostics?: DiagnosticsPort;
|
||||
telemetry?: TelemetryPort;
|
||||
}) {
|
||||
const current = release("build-a", "release-a");
|
||||
return createApplication({
|
||||
session: createAnonymousSessionAdapter(),
|
||||
preferences: options.storage ?? memoryStorage(),
|
||||
diagnostics: { emit: () => {} },
|
||||
diagnostics: options.diagnostics ?? { record: () => {} },
|
||||
telemetry: options.telemetry ?? { emit: () => {} },
|
||||
releaseInfo: {
|
||||
getCurrent: async () => current,
|
||||
refresh:
|
||||
@@ -59,7 +64,13 @@ function applicationWith(options: {
|
||||
describe("production chunk recovery application input", () => {
|
||||
it("reloads exactly once for one active build/release pair", async () => {
|
||||
const reload = vi.fn();
|
||||
const application = applicationWith({ reload });
|
||||
const record = vi.fn<DiagnosticsPort["record"]>();
|
||||
const emit = vi.fn<TelemetryPort["emit"]>();
|
||||
const application = applicationWith({
|
||||
reload,
|
||||
diagnostics: { record },
|
||||
telemetry: { emit },
|
||||
});
|
||||
const input = {
|
||||
chunkId: "route-home",
|
||||
failureKind: "CHUNK_LOAD_FAILURE" as const,
|
||||
@@ -69,6 +80,20 @@ describe("production chunk recovery application input", () => {
|
||||
action: "reload-once",
|
||||
releasePair: "build-a/release-a->build-b/release-b",
|
||||
});
|
||||
expect(record).toHaveBeenCalledWith({
|
||||
level: "warn",
|
||||
eventId: "release.mismatch.detected",
|
||||
context: {
|
||||
build_id: "build-a",
|
||||
active_release_id: "release-b",
|
||||
mismatch_kind: "BUILD_MISMATCH",
|
||||
},
|
||||
});
|
||||
expect(emit).toHaveBeenCalledWith("release.mismatch.detected", {
|
||||
build_id: "build-a",
|
||||
active_release_id: "release-b",
|
||||
mismatch_kind: "BUILD_MISMATCH",
|
||||
});
|
||||
await expect(application.recovery.recoverChunk(input)).resolves.toEqual({
|
||||
action: "support",
|
||||
reason: "reload-already-attempted",
|
||||
|
||||
@@ -0,0 +1,141 @@
|
||||
import { describe, expect, it, vi } from "vitest";
|
||||
|
||||
import {
|
||||
createDiagnosticsAdapter,
|
||||
getLastBootEvidence,
|
||||
noOpDiagnostics,
|
||||
recordBootFailure,
|
||||
} from "../../src/adapters/diagnostics/bounded-diagnostics.js";
|
||||
import {
|
||||
projectDiagnosticRecord,
|
||||
safeErrorKind,
|
||||
} from "../../src/contracts/diagnostics.js";
|
||||
|
||||
describe("structured diagnostics contract", () => {
|
||||
it("projects only registered, bounded context with deterministic time", () => {
|
||||
const projected = projectDiagnosticRecord(
|
||||
{
|
||||
level: "info",
|
||||
eventId: "route.changed",
|
||||
context: { route_id: "APP_HOME", build_id: "build-a" },
|
||||
},
|
||||
() => 0,
|
||||
);
|
||||
|
||||
expect(projected).toEqual({
|
||||
success: true,
|
||||
record: {
|
||||
level: "info",
|
||||
eventId: "route.changed",
|
||||
timestamp: "1970-01-01T00:00:00.000Z",
|
||||
context: { route_id: "APP_HOME", build_id: "build-a" },
|
||||
},
|
||||
});
|
||||
expect(
|
||||
projectDiagnosticRecord({
|
||||
level: "error",
|
||||
eventId: "ui.render.failed",
|
||||
context: { raw_url: "https://example.test/private?token=secret" },
|
||||
}),
|
||||
).toEqual({ success: false, reason: "unknown-context" });
|
||||
expect(
|
||||
projectDiagnosticRecord({
|
||||
level: "error",
|
||||
eventId: "ui.render.failed",
|
||||
context: { route_id: "private value with whitespace" },
|
||||
}),
|
||||
).toEqual({ success: false, reason: "invalid-context" });
|
||||
});
|
||||
|
||||
it("bounds evidence and isolates throwing sinks and hostile error objects", () => {
|
||||
const sink = vi.fn(() => {
|
||||
throw new Error("sink-secret");
|
||||
});
|
||||
const adapter = createDiagnosticsAdapter({
|
||||
maxEntries: 1,
|
||||
now: () => 0,
|
||||
sink,
|
||||
});
|
||||
const circular: Record<string, unknown> = { name: "TypeError" };
|
||||
circular.self = circular;
|
||||
const hostile = new Proxy(
|
||||
{},
|
||||
{
|
||||
get() {
|
||||
throw new Error("private getter");
|
||||
},
|
||||
ownKeys() {
|
||||
throw new Error("private keys");
|
||||
},
|
||||
},
|
||||
);
|
||||
|
||||
expect(safeErrorKind(circular)).toBe("TYPE_ERROR");
|
||||
expect(safeErrorKind(hostile)).toBe("UNKNOWN_FAILURE");
|
||||
expect(
|
||||
projectDiagnosticRecord({
|
||||
level: "error",
|
||||
eventId: "ui.render.failed",
|
||||
context: hostile,
|
||||
}),
|
||||
).toEqual({ success: false, reason: "serialization-failure" });
|
||||
expect(() =>
|
||||
adapter.record({
|
||||
level: "info",
|
||||
eventId: "route.changed",
|
||||
context: { route_id: "APP_HOME" },
|
||||
}),
|
||||
).not.toThrow();
|
||||
adapter.record({
|
||||
level: "warn",
|
||||
eventId: "cache.operation.failed",
|
||||
context: { operation: "query", error_kind: "UNKNOWN_FAILURE" },
|
||||
});
|
||||
|
||||
expect(adapter.entries()).toHaveLength(1);
|
||||
expect(adapter.entries()[0]?.eventId).toBe("cache.operation.failed");
|
||||
expect(adapter.dropped()).toEqual({
|
||||
"queue-full": 1,
|
||||
"sink-failure": 2,
|
||||
});
|
||||
expect(JSON.stringify(adapter.entries())).not.toMatch(
|
||||
/sink-secret|private getter/,
|
||||
);
|
||||
});
|
||||
|
||||
it("creates safe pre-mount boot evidence and supports a true no-op", () => {
|
||||
const circular: Record<string, unknown> = {
|
||||
name: "TypeError",
|
||||
token: "credential-value",
|
||||
stack: "private-stack",
|
||||
};
|
||||
circular.self = circular;
|
||||
|
||||
expect(() =>
|
||||
recordBootFailure(
|
||||
circular,
|
||||
{
|
||||
buildId: "build-a",
|
||||
configSchemaVersion: "1",
|
||||
supportReference: "support-private",
|
||||
},
|
||||
() => 0,
|
||||
),
|
||||
).not.toThrow();
|
||||
const evidence = getLastBootEvidence();
|
||||
expect(evidence?.diagnostic?.eventId).toBe("app.boot.failed");
|
||||
expect(evidence?.telemetry).toMatchObject({
|
||||
eventName: "app.boot.failed",
|
||||
timestamp: "1970-01-01T00:00:00.000Z",
|
||||
});
|
||||
expect(JSON.stringify(evidence)).not.toMatch(
|
||||
/credential-value|private-stack|support-private/,
|
||||
);
|
||||
expect(() =>
|
||||
noOpDiagnostics.record({
|
||||
level: "error",
|
||||
eventId: "app.boot.failed",
|
||||
}),
|
||||
).not.toThrow();
|
||||
});
|
||||
});
|
||||
@@ -52,7 +52,10 @@ describe("TanStack QueryCachePort adapter", () => {
|
||||
it("normalizes adapter exceptions without raw key data", async () => {
|
||||
const client = new QueryClient();
|
||||
vi.spyOn(client, "invalidateQueries").mockRejectedValue(new Error("secret-key"));
|
||||
const adapter = createQueryCacheAdapter(client);
|
||||
const record = vi.fn();
|
||||
const adapter = createQueryCacheAdapter(client, {
|
||||
diagnostics: { record },
|
||||
});
|
||||
const result = await adapter.invalidate(["resource", "sensitive-filter"]);
|
||||
|
||||
expect(result).toMatchObject({
|
||||
@@ -60,5 +63,16 @@ describe("TanStack QueryCachePort adapter", () => {
|
||||
error: { kind: "QUERY_CACHE_FAILURE" },
|
||||
});
|
||||
expect(JSON.stringify(result)).not.toContain("sensitive-filter");
|
||||
expect(record).toHaveBeenCalledWith({
|
||||
level: "warn",
|
||||
eventId: "cache.operation.failed",
|
||||
context: {
|
||||
operation: "invalidate",
|
||||
error_kind: "QUERY_CACHE_FAILURE",
|
||||
},
|
||||
});
|
||||
expect(JSON.stringify(record.mock.calls)).not.toMatch(
|
||||
/sensitive-filter|secret-key/,
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -0,0 +1,102 @@
|
||||
import { describe, expect, it } from "vitest";
|
||||
|
||||
import {
|
||||
canonicalRegistryJson,
|
||||
diffRegistrySnapshots,
|
||||
registrySnapshotDigest,
|
||||
validateBreakingEvidence,
|
||||
verifyRegistryBaselineApproval,
|
||||
} from "../../scripts/lib/registry-compatibility.mjs";
|
||||
|
||||
function snapshot(
|
||||
rows: Readonly<Record<string, Readonly<Record<string, unknown>>>>,
|
||||
) {
|
||||
return {
|
||||
schemaVersion: 2,
|
||||
registries: [
|
||||
{
|
||||
registryId: "FE-REG-TEST",
|
||||
contract: { breakingFields: ["path"] },
|
||||
rows,
|
||||
},
|
||||
],
|
||||
};
|
||||
}
|
||||
|
||||
describe("registry compatibility evidence", () => {
|
||||
it("canonicalizes object and primitive-array ordering", () => {
|
||||
expect(
|
||||
canonicalRegistryJson({
|
||||
second: ["b", "a"],
|
||||
first: { z: 1, a: 2 },
|
||||
}),
|
||||
).toBe('{"first":{"a":2,"z":1},"second":["a","b"]}');
|
||||
});
|
||||
|
||||
it("classifies additive, behavioral and breaking actual diffs", () => {
|
||||
expect(
|
||||
diffRegistrySnapshots(
|
||||
snapshot({ A: { path: "/a" } }),
|
||||
snapshot({ A: { path: "/a" }, B: { path: "/b" } }),
|
||||
).impact,
|
||||
).toBe("additive");
|
||||
expect(
|
||||
diffRegistrySnapshots(
|
||||
snapshot({ A: { path: "/a", owner: "one" } }),
|
||||
snapshot({ A: { path: "/a", owner: "two" } }),
|
||||
).impact,
|
||||
).toBe("behavior-change");
|
||||
expect(
|
||||
diffRegistrySnapshots(
|
||||
snapshot({ A: { path: "/a" } }),
|
||||
snapshot({ A: { path: "/moved" } }),
|
||||
).impact,
|
||||
).toBe("breaking");
|
||||
expect(
|
||||
diffRegistrySnapshots(
|
||||
snapshot({ A: { path: "/a" } }),
|
||||
snapshot({}),
|
||||
).impact,
|
||||
).toBe("breaking");
|
||||
});
|
||||
|
||||
it("verifies the approved digest and complete breaking evidence", () => {
|
||||
const before = snapshot({ A: { path: "/before" } });
|
||||
const after = snapshot({ A: { path: "/after" } });
|
||||
const digest = registrySnapshotDigest(before);
|
||||
expect(
|
||||
verifyRegistryBaselineApproval(before, {
|
||||
schemaVersion: 1,
|
||||
snapshotDigest: digest,
|
||||
owner: "platform",
|
||||
approvedAt: "2026-07-26T00:00:00.000Z",
|
||||
}).passed,
|
||||
).toBe(true);
|
||||
expect(
|
||||
verifyRegistryBaselineApproval(before, {
|
||||
schemaVersion: 1,
|
||||
snapshotDigest: "tampered",
|
||||
owner: "platform",
|
||||
approvedAt: "2026-07-26T00:00:00.000Z",
|
||||
}).passed,
|
||||
).toBe(false);
|
||||
|
||||
const diff = diffRegistrySnapshots(before, after);
|
||||
expect(validateBreakingEvidence(diff, { changes: [] }).passed).toBe(false);
|
||||
const changeId = diff.changes[0]?.changeId;
|
||||
expect(
|
||||
validateBreakingEvidence(diff, {
|
||||
changes: [
|
||||
{
|
||||
changeId,
|
||||
versionBump: "2",
|
||||
migration: "dual-read",
|
||||
compatibilityWindow: "one release",
|
||||
rollback: "restore previous registry snapshot",
|
||||
owner: "platform",
|
||||
},
|
||||
],
|
||||
}).passed,
|
||||
).toBe(true);
|
||||
});
|
||||
});
|
||||
@@ -2,24 +2,32 @@ import { readFile } from "node:fs/promises";
|
||||
import { describe, expect, it } from "vitest";
|
||||
|
||||
describe("registry governance manifest", () => {
|
||||
it("declares exactly nine single-owner registries and impact labels", async () => {
|
||||
it("declares ten typed, single-owner executable registries", async () => {
|
||||
const governance = JSON.parse(
|
||||
await readFile("config/contracts/registry-governance.json", "utf8"),
|
||||
);
|
||||
const registries =
|
||||
/** @type {Array<{registryId: string, owner: string}>} */ (
|
||||
/** @type {Array<{
|
||||
* registryId: string,
|
||||
* owner: string,
|
||||
* requiredFields: string[],
|
||||
* fieldTypes: Record<string, string>
|
||||
* }>} */ (
|
||||
governance.registries
|
||||
);
|
||||
expect(governance.registries).toHaveLength(9);
|
||||
expect(governance.registries).toHaveLength(10);
|
||||
expect(new Set(registries.map((entry) => entry.registryId)).size).toBe(
|
||||
9,
|
||||
10,
|
||||
);
|
||||
expect(registries.every((entry) => entry.owner)).toBe(true);
|
||||
expect(governance.compatibilityImpact.allowed).toEqual([
|
||||
"none",
|
||||
"additive",
|
||||
"behavior-change",
|
||||
"breaking",
|
||||
]);
|
||||
expect(
|
||||
registries.every(
|
||||
(entry) =>
|
||||
Array.isArray(entry.requiredFields) &&
|
||||
entry.requiredFields.length > 0 &&
|
||||
entry.fieldTypes &&
|
||||
Object.keys(entry.fieldTypes).length > 0,
|
||||
),
|
||||
).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -46,6 +46,9 @@ describe("runtime adapter composition", () => {
|
||||
releaseId: "release-a",
|
||||
});
|
||||
expect(adapters.infrastructure.queryClient).toBeDefined();
|
||||
expect(adapters.outputPorts.diagnostics.record).toEqual(expect.any(Function));
|
||||
expect(adapters.outputPorts.telemetry.emit).toEqual(expect.any(Function));
|
||||
expect(adapters.outputPorts.telemetry.pendingCount()).toBe(0);
|
||||
expect(adapters).not.toHaveProperty("http");
|
||||
expect(adapters).not.toHaveProperty("storage");
|
||||
});
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { describe, expect, it } from "vitest";
|
||||
import { describe, expect, it, vi } from "vitest";
|
||||
|
||||
import { createBrowserStorageAdapter } from "../../src/adapters/storage/browser-storage-adapter.js";
|
||||
import {
|
||||
@@ -61,13 +61,27 @@ describe("storage registry", () => {
|
||||
|
||||
it("falls back to memory when preference storage quota is exceeded", () => {
|
||||
const localStorage = createStorage({ quota: true });
|
||||
const adapter = createBrowserStorageAdapter({ localStorage });
|
||||
const record = vi.fn();
|
||||
const adapter = createBrowserStorageAdapter({
|
||||
localStorage,
|
||||
diagnostics: { record },
|
||||
});
|
||||
expect(adapter.write("COLOR_SCHEME", "dark")).toMatchObject({
|
||||
ok: false,
|
||||
fallback: "memory",
|
||||
error: { kind: "STORAGE_QUOTA_EXCEEDED" },
|
||||
});
|
||||
expect(adapter.read("COLOR_SCHEME")).toEqual({ ok: true, value: "dark" });
|
||||
expect(record).toHaveBeenCalledOnce();
|
||||
expect(record).toHaveBeenCalledWith({
|
||||
level: "warn",
|
||||
eventId: "storage.operation.failed",
|
||||
context: {
|
||||
operation: "write:COLOR_SCHEME",
|
||||
error_kind: "STORAGE_QUOTA_EXCEEDED",
|
||||
},
|
||||
});
|
||||
expect(JSON.stringify(record.mock.calls)).not.toContain("dark");
|
||||
});
|
||||
|
||||
it("discards data from a previous schema version", () => {
|
||||
|
||||
@@ -33,15 +33,26 @@ describe("telemetry registry and redaction", () => {
|
||||
}
|
||||
});
|
||||
|
||||
it("uses a default-deny attribute projection", () => {
|
||||
it("redacts forbidden attributes and rejects unknown context", () => {
|
||||
const projected = projectTelemetryEvent("api.request.failed", {
|
||||
...validAttributes,
|
||||
raw_url: "https://api.test/path?token=secret",
|
||||
unregistered: "private",
|
||||
});
|
||||
|
||||
expect(projected.success).toBe(true);
|
||||
expect(JSON.stringify(projected)).not.toMatch(/raw_url|token|secret|unregistered/);
|
||||
expect(JSON.stringify(projected)).not.toMatch(/raw_url|token|secret/);
|
||||
expect(
|
||||
projectTelemetryEvent("api.request.failed", {
|
||||
...validAttributes,
|
||||
unregistered: "private",
|
||||
}),
|
||||
).toEqual({ success: false, reason: "unknown-attributes" });
|
||||
expect(
|
||||
projectTelemetryEvent("api.request.failed", {
|
||||
...validAttributes,
|
||||
route_id: "/users/actual-user-id",
|
||||
}),
|
||||
).toEqual({ success: false, reason: "invalid-attribute-value" });
|
||||
});
|
||||
|
||||
it("validates traceparent without exposing invalid values", () => {
|
||||
@@ -71,10 +82,18 @@ describe("best-effort telemetry adapter", () => {
|
||||
|
||||
expect(adapter.pendingCount()).toBe(2);
|
||||
expect(adapter.droppedCount()).toBe(1);
|
||||
expect(adapter.dropReasons()).toEqual({ "queue-full": 1 });
|
||||
expect(adapter.deliveryEvidence()).toMatchObject({
|
||||
eventName: "telemetry.delivery.dropped",
|
||||
attributes: { reason: "queue-full", queue_size_bucket: "1-10" },
|
||||
});
|
||||
expect(scheduled).toHaveLength(1);
|
||||
});
|
||||
|
||||
it("degrades on sink failure without throwing or recursive events", async () => {
|
||||
const onDrop = vi.fn(() => {
|
||||
throw new Error("observer unavailable");
|
||||
});
|
||||
const adapter = createTelemetryAdapter({
|
||||
enabled: true,
|
||||
endpoint: "https://telemetry.test/events",
|
||||
@@ -82,13 +101,50 @@ describe("best-effort telemetry adapter", () => {
|
||||
fetcher: async () => {
|
||||
throw new Error("sink unavailable");
|
||||
},
|
||||
onDrop,
|
||||
});
|
||||
expect(() => adapter.emit("api.request.failed", validAttributes)).not.toThrow();
|
||||
await expect(adapter.flush()).resolves.toBeUndefined();
|
||||
expect(adapter.droppedCount()).toBe(1);
|
||||
expect(adapter.dropReasons()).toEqual({ "sink-failure": 1 });
|
||||
expect(onDrop).toHaveBeenCalledOnce();
|
||||
expect(adapter.pendingCount()).toBe(0);
|
||||
});
|
||||
|
||||
it("never serializes circular or unbounded event context", () => {
|
||||
const adapter = createTelemetryAdapter({
|
||||
enabled: true,
|
||||
endpoint: "https://telemetry.test/events",
|
||||
schedule: () => {},
|
||||
});
|
||||
const circular = {};
|
||||
circular.self = circular;
|
||||
const hostile = new Proxy(
|
||||
{},
|
||||
{
|
||||
ownKeys() {
|
||||
throw new Error("private proxy value");
|
||||
},
|
||||
},
|
||||
);
|
||||
|
||||
expect(() =>
|
||||
adapter.emit("api.request.failed", {
|
||||
...validAttributes,
|
||||
unregistered: circular,
|
||||
}),
|
||||
).not.toThrow();
|
||||
expect(adapter.pendingCount()).toBe(0);
|
||||
expect(adapter.dropReasons()).toEqual({ "invalid-context": 1 });
|
||||
expect(() =>
|
||||
adapter.emit("api.request.failed", hostile),
|
||||
).not.toThrow();
|
||||
expect(adapter.dropReasons()).toEqual({
|
||||
"invalid-context": 1,
|
||||
"serialization-failure": 1,
|
||||
});
|
||||
});
|
||||
|
||||
it("performs no network or queue work when disabled", async () => {
|
||||
const fetcher = vi.fn();
|
||||
const adapter = createTelemetryAdapter({
|
||||
@@ -102,4 +158,25 @@ describe("best-effort telemetry adapter", () => {
|
||||
expect(fetcher).not.toHaveBeenCalled();
|
||||
expect(adapter.pendingCount()).toBe(0);
|
||||
});
|
||||
|
||||
it("flushes on page exit and removes the lifecycle listener", async () => {
|
||||
const lifecycle = new EventTarget();
|
||||
const remove = vi.spyOn(lifecycle, "removeEventListener");
|
||||
const fetcher = vi.fn(async () => new Response(null, { status: 204 }));
|
||||
const adapter = createTelemetryAdapter({
|
||||
enabled: true,
|
||||
endpoint: "https://telemetry.test/events",
|
||||
schedule: () => {},
|
||||
lifecycle,
|
||||
fetcher,
|
||||
});
|
||||
adapter.emit("api.request.failed", validAttributes);
|
||||
|
||||
lifecycle.dispatchEvent(new Event("pagehide"));
|
||||
await vi.waitFor(() => expect(fetcher).toHaveBeenCalledOnce());
|
||||
adapter.dispose();
|
||||
|
||||
expect(adapter.pendingCount()).toBe(0);
|
||||
expect(remove).toHaveBeenCalledWith("pagehide", expect.any(Function));
|
||||
});
|
||||
});
|
||||
|
||||
BIN
Binary file not shown.
|
After Width: | Height: | Size: 21 KiB |
BIN
Binary file not shown.
|
After Width: | Height: | Size: 26 KiB |
BIN
Binary file not shown.
|
After Width: | Height: | Size: 186 KiB |
BIN
Binary file not shown.
|
After Width: | Height: | Size: 8.6 KiB |
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user