Compare commits
12
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2c3eda4d6b | ||
|
|
0a3bf08308 | ||
|
|
184eb67282 | ||
|
|
c570996a97 | ||
|
|
44414c5244 | ||
|
|
37ca2c3172 | ||
|
|
7f3569ce3c | ||
|
|
a0ca15da65 | ||
|
|
bf813f09ab | ||
|
|
0934de44c7 | ||
|
|
5c36cd978c | ||
|
|
b193feeddc |
@@ -25,6 +25,7 @@
|
|||||||
"test:all": "pnpm test:runtime-schema && pnpm test:unit && pnpm test:component && pnpm test:integration"
|
"test:all": "pnpm test:runtime-schema && pnpm test:unit && pnpm test:component && pnpm test:integration"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
|
"@tanstack/react-query": "5.101.4",
|
||||||
"react": "19.2.8",
|
"react": "19.2.8",
|
||||||
"react-dom": "19.2.8",
|
"react-dom": "19.2.8",
|
||||||
"zod": "4.4.3"
|
"zod": "4.4.3"
|
||||||
|
|||||||
Generated
+18
@@ -8,6 +8,9 @@ importers:
|
|||||||
|
|
||||||
.:
|
.:
|
||||||
dependencies:
|
dependencies:
|
||||||
|
'@tanstack/react-query':
|
||||||
|
specifier: 5.101.4
|
||||||
|
version: 5.101.4(react@19.2.8)
|
||||||
react:
|
react:
|
||||||
specifier: 19.2.8
|
specifier: 19.2.8
|
||||||
version: 19.2.8
|
version: 19.2.8
|
||||||
@@ -396,6 +399,14 @@ packages:
|
|||||||
'@standard-schema/spec@1.1.0':
|
'@standard-schema/spec@1.1.0':
|
||||||
resolution: {integrity: sha512-l2aFy5jALhniG5HgqrD6jXLi/rUWrKvqN/qJx6yoJsgKhblVd+iqqU4RCXavm/jPityDo5TCvKMnpjKnOriy0w==}
|
resolution: {integrity: sha512-l2aFy5jALhniG5HgqrD6jXLi/rUWrKvqN/qJx6yoJsgKhblVd+iqqU4RCXavm/jPityDo5TCvKMnpjKnOriy0w==}
|
||||||
|
|
||||||
|
'@tanstack/query-core@5.101.4':
|
||||||
|
resolution: {integrity: sha512-gNwcvOJcRbLWPOLG/2OBm+zM+Yv+MKsXKEOWC57USuZDEsI71hEErQsiEGx5wX9rzWWkfwM0fVSPoiIFSsxfiw==}
|
||||||
|
|
||||||
|
'@tanstack/react-query@5.101.4':
|
||||||
|
resolution: {integrity: sha512-yRg2pfOCxIs4ZJW3XYYHU/WgtD04FHSnfHlpRT7h7pR77hwkdRG4wxbKe4aq6P0RvXUTBSQpQeadS1SUYUe+KA==}
|
||||||
|
peerDependencies:
|
||||||
|
react: ^18 || ^19
|
||||||
|
|
||||||
'@testing-library/dom@10.4.1':
|
'@testing-library/dom@10.4.1':
|
||||||
resolution: {integrity: sha512-o4PXJQidqJl82ckFaXUeoAW+XysPLauYI43Abki5hABd853iMhitooc6znOnczgbTYmEP6U6/y1ZyKAIsvMKGg==}
|
resolution: {integrity: sha512-o4PXJQidqJl82ckFaXUeoAW+XysPLauYI43Abki5hABd853iMhitooc6znOnczgbTYmEP6U6/y1ZyKAIsvMKGg==}
|
||||||
engines: {node: '>=18'}
|
engines: {node: '>=18'}
|
||||||
@@ -1840,6 +1851,13 @@ snapshots:
|
|||||||
|
|
||||||
'@standard-schema/spec@1.1.0': {}
|
'@standard-schema/spec@1.1.0': {}
|
||||||
|
|
||||||
|
'@tanstack/query-core@5.101.4': {}
|
||||||
|
|
||||||
|
'@tanstack/react-query@5.101.4(react@19.2.8)':
|
||||||
|
dependencies:
|
||||||
|
'@tanstack/query-core': 5.101.4
|
||||||
|
react: 19.2.8
|
||||||
|
|
||||||
'@testing-library/dom@10.4.1':
|
'@testing-library/dom@10.4.1':
|
||||||
dependencies:
|
dependencies:
|
||||||
'@babel/code-frame': 7.29.7
|
'@babel/code-frame': 7.29.7
|
||||||
|
|||||||
@@ -0,0 +1,45 @@
|
|||||||
|
/**
|
||||||
|
* Creates the skeleton-owned side of an external session integration.
|
||||||
|
* Credential acquisition and storage stay inside the supplied external owner.
|
||||||
|
*
|
||||||
|
* @param {{
|
||||||
|
* readState(): import("../../application/ports/auth-session-port.js").SessionState,
|
||||||
|
* attachCredential(request: Request): Promise<Request>,
|
||||||
|
* recoverSession(): Promise<"restored" | "no-session">,
|
||||||
|
* notifyUnauthenticated(): void
|
||||||
|
* }} owner
|
||||||
|
* @returns {import("../../application/ports/auth-session-port.js").AuthSessionPort}
|
||||||
|
*/
|
||||||
|
export function createExternalAuthSessionAdapter(owner) {
|
||||||
|
return Object.freeze({
|
||||||
|
getState() {
|
||||||
|
return owner.readState();
|
||||||
|
},
|
||||||
|
async attach(request) {
|
||||||
|
const attached = await owner.attachCredential(request);
|
||||||
|
if (!(attached instanceof Request)) {
|
||||||
|
throw new TypeError("Auth owner returned an invalid request");
|
||||||
|
}
|
||||||
|
return attached;
|
||||||
|
},
|
||||||
|
async recover() {
|
||||||
|
const result = await owner.recoverSession();
|
||||||
|
if (result !== "restored" && result !== "no-session") {
|
||||||
|
throw new TypeError("Auth owner returned an invalid recovery state");
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
},
|
||||||
|
onUnauthenticated() {
|
||||||
|
owner.notifyUnauthenticated();
|
||||||
|
},
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
export function createAnonymousSessionAdapter() {
|
||||||
|
return createExternalAuthSessionAdapter({
|
||||||
|
readState: () => "unauthenticated",
|
||||||
|
attachCredential: async (request) => request,
|
||||||
|
recoverSession: async () => "no-session",
|
||||||
|
notifyUnauthenticated: () => {},
|
||||||
|
});
|
||||||
|
}
|
||||||
@@ -0,0 +1,407 @@
|
|||||||
|
import { systemClock } from "../../application/ports/clock-port.js";
|
||||||
|
import { getApiOperation } from "../../contracts/api-operations.js";
|
||||||
|
import {
|
||||||
|
createFailure as failure,
|
||||||
|
kindForStatus as statusKind,
|
||||||
|
} from "../../contracts/errors.js";
|
||||||
|
import { retryDelay, shouldRetry } from "./retry-policy.js";
|
||||||
|
import {
|
||||||
|
validateEnvelope,
|
||||||
|
validateOperationPayload,
|
||||||
|
validateOperationRequest,
|
||||||
|
} from "./schema-registry.js";
|
||||||
|
|
||||||
|
const noAuthSession =
|
||||||
|
/** @type {import("../../application/ports/auth-session-port.js").AuthSessionPort} */ ({
|
||||||
|
getState: () => /** @type {"unauthenticated"} */ ("unauthenticated"),
|
||||||
|
attach: async (request) => request,
|
||||||
|
recover: async () => /** @type {"no-session"} */ ("no-session"),
|
||||||
|
onUnauthenticated: () => {},
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @typedef {{
|
||||||
|
* kind: string,
|
||||||
|
* code: string,
|
||||||
|
* retryable: boolean,
|
||||||
|
* operationId: string,
|
||||||
|
* attemptCount: number,
|
||||||
|
* httpStatus?: number,
|
||||||
|
* requestId?: string,
|
||||||
|
* traceId?: string,
|
||||||
|
* retryAfterMs?: number,
|
||||||
|
* userMessageKey: string,
|
||||||
|
* action: string
|
||||||
|
* }} HttpFailure
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @typedef {{ ok: true, value: unknown, meta: Record<string, string> } |
|
||||||
|
* { ok: false, error: HttpFailure }} HttpResult
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {{
|
||||||
|
* baseUrl: string,
|
||||||
|
* fetcher?: typeof fetch,
|
||||||
|
* authSession?: import("../../application/ports/auth-session-port.js").AuthSessionPort,
|
||||||
|
* clock?: import("../../application/ports/clock-port.js").ClockPort,
|
||||||
|
* random?: () => number,
|
||||||
|
* validatePayload?: (schemaId: string, value: unknown) =>
|
||||||
|
* { success: true, data: unknown } | { success: false },
|
||||||
|
* idempotencyKeyFactory?: () => string
|
||||||
|
* }} dependencies
|
||||||
|
*/
|
||||||
|
export function createHttpClient(dependencies) {
|
||||||
|
const fetcher = dependencies.fetcher ?? fetch;
|
||||||
|
const authSession = dependencies.authSession ?? noAuthSession;
|
||||||
|
const clock = dependencies.clock ?? systemClock;
|
||||||
|
const random = dependencies.random ?? Math.random;
|
||||||
|
const validatePayload =
|
||||||
|
dependencies.validatePayload ?? validateOperationPayload;
|
||||||
|
const idempotencyKeyFactory =
|
||||||
|
dependencies.idempotencyKeyFactory ?? (() => crypto.randomUUID());
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {string} operationId
|
||||||
|
* @param {{
|
||||||
|
* body?: unknown,
|
||||||
|
* routeId?: string,
|
||||||
|
* signal?: AbortSignal,
|
||||||
|
* idempotencyKey?: string
|
||||||
|
* }} [input]
|
||||||
|
*/
|
||||||
|
async function execute(operationId, input = {}) {
|
||||||
|
const operation = getApiOperation(operationId);
|
||||||
|
const logicalIdempotencyKey =
|
||||||
|
operation.idempotency === "keyed"
|
||||||
|
? input.idempotencyKey ?? idempotencyKeyFactory()
|
||||||
|
: undefined;
|
||||||
|
let retryCount = 0;
|
||||||
|
let recoveryUsed = false;
|
||||||
|
|
||||||
|
while (true) {
|
||||||
|
const attempt = retryCount;
|
||||||
|
/** @type {HttpResult} */
|
||||||
|
const outcome = await performAttempt({
|
||||||
|
operation,
|
||||||
|
input,
|
||||||
|
attempt,
|
||||||
|
idempotencyKey: logicalIdempotencyKey,
|
||||||
|
});
|
||||||
|
|
||||||
|
if (outcome.ok) return outcome;
|
||||||
|
|
||||||
|
if (outcome.error.httpStatus === 401 && !recoveryUsed) {
|
||||||
|
recoveryUsed = true;
|
||||||
|
const recovered = await recoverSession(authSession, operation, outcome.error);
|
||||||
|
if (!recovered.ok) return recovered;
|
||||||
|
if (operation.idempotency === "none") {
|
||||||
|
return {
|
||||||
|
ok: false,
|
||||||
|
error: {
|
||||||
|
...outcome.error,
|
||||||
|
retryable: false,
|
||||||
|
action: "retry",
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (outcome.error.httpStatus === 401 && recoveryUsed) {
|
||||||
|
authSession.onUnauthenticated();
|
||||||
|
return outcome;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!shouldRetry(operation, outcome.error, retryCount)) {
|
||||||
|
return outcome;
|
||||||
|
}
|
||||||
|
|
||||||
|
const delay = retryDelay(outcome.error, retryCount, random, clock.now());
|
||||||
|
retryCount += 1;
|
||||||
|
|
||||||
|
try {
|
||||||
|
await clock.sleep(delay, input.signal);
|
||||||
|
} catch {
|
||||||
|
return {
|
||||||
|
ok: false,
|
||||||
|
error: failure("REQUEST_ABORTED", operationId, retryCount, {
|
||||||
|
code: "REQUEST_ABORTED",
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {{
|
||||||
|
* operation: ReturnType<typeof getApiOperation>,
|
||||||
|
* input: { body?: unknown, routeId?: string, signal?: AbortSignal },
|
||||||
|
* attempt: number,
|
||||||
|
* idempotencyKey?: string
|
||||||
|
* }} context
|
||||||
|
* @returns {Promise<HttpResult>}
|
||||||
|
*/
|
||||||
|
async function performAttempt(context) {
|
||||||
|
const { operation, input, attempt, idempotencyKey } = context;
|
||||||
|
const controller = new AbortController();
|
||||||
|
let timedOut = false;
|
||||||
|
const timeout = setTimeout(() => {
|
||||||
|
timedOut = true;
|
||||||
|
controller.abort("timeout");
|
||||||
|
}, operation.timeoutMs);
|
||||||
|
const onExternalAbort = () => controller.abort(input.signal?.reason);
|
||||||
|
input.signal?.addEventListener("abort", onExternalAbort, { once: true });
|
||||||
|
|
||||||
|
const headers = new Headers({ Accept: "application/json" });
|
||||||
|
if (input.body !== undefined) headers.set("Content-Type", "application/json");
|
||||||
|
if (idempotencyKey) headers.set("Idempotency-Key", idempotencyKey);
|
||||||
|
|
||||||
|
if (input.body !== undefined) {
|
||||||
|
const requestValidation = validateOperationRequest(
|
||||||
|
operation.requestSchema,
|
||||||
|
input.body,
|
||||||
|
);
|
||||||
|
if (!requestValidation.success) {
|
||||||
|
return {
|
||||||
|
ok: false,
|
||||||
|
error: failure("VALIDATION_REJECTED", operation.operationId, attempt, {
|
||||||
|
code: "REQUEST_SCHEMA_INVALID",
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let request = new Request(new URL(operation.path, dependencies.baseUrl), {
|
||||||
|
method: operation.method,
|
||||||
|
headers,
|
||||||
|
body: input.body === undefined ? undefined : JSON.stringify(input.body),
|
||||||
|
signal: controller.signal,
|
||||||
|
});
|
||||||
|
|
||||||
|
try {
|
||||||
|
if (operation.auth === "external-session") {
|
||||||
|
try {
|
||||||
|
request = await authSession.attach(request);
|
||||||
|
} catch {
|
||||||
|
return {
|
||||||
|
ok: false,
|
||||||
|
error: failure("AUTH_INTEGRATION_FAILURE", operation.operationId, attempt, {
|
||||||
|
code: "AUTH_ATTACH_FAILED",
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const response = await fetcher(request);
|
||||||
|
return await parseResponse(response, operation, attempt, validatePayload);
|
||||||
|
} catch {
|
||||||
|
if (timedOut) {
|
||||||
|
return {
|
||||||
|
ok: false,
|
||||||
|
error: failure("REQUEST_TIMEOUT", operation.operationId, attempt, {
|
||||||
|
code: "REQUEST_TIMEOUT",
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
if (controller.signal.aborted || input.signal?.aborted) {
|
||||||
|
const externalReason = input.signal?.reason;
|
||||||
|
if (externalReason === "timeout") {
|
||||||
|
return {
|
||||||
|
ok: false,
|
||||||
|
error: failure("REQUEST_TIMEOUT", operation.operationId, attempt, {
|
||||||
|
code: "REQUEST_TIMEOUT",
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
if (
|
||||||
|
externalReason !== undefined &&
|
||||||
|
!["navigation", "user", "superseded"].includes(String(externalReason))
|
||||||
|
) {
|
||||||
|
return {
|
||||||
|
ok: false,
|
||||||
|
error: failure("UNKNOWN_FAILURE", operation.operationId, attempt, {
|
||||||
|
code: "EXTERNAL_ABORT_UNRESOLVED",
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
ok: false,
|
||||||
|
error: failure("REQUEST_ABORTED", operation.operationId, attempt, {
|
||||||
|
code: "REQUEST_ABORTED",
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
ok: false,
|
||||||
|
error: failure("NETWORK_UNREACHABLE", operation.operationId, attempt, {
|
||||||
|
code: "NETWORK_UNREACHABLE",
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
} finally {
|
||||||
|
clearTimeout(timeout);
|
||||||
|
input.signal?.removeEventListener("abort", onExternalAbort);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return Object.freeze({ execute });
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {Response} response
|
||||||
|
* @param {import("../../contracts/api-operations.js").ApiOperation} operation
|
||||||
|
* @param {number} attempt
|
||||||
|
* @param {(schemaId: string, value: unknown) =>
|
||||||
|
* { success: true, data: unknown } | { success: false }} validatePayload
|
||||||
|
* @returns {Promise<HttpResult>}
|
||||||
|
*/
|
||||||
|
async function parseResponse(response, operation, attempt, validatePayload) {
|
||||||
|
const contentType = response.headers.get("content-type") ?? "";
|
||||||
|
if (!contentType.toLowerCase().includes("application/json")) {
|
||||||
|
return {
|
||||||
|
ok: false,
|
||||||
|
error: failure("CONTENT_TYPE_MISMATCH", operation.operationId, attempt, {
|
||||||
|
code: "CONTENT_TYPE_MISMATCH",
|
||||||
|
httpStatus: response.status,
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
let envelope;
|
||||||
|
try {
|
||||||
|
envelope = await response.json();
|
||||||
|
} catch {
|
||||||
|
return {
|
||||||
|
ok: false,
|
||||||
|
error: failure("MALFORMED_JSON", operation.operationId, attempt, {
|
||||||
|
code: "MALFORMED_JSON",
|
||||||
|
httpStatus: response.status,
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const envelopeValidation = validateEnvelope(envelope);
|
||||||
|
if (!envelopeValidation.success) {
|
||||||
|
return {
|
||||||
|
ok: false,
|
||||||
|
error: failure(
|
||||||
|
response.ok ? "ENVELOPE_MISMATCH" : statusKind(response.status),
|
||||||
|
operation.operationId,
|
||||||
|
attempt,
|
||||||
|
{
|
||||||
|
code: response.ok ? "ENVELOPE_MISMATCH" : "HTTP_FAILURE",
|
||||||
|
httpStatus: response.status,
|
||||||
|
},
|
||||||
|
),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const envelopeRecord =
|
||||||
|
/** @type {Record<string, unknown>} */ (envelopeValidation.data);
|
||||||
|
if (response.ok && envelopeRecord.success === true && "data" in envelopeRecord) {
|
||||||
|
const payload = validatePayload(operation.responseSchema, envelopeRecord.data);
|
||||||
|
if (!payload.success) {
|
||||||
|
return {
|
||||||
|
ok: false,
|
||||||
|
error: failure("SCHEMA_MISMATCH", operation.operationId, attempt, {
|
||||||
|
code: "SCHEMA_MISMATCH",
|
||||||
|
httpStatus: response.status,
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
ok: true,
|
||||||
|
value: structuredClone(payload.data),
|
||||||
|
meta: safeMeta(envelopeRecord.meta),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const kind = statusKind(response.status);
|
||||||
|
const retryAfter = response.headers.get("retry-after");
|
||||||
|
return {
|
||||||
|
ok: false,
|
||||||
|
error: failure(kind, operation.operationId, attempt, {
|
||||||
|
code: safeBackendCode(envelope),
|
||||||
|
httpStatus: response.status,
|
||||||
|
requestId: safeMeta(envelopeRecord.meta).requestId,
|
||||||
|
traceId: safeMeta(envelopeRecord.meta).traceId,
|
||||||
|
retryAfterMs:
|
||||||
|
response.status === 429 && retryAfter
|
||||||
|
? parseRetryAfterHeader(retryAfter)
|
||||||
|
: undefined,
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {import("../../application/ports/auth-session-port.js").AuthSessionPort} authSession
|
||||||
|
* @param {import("../../contracts/api-operations.js").ApiOperation} operation
|
||||||
|
* @param {HttpFailure} originalFailure
|
||||||
|
* @returns {Promise<{ok: true} | {ok: false, error: HttpFailure}>}
|
||||||
|
*/
|
||||||
|
async function recoverSession(authSession, operation, originalFailure) {
|
||||||
|
try {
|
||||||
|
const result = await authSession.recover();
|
||||||
|
if (result === "restored") return { ok: true };
|
||||||
|
if (result === "no-session") {
|
||||||
|
authSession.onUnauthenticated();
|
||||||
|
return {
|
||||||
|
ok: false,
|
||||||
|
error: failure("AUTH_REQUIRED", operation.operationId, originalFailure.attemptCount, {
|
||||||
|
code: "AUTH_REQUIRED",
|
||||||
|
httpStatus: 401,
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
} catch {
|
||||||
|
// Normalized below.
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
ok: false,
|
||||||
|
error: failure(
|
||||||
|
"AUTH_INTEGRATION_FAILURE",
|
||||||
|
operation.operationId,
|
||||||
|
originalFailure.attemptCount,
|
||||||
|
{ code: "AUTH_RECOVERY_FAILED" },
|
||||||
|
),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {string} kind
|
||||||
|
* @param {string} operationId
|
||||||
|
* @param {number} attempt
|
||||||
|
* @param {FailureDetails} [details]
|
||||||
|
* @returns {HttpFailure}
|
||||||
|
*/
|
||||||
|
/** @param {unknown} envelope */
|
||||||
|
function safeBackendCode(envelope) {
|
||||||
|
if (!envelope || typeof envelope !== "object") return "HTTP_FAILURE";
|
||||||
|
const error = /** @type {Record<string, unknown>} */ (envelope).error;
|
||||||
|
if (!error || typeof error !== "object") return "HTTP_FAILURE";
|
||||||
|
const code = /** @type {Record<string, unknown>} */ (error).code;
|
||||||
|
return typeof code === "string" ? code : "HTTP_FAILURE";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @param {unknown} meta @returns {Record<string, string>} */
|
||||||
|
function safeMeta(meta) {
|
||||||
|
if (!meta || typeof meta !== "object") return {};
|
||||||
|
const metaRecord = /** @type {Record<string, unknown>} */ (meta);
|
||||||
|
return {
|
||||||
|
...(typeof metaRecord.requestId === "string"
|
||||||
|
? { requestId: metaRecord.requestId }
|
||||||
|
: {}),
|
||||||
|
...(typeof metaRecord.traceId === "string" ? { traceId: metaRecord.traceId } : {}),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @param {string} value */
|
||||||
|
function parseRetryAfterHeader(value) {
|
||||||
|
const seconds = Number(value);
|
||||||
|
if (Number.isFinite(seconds) && seconds >= 0) return seconds * 1_000;
|
||||||
|
const timestamp = Date.parse(value);
|
||||||
|
return Number.isFinite(timestamp) ? Math.max(0, timestamp - Date.now()) : undefined;
|
||||||
|
}
|
||||||
@@ -0,0 +1,79 @@
|
|||||||
|
const retryKinds = new Set([
|
||||||
|
"NETWORK_UNREACHABLE",
|
||||||
|
"REQUEST_TIMEOUT",
|
||||||
|
"RATE_LIMITED",
|
||||||
|
"SERVER_FAILURE",
|
||||||
|
]);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {number} retryIndex
|
||||||
|
* @param {() => number} [random]
|
||||||
|
* @param {number} [baseDelayMs]
|
||||||
|
* @param {number} [maxDelayMs]
|
||||||
|
*/
|
||||||
|
export function calculateBackoff(
|
||||||
|
retryIndex,
|
||||||
|
random = Math.random,
|
||||||
|
baseDelayMs = 250,
|
||||||
|
maxDelayMs = 2_000,
|
||||||
|
) {
|
||||||
|
return Math.min(maxDelayMs, baseDelayMs * 2 ** retryIndex) * random();
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @param {string | null | undefined} value @param {number} [now] */
|
||||||
|
export function parseRetryAfter(value, now = Date.now()) {
|
||||||
|
if (!value) return null;
|
||||||
|
|
||||||
|
const seconds = Number(value);
|
||||||
|
if (Number.isFinite(seconds)) {
|
||||||
|
return seconds < 0 ? null : seconds * 1_000;
|
||||||
|
}
|
||||||
|
|
||||||
|
const timestamp = Date.parse(value);
|
||||||
|
if (!Number.isFinite(timestamp)) return null;
|
||||||
|
return Math.max(0, timestamp - now);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {{ idempotency: "safe" | "keyed" | "none" }} operation
|
||||||
|
* @param {{ kind: string, retryAfterMs?: number, httpStatus?: number }} failure
|
||||||
|
* @param {number} retryCount
|
||||||
|
* @param {number} [maxRetries]
|
||||||
|
*/
|
||||||
|
export function shouldRetry(operation, failure, retryCount, maxRetries = 2) {
|
||||||
|
if (retryCount >= maxRetries) return false;
|
||||||
|
if (!retryKinds.has(failure.kind)) return false;
|
||||||
|
if (
|
||||||
|
failure.kind === "SERVER_FAILURE" &&
|
||||||
|
failure.httpStatus !== undefined &&
|
||||||
|
![502, 503, 504].includes(failure.httpStatus)
|
||||||
|
) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
if (
|
||||||
|
failure.kind === "RATE_LIMITED" &&
|
||||||
|
typeof failure.retryAfterMs === "number" &&
|
||||||
|
failure.retryAfterMs > 30_000
|
||||||
|
) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
return operation.idempotency === "safe" || operation.idempotency === "keyed";
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {{ kind: string, retryAfterMs?: number, retryAfter?: string }} failure
|
||||||
|
* @param {number} retryIndex
|
||||||
|
* @param {() => number} [random]
|
||||||
|
* @param {number} [now]
|
||||||
|
*/
|
||||||
|
export function retryDelay(failure, retryIndex, random = Math.random, now = Date.now()) {
|
||||||
|
const localBackoff = calculateBackoff(retryIndex, random);
|
||||||
|
if (failure.kind !== "RATE_LIMITED") return localBackoff;
|
||||||
|
|
||||||
|
const retryAfterMs =
|
||||||
|
typeof failure.retryAfterMs === "number"
|
||||||
|
? failure.retryAfterMs
|
||||||
|
: parseRetryAfter(failure.retryAfter, now);
|
||||||
|
|
||||||
|
return retryAfterMs === null ? localBackoff : Math.max(localBackoff, retryAfterMs);
|
||||||
|
}
|
||||||
@@ -0,0 +1,115 @@
|
|||||||
|
import { z } from "zod";
|
||||||
|
|
||||||
|
const metaSchema = z
|
||||||
|
.object({
|
||||||
|
requestId: z.string().min(1),
|
||||||
|
traceId: z.string().min(1),
|
||||||
|
correlationId: z.string().min(1).optional(),
|
||||||
|
})
|
||||||
|
.passthrough();
|
||||||
|
|
||||||
|
export const successEnvelopeSchema = z
|
||||||
|
.object({
|
||||||
|
success: z.literal(true),
|
||||||
|
data: z.unknown(),
|
||||||
|
meta: metaSchema,
|
||||||
|
})
|
||||||
|
.strict();
|
||||||
|
|
||||||
|
export const failureEnvelopeSchema = z
|
||||||
|
.object({
|
||||||
|
success: z.literal(false),
|
||||||
|
error: z
|
||||||
|
.object({
|
||||||
|
code: z.string().min(1),
|
||||||
|
category: z.string().min(1).optional(),
|
||||||
|
message: z.string().optional(),
|
||||||
|
retryable: z.boolean().optional(),
|
||||||
|
details: z.unknown().optional(),
|
||||||
|
})
|
||||||
|
.strict(),
|
||||||
|
meta: metaSchema,
|
||||||
|
})
|
||||||
|
.strict();
|
||||||
|
|
||||||
|
export const responseEnvelopeSchema = z.discriminatedUnion("success", [
|
||||||
|
successEnvelopeSchema,
|
||||||
|
failureEnvelopeSchema,
|
||||||
|
]);
|
||||||
|
|
||||||
|
const sampleResourceSchema = z
|
||||||
|
.object({
|
||||||
|
id: z.string().min(1),
|
||||||
|
name: z.string().min(1),
|
||||||
|
createdAt: z.string().optional(),
|
||||||
|
})
|
||||||
|
.passthrough();
|
||||||
|
|
||||||
|
const payloadSchemas =
|
||||||
|
/** @type {Readonly<Record<string, z.ZodType>>} */ (Object.freeze({
|
||||||
|
SampleResourceListPayload: z.array(sampleResourceSchema),
|
||||||
|
SampleResourcePayload: sampleResourceSchema,
|
||||||
|
}));
|
||||||
|
|
||||||
|
const requestSchemas =
|
||||||
|
/** @type {Readonly<Record<string, z.ZodType>>} */ (Object.freeze({
|
||||||
|
SampleResourceListQuery: z
|
||||||
|
.object({
|
||||||
|
cursor: z.string().optional(),
|
||||||
|
limit: z.int().min(1).max(100).default(20),
|
||||||
|
})
|
||||||
|
.strict(),
|
||||||
|
CreateSampleResourceCommand: z
|
||||||
|
.object({
|
||||||
|
name: z.string().trim().min(1).max(120),
|
||||||
|
})
|
||||||
|
.strict(),
|
||||||
|
}));
|
||||||
|
|
||||||
|
/** @param {unknown} value */
|
||||||
|
export function validateEnvelope(value) {
|
||||||
|
return projectResult(responseEnvelopeSchema.safeParse(value));
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @param {string} schemaId @param {unknown} value */
|
||||||
|
export function validateOperationPayload(schemaId, value) {
|
||||||
|
const schema = payloadSchemas[schemaId];
|
||||||
|
if (!schema) return missingSchema(schemaId);
|
||||||
|
return projectResult(schema.safeParse(value));
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @param {string} schemaId @param {unknown} value */
|
||||||
|
export function validateOperationRequest(schemaId, value) {
|
||||||
|
const schema = requestSchemas[schemaId];
|
||||||
|
if (!schema) return missingSchema(schemaId);
|
||||||
|
return projectResult(schema.safeParse(value));
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @param {string} schemaId */
|
||||||
|
function missingSchema(schemaId) {
|
||||||
|
return {
|
||||||
|
success: /** @type {false} */ (false),
|
||||||
|
issues: [{ path: "", code: "SCHEMA_NOT_REGISTERED", schemaId }],
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {{ success: true, data: unknown } |
|
||||||
|
* { success: false, error: { issues: Array<{ path: PropertyKey[], code: string }> } }} result
|
||||||
|
*/
|
||||||
|
function projectResult(result) {
|
||||||
|
if (result.success) {
|
||||||
|
return {
|
||||||
|
success: /** @type {true} */ (true),
|
||||||
|
data: structuredClone(result.data),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
success: /** @type {false} */ (false),
|
||||||
|
issues: result.error.issues.map((issue) => ({
|
||||||
|
path: issue.path.join("."),
|
||||||
|
code: issue.code,
|
||||||
|
})),
|
||||||
|
};
|
||||||
|
}
|
||||||
@@ -0,0 +1,72 @@
|
|||||||
|
import { QueryClient } from "@tanstack/react-query";
|
||||||
|
|
||||||
|
import { createFailure } from "../../contracts/errors.js";
|
||||||
|
|
||||||
|
export const QUERY_CACHE_DEFAULTS = Object.freeze({
|
||||||
|
staleTime: 30_000,
|
||||||
|
gcTime: 300_000,
|
||||||
|
refetchOnWindowFocus: true,
|
||||||
|
retry: false,
|
||||||
|
mutationRetry: false,
|
||||||
|
persistence: false,
|
||||||
|
});
|
||||||
|
|
||||||
|
export function createQueryClient() {
|
||||||
|
return new QueryClient({
|
||||||
|
defaultOptions: {
|
||||||
|
queries: {
|
||||||
|
staleTime: QUERY_CACHE_DEFAULTS.staleTime,
|
||||||
|
gcTime: QUERY_CACHE_DEFAULTS.gcTime,
|
||||||
|
refetchOnWindowFocus: QUERY_CACHE_DEFAULTS.refetchOnWindowFocus,
|
||||||
|
retry: QUERY_CACHE_DEFAULTS.retry,
|
||||||
|
},
|
||||||
|
mutations: {
|
||||||
|
retry: QUERY_CACHE_DEFAULTS.mutationRetry,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {QueryClient} queryClient
|
||||||
|
* @returns {import("../../application/ports/query-cache-port.js").QueryCachePort}
|
||||||
|
*/
|
||||||
|
export function createQueryCacheAdapter(queryClient) {
|
||||||
|
return Object.freeze({
|
||||||
|
read(key) {
|
||||||
|
try {
|
||||||
|
return { ok: true, value: queryClient.getQueryData(key) };
|
||||||
|
} catch {
|
||||||
|
return cacheFailure("read", key);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
write(key, value) {
|
||||||
|
try {
|
||||||
|
queryClient.setQueryData(key, structuredClone(value));
|
||||||
|
return { ok: true };
|
||||||
|
} catch {
|
||||||
|
return cacheFailure("write", key);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
async invalidate(namespace) {
|
||||||
|
try {
|
||||||
|
await queryClient.invalidateQueries({ queryKey: namespace, exact: false });
|
||||||
|
return { ok: true };
|
||||||
|
} catch {
|
||||||
|
return cacheFailure("invalidate", namespace);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @param {string} phase @param {readonly unknown[]} key */
|
||||||
|
function cacheFailure(phase, key) {
|
||||||
|
const namespace = typeof key[0] === "string" ? key[0] : "unknown";
|
||||||
|
return {
|
||||||
|
ok: /** @type {false} */ (false),
|
||||||
|
error: createFailure("QUERY_CACHE_FAILURE", "QUERY_CACHE", 0, {
|
||||||
|
code: `QUERY_CACHE_${phase.toUpperCase()}_FAILED`,
|
||||||
|
causeClass: `namespace:${namespace}`,
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
}
|
||||||
@@ -0,0 +1,137 @@
|
|||||||
|
import { createFailure } from "../../contracts/errors.js";
|
||||||
|
import { getStorageDefinition } from "../../contracts/storage-keys.js";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {{
|
||||||
|
* localStorage?: Storage,
|
||||||
|
* sessionStorage?: Storage,
|
||||||
|
* now?: () => number
|
||||||
|
* }} [dependencies]
|
||||||
|
* @returns {import("../../application/ports/storage-port.js").StoragePort}
|
||||||
|
*/
|
||||||
|
export function createBrowserStorageAdapter(dependencies = {}) {
|
||||||
|
const memory = new Map();
|
||||||
|
const now = dependencies.now ?? Date.now;
|
||||||
|
|
||||||
|
/** @param {string} name */
|
||||||
|
function backendFor(name) {
|
||||||
|
if (name === "localStorage") return dependencies.localStorage;
|
||||||
|
if (name === "sessionStorage") return dependencies.sessionStorage;
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
return Object.freeze({
|
||||||
|
read(logicalName) {
|
||||||
|
let definition;
|
||||||
|
try {
|
||||||
|
definition = getStorageDefinition(logicalName);
|
||||||
|
} catch {
|
||||||
|
return unavailable("read", logicalName);
|
||||||
|
}
|
||||||
|
|
||||||
|
const backend = backendFor(definition.backend);
|
||||||
|
try {
|
||||||
|
const raw = backend?.getItem(definition.physicalKey);
|
||||||
|
if (raw === null || raw === undefined) {
|
||||||
|
return { ok: true, value: memory.get(definition.physicalKey) };
|
||||||
|
}
|
||||||
|
const envelope = JSON.parse(raw);
|
||||||
|
if (
|
||||||
|
!envelope ||
|
||||||
|
typeof envelope !== "object" ||
|
||||||
|
envelope.schemaVersion !== definition.schemaVersion
|
||||||
|
) {
|
||||||
|
backend?.removeItem(definition.physicalKey);
|
||||||
|
return { ok: true, value: undefined };
|
||||||
|
}
|
||||||
|
if (typeof envelope.expiresAt === "number" && envelope.expiresAt <= now()) {
|
||||||
|
backend?.removeItem(definition.physicalKey);
|
||||||
|
return { ok: true, value: undefined };
|
||||||
|
}
|
||||||
|
return { ok: true, value: structuredClone(envelope.value) };
|
||||||
|
} catch {
|
||||||
|
return unavailable("read", logicalName);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
write(logicalName, value) {
|
||||||
|
let definition;
|
||||||
|
try {
|
||||||
|
definition = getStorageDefinition(logicalName);
|
||||||
|
} catch {
|
||||||
|
return unavailable("write", logicalName);
|
||||||
|
}
|
||||||
|
|
||||||
|
const expiresAt =
|
||||||
|
typeof definition.ttl === "number" ? now() + definition.ttl : null;
|
||||||
|
const envelope = {
|
||||||
|
schemaVersion: definition.schemaVersion,
|
||||||
|
expiresAt,
|
||||||
|
value: structuredClone(value),
|
||||||
|
};
|
||||||
|
const backend = backendFor(definition.backend);
|
||||||
|
|
||||||
|
try {
|
||||||
|
if (!backend) throw new DOMException("Storage unavailable", "SecurityError");
|
||||||
|
backend.setItem(definition.physicalKey, JSON.stringify(envelope));
|
||||||
|
return { ok: true };
|
||||||
|
} catch (error) {
|
||||||
|
const quota =
|
||||||
|
error instanceof DOMException &&
|
||||||
|
["QuotaExceededError", "NS_ERROR_DOM_QUOTA_REACHED"].includes(error.name);
|
||||||
|
|
||||||
|
if (definition.quotaFallback === "memory") {
|
||||||
|
memory.set(definition.physicalKey, structuredClone(value));
|
||||||
|
return {
|
||||||
|
ok: false,
|
||||||
|
error: storageFailure(quota, "write", logicalName),
|
||||||
|
fallback: "memory",
|
||||||
|
};
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
ok: false,
|
||||||
|
error: storageFailure(quota, "write", logicalName),
|
||||||
|
fallback: definition.quotaFallback,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
remove(logicalName) {
|
||||||
|
let definition;
|
||||||
|
try {
|
||||||
|
definition = getStorageDefinition(logicalName);
|
||||||
|
} catch {
|
||||||
|
return unavailable("remove", logicalName);
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
backendFor(definition.backend)?.removeItem(definition.physicalKey);
|
||||||
|
memory.delete(definition.physicalKey);
|
||||||
|
return { ok: true };
|
||||||
|
} catch {
|
||||||
|
return unavailable("remove", logicalName);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @param {boolean} quota @param {string} phase @param {string} logicalName */
|
||||||
|
function storageFailure(quota, phase, logicalName) {
|
||||||
|
return createFailure(
|
||||||
|
quota ? "STORAGE_QUOTA_EXCEEDED" : "STORAGE_UNAVAILABLE",
|
||||||
|
"STORAGE",
|
||||||
|
0,
|
||||||
|
{
|
||||||
|
code: `${logicalName}_${phase.toUpperCase()}_${
|
||||||
|
quota ? "QUOTA_EXCEEDED" : "UNAVAILABLE"
|
||||||
|
}`,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @param {string} phase @param {string} logicalName */
|
||||||
|
function unavailable(phase, logicalName) {
|
||||||
|
return {
|
||||||
|
ok: /** @type {false} */ (false),
|
||||||
|
error: storageFailure(false, phase, logicalName),
|
||||||
|
};
|
||||||
|
}
|
||||||
@@ -1,8 +1,11 @@
|
|||||||
/**
|
/**
|
||||||
* @typedef {{
|
* @typedef {{
|
||||||
* read(key: readonly unknown[]): unknown,
|
* read(key: readonly unknown[]): { ok: true, value: unknown } |
|
||||||
* write(key: readonly unknown[], value: unknown): void,
|
* { ok: false, error: import("../../contracts/errors.js").ApiFailure },
|
||||||
* invalidate(namespace: readonly unknown[]): Promise<void>
|
* write(key: readonly unknown[], value: unknown): { ok: true } |
|
||||||
|
* { ok: false, error: import("../../contracts/errors.js").ApiFailure },
|
||||||
|
* invalidate(namespace: readonly unknown[]): Promise<{ ok: true } |
|
||||||
|
* { ok: false, error: import("../../contracts/errors.js").ApiFailure }>
|
||||||
* }} QueryCachePort
|
* }} QueryCachePort
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|||||||
@@ -22,7 +22,7 @@
|
|||||||
/**
|
/**
|
||||||
* @template Value
|
* @template Value
|
||||||
* @typedef {{ ok: true, value: Value, meta?: Record<string, unknown> } |
|
* @typedef {{ ok: true, value: Value, meta?: Record<string, unknown> } |
|
||||||
* { ok: false, error: unknown }} Result
|
* { ok: false, error: import("../../contracts/errors.js").ApiFailure }} Result
|
||||||
*/
|
*/
|
||||||
|
|
||||||
export {};
|
export {};
|
||||||
|
|||||||
@@ -1,8 +1,12 @@
|
|||||||
/**
|
/**
|
||||||
* @typedef {{
|
* @typedef {{
|
||||||
* read(logicalName: string): { ok: true, value: unknown } | { ok: false, error: unknown },
|
* read(logicalName: string): { ok: true, value: unknown } |
|
||||||
* write(logicalName: string, value: unknown): { ok: true } | { ok: false, error: unknown },
|
* { ok: false, error: import("../../contracts/errors.js").ApiFailure },
|
||||||
* remove(logicalName: string): { ok: true } | { ok: false, error: unknown }
|
* write(logicalName: string, value: unknown): { ok: true } |
|
||||||
|
* { ok: false, error: import("../../contracts/errors.js").ApiFailure,
|
||||||
|
* fallback?: string },
|
||||||
|
* remove(logicalName: string): { ok: true } |
|
||||||
|
* { ok: false, error: import("../../contracts/errors.js").ApiFailure }
|
||||||
* }} StoragePort
|
* }} StoragePort
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,51 @@
|
|||||||
|
/**
|
||||||
|
* @typedef {{
|
||||||
|
* method: string,
|
||||||
|
* path: string,
|
||||||
|
* operationId: string,
|
||||||
|
* auth: "none" | "external-session",
|
||||||
|
* timeoutMs: number,
|
||||||
|
* idempotency: "safe" | "keyed" | "none",
|
||||||
|
* requestSchema: string,
|
||||||
|
* responseSchema: string,
|
||||||
|
* owner: string
|
||||||
|
* }} ApiOperation
|
||||||
|
*/
|
||||||
|
|
||||||
|
/** @param {ApiOperation} definition */
|
||||||
|
const operation = (definition) => Object.freeze(definition);
|
||||||
|
|
||||||
|
export const API_OPERATIONS = Object.freeze({
|
||||||
|
LIST_SAMPLE_RESOURCES: operation({
|
||||||
|
method: "GET",
|
||||||
|
path: "/api/sample/resources",
|
||||||
|
operationId: "LIST_SAMPLE_RESOURCES",
|
||||||
|
auth: "external-session",
|
||||||
|
timeoutMs: 10_000,
|
||||||
|
idempotency: "safe",
|
||||||
|
requestSchema: "SampleResourceListQuery",
|
||||||
|
responseSchema: "SampleResourceListPayload",
|
||||||
|
owner: "feature-sample-feature-slice-contract-fixture",
|
||||||
|
}),
|
||||||
|
CREATE_SAMPLE_RESOURCE: operation({
|
||||||
|
method: "POST",
|
||||||
|
path: "/api/sample/resources",
|
||||||
|
operationId: "CREATE_SAMPLE_RESOURCE",
|
||||||
|
auth: "external-session",
|
||||||
|
timeoutMs: 10_000,
|
||||||
|
idempotency: "keyed",
|
||||||
|
requestSchema: "CreateSampleResourceCommand",
|
||||||
|
responseSchema: "SampleResourcePayload",
|
||||||
|
owner: "feature-sample-feature-slice-contract-fixture",
|
||||||
|
}),
|
||||||
|
});
|
||||||
|
|
||||||
|
/** @param {string} operationId */
|
||||||
|
export function getApiOperation(operationId) {
|
||||||
|
const registry = /** @type {Record<string, ApiOperation>} */ (API_OPERATIONS);
|
||||||
|
const selected = registry[operationId];
|
||||||
|
if (!selected) {
|
||||||
|
throw new Error(`Unregistered API operation: ${operationId}`);
|
||||||
|
}
|
||||||
|
return selected;
|
||||||
|
}
|
||||||
@@ -0,0 +1,240 @@
|
|||||||
|
const DROP_SENSITIVE = Object.freeze([
|
||||||
|
"cause",
|
||||||
|
"body",
|
||||||
|
"headers",
|
||||||
|
"authorization",
|
||||||
|
"url",
|
||||||
|
"query",
|
||||||
|
"stack",
|
||||||
|
"storageValue",
|
||||||
|
]);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @typedef {{
|
||||||
|
* kind: string,
|
||||||
|
* defaultRetryable: boolean,
|
||||||
|
* severity: string,
|
||||||
|
* userMessageKey: string,
|
||||||
|
* action: string,
|
||||||
|
* telemetryEvent: string,
|
||||||
|
* redaction: readonly string[]
|
||||||
|
* }} ErrorDefinition
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {string} kind
|
||||||
|
* @param {boolean} defaultRetryable
|
||||||
|
* @param {string} severity
|
||||||
|
* @param {string} action
|
||||||
|
* @param {string} [telemetryEvent]
|
||||||
|
* @returns {Readonly<ErrorDefinition>}
|
||||||
|
*/
|
||||||
|
const row = (
|
||||||
|
kind,
|
||||||
|
defaultRetryable,
|
||||||
|
severity,
|
||||||
|
action,
|
||||||
|
telemetryEvent = "api.request.failed",
|
||||||
|
) =>
|
||||||
|
Object.freeze({
|
||||||
|
kind,
|
||||||
|
defaultRetryable,
|
||||||
|
severity,
|
||||||
|
userMessageKey: `error.${kind.toLowerCase()}`,
|
||||||
|
action,
|
||||||
|
telemetryEvent,
|
||||||
|
redaction: DROP_SENSITIVE,
|
||||||
|
});
|
||||||
|
|
||||||
|
export const ERROR_REGISTRY = Object.freeze({
|
||||||
|
NETWORK_UNREACHABLE: row("NETWORK_UNREACHABLE", true, "warning", "retry"),
|
||||||
|
REQUEST_TIMEOUT: row("REQUEST_TIMEOUT", true, "warning", "retry"),
|
||||||
|
REQUEST_ABORTED: row("REQUEST_ABORTED", false, "info", "none"),
|
||||||
|
CONTENT_TYPE_MISMATCH: row(
|
||||||
|
"CONTENT_TYPE_MISMATCH",
|
||||||
|
false,
|
||||||
|
"error",
|
||||||
|
"contact-support",
|
||||||
|
),
|
||||||
|
MALFORMED_JSON: row("MALFORMED_JSON", false, "error", "contact-support"),
|
||||||
|
ENVELOPE_MISMATCH: row("ENVELOPE_MISMATCH", false, "error", "contact-support"),
|
||||||
|
SCHEMA_MISMATCH: row("SCHEMA_MISMATCH", false, "error", "contact-support"),
|
||||||
|
AUTH_REQUIRED: row("AUTH_REQUIRED", false, "info", "reauth"),
|
||||||
|
AUTH_INTEGRATION_FAILURE: row(
|
||||||
|
"AUTH_INTEGRATION_FAILURE",
|
||||||
|
false,
|
||||||
|
"error",
|
||||||
|
"contact-support",
|
||||||
|
),
|
||||||
|
FORBIDDEN: row("FORBIDDEN", false, "warning", "navigate"),
|
||||||
|
NOT_FOUND: row("NOT_FOUND", false, "info", "navigate"),
|
||||||
|
CONFLICT: row("CONFLICT", false, "warning", "retry"),
|
||||||
|
VALIDATION_REJECTED: row("VALIDATION_REJECTED", false, "info", "none"),
|
||||||
|
UNKNOWN_CLIENT_FAILURE: row(
|
||||||
|
"UNKNOWN_CLIENT_FAILURE",
|
||||||
|
false,
|
||||||
|
"warning",
|
||||||
|
"contact-support",
|
||||||
|
),
|
||||||
|
RATE_LIMITED: row("RATE_LIMITED", true, "warning", "retry"),
|
||||||
|
SERVER_FAILURE: row("SERVER_FAILURE", true, "error", "retry"),
|
||||||
|
CHUNK_LOAD_FAILURE: row(
|
||||||
|
"CHUNK_LOAD_FAILURE",
|
||||||
|
false,
|
||||||
|
"error",
|
||||||
|
"reload-once",
|
||||||
|
"release.mismatch.detected",
|
||||||
|
),
|
||||||
|
BOOT_CONFIG_FAILURE: row(
|
||||||
|
"BOOT_CONFIG_FAILURE",
|
||||||
|
false,
|
||||||
|
"error",
|
||||||
|
"contact-support",
|
||||||
|
"app.boot.failed",
|
||||||
|
),
|
||||||
|
RELEASE_MANIFEST_FAILURE: row(
|
||||||
|
"RELEASE_MANIFEST_FAILURE",
|
||||||
|
false,
|
||||||
|
"error",
|
||||||
|
"contact-support",
|
||||||
|
"app.boot.failed",
|
||||||
|
),
|
||||||
|
DEPLOY_MISMATCH: row(
|
||||||
|
"DEPLOY_MISMATCH",
|
||||||
|
false,
|
||||||
|
"error",
|
||||||
|
"reload-once",
|
||||||
|
"release.mismatch.detected",
|
||||||
|
),
|
||||||
|
STORAGE_UNAVAILABLE: row(
|
||||||
|
"STORAGE_UNAVAILABLE",
|
||||||
|
false,
|
||||||
|
"warning",
|
||||||
|
"none",
|
||||||
|
"storage.operation.failed",
|
||||||
|
),
|
||||||
|
STORAGE_QUOTA_EXCEEDED: row(
|
||||||
|
"STORAGE_QUOTA_EXCEEDED",
|
||||||
|
false,
|
||||||
|
"warning",
|
||||||
|
"none",
|
||||||
|
"storage.operation.failed",
|
||||||
|
),
|
||||||
|
RENDER_FAILURE: row(
|
||||||
|
"RENDER_FAILURE",
|
||||||
|
false,
|
||||||
|
"error",
|
||||||
|
"reload-once",
|
||||||
|
"ui.render.failed",
|
||||||
|
),
|
||||||
|
TELEMETRY_FAILURE: row(
|
||||||
|
"TELEMETRY_FAILURE",
|
||||||
|
false,
|
||||||
|
"info",
|
||||||
|
"none",
|
||||||
|
"telemetry.delivery.dropped",
|
||||||
|
),
|
||||||
|
QUERY_CACHE_FAILURE: row(
|
||||||
|
"QUERY_CACHE_FAILURE",
|
||||||
|
false,
|
||||||
|
"error",
|
||||||
|
"retry",
|
||||||
|
"query.cache.failed",
|
||||||
|
),
|
||||||
|
UNKNOWN_FAILURE: row("UNKNOWN_FAILURE", false, "error", "contact-support"),
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @typedef {{
|
||||||
|
* kind: string,
|
||||||
|
* code: string,
|
||||||
|
* httpStatus?: number,
|
||||||
|
* retryable: boolean,
|
||||||
|
* operationId: string,
|
||||||
|
* attemptCount: number,
|
||||||
|
* requestId?: string,
|
||||||
|
* traceId?: string,
|
||||||
|
* retryAfterMs?: number,
|
||||||
|
* userMessageKey: string,
|
||||||
|
* action: string,
|
||||||
|
* causeClass?: string
|
||||||
|
* }} ApiFailure
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {string} kind
|
||||||
|
* @param {string} operationId
|
||||||
|
* @param {number} attempt
|
||||||
|
* @param {{
|
||||||
|
* code?: string,
|
||||||
|
* httpStatus?: number,
|
||||||
|
* requestId?: string,
|
||||||
|
* traceId?: string,
|
||||||
|
* retryAfterMs?: number,
|
||||||
|
* causeClass?: string
|
||||||
|
* }} [details]
|
||||||
|
* @returns {ApiFailure}
|
||||||
|
*/
|
||||||
|
export function createFailure(kind, operationId, attempt, details = {}) {
|
||||||
|
const registry =
|
||||||
|
/** @type {Readonly<Record<string, Readonly<ErrorDefinition>>>} */ (
|
||||||
|
ERROR_REGISTRY
|
||||||
|
);
|
||||||
|
const definition =
|
||||||
|
registry[kind] ?? ERROR_REGISTRY.UNKNOWN_FAILURE;
|
||||||
|
return Object.freeze({
|
||||||
|
kind: definition.kind,
|
||||||
|
code: typeof details.code === "string" ? details.code : definition.kind,
|
||||||
|
retryable: definition.defaultRetryable,
|
||||||
|
operationId,
|
||||||
|
attemptCount: Math.max(1, attempt + 1),
|
||||||
|
...(Number.isInteger(details.httpStatus)
|
||||||
|
? { httpStatus: details.httpStatus }
|
||||||
|
: {}),
|
||||||
|
...(typeof details.requestId === "string" ? { requestId: details.requestId } : {}),
|
||||||
|
...(typeof details.traceId === "string" ? { traceId: details.traceId } : {}),
|
||||||
|
...(typeof details.retryAfterMs === "number"
|
||||||
|
? { retryAfterMs: details.retryAfterMs }
|
||||||
|
: {}),
|
||||||
|
...(typeof details.causeClass === "string"
|
||||||
|
? { causeClass: details.causeClass }
|
||||||
|
: {}),
|
||||||
|
userMessageKey: definition.userMessageKey,
|
||||||
|
action: definition.action,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @param {number} status */
|
||||||
|
export function kindForStatus(status) {
|
||||||
|
if (status === 401) return "AUTH_REQUIRED";
|
||||||
|
if (status === 403) return "FORBIDDEN";
|
||||||
|
if (status === 404) return "NOT_FOUND";
|
||||||
|
if (status === 409) return "CONFLICT";
|
||||||
|
if (status === 422) return "VALIDATION_REJECTED";
|
||||||
|
if (status === 429) return "RATE_LIMITED";
|
||||||
|
if (status >= 500) return "SERVER_FAILURE";
|
||||||
|
if (status >= 400) return "UNKNOWN_CLIENT_FAILURE";
|
||||||
|
return "ENVELOPE_MISMATCH";
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Total catch-all that intentionally discards the thrown value.
|
||||||
|
*
|
||||||
|
* @param {unknown} value
|
||||||
|
* @param {{ operationId?: string, attempt?: number }} [context]
|
||||||
|
*/
|
||||||
|
export function normalizeUnknownFailure(value, context = {}) {
|
||||||
|
const causeClass =
|
||||||
|
value instanceof Error
|
||||||
|
? value.name
|
||||||
|
: value === null
|
||||||
|
? "null"
|
||||||
|
: typeof value;
|
||||||
|
|
||||||
|
return createFailure(
|
||||||
|
"UNKNOWN_FAILURE",
|
||||||
|
context.operationId ?? "UNKNOWN_OPERATION",
|
||||||
|
context.attempt ?? 0,
|
||||||
|
{ code: "UNKNOWN_FAILURE", causeClass },
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,36 @@
|
|||||||
|
const RESOURCE_NAMESPACE = Object.freeze(["resource", 1]);
|
||||||
|
|
||||||
|
export const queryKeys = Object.freeze({
|
||||||
|
resource: Object.freeze({
|
||||||
|
all: () => RESOURCE_NAMESPACE,
|
||||||
|
list: (filters = {}) =>
|
||||||
|
Object.freeze([...RESOURCE_NAMESPACE, "list", canonicalize(filters)]),
|
||||||
|
/** @param {string} resourceId */
|
||||||
|
detail: (resourceId) =>
|
||||||
|
Object.freeze([...RESOURCE_NAMESPACE, "detail", String(resourceId)]),
|
||||||
|
}),
|
||||||
|
});
|
||||||
|
|
||||||
|
export const QUERY_REGISTRY = Object.freeze({
|
||||||
|
RESOURCE: Object.freeze({
|
||||||
|
namespace: RESOURCE_NAMESPACE,
|
||||||
|
serialization: "canonical-object-order",
|
||||||
|
identity: "no-pii-token-or-raw-url",
|
||||||
|
invalidation: "resource namespace after successful mutation",
|
||||||
|
version: 1,
|
||||||
|
persistence: "disabled",
|
||||||
|
}),
|
||||||
|
});
|
||||||
|
|
||||||
|
/** @param {unknown} value @returns {unknown} */
|
||||||
|
export function canonicalize(value) {
|
||||||
|
if (Array.isArray(value)) return value.map(canonicalize);
|
||||||
|
if (value && typeof value === "object") {
|
||||||
|
return Object.fromEntries(
|
||||||
|
Object.entries(value)
|
||||||
|
.sort(([left], [right]) => left.localeCompare(right))
|
||||||
|
.map(([key, item]) => [key, canonicalize(item)]),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return value;
|
||||||
|
}
|
||||||
@@ -0,0 +1,102 @@
|
|||||||
|
const APP_NAMESPACE = "ca-frontend";
|
||||||
|
|
||||||
|
export const STORAGE_REGISTRY = Object.freeze({
|
||||||
|
COLOR_SCHEME: defineStorageKey({
|
||||||
|
logicalName: "COLOR_SCHEME",
|
||||||
|
scope: "preference",
|
||||||
|
name: "color-scheme",
|
||||||
|
backend: "localStorage",
|
||||||
|
classification: "public-preference",
|
||||||
|
schemaVersion: 1,
|
||||||
|
ttl: null,
|
||||||
|
migration: "discard",
|
||||||
|
quotaFallback: "memory",
|
||||||
|
}),
|
||||||
|
CHUNK_RELOAD_GUARD: defineStorageKey({
|
||||||
|
logicalName: "CHUNK_RELOAD_GUARD",
|
||||||
|
scope: "release",
|
||||||
|
name: "chunk-reload-guard",
|
||||||
|
backend: "sessionStorage",
|
||||||
|
classification: "opaque-cache",
|
||||||
|
schemaVersion: 1,
|
||||||
|
ttl: "session",
|
||||||
|
migration: "discard",
|
||||||
|
quotaFallback: "no-persist",
|
||||||
|
}),
|
||||||
|
QUERY_PERSISTENCE: defineStorageKey({
|
||||||
|
logicalName: "QUERY_PERSISTENCE",
|
||||||
|
scope: "cache",
|
||||||
|
name: "query-persistence",
|
||||||
|
backend: "disabled",
|
||||||
|
classification: "sensitive-forbidden",
|
||||||
|
schemaVersion: 1,
|
||||||
|
ttl: null,
|
||||||
|
migration: "discard",
|
||||||
|
quotaFallback: "feature-disable",
|
||||||
|
}),
|
||||||
|
AUTH_TOKEN: defineStorageKey({
|
||||||
|
logicalName: "AUTH_TOKEN",
|
||||||
|
scope: "auth",
|
||||||
|
name: "auth-token",
|
||||||
|
backend: "forbidden",
|
||||||
|
classification: "sensitive-forbidden",
|
||||||
|
schemaVersion: 1,
|
||||||
|
ttl: null,
|
||||||
|
migration: "discard",
|
||||||
|
quotaFallback: "feature-disable",
|
||||||
|
}),
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @typedef {{
|
||||||
|
* logicalName: string,
|
||||||
|
* scope: string,
|
||||||
|
* name: string,
|
||||||
|
* backend: "memory" | "sessionStorage" | "localStorage" | "indexedDB" |
|
||||||
|
* "disabled" | "forbidden",
|
||||||
|
* classification: "public-preference" | "opaque-cache" | "sensitive-forbidden",
|
||||||
|
* schemaVersion: number,
|
||||||
|
* ttl: number | "session" | null,
|
||||||
|
* migration: "discard" | ((value: unknown) => unknown),
|
||||||
|
* quotaFallback: "memory" | "no-persist" | "feature-disable"
|
||||||
|
* }} StorageKeyInput
|
||||||
|
*/
|
||||||
|
|
||||||
|
/** @param {StorageKeyInput} definition */
|
||||||
|
export function defineStorageKey(definition) {
|
||||||
|
if (definition.classification === "sensitive-forbidden") {
|
||||||
|
if (!["disabled", "forbidden"].includes(definition.backend)) {
|
||||||
|
throw new Error("Sensitive client storage registration is forbidden");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (!Number.isInteger(definition.schemaVersion) || definition.schemaVersion < 1) {
|
||||||
|
throw new Error("Storage schemaVersion must be a positive integer");
|
||||||
|
}
|
||||||
|
|
||||||
|
return Object.freeze({
|
||||||
|
...definition,
|
||||||
|
physicalKey: buildPhysicalKey(
|
||||||
|
definition.scope,
|
||||||
|
definition.schemaVersion,
|
||||||
|
definition.name,
|
||||||
|
),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @param {string} scope @param {number} schemaVersion @param {string} name */
|
||||||
|
export function buildPhysicalKey(scope, schemaVersion, name) {
|
||||||
|
return `${APP_NAMESPACE}:${scope}:v${schemaVersion}:${name}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @param {string} logicalName */
|
||||||
|
export function getStorageDefinition(logicalName) {
|
||||||
|
const registry = /** @type {Record<string, ReturnType<typeof defineStorageKey>>} */ (
|
||||||
|
STORAGE_REGISTRY
|
||||||
|
);
|
||||||
|
const definition = registry[logicalName];
|
||||||
|
if (!definition) throw new Error(`Unregistered storage key: ${logicalName}`);
|
||||||
|
if (definition.classification === "sensitive-forbidden") {
|
||||||
|
throw new Error(`Forbidden storage key: ${logicalName}`);
|
||||||
|
}
|
||||||
|
return definition;
|
||||||
|
}
|
||||||
@@ -0,0 +1,103 @@
|
|||||||
|
import { HttpResponse, http } from "msw";
|
||||||
|
import { setupServer } from "msw/node";
|
||||||
|
import { afterAll, afterEach, beforeAll, describe, expect, it, vi } from "vitest";
|
||||||
|
|
||||||
|
import { createExternalAuthSessionAdapter } from "../../src/adapters/auth/external-session-adapter.js";
|
||||||
|
import { createHttpClient } from "../../src/adapters/http/client.js";
|
||||||
|
|
||||||
|
let responseStatuses = [];
|
||||||
|
const server = setupServer(
|
||||||
|
http.get("https://api.test/api/sample/resources", () => {
|
||||||
|
const status = responseStatuses.shift() ?? 200;
|
||||||
|
if (status === 401) {
|
||||||
|
return HttpResponse.json(
|
||||||
|
{
|
||||||
|
success: false,
|
||||||
|
error: { code: "UNAUTHENTICATED" },
|
||||||
|
meta: { requestId: "request-1", traceId: "trace-1" },
|
||||||
|
},
|
||||||
|
{ status },
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return HttpResponse.json({
|
||||||
|
success: true,
|
||||||
|
data: [{ id: "resource-1", name: "Example" }],
|
||||||
|
meta: { requestId: "request-2", traceId: "trace-1" },
|
||||||
|
});
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
beforeAll(() => server.listen({ onUnhandledRequest: "error" }));
|
||||||
|
afterEach(() => {
|
||||||
|
responseStatuses = [];
|
||||||
|
server.resetHandlers();
|
||||||
|
});
|
||||||
|
afterAll(() => server.close());
|
||||||
|
|
||||||
|
const clock = { now: () => 0, sleep: async () => {} };
|
||||||
|
|
||||||
|
describe("bounded 401 session recovery", () => {
|
||||||
|
it("calls recovery once and replays a safe request once", async () => {
|
||||||
|
responseStatuses = [401, 200];
|
||||||
|
const recoverSession = vi.fn(async () => "restored");
|
||||||
|
const authSession = createExternalAuthSessionAdapter({
|
||||||
|
readState: () => "authenticated",
|
||||||
|
attachCredential: async (request) => request,
|
||||||
|
recoverSession,
|
||||||
|
notifyUnauthenticated: vi.fn(),
|
||||||
|
});
|
||||||
|
const client = createHttpClient({
|
||||||
|
baseUrl: "https://api.test",
|
||||||
|
authSession,
|
||||||
|
clock,
|
||||||
|
});
|
||||||
|
|
||||||
|
await expect(client.execute("LIST_SAMPLE_RESOURCES")).resolves.toMatchObject({
|
||||||
|
ok: true,
|
||||||
|
});
|
||||||
|
expect(recoverSession).toHaveBeenCalledTimes(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("stops after a second 401 and notifies unauthenticated once", async () => {
|
||||||
|
responseStatuses = [401, 401];
|
||||||
|
const notifyUnauthenticated = vi.fn();
|
||||||
|
const authSession = createExternalAuthSessionAdapter({
|
||||||
|
readState: () => "authenticated",
|
||||||
|
attachCredential: async (request) => request,
|
||||||
|
recoverSession: async () => "restored",
|
||||||
|
notifyUnauthenticated,
|
||||||
|
});
|
||||||
|
const client = createHttpClient({
|
||||||
|
baseUrl: "https://api.test",
|
||||||
|
authSession,
|
||||||
|
clock,
|
||||||
|
});
|
||||||
|
|
||||||
|
await expect(client.execute("LIST_SAMPLE_RESOURCES")).resolves.toMatchObject({
|
||||||
|
ok: false,
|
||||||
|
error: { kind: "AUTH_REQUIRED" },
|
||||||
|
});
|
||||||
|
expect(notifyUnauthenticated).toHaveBeenCalledTimes(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("normalizes attach and invalid recovery failures", async () => {
|
||||||
|
const attachFailure = createExternalAuthSessionAdapter({
|
||||||
|
readState: () => "authenticated",
|
||||||
|
attachCredential: async () => {
|
||||||
|
throw new Error("credential detail");
|
||||||
|
},
|
||||||
|
recoverSession: async () => "restored",
|
||||||
|
notifyUnauthenticated: vi.fn(),
|
||||||
|
});
|
||||||
|
const client = createHttpClient({
|
||||||
|
baseUrl: "https://api.test",
|
||||||
|
authSession: attachFailure,
|
||||||
|
clock,
|
||||||
|
});
|
||||||
|
|
||||||
|
await expect(client.execute("LIST_SAMPLE_RESOURCES")).resolves.toMatchObject({
|
||||||
|
ok: false,
|
||||||
|
error: { kind: "AUTH_INTEGRATION_FAILURE" },
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,102 @@
|
|||||||
|
import { HttpResponse, http } from "msw";
|
||||||
|
import { setupServer } from "msw/node";
|
||||||
|
import { afterAll, afterEach, beforeAll, describe, expect, it } from "vitest";
|
||||||
|
|
||||||
|
import { createHttpClient } from "../../src/adapters/http/client.js";
|
||||||
|
|
||||||
|
let attempts = 0;
|
||||||
|
const server = setupServer(
|
||||||
|
http.get("https://api.test/api/sample/resources", () => {
|
||||||
|
attempts += 1;
|
||||||
|
if (attempts < 3) {
|
||||||
|
return HttpResponse.json(
|
||||||
|
{ success: false, error: { code: "TEMPORARY" } },
|
||||||
|
{ status: 503 },
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return HttpResponse.json({
|
||||||
|
success: true,
|
||||||
|
data: [{ id: "resource-1", name: "Example" }],
|
||||||
|
meta: { requestId: "request-1", traceId: "trace-1" },
|
||||||
|
});
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
beforeAll(() => server.listen({ onUnhandledRequest: "error" }));
|
||||||
|
afterEach(() => {
|
||||||
|
attempts = 0;
|
||||||
|
server.resetHandlers();
|
||||||
|
});
|
||||||
|
afterAll(() => server.close());
|
||||||
|
|
||||||
|
const clock = {
|
||||||
|
now: () => 0,
|
||||||
|
sleep: async () => {},
|
||||||
|
};
|
||||||
|
|
||||||
|
describe("shared HTTP client", () => {
|
||||||
|
it("retries a safe request at most twice and returns validated data", async () => {
|
||||||
|
const client = createHttpClient({
|
||||||
|
baseUrl: "https://api.test",
|
||||||
|
clock,
|
||||||
|
random: () => 0,
|
||||||
|
});
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
client.execute("LIST_SAMPLE_RESOURCES", { routeId: "SAMPLE_RESOURCE_LIST" }),
|
||||||
|
).resolves.toMatchObject({
|
||||||
|
ok: true,
|
||||||
|
value: [{ id: "resource-1" }],
|
||||||
|
meta: { requestId: "request-1" },
|
||||||
|
});
|
||||||
|
expect(attempts).toBe(3);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("rejects a non-JSON response without exposing its body", async () => {
|
||||||
|
server.use(
|
||||||
|
http.get(
|
||||||
|
"https://api.test/api/sample/resources",
|
||||||
|
() => new HttpResponse("<secret>raw body</secret>", { status: 502 }),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
const client = createHttpClient({ baseUrl: "https://api.test", clock });
|
||||||
|
const result = await client.execute("LIST_SAMPLE_RESOURCES");
|
||||||
|
|
||||||
|
expect(result).toMatchObject({
|
||||||
|
ok: false,
|
||||||
|
error: { kind: "CONTENT_TYPE_MISMATCH" },
|
||||||
|
});
|
||||||
|
expect(JSON.stringify(result)).not.toContain("raw body");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("classifies malformed JSON and invalid payloads at the boundary", async () => {
|
||||||
|
server.use(
|
||||||
|
http.get(
|
||||||
|
"https://api.test/api/sample/resources",
|
||||||
|
() =>
|
||||||
|
new HttpResponse("{", {
|
||||||
|
headers: { "Content-Type": "application/json" },
|
||||||
|
}),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
const client = createHttpClient({ baseUrl: "https://api.test", clock });
|
||||||
|
await expect(client.execute("LIST_SAMPLE_RESOURCES")).resolves.toMatchObject({
|
||||||
|
ok: false,
|
||||||
|
error: { kind: "MALFORMED_JSON" },
|
||||||
|
});
|
||||||
|
|
||||||
|
server.use(
|
||||||
|
http.get("https://api.test/api/sample/resources", () =>
|
||||||
|
HttpResponse.json({
|
||||||
|
success: true,
|
||||||
|
data: [{ id: "resource-1", name: 42 }],
|
||||||
|
meta: { requestId: "request-1", traceId: "trace-1" },
|
||||||
|
}),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
await expect(client.execute("LIST_SAMPLE_RESOURCES")).resolves.toMatchObject({
|
||||||
|
ok: false,
|
||||||
|
error: { kind: "SCHEMA_MISMATCH" },
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,53 @@
|
|||||||
|
import { describe, expect, it } from "vitest";
|
||||||
|
|
||||||
|
import {
|
||||||
|
validateEnvelope,
|
||||||
|
validateOperationPayload,
|
||||||
|
validateOperationRequest,
|
||||||
|
} from "../../src/adapters/http/schema-registry.js";
|
||||||
|
|
||||||
|
describe("HTTP runtime schema boundary", () => {
|
||||||
|
it("rejects an invalid top-level envelope", () => {
|
||||||
|
expect(validateEnvelope({ success: true }).success).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("rejects an invalid operation payload with safe issue metadata", () => {
|
||||||
|
const result = validateOperationPayload("SampleResourceListPayload", [
|
||||||
|
{ id: "resource-1", name: 42 },
|
||||||
|
]);
|
||||||
|
|
||||||
|
expect(result).toMatchObject({
|
||||||
|
success: false,
|
||||||
|
issues: [{ path: "0.name" }],
|
||||||
|
});
|
||||||
|
expect(JSON.stringify(result)).not.toContain("resource-1");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("returns a deep-cloned additive-tolerant payload", () => {
|
||||||
|
const source = [{ id: "resource-1", name: "Example", additive: "accepted" }];
|
||||||
|
const result = validateOperationPayload("SampleResourceListPayload", source);
|
||||||
|
|
||||||
|
expect(result).toMatchObject({
|
||||||
|
success: true,
|
||||||
|
data: [{ id: "resource-1", additive: "accepted" }],
|
||||||
|
});
|
||||||
|
expect(result.data).not.toBe(source);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("validates outbound commands before transport", () => {
|
||||||
|
expect(
|
||||||
|
validateOperationRequest("CreateSampleResourceCommand", { name: "" }).success,
|
||||||
|
).toBe(false);
|
||||||
|
expect(
|
||||||
|
validateOperationRequest("CreateSampleResourceCommand", { name: "Example" })
|
||||||
|
.success,
|
||||||
|
).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("fails closed for an unregistered schema", () => {
|
||||||
|
expect(validateOperationPayload("UnknownPayload", {})).toMatchObject({
|
||||||
|
success: false,
|
||||||
|
issues: [{ code: "SCHEMA_NOT_REGISTERED" }],
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
import { describe, expect, it, vi } from "vitest";
|
||||||
|
|
||||||
|
import {
|
||||||
|
createAnonymousSessionAdapter,
|
||||||
|
createExternalAuthSessionAdapter,
|
||||||
|
} from "../../src/adapters/auth/external-session-adapter.js";
|
||||||
|
|
||||||
|
describe("external AuthSessionPort adapter", () => {
|
||||||
|
it("attaches opaque credentials without exposing a token-shaped session", async () => {
|
||||||
|
const adapter = createExternalAuthSessionAdapter({
|
||||||
|
readState: () => "authenticated",
|
||||||
|
attachCredential: async (request) => {
|
||||||
|
const headers = new Headers(request.headers);
|
||||||
|
headers.set("X-Session-Attached", "true");
|
||||||
|
return new Request(request, { headers });
|
||||||
|
},
|
||||||
|
recoverSession: async () => "restored",
|
||||||
|
notifyUnauthenticated: vi.fn(),
|
||||||
|
});
|
||||||
|
|
||||||
|
const request = await adapter.attach(new Request("https://api.test/resource"));
|
||||||
|
expect(request.headers.get("X-Session-Attached")).toBe("true");
|
||||||
|
expect(adapter.getState()).toBe("authenticated");
|
||||||
|
expect(adapter).not.toHaveProperty("accessToken");
|
||||||
|
expect(adapter).not.toHaveProperty("refreshToken");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("fails invalid recovery states closed", async () => {
|
||||||
|
const adapter = createExternalAuthSessionAdapter({
|
||||||
|
readState: () => "authenticated",
|
||||||
|
attachCredential: async (request) => request,
|
||||||
|
recoverSession: async () => "unexpected",
|
||||||
|
notifyUnauthenticated: vi.fn(),
|
||||||
|
});
|
||||||
|
|
||||||
|
await expect(adapter.recover()).rejects.toThrow("invalid recovery state");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("provides a safe anonymous adapter", async () => {
|
||||||
|
const adapter = createAnonymousSessionAdapter();
|
||||||
|
expect(adapter.getState()).toBe("unauthenticated");
|
||||||
|
await expect(adapter.recover()).resolves.toBe("no-session");
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,70 @@
|
|||||||
|
import { describe, expect, it } from "vitest";
|
||||||
|
|
||||||
|
import {
|
||||||
|
ERROR_REGISTRY,
|
||||||
|
createFailure,
|
||||||
|
kindForStatus,
|
||||||
|
normalizeUnknownFailure,
|
||||||
|
} from "../../src/contracts/errors.js";
|
||||||
|
|
||||||
|
describe("frontend failure classification", () => {
|
||||||
|
it("defines all 26 stable error kinds with the seven contract fields", () => {
|
||||||
|
expect(Object.keys(ERROR_REGISTRY)).toHaveLength(26);
|
||||||
|
for (const definition of Object.values(ERROR_REGISTRY)) {
|
||||||
|
expect(definition).toEqual(
|
||||||
|
expect.objectContaining({
|
||||||
|
kind: expect.any(String),
|
||||||
|
defaultRetryable: expect.any(Boolean),
|
||||||
|
severity: expect.any(String),
|
||||||
|
userMessageKey: expect.any(String),
|
||||||
|
action: expect.any(String),
|
||||||
|
telemetryEvent: expect.any(String),
|
||||||
|
redaction: expect.any(Array),
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
it.each([
|
||||||
|
[401, "AUTH_REQUIRED"],
|
||||||
|
[403, "FORBIDDEN"],
|
||||||
|
[404, "NOT_FOUND"],
|
||||||
|
[409, "CONFLICT"],
|
||||||
|
[422, "VALIDATION_REJECTED"],
|
||||||
|
[418, "UNKNOWN_CLIENT_FAILURE"],
|
||||||
|
[429, "RATE_LIMITED"],
|
||||||
|
[503, "SERVER_FAILURE"],
|
||||||
|
])("maps HTTP %i to %s", (status, kind) => {
|
||||||
|
expect(kindForStatus(status)).toBe(kind);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("projects only allowlisted safe fields", () => {
|
||||||
|
const result = createFailure("SERVER_FAILURE", "LIST_SAMPLE_RESOURCES", 0, {
|
||||||
|
code: "TEMPORARY",
|
||||||
|
httpStatus: 503,
|
||||||
|
requestId: "request-1",
|
||||||
|
stack: "must not leak",
|
||||||
|
body: "must not leak",
|
||||||
|
authorization: "Bearer secret",
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(result).toMatchObject({
|
||||||
|
kind: "SERVER_FAILURE",
|
||||||
|
code: "TEMPORARY",
|
||||||
|
httpStatus: 503,
|
||||||
|
requestId: "request-1",
|
||||||
|
});
|
||||||
|
expect(JSON.stringify(result)).not.toMatch(/stack|body|Bearer|secret/);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("normalizes any thrown value without leaking it", () => {
|
||||||
|
const secret = { token: "sensitive", nested: { rawBody: "private" } };
|
||||||
|
const result = normalizeUnknownFailure(secret);
|
||||||
|
|
||||||
|
expect(result).toMatchObject({
|
||||||
|
kind: "UNKNOWN_FAILURE",
|
||||||
|
causeClass: "object",
|
||||||
|
});
|
||||||
|
expect(JSON.stringify(result)).not.toMatch(/sensitive|private|token|rawBody/);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,55 @@
|
|||||||
|
import { QueryClient } from "@tanstack/react-query";
|
||||||
|
import { describe, expect, it, vi } from "vitest";
|
||||||
|
|
||||||
|
import {
|
||||||
|
createQueryCacheAdapter,
|
||||||
|
createQueryClient,
|
||||||
|
} from "../../src/adapters/query-cache/tanstack-query-cache.js";
|
||||||
|
import { queryKeys } from "../../src/contracts/query-keys.js";
|
||||||
|
|
||||||
|
describe("query key registry", () => {
|
||||||
|
it("canonicalizes filter order into the same stable key", () => {
|
||||||
|
expect(queryKeys.resource.list({ page: 1, status: "open" })).toEqual(
|
||||||
|
queryKeys.resource.list({ status: "open", page: 1 }),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("contains no raw URL or token material", () => {
|
||||||
|
expect(JSON.stringify(queryKeys.resource.detail("resource-1"))).toBe(
|
||||||
|
'["resource",1,"detail","resource-1"]',
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("TanStack QueryCachePort adapter", () => {
|
||||||
|
it("reads, writes, and invalidates only the declared namespace", async () => {
|
||||||
|
const client = createQueryClient();
|
||||||
|
const adapter = createQueryCacheAdapter(client);
|
||||||
|
const listKey = queryKeys.resource.list({ page: 1 });
|
||||||
|
const otherKey = ["other", 1];
|
||||||
|
|
||||||
|
expect(adapter.write(listKey, [{ id: "resource-1" }])).toEqual({ ok: true });
|
||||||
|
expect(adapter.write(otherKey, "preserved")).toEqual({ ok: true });
|
||||||
|
expect(adapter.read(listKey)).toMatchObject({
|
||||||
|
ok: true,
|
||||||
|
value: [{ id: "resource-1" }],
|
||||||
|
});
|
||||||
|
|
||||||
|
await adapter.invalidate(queryKeys.resource.all());
|
||||||
|
expect(client.getQueryState(listKey)?.isInvalidated).toBe(true);
|
||||||
|
expect(client.getQueryState(otherKey)?.isInvalidated).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
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 result = await adapter.invalidate(["resource", "sensitive-filter"]);
|
||||||
|
|
||||||
|
expect(result).toMatchObject({
|
||||||
|
ok: false,
|
||||||
|
error: { kind: "QUERY_CACHE_FAILURE" },
|
||||||
|
});
|
||||||
|
expect(JSON.stringify(result)).not.toContain("sensitive-filter");
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,47 @@
|
|||||||
|
import { describe, expect, it } from "vitest";
|
||||||
|
|
||||||
|
import {
|
||||||
|
calculateBackoff,
|
||||||
|
parseRetryAfter,
|
||||||
|
retryDelay,
|
||||||
|
shouldRetry,
|
||||||
|
} from "../../src/adapters/http/retry-policy.js";
|
||||||
|
|
||||||
|
describe("HTTP retry policy", () => {
|
||||||
|
it("uses capped exponential full jitter", () => {
|
||||||
|
expect(calculateBackoff(0, () => 0.5)).toBe(125);
|
||||||
|
expect(calculateBackoff(8, () => 1)).toBe(2_000);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("parses retry-after and chooses the longer bounded delay", () => {
|
||||||
|
expect(parseRetryAfter("2", 0)).toBe(2_000);
|
||||||
|
expect(retryDelay({ kind: "RATE_LIMITED", retryAfterMs: 500 }, 0, () => 0)).toBe(
|
||||||
|
500,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("allows at most two retries for safe or keyed requests", () => {
|
||||||
|
const failure = { kind: "SERVER_FAILURE" };
|
||||||
|
expect(shouldRetry({ idempotency: "safe" }, failure, 0)).toBe(true);
|
||||||
|
expect(shouldRetry({ idempotency: "keyed" }, failure, 1)).toBe(true);
|
||||||
|
expect(shouldRetry({ idempotency: "safe" }, failure, 2)).toBe(false);
|
||||||
|
expect(shouldRetry({ idempotency: "none" }, failure, 0)).toBe(false);
|
||||||
|
expect(
|
||||||
|
shouldRetry(
|
||||||
|
{ idempotency: "safe" },
|
||||||
|
{ kind: "SERVER_FAILURE", httpStatus: 500 },
|
||||||
|
0,
|
||||||
|
),
|
||||||
|
).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("does not automatically wait beyond 30 seconds", () => {
|
||||||
|
expect(
|
||||||
|
shouldRetry(
|
||||||
|
{ idempotency: "safe" },
|
||||||
|
{ kind: "RATE_LIMITED", retryAfterMs: 31_000 },
|
||||||
|
0,
|
||||||
|
),
|
||||||
|
).toBe(false);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,78 @@
|
|||||||
|
import { describe, expect, it } from "vitest";
|
||||||
|
|
||||||
|
import { createBrowserStorageAdapter } from "../../src/adapters/storage/browser-storage-adapter.js";
|
||||||
|
import {
|
||||||
|
STORAGE_REGISTRY,
|
||||||
|
buildPhysicalKey,
|
||||||
|
defineStorageKey,
|
||||||
|
} from "../../src/contracts/storage-keys.js";
|
||||||
|
|
||||||
|
function createStorage({ quota = false } = {}) {
|
||||||
|
const values = new Map();
|
||||||
|
return {
|
||||||
|
getItem: (key) => values.get(key) ?? null,
|
||||||
|
setItem: (key, value) => {
|
||||||
|
if (quota) throw new DOMException("full", "QuotaExceededError");
|
||||||
|
values.set(key, value);
|
||||||
|
},
|
||||||
|
removeItem: (key) => values.delete(key),
|
||||||
|
clear: () => values.clear(),
|
||||||
|
key: () => null,
|
||||||
|
get length() {
|
||||||
|
return values.size;
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("storage registry", () => {
|
||||||
|
it("builds namespace and schema-versioned physical keys", () => {
|
||||||
|
expect(buildPhysicalKey("preference", 2, "theme")).toBe(
|
||||||
|
"ca-frontend:preference:v2:theme",
|
||||||
|
);
|
||||||
|
expect(STORAGE_REGISTRY.COLOR_SCHEME.physicalKey).toContain(":v1:");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("rejects token or secret persistence registrations", () => {
|
||||||
|
expect(() =>
|
||||||
|
defineStorageKey({
|
||||||
|
logicalName: "TOKEN",
|
||||||
|
scope: "auth",
|
||||||
|
name: "token",
|
||||||
|
backend: "localStorage",
|
||||||
|
classification: "sensitive-forbidden",
|
||||||
|
schemaVersion: 1,
|
||||||
|
ttl: null,
|
||||||
|
migration: "discard",
|
||||||
|
quotaFallback: "feature-disable",
|
||||||
|
}),
|
||||||
|
).toThrow("Sensitive client storage registration is forbidden");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("round-trips public preferences through the adapter", () => {
|
||||||
|
const localStorage = createStorage();
|
||||||
|
const adapter = createBrowserStorageAdapter({ localStorage });
|
||||||
|
expect(adapter.write("COLOR_SCHEME", "dark")).toEqual({ ok: true });
|
||||||
|
expect(adapter.read("COLOR_SCHEME")).toEqual({ ok: true, value: "dark" });
|
||||||
|
});
|
||||||
|
|
||||||
|
it("falls back to memory when preference storage quota is exceeded", () => {
|
||||||
|
const localStorage = createStorage({ quota: true });
|
||||||
|
const adapter = createBrowserStorageAdapter({ localStorage });
|
||||||
|
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" });
|
||||||
|
});
|
||||||
|
|
||||||
|
it("discards data from a previous schema version", () => {
|
||||||
|
const localStorage = createStorage();
|
||||||
|
localStorage.setItem(
|
||||||
|
STORAGE_REGISTRY.COLOR_SCHEME.physicalKey,
|
||||||
|
JSON.stringify({ schemaVersion: 0, value: "dark" }),
|
||||||
|
);
|
||||||
|
const adapter = createBrowserStorageAdapter({ localStorage });
|
||||||
|
expect(adapter.read("COLOR_SCHEME")).toEqual({ ok: true, value: undefined });
|
||||||
|
});
|
||||||
|
});
|
||||||
Reference in New Issue
Block a user