@notchjs/core 0.2.3 → 0.4.0

package/dist/application.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 /// <reference types="node" />
+/// <reference types="node" />
 import * as http from 'node:http';
 import * as https from 'node:https';
 import type { HttpAdapter } from '@notchjs/types';
@@ -10,6 +11,8 @@ export declare class Application {
     private readonly adapter;
     private readonly hooks;
     private readonly _environment;
+    private readonly activeSignals;
+    private cleanupRef?;
     private isInitialized;
     private isListening;
     constructor(adapter: HttpAdapter, hooks: HookCollector, environment: ApplicationEnvironment);
@@ -23,6 +26,9 @@ export declare class Application {
     listen(port: string | number, hostname: string, callback?: () => void): Promise<any>;
     close(signal?: string): Promise<void>;
     getUrl(): Promise<string>;
+    protected shutdownOnSignal(signals?: (NodeJS.Signals | string)[]): void;
+    protected listenToSignals(signals: NodeJS.Signals[]): void;
+    protected unsubscribeFromSignals(): void;
     protected dispose(): Promise<void>;
     private formatAddress;
     private getProtocol;

package/dist/application.js

@@ -3,8 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Application = void 0;
 const node_os_1 = require("node:os");
 const notions_1 = require("@hemjs/notions");
+const iterare_1 = require("iterare");
 class Application {
     constructor(adapter, hooks, environment) {
+        this.activeSignals = new Array();
         this.isInitialized = false;
         this.isListening = false;
         this.adapter = adapter;
@@ -20,11 +22,11 @@ class Application {
             return this;
         }
         const startAt = process.hrtime.bigint();
-        await this.hooks.addStartupHook();
+        await this.hooks.onStartup();
         this.isInitialized = true;
         const finishedAt = process.hrtime.bigint();
-        const elapsed = (Number(finishedAt - startAt) / 1e9).toFixed(3);
-        this.environment.log?.info(`Application started in ${elapsed} seconds`);
+        const elapsedTime = (Number(finishedAt - startAt) / 1e9).toFixed(3);
+        this.environment.log?.info(`Application started in ${elapsedTime} seconds`);
         return this;
     }
     getHttpAdapter() {
@@ -43,6 +45,9 @@ class Application {
     async listen(port, ...args) {
         if (!this.isInitialized)
             await this.init();
+        if (this.environment.config?.shutdown?.enabled === true) {
+            this.shutdownOnSignal(this.environment.config?.shutdown?.signals);
+        }
         return new Promise((resolve, reject) => {
             const errorHandler = (e) => {
                 this.environment.log?.error(e?.toString?.());
@@ -71,13 +76,14 @@ class Application {
     }
     async close(signal) {
         await this.dispose();
-        await this.hooks.addShutdownHook(signal);
+        await this.hooks.onShutdown(signal);
+        this.unsubscribeFromSignals();
         this.isListening = false;
     }
     async getUrl() {
         return new Promise((resolve, reject) => {
             if (!this.isListening) {
-                this.environment.log?.error('app.listen() must be called before attempting to get the URL with app.getUrl()');
+                this.environment.log?.error('app.listen() must be called before app.getUrl()');
                 reject('Server not listening!');
                 return;
             }
@@ -85,6 +91,46 @@ class Application {
             resolve(this.formatAddress(address));
         });
     }
+    shutdownOnSignal(signals = []) {
+        signals = (0, iterare_1.iterate)(Array.from(new Set(['SIGTERM', ...signals])))
+            .map((signal) => signal.toString().toUpperCase().trim())
+            .filter((signal) => !this.activeSignals.includes(signal))
+            .toArray();
+        this.listenToSignals(signals);
+    }
+    listenToSignals(signals) {
+        let receivedSignal = false;
+        const doCleanup = async (signal) => {
+            try {
+                if (receivedSignal) {
+                    return;
+                }
+                receivedSignal = true;
+                this.environment.log?.info(`Received ${signal}. Shutdown initiated...`);
+                await this.dispose();
+                await this.hooks.onShutdown(signal);
+                signals.forEach((sig) => process.removeListener(sig, doCleanup));
+                process.kill(process.pid, signal);
+            }
+            catch (err) {
+                this.environment.log?.error(`Error during shutdown: ${err.stack}`);
+                process.exit(1);
+            }
+        };
+        this.cleanupRef = doCleanup;
+        signals.forEach((signal) => {
+            this.activeSignals.push(signal);
+            process.on(signal, doCleanup);
+        });
+    }
+    unsubscribeFromSignals() {
+        if (!this.cleanupRef) {
+            return;
+        }
+        this.activeSignals.forEach((signal) => {
+            process.removeListener(signal, this.cleanupRef);
+        });
+    }
     async dispose() {
         this.adapter && (await this.adapter.close());
     }

package/dist/hook-collector.d.ts

@@ -3,8 +3,8 @@ import type { HookFactory } from './hook-factory';
 export declare class HookCollector {
     private readonly records;
     constructor(factory: HookFactory, hooks?: HookProvider[]);
-    addStartupHook(): Promise<void>;
-    addShutdownHook(signal?: string): Promise<void>;
+    onStartup(): Promise<void>;
+    onShutdown(signal?: string): Promise<void>;
     private runStartupHook;
     private runShutdownHook;
     private isStartupHook;

package/dist/hook-collector.js

@@ -7,10 +7,10 @@ class HookCollector {
     constructor(factory, hooks = []) {
         this.records = factory.prepare(hooks);
     }
-    async addStartupHook() {
+    async onStartup() {
         await Promise.all(this.runStartupHook(this.records));
     }
-    async addShutdownHook(signal) {
+    async onShutdown(signal) {
         await Promise.all(this.runShutdownHook(this.records, signal));
     }
     runStartupHook(records) {

package/dist/http-adapter-host.d.ts

@@ -1,6 +1,6 @@
 import type { HttpAdapter } from '@notchjs/types';
 export declare class HttpAdapterHost {
     private _httpAdapter;
-    constructor(httpAdapter?: HttpAdapter);
-    get httpAdapter(): HttpAdapter | undefined;
+    constructor(httpAdapter: HttpAdapter);
+    get httpAdapter(): HttpAdapter;
 }

package/dist/interfaces/application-config.d.ts

@@ -1,5 +1,7 @@
 /// <reference types="node" />
 import type { TlsOptions } from 'node:tls';
+import type { ShutdownOptions } from './shutdown-options';
 export interface ApplicationConfig {
     tls?: TlsOptions;
+    shutdown?: ShutdownOptions;
 }

package/dist/interfaces/shutdown-options.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="node" />
+export interface ShutdownOptions {
+    enabled?: boolean;
+    signals?: Array<NodeJS.Signals | string>;
+    graceful?: boolean;
+    grace?: number;
+}

package/dist/interfaces/shutdown-options.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/logger-host.d.ts

@@ -1,6 +1,6 @@
 import type { Logger } from '@armscye/logging';
 export declare class LoggerHost {
     private _logger;
-    constructor(logger?: Logger);
-    get logger(): Logger | undefined;
+    constructor(logger: Logger);
+    get logger(): Logger;
 }

package/dist/notch.module.js

@@ -16,10 +16,13 @@ class NotchModule {
                 {
                     provide: http_adapter_host_1.HttpAdapterHost.name,
                     useFactory: (container) => {
-                        const adapter = container.has(constants_1.HTTP_ADAPTER)
+                        const httpAdapter = container.has(constants_1.HTTP_ADAPTER)
                             ? container.get(constants_1.HTTP_ADAPTER)
                             : undefined;
-                        return new http_adapter_host_1.HttpAdapterHost(adapter);
+                        if (!httpAdapter) {
+                            throw new Error('HTTP adapter not found. Please register a compatible HTTP adapter with the "HTTP_ADAPTER" token.');
+                        }
+                        return new http_adapter_host_1.HttpAdapterHost(httpAdapter);
                     },
                 },
                 {
@@ -55,13 +58,10 @@ class NotchModule {
                 {
                     provide: application_1.Application.name,
                     useFactory: (container) => {
-                        const httpAdapterHost = container.get(http_adapter_host_1.HttpAdapterHost.name);
-                        if (!httpAdapterHost.httpAdapter) {
-                            throw new Error('HTTP adapter missing');
-                        }
                         const config = container.has('config')
                             ? container.get('config')
                             : {};
+                        const httpAdapterHost = container.get(http_adapter_host_1.HttpAdapterHost.name);
                         const loggerHost = container.get(logger_host_1.LoggerHost.name);
                         const hooks = container.get(hook_collector_1.HookCollector.name);
                         return new application_1.Application(httpAdapterHost.httpAdapter, hooks, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@notchjs/core",
-  "version": "0.2.3",
+  "version": "0.4.0",
   "description": "A dependency injection based web framework (Node.js)",
   "license": "MIT",
   "author": "Augustus Kamau",
@@ -18,13 +18,13 @@
     "test": "jest --detectOpenHandles"
   },
   "dependencies": {
-    "@notchjs/util": "^0.2.1",
+    "@notchjs/util": "^0.4.0",
     "iterare": "1.2.1",
     "tslib": "2.6.2"
   },
   "devDependencies": {
-    "@notchjs/express": "^0.2.2",
-    "@notchjs/types": "^0.2.1"
+    "@notchjs/express": "^0.4.0",
+    "@notchjs/types": "^0.4.0"
   },
   "homepage": "https://github.com/notchjs/notch",
   "bugs": {
@@ -40,5 +40,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "976b1b1e73bf54d420001e524625a24845e06bdc"
+  "gitHead": "309faca8c971daedad07aff9fdc69383cdeda2b3"
 }