@mondart/nestjs-common-module-core 3.2.6 → 3.2.7

package/README.md

@@ -79,7 +79,11 @@ directly:
 ```ts
 import { ErrorResponse } from '@mondart/nestjs-common-module-core';
 
-new ErrorResponse({ name: 'NotFoundException', message: 'Not found', status: 404 });
+new ErrorResponse({
+  name: 'NotFoundException',
+  message: 'Not found',
+  status: 404,
+});
 ```
 
 Common request DTOs — `IdDto`, `IdsDto` (comma-separated `ids` query param),
@@ -208,6 +212,26 @@ for `{0}`-style `SharedMessages` interpolation, `EnvValidator` for validating
 `RxjsCatchErrorHelper` / `RxjsCustomTimeoutHelper` RxJS operators for mapping
 errors/timeouts on outbound calls to Nest exceptions.
 
+### Graceful HTTP shutdown
+
+Use `GracefulShutdownHelper.enable()` instead of `app.enableShutdownHooks()`
+in an HTTP service bootstrap:
+
+```ts
+import { GracefulShutdownHelper } from '@mondart/nestjs-common-module-core';
+
+const app = await NestFactory.create(AppModule);
+GracefulShutdownHelper.enable(app);
+await app.listen(appPort);
+```
+
+On `SIGTERM` or `SIGINT`, the helper rejects new requests with `503` and a
+`Connection: close` header, closes idle keep-alive connections, waits up to
+110 seconds for active responses, and then calls `app.close()` so Nest module,
+Kafka, queue, and database shutdown hooks run. Configure the container stop
+grace period above that deadline (the Swarm deployment uses two minutes).
+Do not register Nest's default shutdown signal handlers alongside this helper.
+
 ## Kafka-related exports
 
 `BaseKafkaEventDto`, `KafkaRequestDto`, `KafkaSuccessResponse`,

package/dist/helpers/graceful-shutdown.helper.d.ts

@@ -0,0 +1,15 @@
+import { INestApplication, Logger } from '@nestjs/common';
+export interface GracefulShutdownOptions {
+    timeoutMs?: number;
+    signals?: NodeJS.Signals[];
+    logger?: Pick<Logger, 'log' | 'warn' | 'error'>;
+}
+export interface GracefulShutdownController {
+    readonly isDraining: () => boolean;
+    readonly activeRequests: () => number;
+    shutdown(signal?: NodeJS.Signals): Promise<void>;
+}
+export declare class GracefulShutdownHelper {
+    static enable(app: INestApplication, options?: GracefulShutdownOptions): GracefulShutdownController;
+}
+//# sourceMappingURL=graceful-shutdown.helper.d.ts.map

package/dist/helpers/graceful-shutdown.helper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"graceful-shutdown.helper.d.ts","sourceRoot":"","sources":["../../src/helpers/graceful-shutdown.helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAU1D,MAAM,WAAW,uBAAuB;IACtC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;IAC3B,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;CACjD;AAED,MAAM,WAAW,0BAA0B;IACzC,QAAQ,CAAC,UAAU,EAAE,MAAM,OAAO,CAAC;IACnC,QAAQ,CAAC,cAAc,EAAE,MAAM,MAAM,CAAC;IACtC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAClD;AAWD,qBAAa,sBAAsB;IACjC,MAAM,CAAC,MAAM,CACX,GAAG,EAAE,gBAAgB,EACrB,OAAO,GAAE,uBAA4B,GACpC,0BAA0B;CAwG9B"}

