@moreapp/common-nodejs 0.12.7 → 0.13.0

package/dist/observability/TerminationHandler.d.ts

@@ -3,9 +3,11 @@ import ExpressRequestTracker from "./ExpressRequestTracker";
 import ObservabilityServer from "./ObservabilityServer";
 export default class TerminationHandler {
     private readonly server;
-    private readonly hs;
+    private readonly observabilityServer;
     private readonly requestTracker;
+    private readonly onTermination;
     private readonly sockets;
-    constructor(server: Server, hs: ObservabilityServer, requestTracker: ExpressRequestTracker);
+    private isShuttingDown;
+    constructor(server: Server, observabilityServer: ObservabilityServer, requestTracker: ExpressRequestTracker, onTermination?: () => Promise<void>);
     shutdown(): void;
 }

package/dist/observability/TerminationHandler.js

@@ -10,13 +10,16 @@ const TERMINATION_SIGNALS = ["SIGTERM", "SIGHUP", "SIGINT"];
 const SHUTDOWN_TIMEOUT = 30_000;
 class TerminationHandler {
     server;
-    hs;
+    observabilityServer;
     requestTracker;
+    onTermination;
     sockets = new Set();
-    constructor(server, hs, requestTracker) {
+    isShuttingDown = false;
+    constructor(server, observabilityServer, requestTracker, onTermination = () => Promise.resolve()) {
         this.server = server;
-        this.hs = hs;
+        this.observabilityServer = observabilityServer;
         this.requestTracker = requestTracker;
+        this.onTermination = onTermination;
         for (const signal of TERMINATION_SIGNALS) {
             process.on(signal, () => {
                 logger_1.logger.info("Received termination signal", { signal });
@@ -27,21 +30,35 @@ class TerminationHandler {
             this.sockets.add(socket);
             socket.on("close", () => this.sockets.delete(socket));
         });
+        // Handles errors like `EADDRINUSE`
+        server.on("error", (err) => {
+            logger_1.logger.error("Server threw an unrecoverable error, shutting down", err);
+            this.shutdown();
+        });
     }
     shutdown() {
-        this.hs.setReady(false);
+        if (this.isShuttingDown) {
+            return;
+        }
+        this.isShuttingDown = true;
+        this.observabilityServer.setReady(false);
         logger_1.logger.info("Stopping server");
         this.server.close();
         const interval = (0, node_timers_1.setInterval)(() => {
             const activeRequests = this.requestTracker.nrOfActiveRequests();
             if (activeRequests === 0) {
-                (0, node_timers_1.clearInterval)(interval);
-                // Destroy any remaining sockets
-                this.sockets.forEach((socket) => socket.destroy());
-                void Promise.all([this.hs.stop(), tracer_1.default.shutdown()]).finally(() => {
-                    logger_1.logger.info("Server stopped");
-                    process.exit(0);
-                });
+                void (async () => {
+                    (0, node_timers_1.clearInterval)(interval);
+                    // Destroy any remaining sockets
+                    this.sockets.forEach((socket) => socket.destroy());
+                    await this.onTermination().catch((err) => logger_1.logger.error("Error occurred in termination handler", err));
+                    void Promise.all([this.observabilityServer.stop(), tracer_1.default.shutdown()])
+                        .catch((err) => logger_1.logger.error("Error occurred during shutdown", err))
+                        .finally(() => {
+                        logger_1.logger.info("Server stopped");
+                        process.exit(0);
+                    });
+                })();
             }
             else {
                 logger_1.logger.info("Waiting for requests to finish", { activeRequests });

package/dist/observability/__tests__/TerminationHandler.test.js

@@ -40,6 +40,7 @@ const vitest_1 = require("vitest");
 const node_events_1 = require("node:events");
 const timers = __importStar(require("node:timers"));
 const TerminationHandler_1 = __importDefault(require("../TerminationHandler"));
+const logger_1 = require("../../logger");
 vitest_1.vi.mock("../../logger", () => ({
     logger: {
         info: vitest_1.vi.fn(),
@@ -115,12 +116,9 @@ vitest_1.vi.mock("node:timers", () => ({
         (0, vitest_1.expect)(server.close).toHaveBeenCalled();
         // First interval tick should see 0 active and exit
         intervalCb?.();
-        // ensure hs.stop called
-        (0, vitest_1.expect)(hs.stop).toHaveBeenCalled();
-        // Wait for Promise.all and .finally() to execute
+        // Wait for the async IIFE (await onTermination + Promise.all().finally()) to settle
         await new Promise((resolve) => setImmediate(resolve));
-        // Trigger log flush timeout (index 1, after the 30s timeout at index 0)
-        timeoutCallbacks[1]?.();
+        (0, vitest_1.expect)(hs.stop).toHaveBeenCalled();
         (0, vitest_1.expect)(exitSpy).toHaveBeenCalledWith(0);
     });
     (0, vitest_1.test)("shutdown polls until requests finish then exits 0", async () => {
@@ -140,11 +138,9 @@ vitest_1.vi.mock("node:timers", () => ({
         (0, vitest_1.expect)(exitSpy).not.toHaveBeenCalled();
         // Second tick: now 0
         intervalCb?.();
-        (0, vitest_1.expect)(hs.stop).toHaveBeenCalled();
-        // Wait for Promise.all and .finally() to execute
+        // Wait for the async IIFE (await onTermination + Promise.all().finally()) to settle
         await new Promise((resolve) => setImmediate(resolve));
-        // Trigger log flush timeout (index 1, after the 30s timeout at index 0)
-        timeoutCallbacks[1]?.();
+        (0, vitest_1.expect)(hs.stop).toHaveBeenCalled();
         (0, vitest_1.expect)(exitSpy).toHaveBeenCalledWith(0);
     });
     (0, vitest_1.test)("forceful stop after 30s destroys sockets and exits 1", () => {
@@ -168,4 +164,71 @@ vitest_1.vi.mock("node:timers", () => ({
         (0, vitest_1.expect)(socket.destroy).toHaveBeenCalled();
         (0, vitest_1.expect)(exitSpy).toHaveBeenCalledWith(1);
     });
+    (0, vitest_1.test)("invokes onTermination during graceful shutdown then exits 0", async () => {
+        const server = createFakeServer();
+        const hs = {
+            setReady: vitest_1.vi.fn(),
+            stop: vitest_1.vi.fn(() => Promise.resolve()),
+        };
+        const requestTracker = { nrOfActiveRequests: vitest_1.vi.fn(() => 0) };
+        const onTermination = vitest_1.vi.fn(() => Promise.resolve());
+        const exitSpy = vitest_1.vi.spyOn(process, "exit").mockImplementation(() => undefined);
+        new TerminationHandler_1.default(server, hs, requestTracker, onTermination).shutdown();
+        // First interval tick sees 0 active and runs the graceful path
+        intervalCb?.();
+        // Wait for the async IIFE (await onTermination + Promise.all().finally()) to settle
+        await new Promise((resolve) => setImmediate(resolve));
+        (0, vitest_1.expect)(onTermination).toHaveBeenCalledTimes(1);
+        (0, vitest_1.expect)(exitSpy).toHaveBeenCalledWith(0);
+    });
+    (0, vitest_1.test)("catches and logs onTermination rejection but still exits 0", async () => {
+        const server = createFakeServer();
+        const hs = {
+            setReady: vitest_1.vi.fn(),
+            stop: vitest_1.vi.fn(() => Promise.resolve()),
+        };
+        const requestTracker = { nrOfActiveRequests: vitest_1.vi.fn(() => 0) };
+        const onTermination = vitest_1.vi.fn(() => Promise.reject(new Error("boom")));
+        const exitSpy = vitest_1.vi.spyOn(process, "exit").mockImplementation(() => undefined);
+        new TerminationHandler_1.default(server, hs, requestTracker, onTermination).shutdown();
+        intervalCb?.();
+        await new Promise((resolve) => setImmediate(resolve));
+        (0, vitest_1.expect)(vitest_1.vi.mocked(logger_1.logger.error)).toHaveBeenCalledWith("Error occurred in termination handler", vitest_1.expect.any(Error));
+        // A failing hook must not divert to the forceful exit-1 path
+        (0, vitest_1.expect)(exitSpy).toHaveBeenCalledWith(0);
+    });
+    (0, vitest_1.test)("shuts down when the server emits an error", async () => {
+        const server = createFakeServer();
+        const hs = {
+            setReady: vitest_1.vi.fn(),
+            stop: vitest_1.vi.fn(() => Promise.resolve()),
+        };
+        const requestTracker = { nrOfActiveRequests: vitest_1.vi.fn(() => 0) };
+        const exitSpy = vitest_1.vi.spyOn(process, "exit").mockImplementation(() => undefined);
+        new TerminationHandler_1.default(server, hs, requestTracker);
+        // e.g. EADDRINUSE surfaces as a server "error" event
+        server.emit("error", new Error("EADDRINUSE"));
+        (0, vitest_1.expect)(vitest_1.vi.mocked(logger_1.logger.error)).toHaveBeenCalledWith("Server threw an unrecoverable error, shutting down", vitest_1.expect.any(Error));
+        (0, vitest_1.expect)(hs.setReady).toHaveBeenCalledWith(false);
+        (0, vitest_1.expect)(server.close).toHaveBeenCalled();
+        intervalCb?.();
+        await new Promise((resolve) => setImmediate(resolve));
+        (0, vitest_1.expect)(exitSpy).toHaveBeenCalledWith(0);
+    });
+    (0, vitest_1.test)("ignores a second shutdown call", () => {
+        const server = createFakeServer();
+        const hs = {
+            setReady: vitest_1.vi.fn(),
+            stop: vitest_1.vi.fn(() => Promise.resolve()),
+        };
+        // Never reaches 0 so the poll loop stays active between the two calls
+        const requestTracker = { nrOfActiveRequests: vitest_1.vi.fn(() => 5) };
+        vitest_1.vi.spyOn(process, "exit").mockImplementation(() => undefined);
+        const th = new TerminationHandler_1.default(server, hs, requestTracker);
+        th.shutdown();
+        th.shutdown();
+        (0, vitest_1.expect)(hs.setReady).toHaveBeenCalledTimes(1);
+        (0, vitest_1.expect)(server.close).toHaveBeenCalledTimes(1);
+        (0, vitest_1.expect)(vitest_1.vi.mocked(timers.setInterval)).toHaveBeenCalledTimes(1);
+    });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moreapp/common-nodejs",
-  "version": "0.12.7",
+  "version": "0.13.0",
   "license": "UNLICENSED",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",