@autofleet/nitur 2.2.0-beta.2 → 2.2.0-beta.4
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/lib/health-manager/health-check-handlers.cjs +1 -1
- package/lib/health-manager/health-check-handlers.cjs.map +1 -1
- package/lib/health-manager/health-check-handlers.js +1 -1
- package/lib/health-manager/health-check-handlers.js.map +1 -1
- package/lib/health-manager/health-manager.cjs +1 -1
- package/lib/health-manager/health-manager.cjs.map +1 -1
- package/lib/health-manager/health-manager.d.cts +7 -0
- package/lib/health-manager/health-manager.d.ts +7 -0
- package/lib/health-manager/health-manager.js +1 -1
- package/lib/health-manager/health-manager.js.map +1 -1
- package/lib/health-manager/shutdown-handlers.cjs +1 -1
- package/lib/health-manager/shutdown-handlers.cjs.map +1 -1
- package/lib/health-manager/shutdown-handlers.js +1 -1
- package/lib/health-manager/shutdown-handlers.js.map +1 -1
- package/lib/health-manager/types.cjs.map +1 -1
- package/lib/health-manager/types.d.cts +16 -13
- package/lib/health-manager/types.d.ts +16 -13
- package/lib/health-manager/types.js.map +1 -1
- package/package.json +1 -1
- package/lib/utils.cjs +0 -2
- package/lib/utils.cjs.map +0 -1
- package/lib/utils.js +0 -2
- package/lib/utils.js.map +0 -1
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
const e=require(`./types.cjs`),t={[e.CLIENT_TYPES.REDIS]:async({client:e,name:t})=>{try{await e.ping()}catch(e){throw
|
|
1
|
+
const e=require(`./types.cjs`),t={[e.CLIENT_TYPES.REDIS]:async({client:e,name:t,logger:n})=>{try{await e.ping()}catch(e){throw n.error(`Redis ping error for '${t}': ${e instanceof Error?e.message:String(e)}`),e}},[e.CLIENT_TYPES.SEQUELIZE]:async({client:e,name:t,logger:n})=>{try{let[[t]]=await e.query(`SELECT 1 as status`);if(t?.status!==1)throw Error(`Unexpected query result`)}catch(e){throw n.error(`Sequelize health check error for '${t}': ${e instanceof Error?e.message:String(e)}`),e}},[e.CLIENT_TYPES.ELASTIC_SEARCH]:async({client:e,name:t,logger:n})=>{try{if(!await e.ping())throw Error(`Elasticsearch ping returned false`)}catch(e){throw n.error(`Elasticsearch health check error for '${t}': ${e instanceof Error?e.message:String(e)}`),e}},[e.CLIENT_TYPES.RABBIT]:async({client:e,name:t,logger:n})=>{try{if(!await e.isConnected())throw Error(`RabbitMQ is not connected`)}catch(e){throw n.error(`RabbitMQ health check error for '${t}': ${e instanceof Error?e.message:String(e)}`),e}}};exports.DEFAULT_CLIENT_HEALTHCHECK_FUNC_MAP=t;
|
|
2
2
|
//# sourceMappingURL=health-check-handlers.cjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"health-check-handlers.cjs","names":["DEFAULT_CLIENT_HEALTHCHECK_FUNC_MAP: Partial<Record<ClientType, (options: { client: any
|
|
1
|
+
{"version":3,"file":"health-check-handlers.cjs","names":["DEFAULT_CLIENT_HEALTHCHECK_FUNC_MAP: Partial<Record<ClientType, (options: { client: any; name: string; logger: LoggerInstanceManager; }) => any>>","CLIENT_TYPES"],"sources":["../../src/health-manager/health-check-handlers.ts"],"sourcesContent":["import type {\n RedisClient,\n SequelizeClient,\n ElasticsearchClient,\n RabbitMQClient,\n ClientType,\n} from './types';\nimport type { LoggerInstanceManager } from '@autofleet/logger';\nimport { CLIENT_TYPES } from './types';\n\nexport const DEFAULT_CLIENT_HEALTHCHECK_FUNC_MAP: Partial<Record<ClientType, (options: { client: any; name: string; logger: LoggerInstanceManager; }) => any>> = {\n [CLIENT_TYPES.REDIS]: async ({ client, name, logger }: { client: RedisClient; name: string; logger: LoggerInstanceManager; }) => {\n try {\n await client.ping();\n } catch (error) {\n logger.error(`Redis ping error for '${name}': ${error instanceof Error ? error.message : String(error)}`);\n throw error;\n }\n },\n [CLIENT_TYPES.SEQUELIZE]: async ({ client, name, logger }: { client: SequelizeClient; name: string; logger: LoggerInstanceManager; }) => {\n try {\n const [[result]] = await client.query('SELECT 1 as status');\n if (result?.status !== 1) {\n throw new Error('Unexpected query result');\n }\n } catch (error) {\n logger.error(`Sequelize health check error for '${name}': ${error instanceof Error ? error.message : String(error)}`);\n throw error;\n }\n },\n [CLIENT_TYPES.ELASTIC_SEARCH]: async ({ client, name, logger }: { client: ElasticsearchClient; name: string; logger: LoggerInstanceManager; }) => {\n try {\n const isAlive = await client.ping();\n if (!isAlive) {\n throw new Error('Elasticsearch ping returned false');\n }\n } catch (error) {\n logger.error(`Elasticsearch health check error for '${name}': ${error instanceof Error ? error.message : String(error)}`);\n throw error;\n }\n },\n [CLIENT_TYPES.RABBIT]: async ({ client, name, logger }: { client: RabbitMQClient; name: string; logger: LoggerInstanceManager; }) => {\n try {\n const isConnected = await client.isConnected();\n if (!isConnected) {\n throw new Error('RabbitMQ is not connected');\n }\n } catch (error) {\n logger.error(`RabbitMQ health check error for '${name}': ${error instanceof Error ? error.message : String(error)}`);\n throw error;\n }\n },\n};\n"],"mappings":"+BAUaA,EAAoJ,EAC9JC,EAAAA,aAAa,OAAQ,MAAO,CAAE,SAAQ,OAAM,YAAoF,CAC/H,GAAI,CACF,MAAM,EAAO,MAAM,OACZ,EAAO,CAEd,MADA,EAAO,MAAM,yBAAyB,EAAK,KAAK,aAAiB,MAAQ,EAAM,QAAU,OAAO,EAAM,GAAG,CACnG,KAGTA,EAAAA,aAAa,WAAY,MAAO,CAAE,SAAQ,OAAM,YAAwF,CACvI,GAAI,CACF,GAAM,CAAC,CAAC,IAAW,MAAM,EAAO,MAAM,qBAAqB,CAC3D,GAAI,GAAQ,SAAW,EACrB,MAAU,MAAM,0BAA0B,OAErC,EAAO,CAEd,MADA,EAAO,MAAM,qCAAqC,EAAK,KAAK,aAAiB,MAAQ,EAAM,QAAU,OAAO,EAAM,GAAG,CAC/G,KAGTA,EAAAA,aAAa,gBAAiB,MAAO,CAAE,SAAQ,OAAM,YAA4F,CAChJ,GAAI,CAEF,GAAI,CADY,MAAM,EAAO,MAAM,CAEjC,MAAU,MAAM,oCAAoC,OAE/C,EAAO,CAEd,MADA,EAAO,MAAM,yCAAyC,EAAK,KAAK,aAAiB,MAAQ,EAAM,QAAU,OAAO,EAAM,GAAG,CACnH,KAGTA,EAAAA,aAAa,QAAS,MAAO,CAAE,SAAQ,OAAM,YAAuF,CACnI,GAAI,CAEF,GAAI,CADgB,MAAM,EAAO,aAAa,CAE5C,MAAU,MAAM,4BAA4B,OAEvC,EAAO,CAEd,MADA,EAAO,MAAM,oCAAoC,EAAK,KAAK,aAAiB,MAAQ,EAAM,QAAU,OAAO,EAAM,GAAG,CAC9G,IAGX"}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{CLIENT_TYPES as e}from"./types.js";const t={[e.REDIS]:async({client:e,name:t})=>{try{await e.ping()}catch(e){throw
|
|
1
|
+
import{CLIENT_TYPES as e}from"./types.js";const t={[e.REDIS]:async({client:e,name:t,logger:n})=>{try{await e.ping()}catch(e){throw n.error(`Redis ping error for '${t}': ${e instanceof Error?e.message:String(e)}`),e}},[e.SEQUELIZE]:async({client:e,name:t,logger:n})=>{try{let[[t]]=await e.query(`SELECT 1 as status`);if(t?.status!==1)throw Error(`Unexpected query result`)}catch(e){throw n.error(`Sequelize health check error for '${t}': ${e instanceof Error?e.message:String(e)}`),e}},[e.ELASTIC_SEARCH]:async({client:e,name:t,logger:n})=>{try{if(!await e.ping())throw Error(`Elasticsearch ping returned false`)}catch(e){throw n.error(`Elasticsearch health check error for '${t}': ${e instanceof Error?e.message:String(e)}`),e}},[e.RABBIT]:async({client:e,name:t,logger:n})=>{try{if(!await e.isConnected())throw Error(`RabbitMQ is not connected`)}catch(e){throw n.error(`RabbitMQ health check error for '${t}': ${e instanceof Error?e.message:String(e)}`),e}}};export{t as DEFAULT_CLIENT_HEALTHCHECK_FUNC_MAP};
|
|
2
2
|
//# sourceMappingURL=health-check-handlers.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"health-check-handlers.js","names":["DEFAULT_CLIENT_HEALTHCHECK_FUNC_MAP: Partial<Record<ClientType, (options: { client: any
|
|
1
|
+
{"version":3,"file":"health-check-handlers.js","names":["DEFAULT_CLIENT_HEALTHCHECK_FUNC_MAP: Partial<Record<ClientType, (options: { client: any; name: string; logger: LoggerInstanceManager; }) => any>>"],"sources":["../../src/health-manager/health-check-handlers.ts"],"sourcesContent":["import type {\n RedisClient,\n SequelizeClient,\n ElasticsearchClient,\n RabbitMQClient,\n ClientType,\n} from './types';\nimport type { LoggerInstanceManager } from '@autofleet/logger';\nimport { CLIENT_TYPES } from './types';\n\nexport const DEFAULT_CLIENT_HEALTHCHECK_FUNC_MAP: Partial<Record<ClientType, (options: { client: any; name: string; logger: LoggerInstanceManager; }) => any>> = {\n [CLIENT_TYPES.REDIS]: async ({ client, name, logger }: { client: RedisClient; name: string; logger: LoggerInstanceManager; }) => {\n try {\n await client.ping();\n } catch (error) {\n logger.error(`Redis ping error for '${name}': ${error instanceof Error ? error.message : String(error)}`);\n throw error;\n }\n },\n [CLIENT_TYPES.SEQUELIZE]: async ({ client, name, logger }: { client: SequelizeClient; name: string; logger: LoggerInstanceManager; }) => {\n try {\n const [[result]] = await client.query('SELECT 1 as status');\n if (result?.status !== 1) {\n throw new Error('Unexpected query result');\n }\n } catch (error) {\n logger.error(`Sequelize health check error for '${name}': ${error instanceof Error ? error.message : String(error)}`);\n throw error;\n }\n },\n [CLIENT_TYPES.ELASTIC_SEARCH]: async ({ client, name, logger }: { client: ElasticsearchClient; name: string; logger: LoggerInstanceManager; }) => {\n try {\n const isAlive = await client.ping();\n if (!isAlive) {\n throw new Error('Elasticsearch ping returned false');\n }\n } catch (error) {\n logger.error(`Elasticsearch health check error for '${name}': ${error instanceof Error ? error.message : String(error)}`);\n throw error;\n }\n },\n [CLIENT_TYPES.RABBIT]: async ({ client, name, logger }: { client: RabbitMQClient; name: string; logger: LoggerInstanceManager; }) => {\n try {\n const isConnected = await client.isConnected();\n if (!isConnected) {\n throw new Error('RabbitMQ is not connected');\n }\n } catch (error) {\n logger.error(`RabbitMQ health check error for '${name}': ${error instanceof Error ? error.message : String(error)}`);\n throw error;\n }\n },\n};\n"],"mappings":"0CAUA,MAAaA,EAAoJ,EAC9J,EAAa,OAAQ,MAAO,CAAE,SAAQ,OAAM,YAAoF,CAC/H,GAAI,CACF,MAAM,EAAO,MAAM,OACZ,EAAO,CAEd,MADA,EAAO,MAAM,yBAAyB,EAAK,KAAK,aAAiB,MAAQ,EAAM,QAAU,OAAO,EAAM,GAAG,CACnG,KAGT,EAAa,WAAY,MAAO,CAAE,SAAQ,OAAM,YAAwF,CACvI,GAAI,CACF,GAAM,CAAC,CAAC,IAAW,MAAM,EAAO,MAAM,qBAAqB,CAC3D,GAAI,GAAQ,SAAW,EACrB,MAAU,MAAM,0BAA0B,OAErC,EAAO,CAEd,MADA,EAAO,MAAM,qCAAqC,EAAK,KAAK,aAAiB,MAAQ,EAAM,QAAU,OAAO,EAAM,GAAG,CAC/G,KAGT,EAAa,gBAAiB,MAAO,CAAE,SAAQ,OAAM,YAA4F,CAChJ,GAAI,CAEF,GAAI,CADY,MAAM,EAAO,MAAM,CAEjC,MAAU,MAAM,oCAAoC,OAE/C,EAAO,CAEd,MADA,EAAO,MAAM,yCAAyC,EAAK,KAAK,aAAiB,MAAQ,EAAM,QAAU,OAAO,EAAM,GAAG,CACnH,KAGT,EAAa,QAAS,MAAO,CAAE,SAAQ,OAAM,YAAuF,CACnI,GAAI,CAEF,GAAI,CADgB,MAAM,EAAO,aAAa,CAE5C,MAAU,MAAM,4BAA4B,OAEvC,EAAO,CAEd,MADA,EAAO,MAAM,oCAAoC,EAAK,KAAK,aAAiB,MAAQ,EAAM,QAAU,OAAO,EAAM,GAAG,CAC9G,IAGX"}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
const e=require(`../_virtual/rolldown_runtime.cjs`),t=require(`./health-check-handlers.cjs`),n=require(`./shutdown-handlers.cjs`)
|
|
1
|
+
const e=require(`../_virtual/rolldown_runtime.cjs`),t=require(`./health-check-handlers.cjs`),n=require(`./shutdown-handlers.cjs`);let r=require(`node:timers/promises`),i=require(`@autofleet/errors`);var a=class{constructor(e){this.DEFAULT_CLIENT_OPTIONS={includeInLivenessCheck:!0,includeInReadinessCheck:!0},this.DEFAULT_SERVER_OPTIONS={runDefaultShutdownHandler:!0,name:`server`},this.DEFAULT_CONFIG={shutdownDelayMs:5e3,useExit0:!0,shouldSetupSignalHandlers:!0,enableLivenessOptimization:!0},this.isShuttingDown=!1,this.isReady=!1,this.clientsMap=new Map,this.livenessChecks=[],this.readinessChecks=[],this.canSafelySkipLivenessWhenReady=(e,t)=>!(e&&!t),this.config={...this.DEFAULT_CONFIG,...e.config??{}},this.logger=e.logger,e.server&&this.attachServer(e.server),this.storeClientsWithDefaults(e),this.initializeHealthChecks(),this.config.shouldSetupSignalHandlers&&this.setupSignalHandlers()}storeClientsWithDefaults(e){let r=e.clients;r&&Object.entries(r).forEach(([e,r])=>{if(!r)return;let i=(Array.isArray(r)?r:[r]).map(r=>{let i={...this.DEFAULT_CLIENT_OPTIONS,name:e,...r.options},a=t.DEFAULT_CLIENT_HEALTHCHECK_FUNC_MAP[e],o;r.healthCheck?o=r.healthCheck:a?o=e=>a({client:e.client,name:e.name,logger:this.logger}):(this.logger.warn(`No health check provided for client type '${e}' and no default implementation exists`),o=void 0);let s=n.DEFAULT_CLIENT_SHUTDOWN_HANDLERS_MAP[e],c;return r.shutdown?c=r.shutdown:s?c=e=>s({client:e.client,signal:e.signal,name:e.name,logger:this.logger}):(this.logger.warn(`No shutdown handler provided for client type '${e}' and no default implementation exists`),c=void 0),{connection:r.connection,healthCheck:o,shutdown:c,options:i}});this.clientsMap.set(e,i)})}setupSignalHandlers(){this.logger.info(`Setting up global signal listeners for graceful shutdown`),process.on(`SIGTERM`,async()=>{await this.shutdown(`SIGTERM`)}),process.on(`SIGINT`,async()=>{await this.shutdown(`SIGINT`)})}initializeHealthChecks(){let e=!0;this.clientsMap.forEach(t=>{t.forEach(t=>{if(!t.healthCheck)return;let n=t.options?.includeInLivenessCheck??!0,r=t.options?.includeInReadinessCheck??!0;this.canSafelySkipLivenessWhenReady(n,r)||(e=!1),n&&this.livenessChecks.push({check:t.healthCheck,client:t.connection,name:t.options?.name||`unknown`,customHandlersPayload:t.options?.customHandlersPayload}),r&&this.readinessChecks.push({check:t.healthCheck,client:t.connection,name:t.options?.name||`unknown`,customHandlersPayload:t.options?.customHandlersPayload})})}),this.config.enableLivenessOptimization=this.config.enableLivenessOptimization&&e,this.config.enableLivenessOptimization?this.logger.info(`Liveness check optimization enabled - liveness checks will be skipped when pod is ready`):e||this.logger.warn(`Liveness check optimization disabled - some clients are in liveness checks but not in readiness checks`)}attachServer(e){this.server={server:e.server,shutdown:e.shutdown??(async()=>n.defaultServerShutdownHandler(e.server,this.logger)),options:{...this.DEFAULT_SERVER_OPTIONS,...e.options??{}}}}async aliveCheck(){if(this.isShuttingDown||this.config.enableLivenessOptimization&&this.isReady)return{statusCode:200,status:`ok`};try{return await Promise.all(this.livenessChecks.map(({check:e,client:t,name:n,customHandlersPayload:r})=>e({client:t,name:n,customHandlersPayload:r}))),{statusCode:200,status:`ok`}}catch(e){let t=new i.ServiceUnavailableError(`Liveness probe failed: ${e.message}`);throw t.stack=e.stack,t}}async readyCheck(){if(this.isShuttingDown)throw this.isReady=!1,new i.ServiceUnavailableError(`Readiness probe failed: Application is shutting down`);try{return await Promise.all(this.readinessChecks.map(({check:e,client:t,name:n,customHandlersPayload:r})=>e({client:t,name:n,customHandlersPayload:r}))),this.isReady=!0,{statusCode:200,status:`ok`}}catch(e){this.isReady=!1;let t=new i.ServiceUnavailableError(`Readiness probe failed: ${e.message}`);throw t.stack=e.stack,t}}async shutdown(e=`MANUAL`){try{if(this.isShuttingDown){this.logger.warn(`Shutdown already in progress`);return}let{shutdownDelayMs:t,useExit0:n,onShutdown:i,beforeShutdown:a}=this.config;this.isShuttingDown=!0,this.isReady=!1,this.logger.info(`${e} received: setting readiness state to false`),await a?.(),this.logger.info(`Waiting ${t}ms before shutdown...`),await(0,r.setTimeout)(t);let o=[];this.clientsMap.forEach(e=>{e.forEach(e=>{e.shutdown&&o.push(e.options?.name||`unknown`)})}),this.logger.info(`Executing shutdown hooks...`,{clients:o});let s=[];this.clientsMap.forEach(t=>{t.forEach(t=>{t.shutdown&&s.push(t.shutdown({signal:e,client:t.connection,name:t.options?.name||`unknown`,customHandlersPayload:t.options?.customHandlersPayload}))})}),await Promise.allSettled(s),await i?.(),this.server?.options?.runDefaultShutdownHandler&&(this.logger.info(`Shutting down server...`),await this.server?.shutdown?.()),this.logger.info(`Shutdown process completed`),n&&(this.logger.info(`Exiting process after ${e}`),process.exit(0))}catch(t){this.logger.error(`Error during shutdown process, forcing process exit despite shutdown error`,{error:t,signal:e}),process.exit(1)}}};exports.HealthManager=a;
|
|
2
2
|
//# sourceMappingURL=health-manager.cjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"health-manager.cjs","names":["client","DEFAULT_CLIENT_HEALTHCHECK_FUNC_MAP","DEFAULT_CLIENT_SHUTDOWN_HANDLERS_MAP","defaultServerShutdownHandler","timeoutPromise","ServiceUnavailableError","clientNames: string[]","shutdownPromises: Promise<any>[]"],"sources":["../../src/health-manager/health-manager.ts"],"sourcesContent":["import { setTimeout } from 'node:timers/promises';\nimport { ServiceUnavailableError } from '@autofleet/errors';\nimport type {\n ClientConfig,\n HealthManagerConfig,\n HealthManagerOptions,\n ClientType,\n ServerConfig,\n} from './types';\nimport { DEFAULT_CLIENT_HEALTHCHECK_FUNC_MAP } from './health-check-handlers';\nimport { DEFAULT_CLIENT_SHUTDOWN_HANDLERS_MAP, defaultServerShutdownHandler } from './shutdown-handlers';\nimport { timeoutPromise } from '../utils';\n\n/**\n * Manages application health state and graceful shutdown for Kubernetes liveness/readiness probes\n *\n * Features:\n * - Provides aliveCheck() and readyCheck() methods for liveness/readiness probes\n * - Auto-registers SIGTERM/SIGINT handlers for graceful shutdown\n * - Manages ready state during shutdown to fail readiness probes\n */\nexport class HealthManager {\n private readonly DEFAULT_CLIENT_OPTIONS = {\n includeInLivenessCheck: true,\n includeInReadinessCheck: true,\n };\n\n private readonly DEFAULT_SERVER_OPTIONS = {\n runDefaultShutdownHandler: true,\n name: 'server',\n };\n\n private readonly DEFAULT_CONFIG: HealthManagerConfig = {\n shutdownDelayMs: 5_000,\n useExit0: true,\n shouldSetupSignalHandlers: true,\n livenessPeriodMs: 10_000,\n readinessPeriodMs: 5_000,\n enableLivenessOptimization: true,\n };\n\n private isShuttingDown: boolean = false;\n private isReady: boolean = false;\n\n private config: HealthManagerConfig;\n\n private clientsMap: Map<string, ClientConfig<any>[]> = new Map();\n private server: Required<ServerConfig> | undefined;\n\n private livenessChecks: Array<() => Promise<void>> = [];\n private readinessChecks: Array<() => Promise<void>> = [];\n\n private logger: any;\n\n /**\n * Creates a new HealthManager instance\n *\n * @param params Configuration options for health checks and shutdown behavior\n */\n constructor(params: HealthManagerOptions) {\n this.config = {\n ...this.DEFAULT_CONFIG,\n ...(params.config ?? {}),\n };\n\n this.logger = params.logger;\n if (params.server) {\n this.attachServer(params.server);\n }\n\n this.storeClientsWithDefaults(params);\n\n this.initializeHealthChecks();\n\n if (this.config.shouldSetupSignalHandlers) {\n this.setupSignalHandlers();\n }\n }\n\n /**\n * Store clients with default health check and shutdown functions\n * @private\n */\n private storeClientsWithDefaults(params: HealthManagerOptions): void {\n const clients = params.clients;\n if (!clients) {\n return;\n }\n\n Object.entries(clients).forEach(([type, client]) => {\n if (!client) {\n return;\n }\n\n const clientsArray = Array.isArray(client) ? client : [client];\n\n // Apply default values to each client config\n const clientsWithDefaults = clientsArray.map((client) => {\n const options = {\n ...this.DEFAULT_CLIENT_OPTIONS,\n name: type,\n ...client.options,\n };\n\n const defaultHealthCheck = DEFAULT_CLIENT_HEALTHCHECK_FUNC_MAP[type as ClientType];\n const healthCheck = client.healthCheck ?? (defaultHealthCheck ? () => defaultHealthCheck({ client: client.connection, name: options.name }) : undefined);\n\n const defaultShutdown = DEFAULT_CLIENT_SHUTDOWN_HANDLERS_MAP[type as ClientType];\n const shutdown = client.shutdown ?? (defaultShutdown ? (signal?: string) => defaultShutdown({ client: client.connection, signal, name: options.name }) : undefined);\n\n return {\n connection: client.connection,\n healthCheck,\n shutdown,\n options,\n };\n });\n\n this.clientsMap.set(type, clientsWithDefaults);\n });\n }\n\n /**\n * Register SIGTERM and SIGINT signal listeners\n * @private\n */\n private setupSignalHandlers(): void {\n this.logger.info('Setting up global signal listeners for graceful shutdown');\n\n process.on('SIGTERM', async () => {\n await this.shutdown('SIGTERM');\n });\n\n process.on('SIGINT', async () => {\n await this.shutdown('SIGINT');\n });\n }\n\n /**\n * Initialize health check arrays based on configured clients\n * @private\n */\n private initializeHealthChecks(): void {\n let allClientsInBothChecks = true;\n\n this.clientsMap.forEach((clients) => {\n clients.forEach((client) => {\n if (!client.healthCheck) {\n return;\n }\n\n const includeInLiveness = client.options?.includeInLivenessCheck ?? true;\n const includeInReadiness = client.options?.includeInReadinessCheck ?? true;\n\n // Check if all clients are included in both checks\n if (!includeInLiveness || !includeInReadiness) {\n allClientsInBothChecks = false;\n }\n\n if (includeInLiveness) {\n this.livenessChecks.push(client.healthCheck);\n }\n\n if (includeInReadiness) {\n this.readinessChecks.push(client.healthCheck);\n }\n });\n });\n\n // Safety mechanism: Only enable optimization if all clients are in both checks to prevent skipping liveness checks for clients that aren't in readiness\n this.config.enableLivenessOptimization = this.config.enableLivenessOptimization && allClientsInBothChecks;\n\n if (this.config.enableLivenessOptimization) {\n if (!allClientsInBothChecks) {\n this.logger.warn('Liveness check optimization disabled - not all clients are in both liveness and readiness checks');\n } else {\n this.logger.info('Liveness check optimization enabled - liveness checks will be skipped when pod is ready');\n }\n }\n }\n\n /**\n * Attach an HTTP or HTTPS server to be managed during shutdown\n * @param serverConfig Server configuration including the server instance and optional shutdown handler\n */\n attachServer(serverConfig: ServerConfig): void {\n this.server = {\n server: serverConfig.server,\n shutdown: serverConfig.shutdown ?? (async () => defaultServerShutdownHandler(serverConfig.server)),\n options: {\n ...this.DEFAULT_SERVER_OPTIONS,\n ...(serverConfig.options ?? {}),\n },\n };\n }\n\n /**\n * Performs liveness health checks for clients configured with includeInLivenessCheck\n *\n * @returns Promise that resolves to { status: 'ok', statusCode: 200 } on success\n * @throws ServiceUnavailableError with statusCode 503 if any health check fails\n */\n async aliveCheck(): Promise<{ status: string, statusCode: number }> {\n if (this.isShuttingDown) {\n return { statusCode: 200, status: 'ok' };\n }\n\n // Skip liveness check if optimization is enabled and pod is already ready\n if (this.config.enableLivenessOptimization && this.isReady) {\n return { statusCode: 200, status: 'ok' };\n }\n\n try {\n const livenessPromises = Promise.all(this.livenessChecks.map(check => check()));\n\n await Promise.race([\n livenessPromises,\n timeoutPromise(this.config.livenessPeriodMs ?? 10_000, 'Liveness check timed out'),\n ]);\n\n return { statusCode: 200, status: 'ok' };\n } catch (error) {\n const message = error instanceof Error ? error.message : String(error);\n throw new ServiceUnavailableError(`Liveness probe failed: ${message}`);\n }\n }\n\n /**\n * Performs readiness health checks for clients configured with includeInReadinessCheck\n *\n * @returns Promise that resolves to { status: 'ok', statusCode: 200 } if ready\n * @throws ServiceUnavailableError with statusCode 503 if not ready or health check fails\n */\n async readyCheck(): Promise<{ status: string, statusCode: number }> {\n if (this.isShuttingDown) {\n this.isReady = false;\n throw new ServiceUnavailableError('Readiness probe failed: Application is shutting down');\n }\n\n try {\n const readinessPromises = Promise.all(this.readinessChecks.map(check => check()));\n\n await Promise.race([\n readinessPromises,\n timeoutPromise(this.config.readinessPeriodMs ?? 5_000, 'Readiness check timed out'),\n ]);\n this.isReady = true;\n\n return { statusCode: 200, status: 'ok' };\n } catch (error) {\n this.isReady = false;\n const message = error instanceof Error ? error.message : String(error);\n throw new ServiceUnavailableError(`Readiness probe failed: ${message}`);\n }\n }\n\n /**\n * Triggers graceful shutdown process\n * Can be called manually or automatically via SIGTERM/SIGINT signal handlers\n *\n * @param signal - Signal name (e.g., 'SIGTERM', 'SIGINT', 'MANUAL')\n */\n async shutdown(signal: string = 'MANUAL'): Promise<void> {\n if (this.isShuttingDown) {\n this.logger.warn('Shutdown already in progress');\n return;\n }\n\n const { shutdownDelayMs, useExit0, onShutdown, beforeShutdown } = this.config;\n\n this.isShuttingDown = true;\n this.isReady = false;\n\n this.logger.info(`${signal} received: setting readiness state to false`);\n\n await beforeShutdown?.();\n\n this.logger.info(`Waiting ${shutdownDelayMs}ms before shutdown...`);\n await setTimeout(shutdownDelayMs)\n\n // Collect client names that have shutdown handlers\n const clientNames: string[] = [];\n this.clientsMap.forEach((clients) => {\n clients.forEach((client) => {\n if (client.shutdown) {\n clientNames.push(client.options?.name || 'unknown');\n }\n });\n });\n\n this.logger.info('Executing shutdown hooks...', { clients: clientNames });\n\n const shutdownPromises: Promise<any>[] = [];\n this.clientsMap.forEach((clients) => {\n clients.forEach((client) => {\n if (client.shutdown) {\n shutdownPromises.push(client.shutdown(signal));\n }\n });\n });\n\n await Promise.allSettled(shutdownPromises);\n\n await onShutdown?.();\n\n if (this.server?.options?.runDefaultShutdownHandler) {\n this.logger.info('Shutting down server...');\n await this.server?.shutdown?.();\n }\n\n this.logger.info('Shutdown process completed');\n\n if (useExit0) {\n this.logger.info(`Exiting process after ${signal}`);\n process.exit(0);\n }\n }\n}"],"mappings":"iOAqBA,IAAa,EAAb,KAA2B,CAsCzB,YAAY,EAA8B,6BArCA,CACxC,uBAAwB,GACxB,wBAAyB,GAC1B,6BAEyC,CACxC,0BAA2B,GAC3B,KAAM,SACP,qBAEsD,CACrD,gBAAiB,IACjB,SAAU,GACV,0BAA2B,GAC3B,iBAAkB,IAClB,kBAAmB,IACnB,2BAA4B,GAC7B,qBAEiC,gBACP,mBAI4B,IAAI,wBAGN,EAAE,sBACD,EAAE,CAUtD,KAAK,OAAS,CACZ,GAAG,KAAK,eACR,GAAI,EAAO,QAAU,EAAE,CACxB,CAED,KAAK,OAAS,EAAO,OACjB,EAAO,QACT,KAAK,aAAa,EAAO,OAAO,CAGlC,KAAK,yBAAyB,EAAO,CAErC,KAAK,wBAAwB,CAEzB,KAAK,OAAO,2BACd,KAAK,qBAAqB,CAQ9B,yBAAiC,EAAoC,CACnE,IAAM,EAAU,EAAO,QAClB,GAIL,OAAO,QAAQ,EAAQ,CAAC,SAAS,CAAC,EAAM,KAAY,CAClD,GAAI,CAAC,EACH,OAMF,IAAM,GAHe,MAAM,QAAQ,EAAO,CAAG,EAAS,CAAC,EAAO,EAGrB,IAAK,GAAW,CACvD,IAAM,EAAU,CACd,GAAG,KAAK,uBACR,KAAM,EACN,GAAGA,EAAO,QACX,CAEK,EAAqBC,EAAAA,oCAAoC,GACzD,EAAcD,EAAO,cAAgB,MAA2B,EAAmB,CAAE,OAAQA,EAAO,WAAY,KAAM,EAAQ,KAAM,CAAC,CAAG,IAAA,IAExI,EAAkBE,EAAAA,qCAAqC,GACvD,EAAWF,EAAO,WAAa,EAAmB,GAAoB,EAAgB,CAAE,OAAQA,EAAO,WAAY,SAAQ,KAAM,EAAQ,KAAM,CAAC,CAAG,IAAA,IAEzJ,MAAO,CACL,WAAYA,EAAO,WACnB,cACA,WACA,UACD,EACD,CAEF,KAAK,WAAW,IAAI,EAAM,EAAoB,EAC9C,CAOJ,qBAAoC,CAClC,KAAK,OAAO,KAAK,2DAA2D,CAE5E,QAAQ,GAAG,UAAW,SAAY,CAChC,MAAM,KAAK,SAAS,UAAU,EAC9B,CAEF,QAAQ,GAAG,SAAU,SAAY,CAC/B,MAAM,KAAK,SAAS,SAAS,EAC7B,CAOJ,wBAAuC,CACrC,IAAI,EAAyB,GAE7B,KAAK,WAAW,QAAS,GAAY,CACnC,EAAQ,QAAS,GAAW,CAC1B,GAAI,CAAC,EAAO,YACV,OAGF,IAAM,EAAoB,EAAO,SAAS,wBAA0B,GAC9D,EAAqB,EAAO,SAAS,yBAA2B,IAGlE,CAAC,GAAqB,CAAC,KACzB,EAAyB,IAGvB,GACF,KAAK,eAAe,KAAK,EAAO,YAAY,CAG1C,GACF,KAAK,gBAAgB,KAAK,EAAO,YAAY,EAE/C,EACF,CAGF,KAAK,OAAO,2BAA6B,KAAK,OAAO,4BAA8B,EAE/E,KAAK,OAAO,6BACT,EAGH,KAAK,OAAO,KAAK,0FAA0F,CAF3G,KAAK,OAAO,KAAK,mGAAmG,EAW1H,aAAa,EAAkC,CAC7C,KAAK,OAAS,CACZ,OAAQ,EAAa,OACrB,SAAU,EAAa,WAAa,SAAYG,EAAAA,6BAA6B,EAAa,OAAO,EACjG,QAAS,CACP,GAAG,KAAK,uBACR,GAAI,EAAa,SAAW,EAAE,CAC/B,CACF,CASH,MAAM,YAA8D,CAMlE,GALI,KAAK,gBAKL,KAAK,OAAO,4BAA8B,KAAK,QACjD,MAAO,CAAE,WAAY,IAAK,OAAQ,KAAM,CAG1C,GAAI,CACF,IAAM,EAAmB,QAAQ,IAAI,KAAK,eAAe,IAAI,GAAS,GAAO,CAAC,CAAC,CAO/E,OALA,MAAM,QAAQ,KAAK,CACjB,EACAC,EAAAA,eAAe,KAAK,OAAO,kBAAoB,IAAQ,2BAA2B,CACnF,CAAC,CAEK,CAAE,WAAY,IAAK,OAAQ,KAAM,OACjC,EAAO,CAEd,MAAM,IAAIC,EAAAA,wBAAwB,0BADlB,aAAiB,MAAQ,EAAM,QAAU,OAAO,EAAM,GACA,EAU1E,MAAM,YAA8D,CAClE,GAAI,KAAK,eAEP,KADA,MAAK,QAAU,GACT,IAAIA,EAAAA,wBAAwB,uDAAuD,CAG3F,GAAI,CACF,IAAM,EAAoB,QAAQ,IAAI,KAAK,gBAAgB,IAAI,GAAS,GAAO,CAAC,CAAC,CAQjF,OANA,MAAM,QAAQ,KAAK,CACjB,EACAD,EAAAA,eAAe,KAAK,OAAO,mBAAqB,IAAO,4BAA4B,CACpF,CAAC,CACF,KAAK,QAAU,GAER,CAAE,WAAY,IAAK,OAAQ,KAAM,OACjC,EAAO,CAGd,KAFA,MAAK,QAAU,GAET,IAAIC,EAAAA,wBAAwB,2BADlB,aAAiB,MAAQ,EAAM,QAAU,OAAO,EAAM,GACC,EAU3E,MAAM,SAAS,EAAiB,SAAyB,CACvD,GAAI,KAAK,eAAgB,CACvB,KAAK,OAAO,KAAK,+BAA+B,CAChD,OAGF,GAAM,CAAE,kBAAiB,WAAU,aAAY,kBAAmB,KAAK,OAEvE,KAAK,eAAiB,GACtB,KAAK,QAAU,GAEf,KAAK,OAAO,KAAK,GAAG,EAAO,6CAA6C,CAExE,MAAM,KAAkB,CAExB,KAAK,OAAO,KAAK,WAAW,EAAgB,uBAAuB,CACnE,MAAA,EAAA,EAAA,YAAiB,EAAgB,CAGjC,IAAMC,EAAwB,EAAE,CAChC,KAAK,WAAW,QAAS,GAAY,CACnC,EAAQ,QAAS,GAAW,CACtB,EAAO,UACT,EAAY,KAAK,EAAO,SAAS,MAAQ,UAAU,EAErD,EACF,CAEF,KAAK,OAAO,KAAK,8BAA+B,CAAE,QAAS,EAAa,CAAC,CAEzE,IAAMC,EAAmC,EAAE,CAC3C,KAAK,WAAW,QAAS,GAAY,CACnC,EAAQ,QAAS,GAAW,CACtB,EAAO,UACT,EAAiB,KAAK,EAAO,SAAS,EAAO,CAAC,EAEhD,EACF,CAEF,MAAM,QAAQ,WAAW,EAAiB,CAE1C,MAAM,KAAc,CAEhB,KAAK,QAAQ,SAAS,4BACxB,KAAK,OAAO,KAAK,0BAA0B,CAC3C,MAAM,KAAK,QAAQ,YAAY,EAGjC,KAAK,OAAO,KAAK,6BAA6B,CAE1C,IACF,KAAK,OAAO,KAAK,yBAAyB,IAAS,CACnD,QAAQ,KAAK,EAAE"}
|
|
1
|
+
{"version":3,"file":"health-manager.cjs","names":["client","DEFAULT_CLIENT_HEALTHCHECK_FUNC_MAP","healthCheck: ((options: { client: any; name: string; customHandlersPayload?: any; }) => Promise<void>) | undefined","options","DEFAULT_CLIENT_SHUTDOWN_HANDLERS_MAP","shutdown: ((options: { signal?: string; client: any; name: string; customHandlersPayload?: any; }) => Promise<void>) | undefined","defaultServerShutdownHandler","error: any","ServiceUnavailableError","clientNames: string[]","shutdownPromises: Promise<any>[]"],"sources":["../../src/health-manager/health-manager.ts"],"sourcesContent":["import { setTimeout } from 'node:timers/promises';\nimport { ServiceUnavailableError } from '@autofleet/errors';\nimport type {\n ClientConfig,\n HealthManagerConfig,\n HealthManagerOptions,\n ClientType,\n ServerConfig,\n} from './types';\nimport type { LoggerInstanceManager } from '@autofleet/logger';\nimport { DEFAULT_CLIENT_HEALTHCHECK_FUNC_MAP } from './health-check-handlers';\nimport { DEFAULT_CLIENT_SHUTDOWN_HANDLERS_MAP, defaultServerShutdownHandler } from './shutdown-handlers';\n\n/**\n * Manages application health state and graceful shutdown for Kubernetes liveness/readiness probes\n *\n * Features:\n * - Provides aliveCheck() and readyCheck() methods for liveness/readiness probes\n * - Auto-registers SIGTERM/SIGINT handlers for graceful shutdown\n * - Manages ready state during shutdown to fail readiness probes\n */\nexport class HealthManager {\n private readonly DEFAULT_CLIENT_OPTIONS = {\n includeInLivenessCheck: true,\n includeInReadinessCheck: true,\n };\n\n private readonly DEFAULT_SERVER_OPTIONS = {\n runDefaultShutdownHandler: true,\n name: 'server',\n };\n\n private readonly DEFAULT_CONFIG: HealthManagerConfig = {\n shutdownDelayMs: 5_000,\n useExit0: true,\n shouldSetupSignalHandlers: true,\n enableLivenessOptimization: true,\n };\n\n private isShuttingDown = false;\n private isReady = false;\n\n private config: HealthManagerConfig;\n\n private clientsMap = new Map<string, ClientConfig<any>[]>();\n private server: Required<ServerConfig> | undefined;\n\n private livenessChecks: { check: (options: { client: any; name: string; customHandlersPayload?: any; }) => Promise<void>; client: any; name: string; customHandlersPayload?: any; }[] = [];\n private readinessChecks: { check: (options: { client: any; name: string; customHandlersPayload?: any; }) => Promise<void>; client: any; name: string; customHandlersPayload?: any; }[] = [];\n\n private logger: LoggerInstanceManager;\n\n /**\n * Creates a new HealthManager instance\n *\n * @param params Configuration options for health checks and shutdown behavior\n */\n constructor(params: HealthManagerOptions) {\n this.config = {\n ...this.DEFAULT_CONFIG,\n ...(params.config ?? {}),\n };\n\n this.logger = params.logger;\n if (params.server) {\n this.attachServer(params.server);\n }\n\n this.storeClientsWithDefaults(params);\n\n this.initializeHealthChecks();\n\n if (this.config.shouldSetupSignalHandlers) {\n this.setupSignalHandlers();\n }\n }\n\n /**\n * Store clients with default health check and shutdown functions\n * @private\n */\n private storeClientsWithDefaults(params: HealthManagerOptions): void {\n const clients = params.clients;\n if (!clients) {\n return;\n }\n\n Object.entries(clients).forEach(([type, client]) => {\n if (!client) {\n return;\n }\n\n const clientsArray = Array.isArray(client) ? client : [client];\n\n // Apply default values to each client config\n const clientsWithDefaults = clientsArray.map((client) => {\n const options = {\n ...this.DEFAULT_CLIENT_OPTIONS,\n name: type,\n ...client.options,\n };\n\n const defaultHealthCheck = DEFAULT_CLIENT_HEALTHCHECK_FUNC_MAP[type as ClientType];\n let healthCheck: ((options: { client: any; name: string; customHandlersPayload?: any; }) => Promise<void>) | undefined;\n\n if (client.healthCheck) {\n healthCheck = client.healthCheck;\n } else if (defaultHealthCheck) {\n healthCheck = (options: { client: any; name: string; customHandlersPayload?: any; }) => defaultHealthCheck({ client: options.client, name: options.name, logger: this.logger });\n } else {\n this.logger.warn(`No health check provided for client type '${type}' and no default implementation exists`);\n healthCheck = undefined;\n }\n\n const defaultShutdown = DEFAULT_CLIENT_SHUTDOWN_HANDLERS_MAP[type as ClientType];\n let shutdown: ((options: { signal?: string; client: any; name: string; customHandlersPayload?: any; }) => Promise<void>) | undefined;\n\n if (client.shutdown) {\n shutdown = client.shutdown;\n } else if (defaultShutdown) {\n shutdown = (options: { signal?: string; client: any; name: string; customHandlersPayload?: any; }) => defaultShutdown(\n { client: options.client, signal: options.signal, name: options.name, logger: this.logger },\n );\n } else {\n this.logger.warn(`No shutdown handler provided for client type '${type}' and no default implementation exists`);\n shutdown = undefined;\n }\n\n return {\n connection: client.connection,\n healthCheck,\n shutdown,\n options,\n };\n });\n\n this.clientsMap.set(type, clientsWithDefaults);\n });\n }\n\n /**\n * Register SIGTERM and SIGINT signal listeners\n * @private\n */\n private setupSignalHandlers(): void {\n this.logger.info('Setting up global signal listeners for graceful shutdown');\n\n process.on('SIGTERM', async () => {\n await this.shutdown('SIGTERM');\n });\n\n process.on('SIGINT', async () => {\n await this.shutdown('SIGINT');\n });\n }\n\n /**\n * Check if liveness optimization is safe to enable for a given client configuration\n * If a client is in liveness but not readiness, we cannot skip liveness checks\n * because the optimization relies on readiness passing, but this client isn't checked in readiness\n * @private\n */\n private canSafelySkipLivenessWhenReady = (includeInLiveness: boolean, includeInReadiness: boolean): boolean =>\n !(includeInLiveness && !includeInReadiness);\n\n /**\n * Initialize health check arrays based on configured clients\n * @private\n */\n private initializeHealthChecks(): void {\n let allClientsAllowLivenessOptimization = true;\n\n this.clientsMap.forEach((clients) => {\n clients.forEach((client) => {\n if (!client.healthCheck) {\n return;\n }\n\n const includeInLiveness = client.options?.includeInLivenessCheck ?? true;\n const includeInReadiness = client.options?.includeInReadinessCheck ?? true;\n\n // Check if this client configuration allows liveness optimization\n if (!this.canSafelySkipLivenessWhenReady(includeInLiveness, includeInReadiness)) {\n allClientsAllowLivenessOptimization = false;\n }\n\n if (includeInLiveness) {\n this.livenessChecks.push({\n check: client.healthCheck,\n client: client.connection,\n name: client.options?.name || 'unknown',\n customHandlersPayload: client.options?.customHandlersPayload,\n });\n }\n\n if (includeInReadiness) {\n this.readinessChecks.push({\n check: client.healthCheck,\n client: client.connection,\n name: client.options?.name || 'unknown',\n customHandlersPayload: client.options?.customHandlersPayload,\n });\n }\n });\n });\n\n // Apply optimization setting: only enable if user requested it AND all clients allow it\n this.config.enableLivenessOptimization = this.config.enableLivenessOptimization && allClientsAllowLivenessOptimization;\n\n // Log optimization status\n if (this.config.enableLivenessOptimization) {\n this.logger.info('Liveness check optimization enabled - liveness checks will be skipped when pod is ready');\n } else if (!allClientsAllowLivenessOptimization) {\n this.logger.warn('Liveness check optimization disabled - some clients are in liveness checks but not in readiness checks');\n }\n }\n\n /**\n * Attach an HTTP or HTTPS server to be managed during shutdown\n * @param serverConfig Server configuration including the server instance and optional shutdown handler\n */\n attachServer(serverConfig: ServerConfig): void {\n this.server = {\n server: serverConfig.server,\n shutdown: serverConfig.shutdown ?? (async () => defaultServerShutdownHandler(serverConfig.server, this.logger)),\n options: {\n ...this.DEFAULT_SERVER_OPTIONS,\n ...(serverConfig.options ?? {}),\n },\n };\n }\n\n /**\n * Performs liveness health checks for clients configured with includeInLivenessCheck\n *\n * @returns Promise that resolves to { status: 'ok', statusCode: 200 } on success\n * @throws ServiceUnavailableError with statusCode 503 if any health check fails\n */\n async aliveCheck(): Promise<{ status: string; statusCode: number; }> {\n if (this.isShuttingDown) {\n return { statusCode: 200, status: 'ok' };\n }\n\n // Skip liveness check if optimization is enabled and pod is already ready\n if (this.config.enableLivenessOptimization && this.isReady) {\n return { statusCode: 200, status: 'ok' };\n }\n\n try {\n await Promise.all(\n this.livenessChecks.map(({ check, client, name, customHandlersPayload }) =>\n check({ client, name, customHandlersPayload }),\n ),\n );\n\n return { statusCode: 200, status: 'ok' };\n } catch (error: any) {\n const err = new ServiceUnavailableError(`Liveness probe failed: ${error.message}`);\n err.stack = error.stack;\n throw err;\n }\n }\n\n /**\n * Performs readiness health checks for clients configured with includeInReadinessCheck\n *\n * @returns Promise that resolves to { status: 'ok', statusCode: 200 } if ready\n * @throws ServiceUnavailableError with statusCode 503 if not ready or health check fails\n */\n async readyCheck(): Promise<{ status: string; statusCode: number; }> {\n if (this.isShuttingDown) {\n this.isReady = false;\n throw new ServiceUnavailableError('Readiness probe failed: Application is shutting down');\n }\n\n try {\n await Promise.all(\n this.readinessChecks.map(({ check, client, name, customHandlersPayload }) =>\n check({ client, name, customHandlersPayload }),\n ),\n );\n this.isReady = true;\n\n return { statusCode: 200, status: 'ok' };\n } catch (error: any) {\n this.isReady = false;\n const err = new ServiceUnavailableError(`Readiness probe failed: ${error.message}`);\n err.stack = error.stack;\n throw err;\n }\n }\n\n /**\n * Triggers graceful shutdown process\n * Can be called manually or automatically via SIGTERM/SIGINT signal handlers\n *\n * @param signal - Signal name (e.g., 'SIGTERM', 'SIGINT', 'MANUAL')\n */\n async shutdown(signal = 'MANUAL'): Promise<void> {\n try {\n if (this.isShuttingDown) {\n this.logger.warn('Shutdown already in progress');\n return;\n }\n\n const { shutdownDelayMs, useExit0, onShutdown, beforeShutdown } = this.config;\n\n this.isShuttingDown = true;\n this.isReady = false;\n\n this.logger.info(`${signal} received: setting readiness state to false`);\n\n await beforeShutdown?.();\n\n this.logger.info(`Waiting ${shutdownDelayMs}ms before shutdown...`);\n await setTimeout(shutdownDelayMs);\n\n // Collect client names that have shutdown handlers\n const clientNames: string[] = [];\n this.clientsMap.forEach((clients) => {\n clients.forEach((client) => {\n if (client.shutdown) {\n clientNames.push(client.options?.name || 'unknown');\n }\n });\n });\n\n this.logger.info('Executing shutdown hooks...', { clients: clientNames });\n\n const shutdownPromises: Promise<any>[] = [];\n this.clientsMap.forEach((clients) => {\n clients.forEach((client) => {\n if (client.shutdown) {\n shutdownPromises.push(client.shutdown({\n signal,\n client: client.connection,\n name: client.options?.name || 'unknown',\n customHandlersPayload: client.options?.customHandlersPayload,\n }));\n }\n });\n });\n\n await Promise.allSettled(shutdownPromises);\n\n await onShutdown?.();\n\n if (this.server?.options?.runDefaultShutdownHandler) {\n this.logger.info('Shutting down server...');\n await this.server?.shutdown?.();\n }\n\n this.logger.info('Shutdown process completed');\n\n if (useExit0) {\n this.logger.info(`Exiting process after ${signal}`);\n process.exit(0);\n }\n } catch (error: any) {\n this.logger.error('Error during shutdown process, forcing process exit despite shutdown error', { error, signal });\n process.exit(1);\n }\n }\n}\n"],"mappings":"uMAqBA,IAAa,EAAb,KAA2B,CAoCzB,YAAY,EAA8B,6BAnCA,CACxC,uBAAwB,GACxB,wBAAyB,GAC1B,6BAEyC,CACxC,0BAA2B,GAC3B,KAAM,SACP,qBAEsD,CACrD,gBAAiB,IACjB,SAAU,GACV,0BAA2B,GAC3B,2BAA4B,GAC7B,qBAEwB,gBACP,mBAIG,IAAI,wBAG+J,EAAE,sBACD,EAAE,sCAkHjJ,EAA4B,IACpE,EAAE,GAAqB,CAAC,GAzGxB,KAAK,OAAS,CACZ,GAAG,KAAK,eACR,GAAI,EAAO,QAAU,EAAE,CACxB,CAED,KAAK,OAAS,EAAO,OACjB,EAAO,QACT,KAAK,aAAa,EAAO,OAAO,CAGlC,KAAK,yBAAyB,EAAO,CAErC,KAAK,wBAAwB,CAEzB,KAAK,OAAO,2BACd,KAAK,qBAAqB,CAQ9B,yBAAiC,EAAoC,CACnE,IAAM,EAAU,EAAO,QAClB,GAIL,OAAO,QAAQ,EAAQ,CAAC,SAAS,CAAC,EAAM,KAAY,CAClD,GAAI,CAAC,EACH,OAMF,IAAM,GAHe,MAAM,QAAQ,EAAO,CAAG,EAAS,CAAC,EAAO,EAGrB,IAAK,GAAW,CACvD,IAAM,EAAU,CACd,GAAG,KAAK,uBACR,KAAM,EACN,GAAGA,EAAO,QACX,CAEK,EAAqBC,EAAAA,oCAAoC,GAC3DC,EAEAF,EAAO,YACT,EAAcA,EAAO,YACZ,EACT,EAAe,GAAyE,EAAmB,CAAE,OAAQG,EAAQ,OAAQ,KAAMA,EAAQ,KAAM,OAAQ,KAAK,OAAQ,CAAC,EAE/K,KAAK,OAAO,KAAK,6CAA6C,EAAK,wCAAwC,CAC3G,EAAc,IAAA,IAGhB,IAAM,EAAkBC,EAAAA,qCAAqC,GACzDC,EAaJ,OAXIL,EAAO,SACT,EAAWA,EAAO,SACT,EACT,EAAY,GAA0F,EACpG,CAAE,OAAQG,EAAQ,OAAQ,OAAQA,EAAQ,OAAQ,KAAMA,EAAQ,KAAM,OAAQ,KAAK,OAAQ,CAC5F,EAED,KAAK,OAAO,KAAK,iDAAiD,EAAK,wCAAwC,CAC/G,EAAW,IAAA,IAGN,CACL,WAAYH,EAAO,WACnB,cACA,WACA,UACD,EACD,CAEF,KAAK,WAAW,IAAI,EAAM,EAAoB,EAC9C,CAOJ,qBAAoC,CAClC,KAAK,OAAO,KAAK,2DAA2D,CAE5E,QAAQ,GAAG,UAAW,SAAY,CAChC,MAAM,KAAK,SAAS,UAAU,EAC9B,CAEF,QAAQ,GAAG,SAAU,SAAY,CAC/B,MAAM,KAAK,SAAS,SAAS,EAC7B,CAgBJ,wBAAuC,CACrC,IAAI,EAAsC,GAE1C,KAAK,WAAW,QAAS,GAAY,CACnC,EAAQ,QAAS,GAAW,CAC1B,GAAI,CAAC,EAAO,YACV,OAGF,IAAM,EAAoB,EAAO,SAAS,wBAA0B,GAC9D,EAAqB,EAAO,SAAS,yBAA2B,GAGjE,KAAK,+BAA+B,EAAmB,EAAmB,GAC7E,EAAsC,IAGpC,GACF,KAAK,eAAe,KAAK,CACvB,MAAO,EAAO,YACd,OAAQ,EAAO,WACf,KAAM,EAAO,SAAS,MAAQ,UAC9B,sBAAuB,EAAO,SAAS,sBACxC,CAAC,CAGA,GACF,KAAK,gBAAgB,KAAK,CACxB,MAAO,EAAO,YACd,OAAQ,EAAO,WACf,KAAM,EAAO,SAAS,MAAQ,UAC9B,sBAAuB,EAAO,SAAS,sBACxC,CAAC,EAEJ,EACF,CAGF,KAAK,OAAO,2BAA6B,KAAK,OAAO,4BAA8B,EAG/E,KAAK,OAAO,2BACd,KAAK,OAAO,KAAK,0FAA0F,CACjG,GACV,KAAK,OAAO,KAAK,yGAAyG,CAQ9H,aAAa,EAAkC,CAC7C,KAAK,OAAS,CACZ,OAAQ,EAAa,OACrB,SAAU,EAAa,WAAa,SAAYM,EAAAA,6BAA6B,EAAa,OAAQ,KAAK,OAAO,EAC9G,QAAS,CACP,GAAG,KAAK,uBACR,GAAI,EAAa,SAAW,EAAE,CAC/B,CACF,CASH,MAAM,YAA+D,CAMnE,GALI,KAAK,gBAKL,KAAK,OAAO,4BAA8B,KAAK,QACjD,MAAO,CAAE,WAAY,IAAK,OAAQ,KAAM,CAG1C,GAAI,CAOF,OANA,MAAM,QAAQ,IACZ,KAAK,eAAe,KAAK,CAAE,QAAO,SAAQ,OAAM,2BAC9C,EAAM,CAAE,SAAQ,OAAM,wBAAuB,CAAC,CAC/C,CACF,CAEM,CAAE,WAAY,IAAK,OAAQ,KAAM,OACjCC,EAAY,CACnB,IAAM,EAAM,IAAIC,EAAAA,wBAAwB,0BAA0B,EAAM,UAAU,CAElF,KADA,GAAI,MAAQ,EAAM,MACZ,GAUV,MAAM,YAA+D,CACnE,GAAI,KAAK,eAEP,KADA,MAAK,QAAU,GACT,IAAIA,EAAAA,wBAAwB,uDAAuD,CAG3F,GAAI,CAQF,OAPA,MAAM,QAAQ,IACZ,KAAK,gBAAgB,KAAK,CAAE,QAAO,SAAQ,OAAM,2BAC/C,EAAM,CAAE,SAAQ,OAAM,wBAAuB,CAAC,CAC/C,CACF,CACD,KAAK,QAAU,GAER,CAAE,WAAY,IAAK,OAAQ,KAAM,OACjCD,EAAY,CACnB,KAAK,QAAU,GACf,IAAM,EAAM,IAAIC,EAAAA,wBAAwB,2BAA2B,EAAM,UAAU,CAEnF,KADA,GAAI,MAAQ,EAAM,MACZ,GAUV,MAAM,SAAS,EAAS,SAAyB,CAC/C,GAAI,CACF,GAAI,KAAK,eAAgB,CACvB,KAAK,OAAO,KAAK,+BAA+B,CAChD,OAGF,GAAM,CAAE,kBAAiB,WAAU,aAAY,kBAAmB,KAAK,OAEvE,KAAK,eAAiB,GACtB,KAAK,QAAU,GAEf,KAAK,OAAO,KAAK,GAAG,EAAO,6CAA6C,CAExE,MAAM,KAAkB,CAExB,KAAK,OAAO,KAAK,WAAW,EAAgB,uBAAuB,CACnE,MAAA,EAAA,EAAA,YAAiB,EAAgB,CAGjC,IAAMC,EAAwB,EAAE,CAChC,KAAK,WAAW,QAAS,GAAY,CACnC,EAAQ,QAAS,GAAW,CACtB,EAAO,UACT,EAAY,KAAK,EAAO,SAAS,MAAQ,UAAU,EAErD,EACF,CAEF,KAAK,OAAO,KAAK,8BAA+B,CAAE,QAAS,EAAa,CAAC,CAEzE,IAAMC,EAAmC,EAAE,CAC3C,KAAK,WAAW,QAAS,GAAY,CACnC,EAAQ,QAAS,GAAW,CACtB,EAAO,UACT,EAAiB,KAAK,EAAO,SAAS,CACpC,SACA,OAAQ,EAAO,WACf,KAAM,EAAO,SAAS,MAAQ,UAC9B,sBAAuB,EAAO,SAAS,sBACxC,CAAC,CAAC,EAEL,EACF,CAEF,MAAM,QAAQ,WAAW,EAAiB,CAE1C,MAAM,KAAc,CAEhB,KAAK,QAAQ,SAAS,4BACxB,KAAK,OAAO,KAAK,0BAA0B,CAC3C,MAAM,KAAK,QAAQ,YAAY,EAGjC,KAAK,OAAO,KAAK,6BAA6B,CAE1C,IACF,KAAK,OAAO,KAAK,yBAAyB,IAAS,CACnD,QAAQ,KAAK,EAAE,QAEVH,EAAY,CACnB,KAAK,OAAO,MAAM,6EAA8E,CAAE,QAAO,SAAQ,CAAC,CAClH,QAAQ,KAAK,EAAE"}
|
|
@@ -39,6 +39,13 @@ declare class HealthManager {
|
|
|
39
39
|
*/
|
|
40
40
|
private setupSignalHandlers;
|
|
41
41
|
/**
|
|
42
|
+
* Check if liveness optimization is safe to enable for a given client configuration
|
|
43
|
+
* If a client is in liveness but not readiness, we cannot skip liveness checks
|
|
44
|
+
* because the optimization relies on readiness passing, but this client isn't checked in readiness
|
|
45
|
+
* @private
|
|
46
|
+
*/
|
|
47
|
+
private canSafelySkipLivenessWhenReady;
|
|
48
|
+
/**
|
|
42
49
|
* Initialize health check arrays based on configured clients
|
|
43
50
|
* @private
|
|
44
51
|
*/
|
|
@@ -39,6 +39,13 @@ declare class HealthManager {
|
|
|
39
39
|
*/
|
|
40
40
|
private setupSignalHandlers;
|
|
41
41
|
/**
|
|
42
|
+
* Check if liveness optimization is safe to enable for a given client configuration
|
|
43
|
+
* If a client is in liveness but not readiness, we cannot skip liveness checks
|
|
44
|
+
* because the optimization relies on readiness passing, but this client isn't checked in readiness
|
|
45
|
+
* @private
|
|
46
|
+
*/
|
|
47
|
+
private canSafelySkipLivenessWhenReady;
|
|
48
|
+
/**
|
|
42
49
|
* Initialize health check arrays based on configured clients
|
|
43
50
|
* @private
|
|
44
51
|
*/
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{DEFAULT_CLIENT_HEALTHCHECK_FUNC_MAP as e}from"./health-check-handlers.js";import{DEFAULT_CLIENT_SHUTDOWN_HANDLERS_MAP as t,defaultServerShutdownHandler as n}from"./shutdown-handlers.js";import{
|
|
1
|
+
import{DEFAULT_CLIENT_HEALTHCHECK_FUNC_MAP as e}from"./health-check-handlers.js";import{DEFAULT_CLIENT_SHUTDOWN_HANDLERS_MAP as t,defaultServerShutdownHandler as n}from"./shutdown-handlers.js";import{setTimeout as r}from"node:timers/promises";import{ServiceUnavailableError as i}from"@autofleet/errors";var a=class{constructor(e){this.DEFAULT_CLIENT_OPTIONS={includeInLivenessCheck:!0,includeInReadinessCheck:!0},this.DEFAULT_SERVER_OPTIONS={runDefaultShutdownHandler:!0,name:`server`},this.DEFAULT_CONFIG={shutdownDelayMs:5e3,useExit0:!0,shouldSetupSignalHandlers:!0,enableLivenessOptimization:!0},this.isShuttingDown=!1,this.isReady=!1,this.clientsMap=new Map,this.livenessChecks=[],this.readinessChecks=[],this.canSafelySkipLivenessWhenReady=(e,t)=>!(e&&!t),this.config={...this.DEFAULT_CONFIG,...e.config??{}},this.logger=e.logger,e.server&&this.attachServer(e.server),this.storeClientsWithDefaults(e),this.initializeHealthChecks(),this.config.shouldSetupSignalHandlers&&this.setupSignalHandlers()}storeClientsWithDefaults(n){let r=n.clients;r&&Object.entries(r).forEach(([n,r])=>{if(!r)return;let i=(Array.isArray(r)?r:[r]).map(r=>{let i={...this.DEFAULT_CLIENT_OPTIONS,name:n,...r.options},a=e[n],o;r.healthCheck?o=r.healthCheck:a?o=e=>a({client:e.client,name:e.name,logger:this.logger}):(this.logger.warn(`No health check provided for client type '${n}' and no default implementation exists`),o=void 0);let s=t[n],c;return r.shutdown?c=r.shutdown:s?c=e=>s({client:e.client,signal:e.signal,name:e.name,logger:this.logger}):(this.logger.warn(`No shutdown handler provided for client type '${n}' and no default implementation exists`),c=void 0),{connection:r.connection,healthCheck:o,shutdown:c,options:i}});this.clientsMap.set(n,i)})}setupSignalHandlers(){this.logger.info(`Setting up global signal listeners for graceful shutdown`),process.on(`SIGTERM`,async()=>{await this.shutdown(`SIGTERM`)}),process.on(`SIGINT`,async()=>{await this.shutdown(`SIGINT`)})}initializeHealthChecks(){let e=!0;this.clientsMap.forEach(t=>{t.forEach(t=>{if(!t.healthCheck)return;let n=t.options?.includeInLivenessCheck??!0,r=t.options?.includeInReadinessCheck??!0;this.canSafelySkipLivenessWhenReady(n,r)||(e=!1),n&&this.livenessChecks.push({check:t.healthCheck,client:t.connection,name:t.options?.name||`unknown`,customHandlersPayload:t.options?.customHandlersPayload}),r&&this.readinessChecks.push({check:t.healthCheck,client:t.connection,name:t.options?.name||`unknown`,customHandlersPayload:t.options?.customHandlersPayload})})}),this.config.enableLivenessOptimization=this.config.enableLivenessOptimization&&e,this.config.enableLivenessOptimization?this.logger.info(`Liveness check optimization enabled - liveness checks will be skipped when pod is ready`):e||this.logger.warn(`Liveness check optimization disabled - some clients are in liveness checks but not in readiness checks`)}attachServer(e){this.server={server:e.server,shutdown:e.shutdown??(async()=>n(e.server,this.logger)),options:{...this.DEFAULT_SERVER_OPTIONS,...e.options??{}}}}async aliveCheck(){if(this.isShuttingDown||this.config.enableLivenessOptimization&&this.isReady)return{statusCode:200,status:`ok`};try{return await Promise.all(this.livenessChecks.map(({check:e,client:t,name:n,customHandlersPayload:r})=>e({client:t,name:n,customHandlersPayload:r}))),{statusCode:200,status:`ok`}}catch(e){let t=new i(`Liveness probe failed: ${e.message}`);throw t.stack=e.stack,t}}async readyCheck(){if(this.isShuttingDown)throw this.isReady=!1,new i(`Readiness probe failed: Application is shutting down`);try{return await Promise.all(this.readinessChecks.map(({check:e,client:t,name:n,customHandlersPayload:r})=>e({client:t,name:n,customHandlersPayload:r}))),this.isReady=!0,{statusCode:200,status:`ok`}}catch(e){this.isReady=!1;let t=new i(`Readiness probe failed: ${e.message}`);throw t.stack=e.stack,t}}async shutdown(e=`MANUAL`){try{if(this.isShuttingDown){this.logger.warn(`Shutdown already in progress`);return}let{shutdownDelayMs:t,useExit0:n,onShutdown:i,beforeShutdown:a}=this.config;this.isShuttingDown=!0,this.isReady=!1,this.logger.info(`${e} received: setting readiness state to false`),await a?.(),this.logger.info(`Waiting ${t}ms before shutdown...`),await r(t);let o=[];this.clientsMap.forEach(e=>{e.forEach(e=>{e.shutdown&&o.push(e.options?.name||`unknown`)})}),this.logger.info(`Executing shutdown hooks...`,{clients:o});let s=[];this.clientsMap.forEach(t=>{t.forEach(t=>{t.shutdown&&s.push(t.shutdown({signal:e,client:t.connection,name:t.options?.name||`unknown`,customHandlersPayload:t.options?.customHandlersPayload}))})}),await Promise.allSettled(s),await i?.(),this.server?.options?.runDefaultShutdownHandler&&(this.logger.info(`Shutting down server...`),await this.server?.shutdown?.()),this.logger.info(`Shutdown process completed`),n&&(this.logger.info(`Exiting process after ${e}`),process.exit(0))}catch(t){this.logger.error(`Error during shutdown process, forcing process exit despite shutdown error`,{error:t,signal:e}),process.exit(1)}}};export{a as HealthManager};
|
|
2
2
|
//# sourceMappingURL=health-manager.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"health-manager.js","names":["client","clientNames: string[]","shutdownPromises: Promise<any>[]"],"sources":["../../src/health-manager/health-manager.ts"],"sourcesContent":["import { setTimeout } from 'node:timers/promises';\nimport { ServiceUnavailableError } from '@autofleet/errors';\nimport type {\n ClientConfig,\n HealthManagerConfig,\n HealthManagerOptions,\n ClientType,\n ServerConfig,\n} from './types';\nimport { DEFAULT_CLIENT_HEALTHCHECK_FUNC_MAP } from './health-check-handlers';\nimport { DEFAULT_CLIENT_SHUTDOWN_HANDLERS_MAP, defaultServerShutdownHandler } from './shutdown-handlers';\nimport { timeoutPromise } from '../utils';\n\n/**\n * Manages application health state and graceful shutdown for Kubernetes liveness/readiness probes\n *\n * Features:\n * - Provides aliveCheck() and readyCheck() methods for liveness/readiness probes\n * - Auto-registers SIGTERM/SIGINT handlers for graceful shutdown\n * - Manages ready state during shutdown to fail readiness probes\n */\nexport class HealthManager {\n private readonly DEFAULT_CLIENT_OPTIONS = {\n includeInLivenessCheck: true,\n includeInReadinessCheck: true,\n };\n\n private readonly DEFAULT_SERVER_OPTIONS = {\n runDefaultShutdownHandler: true,\n name: 'server',\n };\n\n private readonly DEFAULT_CONFIG: HealthManagerConfig = {\n shutdownDelayMs: 5_000,\n useExit0: true,\n shouldSetupSignalHandlers: true,\n livenessPeriodMs: 10_000,\n readinessPeriodMs: 5_000,\n enableLivenessOptimization: true,\n };\n\n private isShuttingDown: boolean = false;\n private isReady: boolean = false;\n\n private config: HealthManagerConfig;\n\n private clientsMap: Map<string, ClientConfig<any>[]> = new Map();\n private server: Required<ServerConfig> | undefined;\n\n private livenessChecks: Array<() => Promise<void>> = [];\n private readinessChecks: Array<() => Promise<void>> = [];\n\n private logger: any;\n\n /**\n * Creates a new HealthManager instance\n *\n * @param params Configuration options for health checks and shutdown behavior\n */\n constructor(params: HealthManagerOptions) {\n this.config = {\n ...this.DEFAULT_CONFIG,\n ...(params.config ?? {}),\n };\n\n this.logger = params.logger;\n if (params.server) {\n this.attachServer(params.server);\n }\n\n this.storeClientsWithDefaults(params);\n\n this.initializeHealthChecks();\n\n if (this.config.shouldSetupSignalHandlers) {\n this.setupSignalHandlers();\n }\n }\n\n /**\n * Store clients with default health check and shutdown functions\n * @private\n */\n private storeClientsWithDefaults(params: HealthManagerOptions): void {\n const clients = params.clients;\n if (!clients) {\n return;\n }\n\n Object.entries(clients).forEach(([type, client]) => {\n if (!client) {\n return;\n }\n\n const clientsArray = Array.isArray(client) ? client : [client];\n\n // Apply default values to each client config\n const clientsWithDefaults = clientsArray.map((client) => {\n const options = {\n ...this.DEFAULT_CLIENT_OPTIONS,\n name: type,\n ...client.options,\n };\n\n const defaultHealthCheck = DEFAULT_CLIENT_HEALTHCHECK_FUNC_MAP[type as ClientType];\n const healthCheck = client.healthCheck ?? (defaultHealthCheck ? () => defaultHealthCheck({ client: client.connection, name: options.name }) : undefined);\n\n const defaultShutdown = DEFAULT_CLIENT_SHUTDOWN_HANDLERS_MAP[type as ClientType];\n const shutdown = client.shutdown ?? (defaultShutdown ? (signal?: string) => defaultShutdown({ client: client.connection, signal, name: options.name }) : undefined);\n\n return {\n connection: client.connection,\n healthCheck,\n shutdown,\n options,\n };\n });\n\n this.clientsMap.set(type, clientsWithDefaults);\n });\n }\n\n /**\n * Register SIGTERM and SIGINT signal listeners\n * @private\n */\n private setupSignalHandlers(): void {\n this.logger.info('Setting up global signal listeners for graceful shutdown');\n\n process.on('SIGTERM', async () => {\n await this.shutdown('SIGTERM');\n });\n\n process.on('SIGINT', async () => {\n await this.shutdown('SIGINT');\n });\n }\n\n /**\n * Initialize health check arrays based on configured clients\n * @private\n */\n private initializeHealthChecks(): void {\n let allClientsInBothChecks = true;\n\n this.clientsMap.forEach((clients) => {\n clients.forEach((client) => {\n if (!client.healthCheck) {\n return;\n }\n\n const includeInLiveness = client.options?.includeInLivenessCheck ?? true;\n const includeInReadiness = client.options?.includeInReadinessCheck ?? true;\n\n // Check if all clients are included in both checks\n if (!includeInLiveness || !includeInReadiness) {\n allClientsInBothChecks = false;\n }\n\n if (includeInLiveness) {\n this.livenessChecks.push(client.healthCheck);\n }\n\n if (includeInReadiness) {\n this.readinessChecks.push(client.healthCheck);\n }\n });\n });\n\n // Safety mechanism: Only enable optimization if all clients are in both checks to prevent skipping liveness checks for clients that aren't in readiness\n this.config.enableLivenessOptimization = this.config.enableLivenessOptimization && allClientsInBothChecks;\n\n if (this.config.enableLivenessOptimization) {\n if (!allClientsInBothChecks) {\n this.logger.warn('Liveness check optimization disabled - not all clients are in both liveness and readiness checks');\n } else {\n this.logger.info('Liveness check optimization enabled - liveness checks will be skipped when pod is ready');\n }\n }\n }\n\n /**\n * Attach an HTTP or HTTPS server to be managed during shutdown\n * @param serverConfig Server configuration including the server instance and optional shutdown handler\n */\n attachServer(serverConfig: ServerConfig): void {\n this.server = {\n server: serverConfig.server,\n shutdown: serverConfig.shutdown ?? (async () => defaultServerShutdownHandler(serverConfig.server)),\n options: {\n ...this.DEFAULT_SERVER_OPTIONS,\n ...(serverConfig.options ?? {}),\n },\n };\n }\n\n /**\n * Performs liveness health checks for clients configured with includeInLivenessCheck\n *\n * @returns Promise that resolves to { status: 'ok', statusCode: 200 } on success\n * @throws ServiceUnavailableError with statusCode 503 if any health check fails\n */\n async aliveCheck(): Promise<{ status: string, statusCode: number }> {\n if (this.isShuttingDown) {\n return { statusCode: 200, status: 'ok' };\n }\n\n // Skip liveness check if optimization is enabled and pod is already ready\n if (this.config.enableLivenessOptimization && this.isReady) {\n return { statusCode: 200, status: 'ok' };\n }\n\n try {\n const livenessPromises = Promise.all(this.livenessChecks.map(check => check()));\n\n await Promise.race([\n livenessPromises,\n timeoutPromise(this.config.livenessPeriodMs ?? 10_000, 'Liveness check timed out'),\n ]);\n\n return { statusCode: 200, status: 'ok' };\n } catch (error) {\n const message = error instanceof Error ? error.message : String(error);\n throw new ServiceUnavailableError(`Liveness probe failed: ${message}`);\n }\n }\n\n /**\n * Performs readiness health checks for clients configured with includeInReadinessCheck\n *\n * @returns Promise that resolves to { status: 'ok', statusCode: 200 } if ready\n * @throws ServiceUnavailableError with statusCode 503 if not ready or health check fails\n */\n async readyCheck(): Promise<{ status: string, statusCode: number }> {\n if (this.isShuttingDown) {\n this.isReady = false;\n throw new ServiceUnavailableError('Readiness probe failed: Application is shutting down');\n }\n\n try {\n const readinessPromises = Promise.all(this.readinessChecks.map(check => check()));\n\n await Promise.race([\n readinessPromises,\n timeoutPromise(this.config.readinessPeriodMs ?? 5_000, 'Readiness check timed out'),\n ]);\n this.isReady = true;\n\n return { statusCode: 200, status: 'ok' };\n } catch (error) {\n this.isReady = false;\n const message = error instanceof Error ? error.message : String(error);\n throw new ServiceUnavailableError(`Readiness probe failed: ${message}`);\n }\n }\n\n /**\n * Triggers graceful shutdown process\n * Can be called manually or automatically via SIGTERM/SIGINT signal handlers\n *\n * @param signal - Signal name (e.g., 'SIGTERM', 'SIGINT', 'MANUAL')\n */\n async shutdown(signal: string = 'MANUAL'): Promise<void> {\n if (this.isShuttingDown) {\n this.logger.warn('Shutdown already in progress');\n return;\n }\n\n const { shutdownDelayMs, useExit0, onShutdown, beforeShutdown } = this.config;\n\n this.isShuttingDown = true;\n this.isReady = false;\n\n this.logger.info(`${signal} received: setting readiness state to false`);\n\n await beforeShutdown?.();\n\n this.logger.info(`Waiting ${shutdownDelayMs}ms before shutdown...`);\n await setTimeout(shutdownDelayMs)\n\n // Collect client names that have shutdown handlers\n const clientNames: string[] = [];\n this.clientsMap.forEach((clients) => {\n clients.forEach((client) => {\n if (client.shutdown) {\n clientNames.push(client.options?.name || 'unknown');\n }\n });\n });\n\n this.logger.info('Executing shutdown hooks...', { clients: clientNames });\n\n const shutdownPromises: Promise<any>[] = [];\n this.clientsMap.forEach((clients) => {\n clients.forEach((client) => {\n if (client.shutdown) {\n shutdownPromises.push(client.shutdown(signal));\n }\n });\n });\n\n await Promise.allSettled(shutdownPromises);\n\n await onShutdown?.();\n\n if (this.server?.options?.runDefaultShutdownHandler) {\n this.logger.info('Shutting down server...');\n await this.server?.shutdown?.();\n }\n\n this.logger.info('Shutdown process completed');\n\n if (useExit0) {\n this.logger.info(`Exiting process after ${signal}`);\n process.exit(0);\n }\n }\n}"],"mappings":"4VAqBA,IAAa,EAAb,KAA2B,CAsCzB,YAAY,EAA8B,6BArCA,CACxC,uBAAwB,GACxB,wBAAyB,GAC1B,6BAEyC,CACxC,0BAA2B,GAC3B,KAAM,SACP,qBAEsD,CACrD,gBAAiB,IACjB,SAAU,GACV,0BAA2B,GAC3B,iBAAkB,IAClB,kBAAmB,IACnB,2BAA4B,GAC7B,qBAEiC,gBACP,mBAI4B,IAAI,wBAGN,EAAE,sBACD,EAAE,CAUtD,KAAK,OAAS,CACZ,GAAG,KAAK,eACR,GAAI,EAAO,QAAU,EAAE,CACxB,CAED,KAAK,OAAS,EAAO,OACjB,EAAO,QACT,KAAK,aAAa,EAAO,OAAO,CAGlC,KAAK,yBAAyB,EAAO,CAErC,KAAK,wBAAwB,CAEzB,KAAK,OAAO,2BACd,KAAK,qBAAqB,CAQ9B,yBAAiC,EAAoC,CACnE,IAAM,EAAU,EAAO,QAClB,GAIL,OAAO,QAAQ,EAAQ,CAAC,SAAS,CAAC,EAAM,KAAY,CAClD,GAAI,CAAC,EACH,OAMF,IAAM,GAHe,MAAM,QAAQ,EAAO,CAAG,EAAS,CAAC,EAAO,EAGrB,IAAK,GAAW,CACvD,IAAM,EAAU,CACd,GAAG,KAAK,uBACR,KAAM,EACN,GAAGA,EAAO,QACX,CAEK,EAAqB,EAAoC,GACzD,EAAcA,EAAO,cAAgB,MAA2B,EAAmB,CAAE,OAAQA,EAAO,WAAY,KAAM,EAAQ,KAAM,CAAC,CAAG,IAAA,IAExI,EAAkB,EAAqC,GACvD,EAAWA,EAAO,WAAa,EAAmB,GAAoB,EAAgB,CAAE,OAAQA,EAAO,WAAY,SAAQ,KAAM,EAAQ,KAAM,CAAC,CAAG,IAAA,IAEzJ,MAAO,CACL,WAAYA,EAAO,WACnB,cACA,WACA,UACD,EACD,CAEF,KAAK,WAAW,IAAI,EAAM,EAAoB,EAC9C,CAOJ,qBAAoC,CAClC,KAAK,OAAO,KAAK,2DAA2D,CAE5E,QAAQ,GAAG,UAAW,SAAY,CAChC,MAAM,KAAK,SAAS,UAAU,EAC9B,CAEF,QAAQ,GAAG,SAAU,SAAY,CAC/B,MAAM,KAAK,SAAS,SAAS,EAC7B,CAOJ,wBAAuC,CACrC,IAAI,EAAyB,GAE7B,KAAK,WAAW,QAAS,GAAY,CACnC,EAAQ,QAAS,GAAW,CAC1B,GAAI,CAAC,EAAO,YACV,OAGF,IAAM,EAAoB,EAAO,SAAS,wBAA0B,GAC9D,EAAqB,EAAO,SAAS,yBAA2B,IAGlE,CAAC,GAAqB,CAAC,KACzB,EAAyB,IAGvB,GACF,KAAK,eAAe,KAAK,EAAO,YAAY,CAG1C,GACF,KAAK,gBAAgB,KAAK,EAAO,YAAY,EAE/C,EACF,CAGF,KAAK,OAAO,2BAA6B,KAAK,OAAO,4BAA8B,EAE/E,KAAK,OAAO,6BACT,EAGH,KAAK,OAAO,KAAK,0FAA0F,CAF3G,KAAK,OAAO,KAAK,mGAAmG,EAW1H,aAAa,EAAkC,CAC7C,KAAK,OAAS,CACZ,OAAQ,EAAa,OACrB,SAAU,EAAa,WAAa,SAAY,EAA6B,EAAa,OAAO,EACjG,QAAS,CACP,GAAG,KAAK,uBACR,GAAI,EAAa,SAAW,EAAE,CAC/B,CACF,CASH,MAAM,YAA8D,CAMlE,GALI,KAAK,gBAKL,KAAK,OAAO,4BAA8B,KAAK,QACjD,MAAO,CAAE,WAAY,IAAK,OAAQ,KAAM,CAG1C,GAAI,CACF,IAAM,EAAmB,QAAQ,IAAI,KAAK,eAAe,IAAI,GAAS,GAAO,CAAC,CAAC,CAO/E,OALA,MAAM,QAAQ,KAAK,CACjB,EACA,EAAe,KAAK,OAAO,kBAAoB,IAAQ,2BAA2B,CACnF,CAAC,CAEK,CAAE,WAAY,IAAK,OAAQ,KAAM,OACjC,EAAO,CAEd,MAAM,IAAI,EAAwB,0BADlB,aAAiB,MAAQ,EAAM,QAAU,OAAO,EAAM,GACA,EAU1E,MAAM,YAA8D,CAClE,GAAI,KAAK,eAEP,KADA,MAAK,QAAU,GACT,IAAI,EAAwB,uDAAuD,CAG3F,GAAI,CACF,IAAM,EAAoB,QAAQ,IAAI,KAAK,gBAAgB,IAAI,GAAS,GAAO,CAAC,CAAC,CAQjF,OANA,MAAM,QAAQ,KAAK,CACjB,EACA,EAAe,KAAK,OAAO,mBAAqB,IAAO,4BAA4B,CACpF,CAAC,CACF,KAAK,QAAU,GAER,CAAE,WAAY,IAAK,OAAQ,KAAM,OACjC,EAAO,CAGd,KAFA,MAAK,QAAU,GAET,IAAI,EAAwB,2BADlB,aAAiB,MAAQ,EAAM,QAAU,OAAO,EAAM,GACC,EAU3E,MAAM,SAAS,EAAiB,SAAyB,CACvD,GAAI,KAAK,eAAgB,CACvB,KAAK,OAAO,KAAK,+BAA+B,CAChD,OAGF,GAAM,CAAE,kBAAiB,WAAU,aAAY,kBAAmB,KAAK,OAEvE,KAAK,eAAiB,GACtB,KAAK,QAAU,GAEf,KAAK,OAAO,KAAK,GAAG,EAAO,6CAA6C,CAExE,MAAM,KAAkB,CAExB,KAAK,OAAO,KAAK,WAAW,EAAgB,uBAAuB,CACnE,MAAM,EAAW,EAAgB,CAGjC,IAAMC,EAAwB,EAAE,CAChC,KAAK,WAAW,QAAS,GAAY,CACnC,EAAQ,QAAS,GAAW,CACtB,EAAO,UACT,EAAY,KAAK,EAAO,SAAS,MAAQ,UAAU,EAErD,EACF,CAEF,KAAK,OAAO,KAAK,8BAA+B,CAAE,QAAS,EAAa,CAAC,CAEzE,IAAMC,EAAmC,EAAE,CAC3C,KAAK,WAAW,QAAS,GAAY,CACnC,EAAQ,QAAS,GAAW,CACtB,EAAO,UACT,EAAiB,KAAK,EAAO,SAAS,EAAO,CAAC,EAEhD,EACF,CAEF,MAAM,QAAQ,WAAW,EAAiB,CAE1C,MAAM,KAAc,CAEhB,KAAK,QAAQ,SAAS,4BACxB,KAAK,OAAO,KAAK,0BAA0B,CAC3C,MAAM,KAAK,QAAQ,YAAY,EAGjC,KAAK,OAAO,KAAK,6BAA6B,CAE1C,IACF,KAAK,OAAO,KAAK,yBAAyB,IAAS,CACnD,QAAQ,KAAK,EAAE"}
|
|
1
|
+
{"version":3,"file":"health-manager.js","names":["client","healthCheck: ((options: { client: any; name: string; customHandlersPayload?: any; }) => Promise<void>) | undefined","options","shutdown: ((options: { signal?: string; client: any; name: string; customHandlersPayload?: any; }) => Promise<void>) | undefined","error: any","clientNames: string[]","shutdownPromises: Promise<any>[]"],"sources":["../../src/health-manager/health-manager.ts"],"sourcesContent":["import { setTimeout } from 'node:timers/promises';\nimport { ServiceUnavailableError } from '@autofleet/errors';\nimport type {\n ClientConfig,\n HealthManagerConfig,\n HealthManagerOptions,\n ClientType,\n ServerConfig,\n} from './types';\nimport type { LoggerInstanceManager } from '@autofleet/logger';\nimport { DEFAULT_CLIENT_HEALTHCHECK_FUNC_MAP } from './health-check-handlers';\nimport { DEFAULT_CLIENT_SHUTDOWN_HANDLERS_MAP, defaultServerShutdownHandler } from './shutdown-handlers';\n\n/**\n * Manages application health state and graceful shutdown for Kubernetes liveness/readiness probes\n *\n * Features:\n * - Provides aliveCheck() and readyCheck() methods for liveness/readiness probes\n * - Auto-registers SIGTERM/SIGINT handlers for graceful shutdown\n * - Manages ready state during shutdown to fail readiness probes\n */\nexport class HealthManager {\n private readonly DEFAULT_CLIENT_OPTIONS = {\n includeInLivenessCheck: true,\n includeInReadinessCheck: true,\n };\n\n private readonly DEFAULT_SERVER_OPTIONS = {\n runDefaultShutdownHandler: true,\n name: 'server',\n };\n\n private readonly DEFAULT_CONFIG: HealthManagerConfig = {\n shutdownDelayMs: 5_000,\n useExit0: true,\n shouldSetupSignalHandlers: true,\n enableLivenessOptimization: true,\n };\n\n private isShuttingDown = false;\n private isReady = false;\n\n private config: HealthManagerConfig;\n\n private clientsMap = new Map<string, ClientConfig<any>[]>();\n private server: Required<ServerConfig> | undefined;\n\n private livenessChecks: { check: (options: { client: any; name: string; customHandlersPayload?: any; }) => Promise<void>; client: any; name: string; customHandlersPayload?: any; }[] = [];\n private readinessChecks: { check: (options: { client: any; name: string; customHandlersPayload?: any; }) => Promise<void>; client: any; name: string; customHandlersPayload?: any; }[] = [];\n\n private logger: LoggerInstanceManager;\n\n /**\n * Creates a new HealthManager instance\n *\n * @param params Configuration options for health checks and shutdown behavior\n */\n constructor(params: HealthManagerOptions) {\n this.config = {\n ...this.DEFAULT_CONFIG,\n ...(params.config ?? {}),\n };\n\n this.logger = params.logger;\n if (params.server) {\n this.attachServer(params.server);\n }\n\n this.storeClientsWithDefaults(params);\n\n this.initializeHealthChecks();\n\n if (this.config.shouldSetupSignalHandlers) {\n this.setupSignalHandlers();\n }\n }\n\n /**\n * Store clients with default health check and shutdown functions\n * @private\n */\n private storeClientsWithDefaults(params: HealthManagerOptions): void {\n const clients = params.clients;\n if (!clients) {\n return;\n }\n\n Object.entries(clients).forEach(([type, client]) => {\n if (!client) {\n return;\n }\n\n const clientsArray = Array.isArray(client) ? client : [client];\n\n // Apply default values to each client config\n const clientsWithDefaults = clientsArray.map((client) => {\n const options = {\n ...this.DEFAULT_CLIENT_OPTIONS,\n name: type,\n ...client.options,\n };\n\n const defaultHealthCheck = DEFAULT_CLIENT_HEALTHCHECK_FUNC_MAP[type as ClientType];\n let healthCheck: ((options: { client: any; name: string; customHandlersPayload?: any; }) => Promise<void>) | undefined;\n\n if (client.healthCheck) {\n healthCheck = client.healthCheck;\n } else if (defaultHealthCheck) {\n healthCheck = (options: { client: any; name: string; customHandlersPayload?: any; }) => defaultHealthCheck({ client: options.client, name: options.name, logger: this.logger });\n } else {\n this.logger.warn(`No health check provided for client type '${type}' and no default implementation exists`);\n healthCheck = undefined;\n }\n\n const defaultShutdown = DEFAULT_CLIENT_SHUTDOWN_HANDLERS_MAP[type as ClientType];\n let shutdown: ((options: { signal?: string; client: any; name: string; customHandlersPayload?: any; }) => Promise<void>) | undefined;\n\n if (client.shutdown) {\n shutdown = client.shutdown;\n } else if (defaultShutdown) {\n shutdown = (options: { signal?: string; client: any; name: string; customHandlersPayload?: any; }) => defaultShutdown(\n { client: options.client, signal: options.signal, name: options.name, logger: this.logger },\n );\n } else {\n this.logger.warn(`No shutdown handler provided for client type '${type}' and no default implementation exists`);\n shutdown = undefined;\n }\n\n return {\n connection: client.connection,\n healthCheck,\n shutdown,\n options,\n };\n });\n\n this.clientsMap.set(type, clientsWithDefaults);\n });\n }\n\n /**\n * Register SIGTERM and SIGINT signal listeners\n * @private\n */\n private setupSignalHandlers(): void {\n this.logger.info('Setting up global signal listeners for graceful shutdown');\n\n process.on('SIGTERM', async () => {\n await this.shutdown('SIGTERM');\n });\n\n process.on('SIGINT', async () => {\n await this.shutdown('SIGINT');\n });\n }\n\n /**\n * Check if liveness optimization is safe to enable for a given client configuration\n * If a client is in liveness but not readiness, we cannot skip liveness checks\n * because the optimization relies on readiness passing, but this client isn't checked in readiness\n * @private\n */\n private canSafelySkipLivenessWhenReady = (includeInLiveness: boolean, includeInReadiness: boolean): boolean =>\n !(includeInLiveness && !includeInReadiness);\n\n /**\n * Initialize health check arrays based on configured clients\n * @private\n */\n private initializeHealthChecks(): void {\n let allClientsAllowLivenessOptimization = true;\n\n this.clientsMap.forEach((clients) => {\n clients.forEach((client) => {\n if (!client.healthCheck) {\n return;\n }\n\n const includeInLiveness = client.options?.includeInLivenessCheck ?? true;\n const includeInReadiness = client.options?.includeInReadinessCheck ?? true;\n\n // Check if this client configuration allows liveness optimization\n if (!this.canSafelySkipLivenessWhenReady(includeInLiveness, includeInReadiness)) {\n allClientsAllowLivenessOptimization = false;\n }\n\n if (includeInLiveness) {\n this.livenessChecks.push({\n check: client.healthCheck,\n client: client.connection,\n name: client.options?.name || 'unknown',\n customHandlersPayload: client.options?.customHandlersPayload,\n });\n }\n\n if (includeInReadiness) {\n this.readinessChecks.push({\n check: client.healthCheck,\n client: client.connection,\n name: client.options?.name || 'unknown',\n customHandlersPayload: client.options?.customHandlersPayload,\n });\n }\n });\n });\n\n // Apply optimization setting: only enable if user requested it AND all clients allow it\n this.config.enableLivenessOptimization = this.config.enableLivenessOptimization && allClientsAllowLivenessOptimization;\n\n // Log optimization status\n if (this.config.enableLivenessOptimization) {\n this.logger.info('Liveness check optimization enabled - liveness checks will be skipped when pod is ready');\n } else if (!allClientsAllowLivenessOptimization) {\n this.logger.warn('Liveness check optimization disabled - some clients are in liveness checks but not in readiness checks');\n }\n }\n\n /**\n * Attach an HTTP or HTTPS server to be managed during shutdown\n * @param serverConfig Server configuration including the server instance and optional shutdown handler\n */\n attachServer(serverConfig: ServerConfig): void {\n this.server = {\n server: serverConfig.server,\n shutdown: serverConfig.shutdown ?? (async () => defaultServerShutdownHandler(serverConfig.server, this.logger)),\n options: {\n ...this.DEFAULT_SERVER_OPTIONS,\n ...(serverConfig.options ?? {}),\n },\n };\n }\n\n /**\n * Performs liveness health checks for clients configured with includeInLivenessCheck\n *\n * @returns Promise that resolves to { status: 'ok', statusCode: 200 } on success\n * @throws ServiceUnavailableError with statusCode 503 if any health check fails\n */\n async aliveCheck(): Promise<{ status: string; statusCode: number; }> {\n if (this.isShuttingDown) {\n return { statusCode: 200, status: 'ok' };\n }\n\n // Skip liveness check if optimization is enabled and pod is already ready\n if (this.config.enableLivenessOptimization && this.isReady) {\n return { statusCode: 200, status: 'ok' };\n }\n\n try {\n await Promise.all(\n this.livenessChecks.map(({ check, client, name, customHandlersPayload }) =>\n check({ client, name, customHandlersPayload }),\n ),\n );\n\n return { statusCode: 200, status: 'ok' };\n } catch (error: any) {\n const err = new ServiceUnavailableError(`Liveness probe failed: ${error.message}`);\n err.stack = error.stack;\n throw err;\n }\n }\n\n /**\n * Performs readiness health checks for clients configured with includeInReadinessCheck\n *\n * @returns Promise that resolves to { status: 'ok', statusCode: 200 } if ready\n * @throws ServiceUnavailableError with statusCode 503 if not ready or health check fails\n */\n async readyCheck(): Promise<{ status: string; statusCode: number; }> {\n if (this.isShuttingDown) {\n this.isReady = false;\n throw new ServiceUnavailableError('Readiness probe failed: Application is shutting down');\n }\n\n try {\n await Promise.all(\n this.readinessChecks.map(({ check, client, name, customHandlersPayload }) =>\n check({ client, name, customHandlersPayload }),\n ),\n );\n this.isReady = true;\n\n return { statusCode: 200, status: 'ok' };\n } catch (error: any) {\n this.isReady = false;\n const err = new ServiceUnavailableError(`Readiness probe failed: ${error.message}`);\n err.stack = error.stack;\n throw err;\n }\n }\n\n /**\n * Triggers graceful shutdown process\n * Can be called manually or automatically via SIGTERM/SIGINT signal handlers\n *\n * @param signal - Signal name (e.g., 'SIGTERM', 'SIGINT', 'MANUAL')\n */\n async shutdown(signal = 'MANUAL'): Promise<void> {\n try {\n if (this.isShuttingDown) {\n this.logger.warn('Shutdown already in progress');\n return;\n }\n\n const { shutdownDelayMs, useExit0, onShutdown, beforeShutdown } = this.config;\n\n this.isShuttingDown = true;\n this.isReady = false;\n\n this.logger.info(`${signal} received: setting readiness state to false`);\n\n await beforeShutdown?.();\n\n this.logger.info(`Waiting ${shutdownDelayMs}ms before shutdown...`);\n await setTimeout(shutdownDelayMs);\n\n // Collect client names that have shutdown handlers\n const clientNames: string[] = [];\n this.clientsMap.forEach((clients) => {\n clients.forEach((client) => {\n if (client.shutdown) {\n clientNames.push(client.options?.name || 'unknown');\n }\n });\n });\n\n this.logger.info('Executing shutdown hooks...', { clients: clientNames });\n\n const shutdownPromises: Promise<any>[] = [];\n this.clientsMap.forEach((clients) => {\n clients.forEach((client) => {\n if (client.shutdown) {\n shutdownPromises.push(client.shutdown({\n signal,\n client: client.connection,\n name: client.options?.name || 'unknown',\n customHandlersPayload: client.options?.customHandlersPayload,\n }));\n }\n });\n });\n\n await Promise.allSettled(shutdownPromises);\n\n await onShutdown?.();\n\n if (this.server?.options?.runDefaultShutdownHandler) {\n this.logger.info('Shutting down server...');\n await this.server?.shutdown?.();\n }\n\n this.logger.info('Shutdown process completed');\n\n if (useExit0) {\n this.logger.info(`Exiting process after ${signal}`);\n process.exit(0);\n }\n } catch (error: any) {\n this.logger.error('Error during shutdown process, forcing process exit despite shutdown error', { error, signal });\n process.exit(1);\n }\n }\n}\n"],"mappings":"+SAqBA,IAAa,EAAb,KAA2B,CAoCzB,YAAY,EAA8B,6BAnCA,CACxC,uBAAwB,GACxB,wBAAyB,GAC1B,6BAEyC,CACxC,0BAA2B,GAC3B,KAAM,SACP,qBAEsD,CACrD,gBAAiB,IACjB,SAAU,GACV,0BAA2B,GAC3B,2BAA4B,GAC7B,qBAEwB,gBACP,mBAIG,IAAI,wBAG+J,EAAE,sBACD,EAAE,sCAkHjJ,EAA4B,IACpE,EAAE,GAAqB,CAAC,GAzGxB,KAAK,OAAS,CACZ,GAAG,KAAK,eACR,GAAI,EAAO,QAAU,EAAE,CACxB,CAED,KAAK,OAAS,EAAO,OACjB,EAAO,QACT,KAAK,aAAa,EAAO,OAAO,CAGlC,KAAK,yBAAyB,EAAO,CAErC,KAAK,wBAAwB,CAEzB,KAAK,OAAO,2BACd,KAAK,qBAAqB,CAQ9B,yBAAiC,EAAoC,CACnE,IAAM,EAAU,EAAO,QAClB,GAIL,OAAO,QAAQ,EAAQ,CAAC,SAAS,CAAC,EAAM,KAAY,CAClD,GAAI,CAAC,EACH,OAMF,IAAM,GAHe,MAAM,QAAQ,EAAO,CAAG,EAAS,CAAC,EAAO,EAGrB,IAAK,GAAW,CACvD,IAAM,EAAU,CACd,GAAG,KAAK,uBACR,KAAM,EACN,GAAGA,EAAO,QACX,CAEK,EAAqB,EAAoC,GAC3DC,EAEAD,EAAO,YACT,EAAcA,EAAO,YACZ,EACT,EAAe,GAAyE,EAAmB,CAAE,OAAQE,EAAQ,OAAQ,KAAMA,EAAQ,KAAM,OAAQ,KAAK,OAAQ,CAAC,EAE/K,KAAK,OAAO,KAAK,6CAA6C,EAAK,wCAAwC,CAC3G,EAAc,IAAA,IAGhB,IAAM,EAAkB,EAAqC,GACzDC,EAaJ,OAXIH,EAAO,SACT,EAAWA,EAAO,SACT,EACT,EAAY,GAA0F,EACpG,CAAE,OAAQE,EAAQ,OAAQ,OAAQA,EAAQ,OAAQ,KAAMA,EAAQ,KAAM,OAAQ,KAAK,OAAQ,CAC5F,EAED,KAAK,OAAO,KAAK,iDAAiD,EAAK,wCAAwC,CAC/G,EAAW,IAAA,IAGN,CACL,WAAYF,EAAO,WACnB,cACA,WACA,UACD,EACD,CAEF,KAAK,WAAW,IAAI,EAAM,EAAoB,EAC9C,CAOJ,qBAAoC,CAClC,KAAK,OAAO,KAAK,2DAA2D,CAE5E,QAAQ,GAAG,UAAW,SAAY,CAChC,MAAM,KAAK,SAAS,UAAU,EAC9B,CAEF,QAAQ,GAAG,SAAU,SAAY,CAC/B,MAAM,KAAK,SAAS,SAAS,EAC7B,CAgBJ,wBAAuC,CACrC,IAAI,EAAsC,GAE1C,KAAK,WAAW,QAAS,GAAY,CACnC,EAAQ,QAAS,GAAW,CAC1B,GAAI,CAAC,EAAO,YACV,OAGF,IAAM,EAAoB,EAAO,SAAS,wBAA0B,GAC9D,EAAqB,EAAO,SAAS,yBAA2B,GAGjE,KAAK,+BAA+B,EAAmB,EAAmB,GAC7E,EAAsC,IAGpC,GACF,KAAK,eAAe,KAAK,CACvB,MAAO,EAAO,YACd,OAAQ,EAAO,WACf,KAAM,EAAO,SAAS,MAAQ,UAC9B,sBAAuB,EAAO,SAAS,sBACxC,CAAC,CAGA,GACF,KAAK,gBAAgB,KAAK,CACxB,MAAO,EAAO,YACd,OAAQ,EAAO,WACf,KAAM,EAAO,SAAS,MAAQ,UAC9B,sBAAuB,EAAO,SAAS,sBACxC,CAAC,EAEJ,EACF,CAGF,KAAK,OAAO,2BAA6B,KAAK,OAAO,4BAA8B,EAG/E,KAAK,OAAO,2BACd,KAAK,OAAO,KAAK,0FAA0F,CACjG,GACV,KAAK,OAAO,KAAK,yGAAyG,CAQ9H,aAAa,EAAkC,CAC7C,KAAK,OAAS,CACZ,OAAQ,EAAa,OACrB,SAAU,EAAa,WAAa,SAAY,EAA6B,EAAa,OAAQ,KAAK,OAAO,EAC9G,QAAS,CACP,GAAG,KAAK,uBACR,GAAI,EAAa,SAAW,EAAE,CAC/B,CACF,CASH,MAAM,YAA+D,CAMnE,GALI,KAAK,gBAKL,KAAK,OAAO,4BAA8B,KAAK,QACjD,MAAO,CAAE,WAAY,IAAK,OAAQ,KAAM,CAG1C,GAAI,CAOF,OANA,MAAM,QAAQ,IACZ,KAAK,eAAe,KAAK,CAAE,QAAO,SAAQ,OAAM,2BAC9C,EAAM,CAAE,SAAQ,OAAM,wBAAuB,CAAC,CAC/C,CACF,CAEM,CAAE,WAAY,IAAK,OAAQ,KAAM,OACjCI,EAAY,CACnB,IAAM,EAAM,IAAI,EAAwB,0BAA0B,EAAM,UAAU,CAElF,KADA,GAAI,MAAQ,EAAM,MACZ,GAUV,MAAM,YAA+D,CACnE,GAAI,KAAK,eAEP,KADA,MAAK,QAAU,GACT,IAAI,EAAwB,uDAAuD,CAG3F,GAAI,CAQF,OAPA,MAAM,QAAQ,IACZ,KAAK,gBAAgB,KAAK,CAAE,QAAO,SAAQ,OAAM,2BAC/C,EAAM,CAAE,SAAQ,OAAM,wBAAuB,CAAC,CAC/C,CACF,CACD,KAAK,QAAU,GAER,CAAE,WAAY,IAAK,OAAQ,KAAM,OACjCA,EAAY,CACnB,KAAK,QAAU,GACf,IAAM,EAAM,IAAI,EAAwB,2BAA2B,EAAM,UAAU,CAEnF,KADA,GAAI,MAAQ,EAAM,MACZ,GAUV,MAAM,SAAS,EAAS,SAAyB,CAC/C,GAAI,CACF,GAAI,KAAK,eAAgB,CACvB,KAAK,OAAO,KAAK,+BAA+B,CAChD,OAGF,GAAM,CAAE,kBAAiB,WAAU,aAAY,kBAAmB,KAAK,OAEvE,KAAK,eAAiB,GACtB,KAAK,QAAU,GAEf,KAAK,OAAO,KAAK,GAAG,EAAO,6CAA6C,CAExE,MAAM,KAAkB,CAExB,KAAK,OAAO,KAAK,WAAW,EAAgB,uBAAuB,CACnE,MAAM,EAAW,EAAgB,CAGjC,IAAMC,EAAwB,EAAE,CAChC,KAAK,WAAW,QAAS,GAAY,CACnC,EAAQ,QAAS,GAAW,CACtB,EAAO,UACT,EAAY,KAAK,EAAO,SAAS,MAAQ,UAAU,EAErD,EACF,CAEF,KAAK,OAAO,KAAK,8BAA+B,CAAE,QAAS,EAAa,CAAC,CAEzE,IAAMC,EAAmC,EAAE,CAC3C,KAAK,WAAW,QAAS,GAAY,CACnC,EAAQ,QAAS,GAAW,CACtB,EAAO,UACT,EAAiB,KAAK,EAAO,SAAS,CACpC,SACA,OAAQ,EAAO,WACf,KAAM,EAAO,SAAS,MAAQ,UAC9B,sBAAuB,EAAO,SAAS,sBACxC,CAAC,CAAC,EAEL,EACF,CAEF,MAAM,QAAQ,WAAW,EAAiB,CAE1C,MAAM,KAAc,CAEhB,KAAK,QAAQ,SAAS,4BACxB,KAAK,OAAO,KAAK,0BAA0B,CAC3C,MAAM,KAAK,QAAQ,YAAY,EAGjC,KAAK,OAAO,KAAK,6BAA6B,CAE1C,IACF,KAAK,OAAO,KAAK,yBAAyB,IAAS,CACnD,QAAQ,KAAK,EAAE,QAEVF,EAAY,CACnB,KAAK,OAAO,MAAM,6EAA8E,CAAE,QAAO,SAAQ,CAAC,CAClH,QAAQ,KAAK,EAAE"}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
const e=require(`../_virtual/rolldown_runtime.cjs`),t=require(
|
|
1
|
+
const e=require(`../_virtual/rolldown_runtime.cjs`),t=require(`./types.cjs`);let n=require(`http-terminator`);const r={[t.CLIENT_TYPES.REDIS]:async e=>{try{await e.client.quit?.()}catch(t){throw e.logger.error(`Failed to shutdown redis client '${e.name}'`,{error:t}),t}},[t.CLIENT_TYPES.SEQUELIZE]:async e=>{try{await e.client.close?.()}catch(t){throw e.logger.error(`Failed to shutdown sequelize client '${e.name}'`,{error:t}),t}},[t.CLIENT_TYPES.ELASTIC_SEARCH]:async e=>{try{await e.client.close?.()}catch(t){throw e.logger.error(`Failed to shutdown elasticsearch client '${e.name}'`,{error:t}),t}},[t.CLIENT_TYPES.RABBIT]:async e=>{try{await e.client.gracefulShutdown?.(e.signal)}catch(t){throw e.logger.error(`Failed to shutdown rabbit client '${e.name}'`,{error:t}),t}},[t.CLIENT_TYPES.EVENTS]:async e=>{try{await e.client.exitHandler?.(e.signal)}catch(t){throw e.logger.error(`Failed to shutdown events client '${e.name}'`,{error:t}),t}}},i=async(e,t)=>{try{await(0,n.createHttpTerminator)({server:e}).terminate()}catch(e){throw t.error(`Failed to shutdown server: ${e instanceof Error?e.message:String(e)}`),e}};exports.DEFAULT_CLIENT_SHUTDOWN_HANDLERS_MAP=r,exports.defaultServerShutdownHandler=i;
|
|
2
2
|
//# sourceMappingURL=shutdown-handlers.cjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"shutdown-handlers.cjs","names":["DEFAULT_CLIENT_SHUTDOWN_HANDLERS_MAP: Record<ClientType, (client: any
|
|
1
|
+
{"version":3,"file":"shutdown-handlers.cjs","names":["DEFAULT_CLIENT_SHUTDOWN_HANDLERS_MAP: Record<ClientType, (options: { client: any; name: string; signal?: string; logger: LoggerInstanceManager; }) => Promise<void>>","CLIENT_TYPES"],"sources":["../../src/health-manager/shutdown-handlers.ts"],"sourcesContent":["import {\n createHttpTerminator,\n} from 'http-terminator';\nimport type { Server as HttpServer } from 'node:http';\nimport type { Server as HttpsServer } from 'node:https';\nimport type { LoggerInstanceManager } from '@autofleet/logger';\nimport type { ClientType } from './types';\nimport { CLIENT_TYPES } from './types';\n\nexport const DEFAULT_CLIENT_SHUTDOWN_HANDLERS_MAP: Record<ClientType, (options: { client: any; name: string; signal?: string; logger: LoggerInstanceManager; }) => Promise<void>> = {\n [CLIENT_TYPES.REDIS]: async (options) => {\n try {\n await options.client.quit?.();\n } catch (error) {\n options.logger.error(`Failed to shutdown redis client '${options.name}'`, { error });\n throw error;\n }\n },\n [CLIENT_TYPES.SEQUELIZE]: async (options) => {\n try {\n await options.client.close?.();\n } catch (error) {\n options.logger.error(`Failed to shutdown sequelize client '${options.name}'`, { error });\n throw error;\n }\n },\n [CLIENT_TYPES.ELASTIC_SEARCH]: async (options) => {\n try {\n await options.client.close?.();\n } catch (error) {\n options.logger.error(`Failed to shutdown elasticsearch client '${options.name}'`, { error });\n throw error;\n }\n },\n [CLIENT_TYPES.RABBIT]: async (options) => {\n try {\n await options.client.gracefulShutdown?.(options.signal);\n } catch (error) {\n options.logger.error(`Failed to shutdown rabbit client '${options.name}'`, { error });\n throw error;\n }\n },\n [CLIENT_TYPES.EVENTS]: async (options) => {\n try {\n await options.client.exitHandler?.(options.signal);\n } catch (error) {\n options.logger.error(`Failed to shutdown events client '${options.name}'`, { error });\n throw error;\n }\n },\n};\n\nexport const defaultServerShutdownHandler = async (server: HttpServer | HttpsServer, logger: LoggerInstanceManager): Promise<void> => {\n try {\n const httpTerminator = createHttpTerminator({\n server,\n });\n await httpTerminator.terminate();\n } catch (error) {\n logger.error(`Failed to shutdown server: ${error instanceof Error ? error.message : String(error)}`);\n throw error;\n }\n};\n"],"mappings":"8GASA,MAAaA,EAAuK,EACjLC,EAAAA,aAAa,OAAQ,KAAO,IAAY,CACvC,GAAI,CACF,MAAM,EAAQ,OAAO,QAAQ,OACtB,EAAO,CAEd,MADA,EAAQ,OAAO,MAAM,oCAAoC,EAAQ,KAAK,GAAI,CAAE,QAAO,CAAC,CAC9E,KAGTA,EAAAA,aAAa,WAAY,KAAO,IAAY,CAC3C,GAAI,CACF,MAAM,EAAQ,OAAO,SAAS,OACvB,EAAO,CAEd,MADA,EAAQ,OAAO,MAAM,wCAAwC,EAAQ,KAAK,GAAI,CAAE,QAAO,CAAC,CAClF,KAGTA,EAAAA,aAAa,gBAAiB,KAAO,IAAY,CAChD,GAAI,CACF,MAAM,EAAQ,OAAO,SAAS,OACvB,EAAO,CAEd,MADA,EAAQ,OAAO,MAAM,4CAA4C,EAAQ,KAAK,GAAI,CAAE,QAAO,CAAC,CACtF,KAGTA,EAAAA,aAAa,QAAS,KAAO,IAAY,CACxC,GAAI,CACF,MAAM,EAAQ,OAAO,mBAAmB,EAAQ,OAAO,OAChD,EAAO,CAEd,MADA,EAAQ,OAAO,MAAM,qCAAqC,EAAQ,KAAK,GAAI,CAAE,QAAO,CAAC,CAC/E,KAGTA,EAAAA,aAAa,QAAS,KAAO,IAAY,CACxC,GAAI,CACF,MAAM,EAAQ,OAAO,cAAc,EAAQ,OAAO,OAC3C,EAAO,CAEd,MADA,EAAQ,OAAO,MAAM,qCAAqC,EAAQ,KAAK,GAAI,CAAE,QAAO,CAAC,CAC/E,IAGX,CAEY,EAA+B,MAAO,EAAkC,IAAiD,CACpI,GAAI,CAIF,MAAA,EAAA,EAAA,sBAH4C,CAC1C,SACD,CAAC,CACmB,WAAW,OACzB,EAAO,CAEd,MADA,EAAO,MAAM,8BAA8B,aAAiB,MAAQ,EAAM,QAAU,OAAO,EAAM,GAAG,CAC9F"}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{
|
|
1
|
+
import{CLIENT_TYPES as e}from"./types.js";import{createHttpTerminator as t}from"http-terminator";const n={[e.REDIS]:async e=>{try{await e.client.quit?.()}catch(t){throw e.logger.error(`Failed to shutdown redis client '${e.name}'`,{error:t}),t}},[e.SEQUELIZE]:async e=>{try{await e.client.close?.()}catch(t){throw e.logger.error(`Failed to shutdown sequelize client '${e.name}'`,{error:t}),t}},[e.ELASTIC_SEARCH]:async e=>{try{await e.client.close?.()}catch(t){throw e.logger.error(`Failed to shutdown elasticsearch client '${e.name}'`,{error:t}),t}},[e.RABBIT]:async e=>{try{await e.client.gracefulShutdown?.(e.signal)}catch(t){throw e.logger.error(`Failed to shutdown rabbit client '${e.name}'`,{error:t}),t}},[e.EVENTS]:async e=>{try{await e.client.exitHandler?.(e.signal)}catch(t){throw e.logger.error(`Failed to shutdown events client '${e.name}'`,{error:t}),t}}},r=async(e,n)=>{try{await t({server:e}).terminate()}catch(e){throw n.error(`Failed to shutdown server: ${e instanceof Error?e.message:String(e)}`),e}};export{n as DEFAULT_CLIENT_SHUTDOWN_HANDLERS_MAP,r as defaultServerShutdownHandler};
|
|
2
2
|
//# sourceMappingURL=shutdown-handlers.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"shutdown-handlers.js","names":["DEFAULT_CLIENT_SHUTDOWN_HANDLERS_MAP: Record<ClientType, (client: any
|
|
1
|
+
{"version":3,"file":"shutdown-handlers.js","names":["DEFAULT_CLIENT_SHUTDOWN_HANDLERS_MAP: Record<ClientType, (options: { client: any; name: string; signal?: string; logger: LoggerInstanceManager; }) => Promise<void>>"],"sources":["../../src/health-manager/shutdown-handlers.ts"],"sourcesContent":["import {\n createHttpTerminator,\n} from 'http-terminator';\nimport type { Server as HttpServer } from 'node:http';\nimport type { Server as HttpsServer } from 'node:https';\nimport type { LoggerInstanceManager } from '@autofleet/logger';\nimport type { ClientType } from './types';\nimport { CLIENT_TYPES } from './types';\n\nexport const DEFAULT_CLIENT_SHUTDOWN_HANDLERS_MAP: Record<ClientType, (options: { client: any; name: string; signal?: string; logger: LoggerInstanceManager; }) => Promise<void>> = {\n [CLIENT_TYPES.REDIS]: async (options) => {\n try {\n await options.client.quit?.();\n } catch (error) {\n options.logger.error(`Failed to shutdown redis client '${options.name}'`, { error });\n throw error;\n }\n },\n [CLIENT_TYPES.SEQUELIZE]: async (options) => {\n try {\n await options.client.close?.();\n } catch (error) {\n options.logger.error(`Failed to shutdown sequelize client '${options.name}'`, { error });\n throw error;\n }\n },\n [CLIENT_TYPES.ELASTIC_SEARCH]: async (options) => {\n try {\n await options.client.close?.();\n } catch (error) {\n options.logger.error(`Failed to shutdown elasticsearch client '${options.name}'`, { error });\n throw error;\n }\n },\n [CLIENT_TYPES.RABBIT]: async (options) => {\n try {\n await options.client.gracefulShutdown?.(options.signal);\n } catch (error) {\n options.logger.error(`Failed to shutdown rabbit client '${options.name}'`, { error });\n throw error;\n }\n },\n [CLIENT_TYPES.EVENTS]: async (options) => {\n try {\n await options.client.exitHandler?.(options.signal);\n } catch (error) {\n options.logger.error(`Failed to shutdown events client '${options.name}'`, { error });\n throw error;\n }\n },\n};\n\nexport const defaultServerShutdownHandler = async (server: HttpServer | HttpsServer, logger: LoggerInstanceManager): Promise<void> => {\n try {\n const httpTerminator = createHttpTerminator({\n server,\n });\n await httpTerminator.terminate();\n } catch (error) {\n logger.error(`Failed to shutdown server: ${error instanceof Error ? error.message : String(error)}`);\n throw error;\n }\n};\n"],"mappings":"iGASA,MAAaA,EAAuK,EACjL,EAAa,OAAQ,KAAO,IAAY,CACvC,GAAI,CACF,MAAM,EAAQ,OAAO,QAAQ,OACtB,EAAO,CAEd,MADA,EAAQ,OAAO,MAAM,oCAAoC,EAAQ,KAAK,GAAI,CAAE,QAAO,CAAC,CAC9E,KAGT,EAAa,WAAY,KAAO,IAAY,CAC3C,GAAI,CACF,MAAM,EAAQ,OAAO,SAAS,OACvB,EAAO,CAEd,MADA,EAAQ,OAAO,MAAM,wCAAwC,EAAQ,KAAK,GAAI,CAAE,QAAO,CAAC,CAClF,KAGT,EAAa,gBAAiB,KAAO,IAAY,CAChD,GAAI,CACF,MAAM,EAAQ,OAAO,SAAS,OACvB,EAAO,CAEd,MADA,EAAQ,OAAO,MAAM,4CAA4C,EAAQ,KAAK,GAAI,CAAE,QAAO,CAAC,CACtF,KAGT,EAAa,QAAS,KAAO,IAAY,CACxC,GAAI,CACF,MAAM,EAAQ,OAAO,mBAAmB,EAAQ,OAAO,OAChD,EAAO,CAEd,MADA,EAAQ,OAAO,MAAM,qCAAqC,EAAQ,KAAK,GAAI,CAAE,QAAO,CAAC,CAC/E,KAGT,EAAa,QAAS,KAAO,IAAY,CACxC,GAAI,CACF,MAAM,EAAQ,OAAO,cAAc,EAAQ,OAAO,OAC3C,EAAO,CAEd,MADA,EAAQ,OAAO,MAAM,qCAAqC,EAAQ,KAAK,GAAI,CAAE,QAAO,CAAC,CAC/E,IAGX,CAEY,EAA+B,MAAO,EAAkC,IAAiD,CACpI,GAAI,CAIF,MAHuB,EAAqB,CAC1C,SACD,CAAC,CACmB,WAAW,OACzB,EAAO,CAEd,MADA,EAAO,MAAM,8BAA8B,aAAiB,MAAQ,EAAM,QAAU,OAAO,EAAM,GAAG,CAC9F"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.cjs","names":[],"sources":["../../src/health-manager/types.ts"],"sourcesContent":["import type { LoggerInstanceManager } from '@autofleet/logger';\nimport type { Server as HttpServer } from 'node:http';\nimport type { Server as HttpsServer } from 'node:https';\n\n
|
|
1
|
+
{"version":3,"file":"types.cjs","names":[],"sources":["../../src/health-manager/types.ts"],"sourcesContent":["import type { LoggerInstanceManager } from '@autofleet/logger';\nimport type { Server as HttpServer } from 'node:http';\nimport type { Server as HttpsServer } from 'node:https';\n\n/**\n * Configuration for a single client (e.g., rabbit, sequelize, redis, elasticsearch)\n * Allows custom health checks and shutdown logic\n */\nexport interface ClientConfig<T = any, TPayload = any> {\n /** The actual connection instance */\n connection: T;\n\n /** Custom health check function (optional) - will be called during alive/ready checks with client connection and name */\n healthCheck?: (options: { client: T; name: string; customHandlersPayload?: TPayload; }) => Promise<void>;\n\n /** Custom shutdown function (optional) - will be called during graceful shutdown with signal name (e.g., 'SIGTERM', 'SIGINT'), client connection, and name */\n shutdown?: (options: { signal?: string; client: T; name: string; customHandlersPayload?: TPayload; }) => Promise<void>;\n\n /** Additional options specific to the client (optional) */\n options?: {\n /** Whether to include this client in liveness checks (default: true) */\n includeInLivenessCheck?: boolean;\n\n /** Whether to include this client in readiness checks (default: true) */\n includeInReadinessCheck?: boolean;\n\n /** Custom name for this client (used in logging) */\n name?: string;\n\n /** Custom payload to pass to health check and shutdown handlers - use this to pass any additional data your handlers need */\n customHandlersPayload?: TPayload;\n };\n}\n\n/** Configuration for an HTTP or HTTPS server managed by HealthManager */\nexport interface ServerConfig {\n /** The HTTP or HTTPS server instance */\n server: HttpServer | HttpsServer;\n\n /** Custom shutdown function for the server (optional) - receives signal name (e.g., 'SIGTERM', 'SIGINT') */\n shutdown?: (signal?: string) => Promise<void>;\n\n /** Additional options specific to the server (optional) */\n options?: {\n /** Custom name for this server (used in logging) */\n name?: string;\n\n /** Whether to skip the default shutdown handler for this server */\n runDefaultShutdownHandler?: boolean;\n\n };\n}\n\n/**\n * General configuration options for the HealthManager\n */\nexport interface HealthManagerConfig {\n /**\n * Delay in milliseconds before shutting down after SIGTERM/SIGINT\n * This gives time for load balancers to stop routing traffic. Should be equal to or greater than readiness probe interval.\n * @default 5000\n */\n shutdownDelayMs?: number;\n\n /**\n * Whether to call process.exit(0) after shutdown sequence completes\n * @default true\n */\n useExit0?: boolean;\n\n /** Whether to auto-setup SIGTERM/SIGINT handlers for graceful shutdown\n * @default true\n */\n shouldSetupSignalHandlers?: boolean;\n\n /**\n * Global shutdown hook called before all clients are shut down\n * @default undefined\n */\n beforeShutdown?: (() => Promise<void>) | undefined;\n\n /**\n * Global shutdown hook called after all clients are shut down\n * @default undefined\n */\n onShutdown?: (() => Promise<void>) | undefined;\n\n /**\n * Enable liveness check optimization - if true and all clients are in both liveness and readiness checks,\n * liveness checks will be skipped when pod is already ready (readiness check passed)\n * @default true\n */\n enableLivenessOptimization?: boolean;\n}\n\n/**\n * List of clients and general configuration for HealthManager\n */\nexport interface HealthManagerOptions {\n /** Client configurations */\n clients?: {\n /** RabbitMQ client configuration - can be a single config or array of configs */\n rabbit?: ClientConfig<any> | ClientConfig<any>[];\n\n /** Sequelize instance configuration - can be a single config or array of configs */\n sequelize?: ClientConfig<any> | ClientConfig<any>[];\n\n /** Redis client configuration - can be a single config or array of configs */\n redis?: ClientConfig<any> | ClientConfig<any>[];\n\n /** Elasticsearch client configuration - can be a single config or array of configs */\n elasticsearch?: ClientConfig<any> | ClientConfig<any>[];\n };\n\n /** General configuration options */\n config?: HealthManagerConfig;\n\n /** Logger instance for logging messages */\n logger: LoggerInstanceManager;\n\n /** Optional HTTP or HTTPS server instance to manage during shutdown */\n server?: ServerConfig;\n}\n\nexport interface RedisClient {\n ping: () => Promise<string | void>;\n}\n\n/**\n * Sequelize database interface\n */\nexport interface SequelizeClient {\n query(sql: string | { query: string; values: unknown[]; }): Promise<any>;\n}\n\n/**\n * Elasticsearch client interface\n */\nexport interface ElasticsearchClient {\n ping: () => Promise<boolean>;\n}\n\nexport interface EventsClient {\n exitHandler: () => Promise<void>;\n}\n\n/**\n * RabbitMQ client interface\n */\nexport interface RabbitMQClient {\n isConnected: () => Promise<boolean> | boolean;\n}\n\nexport const CLIENT_TYPES = {\n RABBIT: 'rabbit',\n SEQUELIZE: 'sequelize',\n REDIS: 'redis',\n ELASTIC_SEARCH: 'elasticsearch',\n EVENTS: 'events',\n} as const;\n\nexport type ClientType = typeof CLIENT_TYPES[keyof typeof CLIENT_TYPES];\n"],"mappings":"AAyJA,MAAa,EAAe,CAC1B,OAAQ,SACR,UAAW,YACX,MAAO,QACP,eAAgB,gBAChB,OAAQ,SACT"}
|
|
@@ -8,13 +8,22 @@ import { Server as Server$1 } from "node:https";
|
|
|
8
8
|
* Configuration for a single client (e.g., rabbit, sequelize, redis, elasticsearch)
|
|
9
9
|
* Allows custom health checks and shutdown logic
|
|
10
10
|
*/
|
|
11
|
-
interface ClientConfig<T = any> {
|
|
11
|
+
interface ClientConfig<T = any, TPayload = any> {
|
|
12
12
|
/** The actual connection instance */
|
|
13
13
|
connection: T;
|
|
14
|
-
/** Custom health check function (optional) - will be called during alive/ready checks */
|
|
15
|
-
healthCheck?: (
|
|
16
|
-
|
|
17
|
-
|
|
14
|
+
/** Custom health check function (optional) - will be called during alive/ready checks with client connection and name */
|
|
15
|
+
healthCheck?: (options: {
|
|
16
|
+
client: T;
|
|
17
|
+
name: string;
|
|
18
|
+
customHandlersPayload?: TPayload;
|
|
19
|
+
}) => Promise<void>;
|
|
20
|
+
/** Custom shutdown function (optional) - will be called during graceful shutdown with signal name (e.g., 'SIGTERM', 'SIGINT'), client connection, and name */
|
|
21
|
+
shutdown?: (options: {
|
|
22
|
+
signal?: string;
|
|
23
|
+
client: T;
|
|
24
|
+
name: string;
|
|
25
|
+
customHandlersPayload?: TPayload;
|
|
26
|
+
}) => Promise<void>;
|
|
18
27
|
/** Additional options specific to the client (optional) */
|
|
19
28
|
options?: {
|
|
20
29
|
/** Whether to include this client in liveness checks (default: true) */
|
|
@@ -23,6 +32,8 @@ interface ClientConfig<T = any> {
|
|
|
23
32
|
includeInReadinessCheck?: boolean;
|
|
24
33
|
/** Custom name for this client (used in logging) */
|
|
25
34
|
name?: string;
|
|
35
|
+
/** Custom payload to pass to health check and shutdown handlers - use this to pass any additional data your handlers need */
|
|
36
|
+
customHandlersPayload?: TPayload;
|
|
26
37
|
};
|
|
27
38
|
}
|
|
28
39
|
/** Configuration for an HTTP or HTTPS server managed by HealthManager */
|
|
@@ -68,14 +79,6 @@ interface HealthManagerConfig {
|
|
|
68
79
|
* @default undefined
|
|
69
80
|
*/
|
|
70
81
|
onShutdown?: (() => Promise<void>) | undefined;
|
|
71
|
-
/** The interval in milliseconds at which the liveness checks are repeated (optional)
|
|
72
|
-
* * @default 10_000
|
|
73
|
-
*/
|
|
74
|
-
livenessPeriodMs?: number;
|
|
75
|
-
/** The interval in milliseconds at which the readiness checks are repeated (optional)
|
|
76
|
-
* * @default 5_000
|
|
77
|
-
*/
|
|
78
|
-
readinessPeriodMs?: number;
|
|
79
82
|
/**
|
|
80
83
|
* Enable liveness check optimization - if true and all clients are in both liveness and readiness checks,
|
|
81
84
|
* liveness checks will be skipped when pod is already ready (readiness check passed)
|
|
@@ -8,13 +8,22 @@ import { Server as Server$1 } from "node:https";
|
|
|
8
8
|
* Configuration for a single client (e.g., rabbit, sequelize, redis, elasticsearch)
|
|
9
9
|
* Allows custom health checks and shutdown logic
|
|
10
10
|
*/
|
|
11
|
-
interface ClientConfig<T = any> {
|
|
11
|
+
interface ClientConfig<T = any, TPayload = any> {
|
|
12
12
|
/** The actual connection instance */
|
|
13
13
|
connection: T;
|
|
14
|
-
/** Custom health check function (optional) - will be called during alive/ready checks */
|
|
15
|
-
healthCheck?: (
|
|
16
|
-
|
|
17
|
-
|
|
14
|
+
/** Custom health check function (optional) - will be called during alive/ready checks with client connection and name */
|
|
15
|
+
healthCheck?: (options: {
|
|
16
|
+
client: T;
|
|
17
|
+
name: string;
|
|
18
|
+
customHandlersPayload?: TPayload;
|
|
19
|
+
}) => Promise<void>;
|
|
20
|
+
/** Custom shutdown function (optional) - will be called during graceful shutdown with signal name (e.g., 'SIGTERM', 'SIGINT'), client connection, and name */
|
|
21
|
+
shutdown?: (options: {
|
|
22
|
+
signal?: string;
|
|
23
|
+
client: T;
|
|
24
|
+
name: string;
|
|
25
|
+
customHandlersPayload?: TPayload;
|
|
26
|
+
}) => Promise<void>;
|
|
18
27
|
/** Additional options specific to the client (optional) */
|
|
19
28
|
options?: {
|
|
20
29
|
/** Whether to include this client in liveness checks (default: true) */
|
|
@@ -23,6 +32,8 @@ interface ClientConfig<T = any> {
|
|
|
23
32
|
includeInReadinessCheck?: boolean;
|
|
24
33
|
/** Custom name for this client (used in logging) */
|
|
25
34
|
name?: string;
|
|
35
|
+
/** Custom payload to pass to health check and shutdown handlers - use this to pass any additional data your handlers need */
|
|
36
|
+
customHandlersPayload?: TPayload;
|
|
26
37
|
};
|
|
27
38
|
}
|
|
28
39
|
/** Configuration for an HTTP or HTTPS server managed by HealthManager */
|
|
@@ -68,14 +79,6 @@ interface HealthManagerConfig {
|
|
|
68
79
|
* @default undefined
|
|
69
80
|
*/
|
|
70
81
|
onShutdown?: (() => Promise<void>) | undefined;
|
|
71
|
-
/** The interval in milliseconds at which the liveness checks are repeated (optional)
|
|
72
|
-
* * @default 10_000
|
|
73
|
-
*/
|
|
74
|
-
livenessPeriodMs?: number;
|
|
75
|
-
/** The interval in milliseconds at which the readiness checks are repeated (optional)
|
|
76
|
-
* * @default 5_000
|
|
77
|
-
*/
|
|
78
|
-
readinessPeriodMs?: number;
|
|
79
82
|
/**
|
|
80
83
|
* Enable liveness check optimization - if true and all clients are in both liveness and readiness checks,
|
|
81
84
|
* liveness checks will be skipped when pod is already ready (readiness check passed)
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","names":[],"sources":["../../src/health-manager/types.ts"],"sourcesContent":["import type { LoggerInstanceManager } from '@autofleet/logger';\nimport type { Server as HttpServer } from 'node:http';\nimport type { Server as HttpsServer } from 'node:https';\n\n
|
|
1
|
+
{"version":3,"file":"types.js","names":[],"sources":["../../src/health-manager/types.ts"],"sourcesContent":["import type { LoggerInstanceManager } from '@autofleet/logger';\nimport type { Server as HttpServer } from 'node:http';\nimport type { Server as HttpsServer } from 'node:https';\n\n/**\n * Configuration for a single client (e.g., rabbit, sequelize, redis, elasticsearch)\n * Allows custom health checks and shutdown logic\n */\nexport interface ClientConfig<T = any, TPayload = any> {\n /** The actual connection instance */\n connection: T;\n\n /** Custom health check function (optional) - will be called during alive/ready checks with client connection and name */\n healthCheck?: (options: { client: T; name: string; customHandlersPayload?: TPayload; }) => Promise<void>;\n\n /** Custom shutdown function (optional) - will be called during graceful shutdown with signal name (e.g., 'SIGTERM', 'SIGINT'), client connection, and name */\n shutdown?: (options: { signal?: string; client: T; name: string; customHandlersPayload?: TPayload; }) => Promise<void>;\n\n /** Additional options specific to the client (optional) */\n options?: {\n /** Whether to include this client in liveness checks (default: true) */\n includeInLivenessCheck?: boolean;\n\n /** Whether to include this client in readiness checks (default: true) */\n includeInReadinessCheck?: boolean;\n\n /** Custom name for this client (used in logging) */\n name?: string;\n\n /** Custom payload to pass to health check and shutdown handlers - use this to pass any additional data your handlers need */\n customHandlersPayload?: TPayload;\n };\n}\n\n/** Configuration for an HTTP or HTTPS server managed by HealthManager */\nexport interface ServerConfig {\n /** The HTTP or HTTPS server instance */\n server: HttpServer | HttpsServer;\n\n /** Custom shutdown function for the server (optional) - receives signal name (e.g., 'SIGTERM', 'SIGINT') */\n shutdown?: (signal?: string) => Promise<void>;\n\n /** Additional options specific to the server (optional) */\n options?: {\n /** Custom name for this server (used in logging) */\n name?: string;\n\n /** Whether to skip the default shutdown handler for this server */\n runDefaultShutdownHandler?: boolean;\n\n };\n}\n\n/**\n * General configuration options for the HealthManager\n */\nexport interface HealthManagerConfig {\n /**\n * Delay in milliseconds before shutting down after SIGTERM/SIGINT\n * This gives time for load balancers to stop routing traffic. Should be equal to or greater than readiness probe interval.\n * @default 5000\n */\n shutdownDelayMs?: number;\n\n /**\n * Whether to call process.exit(0) after shutdown sequence completes\n * @default true\n */\n useExit0?: boolean;\n\n /** Whether to auto-setup SIGTERM/SIGINT handlers for graceful shutdown\n * @default true\n */\n shouldSetupSignalHandlers?: boolean;\n\n /**\n * Global shutdown hook called before all clients are shut down\n * @default undefined\n */\n beforeShutdown?: (() => Promise<void>) | undefined;\n\n /**\n * Global shutdown hook called after all clients are shut down\n * @default undefined\n */\n onShutdown?: (() => Promise<void>) | undefined;\n\n /**\n * Enable liveness check optimization - if true and all clients are in both liveness and readiness checks,\n * liveness checks will be skipped when pod is already ready (readiness check passed)\n * @default true\n */\n enableLivenessOptimization?: boolean;\n}\n\n/**\n * List of clients and general configuration for HealthManager\n */\nexport interface HealthManagerOptions {\n /** Client configurations */\n clients?: {\n /** RabbitMQ client configuration - can be a single config or array of configs */\n rabbit?: ClientConfig<any> | ClientConfig<any>[];\n\n /** Sequelize instance configuration - can be a single config or array of configs */\n sequelize?: ClientConfig<any> | ClientConfig<any>[];\n\n /** Redis client configuration - can be a single config or array of configs */\n redis?: ClientConfig<any> | ClientConfig<any>[];\n\n /** Elasticsearch client configuration - can be a single config or array of configs */\n elasticsearch?: ClientConfig<any> | ClientConfig<any>[];\n };\n\n /** General configuration options */\n config?: HealthManagerConfig;\n\n /** Logger instance for logging messages */\n logger: LoggerInstanceManager;\n\n /** Optional HTTP or HTTPS server instance to manage during shutdown */\n server?: ServerConfig;\n}\n\nexport interface RedisClient {\n ping: () => Promise<string | void>;\n}\n\n/**\n * Sequelize database interface\n */\nexport interface SequelizeClient {\n query(sql: string | { query: string; values: unknown[]; }): Promise<any>;\n}\n\n/**\n * Elasticsearch client interface\n */\nexport interface ElasticsearchClient {\n ping: () => Promise<boolean>;\n}\n\nexport interface EventsClient {\n exitHandler: () => Promise<void>;\n}\n\n/**\n * RabbitMQ client interface\n */\nexport interface RabbitMQClient {\n isConnected: () => Promise<boolean> | boolean;\n}\n\nexport const CLIENT_TYPES = {\n RABBIT: 'rabbit',\n SEQUELIZE: 'sequelize',\n REDIS: 'redis',\n ELASTIC_SEARCH: 'elasticsearch',\n EVENTS: 'events',\n} as const;\n\nexport type ClientType = typeof CLIENT_TYPES[keyof typeof CLIENT_TYPES];\n"],"mappings":"AAyJA,MAAa,EAAe,CAC1B,OAAQ,SACR,UAAW,YACX,MAAO,QACP,eAAgB,gBAChB,OAAQ,SACT"}
|
package/package.json
CHANGED
package/lib/utils.cjs
DELETED
package/lib/utils.cjs.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"utils.cjs","names":[],"sources":["../src/utils.ts"],"sourcesContent":["\nimport { setTimeout } from 'node:timers/promises';\n\nexport const timeoutPromise = async (timeoutMs: number, errorMessage: string): Promise<never> => {\n await setTimeout(timeoutMs);\n throw new Error(errorMessage);\n};"],"mappings":"yFAGA,MAAa,EAAiB,MAAO,EAAmB,IAAyC,CAE/F,MADA,MAAA,EAAA,EAAA,YAAiB,EAAU,CACjB,MAAM,EAAa"}
|
package/lib/utils.js
DELETED
package/lib/utils.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"utils.js","names":[],"sources":["../src/utils.ts"],"sourcesContent":["\nimport { setTimeout } from 'node:timers/promises';\n\nexport const timeoutPromise = async (timeoutMs: number, errorMessage: string): Promise<never> => {\n await setTimeout(timeoutMs);\n throw new Error(errorMessage);\n};"],"mappings":"kDAGA,MAAa,EAAiB,MAAO,EAAmB,IAAyC,CAE/F,MADA,MAAM,EAAW,EAAU,CACjB,MAAM,EAAa"}
|