package/dist/helpers/graceful-shutdown.helper.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GracefulShutdownHelper = void 0;
+const common_1 = require("@nestjs/common");
+const DEFAULT_TIMEOUT_MS = 110_000;
+class GracefulShutdownHelper {
+    static enable(app, options = {}) {
+        const server = app.getHttpServer();
+        const timeoutMs = options.timeoutMs ?? DEFAULT_TIMEOUT_MS;
+        const signals = options.signals ?? ['SIGTERM', 'SIGINT'];
+        const logger = options.logger ?? new common_1.Logger('GracefulShutdown');
+        let draining = false;
+        let activeRequests = 0;
+        let shutdownPromise;
+        app.use((_request, response, next) => {
+            if (draining) {
+                response.statusCode = 503;
+                response.setHeader('Connection', 'close');
+                response.setHeader('Content-Type', 'application/json');
+                response.end(JSON.stringify({
+                    statusCode: 503,
+                    message: 'Service is shutting down',
+                }));
+                return;
+            }
+            activeRequests += 1;
+            let completed = false;
+            const complete = () => {
+                if (completed)
+                    return;
+                completed = true;
+                activeRequests = Math.max(0, activeRequests - 1);
+            };
+            response.once('finish', complete);
+            response.once('close', complete);
+            next();
+        });
+        const shutdown = async (signal) => {
+            if (shutdownPromise)
+                return shutdownPromise;
+            shutdownPromise = (async () => {
+                draining = true;
+                logger.log(`${signal ?? 'Shutdown'} received; draining ${activeRequests} active request(s)`);
+                let closeServer = () => undefined;
+                const serverClosed = new Promise((resolve, reject) => {
+                    closeServer = (error) => {
+                        if (error)
+                            reject(error);
+                        else
+                            resolve();
+                    };
+                });
+                server.close(closeServer);
+                server.closeIdleConnections?.();
+                let timeout;
+                try {
+                    await Promise.race([
+                        serverClosed,
+                        new Promise((resolve) => {
+                            timeout = setTimeout(() => {
+                                logger.warn(`Graceful shutdown timed out with ${activeRequests} active request(s)`);
+                                server.closeAllConnections?.();
+                                resolve();
+                            }, timeoutMs);
+                            timeout.unref();
+                        }),
+                    ]);
+                    await app.close();
+                    logger.log('Graceful shutdown completed');
+                }
+                catch (error) {
+                    process.exitCode = 1;
+                    logger.error('Graceful shutdown failed', error instanceof Error ? error.stack : String(error));
+                    throw error;
+                }
+                finally {
+                    if (timeout)
+                        clearTimeout(timeout);
+                }
+            })();
+            return shutdownPromise;
+        };
+        for (const signal of signals) {
+            process.once(signal, () => {
+                void shutdown(signal).catch(() => undefined);
+            });
+        }
+        return {
+            isDraining: () => draining,
+            activeRequests: () => activeRequests,
+            shutdown,
+        };
+    }
+}
+exports.GracefulShutdownHelper = GracefulShutdownHelper;
+//# sourceMappingURL=graceful-shutdown.helper.js.map

package/dist/helpers/graceful-shutdown.helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"graceful-shutdown.helper.js","sourceRoot":"","sources":["../../src/helpers/graceful-shutdown.helper.ts"],"names":[],"mappings":";;;AAAA,2CAA0D;AAsB1D,MAAM,kBAAkB,GAAG,OAAO,CAAC;AASnC,MAAa,sBAAsB;IACjC,MAAM,CAAC,MAAM,CACX,GAAqB,EACrB,UAAmC,EAAE;QAErC,MAAM,MAAM,GAAG,GAAG,CAAC,aAAa,EAAY,CAAC;QAC7C,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,kBAAkB,CAAC;QAC1D,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QACzD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,IAAI,eAAM,CAAC,kBAAkB,CAAC,CAAC;QAChE,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,IAAI,cAAc,GAAG,CAAC,CAAC;QACvB,IAAI,eAA0C,CAAC;QAE/C,GAAG,CAAC,GAAG,CACL,CACE,QAAiB,EACjB,QAA0B,EAC1B,IAAgB,EACV,EAAE;YACR,IAAI,QAAQ,EAAE,CAAC;gBACb,QAAQ,CAAC,UAAU,GAAG,GAAG,CAAC;gBAC1B,QAAQ,CAAC,SAAS,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;gBAC1C,QAAQ,CAAC,SAAS,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;gBACvD,QAAQ,CAAC,GAAG,CACV,IAAI,CAAC,SAAS,CAAC;oBACb,UAAU,EAAE,GAAG;oBACf,OAAO,EAAE,0BAA0B;iBACpC,CAAC,CACH,CAAC;gBACF,OAAO;YACT,CAAC;YAED,cAAc,IAAI,CAAC,CAAC;YACpB,IAAI,SAAS,GAAG,KAAK,CAAC;YACtB,MAAM,QAAQ,GAAG,GAAS,EAAE;gBAC1B,IAAI,SAAS;oBAAE,OAAO;gBACtB,SAAS,GAAG,IAAI,CAAC;gBACjB,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,cAAc,GAAG,CAAC,CAAC,CAAC;YACnD,CAAC,CAAC;YACF,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YAClC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YACjC,IAAI,EAAE,CAAC;QACT,CAAC,CACF,CAAC;QAEF,MAAM,QAAQ,GAAG,KAAK,EAAE,MAAuB,EAAiB,EAAE;YAChE,IAAI,eAAe;gBAAE,OAAO,eAAe,CAAC;YAE5C,eAAe,GAAG,CAAC,KAAK,IAAmB,EAAE;gBAC3C,QAAQ,GAAG,IAAI,CAAC;gBAChB,MAAM,CAAC,GAAG,CACR,GAAG,MAAM,IAAI,UAAU,uBAAuB,cAAc,oBAAoB,CACjF,CAAC;gBAEF,IAAI,WAAW,GAA4B,GAAG,EAAE,CAAC,SAAS,CAAC;gBAC3D,MAAM,YAAY,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;oBACzD,WAAW,GAAG,CAAC,KAAa,EAAQ,EAAE;wBACpC,IAAI,KAAK;4BAAE,MAAM,CAAC,KAAK,CAAC,CAAC;;4BACpB,OAAO,EAAE,CAAC;oBACjB,CAAC,CAAC;gBACJ,CAAC,CAAC,CAAC;gBACH,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;gBAC1B,MAAM,CAAC,oBAAoB,EAAE,EAAE,CAAC;gBAEhC,IAAI,OAAmC,CAAC;gBACxC,IAAI,CAAC;oBACH,MAAM,OAAO,CAAC,IAAI,CAAC;wBACjB,YAAY;wBACZ,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;4BAC5B,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;gCACxB,MAAM,CAAC,IAAI,CACT,oCAAoC,cAAc,oBAAoB,CACvE,CAAC;gCACF,MAAM,CAAC,mBAAmB,EAAE,EAAE,CAAC;gCAC/B,OAAO,EAAE,CAAC;4BACZ,CAAC,EAAE,SAAS,CAAC,CAAC;4BACd,OAAO,CAAC,KAAK,EAAE,CAAC;wBAClB,CAAC,CAAC;qBACH,CAAC,CAAC;oBACH,MAAM,GAAG,CAAC,KAAK,EAAE,CAAC;oBAClB,MAAM,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;gBAC5C,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;oBACrB,MAAM,CAAC,KAAK,CACV,0BAA0B,EAC1B,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CACrD,CAAC;oBACF,MAAM,KAAK,CAAC;gBACd,CAAC;wBAAS,CAAC;oBACT,IAAI,OAAO;wBAAE,YAAY,CAAC,OAAO,CAAC,CAAC;gBACrC,CAAC;YACH,CAAC,CAAC,EAAE,CAAC;YAEL,OAAO,eAAe,CAAC;QACzB,CAAC,CAAC;QAEF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE;gBACxB,KAAK,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;YAC/C,CAAC,CAAC,CAAC;QACL,CAAC;QAED,OAAO;YACL,UAAU,EAAE,GAAG,EAAE,CAAC,QAAQ;YAC1B,cAAc,EAAE,GAAG,EAAE,CAAC,cAAc;YACpC,QAAQ;SACT,CAAC;IACJ,CAAC;CACF;AA5GD,wDA4GC"}

