@expressots/adapter-express 3.0.0-beta.3 → 3.0.0-beta.4.1

package/lib/CHANGELOG.md

@@ -1,3 +1,28 @@
+## [3.0.0-beta.4](https://github.com/expressots/adapter-express/compare/3.0.0-beta.3...3.0.0) (2024-12-03)
+
+### Code Refactoring
+
+- app express class with async methods ([5c9ea2b](https://github.com/expressots/adapter-express/commit/5c9ea2b6cac9fa6455d140c0d0ce052712fa8251))
+
+### Tests
+
+- update tests for globalConfiguration, isDevelopment, getHttpServer, serverShutdown ([17b7d92](https://github.com/expressots/adapter-express/commit/17b7d92e87f4ad0d14a386e8351c723e1392a5c3))
+
+## [3.0.0-beta.3](https://github.com/expressots/adapter-express/compare/3.0.0-beta.2...3.0.0) (2024-11-28)
+
+### Features
+
+- create server instance http and add close method for graceful shutdown ([be16011](https://github.com/expressots/adapter-express/commit/be16011f4686ce513bc254b8db9ca8abe2d79324))
+
+### Bug Fixes
+
+- update error message in getHttpServer method for clarity ([dc4f5a3](https://github.com/expressots/adapter-express/commit/dc4f5a30322e00efa74283445d1d46fabb61ffe1))
+- update middleware path handling to include global prefix ([b7bffc5](https://github.com/expressots/adapter-express/commit/b7bffc5d2217ace1097ee7ef28dc28176de8e256))
+
+### Tests
+
+- add unit tests for serverShutdown and setGlobalRoutePrefix methods ([2c1ad63](https://github.com/expressots/adapter-express/commit/2c1ad633f33374d09c3b8ea2b004cdc94f207da7))
+
 ## [3.0.0-beta.2](https://github.com/expressots/adapter-express/compare/3.0.0-beta.1...3.0.0) (2024-11-24)
 
 ### Features

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

@@ -31,7 +31,6 @@ const fs_1 = __importDefault(require("fs"));
 const process_1 = __importStar(require("process"));
 const core_1 = require("@expressots/core");
 const shared_1 = require("@expressots/shared");
-const application_express_base_1 = require("./application-express.base");
 const http_status_middleware_1 = require("./express-utils/http-status-middleware");
 const inversify_express_server_1 = require("./express-utils/inversify-express-server");
 const engine_1 = require("./render/engine");
@@ -46,9 +45,8 @@ const engine_1 = require("./render/engine");
  * @method setEngine - Configures the application's view engine based on the provided configuration options.
  * @method isDevelopment - Verifies if the current environment is development.
  */
-class AppExpress extends application_express_base_1.ApplicationBase {
+class AppExpress {
     constructor() {
-        super();
         this.logger = new core_1.Logger();
         this.console = new core_1.Console();
         this.serverInstance = null;
@@ -57,15 +55,53 @@ class AppExpress extends application_express_base_1.ApplicationBase {
         this.renderOptions = {};
         this.globalConfiguration();
     }
-    globalConfiguration() { }
-    configureServices() { }
-    postServerInitialization() { }
-    serverShutdown() { }
+    /**
+     * Implement this method to set up global configurations for the server.
+     * This method is called before any other server initialization methods.
+     * Use this method to configure global settings that apply to the entire
+     * server application. Supports asynchronous setup with a Promise.
+     *
+     * @abstract
+     * @returns {void | Promise<void>}
+     * @public API
+     */
+    async 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 asynchronous setup with a Promise.
+     *
+     * @abstract
+     * @returns {void | Promise<void>}
+     * @public API
+     */
+    async 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 asynchronous execution with a Promise.
+     *
+     * @abstract
+     * @returns {void | Promise<void>}
+     * @public API
+     */
+    async 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 asynchronous
+     * cleanup with a Promise.
+     *
+     * @abstract
+     * @returns {void | Promise<void>}
+     * @public API
+     */
+    async serverShutdown() { }
     /**
      * Handles process exit by calling serverShutdown and then exiting the process.
      */
-    handleExit() {
-        this.serverShutdown();
+    async handleExit() {
+        await this.serverShutdown();
         process_1.default.exit(0);
     }
     /**
@@ -182,14 +218,28 @@ class AppExpress extends application_express_base_1.ApplicationBase {
         await this.configEngine();
         this.environment = this.environment || "development";
         this.app.set("env", this.environment);
-        this.port = typeof port === "string" ? parseInt(port, 10) : port || 3000;
-        this.serverInstance = this.app.listen(this.port, () => {
-            this.console.messageServer(this.port, this.environment, appInfo);
-            ["SIGTERM", "SIGHUP", "SIGBREAK", "SIGQUIT", "SIGINT"].forEach((signal) => {
-                process_1.default.on(signal, this.handleExit.bind(this));
+        this.port = typeof port === "string" ? parseInt(port, 10) : port;
+        return new Promise((resolve, reject) => {
+            this.serverInstance = this.app.listen(this.port, async () => {
+                this.port = this.serverInstance?.address()?.port;
+                this.console.messageServer(this.port, this.environment, appInfo);
+                ["SIGTERM", "SIGHUP", "SIGBREAK", "SIGQUIT", "SIGINT"].forEach((signal) => {
+                    process_1.default.on(signal, this.handleExit.bind(this));
+                });
+                try {
+                    await this.postServerInitialization();
+                    resolve(this);
+                }
+                catch (error) {
+                    this.logger.error(`Error during post-server initialization: ${error}`, "adapter-express");
+                    reject(error);
+                }
+            });
+            this.serverInstance?.on("error", (error) => {
+                this.logger.error(`Error starting server: ${error.message}`, "adapter-express");
+                reject(error);
             });
         });
-        await this.postServerInitialization();
     }
     /**
      * Sets the global route prefix for the application.
@@ -197,7 +247,7 @@ class AppExpress extends application_express_base_1.ApplicationBase {
      * @param {string} prefix - The prefix to use for all routes.
      * @public API
      */
-    setGlobalRoutePrefix(prefix) {
+    async setGlobalRoutePrefix(prefix) {
         this.globalPrefix = prefix;
     }
     /**
@@ -247,7 +297,7 @@ class AppExpress extends application_express_base_1.ApplicationBase {
      * @returns A boolean value indicating whether the current environment is development or not.
      * @public API
      */
-    isDevelopment() {
+    async isDevelopment() {
         if (this.app) {
             return this.app.get("env") === "development";
         }
@@ -270,7 +320,7 @@ class AppExpress extends application_express_base_1.ApplicationBase {
       * ```
      * @public API
      */
-    initEnvironment(environment, options) {
+    async initEnvironment(environment, options) {
         this.environment = environment;
         if (options === undefined) {
             (0, shared_1.config)({ path: ".env" });
@@ -298,37 +348,11 @@ class AppExpress extends application_express_base_1.ApplicationBase {
      * @public API
      */
     async getHttpServer() {
-        if (!this.app) {
-            this.logger.error("The method can only be called in `app` or in e2e tests with supertest.", "adapter-express");
-            throw new Error("Incorrect usage of `getHttpServer` method");
+        if (!this.serverInstance) {
+            this.logger.error("Server instance not initialized yet", "adapter-express");
+            throw new Error("Server instance not initialized yet");
         }
-        return this.app;
-    }
-    /**
-     * Close the server instance.
-     * @returns A promise that resolves when the server is closed.
-     * @public API
-     */
-    close(enableLog = false) {
-        return new Promise((resolve, reject) => {
-            if (this.serverInstance) {
-                this.serverInstance.close((err) => {
-                    if (err) {
-                        if (enableLog)
-                            this.logger.error(`Error closing server: ${err.message}`, "adapter-express");
-                        reject(err);
-                    }
-                    else {
-                        if (enableLog)
-                            this.logger.info("Server closed successfully", "adapter-express");
-                        resolve();
-                    }
-                });
-            }
-            else {
-                resolve();
-            }
-        });
+        return Promise.resolve(this.serverInstance);
     }
 }
 exports.AppExpress = AppExpress;

package/lib/cjs/adapter-express/micro-api/application-express-micro.js

@@ -146,14 +146,21 @@ class AppExpressMicro {
      */
     async listen(port, appInfo) {
         const logger = new core_1.Logger();
-        this.port = typeof port === "string" ? parseInt(port, 10) : port || 3000;
+        const normalizedPort = typeof port === "string" ? parseInt(port, 10) : port;
         this.configureMiddleware();
         this.routeManager.applyRoutes();
         if (this.Middleware.getErrorHandler()) {
             this.app.use(this.Middleware.getErrorHandler());
         }
-        return new Promise((resolve) => {
-            this.app.listen(this.port, () => {
+        return new Promise((resolve, reject) => {
+            const server = this.app.listen(normalizedPort, () => {
+                const address = server.address();
+                if (typeof address === "object" && address?.port) {
+                    this.port = address.port;
+                }
+                else {
+                    this.port = normalizedPort;
+                }
                 const appInfoNormalized = appInfo ? `${appInfo?.appName} - ${appInfo?.appVersion} ` : "";
                 logger.info(`${appInfoNormalized}[${this.port}:${this.environment}]`, "MicroAPI");
                 ["SIGTERM", "SIGHUP", "SIGBREAK", "SIGQUIT", "SIGINT"].forEach((signal) => {
@@ -161,6 +168,10 @@ class AppExpressMicro {
                 });
                 resolve();
             });
+            server.on("error", (error) => {
+                logger.error(`Error starting server: ${error.message}`, "MicroAPI");
+                reject(error);
+            });
         });
     }
 }

package/lib/cjs/types/adapter-express/application-express.d.ts

@@ -1,8 +1,7 @@
-import express from "express";
-import { AppContainer, IConsoleMessage, ProviderManager, IMiddleware } from "@expressots/core";
-import { RenderEngine, Env, Server } from "@expressots/shared";
+import { Server as HTTPServer } from "http";
+import { AppContainer, IConsoleMessage, IMiddleware, ProviderManager } from "@expressots/core";
+import { Env, IWebServerPublic, RenderEngine, Server } from "@expressots/shared";
 import { interfaces } from "../di/di.interfaces";
-import { ApplicationBase } from "./application-express.base";
 /**
  * The AppExpress class provides methods for configuring and running an Express application.
  * @class AppExpress
@@ -14,7 +13,7 @@ import { ApplicationBase } from "./application-express.base";
  * @method setEngine - Configures the application's view engine based on the provided configuration options.
  * @method isDevelopment - Verifies if the current environment is development.
  */
-export declare class AppExpress extends ApplicationBase implements Server.IWebServer {
+export declare class AppExpress implements Server.IWebServer {
     private logger;
     private console;
     private app;
@@ -28,10 +27,48 @@ export declare class AppExpress extends ApplicationBase implements Server.IWebSe
     private providerManager;
     private renderOptions;
     constructor();
-    protected globalConfiguration(): void | Promise<void>;
-    protected configureServices(): void | Promise<void>;
-    protected postServerInitialization(): void | Promise<void>;
-    protected serverShutdown(): void | Promise<void>;
+    /**
+     * Implement this method to set up global configurations for the server.
+     * This method is called before any other server initialization methods.
+     * Use this method to configure global settings that apply to the entire
+     * server application. Supports asynchronous setup with a Promise.
+     *
+     * @abstract
+     * @returns {void | Promise<void>}
+     * @public API
+     */
+    protected globalConfiguration(): Promise<void>;
+    /**
+     * 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 asynchronous setup with a Promise.
+     *
+     * @abstract
+     * @returns {void | Promise<void>}
+     * @public API
+     */
+    protected configureServices(): Promise<void>;
+    /**
+     * 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 asynchronous execution with a Promise.
+     *
+     * @abstract
+     * @returns {void | Promise<void>}
+     * @public API
+     */
+    protected postServerInitialization(): Promise<void>;
+    /**
+     * 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 asynchronous
+     * cleanup with a Promise.
+     *
+     * @abstract
+     * @returns {void | Promise<void>}
+     * @public API
+     */
+    protected serverShutdown(): Promise<void>;
     /**
      * Handles process exit by calling serverShutdown and then exiting the process.
      */
@@ -79,14 +116,14 @@ export declare class AppExpress extends ApplicationBase implements Server.IWebSe
      * @param appInfo - Optional message to display the app name and version.
      * @public API
      */
-    listen(port: number | string, appInfo?: IConsoleMessage): Promise<void>;
+    listen(port: number | string, appInfo?: IConsoleMessage): Promise<IWebServerPublic>;
     /**
      * Sets the global route prefix for the application.
      * @method setGlobalRoutePrefix
      * @param {string} prefix - The prefix to use for all routes.
      * @public API
      */
-    setGlobalRoutePrefix(prefix: string): void;
+    setGlobalRoutePrefix(prefix: string): Promise<void>;
     /**
      * Configures the application's view engine based on the provided configuration options.
      */
@@ -106,7 +143,7 @@ export declare class AppExpress extends ApplicationBase implements Server.IWebSe
      * @returns A boolean value indicating whether the current environment is development or not.
      * @public API
      */
-    protected isDevelopment(): boolean;
+    isDevelopment(): Promise<boolean>;
     /**
      * Load environment variables from the specified file based on the environment configuration.
      * @param environment - The environment to load configuration for.
@@ -123,17 +160,11 @@ export declare class AppExpress extends ApplicationBase implements Server.IWebSe
       * ```
      * @public API
      */
-    initEnvironment(environment: Env.Environment, options?: Env.IEnvironment): void;
+    initEnvironment(environment: Env.Environment, options?: Env.IEnvironment): Promise<void>;
     /**
      * Get the underlying HTTP server. (default: Express.js)
      * @returns The underlying HTTP server after initialization.
      * @public API
      */
-    getHttpServer(): Promise<express.Application>;
-    /**
-     * Close the server instance.
-     * @returns A promise that resolves when the server is closed.
-     * @public API
-     */
-    close(enableLog?: boolean): Promise<void>;
+    getHttpServer(): Promise<HTTPServer>;
 }

package/lib/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expressots/adapter-express",
-  "version": "3.0.0-beta.3",
+  "version": "3.0.0-beta.4",
   "description": "Expressots - modern, fast, lightweight nodejs web framework (@adapter-express)",
   "author": "",
   "main": "./lib/cjs/index.js",
@@ -66,14 +66,14 @@
     "reflect-metadata": "0.2.2"
   },
   "devDependencies": {
-    "@codecov/vite-plugin": "^0.0.1-beta.6",
+    "@codecov/vite-plugin": "0.0.1-beta.6",
     "@commitlint/cli": "19.2.1",
     "@commitlint/config-conventional": "19.2.2",
-    "@expressots/core": "3.0.0-beta.3",
-    "@expressots/shared": "3.0.0-beta.3",
+    "@expressots/core": "3.0.0-beta.4",
+    "@expressots/shared": "3.0.0-beta.4",
     "@release-it/conventional-changelog": "8.0.1",
     "@types/express": "4.17.21",
-    "@types/jest": "^29.5.14",
+    "@types/jest": "29.5.14",
     "@types/node": "20.14.10",
     "@typescript-eslint/eslint-plugin": "7.16.1",
     "@typescript-eslint/parser": "7.16.1",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expressots/adapter-express",
-  "version": "3.0.0-beta.3",
+  "version": "3.0.0-beta.4.1",
   "description": "Expressots - modern, fast, lightweight nodejs web framework (@adapter-express)",
   "author": "",
   "main": "./lib/cjs/index.js",
@@ -66,14 +66,14 @@
     "reflect-metadata": "0.2.2"
   },
   "devDependencies": {
-    "@codecov/vite-plugin": "^0.0.1-beta.6",
+    "@codecov/vite-plugin": "0.0.1-beta.6",
     "@commitlint/cli": "19.2.1",
     "@commitlint/config-conventional": "19.2.2",
-    "@expressots/core": "3.0.0-beta.3",
-    "@expressots/shared": "3.0.0-beta.3",
+    "@expressots/core": "3.0.0-beta.4",
+    "@expressots/shared": "3.0.0-beta.4",
     "@release-it/conventional-changelog": "8.0.1",
     "@types/express": "4.17.21",
-    "@types/jest": "^29.5.14",
+    "@types/jest": "29.5.14",
     "@types/node": "20.14.10",
     "@typescript-eslint/eslint-plugin": "7.16.1",
     "@typescript-eslint/parser": "7.16.1",