@pipeline-builder/api-core 0.0.1
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 +202 -0
- package/README.md +98 -0
- package/lib/constants/ai-providers.d.ts +52 -0
- package/lib/constants/ai-providers.js +129 -0
- package/lib/constants/http-status.d.ts +20 -0
- package/lib/constants/http-status.js +26 -0
- package/lib/constants/index.d.ts +3 -0
- package/lib/constants/index.js +6 -0
- package/lib/constants/time.d.ts +10 -0
- package/lib/constants/time.js +13 -0
- package/lib/errors/app-errors.d.ts +30 -0
- package/lib/errors/app-errors.js +53 -0
- package/lib/errors/index.d.ts +1 -0
- package/lib/errors/index.js +4 -0
- package/lib/helpers/access-helpers.d.ts +63 -0
- package/lib/helpers/access-helpers.js +82 -0
- package/lib/helpers/crud-helpers.d.ts +9 -0
- package/lib/helpers/crud-helpers.js +23 -0
- package/lib/helpers/index.d.ts +6 -0
- package/lib/helpers/index.js +9 -0
- package/lib/helpers/org-hierarchy-http.d.ts +74 -0
- package/lib/helpers/org-hierarchy-http.js +144 -0
- package/lib/helpers/org-hierarchy.d.ts +57 -0
- package/lib/helpers/org-hierarchy.js +110 -0
- package/lib/helpers/restore-helpers.d.ts +49 -0
- package/lib/helpers/restore-helpers.js +78 -0
- package/lib/helpers/sse-helpers.d.ts +20 -0
- package/lib/helpers/sse-helpers.js +45 -0
- package/lib/index.d.ts +58 -0
- package/lib/index.js +71 -0
- package/lib/middleware/auth.d.ts +208 -0
- package/lib/middleware/auth.js +588 -0
- package/lib/middleware/index.d.ts +3 -0
- package/lib/middleware/index.js +6 -0
- package/lib/middleware/mongo-sanitize.d.ts +32 -0
- package/lib/middleware/mongo-sanitize.js +100 -0
- package/lib/middleware/step-up.d.ts +45 -0
- package/lib/middleware/step-up.js +138 -0
- package/lib/openapi/extend-zod.d.ts +1 -0
- package/lib/openapi/extend-zod.js +6 -0
- package/lib/openapi/index.d.ts +2 -0
- package/lib/openapi/index.js +5 -0
- package/lib/openapi/registry.d.ts +17 -0
- package/lib/openapi/registry.js +38 -0
- package/lib/openapi/routes/ask-routes.d.ts +7 -0
- package/lib/openapi/routes/ask-routes.js +62 -0
- package/lib/openapi/routes/billing-routes.d.ts +1 -0
- package/lib/openapi/routes/billing-routes.js +66 -0
- package/lib/openapi/routes/image-registry-routes.d.ts +7 -0
- package/lib/openapi/routes/image-registry-routes.js +98 -0
- package/lib/openapi/routes/index.d.ts +5 -0
- package/lib/openapi/routes/index.js +28 -0
- package/lib/openapi/routes/message-routes.d.ts +1 -0
- package/lib/openapi/routes/message-routes.js +105 -0
- package/lib/openapi/routes/pipeline-routes.d.ts +1 -0
- package/lib/openapi/routes/pipeline-routes.js +105 -0
- package/lib/openapi/routes/pipeline-template-routes.d.ts +1 -0
- package/lib/openapi/routes/pipeline-template-routes.js +61 -0
- package/lib/openapi/routes/plugin-routes.d.ts +1 -0
- package/lib/openapi/routes/plugin-routes.js +96 -0
- package/lib/openapi/routes/quota-routes.d.ts +1 -0
- package/lib/openapi/routes/quota-routes.js +62 -0
- package/lib/openapi/schema-registry.d.ts +25 -0
- package/lib/openapi/schema-registry.js +91 -0
- package/lib/routes/health.d.ts +41 -0
- package/lib/routes/health.js +82 -0
- package/lib/routes/index.d.ts +1 -0
- package/lib/routes/index.js +4 -0
- package/lib/services/audit-spool.d.ts +80 -0
- package/lib/services/audit-spool.js +172 -0
- package/lib/services/cache-service.d.ts +124 -0
- package/lib/services/cache-service.js +276 -0
- package/lib/services/circuit-breaker.d.ts +45 -0
- package/lib/services/circuit-breaker.js +138 -0
- package/lib/services/compliance-client.d.ts +46 -0
- package/lib/services/compliance-client.js +128 -0
- package/lib/services/compliance-event-subscriber.d.ts +16 -0
- package/lib/services/compliance-event-subscriber.js +72 -0
- package/lib/services/durable-event-bus.d.ts +96 -0
- package/lib/services/durable-event-bus.js +204 -0
- package/lib/services/entity-events.d.ts +48 -0
- package/lib/services/entity-events.js +79 -0
- package/lib/services/env-redis.d.ts +44 -0
- package/lib/services/env-redis.js +94 -0
- package/lib/services/http-client.d.ts +143 -0
- package/lib/services/http-client.js +335 -0
- package/lib/services/index.d.ts +18 -0
- package/lib/services/index.js +20 -0
- package/lib/services/leader-lock.d.ts +45 -0
- package/lib/services/leader-lock.js +85 -0
- package/lib/services/quota.d.ts +130 -0
- package/lib/services/quota.js +264 -0
- package/lib/services/remote-audit-client.d.ts +160 -0
- package/lib/services/remote-audit-client.js +390 -0
- package/lib/services/retry-strategy.d.ts +74 -0
- package/lib/services/retry-strategy.js +118 -0
- package/lib/services/scheduler.d.ts +41 -0
- package/lib/services/scheduler.js +86 -0
- package/lib/services/service-boot.d.ts +20 -0
- package/lib/services/service-boot.js +28 -0
- package/lib/services/sse-ticket-store.d.ts +51 -0
- package/lib/services/sse-ticket-store.js +130 -0
- package/lib/services/token-revocation.d.ts +52 -0
- package/lib/services/token-revocation.js +120 -0
- package/lib/testing/tier-mock.d.ts +44 -0
- package/lib/testing/tier-mock.js +65 -0
- package/lib/types/audit-events.d.ts +69 -0
- package/lib/types/audit-events.js +4 -0
- package/lib/types/catalog-metadata.d.ts +36 -0
- package/lib/types/catalog-metadata.js +21 -0
- package/lib/types/common.d.ts +255 -0
- package/lib/types/common.js +41 -0
- package/lib/types/error-codes.d.ts +54 -0
- package/lib/types/error-codes.js +107 -0
- package/lib/types/feature-flags.d.ts +36 -0
- package/lib/types/feature-flags.js +128 -0
- package/lib/types/http.d.ts +27 -0
- package/lib/types/http.js +4 -0
- package/lib/types/index.d.ts +11 -0
- package/lib/types/index.js +14 -0
- package/lib/types/permissions.d.ts +65 -0
- package/lib/types/permissions.js +131 -0
- package/lib/types/pipeline-template.d.ts +30 -0
- package/lib/types/pipeline-template.js +13 -0
- package/lib/types/pipeline.d.ts +59 -0
- package/lib/types/pipeline.js +31 -0
- package/lib/types/quota-tiers.d.ts +79 -0
- package/lib/types/quota-tiers.js +221 -0
- package/lib/types/visibility.d.ts +20 -0
- package/lib/types/visibility.js +22 -0
- package/lib/utils/alias-resolver.d.ts +37 -0
- package/lib/utils/alias-resolver.js +68 -0
- package/lib/utils/audit.d.ts +15 -0
- package/lib/utils/audit.js +39 -0
- package/lib/utils/aws-scrub.d.ts +11 -0
- package/lib/utils/aws-scrub.js +67 -0
- package/lib/utils/compliance-attributes.d.ts +6 -0
- package/lib/utils/compliance-attributes.js +69 -0
- package/lib/utils/concurrency.d.ts +9 -0
- package/lib/utils/concurrency.js +29 -0
- package/lib/utils/crash-handlers.d.ts +18 -0
- package/lib/utils/crash-handlers.js +36 -0
- package/lib/utils/env.d.ts +28 -0
- package/lib/utils/env.js +54 -0
- package/lib/utils/headers.d.ts +18 -0
- package/lib/utils/headers.js +21 -0
- package/lib/utils/identity.d.ts +40 -0
- package/lib/utils/identity.js +51 -0
- package/lib/utils/index.d.ts +17 -0
- package/lib/utils/index.js +20 -0
- package/lib/utils/logger.d.ts +38 -0
- package/lib/utils/logger.js +174 -0
- package/lib/utils/metric-emitter.d.ts +36 -0
- package/lib/utils/metric-emitter.js +32 -0
- package/lib/utils/object.d.ts +13 -0
- package/lib/utils/object.js +18 -0
- package/lib/utils/params.d.ts +150 -0
- package/lib/utils/params.js +206 -0
- package/lib/utils/response.d.ts +117 -0
- package/lib/utils/response.js +223 -0
- package/lib/utils/safe-require.d.ts +13 -0
- package/lib/utils/safe-require.js +19 -0
- package/lib/utils/secret-encryption.d.ts +176 -0
- package/lib/utils/secret-encryption.js +374 -0
- package/lib/utils/ssrf.d.ts +30 -0
- package/lib/utils/ssrf.js +106 -0
- package/lib/validation/ai-schemas.d.ts +56 -0
- package/lib/validation/ai-schemas.js +78 -0
- package/lib/validation/common-schemas.d.ts +133 -0
- package/lib/validation/common-schemas.js +94 -0
- package/lib/validation/index.d.ts +7 -0
- package/lib/validation/index.js +10 -0
- package/lib/validation/message-schemas.d.ts +160 -0
- package/lib/validation/message-schemas.js +156 -0
- package/lib/validation/middleware.d.ts +72 -0
- package/lib/validation/middleware.js +65 -0
- package/lib/validation/pipeline-schemas.d.ts +181 -0
- package/lib/validation/pipeline-schemas.js +101 -0
- package/lib/validation/pipeline-template-schemas.d.ts +155 -0
- package/lib/validation/pipeline-template-schemas.js +66 -0
- package/lib/validation/plugin-schemas.d.ts +171 -0
- package/lib/validation/plugin-schemas.js +81 -0
- package/openapi.yaml +292 -0
- package/package.json +167 -0
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
export type CircuitState = 'closed' | 'open' | 'half-open';
|
|
2
|
+
export interface CircuitBreakerConfig {
|
|
3
|
+
/** Consecutive failures that trip the breaker from closed → open. */
|
|
4
|
+
failureThreshold: number;
|
|
5
|
+
/** How long to stay open before allowing a half-open probe (ms). */
|
|
6
|
+
cooldownMs: number;
|
|
7
|
+
/** Master switch — when false, allowRequest() is always true and no state moves. */
|
|
8
|
+
enabled: boolean;
|
|
9
|
+
}
|
|
10
|
+
export declare const DEFAULT_BREAKER_CONFIG: CircuitBreakerConfig;
|
|
11
|
+
/**
|
|
12
|
+
* A single target's breaker. Not concurrency-locked (JS is single-threaded per
|
|
13
|
+
* event loop); `probeInFlight` gates half-open to one in-flight probe so a burst
|
|
14
|
+
* during cooldown doesn't stampede the recovering downstream.
|
|
15
|
+
*/
|
|
16
|
+
export declare class CircuitBreaker {
|
|
17
|
+
private readonly key;
|
|
18
|
+
private readonly config;
|
|
19
|
+
private state;
|
|
20
|
+
private consecutiveFailures;
|
|
21
|
+
private openedAt;
|
|
22
|
+
private probeInFlight;
|
|
23
|
+
constructor(key: string, config?: CircuitBreakerConfig);
|
|
24
|
+
getState(): CircuitState;
|
|
25
|
+
/**
|
|
26
|
+
* Whether a request may proceed. Transitions open→half-open once the cooldown
|
|
27
|
+
* elapses and lets exactly ONE probe through. Returns false when open (or a
|
|
28
|
+
* probe is already in flight) — the caller must fast-fail without any network.
|
|
29
|
+
*/
|
|
30
|
+
allowRequest(): boolean;
|
|
31
|
+
/** A logical request succeeded (2xx/3xx/4xx that isn't a downstream fault). */
|
|
32
|
+
recordSuccess(): void;
|
|
33
|
+
/** A logical request failed (connection error, timeout, or 5xx response). */
|
|
34
|
+
recordFailure(): void;
|
|
35
|
+
private open;
|
|
36
|
+
}
|
|
37
|
+
/** Get (or lazily create) the shared breaker for a `host:port` target. */
|
|
38
|
+
export declare function getCircuitBreaker(key: string): CircuitBreaker;
|
|
39
|
+
/** Test helper: clear all breaker state so suites don't leak across each other. */
|
|
40
|
+
export declare function resetCircuitBreakers(): void;
|
|
41
|
+
/** Thrown by the client when a request is fast-failed because the breaker is open. */
|
|
42
|
+
export declare class CircuitOpenError extends Error {
|
|
43
|
+
readonly code = "CIRCUIT_OPEN";
|
|
44
|
+
constructor(target: string);
|
|
45
|
+
}
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
// Copyright 2026 Pipeline Builder Contributors
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0
|
|
3
|
+
/**
|
|
4
|
+
* Per-target circuit breaker for service-to-service calls.
|
|
5
|
+
*
|
|
6
|
+
* The shared {@link InternalHttpClient} already has timeouts, a bounded socket
|
|
7
|
+
* pool, and bounded retry-with-jitter — but no load-shedding. Under a sustained
|
|
8
|
+
* downstream brownout every caller keeps paying `timeout × (maxRetries+1)` per
|
|
9
|
+
* request, saturating the socket pool and turning one slow dependency into a
|
|
10
|
+
* fleet-wide latency cascade (the classic retry storm). Worse for fail-CLOSED
|
|
11
|
+
* dependencies (compliance): a brownout there blocks plugin/pipeline creation
|
|
12
|
+
* with full retry latency on every request.
|
|
13
|
+
*
|
|
14
|
+
* This breaker short-circuits that: after `failureThreshold` consecutive
|
|
15
|
+
* failures to a target it OPENS and fast-fails (no network, no retries) for
|
|
16
|
+
* `cooldownMs`, then allows a single half-open probe. A fail-closed caller still
|
|
17
|
+
* fails closed — just immediately, instead of after the full retry budget; a
|
|
18
|
+
* fail-open caller (createSafeClient) gets its `null` immediately.
|
|
19
|
+
*
|
|
20
|
+
* State is keyed by `host:port` in a process-level registry so it is shared even
|
|
21
|
+
* when callers mint a fresh client per request — one bad target trips once, not
|
|
22
|
+
* once-per-client. Disable entirely with `S2S_BREAKER_ENABLED=false`.
|
|
23
|
+
*/
|
|
24
|
+
import { envInt, envBool } from '../utils/env.js';
|
|
25
|
+
import { createLogger } from '../utils/logger.js';
|
|
26
|
+
import { emitCounter } from '../utils/metric-emitter.js';
|
|
27
|
+
const logger = createLogger('circuit-breaker');
|
|
28
|
+
export const DEFAULT_BREAKER_CONFIG = {
|
|
29
|
+
failureThreshold: envInt('S2S_BREAKER_THRESHOLD', 5, { min: 1 }),
|
|
30
|
+
cooldownMs: envInt('S2S_BREAKER_COOLDOWN_MS', 10000, { min: 1 }),
|
|
31
|
+
enabled: envBool('S2S_BREAKER_ENABLED', true),
|
|
32
|
+
};
|
|
33
|
+
/**
|
|
34
|
+
* A single target's breaker. Not concurrency-locked (JS is single-threaded per
|
|
35
|
+
* event loop); `probeInFlight` gates half-open to one in-flight probe so a burst
|
|
36
|
+
* during cooldown doesn't stampede the recovering downstream.
|
|
37
|
+
*/
|
|
38
|
+
export class CircuitBreaker {
|
|
39
|
+
key;
|
|
40
|
+
config;
|
|
41
|
+
state = 'closed';
|
|
42
|
+
consecutiveFailures = 0;
|
|
43
|
+
openedAt = 0;
|
|
44
|
+
probeInFlight = false;
|
|
45
|
+
constructor(key, config = DEFAULT_BREAKER_CONFIG) {
|
|
46
|
+
this.key = key;
|
|
47
|
+
this.config = config;
|
|
48
|
+
}
|
|
49
|
+
getState() {
|
|
50
|
+
return this.state;
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* Whether a request may proceed. Transitions open→half-open once the cooldown
|
|
54
|
+
* elapses and lets exactly ONE probe through. Returns false when open (or a
|
|
55
|
+
* probe is already in flight) — the caller must fast-fail without any network.
|
|
56
|
+
*/
|
|
57
|
+
allowRequest() {
|
|
58
|
+
if (!this.config.enabled)
|
|
59
|
+
return true;
|
|
60
|
+
if (this.state === 'closed')
|
|
61
|
+
return true;
|
|
62
|
+
if (this.state === 'open') {
|
|
63
|
+
if (Date.now() - this.openedAt >= this.config.cooldownMs) {
|
|
64
|
+
this.state = 'half-open';
|
|
65
|
+
this.probeInFlight = true;
|
|
66
|
+
return true;
|
|
67
|
+
}
|
|
68
|
+
return false;
|
|
69
|
+
}
|
|
70
|
+
// half-open: allow only a single probe at a time.
|
|
71
|
+
if (this.probeInFlight)
|
|
72
|
+
return false;
|
|
73
|
+
this.probeInFlight = true;
|
|
74
|
+
return true;
|
|
75
|
+
}
|
|
76
|
+
/** A logical request succeeded (2xx/3xx/4xx that isn't a downstream fault). */
|
|
77
|
+
recordSuccess() {
|
|
78
|
+
if (!this.config.enabled)
|
|
79
|
+
return;
|
|
80
|
+
this.consecutiveFailures = 0;
|
|
81
|
+
this.probeInFlight = false;
|
|
82
|
+
if (this.state !== 'closed') {
|
|
83
|
+
logger.info('circuit closed (downstream recovered)', { target: this.key });
|
|
84
|
+
this.state = 'closed';
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
/** A logical request failed (connection error, timeout, or 5xx response). */
|
|
88
|
+
recordFailure() {
|
|
89
|
+
if (!this.config.enabled)
|
|
90
|
+
return;
|
|
91
|
+
this.probeInFlight = false;
|
|
92
|
+
this.consecutiveFailures++;
|
|
93
|
+
// A failed half-open probe means the downstream is still bad — re-open.
|
|
94
|
+
if (this.state === 'half-open') {
|
|
95
|
+
this.open();
|
|
96
|
+
return;
|
|
97
|
+
}
|
|
98
|
+
if (this.state === 'closed' && this.consecutiveFailures >= this.config.failureThreshold) {
|
|
99
|
+
this.open();
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
open() {
|
|
103
|
+
const wasOpen = this.state === 'open';
|
|
104
|
+
this.state = 'open';
|
|
105
|
+
this.openedAt = Date.now();
|
|
106
|
+
if (!wasOpen) {
|
|
107
|
+
logger.warn('circuit opened — shedding load to target', {
|
|
108
|
+
target: this.key,
|
|
109
|
+
consecutiveFailures: this.consecutiveFailures,
|
|
110
|
+
cooldownMs: this.config.cooldownMs,
|
|
111
|
+
});
|
|
112
|
+
emitCounter('s2s_circuit_opened_total', { target: this.key });
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
const registry = new Map();
|
|
117
|
+
/** Get (or lazily create) the shared breaker for a `host:port` target. */
|
|
118
|
+
export function getCircuitBreaker(key) {
|
|
119
|
+
let breaker = registry.get(key);
|
|
120
|
+
if (!breaker) {
|
|
121
|
+
breaker = new CircuitBreaker(key);
|
|
122
|
+
registry.set(key, breaker);
|
|
123
|
+
}
|
|
124
|
+
return breaker;
|
|
125
|
+
}
|
|
126
|
+
/** Test helper: clear all breaker state so suites don't leak across each other. */
|
|
127
|
+
export function resetCircuitBreakers() {
|
|
128
|
+
registry.clear();
|
|
129
|
+
}
|
|
130
|
+
/** Thrown by the client when a request is fast-failed because the breaker is open. */
|
|
131
|
+
export class CircuitOpenError extends Error {
|
|
132
|
+
code = 'CIRCUIT_OPEN';
|
|
133
|
+
constructor(target) {
|
|
134
|
+
super(`Circuit open for ${target} — fast-failing to shed load`);
|
|
135
|
+
this.name = 'CircuitOpenError';
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"circuit-breaker.js","sourceRoot":"","sources":["../../src/services/circuit-breaker.ts"],"names":[],"mappings":"AAAA,+CAA+C;AAC/C,sCAAsC;AAEtC;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAEzD,MAAM,MAAM,GAAG,YAAY,CAAC,iBAAiB,CAAC,CAAC;AAa/C,MAAM,CAAC,MAAM,sBAAsB,GAAyB;IAC1D,gBAAgB,EAAE,MAAM,CAAC,uBAAuB,EAAE,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC;IAChE,UAAU,EAAE,MAAM,CAAC,yBAAyB,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC;IAChE,OAAO,EAAE,OAAO,CAAC,qBAAqB,EAAE,IAAI,CAAC;CAC9C,CAAC;AAEF;;;;GAIG;AACH,MAAM,OAAO,cAAc;IAON,GAAG;IACH,MAAM;IAPjB,KAAK,GAAiB,QAAQ,CAAC;IAC/B,mBAAmB,GAAG,CAAC,CAAC;IACxB,QAAQ,GAAG,CAAC,CAAC;IACb,aAAa,GAAG,KAAK,CAAC;IAE9B,YACmB,GAAW,EACX,MAAM,GAAyB,sBAAsB;mBADrD,GAAG;sBACH,MAAM;IACtB,CAAC;IAEJ,QAAQ;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,YAAY;QACV,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO;YAAE,OAAO,IAAI,CAAC;QACtC,IAAI,IAAI,CAAC,KAAK,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAC;QACzC,IAAI,IAAI,CAAC,KAAK,KAAK,MAAM,EAAE,CAAC;YAC1B,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;gBACzD,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC;gBACzB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;gBAC1B,OAAO,IAAI,CAAC;YACd,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QACD,kDAAkD;QAClD,IAAI,IAAI,CAAC,aAAa;YAAE,OAAO,KAAK,CAAC;QACrC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,+EAA+E;IAC/E,aAAa;QACX,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO;YAAE,OAAO;QACjC,IAAI,CAAC,mBAAmB,GAAG,CAAC,CAAC;QAC7B,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;QAC3B,IAAI,IAAI,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC5B,MAAM,CAAC,IAAI,CAAC,uCAAuC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;YAC3E,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC;QACxB,CAAC;IACH,CAAC;IAED,6EAA6E;IAC7E,aAAa;QACX,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO;YAAE,OAAO;QACjC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;QAC3B,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC3B,wEAAwE;QACxE,IAAI,IAAI,CAAC,KAAK,KAAK,WAAW,EAAE,CAAC;YAC/B,IAAI,CAAC,IAAI,EAAE,CAAC;YACZ,OAAO;QACT,CAAC;QACD,IAAI,IAAI,CAAC,KAAK,KAAK,QAAQ,IAAI,IAAI,CAAC,mBAAmB,IAAI,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE,CAAC;YACxF,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,CAAC;IACH,CAAC;IAEO,IAAI;QACV,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,KAAK,MAAM,CAAC;QACtC,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC;QACpB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC3B,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,CAAC,IAAI,CAAC,0CAA0C,EAAE;gBACtD,MAAM,EAAE,IAAI,CAAC,GAAG;gBAChB,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;gBAC7C,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU;aACnC,CAAC,CAAC;YACH,WAAW,CAAC,0BAA0B,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QAChE,CAAC;IACH,CAAC;CACF;AAED,MAAM,QAAQ,GAAG,IAAI,GAAG,EAA0B,CAAC;AAEnD,0EAA0E;AAC1E,MAAM,UAAU,iBAAiB,CAAC,GAAW;IAC3C,IAAI,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAChC,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,GAAG,IAAI,cAAc,CAAC,GAAG,CAAC,CAAC;QAClC,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAC7B,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,mFAAmF;AACnF,MAAM,UAAU,oBAAoB;IAClC,QAAQ,CAAC,KAAK,EAAE,CAAC;AACnB,CAAC;AAED,sFAAsF;AACtF,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IAChC,IAAI,GAAG,cAAc,CAAC;IAC/B,YAAY,MAAc;QACxB,KAAK,CAAC,oBAAoB,MAAM,8BAA8B,CAAC,CAAC;QAChE,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC;IACjC,CAAC;CACF","sourcesContent":["// Copyright 2026 Pipeline Builder Contributors\n// SPDX-License-Identifier: Apache-2.0\n\n/**\n * Per-target circuit breaker for service-to-service calls.\n *\n * The shared {@link InternalHttpClient} already has timeouts, a bounded socket\n * pool, and bounded retry-with-jitter — but no load-shedding. Under a sustained\n * downstream brownout every caller keeps paying `timeout × (maxRetries+1)` per\n * request, saturating the socket pool and turning one slow dependency into a\n * fleet-wide latency cascade (the classic retry storm). Worse for fail-CLOSED\n * dependencies (compliance): a brownout there blocks plugin/pipeline creation\n * with full retry latency on every request.\n *\n * This breaker short-circuits that: after `failureThreshold` consecutive\n * failures to a target it OPENS and fast-fails (no network, no retries) for\n * `cooldownMs`, then allows a single half-open probe. A fail-closed caller still\n * fails closed — just immediately, instead of after the full retry budget; a\n * fail-open caller (createSafeClient) gets its `null` immediately.\n *\n * State is keyed by `host:port` in a process-level registry so it is shared even\n * when callers mint a fresh client per request — one bad target trips once, not\n * once-per-client. Disable entirely with `S2S_BREAKER_ENABLED=false`.\n */\n\nimport { envInt, envBool } from '../utils/env.js';\nimport { createLogger } from '../utils/logger.js';\nimport { emitCounter } from '../utils/metric-emitter.js';\n\nconst logger = createLogger('circuit-breaker');\n\nexport type CircuitState = 'closed' | 'open' | 'half-open';\n\nexport interface CircuitBreakerConfig {\n  /** Consecutive failures that trip the breaker from closed → open. */\n  failureThreshold: number;\n  /** How long to stay open before allowing a half-open probe (ms). */\n  cooldownMs: number;\n  /** Master switch — when false, allowRequest() is always true and no state moves. */\n  enabled: boolean;\n}\n\nexport const DEFAULT_BREAKER_CONFIG: CircuitBreakerConfig = {\n  failureThreshold: envInt('S2S_BREAKER_THRESHOLD', 5, { min: 1 }),\n  cooldownMs: envInt('S2S_BREAKER_COOLDOWN_MS', 10000, { min: 1 }),\n  enabled: envBool('S2S_BREAKER_ENABLED', true),\n};\n\n/**\n * A single target's breaker. Not concurrency-locked (JS is single-threaded per\n * event loop); `probeInFlight` gates half-open to one in-flight probe so a burst\n * during cooldown doesn't stampede the recovering downstream.\n */\nexport class CircuitBreaker {\n  private state: CircuitState = 'closed';\n  private consecutiveFailures = 0;\n  private openedAt = 0;\n  private probeInFlight = false;\n\n  constructor(\n    private readonly key: string,\n    private readonly config: CircuitBreakerConfig = DEFAULT_BREAKER_CONFIG,\n  ) {}\n\n  getState(): CircuitState {\n    return this.state;\n  }\n\n  /**\n   * Whether a request may proceed. Transitions open→half-open once the cooldown\n   * elapses and lets exactly ONE probe through. Returns false when open (or a\n   * probe is already in flight) — the caller must fast-fail without any network.\n   */\n  allowRequest(): boolean {\n    if (!this.config.enabled) return true;\n    if (this.state === 'closed') return true;\n    if (this.state === 'open') {\n      if (Date.now() - this.openedAt >= this.config.cooldownMs) {\n        this.state = 'half-open';\n        this.probeInFlight = true;\n        return true;\n      }\n      return false;\n    }\n    // half-open: allow only a single probe at a time.\n    if (this.probeInFlight) return false;\n    this.probeInFlight = true;\n    return true;\n  }\n\n  /** A logical request succeeded (2xx/3xx/4xx that isn't a downstream fault). */\n  recordSuccess(): void {\n    if (!this.config.enabled) return;\n    this.consecutiveFailures = 0;\n    this.probeInFlight = false;\n    if (this.state !== 'closed') {\n      logger.info('circuit closed (downstream recovered)', { target: this.key });\n      this.state = 'closed';\n    }\n  }\n\n  /** A logical request failed (connection error, timeout, or 5xx response). */\n  recordFailure(): void {\n    if (!this.config.enabled) return;\n    this.probeInFlight = false;\n    this.consecutiveFailures++;\n    // A failed half-open probe means the downstream is still bad — re-open.\n    if (this.state === 'half-open') {\n      this.open();\n      return;\n    }\n    if (this.state === 'closed' && this.consecutiveFailures >= this.config.failureThreshold) {\n      this.open();\n    }\n  }\n\n  private open(): void {\n    const wasOpen = this.state === 'open';\n    this.state = 'open';\n    this.openedAt = Date.now();\n    if (!wasOpen) {\n      logger.warn('circuit opened — shedding load to target', {\n        target: this.key,\n        consecutiveFailures: this.consecutiveFailures,\n        cooldownMs: this.config.cooldownMs,\n      });\n      emitCounter('s2s_circuit_opened_total', { target: this.key });\n    }\n  }\n}\n\nconst registry = new Map<string, CircuitBreaker>();\n\n/** Get (or lazily create) the shared breaker for a `host:port` target. */\nexport function getCircuitBreaker(key: string): CircuitBreaker {\n  let breaker = registry.get(key);\n  if (!breaker) {\n    breaker = new CircuitBreaker(key);\n    registry.set(key, breaker);\n  }\n  return breaker;\n}\n\n/** Test helper: clear all breaker state so suites don't leak across each other. */\nexport function resetCircuitBreakers(): void {\n  registry.clear();\n}\n\n/** Thrown by the client when a request is fast-failed because the breaker is open. */\nexport class CircuitOpenError extends Error {\n  readonly code = 'CIRCUIT_OPEN';\n  constructor(target: string) {\n    super(`Circuit open for ${target} — fast-failing to shed load`);\n    this.name = 'CircuitOpenError';\n  }\n}\n"]}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import type { ServiceConfig } from '../types/common.js';
|
|
2
|
+
/**
|
|
3
|
+
* Result of a compliance validation check.
|
|
4
|
+
*/
|
|
5
|
+
export interface ComplianceCheckResult {
|
|
6
|
+
passed: boolean;
|
|
7
|
+
violations: ComplianceViolation[];
|
|
8
|
+
warnings: ComplianceViolation[];
|
|
9
|
+
blocked: boolean;
|
|
10
|
+
rulesEvaluated: number;
|
|
11
|
+
rulesSkipped: number;
|
|
12
|
+
exemptionsApplied: string[];
|
|
13
|
+
}
|
|
14
|
+
export interface ComplianceViolation {
|
|
15
|
+
ruleId: string;
|
|
16
|
+
ruleName: string;
|
|
17
|
+
policyId?: string | null;
|
|
18
|
+
field: string;
|
|
19
|
+
operator: string;
|
|
20
|
+
expectedValue: unknown;
|
|
21
|
+
actualValue: unknown;
|
|
22
|
+
severity: string;
|
|
23
|
+
message: string;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Compliance service client interface.
|
|
27
|
+
* Uses fail-closed design: errors propagate to block the operation.
|
|
28
|
+
*/
|
|
29
|
+
export interface ComplianceClient {
|
|
30
|
+
/** Validate plugin attributes against org rules. Throws on service error (fail-closed). */
|
|
31
|
+
validatePlugin(orgId: string, attributes: Record<string, unknown>, authHeader: string, entityId?: string, entityName?: string, action?: string): Promise<ComplianceCheckResult>;
|
|
32
|
+
/** Validate pipeline attributes against org rules. Throws on service error (fail-closed). */
|
|
33
|
+
validatePipeline(orgId: string, attributes: Record<string, unknown>, authHeader: string, entityId?: string, entityName?: string, action?: string): Promise<ComplianceCheckResult>;
|
|
34
|
+
/** Pre-flight check for plugin (no audit, no notification). */
|
|
35
|
+
dryRunPlugin(orgId: string, attributes: Record<string, unknown>, authHeader: string): Promise<ComplianceCheckResult>;
|
|
36
|
+
/** Pre-flight check for pipeline (no audit, no notification). */
|
|
37
|
+
dryRunPipeline(orgId: string, attributes: Record<string, unknown>, authHeader: string): Promise<ComplianceCheckResult>;
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Create a compliance client.
|
|
41
|
+
*
|
|
42
|
+
* IMPORTANT: This client is fail-closed — if the compliance service is
|
|
43
|
+
* unreachable or returns an error, the error propagates and the calling
|
|
44
|
+
* operation (plugin upload, pipeline create) is rejected.
|
|
45
|
+
*/
|
|
46
|
+
export declare function createComplianceClient(config?: Partial<ServiceConfig>): ComplianceClient;
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
// Copyright 2026 Pipeline Builder Contributors
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0
|
|
3
|
+
import { InternalHttpClient } from './http-client.js';
|
|
4
|
+
import { createLogger } from '../utils/logger.js';
|
|
5
|
+
const logger = createLogger('compliance-client');
|
|
6
|
+
/**
|
|
7
|
+
* When true, compliance checks are bypassed if the service is unavailable
|
|
8
|
+
* (fail-open). Default is fail-closed (errors propagate and block the operation).
|
|
9
|
+
*/
|
|
10
|
+
const COMPLIANCE_BYPASS = process.env.COMPLIANCE_BYPASS === 'true';
|
|
11
|
+
/**
|
|
12
|
+
* Per-attempt timeout for a validation POST (env: `COMPLIANCE_VALIDATE_TIMEOUT_MS`).
|
|
13
|
+
* Deliberately TIGHTER than the 5s client default so the enforced retries (below)
|
|
14
|
+
* fit inside a bounded total budget rather than stacking three 5s stalls onto a
|
|
15
|
+
* single interactive request.
|
|
16
|
+
*/
|
|
17
|
+
const VALIDATE_TIMEOUT_MS = parseInt(process.env.COMPLIANCE_VALIDATE_TIMEOUT_MS ?? '4000', 10);
|
|
18
|
+
/**
|
|
19
|
+
* Return a pass-through result when COMPLIANCE_BYPASS is enabled and the
|
|
20
|
+
* compliance service is unreachable.
|
|
21
|
+
*/
|
|
22
|
+
function bypassResult(context) {
|
|
23
|
+
logger.warn('COMPLIANCE_BYPASS: Service unavailable, allowing request', context);
|
|
24
|
+
return {
|
|
25
|
+
passed: true,
|
|
26
|
+
blocked: false,
|
|
27
|
+
violations: [],
|
|
28
|
+
warnings: [{ ruleId: '', ruleName: '', field: '', operator: '', expectedValue: null, actualValue: null, severity: 'warning', message: 'Compliance check skipped (service unavailable)' }],
|
|
29
|
+
rulesEvaluated: 0,
|
|
30
|
+
rulesSkipped: 0,
|
|
31
|
+
exemptionsApplied: [],
|
|
32
|
+
};
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* Build common request headers for compliance calls.
|
|
36
|
+
*/
|
|
37
|
+
function buildHeaders(orgId, authHeader) {
|
|
38
|
+
const headers = {
|
|
39
|
+
'x-org-id': orgId,
|
|
40
|
+
};
|
|
41
|
+
// NOTE: the old `x-internal-service: true` header was removed — it is trusted
|
|
42
|
+
// by nothing (it was spoofable); compliance routes authenticate the caller via
|
|
43
|
+
// the `Authorization` service JWT (`requireServicePrincipal`).
|
|
44
|
+
if (authHeader)
|
|
45
|
+
headers.Authorization = authHeader;
|
|
46
|
+
return headers;
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Request options for a compliance validation POST.
|
|
50
|
+
*
|
|
51
|
+
* These calls are side-effect-free (they evaluate rules and return a verdict;
|
|
52
|
+
* any audit/notification the compliance service writes is derived, not a mutation
|
|
53
|
+
* the caller depends on being once-only), so they are marked `idempotent: true`.
|
|
54
|
+
* That lets the HTTP client auto-retry a transient 503 / connection reset /
|
|
55
|
+
* timeout instead of surfacing it as a hard failure — which, under the
|
|
56
|
+
* fail-closed default, would wrongly REJECT a legitimate plugin upload / pipeline
|
|
57
|
+
* create just because compliance briefly stalled. Paired with the tighter
|
|
58
|
+
* per-attempt timeout so the retries stay within a bounded total budget.
|
|
59
|
+
*/
|
|
60
|
+
function validateOptions(orgId, authHeader) {
|
|
61
|
+
return {
|
|
62
|
+
headers: buildHeaders(orgId, authHeader),
|
|
63
|
+
idempotent: true,
|
|
64
|
+
timeout: VALIDATE_TIMEOUT_MS,
|
|
65
|
+
};
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* Create a compliance client.
|
|
69
|
+
*
|
|
70
|
+
* IMPORTANT: This client is fail-closed — if the compliance service is
|
|
71
|
+
* unreachable or returns an error, the error propagates and the calling
|
|
72
|
+
* operation (plugin upload, pipeline create) is rejected.
|
|
73
|
+
*/
|
|
74
|
+
export function createComplianceClient(config) {
|
|
75
|
+
const serviceConfig = {
|
|
76
|
+
host: config?.host ?? process.env.COMPLIANCE_SERVICE_HOST ?? 'compliance',
|
|
77
|
+
port: config?.port ?? parseInt(process.env.COMPLIANCE_SERVICE_PORT ?? '3000', 10),
|
|
78
|
+
};
|
|
79
|
+
const client = new InternalHttpClient(serviceConfig);
|
|
80
|
+
/**
|
|
81
|
+
* Validate response shape + status. The HTTP client doesn't throw on non-2xx
|
|
82
|
+
* (it just returns the body), so without this an auth failure / route miss
|
|
83
|
+
* silently produced `response.body.data === undefined` and the caller
|
|
84
|
+
* crashed on `.blocked`. Now non-2xx surfaces as a thrown error that the
|
|
85
|
+
* outer try/catch can turn into either fail-closed (default) or
|
|
86
|
+
* COMPLIANCE_BYPASS (fail-open).
|
|
87
|
+
*/
|
|
88
|
+
function unwrap(response, op) {
|
|
89
|
+
if (response.statusCode < 200 || response.statusCode >= 300) {
|
|
90
|
+
const msg = response.body?.message ?? `HTTP ${response.statusCode}`;
|
|
91
|
+
throw new Error(`compliance ${op} failed: ${msg}`);
|
|
92
|
+
}
|
|
93
|
+
if (!response.body?.data) {
|
|
94
|
+
throw new Error(`compliance ${op} returned no data (status ${response.statusCode})`);
|
|
95
|
+
}
|
|
96
|
+
return response.body.data;
|
|
97
|
+
}
|
|
98
|
+
// Shared body for all four validate/dry-run calls: POST → unwrap, and on a
|
|
99
|
+
// transport/HTTP failure either return a fail-open bypass result (when
|
|
100
|
+
// COMPLIANCE_BYPASS) or rethrow. The four methods differ ONLY in path, request
|
|
101
|
+
// body, op label, and bypass context.
|
|
102
|
+
async function runValidation(orgId, authHeader, path, body, op, bypassCtx) {
|
|
103
|
+
try {
|
|
104
|
+
const response = await client.post(path, body, validateOptions(orgId, authHeader));
|
|
105
|
+
return unwrap(response, op);
|
|
106
|
+
}
|
|
107
|
+
catch (error) {
|
|
108
|
+
if (COMPLIANCE_BYPASS)
|
|
109
|
+
return bypassResult(bypassCtx);
|
|
110
|
+
throw error;
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
return {
|
|
114
|
+
validatePlugin(orgId, attributes, authHeader, entityId, entityName, action) {
|
|
115
|
+
return runValidation(orgId, authHeader, '/compliance/validate/plugin', { attributes, entityId, entityName, action: action ?? 'upload' }, 'validatePlugin', { orgId, entityType: 'plugin', entityId, entityName });
|
|
116
|
+
},
|
|
117
|
+
validatePipeline(orgId, attributes, authHeader, entityId, entityName, action) {
|
|
118
|
+
return runValidation(orgId, authHeader, '/compliance/validate/pipeline', { attributes, entityId, entityName, action: action ?? 'create' }, 'validatePipeline', { orgId, entityType: 'pipeline', entityId, entityName });
|
|
119
|
+
},
|
|
120
|
+
dryRunPlugin(orgId, attributes, authHeader) {
|
|
121
|
+
return runValidation(orgId, authHeader, '/compliance/validate/plugin/dry-run', { attributes }, 'dryRunPlugin', { orgId, entityType: 'plugin', dryRun: true });
|
|
122
|
+
},
|
|
123
|
+
dryRunPipeline(orgId, attributes, authHeader) {
|
|
124
|
+
return runValidation(orgId, authHeader, '/compliance/validate/pipeline/dry-run', { attributes }, 'dryRunPipeline', { orgId, entityType: 'pipeline', dryRun: true });
|
|
125
|
+
},
|
|
126
|
+
};
|
|
127
|
+
}
|
|
128
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"compliance-client.js","sourceRoot":"","sources":["../../src/services/compliance-client.ts"],"names":[],"mappings":"AAAA,+CAA+C;AAC/C,sCAAsC;AAEtC,OAAO,EAAE,kBAAkB,EAAuB,MAAM,kBAAkB,CAAC;AAE3E,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,MAAM,MAAM,GAAG,YAAY,CAAC,mBAAmB,CAAC,CAAC;AAEjD;;;GAGG;AACH,MAAM,iBAAiB,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,KAAK,MAAM,CAAC;AAEnE;;;;;GAKG;AACH,MAAM,mBAAmB,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,8BAA8B,IAAI,MAAM,EAAE,EAAE,CAAC,CAAC;AAmE/F;;;GAGG;AACH,SAAS,YAAY,CAAC,OAAgC;IACpD,MAAM,CAAC,IAAI,CAAC,0DAA0D,EAAE,OAAO,CAAC,CAAC;IACjF,OAAO;QACL,MAAM,EAAE,IAAI;QACZ,OAAO,EAAE,KAAK;QACd,UAAU,EAAE,EAAE;QACd,QAAQ,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,gDAAgD,EAAE,CAAC;QACzL,cAAc,EAAE,CAAC;QACjB,YAAY,EAAE,CAAC;QACf,iBAAiB,EAAE,EAAE;KACtB,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAS,YAAY,CAAC,KAAa,EAAE,UAAkB;IACrD,MAAM,OAAO,GAA2B;QACtC,UAAU,EAAE,KAAK;KAClB,CAAC;IACF,8EAA8E;IAC9E,+EAA+E;IAC/E,+DAA+D;IAC/D,IAAI,UAAU;QAAE,OAAO,CAAC,aAAa,GAAG,UAAU,CAAC;IACnD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,eAAe,CAAC,KAAa,EAAE,UAAkB;IACxD,OAAO;QACL,OAAO,EAAE,YAAY,CAAC,KAAK,EAAE,UAAU,CAAC;QACxC,UAAU,EAAE,IAAI;QAChB,OAAO,EAAE,mBAAmB;KAC7B,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,sBAAsB,CAAC,MAA+B;IACpE,MAAM,aAAa,GAAkB;QACnC,IAAI,EAAE,MAAM,EAAE,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC,uBAAuB,IAAI,YAAY;QACzE,IAAI,EAAE,MAAM,EAAE,IAAI,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,IAAI,MAAM,EAAE,EAAE,CAAC;KAClF,CAAC;IAEF,MAAM,MAAM,GAAG,IAAI,kBAAkB,CAAC,aAAa,CAAC,CAAC;IAErD;;;;;;;OAOG;IACH,SAAS,MAAM,CACb,QAA6G,EAC7G,EAAU;QAEV,IAAI,QAAQ,CAAC,UAAU,GAAG,GAAG,IAAI,QAAQ,CAAC,UAAU,IAAI,GAAG,EAAE,CAAC;YAC5D,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,EAAE,OAAO,IAAI,QAAQ,QAAQ,CAAC,UAAU,EAAE,CAAC;YACpE,MAAM,IAAI,KAAK,CAAC,cAAc,EAAE,YAAY,GAAG,EAAE,CAAC,CAAC;QACrD,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,cAAc,EAAE,6BAA6B,QAAQ,CAAC,UAAU,GAAG,CAAC,CAAC;QACvF,CAAC;QACD,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;IAC5B,CAAC;IAED,2EAA2E;IAC3E,uEAAuE;IACvE,+EAA+E;IAC/E,sCAAsC;IACtC,KAAK,UAAU,aAAa,CAC1B,KAAa,EACb,UAAkB,EAClB,IAAY,EACZ,IAA6B,EAC7B,EAAU,EACV,SAAkC;QAElC,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,IAAI,CAChC,IAAI,EAAE,IAAI,EAAE,eAAe,CAAC,KAAK,EAAE,UAAU,CAAC,CAC/C,CAAC;YACF,OAAO,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC9B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,iBAAiB;gBAAE,OAAO,YAAY,CAAC,SAAS,CAAC,CAAC;YACtD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,OAAO;QACL,cAAc,CAAC,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM;YACxE,OAAO,aAAa,CAAC,KAAK,EAAE,UAAU,EAAE,6BAA6B,EACnE,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,IAAI,QAAQ,EAAE,EAAE,gBAAgB,EAClF,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;QAC3D,CAAC;QAED,gBAAgB,CAAC,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM;YAC1E,OAAO,aAAa,CAAC,KAAK,EAAE,UAAU,EAAE,+BAA+B,EACrE,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,IAAI,QAAQ,EAAE,EAAE,kBAAkB,EACpF,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;QAC7D,CAAC;QAED,YAAY,CAAC,KAAK,EAAE,UAAU,EAAE,UAAU;YACxC,OAAO,aAAa,CAAC,KAAK,EAAE,UAAU,EAAE,qCAAqC,EAC3E,EAAE,UAAU,EAAE,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QACnF,CAAC;QAED,cAAc,CAAC,KAAK,EAAE,UAAU,EAAE,UAAU;YAC1C,OAAO,aAAa,CAAC,KAAK,EAAE,UAAU,EAAE,uCAAuC,EAC7E,EAAE,UAAU,EAAE,EAAE,gBAAgB,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QACvF,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["// Copyright 2026 Pipeline Builder Contributors\n// SPDX-License-Identifier: Apache-2.0\n\nimport { InternalHttpClient, type RequestOptions } from './http-client.js';\nimport type { ServiceConfig } from '../types/common.js';\nimport { createLogger } from '../utils/logger.js';\n\nconst logger = createLogger('compliance-client');\n\n/**\n * When true, compliance checks are bypassed if the service is unavailable\n * (fail-open). Default is fail-closed (errors propagate and block the operation).\n */\nconst COMPLIANCE_BYPASS = process.env.COMPLIANCE_BYPASS === 'true';\n\n/**\n * Per-attempt timeout for a validation POST (env: `COMPLIANCE_VALIDATE_TIMEOUT_MS`).\n * Deliberately TIGHTER than the 5s client default so the enforced retries (below)\n * fit inside a bounded total budget rather than stacking three 5s stalls onto a\n * single interactive request.\n */\nconst VALIDATE_TIMEOUT_MS = parseInt(process.env.COMPLIANCE_VALIDATE_TIMEOUT_MS ?? '4000', 10);\n\n/**\n * Result of a compliance validation check.\n */\nexport interface ComplianceCheckResult {\n  passed: boolean;\n  violations: ComplianceViolation[];\n  warnings: ComplianceViolation[];\n  blocked: boolean;\n  rulesEvaluated: number;\n  rulesSkipped: number;\n  exemptionsApplied: string[];\n}\n\nexport interface ComplianceViolation {\n  ruleId: string;\n  ruleName: string;\n  policyId?: string | null;\n  field: string;\n  operator: string;\n  expectedValue: unknown;\n  actualValue: unknown;\n  severity: string;\n  message: string;\n}\n\n/**\n * Compliance service client interface.\n * Uses fail-closed design: errors propagate to block the operation.\n */\nexport interface ComplianceClient {\n  /** Validate plugin attributes against org rules. Throws on service error (fail-closed). */\n  validatePlugin(\n    orgId: string,\n    attributes: Record<string, unknown>,\n    authHeader: string,\n    entityId?: string,\n    entityName?: string,\n    action?: string,\n  ): Promise<ComplianceCheckResult>;\n\n  /** Validate pipeline attributes against org rules. Throws on service error (fail-closed). */\n  validatePipeline(\n    orgId: string,\n    attributes: Record<string, unknown>,\n    authHeader: string,\n    entityId?: string,\n    entityName?: string,\n    action?: string,\n  ): Promise<ComplianceCheckResult>;\n\n  /** Pre-flight check for plugin (no audit, no notification). */\n  dryRunPlugin(\n    orgId: string,\n    attributes: Record<string, unknown>,\n    authHeader: string,\n  ): Promise<ComplianceCheckResult>;\n\n  /** Pre-flight check for pipeline (no audit, no notification). */\n  dryRunPipeline(\n    orgId: string,\n    attributes: Record<string, unknown>,\n    authHeader: string,\n  ): Promise<ComplianceCheckResult>;\n}\n\n/**\n * Return a pass-through result when COMPLIANCE_BYPASS is enabled and the\n * compliance service is unreachable.\n */\nfunction bypassResult(context: Record<string, unknown>): ComplianceCheckResult {\n  logger.warn('COMPLIANCE_BYPASS: Service unavailable, allowing request', context);\n  return {\n    passed: true,\n    blocked: false,\n    violations: [],\n    warnings: [{ ruleId: '', ruleName: '', field: '', operator: '', expectedValue: null, actualValue: null, severity: 'warning', message: 'Compliance check skipped (service unavailable)' }],\n    rulesEvaluated: 0,\n    rulesSkipped: 0,\n    exemptionsApplied: [],\n  };\n}\n\n/**\n * Build common request headers for compliance calls.\n */\nfunction buildHeaders(orgId: string, authHeader: string): Record<string, string> {\n  const headers: Record<string, string> = {\n    'x-org-id': orgId,\n  };\n  // NOTE: the old `x-internal-service: true` header was removed — it is trusted\n  // by nothing (it was spoofable); compliance routes authenticate the caller via\n  // the `Authorization` service JWT (`requireServicePrincipal`).\n  if (authHeader) headers.Authorization = authHeader;\n  return headers;\n}\n\n/**\n * Request options for a compliance validation POST.\n *\n * These calls are side-effect-free (they evaluate rules and return a verdict;\n * any audit/notification the compliance service writes is derived, not a mutation\n * the caller depends on being once-only), so they are marked `idempotent: true`.\n * That lets the HTTP client auto-retry a transient 503 / connection reset /\n * timeout instead of surfacing it as a hard failure — which, under the\n * fail-closed default, would wrongly REJECT a legitimate plugin upload / pipeline\n * create just because compliance briefly stalled. Paired with the tighter\n * per-attempt timeout so the retries stay within a bounded total budget.\n */\nfunction validateOptions(orgId: string, authHeader: string): RequestOptions {\n  return {\n    headers: buildHeaders(orgId, authHeader),\n    idempotent: true,\n    timeout: VALIDATE_TIMEOUT_MS,\n  };\n}\n\n/**\n * Create a compliance client.\n *\n * IMPORTANT: This client is fail-closed — if the compliance service is\n * unreachable or returns an error, the error propagates and the calling\n * operation (plugin upload, pipeline create) is rejected.\n */\nexport function createComplianceClient(config?: Partial<ServiceConfig>): ComplianceClient {\n  const serviceConfig: ServiceConfig = {\n    host: config?.host ?? process.env.COMPLIANCE_SERVICE_HOST ?? 'compliance',\n    port: config?.port ?? parseInt(process.env.COMPLIANCE_SERVICE_PORT ?? '3000', 10),\n  };\n\n  const client = new InternalHttpClient(serviceConfig);\n\n  /**\n   * Validate response shape + status. The HTTP client doesn't throw on non-2xx\n   * (it just returns the body), so without this an auth failure / route miss\n   * silently produced `response.body.data === undefined` and the caller\n   * crashed on `.blocked`. Now non-2xx surfaces as a thrown error that the\n   * outer try/catch can turn into either fail-closed (default) or\n   * COMPLIANCE_BYPASS (fail-open).\n   */\n  function unwrap(\n    response: { statusCode: number; body: { success?: boolean; data?: ComplianceCheckResult; message?: string } },\n    op: string,\n  ): ComplianceCheckResult {\n    if (response.statusCode < 200 || response.statusCode >= 300) {\n      const msg = response.body?.message ?? `HTTP ${response.statusCode}`;\n      throw new Error(`compliance ${op} failed: ${msg}`);\n    }\n    if (!response.body?.data) {\n      throw new Error(`compliance ${op} returned no data (status ${response.statusCode})`);\n    }\n    return response.body.data;\n  }\n\n  // Shared body for all four validate/dry-run calls: POST → unwrap, and on a\n  // transport/HTTP failure either return a fail-open bypass result (when\n  // COMPLIANCE_BYPASS) or rethrow. The four methods differ ONLY in path, request\n  // body, op label, and bypass context.\n  async function runValidation(\n    orgId: string,\n    authHeader: string,\n    path: string,\n    body: Record<string, unknown>,\n    op: string,\n    bypassCtx: Record<string, unknown>,\n  ): Promise<ComplianceCheckResult> {\n    try {\n      const response = await client.post<{ success: boolean; data: ComplianceCheckResult; message?: string }>(\n        path, body, validateOptions(orgId, authHeader),\n      );\n      return unwrap(response, op);\n    } catch (error) {\n      if (COMPLIANCE_BYPASS) return bypassResult(bypassCtx);\n      throw error;\n    }\n  }\n\n  return {\n    validatePlugin(orgId, attributes, authHeader, entityId, entityName, action) {\n      return runValidation(orgId, authHeader, '/compliance/validate/plugin',\n        { attributes, entityId, entityName, action: action ?? 'upload' }, 'validatePlugin',\n        { orgId, entityType: 'plugin', entityId, entityName });\n    },\n\n    validatePipeline(orgId, attributes, authHeader, entityId, entityName, action) {\n      return runValidation(orgId, authHeader, '/compliance/validate/pipeline',\n        { attributes, entityId, entityName, action: action ?? 'create' }, 'validatePipeline',\n        { orgId, entityType: 'pipeline', entityId, entityName });\n    },\n\n    dryRunPlugin(orgId, attributes, authHeader) {\n      return runValidation(orgId, authHeader, '/compliance/validate/plugin/dry-run',\n        { attributes }, 'dryRunPlugin', { orgId, entityType: 'plugin', dryRun: true });\n    },\n\n    dryRunPipeline(orgId, attributes, authHeader) {\n      return runValidation(orgId, authHeader, '/compliance/validate/pipeline/dry-run',\n        { attributes }, 'dryRunPipeline', { orgId, entityType: 'pipeline', dryRun: true });\n    },\n  };\n}\n"]}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { type ServiceConfig } from '../types/common.js';
|
|
2
|
+
/**
|
|
3
|
+
* Registers an entity event subscriber that forwards events to the compliance service.
|
|
4
|
+
*
|
|
5
|
+
* Call this at service startup (in index.ts) to enable automatic compliance
|
|
6
|
+
* notification on entity mutations. Events are fire-and-forget — failures
|
|
7
|
+
* are logged but never block the original request.
|
|
8
|
+
*
|
|
9
|
+
* @param config - Optional service config override (defaults to COMPLIANCE_SERVICE_HOST/PORT env vars)
|
|
10
|
+
* @param serviceName - Service identifier baked into the signed JWT's `sub`
|
|
11
|
+
* (e.g. 'pipeline', 'plugin'). The compliance route requires a service
|
|
12
|
+
* principal — a spoofable `x-internal-service: true` header is no longer
|
|
13
|
+
* accepted. Defaults to a generic 'entity-events' when unspecified, but
|
|
14
|
+
* callers should pass their service name for accurate audit trails.
|
|
15
|
+
*/
|
|
16
|
+
export declare function registerComplianceEventSubscriber(config?: Partial<ServiceConfig>, serviceName?: string): void;
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
// Copyright 2026 Pipeline Builder Contributors
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0
|
|
3
|
+
import { entityEvents } from './entity-events.js';
|
|
4
|
+
import { InternalHttpClient } from './http-client.js';
|
|
5
|
+
import { getServiceAuthHeader } from '../middleware/auth.js';
|
|
6
|
+
import {} from '../types/common.js';
|
|
7
|
+
import { createLogger } from '../utils/logger.js';
|
|
8
|
+
import { emitCounter } from '../utils/metric-emitter.js';
|
|
9
|
+
const logger = createLogger('compliance-events');
|
|
10
|
+
/**
|
|
11
|
+
* Registers an entity event subscriber that forwards events to the compliance service.
|
|
12
|
+
*
|
|
13
|
+
* Call this at service startup (in index.ts) to enable automatic compliance
|
|
14
|
+
* notification on entity mutations. Events are fire-and-forget — failures
|
|
15
|
+
* are logged but never block the original request.
|
|
16
|
+
*
|
|
17
|
+
* @param config - Optional service config override (defaults to COMPLIANCE_SERVICE_HOST/PORT env vars)
|
|
18
|
+
* @param serviceName - Service identifier baked into the signed JWT's `sub`
|
|
19
|
+
* (e.g. 'pipeline', 'plugin'). The compliance route requires a service
|
|
20
|
+
* principal — a spoofable `x-internal-service: true` header is no longer
|
|
21
|
+
* accepted. Defaults to a generic 'entity-events' when unspecified, but
|
|
22
|
+
* callers should pass their service name for accurate audit trails.
|
|
23
|
+
*/
|
|
24
|
+
export function registerComplianceEventSubscriber(config, serviceName = 'entity-events') {
|
|
25
|
+
const serviceConfig = {
|
|
26
|
+
host: config?.host ?? process.env.COMPLIANCE_SERVICE_HOST ?? 'compliance',
|
|
27
|
+
port: config?.port ?? parseInt(process.env.COMPLIANCE_SERVICE_PORT ?? '3000', 10),
|
|
28
|
+
};
|
|
29
|
+
const client = new InternalHttpClient(serviceConfig);
|
|
30
|
+
const subscriber = {
|
|
31
|
+
async onEntityEvent(event) {
|
|
32
|
+
try {
|
|
33
|
+
// Mint a per-event service JWT scoped to the event's org so the
|
|
34
|
+
// compliance route's `runWithTenantContext` sees the right tenant
|
|
35
|
+
// GUC. The compliance side enforces `requireAuth` +
|
|
36
|
+
// `requireServicePrincipal` — the previous `x-internal-service`
|
|
37
|
+
// header is no longer sufficient (and was spoofable).
|
|
38
|
+
//
|
|
39
|
+
// This HTTP notify is the SINGLE delivery channel for post-mutation
|
|
40
|
+
// re-validation (primary enforcement is the fail-CLOSED live
|
|
41
|
+
// validate path). A stable per-event `Idempotency-Key` makes the POST
|
|
42
|
+
// retry-safe in the http-client, so a transient 5xx/timeout is retried
|
|
43
|
+
// rather than dropped on the first attempt; compliance re-evaluation is
|
|
44
|
+
// naturally idempotent, so a duplicate delivery is harmless.
|
|
45
|
+
await client.post('/compliance/events/entity', event, {
|
|
46
|
+
headers: {
|
|
47
|
+
'Authorization': getServiceAuthHeader({ serviceName, orgId: event.orgId, role: 'member' }),
|
|
48
|
+
'Idempotency-Key': `${event.target}:${event.entityId}:${event.eventType}:${event.timestamp.toISOString()}`,
|
|
49
|
+
},
|
|
50
|
+
});
|
|
51
|
+
}
|
|
52
|
+
catch (err) {
|
|
53
|
+
// Fire-and-forget: log + a drop metric so sustained loss is alertable
|
|
54
|
+
// (operators can't act on a warn line alone), then swallow — compliance
|
|
55
|
+
// notification is non-fatal to the originating mutation.
|
|
56
|
+
emitCounter('compliance_event_drop_total', { service: serviceName, target: event.target });
|
|
57
|
+
logger.warn('Failed to notify compliance service of entity event', {
|
|
58
|
+
target: event.target,
|
|
59
|
+
eventType: event.eventType,
|
|
60
|
+
entityId: event.entityId,
|
|
61
|
+
error: err instanceof Error ? err.message : String(err),
|
|
62
|
+
});
|
|
63
|
+
}
|
|
64
|
+
},
|
|
65
|
+
};
|
|
66
|
+
entityEvents.subscribe(subscriber);
|
|
67
|
+
logger.info('Compliance event subscriber registered', {
|
|
68
|
+
host: serviceConfig.host,
|
|
69
|
+
port: serviceConfig.port,
|
|
70
|
+
});
|
|
71
|
+
}
|
|
72
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tcGxpYW5jZS1ldmVudC1zdWJzY3JpYmVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3NlcnZpY2VzL2NvbXBsaWFuY2UtZXZlbnQtc3Vic2NyaWJlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSwrQ0FBK0M7QUFDL0Msc0NBQXNDO0FBRXRDLE9BQU8sRUFBRSxZQUFZLEVBQWdELE1BQU0sb0JBQW9CLENBQUM7QUFDaEcsT0FBTyxFQUFFLGtCQUFrQixFQUFFLE1BQU0sa0JBQWtCLENBQUM7QUFDdEQsT0FBTyxFQUFFLG9CQUFvQixFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFDN0QsT0FBTyxFQUFzQixNQUFNLG9CQUFvQixDQUFDO0FBQ3hELE9BQU8sRUFBRSxZQUFZLEVBQUUsTUFBTSxvQkFBb0IsQ0FBQztBQUNsRCxPQUFPLEVBQUUsV0FBVyxFQUFFLE1BQU0sNEJBQTRCLENBQUM7QUFFekQsTUFBTSxNQUFNLEdBQUcsWUFBWSxDQUFDLG1CQUFtQixDQUFDLENBQUM7QUFFakQ7Ozs7Ozs7Ozs7Ozs7R0FhRztBQUNILE1BQU0sVUFBVSxpQ0FBaUMsQ0FDL0MsTUFBK0IsRUFDL0IsV0FBVyxHQUFXLGVBQWU7SUFFckMsTUFBTSxhQUFhLEdBQWtCO1FBQ25DLElBQUksRUFBRSxNQUFNLEVBQUUsSUFBSSxJQUFJLE9BQU8sQ0FBQyxHQUFHLENBQUMsdUJBQXVCLElBQUksWUFBWTtRQUN6RSxJQUFJLEVBQUUsTUFBTSxFQUFFLElBQUksSUFBSSxRQUFRLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyx1QkFBdUIsSUFBSSxNQUFNLEVBQUUsRUFBRSxDQUFDO0tBQ2xGLENBQUM7SUFFRixNQUFNLE1BQU0sR0FBRyxJQUFJLGtCQUFrQixDQUFDLGFBQWEsQ0FBQyxDQUFDO0lBRXJELE1BQU0sVUFBVSxHQUEwQjtRQUN4QyxLQUFLLENBQUMsYUFBYSxDQUFDLEtBQWtCO1lBQ3BDLElBQUksQ0FBQztnQkFDSCxnRUFBZ0U7Z0JBQ2hFLGtFQUFrRTtnQkFDbEUsb0RBQW9EO2dCQUNwRCxnRUFBZ0U7Z0JBQ2hFLHNEQUFzRDtnQkFDdEQsRUFBRTtnQkFDRixvRUFBb0U7Z0JBQ3BFLDZEQUE2RDtnQkFDN0Qsc0VBQXNFO2dCQUN0RSx1RUFBdUU7Z0JBQ3ZFLHdFQUF3RTtnQkFDeEUsNkRBQTZEO2dCQUM3RCxNQUFNLE1BQU0sQ0FBQyxJQUFJLENBQUMsMkJBQTJCLEVBQUUsS0FBSyxFQUFFO29CQUNwRCxPQUFPLEVBQUU7d0JBQ1AsZUFBZSxFQUFFLG9CQUFvQixDQUFDLEVBQUUsV0FBVyxFQUFFLEtBQUssRUFBRSxLQUFLLENBQUMsS0FBSyxFQUFFLElBQUksRUFBRSxRQUFRLEVBQUUsQ0FBQzt3QkFDMUYsaUJBQWlCLEVBQUUsR0FBRyxLQUFLLENBQUMsTUFBTSxJQUFJLEtBQUssQ0FBQyxRQUFRLElBQUksS0FBSyxDQUFDLFNBQVMsSUFBSSxLQUFLLENBQUMsU0FBUyxDQUFDLFdBQVcsRUFBRSxFQUFFO3FCQUMzRztpQkFDRixDQUFDLENBQUM7WUFDTCxDQUFDO1lBQUMsT0FBTyxHQUFHLEVBQUUsQ0FBQztnQkFDYixzRUFBc0U7Z0JBQ3RFLHdFQUF3RTtnQkFDeEUseURBQXlEO2dCQUN6RCxXQUFXLENBQUMsNkJBQTZCLEVBQUUsRUFBRSxPQUFPLEVBQUUsV0FBVyxFQUFFLE1BQU0sRUFBRSxLQUFLLENBQUMsTUFBTSxFQUFFLENBQUMsQ0FBQztnQkFDM0YsTUFBTSxDQUFDLElBQUksQ0FBQyxxREFBcUQsRUFBRTtvQkFDakUsTUFBTSxFQUFFLEtBQUssQ0FBQyxNQUFNO29CQUNwQixTQUFTLEVBQUUsS0FBSyxDQUFDLFNBQVM7b0JBQzFCLFFBQVEsRUFBRSxLQUFLLENBQUMsUUFBUTtvQkFDeEIsS0FBSyxFQUFFLEdBQUcsWUFBWSxLQUFLLENBQUMsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUM7aUJBQ3hELENBQUMsQ0FBQztZQUNMLENBQUM7UUFDSCxDQUFDO0tBQ0YsQ0FBQztJQUVGLFlBQVksQ0FBQyxTQUFTLENBQUMsVUFBVSxDQUFDLENBQUM7SUFDbkMsTUFBTSxDQUFDLElBQUksQ0FBQyx3Q0FBd0MsRUFBRTtRQUNwRCxJQUFJLEVBQUUsYUFBYSxDQUFDLElBQUk7UUFDeEIsSUFBSSxFQUFFLGFBQWEsQ0FBQyxJQUFJO0tBQ3pCLENBQUMsQ0FBQztBQUNMLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvLyBDb3B5cmlnaHQgMjAyNiBQaXBlbGluZSBCdWlsZGVyIENvbnRyaWJ1dG9yc1xuLy8gU1BEWC1MaWNlbnNlLUlkZW50aWZpZXI6IEFwYWNoZS0yLjBcblxuaW1wb3J0IHsgZW50aXR5RXZlbnRzLCB0eXBlIEVudGl0eUV2ZW50LCB0eXBlIEVudGl0eUV2ZW50U3Vic2NyaWJlciB9IGZyb20gJy4vZW50aXR5LWV2ZW50cy5qcyc7XG5pbXBvcnQgeyBJbnRlcm5hbEh0dHBDbGllbnQgfSBmcm9tICcuL2h0dHAtY2xpZW50LmpzJztcbmltcG9ydCB7IGdldFNlcnZpY2VBdXRoSGVhZGVyIH0gZnJvbSAnLi4vbWlkZGxld2FyZS9hdXRoLmpzJztcbmltcG9ydCB7IHR5cGUgU2VydmljZUNvbmZpZyB9IGZyb20gJy4uL3R5cGVzL2NvbW1vbi5qcyc7XG5pbXBvcnQgeyBjcmVhdGVMb2dnZXIgfSBmcm9tICcuLi91dGlscy9sb2dnZXIuanMnO1xuaW1wb3J0IHsgZW1pdENvdW50ZXIgfSBmcm9tICcuLi91dGlscy9tZXRyaWMtZW1pdHRlci5qcyc7XG5cbmNvbnN0IGxvZ2dlciA9IGNyZWF0ZUxvZ2dlcignY29tcGxpYW5jZS1ldmVudHMnKTtcblxuLyoqXG4gKiBSZWdpc3RlcnMgYW4gZW50aXR5IGV2ZW50IHN1YnNjcmliZXIgdGhhdCBmb3J3YXJkcyBldmVudHMgdG8gdGhlIGNvbXBsaWFuY2Ugc2VydmljZS5cbiAqXG4gKiBDYWxsIHRoaXMgYXQgc2VydmljZSBzdGFydHVwIChpbiBpbmRleC50cykgdG8gZW5hYmxlIGF1dG9tYXRpYyBjb21wbGlhbmNlXG4gKiBub3RpZmljYXRpb24gb24gZW50aXR5IG11dGF0aW9ucy4gRXZlbnRzIGFyZSBmaXJlLWFuZC1mb3JnZXQg4oCUIGZhaWx1cmVzXG4gKiBhcmUgbG9nZ2VkIGJ1dCBuZXZlciBibG9jayB0aGUgb3JpZ2luYWwgcmVxdWVzdC5cbiAqXG4gKiBAcGFyYW0gY29uZmlnIC0gT3B0aW9uYWwgc2VydmljZSBjb25maWcgb3ZlcnJpZGUgKGRlZmF1bHRzIHRvIENPTVBMSUFOQ0VfU0VSVklDRV9IT1NUL1BPUlQgZW52IHZhcnMpXG4gKiBAcGFyYW0gc2VydmljZU5hbWUgLSBTZXJ2aWNlIGlkZW50aWZpZXIgYmFrZWQgaW50byB0aGUgc2lnbmVkIEpXVCdzIGBzdWJgXG4gKiAgIChlLmcuICdwaXBlbGluZScsICdwbHVnaW4nKS4gVGhlIGNvbXBsaWFuY2Ugcm91dGUgcmVxdWlyZXMgYSBzZXJ2aWNlXG4gKiAgIHByaW5jaXBhbCDigJQgYSBzcG9vZmFibGUgYHgtaW50ZXJuYWwtc2VydmljZTogdHJ1ZWAgaGVhZGVyIGlzIG5vIGxvbmdlclxuICogICBhY2NlcHRlZC4gRGVmYXVsdHMgdG8gYSBnZW5lcmljICdlbnRpdHktZXZlbnRzJyB3aGVuIHVuc3BlY2lmaWVkLCBidXRcbiAqICAgY2FsbGVycyBzaG91bGQgcGFzcyB0aGVpciBzZXJ2aWNlIG5hbWUgZm9yIGFjY3VyYXRlIGF1ZGl0IHRyYWlscy5cbiAqL1xuZXhwb3J0IGZ1bmN0aW9uIHJlZ2lzdGVyQ29tcGxpYW5jZUV2ZW50U3Vic2NyaWJlcihcbiAgY29uZmlnPzogUGFydGlhbDxTZXJ2aWNlQ29uZmlnPixcbiAgc2VydmljZU5hbWU6IHN0cmluZyA9ICdlbnRpdHktZXZlbnRzJyxcbik6IHZvaWQge1xuICBjb25zdCBzZXJ2aWNlQ29uZmlnOiBTZXJ2aWNlQ29uZmlnID0ge1xuICAgIGhvc3Q6IGNvbmZpZz8uaG9zdCA/PyBwcm9jZXNzLmVudi5DT01QTElBTkNFX1NFUlZJQ0VfSE9TVCA/PyAnY29tcGxpYW5jZScsXG4gICAgcG9ydDogY29uZmlnPy5wb3J0ID8/IHBhcnNlSW50KHByb2Nlc3MuZW52LkNPTVBMSUFOQ0VfU0VSVklDRV9QT1JUID8/ICczMDAwJywgMTApLFxuICB9O1xuXG4gIGNvbnN0IGNsaWVudCA9IG5ldyBJbnRlcm5hbEh0dHBDbGllbnQoc2VydmljZUNvbmZpZyk7XG5cbiAgY29uc3Qgc3Vic2NyaWJlcjogRW50aXR5RXZlbnRTdWJzY3JpYmVyID0ge1xuICAgIGFzeW5jIG9uRW50aXR5RXZlbnQoZXZlbnQ6IEVudGl0eUV2ZW50KTogUHJvbWlzZTx2b2lkPiB7XG4gICAgICB0cnkge1xuICAgICAgICAvLyBNaW50IGEgcGVyLWV2ZW50IHNlcnZpY2UgSldUIHNjb3BlZCB0byB0aGUgZXZlbnQncyBvcmcgc28gdGhlXG4gICAgICAgIC8vIGNvbXBsaWFuY2Ugcm91dGUncyBgcnVuV2l0aFRlbmFudENvbnRleHRgIHNlZXMgdGhlIHJpZ2h0IHRlbmFudFxuICAgICAgICAvLyBHVUMuIFRoZSBjb21wbGlhbmNlIHNpZGUgZW5mb3JjZXMgYHJlcXVpcmVBdXRoYCArXG4gICAgICAgIC8vIGByZXF1aXJlU2VydmljZVByaW5jaXBhbGAg4oCUIHRoZSBwcmV2aW91cyBgeC1pbnRlcm5hbC1zZXJ2aWNlYFxuICAgICAgICAvLyBoZWFkZXIgaXMgbm8gbG9uZ2VyIHN1ZmZpY2llbnQgKGFuZCB3YXMgc3Bvb2ZhYmxlKS5cbiAgICAgICAgLy9cbiAgICAgICAgLy8gVGhpcyBIVFRQIG5vdGlmeSBpcyB0aGUgU0lOR0xFIGRlbGl2ZXJ5IGNoYW5uZWwgZm9yIHBvc3QtbXV0YXRpb25cbiAgICAgICAgLy8gcmUtdmFsaWRhdGlvbiAocHJpbWFyeSBlbmZvcmNlbWVudCBpcyB0aGUgZmFpbC1DTE9TRUQgbGl2ZVxuICAgICAgICAvLyB2YWxpZGF0ZSBwYXRoKS4gQSBzdGFibGUgcGVyLWV2ZW50IGBJZGVtcG90ZW5jeS1LZXlgIG1ha2VzIHRoZSBQT1NUXG4gICAgICAgIC8vIHJldHJ5LXNhZmUgaW4gdGhlIGh0dHAtY2xpZW50LCBzbyBhIHRyYW5zaWVudCA1eHgvdGltZW91dCBpcyByZXRyaWVkXG4gICAgICAgIC8vIHJhdGhlciB0aGFuIGRyb3BwZWQgb24gdGhlIGZpcnN0IGF0dGVtcHQ7IGNvbXBsaWFuY2UgcmUtZXZhbHVhdGlvbiBpc1xuICAgICAgICAvLyBuYXR1cmFsbHkgaWRlbXBvdGVudCwgc28gYSBkdXBsaWNhdGUgZGVsaXZlcnkgaXMgaGFybWxlc3MuXG4gICAgICAgIGF3YWl0IGNsaWVudC5wb3N0KCcvY29tcGxpYW5jZS9ldmVudHMvZW50aXR5JywgZXZlbnQsIHtcbiAgICAgICAgICBoZWFkZXJzOiB7XG4gICAgICAgICAgICAnQXV0aG9yaXphdGlvbic6IGdldFNlcnZpY2VBdXRoSGVhZGVyKHsgc2VydmljZU5hbWUsIG9yZ0lkOiBldmVudC5vcmdJZCwgcm9sZTogJ21lbWJlcicgfSksXG4gICAgICAgICAgICAnSWRlbXBvdGVuY3ktS2V5JzogYCR7ZXZlbnQudGFyZ2V0fToke2V2ZW50LmVudGl0eUlkfToke2V2ZW50LmV2ZW50VHlwZX06JHtldmVudC50aW1lc3RhbXAudG9JU09TdHJpbmcoKX1gLFxuICAgICAgICAgIH0sXG4gICAgICAgIH0pO1xuICAgICAgfSBjYXRjaCAoZXJyKSB7XG4gICAgICAgIC8vIEZpcmUtYW5kLWZvcmdldDogbG9nICsgYSBkcm9wIG1ldHJpYyBzbyBzdXN0YWluZWQgbG9zcyBpcyBhbGVydGFibGVcbiAgICAgICAgLy8gKG9wZXJhdG9ycyBjYW4ndCBhY3Qgb24gYSB3YXJuIGxpbmUgYWxvbmUpLCB0aGVuIHN3YWxsb3cg4oCUIGNvbXBsaWFuY2VcbiAgICAgICAgLy8gbm90aWZpY2F0aW9uIGlzIG5vbi1mYXRhbCB0byB0aGUgb3JpZ2luYXRpbmcgbXV0YXRpb24uXG4gICAgICAgIGVtaXRDb3VudGVyKCdjb21wbGlhbmNlX2V2ZW50X2Ryb3BfdG90YWwnLCB7IHNlcnZpY2U6IHNlcnZpY2VOYW1lLCB0YXJnZXQ6IGV2ZW50LnRhcmdldCB9KTtcbiAgICAgICAgbG9nZ2VyLndhcm4oJ0ZhaWxlZCB0byBub3RpZnkgY29tcGxpYW5jZSBzZXJ2aWNlIG9mIGVudGl0eSBldmVudCcsIHtcbiAgICAgICAgICB0YXJnZXQ6IGV2ZW50LnRhcmdldCxcbiAgICAgICAgICBldmVudFR5cGU6IGV2ZW50LmV2ZW50VHlwZSxcbiAgICAgICAgICBlbnRpdHlJZDogZXZlbnQuZW50aXR5SWQsXG4gICAgICAgICAgZXJyb3I6IGVyciBpbnN0YW5jZW9mIEVycm9yID8gZXJyLm1lc3NhZ2UgOiBTdHJpbmcoZXJyKSxcbiAgICAgICAgfSk7XG4gICAgICB9XG4gICAgfSxcbiAgfTtcblxuICBlbnRpdHlFdmVudHMuc3Vic2NyaWJlKHN1YnNjcmliZXIpO1xuICBsb2dnZXIuaW5mbygnQ29tcGxpYW5jZSBldmVudCBzdWJzY3JpYmVyIHJlZ2lzdGVyZWQnLCB7XG4gICAgaG9zdDogc2VydmljZUNvbmZpZy5ob3N0LFxuICAgIHBvcnQ6IHNlcnZpY2VDb25maWcucG9ydCxcbiAgfSk7XG59XG4iXX0=
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Durable, at-least-once event backbone (Redis Streams).
|
|
3
|
+
*
|
|
4
|
+
* The platform's cross-service signalling today is point-to-point HTTP plus
|
|
5
|
+
* polling reconcilers plus an IN-PROCESS best-effort emitter ({@link entityEvents}).
|
|
6
|
+
* There is no durable bus, so a signal produced on one pod is either delivered
|
|
7
|
+
* synchronously over HTTP (coupling + retry-storm risk) or lost if the consumer
|
|
8
|
+
* is momentarily down (the reconcilers exist to paper over exactly that).
|
|
9
|
+
*
|
|
10
|
+
* This is that missing bus, as a reusable primitive:
|
|
11
|
+
* - **publish(topic, payload)** → `XADD` onto a bounded (`MAXLEN ~`) per-topic
|
|
12
|
+
* stream. Durable across restarts, shared by all replicas.
|
|
13
|
+
* - **subscribe({topic, group, consumer, handler})** → a `XREADGROUP` consumer.
|
|
14
|
+
* Consumer GROUPS give at-least-once: each group gets every message once, a
|
|
15
|
+
* message stays pending until the handler `XACK`s it, and `XAUTOCLAIM`
|
|
16
|
+
* reclaims messages stranded by a crashed consumer. Multiple groups on one
|
|
17
|
+
* topic = independent fan-out (e.g. quota-sync AND audit both react).
|
|
18
|
+
*
|
|
19
|
+
* FAIL-SAFE + OPT-IN, exactly like the audit spool: {@link createEnvRedisDurableEventBus}
|
|
20
|
+
* returns `null` when Redis isn't configured, so a service without it simply
|
|
21
|
+
* doesn't use the bus (keeps today's behavior). A publish failure is dropped-with-
|
|
22
|
+
* -metric, never thrown; a handler throw leaves the message un-acked for redelivery.
|
|
23
|
+
*
|
|
24
|
+
* Migrating a specific reconciler (e.g. billing→quota entitlement sync) onto this
|
|
25
|
+
* is deliberately follow-on work — this lands the backbone + an additive entity-
|
|
26
|
+
* event bridge; the reconcilers stay as the belt-and-suspenders backstop until a
|
|
27
|
+
* flow is fully cut over.
|
|
28
|
+
*/
|
|
29
|
+
import type { EntityEventSubscriber } from './entity-events.js';
|
|
30
|
+
/** A delivered event: its stream id, topic, and decoded payload. */
|
|
31
|
+
export interface EventEnvelope<T = unknown> {
|
|
32
|
+
/** Redis Stream entry id (`<ms>-<seq>`) — also the idempotency handle. */
|
|
33
|
+
id: string;
|
|
34
|
+
topic: string;
|
|
35
|
+
payload: T;
|
|
36
|
+
}
|
|
37
|
+
export interface SubscribeOptions<T = unknown> {
|
|
38
|
+
/** Topic (stream) to consume. */
|
|
39
|
+
topic: string;
|
|
40
|
+
/** Consumer group — one delivery per group; distinct groups fan out. */
|
|
41
|
+
group: string;
|
|
42
|
+
/** This consumer's id within the group (e.g. `${service}-${pid}`). */
|
|
43
|
+
consumer: string;
|
|
44
|
+
/** Async handler. Resolves ⇒ the message is acked; throws ⇒ left pending for redelivery. */
|
|
45
|
+
handler: (env: EventEnvelope<T>) => Promise<void>;
|
|
46
|
+
/** Max messages per read (default 16). */
|
|
47
|
+
batchSize?: number;
|
|
48
|
+
/** XREADGROUP block time in ms (default 5000). */
|
|
49
|
+
blockMs?: number;
|
|
50
|
+
/** A pending message idle this long (ms) is reclaimed from a dead consumer (default 60000). */
|
|
51
|
+
minIdleMs?: number;
|
|
52
|
+
}
|
|
53
|
+
export interface EventSubscription {
|
|
54
|
+
/** Stop the consumer loop. Resolves once the in-flight read returns. */
|
|
55
|
+
stop(): Promise<void>;
|
|
56
|
+
}
|
|
57
|
+
export interface DurableEventBus {
|
|
58
|
+
/** Publish a payload to a topic. Returns the stream id, or null on failure (dropped, never throws). */
|
|
59
|
+
publish<T>(topic: string, payload: T): Promise<string | null>;
|
|
60
|
+
/** Start a consumer-group reader for a topic. Fire-and-forget loop; call `stop()` to end it. */
|
|
61
|
+
subscribe<T>(opts: SubscribeOptions<T>): EventSubscription;
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* The subset of ioredis' Stream API the bus uses. Kept minimal so a test can
|
|
65
|
+
* supply an in-memory fake and so merely importing this never hard-depends on
|
|
66
|
+
* ioredis (constructed via the shared env helper).
|
|
67
|
+
*/
|
|
68
|
+
export interface RedisStreamClient {
|
|
69
|
+
xadd(key: string, ...args: (string | number)[]): Promise<string | null>;
|
|
70
|
+
xgroup(...args: (string | number)[]): Promise<unknown>;
|
|
71
|
+
xreadgroup(...args: (string | number)[]): Promise<unknown>;
|
|
72
|
+
xack(key: string, group: string, ...ids: string[]): Promise<number>;
|
|
73
|
+
xautoclaim(...args: (string | number)[]): Promise<unknown>;
|
|
74
|
+
}
|
|
75
|
+
/** Build a durable event bus over a Redis Streams client. */
|
|
76
|
+
export declare function createRedisDurableEventBus(redis: RedisStreamClient, opts?: {
|
|
77
|
+
maxLen?: number;
|
|
78
|
+
}): DurableEventBus;
|
|
79
|
+
/**
|
|
80
|
+
* Build a durable event bus from the ambient Redis env via the shared
|
|
81
|
+
* `createEnvRedisClient`. Returns `null` when Redis is not configured — the
|
|
82
|
+
* caller then runs without a bus (today's HTTP/reconciler behavior), never
|
|
83
|
+
* crashing. Opt in with a single boot line where a service wants durable events.
|
|
84
|
+
*/
|
|
85
|
+
export declare function createEnvRedisDurableEventBus(opts?: {
|
|
86
|
+
maxLen?: number;
|
|
87
|
+
}): DurableEventBus | null;
|
|
88
|
+
/** Topic the entity-event bridge publishes to. */
|
|
89
|
+
export declare const ENTITY_EVENT_TOPIC = "entity-events";
|
|
90
|
+
/**
|
|
91
|
+
* An {@link EntityEventSubscriber} that forwards each entity event to the durable
|
|
92
|
+
* bus. `bus.publish` is fail-safe (drops-with-metric, never throws), matching the
|
|
93
|
+
* emitter's fire-and-forget contract. Note `EntityEvent.timestamp` (a Date)
|
|
94
|
+
* serializes to an ISO string on the wire — a consumer re-hydrates as needed.
|
|
95
|
+
*/
|
|
96
|
+
export declare function createEntityEventBusPublisher(bus: DurableEventBus): EntityEventSubscriber;
|