@abyss-project/monitor 1.0.56 → 1.0.58

package/dist/frameworks/express/decorators.d.ts

@@ -49,4 +49,5 @@ export declare function Middlewares(middlewares: Middleware[]): any;
 export declare function Body(schema: Joi.Schema, options?: ValidationOptions): any;
 export declare function Params(schema: Joi.Schema, options?: ValidationOptions): any;
 export declare function Query(schema: Joi.Schema, options?: ValidationOptions): any;
+export declare function Killable(): any;
 export {};

package/dist/frameworks/express/decorators.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Query = exports.Params = exports.Body = exports.Middlewares = exports.Middleware = exports.Controller = exports.Patch = exports.Delete = exports.Put = exports.Post = exports.Get = void 0;
+exports.Killable = exports.Query = exports.Params = exports.Body = exports.Middlewares = exports.Middleware = exports.Controller = exports.Patch = exports.Delete = exports.Put = exports.Post = exports.Get = void 0;
 const types_1 = require("../../types");
 const _1 = require(".");
 const joi_to_swagger_1 = __importDefault(require("joi-to-swagger"));
@@ -161,3 +161,9 @@ function Query(schema, options) {
     };
 }
 exports.Query = Query;
+function Killable() {
+    return function (target, propertyKey, descriptor) {
+        Reflect.defineMetadata(_1.KILLABLE_WATERMARK, true, target, propertyKey);
+    };
+}
+exports.Killable = Killable;

package/dist/frameworks/express/metadata.d.ts

@@ -7,3 +7,4 @@ export declare const ROUTE_WATERMARK = "__route__";
 export declare const DOCS_WATERMARK = "__docs__";
 export declare const MIDDLEWARE_WATERMARK = "__middleware__";
 export declare const MIDDLEWARE_HOOK_WATERMARK = "__middleware_hook__";
+export declare const KILLABLE_WATERMARK = "__killable__";

package/dist/frameworks/express/metadata.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MIDDLEWARE_HOOK_WATERMARK = exports.MIDDLEWARE_WATERMARK = exports.DOCS_WATERMARK = exports.ROUTE_WATERMARK = exports.OPTIONS_WATERMARK = exports.METHOD_WATERMARK = exports.PATH_WATERMARK = exports.MASKED_WATERMARK = exports.CONTROLLER_WATERMARK = void 0;
+exports.KILLABLE_WATERMARK = exports.MIDDLEWARE_HOOK_WATERMARK = exports.MIDDLEWARE_WATERMARK = exports.DOCS_WATERMARK = exports.ROUTE_WATERMARK = exports.OPTIONS_WATERMARK = exports.METHOD_WATERMARK = exports.PATH_WATERMARK = exports.MASKED_WATERMARK = exports.CONTROLLER_WATERMARK = void 0;
 exports.CONTROLLER_WATERMARK = '__controller__';
 exports.MASKED_WATERMARK = '__masked__';
 exports.PATH_WATERMARK = '__path__';
@@ -10,3 +10,4 @@ exports.ROUTE_WATERMARK = '__route__';
 exports.DOCS_WATERMARK = '__docs__';
 exports.MIDDLEWARE_WATERMARK = '__middleware__';
 exports.MIDDLEWARE_HOOK_WATERMARK = '__middleware_hook__';
+exports.KILLABLE_WATERMARK = '__killable__';

package/dist/middlewares/request-tracker.middleware.d.ts

@@ -1,3 +1,8 @@
 import { Request, Response, NextFunction } from 'express-serve-static-core';
 import { Logger } from '../models/logger.model';
-export declare const createRequestTrackerMiddleware: (logger?: Logger) => (req: Request, res: Response, next: NextFunction) => void;
+export type IsKillableFn = (req: Request) => boolean;
+export interface RequestTrackerOptions {
+    logger?: Logger;
+    isKillable?: IsKillableFn;
+}
+export declare const createRequestTrackerMiddleware: (options?: RequestTrackerOptions) => (req: Request, res: Response, next: NextFunction) => void;

package/dist/middlewares/request-tracker.middleware.js

