@expressots/adapter-express 3.0.0-beta.4.2 → 4.0.0-preview.1

package/lib/esm/adapter-express/application-express.js

@@ -0,0 +1,1300 @@
+import express from "express";
+import * as fs from "node:fs";
+// Note: We use the global `process` object directly instead of importing it
+// because signal handlers (SIGTERM, SIGINT, etc.) don't work correctly when
+// process is imported as an ES module in CommonJS compiled code.
+import { AppContainer, Console, INTERCEPTOR_METADATA_KEY, LifecycleRegistry, Logger, Middleware, ProviderManager, BannerGenerator, MetricsCollector, resolveBannerConfig, } from "@expressots/core";
+/**
+ * Metadata key used by `@provide` (and friends) in `@expressots/core`'s
+ * binding-decorator module. The constant lives at an internal path
+ * (`di/binding-decorator/constants`) so we hardcode the string here —
+ * it's part of the framework's stable runtime contract and is what
+ * `MetricsCollector` reads for its own `providers` count.
+ */
+const PROVIDE_METADATA_KEY = "inversify-binding-decorators:provide";
+import { RenderEngine } from "@expressots/shared";
+import { HttpStatusCodeMiddleware } from "./express-utils/http-status-middleware.js";
+import { InversifyExpressServer } from "./express-utils/inversify-express-server.js";
+import { setEngineEjs, setEngineHandlebars, setEnginePug } from "./render/engine.js";
+import { getControllersFromMetadata, getControllersFromContainer, getControllerMethodMetadata, getControllerMetadata, } from "./express-utils/utils.js";
+import { initializeStudio, stopStudio, isStudioEnabled, reportStudioRuntimeInfo, } from "./studio/index.js";
+/**
+ * The AppExpress class provides methods for configuring and running an Express application.
+ * @class AppExpress
+ * @implements {IWebServer} - Interface for the WebServer application implementation.
+ * @extends {ApplicationBase} - Base class for the application implementation that provides lifecycle hooks.
+ * @method configure - Configures the InversifyJS container.
+ * @method listen - Start listening on the given port and environment.
+ * @method setGlobalRoutePrefix - Sets the global route prefix for the application.
+ * @method setEngine - Configures the application's view engine based on the provided configuration options.
+ * @method isDevelopment - Verifies if the current environment is development.
+ */
+export class AppExpress {
+    logger = new Logger();
+    console = new Console();
+    app;
+    serverInstance = null;
+    port;
+    environment;
+    appContainer;
+    globalPrefix = "/";
+    middlewareManager;
+    middlewares = [];
+    providerManager;
+    renderOptions = {};
+    lifecycleRegistry;
+    isShuttingDown = false;
+    bannerGenerator = null;
+    bannerConfig;
+    shutdownHandlers = new Map();
+    studioConfig = {};
+    /**
+     * Latest snapshot of application metrics produced by `MetricsCollector`
+     * during banner display. We cache it so that `reportStudioRuntimeInfo`
+     * can forward the *runtime* provider/interceptor counts (which match
+     * what the CLI banner shows) to the Studio Agent without recomputing.
+     */
+    lastApplicationMetrics = null;
+    /** Track active connections for force-close during shutdown */
+    activeConnections = new Set();
+    /** Timeout for force-closing connections during shutdown (ms) */
+    shutdownTimeout = 5000;
+    /** Number of retries when port is in use (for hot-reload scenarios) */
+    portRetryAttempts = 10;
+    /** Delay between port retry attempts (ms) */
+    portRetryDelay = 500;
+    // Log buffering for banner-first display
+    // IMPORTANT: All these properties must be declared BEFORE initBuffering!
+    static originalStdoutWrite = null;
+    static originalStderrWrite = null;
+    static logBuffer = [];
+    static isBuffering = false;
+    static bufferingInitialized = false;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    static originalGlobalConsole = null;
+    // Initialize buffering when AppExpress class is loaded (before any instances are created)
+    // This ensures ALL logs are buffered from the very beginning for the full template.
+    // The micro() function explicitly disables this buffering since it doesn't use the banner system.
+    // This MUST be declared AFTER all the static properties it uses!
+    static initBuffering = (() => {
+        AppExpress.startLogBuffering();
+        return true;
+    })();
+    /**
+     * Disable log buffering. Called by micro() to restore normal console output
+     * since micro API doesn't use the banner system.
+     * @public API
+     */
+    static disableBuffering() {
+        AppExpress.stopBuffering();
+        // Clear any buffered logs since micro() doesn't need them
+        AppExpress.logBuffer = [];
+    }
+    /**
+     * Start buffering all console output.
+     * This captures both console.log and direct process.stdout.write calls.
+     * @private
+     */
+    static startLogBuffering() {
+        if (AppExpress.isBuffering)
+            return;
+        // Store original streams
+        AppExpress.originalStdoutWrite = process.stdout.write.bind(process.stdout);
+        AppExpress.originalStderrWrite = process.stderr.write.bind(process.stderr);
+        // Create wrapper functions that use fs.writeSync directly (always works
+        // in both CJS and ESM scope - hence the static `node:fs` import above).
+        const createOriginalConsoleMethod = (useStderr = false) => (...args) => {
+            const message = args
+                .map((a) => {
+                if (typeof a === "object" && a !== null) {
+                    try {
+                        return JSON.stringify(a, null, 2);
+                    }
+                    catch {
+                        return String(a);
+                    }
+                }
+                return String(a);
+            })
+                .join(" ") + "\n";
+            // Use fs.writeSync directly - this always works
+            fs.writeSync(useStderr ? 2 : 1, message);
+        };
+        AppExpress.originalGlobalConsole = {
+            log: createOriginalConsoleMethod(false),
+            info: createOriginalConsoleMethod(false),
+            warn: createOriginalConsoleMethod(true),
+            error: createOriginalConsoleMethod(true),
+            debug: createOriginalConsoleMethod(false),
+        };
+        AppExpress.logBuffer = [];
+        AppExpress.isBuffering = true;
+        // Create buffering functions for console methods
+        const bufferConsoleMethod = () => (...args) => {
+            const message = args
+                .map((a) => (typeof a === "object" && a !== null ? JSON.stringify(a) : String(a)))
+                .join(" ") + "\n";
+            AppExpress.logBuffer.push(message);
+        };
+        // Override console methods directly (not replacing the console object)
+        // This ensures even cached references to console.log will use the buffered version
+        console.log = bufferConsoleMethod();
+        console.info = bufferConsoleMethod();
+        console.warn = bufferConsoleMethod();
+        console.error = bufferConsoleMethod();
+        console.debug = bufferConsoleMethod();
+        // Also override process.stdout.write for direct writes (like our Logger)
+        const bufferWrite = (chunk) => {
+            const str = typeof chunk === "string" ? chunk : Buffer.from(chunk).toString();
+            AppExpress.logBuffer.push(str);
+            return true;
+        };
+        // Use direct assignment for overriding
+        process.stdout.write = bufferWrite;
+        process.stderr.write = bufferWrite;
+    }
+    /**
+     * Stop buffering but keep the buffered logs for later flushing.
+     * This restores normal console/stdout output.
+     * @private
+     */
+    static stopBuffering() {
+        if (!AppExpress.isBuffering)
+            return;
+        // Restore original console methods using our wrapper functions
+        if (AppExpress.originalGlobalConsole) {
+            console.log = AppExpress.originalGlobalConsole.log;
+            console.info = AppExpress.originalGlobalConsole.info;
+            console.warn = AppExpress.originalGlobalConsole.warn;
+            console.error = AppExpress.originalGlobalConsole.error;
+            console.debug = AppExpress.originalGlobalConsole.debug;
+        }
+        // Restore original stdout/stderr by direct assignment
+        // (Object.defineProperty may not work correctly for stream.write)
+        if (AppExpress.originalStdoutWrite) {
+            process.stdout.write =
+                AppExpress.originalStdoutWrite;
+        }
+        if (AppExpress.originalStderrWrite) {
+            process.stderr.write =
+                AppExpress.originalStderrWrite;
+        }
+        AppExpress.isBuffering = false;
+    }
+    /**
+     * Flush all buffered logs to stdout.
+     * Should be called after stopBuffering() and after displaying the banner.
+     * @private
+     */
+    static flushBufferedLogs() {
+        const logs = AppExpress.logBuffer;
+        AppExpress.logBuffer = [];
+        for (const log of logs) {
+            if (AppExpress.originalStdoutWrite) {
+                AppExpress.originalStdoutWrite.call(process.stdout, log);
+            }
+            else {
+                process.stdout.write(log);
+            }
+        }
+    }
+    constructor() {
+        // Buffering is already started via static initialization (initBuffering)
+        // This ensures ALL logs are captured from the very beginning
+        this.globalConfiguration();
+    }
+    /**
+     * Helper function to handle both sync and async method calls.
+     * If the result is a Promise, awaits it; otherwise returns immediately.
+     * @private
+     */
+    async handleSyncOrAsync(result) {
+        if (result instanceof Promise) {
+            return await result;
+        }
+    }
+    /**
+     * Implement this method to set up global configurations for the server.
+     * This method is called synchronously in the constructor before any other
+     * server initialization methods. Use this method to configure global settings
+     * that apply to the entire server application.
+     *
+     * Note: This method is synchronous and called during object construction.
+     * For asynchronous initialization, use `configureServices()` instead.
+     *
+     * @abstract
+     * @returns {void}
+     * @public API
+     */
+    globalConfiguration() { }
+    /**
+     * Implement this method to set up required services or configurations before
+     * the server starts. This is essential for initializing dependencies or settings
+     * necessary for server operation. Supports both synchronous and asynchronous setup.
+     *
+     * @abstract
+     * @returns {void | Promise<void>}
+     * @public API
+     */
+    configureServices() { }
+    /**
+     * Implement this method to execute actions or configurations after the server
+     * has started. Use this for operations that need to run once the server is
+     * operational. Supports both synchronous and asynchronous execution.
+     *
+     * @abstract
+     * @returns {void | Promise<void>}
+     * @public API
+     */
+    postServerInitialization() { }
+    /**
+     * Implement this method to handle cleanup and final actions when the server
+     * is shutting down. Ideal for closing resources, stopping tasks, or other
+     * cleanup procedures to ensure a graceful server shutdown. Supports both
+     * synchronous and asynchronous cleanup.
+     *
+     * The signal parameter indicates what triggered the shutdown:
+     * - SIGTERM: Graceful termination (e.g., Kubernetes pod shutdown)
+     * - SIGINT: User interrupt (e.g., Ctrl+C)
+     * - SIGHUP: Terminal hangup
+     * - SIGQUIT: Quit with core dump
+     * - SIGBREAK: Windows break signal
+     *
+     * @abstract
+     * @param signal - The signal that triggered the shutdown (optional for backward compatibility)
+     * @returns {void | Promise<void>}
+     * @public API
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    serverShutdown(signal) { }
+    /**
+     * Performs graceful shutdown of the application.
+     *
+     * Shutdown sequence:
+     * 1. Execute lifecycle shutdown hooks on all IShutdown providers
+     * 2. Call user's serverShutdown hook
+     * 3. Close the HTTP server to stop accepting new connections
+     *
+     * @param signal - The signal that triggered the shutdown
+     * @returns Promise that resolves when shutdown is complete
+     * @internal
+     */
+    async handleExit(signal) {
+        // 1. Stop Studio Agent if running
+        await stopStudio();
+        // 2. Execute lifecycle shutdown hooks on all IShutdown providers
+        if (this.lifecycleRegistry) {
+            await this.lifecycleRegistry.executeShutdown(signal);
+        }
+        // 3. Call user's serverShutdown hook
+        await this.handleSyncOrAsync(this.serverShutdown(signal));
+        // 4. Gracefully close the HTTP server with connection force-close
+        if (this.serverInstance) {
+            await new Promise((resolve) => {
+                // Set a timeout to force-destroy connections if graceful shutdown takes too long
+                const forceCloseTimeout = setTimeout(() => {
+                    console.log(`⚠️  Force-closing ${this.activeConnections.size} active connections after ${this.shutdownTimeout}ms timeout`);
+                    this.destroyAllConnections();
+                    resolve();
+                }, this.shutdownTimeout);
+                // Try graceful close first
+                this.serverInstance.close((err) => {
+                    clearTimeout(forceCloseTimeout);
+                    if (err) {
+                        // Don't fail on close error during shutdown - just log it
+                        console.log(`Note: Server close returned: ${err.message}`);
+                    }
+                    resolve();
+                });
+                // Immediately destroy idle connections (keep-alive connections with no pending requests)
+                // This speeds up shutdown significantly
+                this.serverInstance.closeIdleConnections?.();
+            });
+            // Clear all remaining connections
+            this.destroyAllConnections();
+        }
+    }
+    /**
+     * Destroy all active connections immediately.
+     * Used during forced shutdown.
+     * @private
+     */
+    destroyAllConnections() {
+        for (const socket of this.activeConnections) {
+            try {
+                socket.destroy();
+            }
+            catch {
+                // Ignore errors during connection destruction
+            }
+        }
+        this.activeConnections.clear();
+    }
+    /**
+     * Track a new connection for shutdown management.
+     * @private
+     */
+    trackConnection(socket) {
+        this.activeConnections.add(socket);
+        socket.once("close", () => {
+            this.activeConnections.delete(socket);
+        });
+    }
+    /**
+     * Initialize the InversifyJS container with the provided modules and options.
+     * @param appModules - An array of application modules to be loaded into the container.
+     * @param containerOptions - Container global configuration options.
+     * @option skipBaseClassChecks - Skip the base class checks for the container.
+     * @option autoBindInjectable - Automatically bind the injectable classes.
+     * @option defaultScope - The default scope to use for bindings.
+     *
+     * @returns The configured AppContainer instance.
+     * @public API
+     */
+    configContainer(appModules, containerOptions) {
+        this.appContainer = new AppContainer(containerOptions ? containerOptions : {});
+        if (!appModules) {
+            this.logger.error("No modules provided for container configuration", "adapter-express");
+            return;
+        }
+        this.appContainer.create(appModules);
+        this.providerManager = new ProviderManager(this.appContainer.Container);
+        const baseMiddleware = new Middleware();
+        // Create a wrapper that automatically injects container for exception filters
+        this.middlewareManager = this.createMiddlewareWrapper(baseMiddleware);
+        // Initialize lifecycle registry and discover providers implementing IBootstrap/IShutdown
+        this.lifecycleRegistry = new LifecycleRegistry(this.appContainer.Container);
+        this.lifecycleRegistry.discover();
+        return this.appContainer;
+    }
+    /**
+     * Creates a middleware wrapper that automatically injects container when exception filters are enabled
+     * This allows users to simply set enableExceptionFilters: true without manually passing the container
+     */
+    createMiddlewareWrapper(baseMiddleware) {
+        const container = this.appContainer?.Container;
+        // Create a proxy that intercepts setErrorHandler calls
+        return new Proxy(baseMiddleware, {
+            get(target, prop) {
+                if (prop === "setErrorHandler") {
+                    return function (options) {
+                        // Automatically inject container if enableExceptionFilters is true and container is available
+                        const enhancedOptions = {
+                            ...options,
+                            container: options?.enableExceptionFilters && container ? container : options?.container,
+                        };
+                        target.setErrorHandler(enhancedOptions);
+                    };
+                }
+                // Forward all other property access to the base middleware
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                const value = target[prop];
+                return typeof value === "function" ? value.bind(target) : value;
+            },
+        });
+    }
+    /**
+     * Get the ProviderManager instance.
+     * @returns The ProviderManager instance.
+     * @public API
+     */
+    get Provider() {
+        return this.providerManager;
+    }
+    /**
+     * Get the Middleware instance.
+     * @returns The Middleware instance.
+     * @public API
+     */
+    get Middleware() {
+        return this.middlewareManager;
+    }
+    /**
+     * Configures the Express application with the provided middleware entries.
+     * @param app - The Express application instance.
+     * @param middlewareEntries - An array of Express middleware entries to be applied.
+     */
+    async configureMiddleware(app, middlewareEntries) {
+        for (const entry of middlewareEntries) {
+            if (typeof entry === "function") {
+                app.use(entry);
+                // eslint-disable-next-line no-prototype-builtins
+            }
+            else if (entry?.hasOwnProperty("path")) {
+                const { path, middlewares } = entry;
+                const pathGlobal = this.globalPrefix + path;
+                for (const mid of middlewares) {
+                    if (path) {
+                        if (typeof mid === "function") {
+                            app.use(pathGlobal, mid);
+                        }
+                        else {
+                            const middleware = mid;
+                            // Check if it's a BaseMiddleware instance (has handler method, not use)
+                            const middlewareRecord = middleware;
+                            if (middlewareRecord.handler && typeof middlewareRecord.handler === "function") {
+                                // BaseMiddleware instance - wrap handler method
+                                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                                const baseMiddleware = middleware;
+                                app.use(pathGlobal, (req, res, next) => {
+                                    baseMiddleware.handler(req, res, next);
+                                });
+                            }
+                            else if (middleware.use) {
+                                middleware.use = middleware.use.bind(middleware);
+                                app.use(pathGlobal, middleware.use);
+                            }
+                            else {
+                                this.logger.warn(`Middleware ${middleware.constructor?.name || "unknown"} does not have a 'use' or 'handler' method`, "application-express");
+                            }
+                        }
+                    }
+                }
+            }
+            else {
+                const middleware = entry;
+                // Check if it's a BaseMiddleware instance (has handler method, not use)
+                // BaseMiddleware instances are handled specially in inversify-express-server
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                if (middleware.handler && typeof middleware.handler === "function") {
+                    // BaseMiddleware instance - wrap handler method
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                    const baseMiddleware = middleware;
+                    app.use((req, res, next) => {
+                        baseMiddleware.handler(req, res, next);
+                    });
+                }
+                else if (middleware.use) {
+                    middleware.use = middleware.use.bind(middleware);
+                    app.use(middleware.use);
+                }
+                else {
+                    this.logger.warn(`Middleware ${middleware.constructor?.name || "unknown"} does not have a 'use' or 'handler' method`, "application-express");
+                }
+            }
+        }
+    }
+    /**
+     * Create and configure the Express application.
+     * @param container - The InversifyJS container.
+     * @param middlewares - An array of Express middlewares to be applied.
+     * @returns The configured Application instance.
+     */
+    async init() {
+        if (!this.appContainer) {
+            this.logger.error("No container provided for application configuration", "adapter-express");
+            process.exit(1);
+        }
+        // Create Express app early so it's available during configureServices for render()
+        const tempApp = express();
+        this.Middleware.setExpressApp(tempApp);
+        // Initialize Studio Agent if available (adds middleware before user
+        // middlewares). At this point we already know the port the user asked
+        // us to listen on (set in `listen()` before `init()` is invoked) and
+        // the configured global prefix, so forward both — the agent uses them
+        // to populate the Studio Status page.
+        await initializeStudio(tempApp, {
+            ...this.studioConfig,
+            appPort: this.port,
+            globalPrefix: this.globalPrefix,
+        }, this.appContainer);
+        await this.handleSyncOrAsync(this.configureServices());
+        const sortedMiddlewarePipeline = this.Middleware.getMiddlewarePipeline();
+        const pipeline = sortedMiddlewarePipeline.map((entry) => entry.middleware);
+        this.middlewares.push(...pipeline);
+        /* Apply the status code to the response */
+        this.middlewares.unshift(new HttpStatusCodeMiddleware(this.globalPrefix));
+        const expressServer = new InversifyExpressServer(this.appContainer.Container, null, { rootPath: this.globalPrefix }, tempApp);
+        // Pass ContentNegotiationService to InversifyExpressServer if available
+        const contentNegotiationService = this.Middleware.getContentNegotiationService();
+        if (contentNegotiationService) {
+            expressServer.setContentNegotiationService(contentNegotiationService);
+        }
+        // Pass ValidationService to InversifyExpressServer if validation is configured
+        const validationConfig = this.Middleware.getValidationConfig?.();
+        if (validationConfig) {
+            // `.js` extension required by NodeNext for ESM consumers; the
+            // CJS build accepts it unchanged.
+            const { ValidationService } = await import("./express-utils/validation-service.js");
+            const { ClassValidatorAdapter } = await import("@expressots/core");
+            const validationService = new ValidationService();
+            validationService.enable(validationConfig);
+            // Register ClassValidatorAdapter by default
+            const classValidatorAdapter = new ClassValidatorAdapter();
+            validationService.getRegistry().register(classValidatorAdapter);
+            // Register any additional adapters from config
+            if (validationConfig.adapters) {
+                for (const AdapterClass of validationConfig.adapters) {
+                    const adapter = new AdapterClass();
+                    validationService.getRegistry().register(adapter);
+                }
+            }
+            expressServer.setValidationService(validationService);
+        }
+        expressServer.setConfig((app) => {
+            this.configureMiddleware(app, this.middlewares);
+        });
+        expressServer.setErrorConfig((app) => {
+            if (this.Middleware.getErrorHandler()) {
+                app.use(this.Middleware.getErrorHandler());
+            }
+        });
+        this.app = expressServer.build();
+        return this;
+    }
+    /**
+     * Start listening on the given port and environment.
+     * @param port - The port number to listen on.
+     * @param appInfo - Optional message to display the app name and version.
+     * @public API
+     */
+    async listen(port, appInfo) {
+        // Capture wall-clock start so we can report total boot duration to the
+        // Studio Status page once `app.listen()` resolves with the actual port.
+        const listenStartedAt = Date.now();
+        // Close existing server instance if it exists
+        if (this.serverInstance) {
+            this.logger.warn("Closing existing server instance before starting new one", "adapter-express");
+            await this.closeExistingServer();
+            this.logger.info("✓ Application reloaded", "adapter-express");
+        }
+        // Remove old signal handlers to prevent duplicates
+        this.removeShutdownHandlers();
+        // Reset shutdown flag
+        this.isShuttingDown = false;
+        // Resolve banner configuration with environment-specific overrides
+        const resolvedBannerConfig = resolveBannerConfig(this.bannerConfig, this.environment || "development");
+        // Initialize banner generator with resolved config
+        this.bannerGenerator = new BannerGenerator(resolvedBannerConfig);
+        this.environment = this.environment || "development";
+        this.port = typeof port === "string" ? parseInt(port, 10) : port;
+        try {
+            await this.init();
+            await this.configEngine();
+            this.app.set("env", this.environment);
+            // Stop buffering and restore normal output (but don't flush yet)
+            AppExpress.stopBuffering();
+            // Flush all buffered logs that were captured during initialization
+            AppExpress.flushBufferedLogs();
+        }
+        catch (error) {
+            // Ensure buffering is stopped and logs are flushed even on error
+            AppExpress.stopBuffering();
+            AppExpress.flushBufferedLogs();
+            throw error;
+        }
+        // Ensure port is available (handles hot-reload scenarios)
+        // This will kill the previous process if needed - safest approach for dev experience
+        const portAvailable = await this.ensurePortAvailable(this.port);
+        if (!portAvailable) {
+            const errorMessage = `Port ${this.port} is still in use and could not be freed`;
+            this.logger.error(errorMessage, "adapter-express");
+            this.logger.info("💡 Try manually killing the process:", "adapter-express");
+            this.logger.info(process.platform === "win32"
+                ? `   netstat -ano | findstr :${this.port} && taskkill /F /PID <pid>`
+                : `   lsof -ti:${this.port} | xargs kill -9`, "adapter-express");
+            throw new Error(errorMessage);
+        }
+        return new Promise((resolve, reject) => {
+            this.serverInstance = this.app.listen(this.port, async () => {
+                // Track all connections for graceful shutdown
+                // This enables force-closing connections during hot-reload
+                this.serverInstance.on("connection", (socket) => {
+                    this.trackConnection(socket);
+                });
+                // Update port with actual assigned port (important for port 0 auto-assign)
+                this.port = this.serverInstance?.address()?.port || this.port;
+                // Display startup banner AFTER server starts (so we have the correct port)
+                this.displayStartupBanner(appInfo);
+                // Push live runtime details to the Studio Agent so the Status
+                // page swaps "—" for real values. We forward the same numbers
+                // `MetricsCollector` produced for the CLI banner (providers,
+                // interceptors, middleware) — they come from DI metadata at
+                // runtime and include framework-registered items that the
+                // agent's static file scan can't see. We also forward the
+                // *names* of those items so the Studio drill-down can list
+                // them. No-op when Studio is disabled or when the installed
+                // agent is too old to support it.
+                reportStudioRuntimeInfo({
+                    appPort: this.port,
+                    globalPrefix: this.globalPrefix,
+                    startupMs: Date.now() - listenStartedAt,
+                    providerCount: this.lastApplicationMetrics?.providers,
+                    interceptorCount: this.lastApplicationMetrics?.interceptors,
+                    middlewareCount: this.lastApplicationMetrics?.middleware,
+                    runtimeItems: this.collectStudioRuntimeItems(),
+                });
+                // Setup signal handlers for graceful shutdown
+                // Supported signals:
+                // - SIGTERM: Standard termination (Kubernetes, Docker, process managers)
+                // - SIGINT: User interrupt (Ctrl+C)
+                // - SIGHUP: Terminal hangup
+                // - SIGQUIT: Quit with core dump request
+                // - SIGBREAK: Windows break signal (Ctrl+Break)
+                // - SIGUSR2: Used by nodemon for restart (not on Windows)
+                const shutdownSignals = [
+                    "SIGTERM",
+                    "SIGINT",
+                    "SIGHUP",
+                    "SIGQUIT",
+                    "SIGBREAK",
+                    ...(process.platform !== "win32" ? ["SIGUSR2"] : []),
+                ];
+                for (const signal of shutdownSignals) {
+                    // Skip if handler already registered (prevents duplicates)
+                    if (this.shutdownHandlers.has(signal)) {
+                        continue;
+                    }
+                    const handler = () => {
+                        // Prevent multiple shutdown attempts
+                        if (this.isShuttingDown) {
+                            return;
+                        }
+                        this.isShuttingDown = true;
+                        // Use console.log for shutdown messages - synchronous and guaranteed to write before exit
+                        console.log(`\n📡 Signal ${signal} received, initiating graceful shutdown...`);
+                        // Execute shutdown hooks and exit
+                        this.handleExit(signal)
+                            .then(() => {
+                            console.log("✅ Graceful shutdown completed");
+                            process.exit(0);
+                        })
+                            .catch((error) => {
+                            console.error(`❌ Error during shutdown: ${error.message}`);
+                            process.exit(1);
+                        });
+                    };
+                    // Store handler for later removal and register it
+                    this.shutdownHandlers.set(signal, handler);
+                    process.on(signal, handler);
+                }
+                // Setup exit handler to force-close connections immediately
+                // This is a last-resort handler for when signals don't arrive or complete in time
+                // (e.g., during hot-reload when the process is killed quickly)
+                const exitHandler = () => {
+                    if (this.serverInstance) {
+                        // Synchronously destroy all connections - this is our last chance
+                        this.destroyAllConnections();
+                        // Try to close the server synchronously (won't block but releases the port faster)
+                        try {
+                            this.serverInstance.close();
+                        }
+                        catch {
+                            // Ignore errors during exit
+                        }
+                    }
+                };
+                // Register exit handler (only once)
+                if (!this.shutdownHandlers.has("exit")) {
+                    this.shutdownHandlers.set("exit", exitHandler);
+                    process.once("exit", exitHandler);
+                }
+                try {
+                    // Call user's postServerInitialization hook
+                    await this.handleSyncOrAsync(this.postServerInitialization());
+                    // Execute bootstrap lifecycle hooks on all IBootstrap providers
+                    if (this.lifecycleRegistry) {
+                        await this.lifecycleRegistry.executeBootstrap();
+                    }
+                    resolve(this);
+                }
+                catch (error) {
+                    this.logger.error(`Error during post-server initialization: ${error}`, "adapter-express");
+                    reject(error);
+                }
+            });
+            this.serverInstance?.on("error", (error) => {
+                // Handle EADDRINUSE error with helpful suggestions
+                if (error.code === "EADDRINUSE") {
+                    const port = this.port;
+                    const errorMessage = `Port ${port} is already in use`;
+                    const suggestions = [
+                        `Try a different port: Set PORT environment variable to another value`,
+                        `Find and stop the process using port ${port}`,
+                        process.platform === "win32"
+                            ? `On Windows: netstat -ano | findstr :${port}`
+                            : `On Linux/Mac: lsof -ti:${port} | xargs kill`,
+                    ];
+                    this.logger.error(errorMessage, "adapter-express");
+                    this.logger.info("💡 Suggestions:", "adapter-express");
+                    suggestions.forEach((suggestion) => {
+                        this.logger.info(`   • ${suggestion}`, "adapter-express");
+                    });
+                    reject(new Error(`${errorMessage}. ${suggestions[0]}`));
+                }
+                else {
+                    this.logger.error(`Error starting server: ${error.message}`, "adapter-express");
+                    reject(error);
+                }
+            });
+        });
+    }
+    /**
+     * Close existing server instance if it exists.
+     * @private
+     */
+    async closeExistingServer() {
+        if (this.serverInstance) {
+            return new Promise((resolve) => {
+                this.serverInstance.close(() => {
+                    this.serverInstance = null;
+                    resolve();
+                });
+                // Force close after timeout
+                setTimeout(() => {
+                    if (this.serverInstance) {
+                        this.serverInstance = null;
+                        resolve();
+                    }
+                }, 1000);
+            });
+        }
+    }
+    /**
+     * Wait for a specified duration.
+     * @private
+     */
+    delay(ms) {
+        return new Promise((resolve) => setTimeout(resolve, ms));
+    }
+    /**
+     * Kill the process using a specific port.
+     * @private
+     */
+    async killProcessOnPort(port) {
+        const { exec } = await import("child_process");
+        const { promisify } = await import("util");
+        const execAsync = promisify(exec);
+        try {
+            if (process.platform === "win32") {
+                // Windows: Find PID using netstat and kill it
+                const { stdout } = await execAsync(`netstat -ano | findstr :${port} | findstr LISTENING`);
+                const lines = stdout.trim().split("\n");
+                for (const line of lines) {
+                    const parts = line.trim().split(/\s+/);
+                    const pid = parts[parts.length - 1];
+                    if (pid && pid !== String(process.pid) && /^\d+$/.test(pid)) {
+                        try {
+                            await execAsync(`taskkill /F /PID ${pid}`);
+                            return true;
+                        }
+                        catch {
+                            // Process might have already exited
+                        }
+                    }
+                }
+            }
+            else {
+                // Linux/Mac: Use lsof to find PID and kill it
+                try {
+                    const { stdout } = await execAsync(`lsof -ti:${port}`);
+                    const pids = stdout.trim().split("\n").filter(Boolean);
+                    for (const pid of pids) {
+                        if (pid !== String(process.pid)) {
+                            try {
+                                await execAsync(`kill -9 ${pid}`);
+                                return true;
+                            }
+                            catch {
+                                // Process might have already exited
+                            }
+                        }
+                    }
+                }
+                catch {
+                    // No process found on port
+                }
+            }
+        }
+        catch {
+            // Command failed - port might already be free
+        }
+        return false;
+    }
+    /**
+     * Check if the port is available by attempting to bind to it.
+     * @private
+     */
+    async isPortAvailable(port) {
+        const net = await import("net");
+        return new Promise((resolve) => {
+            const testServer = net.createServer();
+            testServer.once("error", () => {
+                resolve(false);
+            });
+            testServer.once("listening", () => {
+                testServer.close(() => {
+                    resolve(true);
+                });
+            });
+            testServer.listen(port);
+        });
+    }
+    /**
+     * Ensure the port is available, killing the existing process if needed.
+     * This is the safest approach for hot-reload scenarios.
+     * @private
+     */
+    async ensurePortAvailable(port) {
+        // First, check if port is already available
+        if (await this.isPortAvailable(port)) {
+            return true;
+        }
+        // Try to kill the process on the port
+        let killed = await this.killProcessOnPort(port);
+        if (killed) {
+            // Wait a moment for the port to be released
+            await this.delay(500);
+        }
+        // Retry multiple times to check if port is now available
+        // Hot reload scenarios may need more time for the old process to shut down
+        for (let attempt = 1; attempt <= this.portRetryAttempts; attempt++) {
+            if (await this.isPortAvailable(port)) {
+                return true;
+            }
+            // Try to kill again if still not available (process might be slow to release)
+            if (attempt % 3 === 0) {
+                killed = await this.killProcessOnPort(port);
+                if (killed) {
+                    await this.delay(300);
+                }
+            }
+            if (attempt < this.portRetryAttempts) {
+                await this.delay(this.portRetryDelay);
+            }
+        }
+        return false;
+    }
+    /**
+     * Remove existing shutdown signal handlers to prevent duplicates.
+     * @private
+     */
+    removeShutdownHandlers() {
+        this.shutdownHandlers.forEach((handler, signal) => {
+            // Handle "exit" event specially (it's not a signal but we track it the same way)
+            if (signal === "exit") {
+                process.removeListener("exit", handler);
+            }
+            else {
+                process.removeListener(signal, handler);
+            }
+        });
+        this.shutdownHandlers.clear();
+        // Also clear any tracked connections from previous runs
+        this.activeConnections.clear();
+    }
+    /**
+     * Sets the global route prefix for the application.
+     * @method setGlobalRoutePrefix
+     * @param {string} prefix - The prefix to use for all routes.
+     * @public API
+     */
+    async setGlobalRoutePrefix(prefix) {
+        this.globalPrefix = prefix;
+    }
+    /**
+     * Configures the application's view engine based on the provided configuration options.
+     */
+    async configEngine() {
+        if (this.renderOptions.engine) {
+            switch (this.renderOptions.engine) {
+                case RenderEngine.Engine.HBS:
+                    await setEngineHandlebars(this.app, this.renderOptions.options);
+                    break;
+                case RenderEngine.Engine.EJS:
+                    await setEngineEjs(this.app, this.renderOptions.options);
+                    break;
+                case RenderEngine.Engine.PUG:
+                    await setEnginePug(this.app, this.renderOptions.options);
+                    break;
+                default:
+                    throw new Error("Unsupported engine type!");
+            }
+        }
+    }
+    /**
+     * Configures the application's view engine based on the provided configuration options.
+     * @method setEngine
+     * @template T - A generic type extending from RenderTemplateOptions.
+     *
+     * @param {Engine} engine - The view engine to set
+     * @param {EngineOptions} [options] - The configuration options for the view engine
+     * @public API
+     */
+    /**
+     * Configure the startup banner display.
+     * Can be called in configureServices() or globalConfiguration().
+     *
+     * @param config - Banner configuration options
+     * @example
+     * ```typescript
+     * export class App extends AppExpress {
+     *   configureServices(): void {
+     *     this.setBanner({
+     *       style: "full",
+     *       showMetrics: true,
+     *       showFeatures: true,
+     *       showConfig: true,
+     *       showPerformance: true,
+     *       showResources: true,
+     *       // Environment-specific overrides
+     *       environment: {
+     *         production: {
+     *           style: "compact",
+     *           showConfig: false,
+     *           showResources: false,
+     *         },
+     *       },
+     *     });
+     *   }
+     * }
+     * ```
+     * @public API
+     */
+    setBanner(config) {
+        this.bannerConfig = config;
+    }
+    /**
+     * Configure ExpressoTS Studio integration.
+     * When enabled and @expressots/studio-agent is installed, automatically
+     * instruments the application for request recording and real-time monitoring.
+     *
+     * By default, Studio is auto-enabled in development if the package is installed.
+     * Use this method to customize behavior or enable in production.
+     *
+     * @param config - Studio configuration options
+     * @example
+     * ```typescript
+     * export class App extends AppExpress {
+     *   configureServices(): void {
+     *     this.setStudio({
+     *       enabled: true,    // Force enable (default: auto in dev)
+     *       port: 3334,       // WebSocket port for UI connection
+     *       serviceName: 'my-app', // Service name for tracing
+     *     });
+     *   }
+     * }
+     * ```
+     * @public API
+     */
+    setStudio(config) {
+        this.studioConfig = config;
+    }
+    /**
+     * Check if ExpressoTS Studio is currently enabled.
+     * @returns Boolean indicating if Studio Agent is running.
+     * @public API
+     */
+    isStudioEnabled() {
+        return isStudioEnabled();
+    }
+    /**
+     * Configure a view engine for server-side rendering.
+     *
+     * @deprecated Use `this.Middleware.render()` instead. Will be removed in v5.0.0.
+     *
+     * @example Migration
+     * ```typescript
+     * // Before (deprecated)
+     * this.setEngine(RenderEngine.Engine.EJS, { viewsDir: 'views' });
+     *
+     * // After (recommended)
+     * this.Middleware.render({ engine: 'ejs', viewsDir: 'views' });
+     *
+     * // Or with auto-detection
+     * this.Middleware.render();
+     * ```
+     *
+     * @param engine - The view engine to set
+     * @param options - The configuration options for the view engine
+     * @public API
+     */
+    async setEngine(engine, options) {
+        this.logger.warn("setEngine() is deprecated. Use this.Middleware.render() instead. Will be removed in v5.0.0.", "adapter-express");
+        try {
+            // Bridge to new render system
+            const engineMap = {
+                ejs: "ejs",
+                pug: "pug",
+                hbs: "hbs",
+            };
+            const engineName = engineMap[engine] || engine;
+            // Try to use the new render system
+            await this.Middleware.render({
+                engine: engineName,
+                viewsDir: options?.viewsDir,
+                partialsDir: options?.partialsDir,
+            });
+        }
+        catch {
+            // Fallback to old system if new system fails
+            if (options) {
+                this.renderOptions = { engine, options };
+            }
+            else {
+                this.renderOptions = { engine };
+            }
+        }
+    }
+    /**
+     * Verifies if the current environment is development.
+     * @returns A boolean value indicating whether the current environment is development or not.
+     * @public API
+     */
+    async isDevelopment() {
+        // Check Express app environment first (most reliable)
+        if (this.app) {
+            return this.app.get("env") === "development";
+        }
+        // Fallback to this.environment (set by bootstrap())
+        if (this.environment) {
+            return this.environment === "development";
+        }
+        // Fallback to process.env.NODE_ENV
+        if (process.env.NODE_ENV) {
+            return process.env.NODE_ENV === "development";
+        }
+        // Default to false if nothing is set
+        return false;
+    }
+    /**
+     * Get the underlying HTTP server. (default: Express.js)
+     * @returns The underlying HTTP server after initialization.
+     * @public API
+     */
+    async getHttpServer() {
+        if (!this.serverInstance) {
+            this.logger.error("Server instance not initialized yet", "adapter-express");
+            throw new Error("Server instance not initialized yet");
+        }
+        return Promise.resolve(this.serverInstance);
+    }
+    /**
+     * Get the port the server is listening on.
+     * Useful for dynamic port assignment (port: 0) in testing scenarios.
+     * @returns The actual port number the server is bound to.
+     * @public API
+     */
+    async getPort() {
+        if (!this.serverInstance) {
+            this.logger.error("Server instance not initialized yet", "adapter-express");
+            throw new Error("Server instance not initialized yet");
+        }
+        const address = this.serverInstance.address();
+        if (address && typeof address === "object" && "port" in address) {
+            return Promise.resolve(address.port);
+        }
+        throw new Error("Unable to determine server port");
+    }
+    /**
+     * Detect API versions from @Version() decorators on controllers.
+     * @returns Array of unique API versions (e.g., ["v1", "v2"])
+     * @private
+     */
+    detectApiVersions() {
+        try {
+            const controllers = getControllersFromMetadata();
+            const versions = new Set();
+            controllers.forEach((controllerTarget) => {
+                // Cast DecoratorTarget to NewableFunction for metadata access
+                const controllerConstructor = controllerTarget;
+                // Check controller-level version
+                const controllerMetadata = getControllerMetadata(controllerConstructor);
+                if (controllerMetadata?.version) {
+                    const version = String(controllerMetadata.version);
+                    // Normalize version format (ensure "v" prefix)
+                    const normalizedVersion = version.startsWith("v") ? version : `v${version}`;
+                    versions.add(normalizedVersion);
+                }
+                // Check method-level versions
+                const methodMetadata = getControllerMethodMetadata(controllerConstructor);
+                if (methodMetadata) {
+                    methodMetadata.forEach((method) => {
+                        if (method.version) {
+                            const version = String(method.version);
+                            const normalizedVersion = version.startsWith("v") ? version : `v${version}`;
+                            versions.add(normalizedVersion);
+                        }
+                    });
+                }
+            });
+            return Array.from(versions).sort();
+        }
+        catch (error) {
+            // If metadata not available, return empty array
+            return [];
+        }
+    }
+    /**
+     * Harvest provider + interceptor *names* from DI metadata so the
+     * Studio Status page can drill down into the items behind the
+     * "Providers" / "Interceptors" counters.
+     *
+     * Reads the same metadata that {@link MetricsCollector} uses for the
+     * CLI banner — so what shows up here is the source of truth, not the
+     * agent's static file scan (which can't see framework-registered
+     * items like `Logger` or `LifecycleRegistry`).
+     *
+     * Returns `undefined` instead of an empty object so {@link
+     * reportStudioRuntimeInfo} can skip forwarding when nothing was
+     * harvested (keeps the WS payload small).
+     */
+    collectStudioRuntimeItems() {
+        try {
+            const providerMetadata = Reflect.getMetadata(PROVIDE_METADATA_KEY, Reflect) || [];
+            const providers = [];
+            for (const entry of providerMetadata) {
+                const name = entry?.implementationType?.name;
+                if (typeof name === "string" && name.length > 0) {
+                    providers.push({ name, source: "provide" });
+                }
+            }
+            const interceptorMetadata = Reflect.getMetadata(INTERCEPTOR_METADATA_KEY.interceptor, Reflect) || [];
+            const interceptors = [];
+            for (const entry of interceptorMetadata) {
+                const name = entry?.interceptor?.name;
+                if (typeof name === "string" && name.length > 0) {
+                    interceptors.push({
+                        name,
+                        priority: entry?.priority,
+                        source: "metadata",
+                    });
+                }
+            }
+            // Bail out if both lists are empty — nothing useful to forward.
+            if (providers.length === 0 && interceptors.length === 0) {
+                return undefined;
+            }
+            return { providers, interceptors };
+        }
+        catch {
+            // Metadata reads should never break boot. Status page just falls
+            // back to its static-scan list.
+            return undefined;
+        }
+    }
+    /**
+     * Display middleware startup logs after the banner.
+     * This makes startup logging transparent to the user - no need for manual code in postServerInitialization().
+     * @private
+     */
+    displayMiddlewareStartupLogs() {
+        const isDev = this.environment === "development";
+        if (!isDev)
+            return;
+        const startupLogs = this.Middleware.getStartupLogs();
+        if (startupLogs.length === 0)
+            return;
+        startupLogs.forEach((log) => {
+            if (log.type === "warn") {
+                this.logger.warn(log.message, "middleware");
+            }
+            else {
+                this.logger.info(log.message, "middleware");
+            }
+        });
+        this.Middleware.clearStartupLogs();
+    }
+    /**
+     * Display startup banner with application metrics.
+     * @param appInfo - Application info
+     * @private
+     */
+    displayStartupBanner(appInfo) {
+        if (!this.bannerGenerator) {
+            // Fallback to old console message if banner generator not initialized
+            this.console.messageServer(this.port, this.environment || "development", appInfo);
+            // Log CI detection after banner, before middleware logs
+            this.displayCIDetectionLogs(appInfo);
+            // Still display middleware startup logs even in fallback mode
+            this.displayMiddlewareStartupLogs();
+            return;
+        }
+        try {
+            let finalAppInfo = appInfo;
+            if (!finalAppInfo?.apiVersions || finalAppInfo.apiVersions.length === 0) {
+                const apiVersions = this.detectApiVersions();
+                if (apiVersions.length > 0) {
+                    finalAppInfo = {
+                        ...appInfo,
+                        appName: appInfo?.appName || "App",
+                        appVersion: appInfo?.appVersion || "not provided",
+                        apiVersions,
+                    };
+                }
+            }
+            // Detect API versions from controllers
+            const detectedApiVersions = finalAppInfo?.apiVersions || [];
+            // Collect metrics. Cache the result on the instance so the Studio
+            // integration can forward the *runtime* counts (providers /
+            // interceptors / middleware) to the agent — those values come from
+            // DI metadata and registries, which our static file scanner can't
+            // see, so without this the Studio Status page would disagree with
+            // the CLI banner.
+            const { metrics, features } = MetricsCollector.collect(this.appContainer.Container, {
+                getControllersFromMetadata: () => getControllersFromMetadata(),
+                getControllersFromContainer: () => getControllersFromContainer(this.appContainer.Container, false),
+                getControllerMethodMetadata: (constructor) => getControllerMethodMetadata(constructor),
+                getMiddlewareCount: () => this.Middleware.getMiddlewarePipeline().length,
+                hasContentNegotiation: () => !!this.Middleware.getContentNegotiationService(),
+                hasSmartValidation: () => !!this.Middleware.getValidationConfig(),
+                hasAuthorization: () => this.appContainer.Container.isBound("IGuardCache"),
+                hasExceptionFilters: () => !!this.Middleware.getErrorHandler(),
+                hasApiVersioning: () => detectedApiVersions.length > 0,
+                hasGlobalRoutePrefix: () => !!this.globalPrefix && this.globalPrefix !== "/",
+                hasErrorHandler: () => !!this.Middleware.getErrorHandler(),
+                hasRequestLogging: () => {
+                    // Check if any request logging middleware is in the pipeline
+                    const pipeline = this.Middleware.getPipelineInfo();
+                    return pipeline.entries.some((e) => e.category === "logging" || e.name.toLowerCase().includes("logging"));
+                },
+            });
+            // Persist the metrics so `reportStudioRuntimeInfo` (called from the
+            // listen callback) can forward live provider/interceptor counts.
+            this.lastApplicationMetrics = metrics;
+            // Discover providers for introspection
+            this.Provider.discover();
+            // Get middleware and provider views for banner
+            const middlewareView = this.Middleware.getFormattedView();
+            const providerView = this.Provider.getFormattedView();
+            // Prepare banner data with extended info
+            const bannerData = {
+                appInfo: finalAppInfo,
+                metrics,
+                features,
+                middlewareView,
+                providerView,
+            };
+            // Display banner
+            this.bannerGenerator.display(this.port, this.environment || "development", finalAppInfo, metrics, features, {
+                "Global Prefix": this.globalPrefix || "/",
+                "Node Version": process.version,
+                Platform: process.platform,
+            }, bannerData);
+            // Log CI detection after banner, before middleware logs
+            this.displayCIDetectionLogs(appInfo);
+            // Automatically display middleware startup logs after banner (transparent to user)
+            this.displayMiddlewareStartupLogs();
+        }
+        catch (error) {
+            // Fallback to old console message on error
+            this.logger.warn("Failed to display startup banner, using fallback", "adapter-express", error);
+            this.console.messageServer(this.port, this.environment || "development", appInfo);
+            // Log CI detection after banner, before middleware logs
+            this.displayCIDetectionLogs(appInfo);
+            // Still display middleware startup logs even in fallback mode
+            this.displayMiddlewareStartupLogs();
+        }
+    }
+    /**
+     * Display CI detection logs after the banner but before middleware logs.
+     * @param appInfo - Application info containing CI detection data
+     * @private
+     */
+    displayCIDetectionLogs(appInfo) {
+        if (appInfo?.ciDetection?.detected) {
+            this.logger.info(`🔍 CI environment detected: ${appInfo.ciDetection.platform}`, "bootstrap");
+            this.logger.info(`✅ Skipping .env file loading (using process.env)`, "bootstrap");
+        }
+    }
+}