package/dist/helpers/index.d.ts

@@ -3,6 +3,7 @@ export * from './cli-command.helper';
 export * from './convert-string-case.helper';
 export * from './generate-hash.helper';
 export * from './get-env.helper';
+export * from './graceful-shutdown.helper';
 export * from './hmac.helper';
 export * from './i18n-message.helper';
 export * from './message-formatter.helper';

package/dist/helpers/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wBAAwB,CAAC;AACvC,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iBAAiB,CAAC;AAChC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uCAAuC,CAAC;AACtD,cAAc,uCAAuC,CAAC;AACtD,cAAc,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wBAAwB,CAAC;AACvC,cAAc,kBAAkB,CAAC;AACjC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iBAAiB,CAAC;AAChC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uCAAuC,CAAC;AACtD,cAAc,uCAAuC,CAAC;AACtD,cAAc,cAAc,CAAC"}

package/dist/helpers/index.js

@@ -19,6 +19,7 @@ __exportStar(require("./cli-command.helper"), exports);
 __exportStar(require("./convert-string-case.helper"), exports);
 __exportStar(require("./generate-hash.helper"), exports);
 __exportStar(require("./get-env.helper"), exports);
+__exportStar(require("./graceful-shutdown.helper"), exports);
 __exportStar(require("./hmac.helper"), exports);
 __exportStar(require("./i18n-message.helper"), exports);
 __exportStar(require("./message-formatter.helper"), exports);

package/dist/helpers/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,uDAAqC;AACrC,+DAA6C;AAC7C,yDAAuC;AACvC,mDAAiC;AACjC,gDAA8B;AAC9B,wDAAsC;AACtC,6DAA2C;AAC3C,kDAAgC;AAChC,6DAA2C;AAC3C,iDAA+B;AAC/B,qDAAmC;AACnC,4DAA0C;AAC1C,wEAAsD;AACtD,wEAAsD;AACtD,+CAA6B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,uDAAqC;AACrC,+DAA6C;AAC7C,yDAAuC;AACvC,mDAAiC;AACjC,6DAA2C;AAC3C,gDAA8B;AAC9B,wDAAsC;AACtC,6DAA2C;AAC3C,kDAAgC;AAChC,6DAA2C;AAC3C,iDAA+B;AAC/B,qDAAmC;AACnC,4DAA0C;AAC1C,wEAAsD;AACtD,wEAAsD;AACtD,+CAA6B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mondart/nestjs-common-module-core",
-  "version": "3.2.6",
+  "version": "3.2.7",
   "description": "Core utilities, DTOs, decorators, entities, filters, validators and helpers for NestJS.",
   "author": {
     "name": "Mondart"