Compare commits
6
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
bf813f09ab | ||
|
|
0934de44c7 | ||
|
|
5c36cd978c | ||
|
|
b193feeddc | ||
|
|
6b51104010 | ||
|
|
7199d7d9b6 |
+2
-1
@@ -26,7 +26,8 @@
|
|||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"react": "19.2.8",
|
"react": "19.2.8",
|
||||||
"react-dom": "19.2.8"
|
"react-dom": "19.2.8",
|
||||||
|
"zod": "4.4.3"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@axe-core/playwright": "4.12.1",
|
"@axe-core/playwright": "4.12.1",
|
||||||
|
|||||||
Generated
+8
@@ -14,6 +14,9 @@ importers:
|
|||||||
react-dom:
|
react-dom:
|
||||||
specifier: 19.2.8
|
specifier: 19.2.8
|
||||||
version: 19.2.8(react@19.2.8)
|
version: 19.2.8(react@19.2.8)
|
||||||
|
zod:
|
||||||
|
specifier: 4.4.3
|
||||||
|
version: 4.4.3
|
||||||
devDependencies:
|
devDependencies:
|
||||||
'@axe-core/playwright':
|
'@axe-core/playwright':
|
||||||
specifier: 4.12.1
|
specifier: 4.12.1
|
||||||
@@ -1584,6 +1587,9 @@ packages:
|
|||||||
resolution: {integrity: sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==}
|
resolution: {integrity: sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==}
|
||||||
engines: {node: '>=10'}
|
engines: {node: '>=10'}
|
||||||
|
|
||||||
|
zod@4.4.3:
|
||||||
|
resolution: {integrity: sha512-ytENFjIJFl2UwYglde2jchW2Hwm4GJFLDiSXWdTrJQBIN9Fcyp7n4DhxJEiWNAJMV1/BqWfW/kkg71UDcHJyTQ==}
|
||||||
|
|
||||||
snapshots:
|
snapshots:
|
||||||
|
|
||||||
'@adobe/css-tools@4.5.0': {}
|
'@adobe/css-tools@4.5.0': {}
|
||||||
@@ -2866,3 +2872,5 @@ snapshots:
|
|||||||
yargs-parser: 21.1.1
|
yargs-parser: 21.1.1
|
||||||
|
|
||||||
yocto-queue@0.1.0: {}
|
yocto-queue@0.1.0: {}
|
||||||
|
|
||||||
|
zod@4.4.3: {}
|
||||||
|
|||||||
@@ -0,0 +1,13 @@
|
|||||||
|
{
|
||||||
|
"APP_ENV": "local",
|
||||||
|
"API_BASE_URL": "http://localhost:8080",
|
||||||
|
"REQUEST_TIMEOUT_MS": 10000,
|
||||||
|
"MAX_RETRY_ATTEMPTS": 2,
|
||||||
|
"TELEMETRY_ENABLED": false,
|
||||||
|
"AUTH_MODE": "external",
|
||||||
|
"CONFIG_SCHEMA_VERSION": "1",
|
||||||
|
"API_CONTRACT_VERSION": "1",
|
||||||
|
"RELEASE_MANIFEST_URL": "/release-manifest.json",
|
||||||
|
"BUILD_ID": "local-build",
|
||||||
|
"RELEASE_ID": "local-release"
|
||||||
|
}
|
||||||
@@ -0,0 +1,454 @@
|
|||||||
|
import { systemClock } from "../../application/ports/clock-port.js";
|
||||||
|
import { getApiOperation } from "../../contracts/api-operations.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
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @typedef {{
|
||||||
|
* code?: string,
|
||||||
|
* httpStatus?: number,
|
||||||
|
* requestId?: string,
|
||||||
|
* traceId?: string,
|
||||||
|
* retryAfterMs?: number
|
||||||
|
* }} FailureDetails
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @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 (!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}
|
||||||
|
*/
|
||||||
|
function failure(kind, operationId, attempt, details = {}) {
|
||||||
|
const retryable = new Set([
|
||||||
|
"NETWORK_UNREACHABLE",
|
||||||
|
"REQUEST_TIMEOUT",
|
||||||
|
"RATE_LIMITED",
|
||||||
|
"SERVER_FAILURE",
|
||||||
|
]).has(kind);
|
||||||
|
const action =
|
||||||
|
kind === "AUTH_REQUIRED"
|
||||||
|
? "reauth"
|
||||||
|
: retryable
|
||||||
|
? "retry"
|
||||||
|
: kind === "REQUEST_ABORTED"
|
||||||
|
? "none"
|
||||||
|
: "contact-support";
|
||||||
|
|
||||||
|
return Object.freeze({
|
||||||
|
kind,
|
||||||
|
code: details.code ?? kind,
|
||||||
|
retryable,
|
||||||
|
operationId,
|
||||||
|
attemptCount: attempt + 1,
|
||||||
|
...(details.httpStatus === undefined ? {} : { httpStatus: details.httpStatus }),
|
||||||
|
...(details.requestId ? { requestId: details.requestId } : {}),
|
||||||
|
...(details.traceId ? { traceId: details.traceId } : {}),
|
||||||
|
...(details.retryAfterMs === undefined
|
||||||
|
? {}
|
||||||
|
: { retryAfterMs: details.retryAfterMs }),
|
||||||
|
userMessageKey: `error.${kind.toLowerCase()}`,
|
||||||
|
action,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @param {number} status */
|
||||||
|
function statusKind(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";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @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,104 @@
|
|||||||
|
import { assertSafeConfigNames, getBuildConfig } from "../contracts/env.js";
|
||||||
|
import { validateRuntimeConfig } from "./runtime-config-schema.js";
|
||||||
|
|
||||||
|
export class BootConfigError extends Error {
|
||||||
|
/**
|
||||||
|
* @param {string} code
|
||||||
|
* @param {{ buildId: string, configSchemaVersion?: string, releaseId?: string }} safe
|
||||||
|
*/
|
||||||
|
constructor(code, safe) {
|
||||||
|
super("Runtime configuration could not be loaded");
|
||||||
|
this.name = "BootConfigError";
|
||||||
|
this.kind = "BOOT_CONFIG_FAILURE";
|
||||||
|
this.code = code;
|
||||||
|
this.safe = Object.freeze({
|
||||||
|
kind: this.kind,
|
||||||
|
code,
|
||||||
|
buildId: safe.buildId,
|
||||||
|
configSchemaVersion: safe.configSchemaVersion,
|
||||||
|
releaseId: safe.releaseId,
|
||||||
|
supportReference: `${safe.buildId}:${code}`,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {{
|
||||||
|
* fetcher?: typeof fetch,
|
||||||
|
* buildConfig?: ReturnType<typeof getBuildConfig>,
|
||||||
|
* now?: () => number
|
||||||
|
* }} [options]
|
||||||
|
*/
|
||||||
|
export async function loadRuntimeConfig(options = {}) {
|
||||||
|
const fetcher = options.fetcher ?? fetch;
|
||||||
|
const buildConfig = options.buildConfig ?? getBuildConfig();
|
||||||
|
const now = options.now ?? performance.now.bind(performance);
|
||||||
|
const startedAt = now();
|
||||||
|
|
||||||
|
let response;
|
||||||
|
try {
|
||||||
|
response = await fetcher(buildConfig.runtimeConfigUrl, {
|
||||||
|
cache: "no-store",
|
||||||
|
headers: { Accept: "application/json" },
|
||||||
|
});
|
||||||
|
} catch {
|
||||||
|
throw new BootConfigError("CONFIG_FETCH_FAILED", {
|
||||||
|
buildId: buildConfig.buildId,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!response.ok) {
|
||||||
|
throw new BootConfigError("CONFIG_HTTP_FAILED", {
|
||||||
|
buildId: buildConfig.buildId,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
let rawConfig;
|
||||||
|
try {
|
||||||
|
rawConfig = await response.json();
|
||||||
|
} catch {
|
||||||
|
throw new BootConfigError("CONFIG_JSON_INVALID", {
|
||||||
|
buildId: buildConfig.buildId,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!rawConfig || typeof rawConfig !== "object" || Array.isArray(rawConfig)) {
|
||||||
|
throw new BootConfigError("CONFIG_SHAPE_INVALID", {
|
||||||
|
buildId: buildConfig.buildId,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
assertSafeConfigNames(rawConfig);
|
||||||
|
} catch {
|
||||||
|
throw new BootConfigError("CONFIG_SECRET_NAME_REJECTED", {
|
||||||
|
buildId: buildConfig.buildId,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
const validated = validateRuntimeConfig(rawConfig);
|
||||||
|
if (!validated.success) {
|
||||||
|
throw new BootConfigError("CONFIG_SCHEMA_INVALID", {
|
||||||
|
buildId: buildConfig.buildId,
|
||||||
|
configSchemaVersion:
|
||||||
|
typeof rawConfig.CONFIG_SCHEMA_VERSION === "string"
|
||||||
|
? rawConfig.CONFIG_SCHEMA_VERSION
|
||||||
|
: undefined,
|
||||||
|
releaseId: typeof rawConfig.RELEASE_ID === "string" ? rawConfig.RELEASE_ID : undefined,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
if (validated.data.BUILD_ID && validated.data.BUILD_ID !== buildConfig.buildId) {
|
||||||
|
throw new BootConfigError("CONFIG_BUILD_MISMATCH", {
|
||||||
|
buildId: buildConfig.buildId,
|
||||||
|
configSchemaVersion: validated.data.CONFIG_SCHEMA_VERSION,
|
||||||
|
releaseId: validated.data.RELEASE_ID,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
return Object.freeze({
|
||||||
|
config: validated.data,
|
||||||
|
build: buildConfig,
|
||||||
|
validationDurationMs: now() - startedAt,
|
||||||
|
});
|
||||||
|
}
|
||||||
+34
-5
@@ -1,11 +1,24 @@
|
|||||||
import { StrictMode } from "react";
|
import { StrictMode } from "react";
|
||||||
import { createRoot } from "react-dom/client";
|
import { createRoot } from "react-dom/client";
|
||||||
|
|
||||||
function BootstrapShell() {
|
import { BootConfigError, loadRuntimeConfig } from "./load-runtime-config.js";
|
||||||
|
|
||||||
|
/** @param {{ environment: string }} props */
|
||||||
|
function BootstrapShell({ environment }) {
|
||||||
return (
|
return (
|
||||||
<main>
|
<main>
|
||||||
<h1>Clean Architecture Frontend</h1>
|
<h1>Clean Architecture Frontend</h1>
|
||||||
<p>런타임 계약을 불러오는 중입니다.</p>
|
<p>{environment} 런타임 계약이 검증되었습니다.</p>
|
||||||
|
</main>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @param {{ supportReference: string }} props */
|
||||||
|
function BootErrorShell({ supportReference }) {
|
||||||
|
return (
|
||||||
|
<main role="alert">
|
||||||
|
<h1>애플리케이션을 시작할 수 없습니다.</h1>
|
||||||
|
<p>지원 참조: {supportReference}</p>
|
||||||
</main>
|
</main>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
@@ -16,8 +29,24 @@ if (!rootElement) {
|
|||||||
throw new Error("Missing #root mount element");
|
throw new Error("Missing #root mount element");
|
||||||
}
|
}
|
||||||
|
|
||||||
createRoot(rootElement).render(
|
const root = createRoot(rootElement);
|
||||||
|
|
||||||
|
async function boot() {
|
||||||
|
try {
|
||||||
|
const runtime = await loadRuntimeConfig();
|
||||||
|
root.render(
|
||||||
<StrictMode>
|
<StrictMode>
|
||||||
<BootstrapShell />
|
<BootstrapShell environment={runtime.config.APP_ENV} />
|
||||||
</StrictMode>,
|
</StrictMode>,
|
||||||
);
|
);
|
||||||
|
} catch (error) {
|
||||||
|
const supportReference =
|
||||||
|
error instanceof BootConfigError
|
||||||
|
? error.safe.supportReference
|
||||||
|
: "boot:unknown";
|
||||||
|
|
||||||
|
root.render(<BootErrorShell supportReference={supportReference} />);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void boot();
|
||||||
|
|||||||
@@ -0,0 +1,66 @@
|
|||||||
|
import { z } from "zod";
|
||||||
|
|
||||||
|
const version = z.string().regex(/^\d+(?:\.\d+){0,2}$/);
|
||||||
|
|
||||||
|
export const runtimeConfigSchema = z
|
||||||
|
.object({
|
||||||
|
APP_ENV: z.enum(["local", "development", "staging", "production"]),
|
||||||
|
API_BASE_URL: z.url(),
|
||||||
|
REQUEST_TIMEOUT_MS: z.int().min(100).max(60_000).default(10_000),
|
||||||
|
MAX_RETRY_ATTEMPTS: z.int().min(0).max(2).default(2),
|
||||||
|
TELEMETRY_ENABLED: z.boolean(),
|
||||||
|
TELEMETRY_ENDPOINT: z.url().optional(),
|
||||||
|
AUTH_MODE: z.literal("external"),
|
||||||
|
CONFIG_SCHEMA_VERSION: version,
|
||||||
|
API_CONTRACT_VERSION: version,
|
||||||
|
RELEASE_MANIFEST_URL: z.string().min(1).default("/release-manifest.json"),
|
||||||
|
RELEASE_ID: z.string().min(1).optional(),
|
||||||
|
BUILD_ID: z.string().min(1).optional(),
|
||||||
|
})
|
||||||
|
.strict()
|
||||||
|
.superRefine((config, context) => {
|
||||||
|
if (config.TELEMETRY_ENABLED && !config.TELEMETRY_ENDPOINT) {
|
||||||
|
context.addIssue({
|
||||||
|
code: "custom",
|
||||||
|
path: ["TELEMETRY_ENDPOINT"],
|
||||||
|
message: "required when telemetry is enabled",
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
const local = config.APP_ENV === "local" || config.APP_ENV === "development";
|
||||||
|
const endpointEntries =
|
||||||
|
/** @type {Array<[string, string | undefined]>} */ ([
|
||||||
|
["API_BASE_URL", config.API_BASE_URL],
|
||||||
|
["TELEMETRY_ENDPOINT", config.TELEMETRY_ENDPOINT],
|
||||||
|
]);
|
||||||
|
|
||||||
|
for (const [key, value] of endpointEntries) {
|
||||||
|
if (value && !local && new URL(value).protocol !== "https:") {
|
||||||
|
context.addIssue({
|
||||||
|
code: "custom",
|
||||||
|
path: [key],
|
||||||
|
message: "HTTPS is required outside local environments",
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
/** @param {unknown} value */
|
||||||
|
export function validateRuntimeConfig(value) {
|
||||||
|
const result = runtimeConfigSchema.safeParse(value);
|
||||||
|
|
||||||
|
if (!result.success) {
|
||||||
|
return {
|
||||||
|
success: /** @type {false} */ (false),
|
||||||
|
issues: result.error.issues.map((issue) => ({
|
||||||
|
path: issue.path.join("."),
|
||||||
|
code: issue.code,
|
||||||
|
})),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
success: /** @type {true} */ (true),
|
||||||
|
data: structuredClone(result.data),
|
||||||
|
};
|
||||||
|
}
|
||||||
@@ -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,54 @@
|
|||||||
|
const forbiddenConfigName = /(SECRET|PASSWORD|PRIVATE_KEY|TOKEN)/i;
|
||||||
|
|
||||||
|
export const ENV_REGISTRY = Object.freeze({
|
||||||
|
VITE_BUILD_ID: build("public-metadata", true, null),
|
||||||
|
VITE_COMMIT_SHA: build("public-metadata", false, "local"),
|
||||||
|
VITE_ROUTER_BASE_PATH: build("compile-time", true, "/"),
|
||||||
|
VITE_RUNTIME_CONFIG_URL: build("compile-time", true, "/config.json"),
|
||||||
|
APP_ENV: runtime("public", true, null),
|
||||||
|
API_BASE_URL: runtime("public-sensitive", true, null),
|
||||||
|
REQUEST_TIMEOUT_MS: runtime("public", false, 10_000),
|
||||||
|
MAX_RETRY_ATTEMPTS: runtime("public", false, 2),
|
||||||
|
TELEMETRY_ENABLED: runtime("public", true, false),
|
||||||
|
TELEMETRY_ENDPOINT: runtime("public-sensitive", false, null),
|
||||||
|
AUTH_MODE: runtime("public", true, "external"),
|
||||||
|
CONFIG_SCHEMA_VERSION: runtime("public", true, null),
|
||||||
|
API_CONTRACT_VERSION: runtime("public", true, null),
|
||||||
|
RELEASE_MANIFEST_URL: runtime("public", true, "/release-manifest.json"),
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {string} classification
|
||||||
|
* @param {boolean} required
|
||||||
|
* @param {unknown} defaultValue
|
||||||
|
*/
|
||||||
|
function build(classification, required, defaultValue) {
|
||||||
|
return Object.freeze({ phase: "build", classification, required, defaultValue });
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {string} classification
|
||||||
|
* @param {boolean} required
|
||||||
|
* @param {unknown} defaultValue
|
||||||
|
*/
|
||||||
|
function runtime(classification, required, defaultValue) {
|
||||||
|
return Object.freeze({ phase: "runtime", classification, required, defaultValue });
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @param {Record<string, unknown>} config */
|
||||||
|
export function assertSafeConfigNames(config) {
|
||||||
|
for (const name of Object.keys(config)) {
|
||||||
|
if (forbiddenConfigName.test(name)) {
|
||||||
|
throw new Error(`Forbidden client configuration key: ${name}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export function getBuildConfig(environment = import.meta.env) {
|
||||||
|
const buildId = environment.VITE_BUILD_ID || "local-build";
|
||||||
|
const commitSha = environment.VITE_COMMIT_SHA || "local";
|
||||||
|
const routerBasePath = environment.VITE_ROUTER_BASE_PATH || "/";
|
||||||
|
const runtimeConfigUrl = environment.VITE_RUNTIME_CONFIG_URL || "/config.json";
|
||||||
|
|
||||||
|
return Object.freeze({ buildId, commitSha, routerBasePath, runtimeConfigUrl });
|
||||||
|
}
|
||||||
@@ -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,73 @@
|
|||||||
|
import { describe, expect, it } from "vitest";
|
||||||
|
|
||||||
|
import { loadRuntimeConfig } from "../../src/bootstrap/load-runtime-config.js";
|
||||||
|
import { validateRuntimeConfig } from "../../src/bootstrap/runtime-config-schema.js";
|
||||||
|
import { assertSafeConfigNames } from "../../src/contracts/env.js";
|
||||||
|
|
||||||
|
const validConfig = {
|
||||||
|
APP_ENV: "local",
|
||||||
|
API_BASE_URL: "http://localhost:8080",
|
||||||
|
REQUEST_TIMEOUT_MS: 10_000,
|
||||||
|
MAX_RETRY_ATTEMPTS: 2,
|
||||||
|
TELEMETRY_ENABLED: false,
|
||||||
|
AUTH_MODE: "external",
|
||||||
|
CONFIG_SCHEMA_VERSION: "1",
|
||||||
|
API_CONTRACT_VERSION: "1",
|
||||||
|
RELEASE_MANIFEST_URL: "/release-manifest.json",
|
||||||
|
BUILD_ID: "build-a",
|
||||||
|
};
|
||||||
|
|
||||||
|
describe("runtime configuration boundary", () => {
|
||||||
|
it.each([
|
||||||
|
[{ ...validConfig, API_BASE_URL: undefined }, "required key"],
|
||||||
|
[{ ...validConfig, REQUEST_TIMEOUT_MS: 0 }, "integer range"],
|
||||||
|
[{ ...validConfig, MAX_RETRY_ATTEMPTS: 3 }, "retry cap"],
|
||||||
|
[{ ...validConfig, TELEMETRY_ENABLED: "false" }, "ambiguous boolean"],
|
||||||
|
[{ ...validConfig, CONFIG_SCHEMA_VERSION: "next" }, "version"],
|
||||||
|
[{ ...validConfig, UNKNOWN_KEY: true }, "unknown key"],
|
||||||
|
])("rejects invalid config: %s (%s)", (candidate) => {
|
||||||
|
expect(validateRuntimeConfig(candidate).success).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("rejects secret-like names before schema validation", () => {
|
||||||
|
expect(() => assertSafeConfigNames({ CLIENT_SECRET: "not-safe" })).toThrow(
|
||||||
|
"Forbidden client configuration key",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("validates a fetched config under the 500ms budget excluding network", async () => {
|
||||||
|
let current = 100;
|
||||||
|
const result = await loadRuntimeConfig({
|
||||||
|
buildConfig: {
|
||||||
|
buildId: "build-a",
|
||||||
|
commitSha: "local",
|
||||||
|
routerBasePath: "/",
|
||||||
|
runtimeConfigUrl: "/config.json",
|
||||||
|
},
|
||||||
|
fetcher: async () => new Response(JSON.stringify(validConfig)),
|
||||||
|
now: () => (current += 2),
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(result.validationDurationMs).toBeLessThanOrEqual(500);
|
||||||
|
expect(result.config.API_BASE_URL).toBe("http://localhost:8080");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("returns only safe boot fields on failure", async () => {
|
||||||
|
await expect(
|
||||||
|
loadRuntimeConfig({
|
||||||
|
buildConfig: {
|
||||||
|
buildId: "build-a",
|
||||||
|
commitSha: "local",
|
||||||
|
routerBasePath: "/",
|
||||||
|
runtimeConfigUrl: "/config.json",
|
||||||
|
},
|
||||||
|
fetcher: async () => new Response("{"),
|
||||||
|
}),
|
||||||
|
).rejects.toMatchObject({
|
||||||
|
safe: {
|
||||||
|
kind: "BOOT_CONFIG_FAILURE",
|
||||||
|
buildId: "build-a",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -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);
|
||||||
|
});
|
||||||
|
});
|
||||||
Reference in New Issue
Block a user