@catbee/utils 2.0.5 → 2.1.1

package/server/index.mjs

@@ -23,6 +23,7 @@
  */
 
 import express from 'express';
+import http from 'http';
 import https from 'https';
 import { HttpStatusCodes } from '@catbee/utils/http-status-codes';
 import { createFinalErrorResponse, SuccessResponse } from '@catbee/utils/response';
@@ -682,6 +683,15 @@ var DependencyErrors = {
   "cookie-parser": getDependencyErrorMessage("cookie-parser"),
   "@scalar/express-api-reference": getDependencyErrorMessage("@scalar/express-api-reference")
 };
+var SUPPORTED_HTTP_METHODS = /* @__PURE__ */ new Set([
+  "get",
+  "post",
+  "put",
+  "delete",
+  "patch",
+  "options",
+  "head"
+]);
 var ExpressServer = class {
   static {
     __name(this, "ExpressServer");
@@ -694,11 +704,11 @@ var ExpressServer = class {
   hooks;
   /** Global API prefix (from config) */
   globalPrefix;
-  /** Internal fallback router */
+  /** Primary root router mounted to the application */
   rootRouter;
-  /** User-supplied router */
-  externalRouter;
-  /** Internal Express app instance */
+  /** Set of registered sub-routers to prevent duplicate mounting */
+  mountedRouters = /* @__PURE__ */ new Set();
+  /** Express app instance */
   app;
   /** Set of active WebSocket connections */
   connections = /* @__PURE__ */ new Set();
@@ -706,6 +716,8 @@ var ExpressServer = class {
   isShuttingDown = false;
   /** Flag indicating if graceful shutdown handlers are registered */
   gracefulShutdownRegistered = false;
+  /** Map of registered signal listeners for clean teardown */
+  signalListeners = /* @__PURE__ */ new Map();
   /**
   * Collection of registered health check functions.
   * These are executed when the health check endpoint is accessed.
@@ -713,6 +725,8 @@ var ExpressServer = class {
   healthChecks = [];
   /** Promise that resolves when initialization (middleware + routes) is complete */
   initPromise;
+  /** In-flight start promise to protect against concurrent start() calls */
+  startPromise;
   /**
   * Initializes server with intelligent defaults and security best practices.
   * All settings can be customized via config and hooks.
@@ -815,6 +829,7 @@ var ExpressServer = class {
     this.setupBodyParsingMiddleware();
     this.setupCookieParsingMiddleware();
     await this.setupOpenApiMiddleware();
+    this.setupResponseHook();
   }
   /**
   * Set up basic middleware (trust proxy, request ID, context).
@@ -869,10 +884,15 @@ var ExpressServer = class {
   * Set up global headers middleware.
   */
   setupGlobalHeaders() {
+    const hasCustomHeaders = Boolean(this.config.globalHeaders && Object.keys(this.config.globalHeaders).length > 0);
+    const isMicroservice = Boolean(this.config.isMicroservice);
+    const hasServiceVersion = Boolean(this.config.serviceVersion?.enable);
+    if (!hasCustomHeaders && !isMicroservice && !hasServiceVersion) {
+      return;
+    }
     this.app.use((_req, res, next) => {
       if (this.config.globalHeaders) {
-        for (const key in this.config.globalHeaders) {
-          const value = this.config.globalHeaders[key];
+        for (const [key, value] of Object.entries(this.config.globalHeaders)) {
           res.setHeader(key, typeof value === "function" ? value() : value);
         }
       }
@@ -1067,6 +1087,11 @@ var ExpressServer = class {
         }, "Failed to mount OpenAPI docs");
       }
     }
+  }
+  /**
+  * Set up response preprocessing hook (applies global prefix if set).
+  */
+  setupResponseHook() {
     if (this.hooks.onResponse) {
       this.app.use(this.globalPrefix, this.hooks.onResponse);
     }
@@ -1085,8 +1110,7 @@ var ExpressServer = class {
     this.app.get(healthCheckPath, async (_req, res) => {
       return this.handleHealthCheckRequest(res);
     });
-    const routerToUse = this.externalRouter || this.rootRouter;
-    this.app.use(this.globalPrefix, routerToUse);
+    this.app.use(this.globalPrefix, this.rootRouter);
     await this.runHook("afterRoutes", this.app);
     this.app.use((req, res) => {
       const status = HttpStatusCodes.NOT_FOUND;
@@ -1221,11 +1245,15 @@ var ExpressServer = class {
   * Start the HTTP server and begin listening for requests.
   *
   * This method:
+  * - Protects against concurrent start() invocations
+  * - Awaits server initialization (middleware + routes)
   * - Executes beforeStart hooks
+  * - Creates the HTTP/HTTPS server instance
+  * - Sets up error handling and connection tracking BEFORE listening
+  * - Executes onServerCreated hook BEFORE listening
   * - Binds to the configured host/port
-  * - Sets up error handling for startup failures
-  * - Executes afterStart hooks on success
-  * - Logs startup information
+  * - Executes afterStart hooks on successful listen
+  * - Cleans up server reference and listeners on startup failure
   *
   * @returns Promise resolving to the running HTTP server instance
   * @throws Error if server fails to start or port is already in use
@@ -1235,33 +1263,68 @@ var ExpressServer = class {
       getLogger().warn("Server is already running, returning existing instance");
       return this.server;
     }
+    if (this.startPromise) {
+      return this.startPromise;
+    }
+    this.startPromise = this.doStart();
+    try {
+      return await this.startPromise;
+    } finally {
+      this.startPromise = void 0;
+    }
+  }
+  /**
+  * Internal implementation of server startup.
+  */
+  async doStart() {
     await this.initPromise;
     await this.runHook("beforeStart", this.app);
+    const server = this.createServerInstance();
+    this.server = server;
     return new Promise((resolve, reject) => {
-      try {
+      let isListening = false;
+      server.on("error", (err) => {
+        if (!isListening) {
+          getLogger().error({
+            err
+          }, "Server failed to start");
+          try {
+            server.removeAllListeners();
+            server.close();
+          } catch {
+          }
+          this.server = null;
+          this.connections.clear();
+          reject(err);
+        } else {
+          getLogger().error({
+            err
+          }, "Server runtime error");
+        }
+      });
+      this.setupConnectionTracking();
+      Promise.resolve(this.runHook("onServerCreated", server)).then(() => {
         const onListening = /* @__PURE__ */ __name(async () => {
+          isListening = true;
           this.logServerStartInfo();
-          if (this.server) await this.runHook("afterStart", this.server);
-          resolve(this.server);
+          await this.runHook("afterStart", server);
+          resolve(server);
         }, "onListening");
-        this.server = this.createServerInstance(onListening);
-        this.runHook("onServerCreated", this.server);
-        this.setupConnectionTracking();
-        this.setupServerErrorHandling(reject);
-      } catch (error) {
-        reject(error);
-      }
+        const listenArgs = [
+          this.config.port,
+          this.config.host,
+          onListening
+        ];
+        server.listen(...listenArgs);
+      }).catch((err) => {
+        server.emit("error", err instanceof Error ? err : new Error(String(err)));
+      });
     });
   }
   /**
-  * Create HTTP or HTTPS server instance.
+  * Create HTTP or HTTPS server instance (without listening).
   */
-  createServerInstance(onListening) {
-    const listenArgs = [
-      this.config.port,
-      this.config.host,
-      onListening
-    ];
+  createServerInstance() {
     if (this.config.https) {
       const httpsOptions = {
         ...this.config.https,
@@ -1274,9 +1337,9 @@ var ExpressServer = class {
       if (this.config.https.passphrase) {
         httpsOptions.passphrase = this.config.https.passphrase;
       }
-      return https.createServer(httpsOptions, this.app).listen(...listenArgs);
+      return https.createServer(httpsOptions, this.app);
     }
-    return this.app.listen(...listenArgs);
+    return http.createServer(this.app);
   }
   /**
   * Set up connection tracking for graceful shutdown.
@@ -1288,17 +1351,6 @@ var ExpressServer = class {
     });
   }
   /**
-  * Set up error handling for server startup.
-  */
-  setupServerErrorHandling(reject) {
-    this.server.on("error", (err) => {
-      getLogger().error({
-        err
-      }, "Server failed to start");
-      reject(err);
-    });
-  }
-  /**
   * Log server startup information.
   */
   logServerStartInfo() {
@@ -1360,6 +1412,7 @@ var ExpressServer = class {
       afterStopCalled = true;
       await this.runHook("afterStop");
     }, "runAfterStop");
+    server.closeIdleConnections?.();
     const serverClosePromise = new Promise((resolve, reject) => {
       server.close(async (err) => {
         if (timer) clearTimeout(timer);
@@ -1422,7 +1475,7 @@ var ExpressServer = class {
     }
     let signalHandled = false;
     signals.forEach((signal) => {
-      process.on(signal, async () => {
+      const handler = /* @__PURE__ */ __name(async () => {
         if (signalHandled) {
           getLogger().warn(`Ignoring duplicate ${signal}`);
           return;
@@ -1430,6 +1483,7 @@ var ExpressServer = class {
         signalHandled = true;
         getLogger().info(`Received ${signal}, initiating graceful shutdown...`);
         try {
+          this.disableGracefulShutdown();
           await this.stop(true);
           process.exit(0);
         } catch (err) {
@@ -1438,12 +1492,29 @@ var ExpressServer = class {
           }, "Shutdown failed");
           process.exit(1);
         }
-      });
+      }, "handler");
+      this.signalListeners.set(signal, handler);
+      process.on(signal, handler);
     });
     this.gracefulShutdownRegistered = true;
     return this;
   }
   /**
+  * Unregister graceful shutdown signal listeners.
+  * Useful for testing and dynamic server lifecycles to prevent memory and listener leaks.
+  */
+  disableGracefulShutdown() {
+    if (!this.gracefulShutdownRegistered) {
+      return this;
+    }
+    for (const [signal, handler] of this.signalListeners.entries()) {
+      process.removeListener(signal, handler);
+    }
+    this.signalListeners.clear();
+    this.gracefulShutdownRegistered = false;
+    return this;
+  }
+  /**
   * Destroy all active connections (gracefully if possible).
   * If a connection does not close cleanly, it will be force-destroyed.
   */
@@ -1456,32 +1527,56 @@ var ExpressServer = class {
     ];
     await Promise.allSettled(sockets.map((socket) => new Promise((resolve) => {
       socket.end();
-      const timer = setTimeout(() => {
-        socket.destroy();
-        resolve();
-      }, 1e3);
-      socket.once("close", () => {
-        clearTimeout(timer);
+      let timer;
+      const cleanup = /* @__PURE__ */ __name(() => {
+        if (timer) clearTimeout(timer);
+        socket.removeListener("close", onClose);
+        socket.removeListener("error", onError);
         resolve();
-      });
-      socket.once("error", () => {
-        clearTimeout(timer);
+      }, "cleanup");
+      const onClose = /* @__PURE__ */ __name(() => cleanup(), "onClose");
+      const onError = /* @__PURE__ */ __name(() => {
         socket.destroy();
-        resolve();
-      });
+        cleanup();
+      }, "onError");
+      timer = setTimeout(() => {
+        socket.destroy();
+        cleanup();
+      }, 1e3);
+      socket.once("close", onClose);
+      socket.once("error", onError);
     })));
     this.connections.clear();
     getLogger().info(`Closed ${sockets.length} active connection(s)`);
   }
   /**
-  * Set an externally created base router.
-  * This will override the internal rootRouter.
+  * Mount a base router onto the server's root router.
+  *
+  * Note: This attaches the supplied router to the root router pipeline.
+  * Duplicate mounting of the same router instance is ignored.
+  *
+  * @param router The Express router instance to mount
+  * @returns This instance for method chaining
   */
-  setBaseRouter(router) {
-    this.externalRouter = router;
+  addBaseRouter(router) {
+    if (this.mountedRouters.has(router)) {
+      return this;
+    }
+    this.mountedRouters.add(router);
+    this.rootRouter.use(router);
     return this;
   }
   /**
+  * Alias for `addBaseRouter` (maintained for backward compatibility).
+  * Mounts the supplied router onto the server's root router.
+  *
+  * @param router The Express router instance to mount
+  * @returns This instance for method chaining
+  */
+  setBaseRouter(router) {
+    return this.addBaseRouter(router);
+  }
+  /**
   * Create and register a new router (only used if not injecting one externally - use `setBaseRouter` instead).
   */
   createRouter(prefix = "") {
@@ -1501,27 +1596,73 @@ var ExpressServer = class {
   */
   registerRoute(methods, path, ...handlers) {
     const fullPath = this.normalizePath(path, true);
-    const routerToUse = this.externalRouter || this.rootRouter;
-    const methodMap = {
-      get: routerToUse.get.bind(routerToUse),
-      post: routerToUse.post.bind(routerToUse),
-      put: routerToUse.put.bind(routerToUse),
-      delete: routerToUse.delete.bind(routerToUse),
-      patch: routerToUse.patch.bind(routerToUse),
-      options: routerToUse.options.bind(routerToUse),
-      head: routerToUse.head.bind(routerToUse)
-    };
+    const routerToUse = this.rootRouter;
     methods.forEach((m) => {
-      const fn = methodMap[m];
-      if (fn) {
-        fn(fullPath, ...handlers);
-      } else {
+      const method = m.toLowerCase();
+      if (!SUPPORTED_HTTP_METHODS.has(method) || typeof routerToUse[method] !== "function") {
         throw new Error(`Unsupported HTTP method: ${m}`);
       }
+      routerToUse[method](fullPath, ...handlers);
     });
     return this;
   }
   /**
+  * Register a GET route handler.
+  */
+  get(path, ...handlers) {
+    return this.registerRoute([
+      "get"
+    ], path, ...handlers);
+  }
+  /**
+  * Register a POST route handler.
+  */
+  post(path, ...handlers) {
+    return this.registerRoute([
+      "post"
+    ], path, ...handlers);
+  }
+  /**
+  * Register a PUT route handler.
+  */
+  put(path, ...handlers) {
+    return this.registerRoute([
+      "put"
+    ], path, ...handlers);
+  }
+  /**
+  * Register a DELETE route handler.
+  */
+  delete(path, ...handlers) {
+    return this.registerRoute([
+      "delete"
+    ], path, ...handlers);
+  }
+  /**
+  * Register a PATCH route handler.
+  */
+  patch(path, ...handlers) {
+    return this.registerRoute([
+      "patch"
+    ], path, ...handlers);
+  }
+  /**
+  * Register an OPTIONS route handler.
+  */
+  options(path, ...handlers) {
+    return this.registerRoute([
+      "options"
+    ], path, ...handlers);
+  }
+  /**
+  * Register a HEAD route handler.
+  */
+  head(path, ...handlers) {
+    return this.registerRoute([
+      "head"
+    ], path, ...handlers);
+  }
+  /**
   * Register custom middleware with optional path restriction.
   *
   * Use this for:
@@ -1535,7 +1676,7 @@ var ExpressServer = class {
   * @returns This instance for method chaining
   */
   registerMiddleware(path, middleware) {
-    const routerToUse = this.externalRouter || this.rootRouter;
+    const routerToUse = this.rootRouter;
     if (typeof path === "string") {
       const normalizedPath = this.normalizePath(path);
       if (normalizedPath) {
@@ -1558,7 +1699,7 @@ var ExpressServer = class {
   */
   useMiddleware(...middlewares) {
     middlewares.forEach((middleware) => {
-      (this.externalRouter || this.rootRouter).use(middleware);
+      this.rootRouter.use(middleware);
     });
     return this;
   }