@pipeline-builder/api-server 3.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +202 -0
- package/README.md +39 -0
- package/lib/api/app-factory.d.ts +71 -0
- package/lib/api/app-factory.js +212 -0
- package/lib/api/check-quota.d.ts +13 -0
- package/lib/api/check-quota.js +67 -0
- package/lib/api/context-middleware.d.ts +34 -0
- package/lib/api/context-middleware.js +45 -0
- package/lib/api/etag-middleware.d.ts +7 -0
- package/lib/api/etag-middleware.js +37 -0
- package/lib/api/get-context.d.ts +22 -0
- package/lib/api/get-context.js +31 -0
- package/lib/api/health-checks.d.ts +25 -0
- package/lib/api/health-checks.js +36 -0
- package/lib/api/idempotency-middleware.d.ts +9 -0
- package/lib/api/idempotency-middleware.js +64 -0
- package/lib/api/index.d.ts +15 -0
- package/lib/api/index.js +43 -0
- package/lib/api/metrics.d.ts +12 -0
- package/lib/api/metrics.js +83 -0
- package/lib/api/middleware-factory.d.ts +47 -0
- package/lib/api/middleware-factory.js +66 -0
- package/lib/api/middleware.d.ts +1 -0
- package/lib/api/middleware.js +14 -0
- package/lib/api/quota-helpers.d.ts +23 -0
- package/lib/api/quota-helpers.js +25 -0
- package/lib/api/request-types.d.ts +55 -0
- package/lib/api/request-types.js +62 -0
- package/lib/api/require-org-id.d.ts +14 -0
- package/lib/api/require-org-id.js +31 -0
- package/lib/api/route-wrapper.d.ts +50 -0
- package/lib/api/route-wrapper.js +62 -0
- package/lib/api/server.d.ts +79 -0
- package/lib/api/server.js +144 -0
- package/lib/api/tracing.d.ts +15 -0
- package/lib/api/tracing.js +53 -0
- package/lib/http/index.d.ts +2 -0
- package/lib/http/index.js +21 -0
- package/lib/http/sse-connection-manager.d.ts +145 -0
- package/lib/http/sse-connection-manager.js +329 -0
- package/lib/http/ws-manager.d.ts +37 -0
- package/lib/http/ws-manager.js +105 -0
- package/lib/index.d.ts +30 -0
- package/lib/index.js +51 -0
- package/package.json +143 -0
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// Copyright 2026 Pipeline Builder Contributors
|
|
3
|
+
// SPDX-License-Identifier: Apache-2.0
|
|
4
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
5
|
+
exports.startServer = startServer;
|
|
6
|
+
exports.runServer = runServer;
|
|
7
|
+
const api_core_1 = require("@pipeline-builder/api-core");
|
|
8
|
+
const pipeline_core_1 = require("@pipeline-builder/pipeline-core");
|
|
9
|
+
const tracing_1 = require("./tracing");
|
|
10
|
+
const logger = (0, api_core_1.createLogger)('Server');
|
|
11
|
+
/**
|
|
12
|
+
* Start an Express server with graceful shutdown handling
|
|
13
|
+
*
|
|
14
|
+
* Features:
|
|
15
|
+
* - Automatic database connection testing
|
|
16
|
+
* - Graceful shutdown on SIGINT/SIGTERM
|
|
17
|
+
* - SSE connection cleanup
|
|
18
|
+
* - Configurable shutdown timeout
|
|
19
|
+
*
|
|
20
|
+
* @param app - Express application
|
|
21
|
+
* @param options - Server options
|
|
22
|
+
* @returns Server instance and control functions
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* ```typescript
|
|
26
|
+
* const { app, sseManager } = createApp();
|
|
27
|
+
*
|
|
28
|
+
* app.post('/api/resource', requireAuth, handler);
|
|
29
|
+
*
|
|
30
|
+
* await startServer(app, {
|
|
31
|
+
* name: 'My Microservice',
|
|
32
|
+
* sseManager,
|
|
33
|
+
* onStart: (port) => console.log(`Listening on ${port}`),
|
|
34
|
+
* });
|
|
35
|
+
* ```
|
|
36
|
+
*/
|
|
37
|
+
async function startServer(app, options = {}) {
|
|
38
|
+
const serverConfig = pipeline_core_1.Config.get('server');
|
|
39
|
+
const { name = 'Microservice', sseManager, shutdownTimeoutMs = 15000, onStart, onShutdown, onBeforeStart, testDatabase, closeDatabase, } = options;
|
|
40
|
+
const port = options.port ?? serverConfig.port;
|
|
41
|
+
// Validate auth configuration at server startup (not during CDK synthesis)
|
|
42
|
+
pipeline_core_1.Config.validateAuth();
|
|
43
|
+
logger.info(`Starting ${name}...`);
|
|
44
|
+
// Pre-start hook (e.g., initialize external connections)
|
|
45
|
+
if (onBeforeStart) {
|
|
46
|
+
await onBeforeStart();
|
|
47
|
+
}
|
|
48
|
+
// Test database connection
|
|
49
|
+
if (testDatabase !== false) {
|
|
50
|
+
const dbHealthy = testDatabase
|
|
51
|
+
? await testDatabase()
|
|
52
|
+
: await (0, pipeline_core_1.getConnection)().testConnection();
|
|
53
|
+
if (!dbHealthy) {
|
|
54
|
+
throw new Error('Database connection failed');
|
|
55
|
+
}
|
|
56
|
+
logger.info('Database connection established');
|
|
57
|
+
}
|
|
58
|
+
// Start server
|
|
59
|
+
const server = app.listen(port, () => {
|
|
60
|
+
logger.info(`${name} listening on port: ${port}`);
|
|
61
|
+
logger.info(`Platform URL: ${serverConfig.platformUrl}`);
|
|
62
|
+
onStart?.(port);
|
|
63
|
+
});
|
|
64
|
+
// Shutdown handler (guarded against concurrent signals)
|
|
65
|
+
let shuttingDown = false;
|
|
66
|
+
const shutdown = async (signal) => {
|
|
67
|
+
if (shuttingDown)
|
|
68
|
+
return;
|
|
69
|
+
shuttingDown = true;
|
|
70
|
+
if (signal) {
|
|
71
|
+
logger.info(`${signal} received, shutting down gracefully...`);
|
|
72
|
+
}
|
|
73
|
+
// Custom shutdown callback
|
|
74
|
+
if (onShutdown) {
|
|
75
|
+
try {
|
|
76
|
+
await onShutdown();
|
|
77
|
+
}
|
|
78
|
+
catch (error) {
|
|
79
|
+
logger.error('Error in onShutdown callback', { error });
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
// Close SSE connections
|
|
83
|
+
if (sseManager) {
|
|
84
|
+
sseManager.shutdown();
|
|
85
|
+
logger.info('SSE connections closed');
|
|
86
|
+
}
|
|
87
|
+
// Close HTTP server
|
|
88
|
+
server.close(async () => {
|
|
89
|
+
logger.info('HTTP server closed');
|
|
90
|
+
// Shutdown OpenTelemetry tracing
|
|
91
|
+
await (0, tracing_1.shutdownTracing)().catch(err => logger.error('Error shutting down tracing', { error: err }));
|
|
92
|
+
// Close database connection
|
|
93
|
+
if (closeDatabase !== false) {
|
|
94
|
+
try {
|
|
95
|
+
if (closeDatabase) {
|
|
96
|
+
await closeDatabase();
|
|
97
|
+
}
|
|
98
|
+
else {
|
|
99
|
+
await (0, pipeline_core_1.closeConnection)();
|
|
100
|
+
}
|
|
101
|
+
logger.info('Database connection closed');
|
|
102
|
+
}
|
|
103
|
+
catch (error) {
|
|
104
|
+
logger.error('Error closing database', { error });
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
process.exit(0);
|
|
108
|
+
});
|
|
109
|
+
// Force shutdown after timeout
|
|
110
|
+
setTimeout(() => {
|
|
111
|
+
logger.error('Forced shutdown after timeout');
|
|
112
|
+
process.exit(1);
|
|
113
|
+
}, shutdownTimeoutMs).unref();
|
|
114
|
+
};
|
|
115
|
+
// Register signal handlers
|
|
116
|
+
process.once('SIGINT', () => void shutdown('SIGINT'));
|
|
117
|
+
process.once('SIGTERM', () => void shutdown('SIGTERM'));
|
|
118
|
+
return {
|
|
119
|
+
server,
|
|
120
|
+
port,
|
|
121
|
+
shutdown: () => shutdown(),
|
|
122
|
+
};
|
|
123
|
+
}
|
|
124
|
+
/**
|
|
125
|
+
* Simple server start wrapper with error handling
|
|
126
|
+
*
|
|
127
|
+
* @param app - Express application
|
|
128
|
+
* @param options - Server options
|
|
129
|
+
*
|
|
130
|
+
* @example
|
|
131
|
+
* ```typescript
|
|
132
|
+
* const { app, sseManager } = createApp();
|
|
133
|
+
* app.post('/api/resource', handler);
|
|
134
|
+
*
|
|
135
|
+
* void runServer(app, { name: 'My Service', sseManager });
|
|
136
|
+
* ```
|
|
137
|
+
*/
|
|
138
|
+
function runServer(app, options = {}) {
|
|
139
|
+
startServer(app, options).catch((error) => {
|
|
140
|
+
logger.error('Failed to start server', { error });
|
|
141
|
+
process.exit(1);
|
|
142
|
+
});
|
|
143
|
+
}
|
|
144
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"server.js","sourceRoot":"","sources":["../../src/api/server.ts"],"names":[],"mappings":";AAAA,+CAA+C;AAC/C,sCAAsC;;AAyEtC,kCAgHC;AAgBD,8BAKC;AA3MD,yDAA0D;AAC1D,mEAAyF;AAEzF,uCAA4C;AAG5C,MAAM,MAAM,GAAG,IAAA,uBAAY,EAAC,QAAQ,CAAC,CAAC;AAsCtC;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACI,KAAK,UAAU,WAAW,CAC/B,GAAY,EACZ,UAA8B,EAAE;IAEhC,MAAM,YAAY,GAAG,sBAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC1C,MAAM,EACJ,IAAI,GAAG,cAAc,EACrB,UAAU,EACV,iBAAiB,GAAG,KAAK,EACzB,OAAO,EACP,UAAU,EACV,aAAa,EACb,YAAY,EACZ,aAAa,GACd,GAAG,OAAO,CAAC;IACZ,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,YAAY,CAAC,IAAI,CAAC;IAE/C,2EAA2E;IAC3E,sBAAM,CAAC,YAAY,EAAE,CAAC;IAEtB,MAAM,CAAC,IAAI,CAAC,YAAY,IAAI,KAAK,CAAC,CAAC;IAEnC,yDAAyD;IACzD,IAAI,aAAa,EAAE,CAAC;QAClB,MAAM,aAAa,EAAE,CAAC;IACxB,CAAC;IAED,2BAA2B;IAC3B,IAAI,YAAY,KAAK,KAAK,EAAE,CAAC;QAC3B,MAAM,SAAS,GAAG,YAAY;YAC5B,CAAC,CAAC,MAAM,YAAY,EAAE;YACtB,CAAC,CAAC,MAAM,IAAA,6BAAa,GAAE,CAAC,cAAc,EAAE,CAAC;QAE3C,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;IACjD,CAAC;IAED,eAAe;IACf,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE;QACnC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,uBAAuB,IAAI,EAAE,CAAC,CAAC;QAClD,MAAM,CAAC,IAAI,CAAC,iBAAiB,YAAY,CAAC,WAAW,EAAE,CAAC,CAAC;QACzD,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;IAEH,wDAAwD;IACxD,IAAI,YAAY,GAAG,KAAK,CAAC;IACzB,MAAM,QAAQ,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE;QACzC,IAAI,YAAY;YAAE,OAAO;QACzB,YAAY,GAAG,IAAI,CAAC;QAEpB,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,wCAAwC,CAAC,CAAC;QACjE,CAAC;QAED,2BAA2B;QAC3B,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC;gBACH,MAAM,UAAU,EAAE,CAAC;YACrB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,CAAC,KAAK,CAAC,8BAA8B,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;YAC1D,CAAC;QACH,CAAC;QAED,wBAAwB;QACxB,IAAI,UAAU,EAAE,CAAC;YACf,UAAU,CAAC,QAAQ,EAAE,CAAC;YACtB,MAAM,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;QACxC,CAAC;QAED,oBAAoB;QACpB,MAAM,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE;YACtB,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;YAElC,iCAAiC;YACjC,MAAM,IAAA,yBAAe,GAAE,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;YAElG,4BAA4B;YAC5B,IAAI,aAAa,KAAK,KAAK,EAAE,CAAC;gBAC5B,IAAI,CAAC;oBACH,IAAI,aAAa,EAAE,CAAC;wBAClB,MAAM,aAAa,EAAE,CAAC;oBACxB,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAA,+BAAe,GAAE,CAAC;oBAC1B,CAAC;oBACD,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;gBAC5C,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,MAAM,CAAC,KAAK,CAAC,wBAAwB,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;gBACpD,CAAC;YACH,CAAC;YAED,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC,CAAC,CAAC;QAEH,+BAA+B;QAC/B,UAAU,CAAC,GAAG,EAAE;YACd,MAAM,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC;YAC9C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC,EAAE,iBAAiB,CAAC,CAAC,KAAK,EAAE,CAAC;IAChC,CAAC,CAAC;IAEF,2BAA2B;IAC3B,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,KAAK,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;IACtD,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,KAAK,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;IAExD,OAAO;QACL,MAAM;QACN,IAAI;QACJ,QAAQ,EAAE,GAAG,EAAE,CAAC,QAAQ,EAAE;KAC3B,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAgB,SAAS,CAAC,GAAY,EAAE,UAA8B,EAAE;IACtE,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACxC,MAAM,CAAC,KAAK,CAAC,wBAAwB,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAClD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["// Copyright 2026 Pipeline Builder Contributors\n// SPDX-License-Identifier: Apache-2.0\n\nimport { Server } from 'http';\nimport { createLogger } from '@pipeline-builder/api-core';\nimport { Config, getConnection, closeConnection } from '@pipeline-builder/pipeline-core';\nimport { Express } from 'express';\nimport { shutdownTracing } from './tracing';\nimport { SSEManager } from '../http/sse-connection-manager';\n\nconst logger = createLogger('Server');\n\n/**\n * Options for starting a server\n */\nexport interface StartServerOptions {\n  /** Service name for logging */\n  name?: string;\n  /** Port to listen on (default: from config) */\n  port?: number;\n  /** SSE manager for graceful shutdown */\n  sseManager?: SSEManager;\n  /** Shutdown timeout in milliseconds (default: 15000) */\n  shutdownTimeoutMs?: number;\n  /** Callback after server starts */\n  onStart?: (port: number) => void;\n  /** Callback before shutdown */\n  onShutdown?: () => Promise<void>;\n  /** Runs before database check (e.g., initialize external connections) */\n  onBeforeStart?: () => Promise<void>;\n  /** Custom database health check, or false to skip. Default: PostgreSQL testConnection */\n  testDatabase?: (() => Promise<boolean>) | false;\n  /** Custom database close, or false to skip. Default: PostgreSQL closeConnection */\n  closeDatabase?: (() => Promise<void>) | false;\n}\n\n/**\n * Result of starting a server\n */\nexport interface StartServerResult {\n  /** HTTP server instance */\n  server: Server;\n  /** Port the server is listening on */\n  port: number;\n  /** Function to manually trigger shutdown */\n  shutdown: () => Promise<void>;\n}\n\n/**\n * Start an Express server with graceful shutdown handling\n *\n * Features:\n * - Automatic database connection testing\n * - Graceful shutdown on SIGINT/SIGTERM\n * - SSE connection cleanup\n * - Configurable shutdown timeout\n *\n * @param app - Express application\n * @param options - Server options\n * @returns Server instance and control functions\n *\n * @example\n * ```typescript\n * const { app, sseManager } = createApp();\n *\n * app.post('/api/resource', requireAuth, handler);\n *\n * await startServer(app, {\n *   name: 'My Microservice',\n *   sseManager,\n *   onStart: (port) => console.log(`Listening on ${port}`),\n * });\n * ```\n */\nexport async function startServer(\n  app: Express,\n  options: StartServerOptions = {},\n): Promise<StartServerResult> {\n  const serverConfig = Config.get('server');\n  const {\n    name = 'Microservice',\n    sseManager,\n    shutdownTimeoutMs = 15000,\n    onStart,\n    onShutdown,\n    onBeforeStart,\n    testDatabase,\n    closeDatabase,\n  } = options;\n  const port = options.port ?? serverConfig.port;\n\n  // Validate auth configuration at server startup (not during CDK synthesis)\n  Config.validateAuth();\n\n  logger.info(`Starting ${name}...`);\n\n  // Pre-start hook (e.g., initialize external connections)\n  if (onBeforeStart) {\n    await onBeforeStart();\n  }\n\n  // Test database connection\n  if (testDatabase !== false) {\n    const dbHealthy = testDatabase\n      ? await testDatabase()\n      : await getConnection().testConnection();\n\n    if (!dbHealthy) {\n      throw new Error('Database connection failed');\n    }\n\n    logger.info('Database connection established');\n  }\n\n  // Start server\n  const server = app.listen(port, () => {\n    logger.info(`${name} listening on port: ${port}`);\n    logger.info(`Platform URL: ${serverConfig.platformUrl}`);\n    onStart?.(port);\n  });\n\n  // Shutdown handler (guarded against concurrent signals)\n  let shuttingDown = false;\n  const shutdown = async (signal?: string) => {\n    if (shuttingDown) return;\n    shuttingDown = true;\n\n    if (signal) {\n      logger.info(`${signal} received, shutting down gracefully...`);\n    }\n\n    // Custom shutdown callback\n    if (onShutdown) {\n      try {\n        await onShutdown();\n      } catch (error) {\n        logger.error('Error in onShutdown callback', { error });\n      }\n    }\n\n    // Close SSE connections\n    if (sseManager) {\n      sseManager.shutdown();\n      logger.info('SSE connections closed');\n    }\n\n    // Close HTTP server\n    server.close(async () => {\n      logger.info('HTTP server closed');\n\n      // Shutdown OpenTelemetry tracing\n      await shutdownTracing().catch(err => logger.error('Error shutting down tracing', { error: err }));\n\n      // Close database connection\n      if (closeDatabase !== false) {\n        try {\n          if (closeDatabase) {\n            await closeDatabase();\n          } else {\n            await closeConnection();\n          }\n          logger.info('Database connection closed');\n        } catch (error) {\n          logger.error('Error closing database', { error });\n        }\n      }\n\n      process.exit(0);\n    });\n\n    // Force shutdown after timeout\n    setTimeout(() => {\n      logger.error('Forced shutdown after timeout');\n      process.exit(1);\n    }, shutdownTimeoutMs).unref();\n  };\n\n  // Register signal handlers\n  process.once('SIGINT', () => void shutdown('SIGINT'));\n  process.once('SIGTERM', () => void shutdown('SIGTERM'));\n\n  return {\n    server,\n    port,\n    shutdown: () => shutdown(),\n  };\n}\n\n/**\n * Simple server start wrapper with error handling\n *\n * @param app - Express application\n * @param options - Server options\n *\n * @example\n * ```typescript\n * const { app, sseManager } = createApp();\n * app.post('/api/resource', handler);\n *\n * void runServer(app, { name: 'My Service', sseManager });\n * ```\n */\nexport function runServer(app: Express, options: StartServerOptions = {}): void {\n  startServer(app, options).catch((error) => {\n    logger.error('Failed to start server', { error });\n    process.exit(1);\n  });\n}\n"]}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Initialize OpenTelemetry tracing with OTLP HTTP exporter.
|
|
3
|
+
* Configured via `Config.get('observability').tracing`.
|
|
4
|
+
*
|
|
5
|
+
* @example
|
|
6
|
+
* ```typescript
|
|
7
|
+
* import { initTracing } from '@pipeline-builder/api-server';
|
|
8
|
+
* initTracing('pipeline-service');
|
|
9
|
+
* ```
|
|
10
|
+
*/
|
|
11
|
+
export declare function initTracing(serviceName: string): void;
|
|
12
|
+
/**
|
|
13
|
+
* Shutdown the OpenTelemetry SDK gracefully.
|
|
14
|
+
*/
|
|
15
|
+
export declare function shutdownTracing(): Promise<void>;
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// Copyright 2026 Pipeline Builder Contributors
|
|
3
|
+
// SPDX-License-Identifier: Apache-2.0
|
|
4
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
5
|
+
exports.initTracing = initTracing;
|
|
6
|
+
exports.shutdownTracing = shutdownTracing;
|
|
7
|
+
const exporter_trace_otlp_http_1 = require("@opentelemetry/exporter-trace-otlp-http");
|
|
8
|
+
const resources_1 = require("@opentelemetry/resources");
|
|
9
|
+
const sdk_node_1 = require("@opentelemetry/sdk-node");
|
|
10
|
+
const api_core_1 = require("@pipeline-builder/api-core");
|
|
11
|
+
const pipeline_core_1 = require("@pipeline-builder/pipeline-core");
|
|
12
|
+
const logger = (0, api_core_1.createLogger)('Tracing');
|
|
13
|
+
let sdk = null;
|
|
14
|
+
/**
|
|
15
|
+
* Initialize OpenTelemetry tracing with OTLP HTTP exporter.
|
|
16
|
+
* Configured via `Config.get('observability').tracing`.
|
|
17
|
+
*
|
|
18
|
+
* @example
|
|
19
|
+
* ```typescript
|
|
20
|
+
* import { initTracing } from '@pipeline-builder/api-server';
|
|
21
|
+
* initTracing('pipeline-service');
|
|
22
|
+
* ```
|
|
23
|
+
*/
|
|
24
|
+
function initTracing(serviceName) {
|
|
25
|
+
const { tracing } = pipeline_core_1.Config.getAny('observability');
|
|
26
|
+
if (!tracing.enabled) {
|
|
27
|
+
logger.debug('OpenTelemetry tracing disabled (set OTEL_TRACING_ENABLED=true to enable)');
|
|
28
|
+
return;
|
|
29
|
+
}
|
|
30
|
+
if (sdk) {
|
|
31
|
+
logger.debug('OpenTelemetry already initialized');
|
|
32
|
+
return;
|
|
33
|
+
}
|
|
34
|
+
const exporter = new exporter_trace_otlp_http_1.OTLPTraceExporter({
|
|
35
|
+
url: tracing.endpoint,
|
|
36
|
+
});
|
|
37
|
+
sdk = new sdk_node_1.NodeSDK({
|
|
38
|
+
resource: (0, resources_1.resourceFromAttributes)({ 'service.name': serviceName }),
|
|
39
|
+
traceExporter: exporter,
|
|
40
|
+
});
|
|
41
|
+
sdk.start();
|
|
42
|
+
logger.info(`OpenTelemetry tracing initialized for ${serviceName}`);
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Shutdown the OpenTelemetry SDK gracefully.
|
|
46
|
+
*/
|
|
47
|
+
async function shutdownTracing() {
|
|
48
|
+
if (sdk) {
|
|
49
|
+
await sdk.shutdown();
|
|
50
|
+
sdk = null;
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHJhY2luZy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9hcGkvdHJhY2luZy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsK0NBQStDO0FBQy9DLHNDQUFzQzs7QUFzQnRDLGtDQXdCQztBQUtELDBDQUtDO0FBdERELHNGQUE0RTtBQUM1RSx3REFBa0U7QUFDbEUsc0RBQWtEO0FBQ2xELHlEQUEwRDtBQUMxRCxtRUFBeUQ7QUFFekQsTUFBTSxNQUFNLEdBQUcsSUFBQSx1QkFBWSxFQUFDLFNBQVMsQ0FBQyxDQUFDO0FBRXZDLElBQUksR0FBRyxHQUFtQixJQUFJLENBQUM7QUFFL0I7Ozs7Ozs7OztHQVNHO0FBQ0gsU0FBZ0IsV0FBVyxDQUFDLFdBQW1CO0lBQzdDLE1BQU0sRUFBRSxPQUFPLEVBQUUsR0FBRyxzQkFBTSxDQUFDLE1BQU0sQ0FBQyxlQUFlLENBQXdELENBQUM7SUFFMUcsSUFBSSxDQUFDLE9BQU8sQ0FBQyxPQUFPLEVBQUUsQ0FBQztRQUNyQixNQUFNLENBQUMsS0FBSyxDQUFDLDBFQUEwRSxDQUFDLENBQUM7UUFDekYsT0FBTztJQUNULENBQUM7SUFFRCxJQUFJLEdBQUcsRUFBRSxDQUFDO1FBQ1IsTUFBTSxDQUFDLEtBQUssQ0FBQyxtQ0FBbUMsQ0FBQyxDQUFDO1FBQ2xELE9BQU87SUFDVCxDQUFDO0lBRUQsTUFBTSxRQUFRLEdBQUcsSUFBSSw0Q0FBaUIsQ0FBQztRQUNyQyxHQUFHLEVBQUUsT0FBTyxDQUFDLFFBQVE7S0FDdEIsQ0FBQyxDQUFDO0lBRUgsR0FBRyxHQUFHLElBQUksa0JBQU8sQ0FBQztRQUNoQixRQUFRLEVBQUUsSUFBQSxrQ0FBc0IsRUFBQyxFQUFFLGNBQWMsRUFBRSxXQUFXLEVBQUUsQ0FBQztRQUNqRSxhQUFhLEVBQUUsUUFBUTtLQUN4QixDQUFDLENBQUM7SUFFSCxHQUFHLENBQUMsS0FBSyxFQUFFLENBQUM7SUFDWixNQUFNLENBQUMsSUFBSSxDQUFDLHlDQUF5QyxXQUFXLEVBQUUsQ0FBQyxDQUFDO0FBQ3RFLENBQUM7QUFFRDs7R0FFRztBQUNJLEtBQUssVUFBVSxlQUFlO0lBQ25DLElBQUksR0FBRyxFQUFFLENBQUM7UUFDUixNQUFNLEdBQUcsQ0FBQyxRQUFRLEVBQUUsQ0FBQztRQUNyQixHQUFHLEdBQUcsSUFBSSxDQUFDO0lBQ2IsQ0FBQztBQUNILENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvLyBDb3B5cmlnaHQgMjAyNiBQaXBlbGluZSBCdWlsZGVyIENvbnRyaWJ1dG9yc1xuLy8gU1BEWC1MaWNlbnNlLUlkZW50aWZpZXI6IEFwYWNoZS0yLjBcblxuaW1wb3J0IHsgT1RMUFRyYWNlRXhwb3J0ZXIgfSBmcm9tICdAb3BlbnRlbGVtZXRyeS9leHBvcnRlci10cmFjZS1vdGxwLWh0dHAnO1xuaW1wb3J0IHsgcmVzb3VyY2VGcm9tQXR0cmlidXRlcyB9IGZyb20gJ0BvcGVudGVsZW1ldHJ5L3Jlc291cmNlcyc7XG5pbXBvcnQgeyBOb2RlU0RLIH0gZnJvbSAnQG9wZW50ZWxlbWV0cnkvc2RrLW5vZGUnO1xuaW1wb3J0IHsgY3JlYXRlTG9nZ2VyIH0gZnJvbSAnQHBpcGVsaW5lLWJ1aWxkZXIvYXBpLWNvcmUnO1xuaW1wb3J0IHsgQ29uZmlnIH0gZnJvbSAnQHBpcGVsaW5lLWJ1aWxkZXIvcGlwZWxpbmUtY29yZSc7XG5cbmNvbnN0IGxvZ2dlciA9IGNyZWF0ZUxvZ2dlcignVHJhY2luZycpO1xuXG5sZXQgc2RrOiBOb2RlU0RLIHwgbnVsbCA9IG51bGw7XG5cbi8qKlxuICogSW5pdGlhbGl6ZSBPcGVuVGVsZW1ldHJ5IHRyYWNpbmcgd2l0aCBPVExQIEhUVFAgZXhwb3J0ZXIuXG4gKiBDb25maWd1cmVkIHZpYSBgQ29uZmlnLmdldCgnb2JzZXJ2YWJpbGl0eScpLnRyYWNpbmdgLlxuICpcbiAqIEBleGFtcGxlXG4gKiBgYGB0eXBlc2NyaXB0XG4gKiBpbXBvcnQgeyBpbml0VHJhY2luZyB9IGZyb20gJ0BwaXBlbGluZS1idWlsZGVyL2FwaS1zZXJ2ZXInO1xuICogaW5pdFRyYWNpbmcoJ3BpcGVsaW5lLXNlcnZpY2UnKTtcbiAqIGBgYFxuICovXG5leHBvcnQgZnVuY3Rpb24gaW5pdFRyYWNpbmcoc2VydmljZU5hbWU6IHN0cmluZyk6IHZvaWQge1xuICBjb25zdCB7IHRyYWNpbmcgfSA9IENvbmZpZy5nZXRBbnkoJ29ic2VydmFiaWxpdHknKSBhcyB7IHRyYWNpbmc6IHsgZW5hYmxlZDogYm9vbGVhbjsgZW5kcG9pbnQ6IHN0cmluZyB9IH07XG5cbiAgaWYgKCF0cmFjaW5nLmVuYWJsZWQpIHtcbiAgICBsb2dnZXIuZGVidWcoJ09wZW5UZWxlbWV0cnkgdHJhY2luZyBkaXNhYmxlZCAoc2V0IE9URUxfVFJBQ0lOR19FTkFCTEVEPXRydWUgdG8gZW5hYmxlKScpO1xuICAgIHJldHVybjtcbiAgfVxuXG4gIGlmIChzZGspIHtcbiAgICBsb2dnZXIuZGVidWcoJ09wZW5UZWxlbWV0cnkgYWxyZWFkeSBpbml0aWFsaXplZCcpO1xuICAgIHJldHVybjtcbiAgfVxuXG4gIGNvbnN0IGV4cG9ydGVyID0gbmV3IE9UTFBUcmFjZUV4cG9ydGVyKHtcbiAgICB1cmw6IHRyYWNpbmcuZW5kcG9pbnQsXG4gIH0pO1xuXG4gIHNkayA9IG5ldyBOb2RlU0RLKHtcbiAgICByZXNvdXJjZTogcmVzb3VyY2VGcm9tQXR0cmlidXRlcyh7ICdzZXJ2aWNlLm5hbWUnOiBzZXJ2aWNlTmFtZSB9KSxcbiAgICB0cmFjZUV4cG9ydGVyOiBleHBvcnRlcixcbiAgfSk7XG5cbiAgc2RrLnN0YXJ0KCk7XG4gIGxvZ2dlci5pbmZvKGBPcGVuVGVsZW1ldHJ5IHRyYWNpbmcgaW5pdGlhbGl6ZWQgZm9yICR7c2VydmljZU5hbWV9YCk7XG59XG5cbi8qKlxuICogU2h1dGRvd24gdGhlIE9wZW5UZWxlbWV0cnkgU0RLIGdyYWNlZnVsbHkuXG4gKi9cbmV4cG9ydCBhc3luYyBmdW5jdGlvbiBzaHV0ZG93blRyYWNpbmcoKTogUHJvbWlzZTx2b2lkPiB7XG4gIGlmIChzZGspIHtcbiAgICBhd2FpdCBzZGsuc2h1dGRvd24oKTtcbiAgICBzZGsgPSBudWxsO1xuICB9XG59XG4iXX0=
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// Copyright 2026 Pipeline Builder Contributors
|
|
3
|
+
// SPDX-License-Identifier: Apache-2.0
|
|
4
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
5
|
+
if (k2 === undefined) k2 = k;
|
|
6
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
7
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
8
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
9
|
+
}
|
|
10
|
+
Object.defineProperty(o, k2, desc);
|
|
11
|
+
}) : (function(o, m, k, k2) {
|
|
12
|
+
if (k2 === undefined) k2 = k;
|
|
13
|
+
o[k2] = m[k];
|
|
14
|
+
}));
|
|
15
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
16
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
17
|
+
};
|
|
18
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
+
__exportStar(require("./sse-connection-manager"), exports);
|
|
20
|
+
__exportStar(require("./ws-manager"), exports);
|
|
21
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaHR0cC9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsK0NBQStDO0FBQy9DLHNDQUFzQzs7Ozs7Ozs7Ozs7Ozs7OztBQUV0QywyREFBeUM7QUFDekMsK0NBQTZCIiwic291cmNlc0NvbnRlbnQiOlsiLy8gQ29weXJpZ2h0IDIwMjYgUGlwZWxpbmUgQnVpbGRlciBDb250cmlidXRvcnNcbi8vIFNQRFgtTGljZW5zZS1JZGVudGlmaWVyOiBBcGFjaGUtMi4wXG5cbmV4cG9ydCAqIGZyb20gJy4vc3NlLWNvbm5lY3Rpb24tbWFuYWdlcic7XG5leHBvcnQgKiBmcm9tICcuL3dzLW1hbmFnZXInO1xuIl19
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
import { Response } from 'express';
|
|
2
|
+
/**
|
|
3
|
+
* Event types for SSE logging
|
|
4
|
+
*/
|
|
5
|
+
export type SSEEventType = 'INFO' | 'WARN' | 'ERROR' | 'COMPLETED' | 'ROLLBACK' | 'MESSAGE';
|
|
6
|
+
/**
|
|
7
|
+
* SSE payload structure
|
|
8
|
+
*/
|
|
9
|
+
export interface SSEPayload {
|
|
10
|
+
ts: string;
|
|
11
|
+
type: SSEEventType;
|
|
12
|
+
message: string;
|
|
13
|
+
data?: unknown;
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* SSE client with connection tracking
|
|
17
|
+
*/
|
|
18
|
+
export interface SSEClient {
|
|
19
|
+
id: string;
|
|
20
|
+
res: Response;
|
|
21
|
+
connectedAt: number;
|
|
22
|
+
timeout: NodeJS.Timeout;
|
|
23
|
+
/** Number of consecutive backpressure events (write returned false). */
|
|
24
|
+
backpressureCount: number;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* SSE Manager configuration options
|
|
28
|
+
*/
|
|
29
|
+
export interface SSEManagerOptions {
|
|
30
|
+
/** Maximum clients allowed per request ID (default: 10) */
|
|
31
|
+
maxClientsPerRequest?: number;
|
|
32
|
+
/** Client timeout in milliseconds (default: 30 minutes) */
|
|
33
|
+
clientTimeoutMs?: number;
|
|
34
|
+
/** Interval for cleanup checks in milliseconds (default: 5 minutes) */
|
|
35
|
+
cleanupIntervalMs?: number;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* SSE Manager statistics
|
|
39
|
+
*/
|
|
40
|
+
export interface SSEManagerStats {
|
|
41
|
+
totalRequests: number;
|
|
42
|
+
totalClients: number;
|
|
43
|
+
oldestConnectionMs: number | null;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* SSE helper class with memory leak protection
|
|
47
|
+
*
|
|
48
|
+
* Features:
|
|
49
|
+
* - Client limits per request ID
|
|
50
|
+
* - Automatic timeout for idle connections
|
|
51
|
+
* - Periodic cleanup of stale connections
|
|
52
|
+
* - Connection statistics
|
|
53
|
+
*
|
|
54
|
+
* @example
|
|
55
|
+
* ```typescript
|
|
56
|
+
* const sseManager = new SSEManager({ maxClientsPerRequest: 5 });
|
|
57
|
+
* app.get('/logs/:requestId', sseManager.middleware());
|
|
58
|
+
*
|
|
59
|
+
* // Send events
|
|
60
|
+
* sseManager.send('request-123', 'INFO', 'Processing...');
|
|
61
|
+
* ```
|
|
62
|
+
*/
|
|
63
|
+
export declare class SSEManager {
|
|
64
|
+
private clients;
|
|
65
|
+
private readonly maxClientsPerRequest;
|
|
66
|
+
private readonly clientTimeoutMs;
|
|
67
|
+
private cleanupInterval;
|
|
68
|
+
constructor(options?: SSEManagerOptions);
|
|
69
|
+
/**
|
|
70
|
+
* Adds a client to the SSE manager
|
|
71
|
+
*
|
|
72
|
+
* @param requestId - Unique request ID
|
|
73
|
+
* @param res - Express Response object
|
|
74
|
+
* @returns true if client was added, false if rejected (limit reached)
|
|
75
|
+
*/
|
|
76
|
+
addClient(requestId: string, res: Response): boolean;
|
|
77
|
+
/**
|
|
78
|
+
* Removes a client from the manager
|
|
79
|
+
*/
|
|
80
|
+
private removeClient;
|
|
81
|
+
/**
|
|
82
|
+
* Sends a message to all SSE clients for a requestId
|
|
83
|
+
*
|
|
84
|
+
* @param requestId - Request ID
|
|
85
|
+
* @param type - Event type
|
|
86
|
+
* @param message - Message string
|
|
87
|
+
* @param data - Optional additional data
|
|
88
|
+
* @returns Number of clients the message was sent to
|
|
89
|
+
*/
|
|
90
|
+
send(requestId: string, type: SSEEventType, message: string, data?: unknown): number;
|
|
91
|
+
/**
|
|
92
|
+
* Broadcast a message to all connected clients across all requests
|
|
93
|
+
*
|
|
94
|
+
* @param type - Event type
|
|
95
|
+
* @param message - Message string
|
|
96
|
+
* @param data - Optional additional data
|
|
97
|
+
* @returns Total number of clients the message was sent to
|
|
98
|
+
*/
|
|
99
|
+
broadcast(type: SSEEventType, message: string, data?: unknown): number;
|
|
100
|
+
/**
|
|
101
|
+
* Close all clients for a specific request
|
|
102
|
+
*
|
|
103
|
+
* @param requestId - Request ID to close
|
|
104
|
+
* @param finalMessage - Optional final message to send before closing
|
|
105
|
+
*/
|
|
106
|
+
closeRequest(requestId: string, finalMessage?: string): void;
|
|
107
|
+
/**
|
|
108
|
+
* Get statistics about current connections
|
|
109
|
+
*/
|
|
110
|
+
getStats(): SSEManagerStats;
|
|
111
|
+
/**
|
|
112
|
+
* Check if a request has any connected clients
|
|
113
|
+
*/
|
|
114
|
+
hasClients(requestId: string): boolean;
|
|
115
|
+
/**
|
|
116
|
+
* Get the number of clients for a specific request
|
|
117
|
+
*/
|
|
118
|
+
getClientCount(requestId: string): number;
|
|
119
|
+
/**
|
|
120
|
+
* Middleware to initialize SSE connection
|
|
121
|
+
*
|
|
122
|
+
* @example
|
|
123
|
+
* ```typescript
|
|
124
|
+
* app.get('/logs/:requestId', sseManager.middleware());
|
|
125
|
+
* ```
|
|
126
|
+
*/
|
|
127
|
+
middleware(): (req: {
|
|
128
|
+
params: {
|
|
129
|
+
requestId: string;
|
|
130
|
+
};
|
|
131
|
+
}, res: Response) => void;
|
|
132
|
+
/**
|
|
133
|
+
* Start periodic cleanup of stale connections
|
|
134
|
+
*/
|
|
135
|
+
private startCleanupInterval;
|
|
136
|
+
/**
|
|
137
|
+
* Clean up stale connections using single-pass partition.
|
|
138
|
+
* O(R × C) instead of O(R × C²), and avoids mutation-during-iteration.
|
|
139
|
+
*/
|
|
140
|
+
private cleanup;
|
|
141
|
+
/**
|
|
142
|
+
* Shutdown the SSE manager and close all connections
|
|
143
|
+
*/
|
|
144
|
+
shutdown(): void;
|
|
145
|
+
}
|