@@ -3,8 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createRequestTrackerMiddleware = void 0;
 const request_tracker_utils_1 = require("../utils/request-tracker.utils");
 const graceful_shutdown_types_1 = require("../types/graceful-shutdown.types");
-const createRequestTrackerMiddleware = (logger) => {
+const killable_route_utils_1 = require("../utils/killable-route.utils");
+const createRequestTrackerMiddleware = (options) => {
+    const { logger, isKillable } = options || {};
     return (req, res, next) => {
+        const requestIsKillable = isKillable ? isKillable(req) : (0, killable_route_utils_1.isRouteKillable)(req);
         if ((0, request_tracker_utils_1.getIsShuttingDown)()) {
             res.status(503).json({
                 errorCode: graceful_shutdown_types_1.GracefulShutdownErrorCode.SERVICE_UNAVAILABLE,
@@ -12,13 +15,13 @@ const createRequestTrackerMiddleware = (logger) => {
             });
             return;
         }
-        (0, request_tracker_utils_1.incrementActiveRequests)();
+        (0, request_tracker_utils_1.incrementActiveRequests)(requestIsKillable);
         let cleaned = false;
         const cleanup = () => {
             if (cleaned)
                 return;
             cleaned = true;
-            (0, request_tracker_utils_1.decrementActiveRequests)();
+            (0, request_tracker_utils_1.decrementActiveRequests)(requestIsKillable);
         };
         res.on('finish', cleanup);
         res.on('close', cleanup);

package/dist/utils/graceful-shutdown.utils.js

@@ -3,20 +3,39 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.setupGracefulShutdown = void 0;
 const request_tracker_utils_1 = require("../utils/request-tracker.utils");
 const graceful_shutdown_types_1 = require("../types/graceful-shutdown.types");
+const types_1 = require("../types");
 const DEFAULT_SHUTDOWN_TIMEOUT = 30000;
 const DEFAULT_REQUESTS_TIMEOUT = 25000;
 const DEFAULT_CHECK_INTERVAL = 100;
+const createGracefulShutdownLogger = (baseLogger) => {
+    const defaultPayload = {
+        context: 'GracefulShutdown',
+        scenario: types_1.LogScenario.SYSTEM_STARTUP,
+    };
+    const wrappedLogger = Object.create(baseLogger);
+    wrappedLogger.log = (message, payload, options) => baseLogger.log(message, { ...defaultPayload, ...payload }, options);
+    wrappedLogger.info = (message, payload, options) => baseLogger.info(message, { ...defaultPayload, ...payload }, options);
+    wrappedLogger.debug = (message, payload, options) => baseLogger.debug(message, { ...defaultPayload, ...payload }, options);
+    wrappedLogger.warn = (message, payload, options) => baseLogger.warn(message, { ...defaultPayload, ...payload }, options);
+    wrappedLogger.error = (message, payload, options) => baseLogger.error(message, { ...defaultPayload, ...payload }, options);
+    return wrappedLogger;
+};
 const setupGracefulShutdown = (config) => {
-    const { logger, httpServer, databases = [], messageQueues = [], caches = [], otherResources = [], shutdownTimeout = DEFAULT_SHUTDOWN_TIMEOUT, requestsTimeout = DEFAULT_REQUESTS_TIMEOUT, checkInterval = DEFAULT_CHECK_INTERVAL, } = config;
+    const { logger: baseLogger, httpServer, databases = [], messageQueues = [], caches = [], otherResources = [], shutdownTimeout = DEFAULT_SHUTDOWN_TIMEOUT, requestsTimeout = DEFAULT_REQUESTS_TIMEOUT, checkInterval = DEFAULT_CHECK_INTERVAL, } = config;
+    const logger = createGracefulShutdownLogger(baseLogger);
     const gracefulShutdown = async (signal) => {
         if ((0, request_tracker_utils_1.getIsShuttingDown)()) {
             logger.warn(`Already shutting down, ignoring ${signal}`);
             return;
         }
         (0, request_tracker_utils_1.setIsShuttingDown)(true);
-        logger.info(`Received ${signal}, starting graceful shutdown...`, {
+        const totalRequests = (0, request_tracker_utils_1.getTotalRequestsCount)();
+        const killableRequests = (0, request_tracker_utils_1.getKillableRequestsCount)();
+        logger.log(`Received ${signal}, starting graceful shutdown...`, {
             data: {
                 activeRequests: (0, request_tracker_utils_1.getActiveRequestsCount)(),
+                killableRequests,
+                totalRequests,
             },
         });
         const forceShutdownTimer = setTimeout(() => {
@@ -31,7 +50,7 @@ const setupGracefulShutdown = (config) => {
         try {
             const activeRequests = (0, request_tracker_utils_1.getActiveRequestsCount)();
             if (activeRequests > 0) {
-                logger.info(`Waiting for ${activeRequests} active requests to complete...`, {
+                logger.log(`Waiting for ${activeRequests} active requests to complete...`, {
                     data: {
                         activeRequests,
                         timeoutMs: requestsTimeout,
@@ -60,7 +79,7 @@ const setupGracefulShutdown = (config) => {
                             reject(err);
                         }
                         else {
-                            logger.info('HTTP server closed, no longer accepting new connections');
+                            logger.log('HTTP server closed, no longer accepting new connections');
                             resolve();
                         }
                     });
@@ -70,7 +89,7 @@ const setupGracefulShutdown = (config) => {
                 await Promise.allSettled(messageQueues.map(async (mq) => {
                     try {
                         await mq.close();
-                        logger.info(`Message queue connection closed${mq.name ? `: ${mq.name}` : ''}`);
+                        logger.log(`Message queue connection closed${mq.name ? `: ${mq.name}` : ''}`);
                     }
                     catch (error) {
                         logger.error(`Error closing message queue connection${mq.name ? `: ${mq.name}` : ''}`, {
@@ -86,7 +105,7 @@ const setupGracefulShutdown = (config) => {
                 await Promise.allSettled(caches.map(async (cache) => {
                     try {
                         await cache.close();
-                        logger.info(`Cache connection closed${cache.name ? `: ${cache.name}` : ''}`);
+                        logger.log(`Cache connection closed${cache.name ? `: ${cache.name}` : ''}`);
                     }
                     catch (error) {
                         logger.error(`Error closing cache connection${cache.name ? `: ${cache.name}` : ''}`, {
@@ -102,7 +121,7 @@ const setupGracefulShutdown = (config) => {
                 await Promise.allSettled(databases.map(async (db) => {
                     try {
                         await db.close();
-                        logger.info(`Database connection closed${db.name ? `: ${db.name}` : ''}`);
+                        logger.log(`Database connection closed${db.name ? `: ${db.name}` : ''}`);
                     }
                     catch (error) {
                         logger.error(`Error closing database connection${db.name ? `: ${db.name}` : ''}`, {
@@ -118,7 +137,7 @@ const setupGracefulShutdown = (config) => {
                 await Promise.allSettled(otherResources.map(async (resource) => {
                     try {
                         await resource.close();
-                        logger.info(`Resource closed${resource.name ? `: ${resource.name}` : ''}`);
+                        logger.log(`Resource closed${resource.name ? `: ${resource.name}` : ''}`);
                     }
                     catch (error) {
                         logger.error(`Error closing resource${resource.name ? `: ${resource.name}` : ''}`, {
@@ -130,7 +149,7 @@ const setupGracefulShutdown = (config) => {
                     }
                 }));
             }
-            logger.info('Graceful shutdown completed successfully');
+            logger.log('Graceful shutdown completed successfully');
             clearTimeout(forceShutdownTimer);
             process.exit(0);
         }
@@ -164,6 +183,6 @@ const setupGracefulShutdown = (config) => {
         });
         gracefulShutdown('unhandledRejection');
     });
-    logger.info('Graceful shutdown handlers registered');
+    logger.log('Graceful shutdown handlers registered');
 };
 exports.setupGracefulShutdown = setupGracefulShutdown;

package/dist/utils/killable-route.utils.d.ts

@@ -0,0 +1,3 @@
+import 'reflect-metadata';
+import { Request } from 'express-serve-static-core';
+export declare const isRouteKillable: (req: Request) => boolean;

package/dist/utils/killable-route.utils.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isRouteKillable = void 0;
+require("reflect-metadata");
+const metadata_1 = require("../frameworks/express/metadata");
+const isRouteKillable = (req) => {
+    const route = req.route;
+    if (!route || !route.stack || route.stack.length === 0) {
+        return false;
+    }
+    for (const layer of route.stack) {
+        const handler = layer.handle;
+        if (!handler)
+            continue;
+        const prototype = Object.getPrototypeOf(handler);
+        if (prototype && prototype.constructor) {
+            const propertyKey = handler.name;
+            const isKillable = Reflect.getMetadata(metadata_1.KILLABLE_WATERMARK, prototype.constructor.prototype, propertyKey);
+            if (isKillable) {
+                return true;
+            }
+        }
+    }
+    return false;
+};
+exports.isRouteKillable = isRouteKillable;

package/dist/utils/request-tracker.utils.d.ts

@@ -1,7 +1,9 @@
 import { Logger } from '../models/logger.model';
 export declare const getActiveRequestsCount: () => number;
+export declare const getKillableRequestsCount: () => number;
+export declare const getTotalRequestsCount: () => number;
 export declare const getIsShuttingDown: () => boolean;
 export declare const setIsShuttingDown: (value: boolean) => void;
-export declare const incrementActiveRequests: () => void;
-export declare const decrementActiveRequests: () => void;
+export declare const incrementActiveRequests: (isKillable?: boolean) => void;
+export declare const decrementActiveRequests: (isKillable?: boolean) => void;
 export declare const waitForActiveRequests: (timeout?: number, checkInterval?: number, logger?: Logger) => Promise<void>;

package/dist/utils/request-tracker.utils.js

@@ -1,23 +1,38 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.waitForActiveRequests = exports.decrementActiveRequests = exports.incrementActiveRequests = exports.setIsShuttingDown = exports.getIsShuttingDown = exports.getActiveRequestsCount = void 0;
+exports.waitForActiveRequests = exports.decrementActiveRequests = exports.incrementActiveRequests = exports.setIsShuttingDown = exports.getIsShuttingDown = exports.getTotalRequestsCount = exports.getKillableRequestsCount = exports.getActiveRequestsCount = void 0;
 const graceful_shutdown_types_1 = require("../types/graceful-shutdown.types");
 let activeRequests = 0;
+let killableRequests = 0;
 let isShuttingDown = false;
 const getActiveRequestsCount = () => activeRequests;
 exports.getActiveRequestsCount = getActiveRequestsCount;
+const getKillableRequestsCount = () => killableRequests;
+exports.getKillableRequestsCount = getKillableRequestsCount;
+const getTotalRequestsCount = () => activeRequests + killableRequests;
+exports.getTotalRequestsCount = getTotalRequestsCount;
 const getIsShuttingDown = () => isShuttingDown;
 exports.getIsShuttingDown = getIsShuttingDown;
 const setIsShuttingDown = (value) => {
     isShuttingDown = value;
 };
 exports.setIsShuttingDown = setIsShuttingDown;
-const incrementActiveRequests = () => {
-    activeRequests++;
+const incrementActiveRequests = (isKillable = false) => {
+    if (isKillable) {
+        killableRequests++;
+    }
+    else {
+        activeRequests++;
+    }
 };
 exports.incrementActiveRequests = incrementActiveRequests;
-const decrementActiveRequests = () => {
-    activeRequests--;
+const decrementActiveRequests = (isKillable = false) => {
+    if (isKillable) {
+        killableRequests--;
+    }
+    else {
+        activeRequests--;
+    }
 };
 exports.decrementActiveRequests = decrementActiveRequests;
 const waitForActiveRequests = async (timeout = 30000, checkInterval = 100, logger) => {
@@ -25,7 +40,7 @@ const waitForActiveRequests = async (timeout = 30000, checkInterval = 100, logge
     return new Promise((resolve, reject) => {
         const check = () => {
             if (activeRequests === 0) {
-                logger === null || logger === void 0 ? void 0 : logger.info('All active requests completed');
+                logger === null || logger === void 0 ? void 0 : logger.log('All active requests completed');
                 resolve();
                 return;
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abyss-project/monitor",
-  "version": "1.0.56",
+  "version": "1.0.58",
   "description": "Core package to interact with Abyss-Monitor",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",