@pipeline-builder/api-server 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 +79 -0
- package/lib/api/app-factory.d.ts +95 -0
- package/lib/api/app-factory.js +328 -0
- package/lib/api/check-quota.d.ts +13 -0
- package/lib/api/check-quota.js +74 -0
- package/lib/api/context-middleware.d.ts +34 -0
- package/lib/api/context-middleware.js +42 -0
- package/lib/api/etag-middleware.d.ts +7 -0
- package/lib/api/etag-middleware.js +44 -0
- package/lib/api/get-context.d.ts +22 -0
- package/lib/api/get-context.js +28 -0
- package/lib/api/health-checks.d.ts +62 -0
- package/lib/api/health-checks.js +87 -0
- package/lib/api/idempotency-middleware.d.ts +80 -0
- package/lib/api/idempotency-middleware.js +321 -0
- package/lib/api/index.d.ts +20 -0
- package/lib/api/index.js +34 -0
- package/lib/api/meter-quota.d.ts +32 -0
- package/lib/api/meter-quota.js +70 -0
- package/lib/api/metrics.d.ts +47 -0
- package/lib/api/metrics.js +221 -0
- package/lib/api/middleware-factory.d.ts +56 -0
- package/lib/api/middleware-factory.js +80 -0
- package/lib/api/middleware.d.ts +1 -0
- package/lib/api/middleware.js +8 -0
- package/lib/api/mongo-connect.d.ts +19 -0
- package/lib/api/mongo-connect.js +41 -0
- package/lib/api/quota-helpers.d.ts +23 -0
- package/lib/api/quota-helpers.js +22 -0
- package/lib/api/rate-limit-by-org.d.ts +29 -0
- package/lib/api/rate-limit-by-org.js +64 -0
- package/lib/api/readiness.d.ts +29 -0
- package/lib/api/readiness.js +65 -0
- package/lib/api/request-types.d.ts +55 -0
- package/lib/api/request-types.js +65 -0
- package/lib/api/require-org-id.d.ts +14 -0
- package/lib/api/require-org-id.js +28 -0
- package/lib/api/route-wrapper.d.ts +50 -0
- package/lib/api/route-wrapper.js +84 -0
- package/lib/api/server.d.ts +79 -0
- package/lib/api/server.js +234 -0
- package/lib/api/tenant-context.d.ts +28 -0
- package/lib/api/tenant-context.js +48 -0
- package/lib/api/tracing.d.ts +25 -0
- package/lib/api/tracing.js +69 -0
- package/lib/http/index.d.ts +4 -0
- package/lib/http/index.js +7 -0
- package/lib/http/sse-connection-manager.d.ts +357 -0
- package/lib/http/sse-connection-manager.js +665 -0
- package/lib/http/sse-relay.d.ts +63 -0
- package/lib/http/sse-relay.js +70 -0
- package/lib/http/sse-ticket-channel.d.ts +31 -0
- package/lib/http/sse-ticket-channel.js +52 -0
- package/lib/http/sse-ticket-store.d.ts +75 -0
- package/lib/http/sse-ticket-store.js +160 -0
- package/lib/index.d.ts +30 -0
- package/lib/index.js +35 -0
- package/lib/otel-bootstrap.d.ts +1 -0
- package/lib/otel-bootstrap.js +75 -0
- package/package.json +183 -0
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
// Copyright 2026 Pipeline Builder Contributors
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0
|
|
3
|
+
import { createHash } from 'crypto';
|
|
4
|
+
/**
|
|
5
|
+
* Middleware that adds ETag support for conditional GET requests.
|
|
6
|
+
* Generates a weak ETag from the response body hash.
|
|
7
|
+
* Returns 304 Not Modified when the client's If-None-Match header matches.
|
|
8
|
+
*/
|
|
9
|
+
export function etagMiddleware() {
|
|
10
|
+
return (req, res, next) => {
|
|
11
|
+
// Only apply to GET requests
|
|
12
|
+
if (req.method !== 'GET')
|
|
13
|
+
return next();
|
|
14
|
+
res.json = (body) => {
|
|
15
|
+
// Serialize once, hash, and send — avoids double JSON.stringify
|
|
16
|
+
const serialized = JSON.stringify(body);
|
|
17
|
+
// Only ETag/304 SUCCESSFUL responses. For non-2xx (errors), skip the
|
|
18
|
+
// conditional logic entirely — otherwise an error response whose body
|
|
19
|
+
// happens to hash-match the client's If-None-Match would be turned into a
|
|
20
|
+
// 304 Not Modified, making the client serve a stale (possibly successful)
|
|
21
|
+
// cached body in place of the error.
|
|
22
|
+
if (res.statusCode < 200 || res.statusCode >= 300) {
|
|
23
|
+
res.setHeader('Content-Type', 'application/json');
|
|
24
|
+
res.end(serialized);
|
|
25
|
+
return res;
|
|
26
|
+
}
|
|
27
|
+
const hash = createHash('md5').update(serialized).digest('hex').slice(0, 16);
|
|
28
|
+
const etag = `W/"${hash}"`;
|
|
29
|
+
res.setHeader('ETag', etag);
|
|
30
|
+
// Check If-None-Match header
|
|
31
|
+
const ifNoneMatch = req.headers['if-none-match'];
|
|
32
|
+
if (ifNoneMatch && ifNoneMatch === etag) {
|
|
33
|
+
res.status(304).end();
|
|
34
|
+
return res;
|
|
35
|
+
}
|
|
36
|
+
// Send pre-serialized body to avoid double JSON.stringify
|
|
37
|
+
res.setHeader('Content-Type', 'application/json');
|
|
38
|
+
res.end(serialized);
|
|
39
|
+
return res;
|
|
40
|
+
};
|
|
41
|
+
next();
|
|
42
|
+
};
|
|
43
|
+
}
|
|
44
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZXRhZy1taWRkbGV3YXJlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2FwaS9ldGFnLW1pZGRsZXdhcmUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsK0NBQStDO0FBQy9DLHNDQUFzQztBQUV0QyxPQUFPLEVBQUUsVUFBVSxFQUFFLE1BQU0sUUFBUSxDQUFDO0FBR3BDOzs7O0dBSUc7QUFDSCxNQUFNLFVBQVUsY0FBYztJQUM1QixPQUFPLENBQUMsR0FBWSxFQUFFLEdBQWEsRUFBRSxJQUFrQixFQUFFLEVBQUU7UUFDekQsNkJBQTZCO1FBQzdCLElBQUksR0FBRyxDQUFDLE1BQU0sS0FBSyxLQUFLO1lBQUUsT0FBTyxJQUFJLEVBQUUsQ0FBQztRQUV4QyxHQUFHLENBQUMsSUFBSSxHQUFHLENBQUMsSUFBYSxFQUFFLEVBQUU7WUFDM0IsZ0VBQWdFO1lBQ2hFLE1BQU0sVUFBVSxHQUFHLElBQUksQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLENBQUM7WUFFeEMscUVBQXFFO1lBQ3JFLHNFQUFzRTtZQUN0RSwwRUFBMEU7WUFDMUUsMEVBQTBFO1lBQzFFLHFDQUFxQztZQUNyQyxJQUFJLEdBQUcsQ0FBQyxVQUFVLEdBQUcsR0FBRyxJQUFJLEdBQUcsQ0FBQyxVQUFVLElBQUksR0FBRyxFQUFFLENBQUM7Z0JBQ2xELEdBQUcsQ0FBQyxTQUFTLENBQUMsY0FBYyxFQUFFLGtCQUFrQixDQUFDLENBQUM7Z0JBQ2xELEdBQUcsQ0FBQyxHQUFHLENBQUMsVUFBVSxDQUFDLENBQUM7Z0JBQ3BCLE9BQU8sR0FBRyxDQUFDO1lBQ2IsQ0FBQztZQUVELE1BQU0sSUFBSSxHQUFHLFVBQVUsQ0FBQyxLQUFLLENBQUMsQ0FBQyxNQUFNLENBQUMsVUFBVSxDQUFDLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDLEtBQUssQ0FBQyxDQUFDLEVBQUUsRUFBRSxDQUFDLENBQUM7WUFDN0UsTUFBTSxJQUFJLEdBQUcsTUFBTSxJQUFJLEdBQUcsQ0FBQztZQUUzQixHQUFHLENBQUMsU0FBUyxDQUFDLE1BQU0sRUFBRSxJQUFJLENBQUMsQ0FBQztZQUU1Qiw2QkFBNkI7WUFDN0IsTUFBTSxXQUFXLEdBQUcsR0FBRyxDQUFDLE9BQU8sQ0FBQyxlQUFlLENBQUMsQ0FBQztZQUNqRCxJQUFJLFdBQVcsSUFBSSxXQUFXLEtBQUssSUFBSSxFQUFFLENBQUM7Z0JBQ3hDLEdBQUcsQ0FBQyxNQUFNLENBQUMsR0FBRyxDQUFDLENBQUMsR0FBRyxFQUFFLENBQUM7Z0JBQ3RCLE9BQU8sR0FBRyxDQUFDO1lBQ2IsQ0FBQztZQUVELDBEQUEwRDtZQUMxRCxHQUFHLENBQUMsU0FBUyxDQUFDLGNBQWMsRUFBRSxrQkFBa0IsQ0FBQyxDQUFDO1lBQ2xELEdBQUcsQ0FBQyxHQUFHLENBQUMsVUFBVSxDQUFDLENBQUM7WUFDcEIsT0FBTyxHQUFHLENBQUM7UUFDYixDQUFDLENBQUM7UUFFRixJQUFJLEVBQUUsQ0FBQztJQUNULENBQUMsQ0FBQztBQUNKLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvLyBDb3B5cmlnaHQgMjAyNiBQaXBlbGluZSBCdWlsZGVyIENvbnRyaWJ1dG9yc1xuLy8gU1BEWC1MaWNlbnNlLUlkZW50aWZpZXI6IEFwYWNoZS0yLjBcblxuaW1wb3J0IHsgY3JlYXRlSGFzaCB9IGZyb20gJ2NyeXB0byc7XG5pbXBvcnQgdHlwZSB7IFJlcXVlc3QsIFJlc3BvbnNlLCBOZXh0RnVuY3Rpb24gfSBmcm9tICdleHByZXNzJztcblxuLyoqXG4gKiBNaWRkbGV3YXJlIHRoYXQgYWRkcyBFVGFnIHN1cHBvcnQgZm9yIGNvbmRpdGlvbmFsIEdFVCByZXF1ZXN0cy5cbiAqIEdlbmVyYXRlcyBhIHdlYWsgRVRhZyBmcm9tIHRoZSByZXNwb25zZSBib2R5IGhhc2guXG4gKiBSZXR1cm5zIDMwNCBOb3QgTW9kaWZpZWQgd2hlbiB0aGUgY2xpZW50J3MgSWYtTm9uZS1NYXRjaCBoZWFkZXIgbWF0Y2hlcy5cbiAqL1xuZXhwb3J0IGZ1bmN0aW9uIGV0YWdNaWRkbGV3YXJlKCkge1xuICByZXR1cm4gKHJlcTogUmVxdWVzdCwgcmVzOiBSZXNwb25zZSwgbmV4dDogTmV4dEZ1bmN0aW9uKSA9PiB7XG4gICAgLy8gT25seSBhcHBseSB0byBHRVQgcmVxdWVzdHNcbiAgICBpZiAocmVxLm1ldGhvZCAhPT0gJ0dFVCcpIHJldHVybiBuZXh0KCk7XG5cbiAgICByZXMuanNvbiA9IChib2R5OiB1bmtub3duKSA9PiB7XG4gICAgICAvLyBTZXJpYWxpemUgb25jZSwgaGFzaCwgYW5kIHNlbmQg4oCUIGF2b2lkcyBkb3VibGUgSlNPTi5zdHJpbmdpZnlcbiAgICAgIGNvbnN0IHNlcmlhbGl6ZWQgPSBKU09OLnN0cmluZ2lmeShib2R5KTtcblxuICAgICAgLy8gT25seSBFVGFnLzMwNCBTVUNDRVNTRlVMIHJlc3BvbnNlcy4gRm9yIG5vbi0yeHggKGVycm9ycyksIHNraXAgdGhlXG4gICAgICAvLyBjb25kaXRpb25hbCBsb2dpYyBlbnRpcmVseSDigJQgb3RoZXJ3aXNlIGFuIGVycm9yIHJlc3BvbnNlIHdob3NlIGJvZHlcbiAgICAgIC8vIGhhcHBlbnMgdG8gaGFzaC1tYXRjaCB0aGUgY2xpZW50J3MgSWYtTm9uZS1NYXRjaCB3b3VsZCBiZSB0dXJuZWQgaW50byBhXG4gICAgICAvLyAzMDQgTm90IE1vZGlmaWVkLCBtYWtpbmcgdGhlIGNsaWVudCBzZXJ2ZSBhIHN0YWxlIChwb3NzaWJseSBzdWNjZXNzZnVsKVxuICAgICAgLy8gY2FjaGVkIGJvZHkgaW4gcGxhY2Ugb2YgdGhlIGVycm9yLlxuICAgICAgaWYgKHJlcy5zdGF0dXNDb2RlIDwgMjAwIHx8IHJlcy5zdGF0dXNDb2RlID49IDMwMCkge1xuICAgICAgICByZXMuc2V0SGVhZGVyKCdDb250ZW50LVR5cGUnLCAnYXBwbGljYXRpb24vanNvbicpO1xuICAgICAgICByZXMuZW5kKHNlcmlhbGl6ZWQpO1xuICAgICAgICByZXR1cm4gcmVzO1xuICAgICAgfVxuXG4gICAgICBjb25zdCBoYXNoID0gY3JlYXRlSGFzaCgnbWQ1JykudXBkYXRlKHNlcmlhbGl6ZWQpLmRpZ2VzdCgnaGV4Jykuc2xpY2UoMCwgMTYpO1xuICAgICAgY29uc3QgZXRhZyA9IGBXL1wiJHtoYXNofVwiYDtcblxuICAgICAgcmVzLnNldEhlYWRlcignRVRhZycsIGV0YWcpO1xuXG4gICAgICAvLyBDaGVjayBJZi1Ob25lLU1hdGNoIGhlYWRlclxuICAgICAgY29uc3QgaWZOb25lTWF0Y2ggPSByZXEuaGVhZGVyc1snaWYtbm9uZS1tYXRjaCddO1xuICAgICAgaWYgKGlmTm9uZU1hdGNoICYmIGlmTm9uZU1hdGNoID09PSBldGFnKSB7XG4gICAgICAgIHJlcy5zdGF0dXMoMzA0KS5lbmQoKTtcbiAgICAgICAgcmV0dXJuIHJlcztcbiAgICAgIH1cblxuICAgICAgLy8gU2VuZCBwcmUtc2VyaWFsaXplZCBib2R5IHRvIGF2b2lkIGRvdWJsZSBKU09OLnN0cmluZ2lmeVxuICAgICAgcmVzLnNldEhlYWRlcignQ29udGVudC1UeXBlJywgJ2FwcGxpY2F0aW9uL2pzb24nKTtcbiAgICAgIHJlcy5lbmQoc2VyaWFsaXplZCk7XG4gICAgICByZXR1cm4gcmVzO1xuICAgIH07XG5cbiAgICBuZXh0KCk7XG4gIH07XG59XG4iXX0=
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import type { Request } from 'express';
|
|
2
|
+
import type { RequestContext } from './request-types.js';
|
|
3
|
+
/**
|
|
4
|
+
* Safely retrieve the RequestContext from an Express request.
|
|
5
|
+
*
|
|
6
|
+
* Throws a descriptive error if the context middleware has not been applied,
|
|
7
|
+
* instead of silently returning undefined or crashing with a cryptic error.
|
|
8
|
+
*
|
|
9
|
+
* @param req - Express request object
|
|
10
|
+
* @returns The attached RequestContext
|
|
11
|
+
* @throws Error if req.context is not initialized
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```typescript
|
|
15
|
+
* app.get('/pipelines', requireAuth, async (req, res) => {
|
|
16
|
+
* const ctx = getContext(req);
|
|
17
|
+
* ctx.log('INFO', 'Fetching pipelines');
|
|
18
|
+
* // ...
|
|
19
|
+
* });
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
export declare function getContext(req: Request): RequestContext;
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
// Copyright 2026 Pipeline Builder Contributors
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0
|
|
3
|
+
/**
|
|
4
|
+
* Safely retrieve the RequestContext from an Express request.
|
|
5
|
+
*
|
|
6
|
+
* Throws a descriptive error if the context middleware has not been applied,
|
|
7
|
+
* instead of silently returning undefined or crashing with a cryptic error.
|
|
8
|
+
*
|
|
9
|
+
* @param req - Express request object
|
|
10
|
+
* @returns The attached RequestContext
|
|
11
|
+
* @throws Error if req.context is not initialized
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```typescript
|
|
15
|
+
* app.get('/pipelines', requireAuth, async (req, res) => {
|
|
16
|
+
* const ctx = getContext(req);
|
|
17
|
+
* ctx.log('INFO', 'Fetching pipelines');
|
|
18
|
+
* // ...
|
|
19
|
+
* });
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
export function getContext(req) {
|
|
23
|
+
if (!req.context) {
|
|
24
|
+
throw new Error('Request context not initialized. Ensure attachRequestContext middleware is applied.');
|
|
25
|
+
}
|
|
26
|
+
return req.context;
|
|
27
|
+
}
|
|
28
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ2V0LWNvbnRleHQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYXBpL2dldC1jb250ZXh0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLCtDQUErQztBQUMvQyxzQ0FBc0M7QUFLdEM7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQWtCRztBQUNILE1BQU0sVUFBVSxVQUFVLENBQUMsR0FBWTtJQUNyQyxJQUFJLENBQUMsR0FBRyxDQUFDLE9BQU8sRUFBRSxDQUFDO1FBQ2pCLE1BQU0sSUFBSSxLQUFLLENBQ2IscUZBQXFGLENBQ3RGLENBQUM7SUFDSixDQUFDO0lBQ0QsT0FBTyxHQUFHLENBQUMsT0FBTyxDQUFDO0FBQ3JCLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvLyBDb3B5cmlnaHQgMjAyNiBQaXBlbGluZSBCdWlsZGVyIENvbnRyaWJ1dG9yc1xuLy8gU1BEWC1MaWNlbnNlLUlkZW50aWZpZXI6IEFwYWNoZS0yLjBcblxuaW1wb3J0IHR5cGUgeyBSZXF1ZXN0IH0gZnJvbSAnZXhwcmVzcyc7XG5pbXBvcnQgdHlwZSB7IFJlcXVlc3RDb250ZXh0IH0gZnJvbSAnLi9yZXF1ZXN0LXR5cGVzLmpzJztcblxuLyoqXG4gKiBTYWZlbHkgcmV0cmlldmUgdGhlIFJlcXVlc3RDb250ZXh0IGZyb20gYW4gRXhwcmVzcyByZXF1ZXN0LlxuICpcbiAqIFRocm93cyBhIGRlc2NyaXB0aXZlIGVycm9yIGlmIHRoZSBjb250ZXh0IG1pZGRsZXdhcmUgaGFzIG5vdCBiZWVuIGFwcGxpZWQsXG4gKiBpbnN0ZWFkIG9mIHNpbGVudGx5IHJldHVybmluZyB1bmRlZmluZWQgb3IgY3Jhc2hpbmcgd2l0aCBhIGNyeXB0aWMgZXJyb3IuXG4gKlxuICogQHBhcmFtIHJlcSAtIEV4cHJlc3MgcmVxdWVzdCBvYmplY3RcbiAqIEByZXR1cm5zIFRoZSBhdHRhY2hlZCBSZXF1ZXN0Q29udGV4dFxuICogQHRocm93cyBFcnJvciBpZiByZXEuY29udGV4dCBpcyBub3QgaW5pdGlhbGl6ZWRcbiAqXG4gKiBAZXhhbXBsZVxuICogYGBgdHlwZXNjcmlwdFxuICogYXBwLmdldCgnL3BpcGVsaW5lcycsIHJlcXVpcmVBdXRoLCBhc3luYyAocmVxLCByZXMpID0+IHtcbiAqICAgY29uc3QgY3R4ID0gZ2V0Q29udGV4dChyZXEpO1xuICogICBjdHgubG9nKCdJTkZPJywgJ0ZldGNoaW5nIHBpcGVsaW5lcycpO1xuICogICAvLyAuLi5cbiAqIH0pO1xuICogYGBgXG4gKi9cbmV4cG9ydCBmdW5jdGlvbiBnZXRDb250ZXh0KHJlcTogUmVxdWVzdCk6IFJlcXVlc3RDb250ZXh0IHtcbiAgaWYgKCFyZXEuY29udGV4dCkge1xuICAgIHRocm93IG5ldyBFcnJvcihcbiAgICAgICdSZXF1ZXN0IGNvbnRleHQgbm90IGluaXRpYWxpemVkLiBFbnN1cmUgYXR0YWNoUmVxdWVzdENvbnRleHQgbWlkZGxld2FyZSBpcyBhcHBsaWVkLicsXG4gICAgKTtcbiAgfVxuICByZXR1cm4gcmVxLmNvbnRleHQ7XG59XG4iXX0=
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
type HealthStatus = 'connected' | 'disconnected' | 'unknown';
|
|
2
|
+
type HealthResult = Record<string, HealthStatus>;
|
|
3
|
+
/**
|
|
4
|
+
* Postgres health probe: returns `{ postgres: 'connected' }` when the pool's
|
|
5
|
+
* connection test succeeds, `{ postgres: 'disconnected' }` on any error or
|
|
6
|
+
* timeout (so `/ready` correctly reports 503). Use as (part of) the
|
|
7
|
+
* `checkDependencies` option of `createApp()` for any service backed by the
|
|
8
|
+
* shared pipeline-data Drizzle connection.
|
|
9
|
+
*/
|
|
10
|
+
export declare function postgresHealthCheck(timeoutMs?: number): Promise<HealthResult>;
|
|
11
|
+
/** Minimal shape of an ioredis client needed for a health PING. */
|
|
12
|
+
interface RedisLike {
|
|
13
|
+
ping(): Promise<string>;
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Source of a redis client: either the client itself, or a (sync/async) getter.
|
|
17
|
+
* The getter form supports BullMQ's `queue.client` (a `Promise<RedisClient>`)
|
|
18
|
+
* so a service can probe the exact connection its queue uses without opening
|
|
19
|
+
* a second one.
|
|
20
|
+
*/
|
|
21
|
+
type RedisClientSource = RedisLike | (() => RedisLike | Promise<RedisLike>);
|
|
22
|
+
/**
|
|
23
|
+
* Redis health probe factory: pass the service's EXISTING ioredis connection
|
|
24
|
+
* (or a getter for it — e.g. `() => queue.client`) and get back a
|
|
25
|
+
* `checkDependencies` callback that `PING`s it. Mirrors `mongoHealthCheck` —
|
|
26
|
+
* it probes the real connection rather than opening a throwaway one per call.
|
|
27
|
+
* The PING is time-boxed so a down redis (whose offline queue would otherwise
|
|
28
|
+
* buffer the command) reports `disconnected` quickly instead of hanging.
|
|
29
|
+
*/
|
|
30
|
+
export declare function redisHealthCheck(source: RedisClientSource, timeoutMs?: number): () => Promise<HealthResult>;
|
|
31
|
+
/**
|
|
32
|
+
* Combine several dependency probes into one `checkDependencies` callback that
|
|
33
|
+
* runs them IN PARALLEL and merges their results. A slow/failed probe can't
|
|
34
|
+
* delay the others or time out the whole `/ready` response.
|
|
35
|
+
*
|
|
36
|
+
* CONTRACT: each probe must CATCH internally and RETURN its `{ name: status }`
|
|
37
|
+
* (as the built-in postgres/redis/mongo probes do). A probe that THROWS is
|
|
38
|
+
* merged as `{}` — its dependency then vanishes from the map and `/ready`
|
|
39
|
+
* reports 200 with the dep simply absent (a silent false-healthy), rather than
|
|
40
|
+
* surfacing it as `disconnected`. The `.catch(() => ({}))` below only exists so
|
|
41
|
+
* one misbehaving probe can't take down the others, NOT as a substitute for a
|
|
42
|
+
* probe returning its own disconnected status.
|
|
43
|
+
*/
|
|
44
|
+
export declare function combineHealthChecks(...checks: Array<() => Promise<HealthResult>>): () => Promise<HealthResult>;
|
|
45
|
+
/**
|
|
46
|
+
* Minimal shape expected of a mongoose connection for the health probe.
|
|
47
|
+
* Accepts `mongoose.connection` directly without requiring mongoose as a
|
|
48
|
+
* dependency of api-server.
|
|
49
|
+
*/
|
|
50
|
+
interface MongooseConnectionLike {
|
|
51
|
+
readyState: number;
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* MongoDB health probe factory: pass `mongoose.connection` and get back a
|
|
55
|
+
* `checkDependencies` callback that reports based on mongoose's readyState.
|
|
56
|
+
*
|
|
57
|
+
* Mapping (per mongoose docs): 1=connected, 2=connecting, 3=disconnecting,
|
|
58
|
+
* any other value (0=disconnected, 99=uninitialized) is treated as
|
|
59
|
+
* 'disconnected' so `/health` returns 503.
|
|
60
|
+
*/
|
|
61
|
+
export declare function mongoHealthCheck(connection: MongooseConnectionLike): () => Promise<HealthResult>;
|
|
62
|
+
export {};
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
// Copyright 2026 Pipeline Builder Contributors
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0
|
|
3
|
+
import { getConnection } from '@pipeline-builder/pipeline-data';
|
|
4
|
+
/**
|
|
5
|
+
* Reject if `promise` hasn't settled within `ms`. A health/readiness probe
|
|
6
|
+
* must never hang the `/ready` response — a down datastore (or a BullMQ
|
|
7
|
+
* ioredis client with `maxRetriesPerRequest: null` + an offline queue) can
|
|
8
|
+
* leave a `ping()`/query pending indefinitely, so every probe is time-boxed.
|
|
9
|
+
*/
|
|
10
|
+
function withTimeout(promise, ms, label) {
|
|
11
|
+
return new Promise((resolve, reject) => {
|
|
12
|
+
const timer = setTimeout(() => reject(new Error(`${label} timed out after ${ms}ms`)), ms);
|
|
13
|
+
timer.unref?.();
|
|
14
|
+
promise.then((value) => { clearTimeout(timer); resolve(value); }, (err) => { clearTimeout(timer); reject(err); });
|
|
15
|
+
});
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* Postgres health probe: returns `{ postgres: 'connected' }` when the pool's
|
|
19
|
+
* connection test succeeds, `{ postgres: 'disconnected' }` on any error or
|
|
20
|
+
* timeout (so `/ready` correctly reports 503). Use as (part of) the
|
|
21
|
+
* `checkDependencies` option of `createApp()` for any service backed by the
|
|
22
|
+
* shared pipeline-data Drizzle connection.
|
|
23
|
+
*/
|
|
24
|
+
export async function postgresHealthCheck(timeoutMs = 3000) {
|
|
25
|
+
try {
|
|
26
|
+
await withTimeout(getConnection().testConnection(), timeoutMs, 'postgres testConnection');
|
|
27
|
+
return { postgres: 'connected' };
|
|
28
|
+
}
|
|
29
|
+
catch {
|
|
30
|
+
return { postgres: 'disconnected' };
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Redis health probe factory: pass the service's EXISTING ioredis connection
|
|
35
|
+
* (or a getter for it — e.g. `() => queue.client`) and get back a
|
|
36
|
+
* `checkDependencies` callback that `PING`s it. Mirrors `mongoHealthCheck` —
|
|
37
|
+
* it probes the real connection rather than opening a throwaway one per call.
|
|
38
|
+
* The PING is time-boxed so a down redis (whose offline queue would otherwise
|
|
39
|
+
* buffer the command) reports `disconnected` quickly instead of hanging.
|
|
40
|
+
*/
|
|
41
|
+
export function redisHealthCheck(source, timeoutMs = 2000) {
|
|
42
|
+
return async () => {
|
|
43
|
+
try {
|
|
44
|
+
const client = typeof source === 'function' ? await source() : source;
|
|
45
|
+
await withTimeout(client.ping(), timeoutMs, 'redis ping');
|
|
46
|
+
return { redis: 'connected' };
|
|
47
|
+
}
|
|
48
|
+
catch {
|
|
49
|
+
return { redis: 'disconnected' };
|
|
50
|
+
}
|
|
51
|
+
};
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* Combine several dependency probes into one `checkDependencies` callback that
|
|
55
|
+
* runs them IN PARALLEL and merges their results. A slow/failed probe can't
|
|
56
|
+
* delay the others or time out the whole `/ready` response.
|
|
57
|
+
*
|
|
58
|
+
* CONTRACT: each probe must CATCH internally and RETURN its `{ name: status }`
|
|
59
|
+
* (as the built-in postgres/redis/mongo probes do). A probe that THROWS is
|
|
60
|
+
* merged as `{}` — its dependency then vanishes from the map and `/ready`
|
|
61
|
+
* reports 200 with the dep simply absent (a silent false-healthy), rather than
|
|
62
|
+
* surfacing it as `disconnected`. The `.catch(() => ({}))` below only exists so
|
|
63
|
+
* one misbehaving probe can't take down the others, NOT as a substitute for a
|
|
64
|
+
* probe returning its own disconnected status.
|
|
65
|
+
*/
|
|
66
|
+
export function combineHealthChecks(...checks) {
|
|
67
|
+
return async () => {
|
|
68
|
+
const results = await Promise.all(checks.map((check) => check().catch(() => ({}))));
|
|
69
|
+
return Object.assign({}, ...results);
|
|
70
|
+
};
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* MongoDB health probe factory: pass `mongoose.connection` and get back a
|
|
74
|
+
* `checkDependencies` callback that reports based on mongoose's readyState.
|
|
75
|
+
*
|
|
76
|
+
* Mapping (per mongoose docs): 1=connected, 2=connecting, 3=disconnecting,
|
|
77
|
+
* any other value (0=disconnected, 99=uninitialized) is treated as
|
|
78
|
+
* 'disconnected' so `/health` returns 503.
|
|
79
|
+
*/
|
|
80
|
+
export function mongoHealthCheck(connection) {
|
|
81
|
+
return async () => ({
|
|
82
|
+
mongodb: connection.readyState === 1 ? 'connected'
|
|
83
|
+
: connection.readyState === 2 ? 'unknown' // connecting; treat as transient
|
|
84
|
+
: 'disconnected',
|
|
85
|
+
});
|
|
86
|
+
}
|
|
87
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"health-checks.js","sourceRoot":"","sources":["../../src/api/health-checks.ts"],"names":[],"mappings":"AAAA,+CAA+C;AAC/C,sCAAsC;AAEtC,OAAO,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAKhE;;;;;GAKG;AACH,SAAS,WAAW,CAAI,OAAmB,EAAE,EAAU,EAAE,KAAa;IACpE,OAAO,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACxC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,GAAG,KAAK,oBAAoB,EAAE,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC1F,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC;QAChB,OAAO,CAAC,IAAI,CACV,CAAC,KAAK,EAAE,EAAE,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACnD,CAAC,GAAG,EAAE,EAAE,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAC/C,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,SAAS,GAAG,IAAI;IACxD,IAAI,CAAC;QACH,MAAM,WAAW,CAAC,aAAa,EAAE,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,yBAAyB,CAAC,CAAC;QAC1F,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;IACnC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,CAAC;IACtC,CAAC;AACH,CAAC;AAeD;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAyB,EAAE,SAAS,GAAG,IAAI;IAC1E,OAAO,KAAK,IAAI,EAAE;QAChB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,OAAO,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,MAAM,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;YACtE,MAAM,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,YAAY,CAAC,CAAC;YAC1D,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;QAChC,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC;QACnC,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,mBAAmB,CACjC,GAAG,MAA0C;IAE7C,OAAO,KAAK,IAAI,EAAE;QAChB,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,EAAmB,CAAA,CAAC,CAAC,CAAC,CAAC;QACpG,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,OAAO,CAAiB,CAAC;IACvD,CAAC,CAAC;AACJ,CAAC;AAWD;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAAC,UAAkC;IACjE,OAAO,KAAK,IAAI,EAAE,CAAC,CAAC;QAClB,OAAO,EAAE,UAAU,CAAC,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW;YAChD,CAAC,CAAC,UAAU,CAAC,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,iCAAiC;gBACzE,CAAC,CAAC,cAAc;KACrB,CAAC,CAAC;AACL,CAAC","sourcesContent":["// Copyright 2026 Pipeline Builder Contributors\n// SPDX-License-Identifier: Apache-2.0\n\nimport { getConnection } from '@pipeline-builder/pipeline-data';\n\ntype HealthStatus = 'connected' | 'disconnected' | 'unknown';\ntype HealthResult = Record<string, HealthStatus>;\n\n/**\n * Reject if `promise` hasn't settled within `ms`. A health/readiness probe\n * must never hang the `/ready` response — a down datastore (or a BullMQ\n * ioredis client with `maxRetriesPerRequest: null` + an offline queue) can\n * leave a `ping()`/query pending indefinitely, so every probe is time-boxed.\n */\nfunction withTimeout<T>(promise: Promise<T>, ms: number, label: string): Promise<T> {\n  return new Promise<T>((resolve, reject) => {\n    const timer = setTimeout(() => reject(new Error(`${label} timed out after ${ms}ms`)), ms);\n    timer.unref?.();\n    promise.then(\n      (value) => { clearTimeout(timer); resolve(value); },\n      (err) => { clearTimeout(timer); reject(err); },\n    );\n  });\n}\n\n/**\n * Postgres health probe: returns `{ postgres: 'connected' }` when the pool's\n * connection test succeeds, `{ postgres: 'disconnected' }` on any error or\n * timeout (so `/ready` correctly reports 503). Use as (part of) the\n * `checkDependencies` option of `createApp()` for any service backed by the\n * shared pipeline-data Drizzle connection.\n */\nexport async function postgresHealthCheck(timeoutMs = 3000): Promise<HealthResult> {\n  try {\n    await withTimeout(getConnection().testConnection(), timeoutMs, 'postgres testConnection');\n    return { postgres: 'connected' };\n  } catch {\n    return { postgres: 'disconnected' };\n  }\n}\n\n/** Minimal shape of an ioredis client needed for a health PING. */\ninterface RedisLike {\n  ping(): Promise<string>;\n}\n\n/**\n * Source of a redis client: either the client itself, or a (sync/async) getter.\n * The getter form supports BullMQ's `queue.client` (a `Promise<RedisClient>`)\n * so a service can probe the exact connection its queue uses without opening\n * a second one.\n */\ntype RedisClientSource = RedisLike | (() => RedisLike | Promise<RedisLike>);\n\n/**\n * Redis health probe factory: pass the service's EXISTING ioredis connection\n * (or a getter for it — e.g. `() => queue.client`) and get back a\n * `checkDependencies` callback that `PING`s it. Mirrors `mongoHealthCheck` —\n * it probes the real connection rather than opening a throwaway one per call.\n * The PING is time-boxed so a down redis (whose offline queue would otherwise\n * buffer the command) reports `disconnected` quickly instead of hanging.\n */\nexport function redisHealthCheck(source: RedisClientSource, timeoutMs = 2000): () => Promise<HealthResult> {\n  return async () => {\n    try {\n      const client = typeof source === 'function' ? await source() : source;\n      await withTimeout(client.ping(), timeoutMs, 'redis ping');\n      return { redis: 'connected' };\n    } catch {\n      return { redis: 'disconnected' };\n    }\n  };\n}\n\n/**\n * Combine several dependency probes into one `checkDependencies` callback that\n * runs them IN PARALLEL and merges their results. A slow/failed probe can't\n * delay the others or time out the whole `/ready` response.\n *\n * CONTRACT: each probe must CATCH internally and RETURN its `{ name: status }`\n * (as the built-in postgres/redis/mongo probes do). A probe that THROWS is\n * merged as `{}` — its dependency then vanishes from the map and `/ready`\n * reports 200 with the dep simply absent (a silent false-healthy), rather than\n * surfacing it as `disconnected`. The `.catch(() => ({}))` below only exists so\n * one misbehaving probe can't take down the others, NOT as a substitute for a\n * probe returning its own disconnected status.\n */\nexport function combineHealthChecks(\n  ...checks: Array<() => Promise<HealthResult>>\n): () => Promise<HealthResult> {\n  return async () => {\n    const results = await Promise.all(checks.map((check) => check().catch(() => ({} as HealthResult))));\n    return Object.assign({}, ...results) as HealthResult;\n  };\n}\n\n/**\n * Minimal shape expected of a mongoose connection for the health probe.\n * Accepts `mongoose.connection` directly without requiring mongoose as a\n * dependency of api-server.\n */\ninterface MongooseConnectionLike {\n  readyState: number;\n}\n\n/**\n * MongoDB health probe factory: pass `mongoose.connection` and get back a\n * `checkDependencies` callback that reports based on mongoose's readyState.\n *\n * Mapping (per mongoose docs): 1=connected, 2=connecting, 3=disconnecting,\n * any other value (0=disconnected, 99=uninitialized) is treated as\n * 'disconnected' so `/health` returns 503.\n */\nexport function mongoHealthCheck(connection: MongooseConnectionLike): () => Promise<HealthResult> {\n  return async () => ({\n    mongodb: connection.readyState === 1 ? 'connected'\n      : connection.readyState === 2 ? 'unknown' // connecting; treat as transient\n        : 'disconnected',\n  });\n}\n"]}
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
import type { Request, Response, NextFunction } from 'express';
|
|
2
|
+
interface CachedEntry {
|
|
3
|
+
statusCode: number;
|
|
4
|
+
body: unknown;
|
|
5
|
+
expiresAt: number;
|
|
6
|
+
/** Reservation placeholder: the request is in-flight, no real response yet.
|
|
7
|
+
* A duplicate that sees a pending entry is rejected with 409, not replayed. */
|
|
8
|
+
pending?: boolean;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* Pluggable backend for idempotency-key replay cache. The default in-memory
|
|
12
|
+
* implementation works fine single-replica; a Redis-backed implementation
|
|
13
|
+
* is required for correct deduplication across horizontally-scaled replicas
|
|
14
|
+
* (otherwise two replicas behind a load-balancer cache independently and a
|
|
15
|
+
* retry hitting a different pod won't replay).
|
|
16
|
+
*/
|
|
17
|
+
export interface IdempotencyStore {
|
|
18
|
+
get(key: string): Promise<CachedEntry | null>;
|
|
19
|
+
set(key: string, entry: CachedEntry, ttlSeconds: number): Promise<void>;
|
|
20
|
+
/**
|
|
21
|
+
* Atomically claim `key` IFF it is currently absent. Returns `true` when THIS
|
|
22
|
+
* caller set the entry (won the race), `false` when an entry already exists.
|
|
23
|
+
* This is what serializes concurrent first-time requests that share an
|
|
24
|
+
* Idempotency-Key — a plain get-then-set leaves a window where two requests
|
|
25
|
+
* both see "not cached" and both execute the mutation.
|
|
26
|
+
*/
|
|
27
|
+
reserve(key: string, entry: CachedEntry, ttlSeconds: number): Promise<boolean>;
|
|
28
|
+
/** Remove a key — releases a reservation after a non-cacheable (non-2xx) response. */
|
|
29
|
+
delete(key: string): Promise<void>;
|
|
30
|
+
}
|
|
31
|
+
/** Default in-memory store. Single-replica only. Exported for testing. */
|
|
32
|
+
export declare function createMemoryStore(): IdempotencyStore;
|
|
33
|
+
/**
|
|
34
|
+
* Minimal Redis surface the idempotency store needs (an ioredis subset).
|
|
35
|
+
* `set` supports the variadic option tail: `SET key val EX <ttl> [NX]`, which
|
|
36
|
+
* returns `'OK'` on success and `null` when an `NX` set was refused.
|
|
37
|
+
*/
|
|
38
|
+
export interface RedisIdempotencyClient {
|
|
39
|
+
get(key: string): Promise<string | null>;
|
|
40
|
+
set(key: string, value: string, ...args: (string | number)[]): Promise<string | null>;
|
|
41
|
+
del(key: string): Promise<number>;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Redis-backed {@link IdempotencyStore} for correct deduplication across
|
|
45
|
+
* horizontally-scaled replicas. `reserve` maps to an atomic `SET … NX` so two
|
|
46
|
+
* pods behind a load-balancer can't both win a first-time request sharing an
|
|
47
|
+
* Idempotency-Key; a retry landing on ANY pod sees the same committed response.
|
|
48
|
+
* Redis TTL owns expiry (the `CachedEntry.expiresAt` field is carried only for
|
|
49
|
+
* API-shape parity with the memory store).
|
|
50
|
+
*/
|
|
51
|
+
export declare function createRedisIdempotencyStore(redis: RedisIdempotencyClient): IdempotencyStore;
|
|
52
|
+
/**
|
|
53
|
+
* Build a Redis-backed idempotency store from the shared env Redis (the same
|
|
54
|
+
* `REDIS_URL` / `REDIS_HOST` wiring the rate-limiter and audit-spool use).
|
|
55
|
+
* Returns `null` when Redis isn't configured/available so the caller keeps the
|
|
56
|
+
* in-memory default (single-replica correctness). Never throws.
|
|
57
|
+
*/
|
|
58
|
+
export declare function createEnvRedisIdempotencyStore(): IdempotencyStore | null;
|
|
59
|
+
/** Inject the process-wide idempotency store (e.g. a Redis-backed one). */
|
|
60
|
+
export declare function setIdempotencyStore(store: IdempotencyStore): void;
|
|
61
|
+
/** The current process-wide default store (in-memory unless overridden). */
|
|
62
|
+
export declare function getIdempotencyStore(): IdempotencyStore;
|
|
63
|
+
export interface IdempotencyMiddlewareOptions {
|
|
64
|
+
/** Custom store backend. Defaults to the process-wide store set via
|
|
65
|
+
* {@link setIdempotencyStore} (in-memory until `createApp` wires Redis). */
|
|
66
|
+
store?: IdempotencyStore;
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Middleware that supports idempotency keys for POST/PUT/DELETE mutations.
|
|
70
|
+
*
|
|
71
|
+
* When a request includes the `Idempotency-Key` header:
|
|
72
|
+
* - First call: processes normally, caches the response
|
|
73
|
+
* - Subsequent calls with same key: returns cached response (prevents duplicate mutations)
|
|
74
|
+
*
|
|
75
|
+
* Defaults to an in-memory store (single-replica). Pass a custom
|
|
76
|
+
* cross-replica `{ store }` implementing `IdempotencyStore` to dedupe across
|
|
77
|
+
* replicas.
|
|
78
|
+
*/
|
|
79
|
+
export declare function idempotencyMiddleware(options?: IdempotencyMiddlewareOptions): (req: Request, res: Response, next: NextFunction) => void;
|
|
80
|
+
export {};
|