@pureq/pureq 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +21 -0
- package/README.md +932 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -0
- package/dist/scripts/benchmark.d.ts +2 -0
- package/dist/scripts/benchmark.d.ts.map +1 -0
- package/dist/scripts/benchmark.js +69 -0
- package/dist/scripts/benchmark.js.map +1 -0
- package/dist/scripts/edge-smoke-entry.d.ts +8 -0
- package/dist/scripts/edge-smoke-entry.d.ts.map +1 -0
- package/dist/scripts/edge-smoke-entry.js +23 -0
- package/dist/scripts/edge-smoke-entry.js.map +1 -0
- package/dist/src/adapters/fetchAdapter.d.ts +3 -0
- package/dist/src/adapters/fetchAdapter.d.ts.map +1 -0
- package/dist/src/adapters/fetchAdapter.js +4 -0
- package/dist/src/adapters/fetchAdapter.js.map +1 -0
- package/dist/src/adapters/instrumentedAdapter.d.ts +21 -0
- package/dist/src/adapters/instrumentedAdapter.d.ts.map +1 -0
- package/dist/src/adapters/instrumentedAdapter.js +25 -0
- package/dist/src/adapters/instrumentedAdapter.js.map +1 -0
- package/dist/src/client/createClient.d.ts +193 -0
- package/dist/src/client/createClient.d.ts.map +1 -0
- package/dist/src/client/createClient.js +310 -0
- package/dist/src/client/createClient.js.map +1 -0
- package/dist/src/executor/execute.d.ts +19 -0
- package/dist/src/executor/execute.d.ts.map +1 -0
- package/dist/src/executor/execute.js +121 -0
- package/dist/src/executor/execute.js.map +1 -0
- package/dist/src/index.d.ts +37 -0
- package/dist/src/index.d.ts.map +1 -0
- package/dist/src/index.js +36 -0
- package/dist/src/index.js.map +1 -0
- package/dist/src/middleware/circuitBreaker.d.ts +77 -0
- package/dist/src/middleware/circuitBreaker.d.ts.map +1 -0
- package/dist/src/middleware/circuitBreaker.js +246 -0
- package/dist/src/middleware/circuitBreaker.js.map +1 -0
- package/dist/src/middleware/circuitBreakerKeys.d.ts +5 -0
- package/dist/src/middleware/circuitBreakerKeys.d.ts.map +1 -0
- package/dist/src/middleware/circuitBreakerKeys.js +30 -0
- package/dist/src/middleware/circuitBreakerKeys.js.map +1 -0
- package/dist/src/middleware/compose.d.ts +9 -0
- package/dist/src/middleware/compose.d.ts.map +1 -0
- package/dist/src/middleware/compose.js +45 -0
- package/dist/src/middleware/compose.js.map +1 -0
- package/dist/src/middleware/concurrencyLimit.d.ts +11 -0
- package/dist/src/middleware/concurrencyLimit.d.ts.map +1 -0
- package/dist/src/middleware/concurrencyLimit.js +126 -0
- package/dist/src/middleware/concurrencyLimit.js.map +1 -0
- package/dist/src/middleware/deadline.d.ts +10 -0
- package/dist/src/middleware/deadline.d.ts.map +1 -0
- package/dist/src/middleware/deadline.js +99 -0
- package/dist/src/middleware/deadline.js.map +1 -0
- package/dist/src/middleware/dedupe.d.ts +13 -0
- package/dist/src/middleware/dedupe.d.ts.map +1 -0
- package/dist/src/middleware/dedupe.js +46 -0
- package/dist/src/middleware/dedupe.js.map +1 -0
- package/dist/src/middleware/defaultTimeout.d.ts +6 -0
- package/dist/src/middleware/defaultTimeout.d.ts.map +1 -0
- package/dist/src/middleware/defaultTimeout.js +23 -0
- package/dist/src/middleware/defaultTimeout.js.map +1 -0
- package/dist/src/middleware/diagnostics.d.ts +28 -0
- package/dist/src/middleware/diagnostics.d.ts.map +1 -0
- package/dist/src/middleware/diagnostics.js +131 -0
- package/dist/src/middleware/diagnostics.js.map +1 -0
- package/dist/src/middleware/diagnosticsExporters.d.ts +27 -0
- package/dist/src/middleware/diagnosticsExporters.d.ts.map +1 -0
- package/dist/src/middleware/diagnosticsExporters.js +45 -0
- package/dist/src/middleware/diagnosticsExporters.js.map +1 -0
- package/dist/src/middleware/hedge.d.ts +17 -0
- package/dist/src/middleware/hedge.d.ts.map +1 -0
- package/dist/src/middleware/hedge.js +125 -0
- package/dist/src/middleware/hedge.js.map +1 -0
- package/dist/src/middleware/httpCache.d.ts +14 -0
- package/dist/src/middleware/httpCache.d.ts.map +1 -0
- package/dist/src/middleware/httpCache.js +126 -0
- package/dist/src/middleware/httpCache.js.map +1 -0
- package/dist/src/middleware/idempotencyKey.d.ts +12 -0
- package/dist/src/middleware/idempotencyKey.d.ts.map +1 -0
- package/dist/src/middleware/idempotencyKey.js +33 -0
- package/dist/src/middleware/idempotencyKey.js.map +1 -0
- package/dist/src/middleware/offlineQueue.d.ts +78 -0
- package/dist/src/middleware/offlineQueue.d.ts.map +1 -0
- package/dist/src/middleware/offlineQueue.js +189 -0
- package/dist/src/middleware/offlineQueue.js.map +1 -0
- package/dist/src/middleware/presets.d.ts +31 -0
- package/dist/src/middleware/presets.d.ts.map +1 -0
- package/dist/src/middleware/presets.js +122 -0
- package/dist/src/middleware/presets.js.map +1 -0
- package/dist/src/middleware/retry.d.ts +27 -0
- package/dist/src/middleware/retry.d.ts.map +1 -0
- package/dist/src/middleware/retry.js +189 -0
- package/dist/src/middleware/retry.js.map +1 -0
- package/dist/src/middleware/stalePolicy.d.ts +14 -0
- package/dist/src/middleware/stalePolicy.d.ts.map +1 -0
- package/dist/src/middleware/stalePolicy.js +13 -0
- package/dist/src/middleware/stalePolicy.js.map +1 -0
- package/dist/src/observability/otelMapping.d.ts +13 -0
- package/dist/src/observability/otelMapping.d.ts.map +1 -0
- package/dist/src/observability/otelMapping.js +31 -0
- package/dist/src/observability/otelMapping.js.map +1 -0
- package/dist/src/observability/otelProfiles.d.ts +16 -0
- package/dist/src/observability/otelProfiles.d.ts.map +1 -0
- package/dist/src/observability/otelProfiles.js +66 -0
- package/dist/src/observability/otelProfiles.js.map +1 -0
- package/dist/src/observability/redaction.d.ts +39 -0
- package/dist/src/observability/redaction.d.ts.map +1 -0
- package/dist/src/observability/redaction.js +112 -0
- package/dist/src/observability/redaction.js.map +1 -0
- package/dist/src/policy/guardrails.d.ts +14 -0
- package/dist/src/policy/guardrails.d.ts.map +1 -0
- package/dist/src/policy/guardrails.js +36 -0
- package/dist/src/policy/guardrails.js.map +1 -0
- package/dist/src/response/response.d.ts +58 -0
- package/dist/src/response/response.d.ts.map +1 -0
- package/dist/src/response/response.js +91 -0
- package/dist/src/response/response.js.map +1 -0
- package/dist/src/serializers/formUrlEncodedSerializer.d.ts +6 -0
- package/dist/src/serializers/formUrlEncodedSerializer.d.ts.map +1 -0
- package/dist/src/serializers/formUrlEncodedSerializer.js +38 -0
- package/dist/src/serializers/formUrlEncodedSerializer.js.map +1 -0
- package/dist/src/serializers/jsonBodySerializer.d.ts +3 -0
- package/dist/src/serializers/jsonBodySerializer.d.ts.map +1 -0
- package/dist/src/serializers/jsonBodySerializer.js +24 -0
- package/dist/src/serializers/jsonBodySerializer.js.map +1 -0
- package/dist/src/types/events.d.ts +49 -0
- package/dist/src/types/events.d.ts.map +1 -0
- package/dist/src/types/events.js +2 -0
- package/dist/src/types/events.js.map +1 -0
- package/dist/src/types/http.d.ts +78 -0
- package/dist/src/types/http.d.ts.map +1 -0
- package/dist/src/types/http.js +2 -0
- package/dist/src/types/http.js.map +1 -0
- package/dist/src/types/internal.d.ts +20 -0
- package/dist/src/types/internal.d.ts.map +1 -0
- package/dist/src/types/internal.js +2 -0
- package/dist/src/types/internal.js.map +1 -0
- package/dist/src/types/result.d.ts +32 -0
- package/dist/src/types/result.d.ts.map +1 -0
- package/dist/src/types/result.js +66 -0
- package/dist/src/types/result.js.map +1 -0
- package/dist/src/utils/crypto.d.ts +8 -0
- package/dist/src/utils/crypto.d.ts.map +1 -0
- package/dist/src/utils/crypto.js +21 -0
- package/dist/src/utils/crypto.js.map +1 -0
- package/dist/src/utils/policyTrace.d.ts +17 -0
- package/dist/src/utils/policyTrace.d.ts.map +1 -0
- package/dist/src/utils/policyTrace.js +34 -0
- package/dist/src/utils/policyTrace.js.map +1 -0
- package/dist/src/utils/stableKey.d.ts +17 -0
- package/dist/src/utils/stableKey.d.ts.map +1 -0
- package/dist/src/utils/stableKey.js +41 -0
- package/dist/src/utils/stableKey.js.map +1 -0
- package/dist/src/utils/url.d.ts +22 -0
- package/dist/src/utils/url.d.ts.map +1 -0
- package/dist/src/utils/url.js +2 -0
- package/dist/src/utils/url.js.map +1 -0
- package/dist/tests/adapter-serializer.test.d.ts +2 -0
- package/dist/tests/adapter-serializer.test.d.ts.map +1 -0
- package/dist/tests/adapter-serializer.test.js +59 -0
- package/dist/tests/adapter-serializer.test.js.map +1 -0
- package/dist/tests/browser-runtime.smoke.test.d.ts +2 -0
- package/dist/tests/browser-runtime.smoke.test.d.ts.map +1 -0
- package/dist/tests/browser-runtime.smoke.test.js +17 -0
- package/dist/tests/browser-runtime.smoke.test.js.map +1 -0
- package/dist/tests/circuit-breaker.test.d.ts +2 -0
- package/dist/tests/circuit-breaker.test.d.ts.map +1 -0
- package/dist/tests/circuit-breaker.test.js +184 -0
- package/dist/tests/circuit-breaker.test.js.map +1 -0
- package/dist/tests/client.integration.d.ts +2 -0
- package/dist/tests/client.integration.d.ts.map +1 -0
- package/dist/tests/client.integration.js +44 -0
- package/dist/tests/client.integration.js.map +1 -0
- package/dist/tests/client.integration.test.d.ts +2 -0
- package/dist/tests/client.integration.test.d.ts.map +1 -0
- package/dist/tests/client.integration.test.js +63 -0
- package/dist/tests/client.integration.test.js.map +1 -0
- package/dist/tests/compose.test.d.ts +2 -0
- package/dist/tests/compose.test.d.ts.map +1 -0
- package/dist/tests/compose.test.js +24 -0
- package/dist/tests/compose.test.js.map +1 -0
- package/dist/tests/concurrency-limit.test.d.ts +2 -0
- package/dist/tests/concurrency-limit.test.d.ts.map +1 -0
- package/dist/tests/concurrency-limit.test.js +87 -0
- package/dist/tests/concurrency-limit.test.js.map +1 -0
- package/dist/tests/deadline-middleware.test.d.ts +2 -0
- package/dist/tests/deadline-middleware.test.d.ts.map +1 -0
- package/dist/tests/deadline-middleware.test.js +38 -0
- package/dist/tests/deadline-middleware.test.js.map +1 -0
- package/dist/tests/dedupe-middleware.test.d.ts +2 -0
- package/dist/tests/dedupe-middleware.test.d.ts.map +1 -0
- package/dist/tests/dedupe-middleware.test.js +56 -0
- package/dist/tests/dedupe-middleware.test.js.map +1 -0
- package/dist/tests/default-timeout.test.d.ts +2 -0
- package/dist/tests/default-timeout.test.d.ts.map +1 -0
- package/dist/tests/default-timeout.test.js +28 -0
- package/dist/tests/default-timeout.test.js.map +1 -0
- package/dist/tests/diagnostics-exporters.test.d.ts +2 -0
- package/dist/tests/diagnostics-exporters.test.d.ts.map +1 -0
- package/dist/tests/diagnostics-exporters.test.js +41 -0
- package/dist/tests/diagnostics-exporters.test.js.map +1 -0
- package/dist/tests/diagnostics.test.d.ts +2 -0
- package/dist/tests/diagnostics.test.d.ts.map +1 -0
- package/dist/tests/diagnostics.test.js +38 -0
- package/dist/tests/diagnostics.test.js.map +1 -0
- package/dist/tests/error-metadata.test.d.ts +2 -0
- package/dist/tests/error-metadata.test.d.ts.map +1 -0
- package/dist/tests/error-metadata.test.js +23 -0
- package/dist/tests/error-metadata.test.js.map +1 -0
- package/dist/tests/execute-timeout.test.d.ts +2 -0
- package/dist/tests/execute-timeout.test.d.ts.map +1 -0
- package/dist/tests/execute-timeout.test.js +30 -0
- package/dist/tests/execute-timeout.test.js.map +1 -0
- package/dist/tests/form-serializer.test.d.ts +2 -0
- package/dist/tests/form-serializer.test.d.ts.map +1 -0
- package/dist/tests/form-serializer.test.js +16 -0
- package/dist/tests/form-serializer.test.js.map +1 -0
- package/dist/tests/hedge.test.d.ts +2 -0
- package/dist/tests/hedge.test.d.ts.map +1 -0
- package/dist/tests/hedge.test.js +45 -0
- package/dist/tests/hedge.test.js.map +1 -0
- package/dist/tests/http-cache.test.d.ts +2 -0
- package/dist/tests/http-cache.test.d.ts.map +1 -0
- package/dist/tests/http-cache.test.js +60 -0
- package/dist/tests/http-cache.test.js.map +1 -0
- package/dist/tests/idempotency-key.test.d.ts +2 -0
- package/dist/tests/idempotency-key.test.d.ts.map +1 -0
- package/dist/tests/idempotency-key.test.js +31 -0
- package/dist/tests/idempotency-key.test.js.map +1 -0
- package/dist/tests/instrumented-adapter.test.d.ts +2 -0
- package/dist/tests/instrumented-adapter.test.d.ts.map +1 -0
- package/dist/tests/instrumented-adapter.test.js +33 -0
- package/dist/tests/instrumented-adapter.test.js.map +1 -0
- package/dist/tests/interceptor-order.test.d.ts +2 -0
- package/dist/tests/interceptor-order.test.d.ts.map +1 -0
- package/dist/tests/interceptor-order.test.js +38 -0
- package/dist/tests/interceptor-order.test.js.map +1 -0
- package/dist/tests/json-helper.test.d.ts +2 -0
- package/dist/tests/json-helper.test.d.ts.map +1 -0
- package/dist/tests/json-helper.test.js +42 -0
- package/dist/tests/json-helper.test.js.map +1 -0
- package/dist/tests/observability.test.d.ts +2 -0
- package/dist/tests/observability.test.d.ts.map +1 -0
- package/dist/tests/observability.test.js +59 -0
- package/dist/tests/observability.test.js.map +1 -0
- package/dist/tests/offline-queue.test.d.ts +2 -0
- package/dist/tests/offline-queue.test.d.ts.map +1 -0
- package/dist/tests/offline-queue.test.js +35 -0
- package/dist/tests/offline-queue.test.js.map +1 -0
- package/dist/tests/otel-mapping.test.d.ts +2 -0
- package/dist/tests/otel-mapping.test.d.ts.map +1 -0
- package/dist/tests/otel-mapping.test.js +20 -0
- package/dist/tests/otel-mapping.test.js.map +1 -0
- package/dist/tests/policy-guardrails.test.d.ts +2 -0
- package/dist/tests/policy-guardrails.test.d.ts.map +1 -0
- package/dist/tests/policy-guardrails.test.js +25 -0
- package/dist/tests/policy-guardrails.test.js.map +1 -0
- package/dist/tests/presets.test.d.ts +2 -0
- package/dist/tests/presets.test.d.ts.map +1 -0
- package/dist/tests/presets.test.js +41 -0
- package/dist/tests/presets.test.js.map +1 -0
- package/dist/tests/public-api.contract.d.ts +2 -0
- package/dist/tests/public-api.contract.d.ts.map +1 -0
- package/dist/tests/public-api.contract.js +14 -0
- package/dist/tests/public-api.contract.js.map +1 -0
- package/dist/tests/public-api.contract.test.d.ts +2 -0
- package/dist/tests/public-api.contract.test.d.ts.map +1 -0
- package/dist/tests/public-api.contract.test.js +25 -0
- package/dist/tests/public-api.contract.test.js.map +1 -0
- package/dist/tests/redaction.test.d.ts +2 -0
- package/dist/tests/redaction.test.d.ts.map +1 -0
- package/dist/tests/redaction.test.js +23 -0
- package/dist/tests/redaction.test.js.map +1 -0
- package/dist/tests/retry-after-budget.test.d.ts +2 -0
- package/dist/tests/retry-after-budget.test.d.ts.map +1 -0
- package/dist/tests/retry-after-budget.test.js +72 -0
- package/dist/tests/retry-after-budget.test.js.map +1 -0
- package/dist/tests/retry-policy-trace.test.d.ts +2 -0
- package/dist/tests/retry-policy-trace.test.d.ts.map +1 -0
- package/dist/tests/retry-policy-trace.test.js +35 -0
- package/dist/tests/retry-policy-trace.test.js.map +1 -0
- package/dist/tests/retry-policy.test.d.ts +2 -0
- package/dist/tests/retry-policy.test.d.ts.map +1 -0
- package/dist/tests/retry-policy.test.js +51 -0
- package/dist/tests/retry-policy.test.js.map +1 -0
- package/dist/tests/retry.stress.d.ts +2 -0
- package/dist/tests/retry.stress.d.ts.map +1 -0
- package/dist/tests/retry.stress.js +21 -0
- package/dist/tests/retry.stress.js.map +1 -0
- package/dist/tests/retry.stress.test.d.ts +2 -0
- package/dist/tests/retry.stress.test.d.ts.map +1 -0
- package/dist/tests/retry.stress.test.js +21 -0
- package/dist/tests/retry.stress.test.js.map +1 -0
- package/package.json +63 -0
|
@@ -0,0 +1,246 @@
|
|
|
1
|
+
export class PureqCircuitOpenError extends Error {
|
|
2
|
+
constructor(message = "pureq: circuit breaker is open") {
|
|
3
|
+
super(message);
|
|
4
|
+
this.code = "PUREQ_CIRCUIT_OPEN";
|
|
5
|
+
this.name = "PureqCircuitOpenError";
|
|
6
|
+
}
|
|
7
|
+
}
|
|
8
|
+
function defaultShouldTrip(context) {
|
|
9
|
+
if (context.error) {
|
|
10
|
+
return true;
|
|
11
|
+
}
|
|
12
|
+
if (context.response) {
|
|
13
|
+
return context.response.status >= 500;
|
|
14
|
+
}
|
|
15
|
+
return false;
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* Circuit breaker middleware for downstream dependency protection.
|
|
19
|
+
*/
|
|
20
|
+
export function circuitBreaker(options = {}) {
|
|
21
|
+
return createCircuitBreaker(options).middleware;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Default key builder uses method + full URL, meaning parameterized
|
|
25
|
+
* paths (e.g. /users/123 vs /users/456) are tracked as separate
|
|
26
|
+
* circuits. For endpoint-level protection use a custom keyBuilder
|
|
27
|
+
* such as keyByMethodAndPath or keyByHost from circuitBreakerKeys.
|
|
28
|
+
*/
|
|
29
|
+
function defaultKeyBuilder(req) {
|
|
30
|
+
return `${req.method}:${req.url}`;
|
|
31
|
+
}
|
|
32
|
+
function createEntry(now) {
|
|
33
|
+
return {
|
|
34
|
+
state: "closed",
|
|
35
|
+
failureCount: 0,
|
|
36
|
+
successCount: 0,
|
|
37
|
+
openedAt: 0,
|
|
38
|
+
halfOpenProbeInFlight: false,
|
|
39
|
+
lastChangedAt: now,
|
|
40
|
+
lastAccessedAt: now,
|
|
41
|
+
};
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Stateful circuit breaker controller.
|
|
45
|
+
* Provides middleware plus runtime inspection/reset APIs.
|
|
46
|
+
*/
|
|
47
|
+
export function createCircuitBreaker(options = {}) {
|
|
48
|
+
const failureThreshold = options.failureThreshold ?? 5;
|
|
49
|
+
const successThreshold = options.successThreshold ?? 1;
|
|
50
|
+
const cooldownMs = options.cooldownMs ?? 30000;
|
|
51
|
+
const shouldTrip = options.shouldTrip ?? defaultShouldTrip;
|
|
52
|
+
const keyBuilder = options.keyBuilder ?? defaultKeyBuilder;
|
|
53
|
+
const maxEntries = options.maxEntries ?? Number.POSITIVE_INFINITY;
|
|
54
|
+
const entryTtlMs = options.entryTtlMs;
|
|
55
|
+
const entries = new Map();
|
|
56
|
+
function evictOldestEntry() {
|
|
57
|
+
const oldestKey = entries.keys().next().value;
|
|
58
|
+
if (oldestKey !== undefined) {
|
|
59
|
+
entries.delete(oldestKey);
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
function pruneExpiredEntries(now) {
|
|
63
|
+
if (entryTtlMs === undefined || entryTtlMs <= 0) {
|
|
64
|
+
return;
|
|
65
|
+
}
|
|
66
|
+
for (const [key, entry] of entries) {
|
|
67
|
+
if (now - entry.lastAccessedAt >= entryTtlMs) {
|
|
68
|
+
entries.delete(key);
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
function touchEntry(key, entry, now) {
|
|
73
|
+
entry.lastAccessedAt = now;
|
|
74
|
+
entries.delete(key);
|
|
75
|
+
entries.set(key, entry);
|
|
76
|
+
}
|
|
77
|
+
function getEntry(key, now) {
|
|
78
|
+
pruneExpiredEntries(now);
|
|
79
|
+
const existing = entries.get(key);
|
|
80
|
+
if (existing) {
|
|
81
|
+
touchEntry(key, existing, now);
|
|
82
|
+
return existing;
|
|
83
|
+
}
|
|
84
|
+
while (entries.size >= maxEntries) {
|
|
85
|
+
evictOldestEntry();
|
|
86
|
+
}
|
|
87
|
+
const created = createEntry(now);
|
|
88
|
+
entries.set(key, created);
|
|
89
|
+
return created;
|
|
90
|
+
}
|
|
91
|
+
function openCircuit(key, entry, now) {
|
|
92
|
+
const previousState = entry.state;
|
|
93
|
+
entry.state = "open";
|
|
94
|
+
entry.openedAt = now;
|
|
95
|
+
entry.failureCount = 0;
|
|
96
|
+
entry.successCount = 0;
|
|
97
|
+
entry.halfOpenProbeInFlight = false;
|
|
98
|
+
entry.lastChangedAt = now;
|
|
99
|
+
entry.lastAccessedAt = now;
|
|
100
|
+
if (previousState !== entry.state) {
|
|
101
|
+
options.hooks?.onStateChange?.({ key, from: previousState, to: entry.state, at: now });
|
|
102
|
+
}
|
|
103
|
+
options.hooks?.onOpen?.({ key, openedAt: now, failures: failureThreshold });
|
|
104
|
+
}
|
|
105
|
+
function closeCircuit(key, entry, now) {
|
|
106
|
+
const previousState = entry.state;
|
|
107
|
+
entry.state = "closed";
|
|
108
|
+
entry.failureCount = 0;
|
|
109
|
+
entry.successCount = 0;
|
|
110
|
+
entry.halfOpenProbeInFlight = false;
|
|
111
|
+
entry.lastChangedAt = now;
|
|
112
|
+
entry.lastAccessedAt = now;
|
|
113
|
+
if (previousState !== entry.state) {
|
|
114
|
+
options.hooks?.onStateChange?.({ key, from: previousState, to: entry.state, at: now });
|
|
115
|
+
}
|
|
116
|
+
options.hooks?.onClose?.({ key, at: now });
|
|
117
|
+
}
|
|
118
|
+
function moveToHalfOpen(key, entry, now) {
|
|
119
|
+
const previousState = entry.state;
|
|
120
|
+
entry.state = "half-open";
|
|
121
|
+
entry.successCount = 0;
|
|
122
|
+
entry.halfOpenProbeInFlight = false;
|
|
123
|
+
entry.lastChangedAt = now;
|
|
124
|
+
entry.lastAccessedAt = now;
|
|
125
|
+
if (previousState !== entry.state) {
|
|
126
|
+
options.hooks?.onStateChange?.({ key, from: previousState, to: entry.state, at: now });
|
|
127
|
+
}
|
|
128
|
+
options.hooks?.onHalfOpen?.({ key, at: now });
|
|
129
|
+
}
|
|
130
|
+
const middleware = async (req, next) => {
|
|
131
|
+
const now = Date.now();
|
|
132
|
+
const key = keyBuilder(req);
|
|
133
|
+
const entry = getEntry(key, now);
|
|
134
|
+
touchEntry(key, entry, now);
|
|
135
|
+
if (entry.state === "open") {
|
|
136
|
+
if (now - entry.openedAt < cooldownMs) {
|
|
137
|
+
throw new PureqCircuitOpenError();
|
|
138
|
+
}
|
|
139
|
+
moveToHalfOpen(key, entry, now);
|
|
140
|
+
}
|
|
141
|
+
if (entry.state === "half-open") {
|
|
142
|
+
if (entry.halfOpenProbeInFlight) {
|
|
143
|
+
throw new PureqCircuitOpenError("pureq: circuit breaker half-open probe in flight");
|
|
144
|
+
}
|
|
145
|
+
entry.halfOpenProbeInFlight = true;
|
|
146
|
+
}
|
|
147
|
+
try {
|
|
148
|
+
const response = await next(req);
|
|
149
|
+
const shouldCountFailure = shouldTrip({ key, req, response });
|
|
150
|
+
if (shouldCountFailure) {
|
|
151
|
+
if (entry.state === "half-open") {
|
|
152
|
+
openCircuit(key, entry, Date.now());
|
|
153
|
+
}
|
|
154
|
+
else {
|
|
155
|
+
entry.failureCount += 1;
|
|
156
|
+
if (entry.failureCount >= failureThreshold) {
|
|
157
|
+
openCircuit(key, entry, Date.now());
|
|
158
|
+
}
|
|
159
|
+
}
|
|
160
|
+
return response;
|
|
161
|
+
}
|
|
162
|
+
if (entry.state === "half-open") {
|
|
163
|
+
entry.successCount += 1;
|
|
164
|
+
if (entry.successCount >= successThreshold) {
|
|
165
|
+
closeCircuit(key, entry, Date.now());
|
|
166
|
+
}
|
|
167
|
+
}
|
|
168
|
+
else {
|
|
169
|
+
entry.failureCount = 0;
|
|
170
|
+
}
|
|
171
|
+
return response;
|
|
172
|
+
}
|
|
173
|
+
catch (error) {
|
|
174
|
+
const shouldCountFailure = shouldTrip({ key, req, error });
|
|
175
|
+
if (!shouldCountFailure) {
|
|
176
|
+
throw error;
|
|
177
|
+
}
|
|
178
|
+
if (entry.state === "half-open") {
|
|
179
|
+
openCircuit(key, entry, Date.now());
|
|
180
|
+
}
|
|
181
|
+
else {
|
|
182
|
+
entry.failureCount += 1;
|
|
183
|
+
if (entry.failureCount >= failureThreshold) {
|
|
184
|
+
openCircuit(key, entry, Date.now());
|
|
185
|
+
}
|
|
186
|
+
}
|
|
187
|
+
throw error;
|
|
188
|
+
}
|
|
189
|
+
finally {
|
|
190
|
+
if (entry.state === "half-open") {
|
|
191
|
+
entry.halfOpenProbeInFlight = false;
|
|
192
|
+
}
|
|
193
|
+
touchEntry(key, entry, Date.now());
|
|
194
|
+
}
|
|
195
|
+
};
|
|
196
|
+
const snapshot = () => {
|
|
197
|
+
pruneExpiredEntries(Date.now());
|
|
198
|
+
const result = [];
|
|
199
|
+
let closed = 0;
|
|
200
|
+
let open = 0;
|
|
201
|
+
let halfOpen = 0;
|
|
202
|
+
for (const [key, entry] of entries) {
|
|
203
|
+
if (entry.state === "closed") {
|
|
204
|
+
closed += 1;
|
|
205
|
+
}
|
|
206
|
+
else if (entry.state === "open") {
|
|
207
|
+
open += 1;
|
|
208
|
+
}
|
|
209
|
+
else {
|
|
210
|
+
halfOpen += 1;
|
|
211
|
+
}
|
|
212
|
+
result.push({
|
|
213
|
+
key,
|
|
214
|
+
state: entry.state,
|
|
215
|
+
failureCount: entry.failureCount,
|
|
216
|
+
successCount: entry.successCount,
|
|
217
|
+
openedAt: entry.openedAt,
|
|
218
|
+
lastChangedAt: entry.lastChangedAt,
|
|
219
|
+
lastAccessedAt: entry.lastAccessedAt,
|
|
220
|
+
});
|
|
221
|
+
}
|
|
222
|
+
result.sort((a, b) => a.key.localeCompare(b.key));
|
|
223
|
+
return {
|
|
224
|
+
size: result.length,
|
|
225
|
+
summary: {
|
|
226
|
+
closed,
|
|
227
|
+
open,
|
|
228
|
+
halfOpen,
|
|
229
|
+
},
|
|
230
|
+
entries: result,
|
|
231
|
+
};
|
|
232
|
+
};
|
|
233
|
+
const reset = (key) => {
|
|
234
|
+
if (key === undefined) {
|
|
235
|
+
entries.clear();
|
|
236
|
+
return;
|
|
237
|
+
}
|
|
238
|
+
entries.delete(key);
|
|
239
|
+
};
|
|
240
|
+
return {
|
|
241
|
+
middleware,
|
|
242
|
+
snapshot,
|
|
243
|
+
reset,
|
|
244
|
+
};
|
|
245
|
+
}
|
|
246
|
+
//# sourceMappingURL=circuitBreaker.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"circuitBreaker.js","sourceRoot":"","sources":["../../../src/middleware/circuitBreaker.ts"],"names":[],"mappings":"AAGA,MAAM,OAAO,qBAAsB,SAAQ,KAAK;IAG9C,YAAY,OAAO,GAAG,gCAAgC;QACpD,KAAK,CAAC,OAAO,CAAC,CAAC;QAHR,SAAI,GAAG,oBAAoB,CAAC;QAInC,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;IACtC,CAAC;CACF;AA8ED,SAAS,iBAAiB,CAAC,OAG1B;IACC,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrB,OAAO,OAAO,CAAC,QAAQ,CAAC,MAAM,IAAI,GAAG,CAAC;IACxC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc,CAAC,UAAiC,EAAE;IAChE,OAAO,oBAAoB,CAAC,OAAO,CAAC,CAAC,UAAU,CAAC;AAClD,CAAC;AAED;;;;;GAKG;AACH,SAAS,iBAAiB,CAAC,GAA4B;IACrD,OAAO,GAAG,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,GAAG,EAAE,CAAC;AACpC,CAAC;AAED,SAAS,WAAW,CAAC,GAAW;IAC9B,OAAO;QACL,KAAK,EAAE,QAAQ;QACf,YAAY,EAAE,CAAC;QACf,YAAY,EAAE,CAAC;QACf,QAAQ,EAAE,CAAC;QACX,qBAAqB,EAAE,KAAK;QAC5B,aAAa,EAAE,GAAG;QAClB,cAAc,EAAE,GAAG;KACpB,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAAC,UAAiC,EAAE;IACtE,MAAM,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,IAAI,CAAC,CAAC;IACvD,MAAM,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,IAAI,CAAC,CAAC;IACvD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,KAAM,CAAC;IAChD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,iBAAiB,CAAC;IAE3D,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,iBAAiB,CAAC;IAC3D,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,MAAM,CAAC,iBAAiB,CAAC;IAClE,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IACtC,MAAM,OAAO,GAAG,IAAI,GAAG,EAAwB,CAAC;IAEhD,SAAS,gBAAgB;QACvB,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,KAA2B,CAAC;QACpE,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IAED,SAAS,mBAAmB,CAAC,GAAW;QACtC,IAAI,UAAU,KAAK,SAAS,IAAI,UAAU,IAAI,CAAC,EAAE,CAAC;YAChD,OAAO;QACT,CAAC;QAED,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,OAAO,EAAE,CAAC;YACnC,IAAI,GAAG,GAAG,KAAK,CAAC,cAAc,IAAI,UAAU,EAAE,CAAC;gBAC7C,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACtB,CAAC;QACH,CAAC;IACH,CAAC;IAED,SAAS,UAAU,CAAC,GAAW,EAAE,KAAmB,EAAE,GAAW;QAC/D,KAAK,CAAC,cAAc,GAAG,GAAG,CAAC;QAC3B,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACpB,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAC1B,CAAC;IAED,SAAS,QAAQ,CAAC,GAAW,EAAE,GAAW;QACxC,mBAAmB,CAAC,GAAG,CAAC,CAAC;QAEzB,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,QAAQ,EAAE,CAAC;YACb,UAAU,CAAC,GAAG,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;YAC/B,OAAO,QAAQ,CAAC;QAClB,CAAC;QAED,OAAO,OAAO,CAAC,IAAI,IAAI,UAAU,EAAE,CAAC;YAClC,gBAAgB,EAAE,CAAC;QACrB,CAAC;QAED,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;QACjC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAC1B,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,SAAS,WAAW,CAAC,GAAW,EAAE,KAAmB,EAAE,GAAW;QAChE,MAAM,aAAa,GAAG,KAAK,CAAC,KAAK,CAAC;QAClC,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC;QACrB,KAAK,CAAC,QAAQ,GAAG,GAAG,CAAC;QACrB,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC;QACvB,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC;QACvB,KAAK,CAAC,qBAAqB,GAAG,KAAK,CAAC;QACpC,KAAK,CAAC,aAAa,GAAG,GAAG,CAAC;QAC1B,KAAK,CAAC,cAAc,GAAG,GAAG,CAAC;QAC3B,IAAI,aAAa,KAAK,KAAK,CAAC,KAAK,EAAE,CAAC;YAClC,OAAO,CAAC,KAAK,EAAE,aAAa,EAAE,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,aAAa,EAAE,EAAE,EAAE,KAAK,CAAC,KAAK,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;QACzF,CAAC;QACD,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,QAAQ,EAAE,gBAAgB,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED,SAAS,YAAY,CAAC,GAAW,EAAE,KAAmB,EAAE,GAAW;QACjE,MAAM,aAAa,GAAG,KAAK,CAAC,KAAK,CAAC;QAClC,KAAK,CAAC,KAAK,GAAG,QAAQ,CAAC;QACvB,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC;QACvB,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC;QACvB,KAAK,CAAC,qBAAqB,GAAG,KAAK,CAAC;QACpC,KAAK,CAAC,aAAa,GAAG,GAAG,CAAC;QAC1B,KAAK,CAAC,cAAc,GAAG,GAAG,CAAC;QAC3B,IAAI,aAAa,KAAK,KAAK,CAAC,KAAK,EAAE,CAAC;YAClC,OAAO,CAAC,KAAK,EAAE,aAAa,EAAE,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,aAAa,EAAE,EAAE,EAAE,KAAK,CAAC,KAAK,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;QACzF,CAAC;QACD,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED,SAAS,cAAc,CAAC,GAAW,EAAE,KAAmB,EAAE,GAAW;QACnE,MAAM,aAAa,GAAG,KAAK,CAAC,KAAK,CAAC;QAClC,KAAK,CAAC,KAAK,GAAG,WAAW,CAAC;QAC1B,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC;QACvB,KAAK,CAAC,qBAAqB,GAAG,KAAK,CAAC;QACpC,KAAK,CAAC,aAAa,GAAG,GAAG,CAAC;QAC1B,KAAK,CAAC,cAAc,GAAG,GAAG,CAAC;QAC3B,IAAI,aAAa,KAAK,KAAK,CAAC,KAAK,EAAE,CAAC;YAClC,OAAO,CAAC,KAAK,EAAE,aAAa,EAAE,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,aAAa,EAAE,EAAE,EAAE,KAAK,CAAC,KAAK,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;QACzF,CAAC;QACD,OAAO,CAAC,KAAK,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;IAChD,CAAC;IAED,MAAM,UAAU,GAAe,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QACjD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,MAAM,GAAG,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;QAC5B,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACjC,UAAU,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;QAE5B,IAAI,KAAK,CAAC,KAAK,KAAK,MAAM,EAAE,CAAC;YAC3B,IAAI,GAAG,GAAG,KAAK,CAAC,QAAQ,GAAG,UAAU,EAAE,CAAC;gBACtC,MAAM,IAAI,qBAAqB,EAAE,CAAC;YACpC,CAAC;YACD,cAAc,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;QAClC,CAAC;QAED,IAAI,KAAK,CAAC,KAAK,KAAK,WAAW,EAAE,CAAC;YAChC,IAAI,KAAK,CAAC,qBAAqB,EAAE,CAAC;gBAChC,MAAM,IAAI,qBAAqB,CAAC,kDAAkD,CAAC,CAAC;YACtF,CAAC;YACD,KAAK,CAAC,qBAAqB,GAAG,IAAI,CAAC;QACrC,CAAC;QAED,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,CAAC;YACjC,MAAM,kBAAkB,GAAG,UAAU,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;YAE9D,IAAI,kBAAkB,EAAE,CAAC;gBACvB,IAAI,KAAK,CAAC,KAAK,KAAK,WAAW,EAAE,CAAC;oBAChC,WAAW,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;gBACtC,CAAC;qBAAM,CAAC;oBACN,KAAK,CAAC,YAAY,IAAI,CAAC,CAAC;oBACxB,IAAI,KAAK,CAAC,YAAY,IAAI,gBAAgB,EAAE,CAAC;wBAC3C,WAAW,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;oBACtC,CAAC;gBACH,CAAC;gBACD,OAAO,QAAQ,CAAC;YAClB,CAAC;YAED,IAAI,KAAK,CAAC,KAAK,KAAK,WAAW,EAAE,CAAC;gBAChC,KAAK,CAAC,YAAY,IAAI,CAAC,CAAC;gBACxB,IAAI,KAAK,CAAC,YAAY,IAAI,gBAAgB,EAAE,CAAC;oBAC3C,YAAY,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;gBACvC,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC;YACzB,CAAC;YAED,OAAO,QAAQ,CAAC;QAClB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,kBAAkB,GAAG,UAAU,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;YAC3D,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBACxB,MAAM,KAAK,CAAC;YACd,CAAC;YAED,IAAI,KAAK,CAAC,KAAK,KAAK,WAAW,EAAE,CAAC;gBAChC,WAAW,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;YACtC,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,YAAY,IAAI,CAAC,CAAC;gBACxB,IAAI,KAAK,CAAC,YAAY,IAAI,gBAAgB,EAAE,CAAC;oBAC3C,WAAW,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;gBACtC,CAAC;YACH,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;gBAAS,CAAC;YACT,IAAI,KAAK,CAAC,KAAK,KAAK,WAAW,EAAE,CAAC;gBAChC,KAAK,CAAC,qBAAqB,GAAG,KAAK,CAAC;YACtC,CAAC;YAED,UAAU,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QACrC,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,QAAQ,GAAG,GAAoB,EAAE;QACrC,mBAAmB,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QAEhC,MAAM,MAAM,GAA2B,EAAE,CAAC;QAC1C,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,IAAI,IAAI,GAAG,CAAC,CAAC;QACb,IAAI,QAAQ,GAAG,CAAC,CAAC;QACjB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,OAAO,EAAE,CAAC;YACnC,IAAI,KAAK,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC7B,MAAM,IAAI,CAAC,CAAC;YACd,CAAC;iBAAM,IAAI,KAAK,CAAC,KAAK,KAAK,MAAM,EAAE,CAAC;gBAClC,IAAI,IAAI,CAAC,CAAC;YACZ,CAAC;iBAAM,CAAC;gBACN,QAAQ,IAAI,CAAC,CAAC;YAChB,CAAC;YAED,MAAM,CAAC,IAAI,CAAC;gBACV,GAAG;gBACH,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,YAAY,EAAE,KAAK,CAAC,YAAY;gBAChC,YAAY,EAAE,KAAK,CAAC,YAAY;gBAChC,QAAQ,EAAE,KAAK,CAAC,QAAQ;gBACxB,aAAa,EAAE,KAAK,CAAC,aAAa;gBAClC,cAAc,EAAE,KAAK,CAAC,cAAc;aACrC,CAAC,CAAC;QACL,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAElD,OAAO;YACL,IAAI,EAAE,MAAM,CAAC,MAAM;YACnB,OAAO,EAAE;gBACP,MAAM;gBACN,IAAI;gBACJ,QAAQ;aACT;YACD,OAAO,EAAE,MAAM;SAChB,CAAC;IACJ,CAAC,CAAC;IAEF,MAAM,KAAK,GAAG,CAAC,GAAY,EAAQ,EAAE;QACnC,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACtB,OAAO,CAAC,KAAK,EAAE,CAAC;YAChB,OAAO;QACT,CAAC;QACD,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACtB,CAAC,CAAC;IAEF,OAAO;QACL,UAAU;QACV,QAAQ;QACR,KAAK;KACN,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type { RequestConfig } from "../types/http";
|
|
2
|
+
export declare function keyByHost(req: Readonly<RequestConfig>): string;
|
|
3
|
+
export declare function keyByMethodAndPath(req: Readonly<RequestConfig>): string;
|
|
4
|
+
export declare function keyByOriginAndPath(req: Readonly<RequestConfig>): string;
|
|
5
|
+
//# sourceMappingURL=circuitBreakerKeys.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"circuitBreakerKeys.d.ts","sourceRoot":"","sources":["../../../src/middleware/circuitBreakerKeys.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAUnD,wBAAgB,SAAS,CAAC,GAAG,EAAE,QAAQ,CAAC,aAAa,CAAC,GAAG,MAAM,CAM9D;AAED,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,QAAQ,CAAC,aAAa,CAAC,GAAG,MAAM,CAMvE;AAED,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,QAAQ,CAAC,aAAa,CAAC,GAAG,MAAM,CAMvE"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
function safeURL(url) {
|
|
2
|
+
try {
|
|
3
|
+
return new URL(url);
|
|
4
|
+
}
|
|
5
|
+
catch {
|
|
6
|
+
return undefined;
|
|
7
|
+
}
|
|
8
|
+
}
|
|
9
|
+
export function keyByHost(req) {
|
|
10
|
+
const parsed = safeURL(req.url);
|
|
11
|
+
if (!parsed) {
|
|
12
|
+
return `host:unknown:${req.method}`;
|
|
13
|
+
}
|
|
14
|
+
return `host:${parsed.host}`;
|
|
15
|
+
}
|
|
16
|
+
export function keyByMethodAndPath(req) {
|
|
17
|
+
const parsed = safeURL(req.url);
|
|
18
|
+
if (!parsed) {
|
|
19
|
+
return `path:${req.method}:${req.url}`;
|
|
20
|
+
}
|
|
21
|
+
return `path:${req.method}:${parsed.pathname}`;
|
|
22
|
+
}
|
|
23
|
+
export function keyByOriginAndPath(req) {
|
|
24
|
+
const parsed = safeURL(req.url);
|
|
25
|
+
if (!parsed) {
|
|
26
|
+
return `origin-path:${req.method}:${req.url}`;
|
|
27
|
+
}
|
|
28
|
+
return `origin-path:${req.method}:${parsed.origin}${parsed.pathname}`;
|
|
29
|
+
}
|
|
30
|
+
//# sourceMappingURL=circuitBreakerKeys.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"circuitBreakerKeys.js","sourceRoot":"","sources":["../../../src/middleware/circuitBreakerKeys.ts"],"names":[],"mappings":"AAEA,SAAS,OAAO,CAAC,GAAW;IAC1B,IAAI,CAAC;QACH,OAAO,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;IACtB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,GAA4B;IACpD,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAChC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,gBAAgB,GAAG,CAAC,MAAM,EAAE,CAAC;IACtC,CAAC;IACD,OAAO,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;AAC/B,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,GAA4B;IAC7D,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAChC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,QAAQ,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,GAAG,EAAE,CAAC;IACzC,CAAC;IACD,OAAO,QAAQ,GAAG,CAAC,MAAM,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;AACjD,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,GAA4B;IAC7D,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAChC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,eAAe,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,GAAG,EAAE,CAAC;IAChD,CAAC;IACD,OAAO,eAAe,GAAG,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;AACxE,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { Middleware } from "../types/http";
|
|
2
|
+
import type { InternalRequestConfig } from "../types/internal";
|
|
3
|
+
import type { HttpResponse } from "../response/response";
|
|
4
|
+
/**
|
|
5
|
+
* Composes multiple middlewares into a single executable function.
|
|
6
|
+
* Implements the "Onion Model" with re-entry prevention via index tracking.
|
|
7
|
+
*/
|
|
8
|
+
export declare function compose(middlewares: readonly Middleware[], executor?: (req: InternalRequestConfig) => Promise<HttpResponse>): (req: InternalRequestConfig) => Promise<HttpResponse>;
|
|
9
|
+
//# sourceMappingURL=compose.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"compose.d.ts","sourceRoot":"","sources":["../../../src/middleware/compose.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAGzD;;;GAGG;AACH,wBAAgB,OAAO,CACrB,WAAW,EAAE,SAAS,UAAU,EAAE,EAClC,QAAQ,GAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,OAAO,CAAC,YAAY,CAAW,IAExD,KAAK,qBAAqB,KAAG,OAAO,CAAC,YAAY,CAAC,CAyCpE"}
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
import { execute } from "../executor/execute";
|
|
2
|
+
/**
|
|
3
|
+
* Composes multiple middlewares into a single executable function.
|
|
4
|
+
* Implements the "Onion Model" with re-entry prevention via index tracking.
|
|
5
|
+
*/
|
|
6
|
+
export function compose(middlewares, executor = execute) {
|
|
7
|
+
return function (req) {
|
|
8
|
+
function dispatch(i, currentConfig) {
|
|
9
|
+
const middleware = middlewares[i];
|
|
10
|
+
// After the last middleware, run the executor
|
|
11
|
+
if (!middleware) {
|
|
12
|
+
return executor(currentConfig);
|
|
13
|
+
}
|
|
14
|
+
// Guards against concurrent calls to next() within a single middleware.
|
|
15
|
+
// The flag is reset in the finally block after dispatch completes,
|
|
16
|
+
// which intentionally allows sequential re-invocation of next()
|
|
17
|
+
// (e.g. in an error-recovery path). Only truly parallel calls are rejected.
|
|
18
|
+
let nextInFlight = false;
|
|
19
|
+
try {
|
|
20
|
+
return middleware(currentConfig, async (nextConfig) => {
|
|
21
|
+
if (nextInFlight) {
|
|
22
|
+
throw new Error("pureq: next() was called multiple times in a single middleware");
|
|
23
|
+
}
|
|
24
|
+
nextInFlight = true;
|
|
25
|
+
const nextReq = {
|
|
26
|
+
...currentConfig,
|
|
27
|
+
...nextConfig,
|
|
28
|
+
_middlewares: currentConfig._middlewares,
|
|
29
|
+
};
|
|
30
|
+
try {
|
|
31
|
+
return await dispatch(i + 1, nextReq);
|
|
32
|
+
}
|
|
33
|
+
finally {
|
|
34
|
+
nextInFlight = false;
|
|
35
|
+
}
|
|
36
|
+
});
|
|
37
|
+
}
|
|
38
|
+
catch (err) {
|
|
39
|
+
return Promise.reject(err);
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
return dispatch(0, req);
|
|
43
|
+
};
|
|
44
|
+
}
|
|
45
|
+
//# sourceMappingURL=compose.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"compose.js","sourceRoot":"","sources":["../../../src/middleware/compose.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE9C;;;GAGG;AACH,MAAM,UAAU,OAAO,CACrB,WAAkC,EAClC,WAAkE,OAAO;IAEzE,OAAO,UAAU,GAA0B;QACzC,SAAS,QAAQ,CAAC,CAAS,EAAE,aAAoC;YAC/D,MAAM,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;YAElC,8CAA8C;YAC9C,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,OAAO,QAAQ,CAAC,aAAa,CAAC,CAAC;YACjC,CAAC;YAED,wEAAwE;YACxE,mEAAmE;YACnE,gEAAgE;YAChE,4EAA4E;YAC5E,IAAI,YAAY,GAAG,KAAK,CAAC;YAEzB,IAAI,CAAC;gBACH,OAAO,UAAU,CAAC,aAAa,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE;oBACpD,IAAI,YAAY,EAAE,CAAC;wBACjB,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;oBACpF,CAAC;oBAED,YAAY,GAAG,IAAI,CAAC;oBACpB,MAAM,OAAO,GAA0B;wBACrC,GAAG,aAAa;wBAChB,GAAG,UAAU;wBACb,YAAY,EAAE,aAAa,CAAC,YAAY;qBACzC,CAAC;oBAEF,IAAI,CAAC;wBACH,OAAO,MAAM,QAAQ,CAAC,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;oBACxC,CAAC;4BAAS,CAAC;wBACT,YAAY,GAAG,KAAK,CAAC;oBACvB,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC;QAED,OAAO,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAC1B,CAAC,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { Middleware, RequestConfig } from "../types/http";
|
|
2
|
+
export interface ConcurrencyLimitOptions {
|
|
3
|
+
readonly maxConcurrent: number;
|
|
4
|
+
readonly keyBuilder?: (req: Readonly<RequestConfig>) => string;
|
|
5
|
+
readonly maxQueue?: number;
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* Limits in-flight request concurrency globally or by key.
|
|
9
|
+
*/
|
|
10
|
+
export declare function concurrencyLimit(options: ConcurrencyLimitOptions): Middleware;
|
|
11
|
+
//# sourceMappingURL=concurrencyLimit.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"concurrencyLimit.d.ts","sourceRoot":"","sources":["../../../src/middleware/concurrencyLimit.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAG/D,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,QAAQ,CAAC,aAAa,CAAC,KAAK,MAAM,CAAC;IAC/D,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AA2BD;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,UAAU,CAyI7E"}
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
import { markPolicyMiddleware } from "../policy/guardrails";
|
|
2
|
+
const GLOBAL_KEY = "__global__";
|
|
3
|
+
function validateOptions(options) {
|
|
4
|
+
if (!Number.isInteger(options.maxConcurrent) || options.maxConcurrent <= 0) {
|
|
5
|
+
throw new Error("pureq: concurrencyLimit requires maxConcurrent to be a positive integer");
|
|
6
|
+
}
|
|
7
|
+
if (options.maxQueue !== undefined && (!Number.isInteger(options.maxQueue) || options.maxQueue < 0)) {
|
|
8
|
+
throw new Error("pureq: concurrencyLimit maxQueue must be >= 0");
|
|
9
|
+
}
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* Limits in-flight request concurrency globally or by key.
|
|
13
|
+
*/
|
|
14
|
+
export function concurrencyLimit(options) {
|
|
15
|
+
validateOptions(options);
|
|
16
|
+
const maxConcurrent = options.maxConcurrent;
|
|
17
|
+
const maxQueue = options.maxQueue;
|
|
18
|
+
const keyBuilder = options.keyBuilder ?? (() => GLOBAL_KEY);
|
|
19
|
+
const buckets = new Map();
|
|
20
|
+
let nextTicketId = 0;
|
|
21
|
+
const getBucket = (key) => {
|
|
22
|
+
const existing = buckets.get(key);
|
|
23
|
+
if (existing) {
|
|
24
|
+
return existing;
|
|
25
|
+
}
|
|
26
|
+
const created = { active: 0, queue: [] };
|
|
27
|
+
buckets.set(key, created);
|
|
28
|
+
return created;
|
|
29
|
+
};
|
|
30
|
+
const cleanupBucketIfEmpty = (key) => {
|
|
31
|
+
const bucket = buckets.get(key);
|
|
32
|
+
if (!bucket) {
|
|
33
|
+
return;
|
|
34
|
+
}
|
|
35
|
+
if (bucket.active === 0 && bucket.queue.length === 0) {
|
|
36
|
+
buckets.delete(key);
|
|
37
|
+
}
|
|
38
|
+
};
|
|
39
|
+
const promoteNext = (key) => {
|
|
40
|
+
const bucket = buckets.get(key);
|
|
41
|
+
if (!bucket) {
|
|
42
|
+
return;
|
|
43
|
+
}
|
|
44
|
+
while (bucket.active < maxConcurrent && bucket.queue.length > 0) {
|
|
45
|
+
const next = bucket.queue.shift();
|
|
46
|
+
if (!next) {
|
|
47
|
+
break;
|
|
48
|
+
}
|
|
49
|
+
if (next.signal && next.onAbort) {
|
|
50
|
+
next.signal.removeEventListener("abort", next.onAbort);
|
|
51
|
+
}
|
|
52
|
+
bucket.active += 1;
|
|
53
|
+
next.resolve();
|
|
54
|
+
}
|
|
55
|
+
cleanupBucketIfEmpty(key);
|
|
56
|
+
};
|
|
57
|
+
const acquire = async (key, signal) => {
|
|
58
|
+
const bucket = getBucket(key);
|
|
59
|
+
if (bucket.active < maxConcurrent) {
|
|
60
|
+
bucket.active += 1;
|
|
61
|
+
return;
|
|
62
|
+
}
|
|
63
|
+
if (maxQueue !== undefined && bucket.queue.length >= maxQueue) {
|
|
64
|
+
throw new Error(`pureq: concurrency queue limit exceeded for key '${key}'`);
|
|
65
|
+
}
|
|
66
|
+
if (signal?.aborted) {
|
|
67
|
+
throw signal.reason ?? new DOMException("Aborted", "AbortError");
|
|
68
|
+
}
|
|
69
|
+
await new Promise((resolve, reject) => {
|
|
70
|
+
const ticketId = nextTicketId++;
|
|
71
|
+
// Prevent ticket ID overflow for long-running processes
|
|
72
|
+
if (nextTicketId > Number.MAX_SAFE_INTEGER) {
|
|
73
|
+
nextTicketId = 0;
|
|
74
|
+
}
|
|
75
|
+
let onAbort;
|
|
76
|
+
if (signal) {
|
|
77
|
+
onAbort = () => {
|
|
78
|
+
const queuedBucket = buckets.get(key);
|
|
79
|
+
if (!queuedBucket) {
|
|
80
|
+
reject(signal.reason ?? new DOMException("Aborted", "AbortError"));
|
|
81
|
+
return;
|
|
82
|
+
}
|
|
83
|
+
const index = queuedBucket.queue.findIndex((entry) => entry.id === ticketId);
|
|
84
|
+
if (index >= 0) {
|
|
85
|
+
queuedBucket.queue.splice(index, 1);
|
|
86
|
+
}
|
|
87
|
+
cleanupBucketIfEmpty(key);
|
|
88
|
+
reject(signal.reason ?? new DOMException("Aborted", "AbortError"));
|
|
89
|
+
};
|
|
90
|
+
signal.addEventListener("abort", onAbort, { once: true });
|
|
91
|
+
}
|
|
92
|
+
const entry = {
|
|
93
|
+
id: ticketId,
|
|
94
|
+
resolve,
|
|
95
|
+
reject,
|
|
96
|
+
...(signal !== undefined ? { signal } : {}),
|
|
97
|
+
...(onAbort !== undefined ? { onAbort } : {}),
|
|
98
|
+
};
|
|
99
|
+
bucket.queue.push(entry);
|
|
100
|
+
});
|
|
101
|
+
};
|
|
102
|
+
const release = (key) => {
|
|
103
|
+
const bucket = buckets.get(key);
|
|
104
|
+
if (!bucket) {
|
|
105
|
+
return;
|
|
106
|
+
}
|
|
107
|
+
bucket.active = Math.max(0, bucket.active - 1);
|
|
108
|
+
promoteNext(key);
|
|
109
|
+
};
|
|
110
|
+
const middleware = async (req, next) => {
|
|
111
|
+
const key = keyBuilder(req);
|
|
112
|
+
await acquire(key, req.signal);
|
|
113
|
+
try {
|
|
114
|
+
return await next(req);
|
|
115
|
+
}
|
|
116
|
+
finally {
|
|
117
|
+
release(key);
|
|
118
|
+
}
|
|
119
|
+
};
|
|
120
|
+
return markPolicyMiddleware(middleware, {
|
|
121
|
+
name: "concurrencyLimit",
|
|
122
|
+
kind: "concurrency",
|
|
123
|
+
maxConcurrent,
|
|
124
|
+
});
|
|
125
|
+
}
|
|
126
|
+
//# sourceMappingURL=concurrencyLimit.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"concurrencyLimit.js","sourceRoot":"","sources":["../../../src/middleware/concurrencyLimit.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAqB5D,MAAM,UAAU,GAAG,YAAY,CAAC;AAEhC,SAAS,eAAe,CAAC,OAAgC;IACvD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,OAAO,CAAC,aAAa,IAAI,CAAC,EAAE,CAAC;QAC3E,MAAM,IAAI,KAAK,CAAC,yEAAyE,CAAC,CAAC;IAC7F,CAAC;IAED,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC,EAAE,CAAC;QACpG,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;IACnE,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,OAAgC;IAC/D,eAAe,CAAC,OAAO,CAAC,CAAC;IAEzB,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;IAC5C,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAClC,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC;IAE5D,MAAM,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC1C,IAAI,YAAY,GAAG,CAAC,CAAC;IAErB,MAAM,SAAS,GAAG,CAAC,GAAW,EAAU,EAAE;QACxC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,QAAQ,EAAE,CAAC;YACb,OAAO,QAAQ,CAAC;QAClB,CAAC;QAED,MAAM,OAAO,GAAW,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;QACjD,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAC1B,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC;IAEF,MAAM,oBAAoB,GAAG,CAAC,GAAW,EAAQ,EAAE;QACjD,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO;QACT,CAAC;QAED,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrD,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACtB,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,WAAW,GAAG,CAAC,GAAW,EAAQ,EAAE;QACxC,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO;QACT,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,GAAG,aAAa,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChE,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YAClC,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,MAAM;YACR,CAAC;YAED,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBAChC,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YACzD,CAAC;YAED,MAAM,CAAC,MAAM,IAAI,CAAC,CAAC;YACnB,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,CAAC;QAED,oBAAoB,CAAC,GAAG,CAAC,CAAC;IAC5B,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,KAAK,EAAE,GAAW,EAAE,MAAoB,EAAiB,EAAE;QACzE,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;QAE9B,IAAI,MAAM,CAAC,MAAM,GAAG,aAAa,EAAE,CAAC;YAClC,MAAM,CAAC,MAAM,IAAI,CAAC,CAAC;YACnB,OAAO;QACT,CAAC;QAED,IAAI,QAAQ,KAAK,SAAS,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,IAAI,QAAQ,EAAE,CAAC;YAC9D,MAAM,IAAI,KAAK,CAAC,oDAAoD,GAAG,GAAG,CAAC,CAAC;QAC9E,CAAC;QAED,IAAI,MAAM,EAAE,OAAO,EAAE,CAAC;YACpB,MAAM,MAAM,CAAC,MAAM,IAAI,IAAI,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QACnE,CAAC;QAED,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC1C,MAAM,QAAQ,GAAG,YAAY,EAAE,CAAC;YAChC,wDAAwD;YACxD,IAAI,YAAY,GAAG,MAAM,CAAC,gBAAgB,EAAE,CAAC;gBAC3C,YAAY,GAAG,CAAC,CAAC;YACnB,CAAC;YAED,IAAI,OAAiC,CAAC;YACtC,IAAI,MAAM,EAAE,CAAC;gBACX,OAAO,GAAG,GAAG,EAAE;oBACb,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;oBACtC,IAAI,CAAC,YAAY,EAAE,CAAC;wBAClB,MAAM,CAAC,MAAM,CAAC,MAAM,IAAI,IAAI,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC;wBACnE,OAAO;oBACT,CAAC;oBAED,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAC;oBAC7E,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;wBACf,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;oBACtC,CAAC;oBAED,oBAAoB,CAAC,GAAG,CAAC,CAAC;oBAC1B,MAAM,CAAC,MAAM,CAAC,MAAM,IAAI,IAAI,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC;gBACrE,CAAC,CAAC;gBAEF,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;YAC5D,CAAC;YAED,MAAM,KAAK,GAAe;gBACxB,EAAE,EAAE,QAAQ;gBACZ,OAAO;gBACP,MAAM;gBACN,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC3C,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aAC9C,CAAC;YAEF,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,CAAC,GAAW,EAAQ,EAAE;QACpC,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO;QACT,CAAC;QAED,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC/C,WAAW,CAAC,GAAG,CAAC,CAAC;IACnB,CAAC,CAAC;IAEF,MAAM,UAAU,GAAe,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QACjD,MAAM,GAAG,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;QAC5B,MAAM,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;QAE/B,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,CAAC;QACzB,CAAC;gBAAS,CAAC;YACT,OAAO,CAAC,GAAG,CAAC,CAAC;QACf,CAAC;IACH,CAAC,CAAC;IAEF,OAAO,oBAAoB,CAAC,UAAU,EAAE;QACtC,IAAI,EAAE,kBAAkB;QACxB,IAAI,EAAE,aAAa;QACnB,aAAa;KACd,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { Middleware } from "../types/http";
|
|
2
|
+
export interface DeadlineOptions {
|
|
3
|
+
readonly defaultTimeoutMs?: number;
|
|
4
|
+
readonly now?: () => number;
|
|
5
|
+
}
|
|
6
|
+
/**
|
|
7
|
+
* Applies a total request deadline that is preserved across retries.
|
|
8
|
+
*/
|
|
9
|
+
export declare function deadline(options?: DeadlineOptions): Middleware;
|
|
10
|
+
//# sourceMappingURL=deadline.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"deadline.d.ts","sourceRoot":"","sources":["../../../src/middleware/deadline.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAGhD,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,MAAM,CAAC;CAC7B;AAmFD;;GAEG;AACH,wBAAgB,QAAQ,CAAC,OAAO,GAAE,eAAoB,GAAG,UAAU,CA8ClE"}
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
import { markPolicyMiddleware } from "../policy/guardrails";
|
|
2
|
+
function resolveDeadlineAt(req, now, defaultTimeoutMs) {
|
|
3
|
+
const existing = req._meta?.deadlineAt;
|
|
4
|
+
if (typeof existing === "number" && Number.isFinite(existing)) {
|
|
5
|
+
return existing;
|
|
6
|
+
}
|
|
7
|
+
if (req.timeout !== undefined) {
|
|
8
|
+
if (!Number.isFinite(req.timeout) || req.timeout <= 0) {
|
|
9
|
+
throw new Error("pureq: deadline requires timeout to be a positive number");
|
|
10
|
+
}
|
|
11
|
+
return now + req.timeout;
|
|
12
|
+
}
|
|
13
|
+
if (defaultTimeoutMs !== undefined) {
|
|
14
|
+
if (!Number.isFinite(defaultTimeoutMs) || defaultTimeoutMs <= 0) {
|
|
15
|
+
throw new Error("pureq: deadline defaultTimeoutMs must be a positive number");
|
|
16
|
+
}
|
|
17
|
+
return now + defaultTimeoutMs;
|
|
18
|
+
}
|
|
19
|
+
return undefined;
|
|
20
|
+
}
|
|
21
|
+
function readMeta(req) {
|
|
22
|
+
if (typeof req !== "object" || req === null || !("_meta" in req)) {
|
|
23
|
+
return undefined;
|
|
24
|
+
}
|
|
25
|
+
return req._meta;
|
|
26
|
+
}
|
|
27
|
+
function timeoutError(deadlineAt, now) {
|
|
28
|
+
const elapsed = Math.max(0, Math.round(now - deadlineAt));
|
|
29
|
+
return new Error(`pureq: request timeout after deadline exceeded (${elapsed}ms past deadline)`);
|
|
30
|
+
}
|
|
31
|
+
function joinSignal(externalSignal, remainingMs, deadlineAt, now) {
|
|
32
|
+
const controller = new AbortController();
|
|
33
|
+
const timeoutId = setTimeout(() => {
|
|
34
|
+
controller.abort(timeoutError(deadlineAt, now()));
|
|
35
|
+
}, remainingMs);
|
|
36
|
+
const onExternalAbort = () => {
|
|
37
|
+
controller.abort(externalSignal?.reason ?? new DOMException("Aborted", "AbortError"));
|
|
38
|
+
};
|
|
39
|
+
if (externalSignal) {
|
|
40
|
+
if (externalSignal.aborted) {
|
|
41
|
+
onExternalAbort();
|
|
42
|
+
}
|
|
43
|
+
else {
|
|
44
|
+
externalSignal.addEventListener("abort", onExternalAbort, { once: true });
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
const cleanup = () => {
|
|
48
|
+
clearTimeout(timeoutId);
|
|
49
|
+
if (externalSignal) {
|
|
50
|
+
externalSignal.removeEventListener("abort", onExternalAbort);
|
|
51
|
+
}
|
|
52
|
+
};
|
|
53
|
+
return {
|
|
54
|
+
signal: controller.signal,
|
|
55
|
+
cleanup,
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Applies a total request deadline that is preserved across retries.
|
|
60
|
+
*/
|
|
61
|
+
export function deadline(options = {}) {
|
|
62
|
+
const middleware = async (req, next) => {
|
|
63
|
+
const nowFactory = options.now ?? Date.now;
|
|
64
|
+
const startedAt = nowFactory();
|
|
65
|
+
const existingMeta = readMeta(req);
|
|
66
|
+
const deadlineAt = resolveDeadlineAt({
|
|
67
|
+
...(req.timeout !== undefined ? { timeout: req.timeout } : {}),
|
|
68
|
+
...(existingMeta ? { _meta: existingMeta } : {}),
|
|
69
|
+
}, startedAt, options.defaultTimeoutMs);
|
|
70
|
+
if (deadlineAt === undefined) {
|
|
71
|
+
return next(req);
|
|
72
|
+
}
|
|
73
|
+
const remainingMs = Math.max(0, Math.ceil(deadlineAt - startedAt));
|
|
74
|
+
if (remainingMs <= 0) {
|
|
75
|
+
throw timeoutError(deadlineAt, startedAt);
|
|
76
|
+
}
|
|
77
|
+
const { signal, cleanup } = joinSignal(req.signal, remainingMs, deadlineAt, nowFactory);
|
|
78
|
+
try {
|
|
79
|
+
const nextReq = {
|
|
80
|
+
...req,
|
|
81
|
+
signal,
|
|
82
|
+
timeout: Math.min(req.timeout ?? remainingMs, remainingMs),
|
|
83
|
+
_meta: {
|
|
84
|
+
...(existingMeta ?? {}),
|
|
85
|
+
deadlineAt,
|
|
86
|
+
},
|
|
87
|
+
};
|
|
88
|
+
return await next(nextReq);
|
|
89
|
+
}
|
|
90
|
+
finally {
|
|
91
|
+
cleanup();
|
|
92
|
+
}
|
|
93
|
+
};
|
|
94
|
+
return markPolicyMiddleware(middleware, {
|
|
95
|
+
name: "deadline",
|
|
96
|
+
kind: "timeout",
|
|
97
|
+
});
|
|
98
|
+
}
|
|
99
|
+
//# sourceMappingURL=deadline.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"deadline.js","sourceRoot":"","sources":["../../../src/middleware/deadline.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAO5D,SAAS,iBAAiB,CACxB,GAAsF,EACtF,GAAW,EACX,gBAAyB;IAEzB,MAAM,QAAQ,GAAG,GAAG,CAAC,KAAK,EAAE,UAAU,CAAC;IACvC,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC9D,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,IAAI,GAAG,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QAC9B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,OAAO,IAAI,CAAC,EAAE,CAAC;YACtD,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;QAC9E,CAAC;QACD,OAAO,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC;IAC3B,CAAC;IAED,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;QACnC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,gBAAgB,IAAI,CAAC,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAChF,CAAC;QACD,OAAO,GAAG,GAAG,gBAAgB,CAAC;IAChC,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,QAAQ,CAAC,GAAoE;IAGpF,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,CAAC,CAAC,OAAO,IAAI,GAAG,CAAC,EAAE,CAAC;QACjE,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAQ,GAA8D,CAAC,KAAK,CAAC;AAC/E,CAAC;AAED,SAAS,YAAY,CAAC,UAAkB,EAAE,GAAW;IACnD,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,UAAU,CAAC,CAAC,CAAC;IAC1D,OAAO,IAAI,KAAK,CAAC,mDAAmD,OAAO,mBAAmB,CAAC,CAAC;AAClG,CAAC;AAED,SAAS,UAAU,CACjB,cAAuC,EACvC,WAAmB,EACnB,UAAkB,EAClB,GAAiB;IAKjB,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;IACzC,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;QAChC,UAAU,CAAC,KAAK,CAAC,YAAY,CAAC,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IACpD,CAAC,EAAE,WAAW,CAAC,CAAC;IAEhB,MAAM,eAAe,GAAG,GAAG,EAAE;QAC3B,UAAU,CAAC,KAAK,CAAC,cAAc,EAAE,MAAM,IAAI,IAAI,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC;IACxF,CAAC,CAAC;IAEF,IAAI,cAAc,EAAE,CAAC;QACnB,IAAI,cAAc,CAAC,OAAO,EAAE,CAAC;YAC3B,eAAe,EAAE,CAAC;QACpB,CAAC;aAAM,CAAC;YACN,cAAc,CAAC,gBAAgB,CAAC,OAAO,EAAE,eAAe,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QAC5E,CAAC;IACH,CAAC;IAED,MAAM,OAAO,GAAG,GAAG,EAAE;QACnB,YAAY,CAAC,SAAS,CAAC,CAAC;QACxB,IAAI,cAAc,EAAE,CAAC;YACnB,cAAc,CAAC,mBAAmB,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC,CAAC;IAEF,OAAO;QACL,MAAM,EAAE,UAAU,CAAC,MAAM;QACzB,OAAO;KACR,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,QAAQ,CAAC,UAA2B,EAAE;IACpD,MAAM,UAAU,GAAe,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QACjD,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC;QAC3C,MAAM,SAAS,GAAG,UAAU,EAAE,CAAC;QAC/B,MAAM,YAAY,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;QACnC,MAAM,UAAU,GAAG,iBAAiB,CAClC;YACE,GAAG,CAAC,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC9D,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACjD,EACD,SAAS,EACT,OAAO,CAAC,gBAAgB,CACzB,CAAC;QAEF,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC,CAAC;QACnE,IAAI,WAAW,IAAI,CAAC,EAAE,CAAC;YACrB,MAAM,YAAY,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;QAC5C,CAAC;QAED,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;QAExF,IAAI,CAAC;YACH,MAAM,OAAO,GAAG;gBACd,GAAG,GAAG;gBACN,MAAM;gBACN,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,IAAI,WAAW,EAAE,WAAW,CAAC;gBAC1D,KAAK,EAAE;oBACL,GAAG,CAAC,YAAY,IAAI,EAAE,CAAC;oBACvB,UAAU;iBACX;aACF,CAAC;YAEF,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7B,CAAC;gBAAS,CAAC;YACT,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC,CAAC;IAEF,OAAO,oBAAoB,CAAC,UAAU,EAAE;QACtC,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,SAAS;KAChB,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { Middleware, RequestConfig } from "../types/http";
|
|
2
|
+
export interface DedupeOptions {
|
|
3
|
+
readonly methods?: readonly RequestConfig["method"][];
|
|
4
|
+
readonly includeHeaders?: boolean;
|
|
5
|
+
readonly includeBody?: boolean;
|
|
6
|
+
readonly keyBuilder?: (req: Readonly<RequestConfig>) => string;
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* Deduplicates in-flight requests with the same request signature.
|
|
10
|
+
* Useful for UI bursts and concurrent cache stampede prevention.
|
|
11
|
+
*/
|
|
12
|
+
export declare function dedupe(options?: DedupeOptions): Middleware;
|
|
13
|
+
//# sourceMappingURL=dedupe.d.ts.map
|