@tsed/terminus 8.11.0 → 8.11.2-rc.1

package/lib/esm/TerminusModule.js

@@ -121,4 +121,3 @@ TerminusModule = __decorate([
     Module()
 ], TerminusModule);
 export { TerminusModule };
-//# sourceMappingURL=TerminusModule.js.map

package/lib/esm/decorators/health.js

@@ -25,4 +25,3 @@ export function Health(name) {
         });
     };
 }
-//# sourceMappingURL=health.js.map

package/lib/esm/index.js

@@ -5,4 +5,3 @@ export * from "./decorators/health.js";
 export * from "./interfaces/interfaces.js";
 export * from "./interfaces/TerminusSettings.js";
 export * from "./TerminusModule.js";
-//# sourceMappingURL=index.js.map

package/lib/esm/interfaces/TerminusSettings.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=TerminusSettings.js.map

package/lib/esm/interfaces/interfaces.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=interfaces.js.map

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tsed/terminus",
   "description": "Adds graceful shutdown and Kubernetes readiness / liveness checks for any HTTP applications.",
   "type": "module",
-  "version": "8.11.0",
+  "version": "8.11.2-rc.1",
   "author": "Romain Lenzotti",
   "source": "./src/index.ts",
   "main": "./lib/esm/index.js",
@@ -29,12 +29,12 @@
   },
   "devDependencies": {
     "@godaddy/terminus": "^4.12.1",
-    "@tsed/barrels": "8.11.0",
-    "@tsed/core": "8.11.0",
-    "@tsed/di": "8.11.0",
-    "@tsed/platform-http": "8.11.0",
-    "@tsed/schema": "8.11.0",
-    "@tsed/typescript": "8.11.0",
+    "@tsed/barrels": "8.11.2-rc.1",
+    "@tsed/core": "8.11.2-rc.1",
+    "@tsed/di": "8.11.2-rc.1",
+    "@tsed/platform-http": "8.11.2-rc.1",
+    "@tsed/schema": "8.11.2-rc.1",
+    "@tsed/typescript": "8.11.2-rc.1",
     "eslint": "9.12.0",
     "typescript": "5.4.5",
     "vitest": "3.1.4"
@@ -65,5 +65,8 @@
     "url": "https://github.com/tsedio/tsed/issues"
   },
   "homepage": "https://github.com/tsedio/tsed/tree/production/packages/third-parties/terminus",
-  "license": "MIT"
+  "license": "MIT",
+  "publishConfig": {
+    "tag": "rc"
+  }
 }

package/lib/esm/TerminusModule.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"TerminusModule.js","sourceRoot":"","sources":["../../src/TerminusModule.ts"],"names":[],"mappings":";AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,KAAK,MAAM,YAAY,CAAC;AAE/B,OAAO,EAAC,cAAc,EAAC,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAC,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAmB,MAAM,UAAU,CAAC;AAErF,OAAO,EAAC,UAAU,EAAC,MAAM,cAAc,CAAC;AAKjC,IAAM,cAAc,GAApB,MAAM,cAAc;IAgBlB,OAAO;QACZ,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAED,gBAAgB;QACd,MAAM,EAAC,IAAI,EAAE,GAAG,KAAK,EAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEvC,OAAO;YACL,MAAM,EAAE,CAAC,KAAa,EAAE,KAAU,EAAE,EAAE,CACpC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC;gBACxB,KAAK,EAAE,KAAK,CAAC,WAAW,EAAE;gBAC1B,aAAa,EAAE,KAAK,CAAC,OAAO;aAC7B,CAAC;YACJ,YAAY,EAAE,IAAI,CAAC,UAAU,EAAE;YAC/B,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;YACzC,UAAU,EAAE,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC;YAC7C,cAAc,EAAE,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC;YACrD,2BAA2B,EAAE,IAAI,CAAC,aAAa,CAAC,8BAA8B,CAAC;YAC/E,GAAG,KAAK;SACT,CAAC;IACJ,CAAC;IAED,UAAU,CAAC,MAA8B;QACvC,OAAO,OAAO,CAAC,OAAO,CAAC;YACrB,GAAG,MAAM;YACT;gBACE,GAAG,EAAE,IAAI,CAAC,QAAQ;gBAClB,MAAM,EAAE,KAAK;gBACb,IAAI,EAAE,2BAA2B;aAClC;YACD,GAAG,IAAI,CAAC,MAAM,CAAiB,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,EAAC,QAAQ,EAAE,WAAW,EAAE,OAAO,EAAC,EAAE,EAAE;gBAChF,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;gBAElD,OAAO;oBACL,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,GAAG,QAAQ,CAAC,SAAS,IAAI,WAAW,IAAI;oBAC9C,GAAG,EAAE,IAAI;iBACH,CAAC;YACX,CAAC,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAEO,KAAK;QACX,MAAM,cAAc,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAE/C,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,cAAc,CAAC,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;QAClD,CAAC;QAED,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAEO,MAAM,CACZ,IAAY;QAMZ,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;YACvD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC;YAExD,IAAI,QAAQ,EAAE,CAAC;gBACb,OAAO,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,EAAE,OAAO,CAAiB,EAAE,EAAE;oBAC7E,OAAO;wBACL,QAAQ;wBACR,WAAW;wBACX,OAAO;qBACR,CAAC;gBACJ,CAAC,CAAC,CAAC;YACL,CAAC;YACD,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,UAAU;QAChB,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAiB,QAAQ,CAAC,CAAC,MAAM,CAC7D,CAAC,OAAO,EAAE,EAAC,QAAQ,EAAE,WAAW,EAAE,OAAO,EAAE,EAAC,IAAI,EAAC,EAAC,EAAE,EAAE;YACpD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAM,QAAQ,CAAC,KAAK,CAAE,CAAC;YACzD,MAAM,QAAQ,GAAG,KAAK,EAAE,GAAG,IAAW,EAAE,EAAE;gBACxC,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,WAAW,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;gBAEpD,OAAO,EAAC,CAAC,IAAI,CAAC,EAAE,MAAM,EAAC,CAAC;YAC1B,CAAC,CAAC;YAEF,IAAI,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAExC,OAAO;gBACL,GAAG,OAAO;gBACV,CAAC,IAAI,CAAC,EAAE,QAAQ;aACjB,CAAC;QACJ,CAAC,EACD,EAAkD,CACnD,CAAC;QAEF,MAAM,OAAO,GAAwB;YACnC,GAAG,UAAU;YACb,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,KAAU,EAAE,EAAE;gBAC9B,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;gBAEvF,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAC/B,CAAC;SACF,CAAC;QAEF,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,OAAO,CAAC,QAAuB,EAAE,IAAY;QACnD,IAAI,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC1E,CAAC;IAEO,aAAa,CAAC,IAAY;QAChC,OAAO,CAAC,GAAG,IAAW,EAAE,EAAE;YACxB,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;QAC3C,CAAC,CAAC;IACJ,CAAC;CACF,CAAA;AArIS;IADP,QAAQ,CAAC,UAAU,EAAE,EAAE,CAAC;;gDACU;AAG3B;IADP,QAAQ,CAAC,eAAe,EAAE,SAAS,CAAC;;gDACZ;AAGjB;IADP,MAAM,EAAE;8BACS,eAAe;gDAAC;AAG1B;IADP,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;;kDACmB;AAG/B;IADP,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC;;mDACoB;AAd9B,cAAc;IAD1B,MAAM,EAAE;GACI,cAAc,CAuI1B"}

package/lib/esm/decorators/health.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"health.js","sourceRoot":"","sources":["../../../src/decorators/health.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAC,MAAM,YAAY,CAAC;AAEjC;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,MAAM,CAAC,IAAY;IACjC,OAAO,CAAW,MAAc,EAAE,WAAmB,EAAE,EAAE;QACvD,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,iBAAiB,EAAE;YAC1C,CAAC,WAAW,CAAC,EAAE,EAAC,IAAI,EAAC;SACtB,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC"}

package/lib/esm/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,kCAAkC,CAAC;AACjD,cAAc,qBAAqB,CAAC"}

package/lib/esm/interfaces/TerminusSettings.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"TerminusSettings.js","sourceRoot":"","sources":["../../../src/interfaces/TerminusSettings.ts"],"names":[],"mappings":""}

package/lib/esm/interfaces/interfaces.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../../src/interfaces/interfaces.ts"],"names":[],"mappings":""}

package/src/TerminusModule.spec.ts

@@ -1,91 +0,0 @@
-import {Injectable} from "@tsed/di";
-import {PlatformTest} from "@tsed/platform-http/testing";
-
-import {Health} from "./decorators/health.js";
-import {TerminusModule} from "./TerminusModule.js";
-
-@Injectable()
-class MyService {
-  @Health("mongo")
-  mongo() {
-    return Promise.resolve("OK");
-  }
-
-  @Health("/redis/health")
-  redis() {
-    return Promise.resolve("OK");
-  }
-
-  $beforeShutdown() {}
-}
-
-describe("TerminusModule", () => {
-  beforeEach(() =>
-    PlatformTest.create({
-      terminus: {
-        path: "/health"
-      }
-    })
-  );
-  afterEach(() => PlatformTest.reset());
-
-  it("should load health providers", async () => {
-    const terminusModule = PlatformTest.get<TerminusModule>(TerminusModule);
-
-    const {logger, ...props} = terminusModule.getConfiguration();
-
-    expect(props).toEqual({
-      beforeShutdown: expect.any(Function),
-      healthChecks: {
-        "/mongo/health": expect.any(Function),
-        "/redis/health": expect.any(Function),
-        "/health": expect.any(Function)
-      },
-      onSendFailureDuringShutdown: expect.any(Function),
-      onShutdown: expect.any(Function),
-      onSignal: expect.any(Function)
-    });
-
-    const result = await props.healthChecks["/health"]({});
-
-    expect(result).toEqual([
-      {mongo: "OK"},
-      {"/redis/health": "OK"} // legacy
-    ]);
-
-    logger("event", {message: "message"});
-
-    expect(await terminusModule.$logRoutes([])).toEqual([
-      {
-        method: "GET",
-        name: "TerminusModule.dispatch()",
-        url: "/health"
-      },
-      {
-        method: "GET",
-        name: "MyService.mongo()",
-        url: "/mongo/health"
-      },
-      {
-        method: "GET",
-        name: "MyService.redis()",
-        url: "/redis/health"
-      }
-    ]);
-
-    await props.onSignal();
-  });
-
-  it("should emit event", async () => {
-    const terminusModule = PlatformTest.get<TerminusModule>(TerminusModule);
-    const service = PlatformTest.get<MyService>(MyService);
-
-    vi.spyOn(service, "$beforeShutdown");
-
-    const {beforeShutdown} = terminusModule.getConfiguration();
-
-    await beforeShutdown();
-
-    expect(service.$beforeShutdown).toHaveBeenCalledWith();
-  });
-});

package/src/TerminusModule.ts

@@ -1,147 +0,0 @@
-import Http from "node:http";
-import Https from "node:https";
-
-import {createTerminus} from "@godaddy/terminus";
-import {Constant, Inject, InjectorService, Module, OnInit, Provider} from "@tsed/di";
-import type {PlatformRouteDetails} from "@tsed/platform-http";
-import {concatPath} from "@tsed/schema";
-
-import {TerminusSettings} from "./interfaces/TerminusSettings.js";
-
-@Module()
-export class TerminusModule implements OnInit {
-  @Constant("terminus", {})
-  private settings: TerminusSettings;
-
-  @Constant("terminus.path", "/health")
-  private basePath: string;
-
-  @Inject()
-  private injector: InjectorService;
-
-  @Inject(Http.Server)
-  private httpServer: Http.Server | null;
-
-  @Inject(Https.Server)
-  private httpsServer: Https.Server | null;
-
-  public $onInit() {
-    this.mount();
-  }
-
-  getConfiguration() {
-    const {path, ...props} = this.settings;
-
-    return {
-      logger: (event: string, error: any) =>
-        this.injector.logger.info({
-          event: event.toUpperCase(),
-          error_message: error.message
-        }),
-      healthChecks: this.getHealths(),
-      onSignal: this.createEmitter("$onSignal"),
-      onShutdown: this.createEmitter("$onShutdown"),
-      beforeShutdown: this.createEmitter("$beforeShutdown"),
-      onSendFailureDuringShutdown: this.createEmitter("$onSendFailureDuringShutdown"),
-      ...props
-    };
-  }
-
-  $logRoutes(routes: PlatformRouteDetails[]): Promise<PlatformRouteDetails[]> {
-    return Promise.resolve([
-      ...routes,
-      {
-        url: this.basePath,
-        method: "GET",
-        name: `TerminusModule.dispatch()`
-      },
-      ...this.getAll<{name: string}>("health").map(({provider, propertyKey, options}) => {
-        const path = this.getPath(provider, options.name);
-
-        return {
-          method: "GET",
-          name: `${provider.className}.${propertyKey}()`,
-          url: path
-        } as any;
-      })
-    ]);
-  }
-
-  private mount() {
-    const terminusConfig = this.getConfiguration();
-
-    if (this.httpServer) {
-      createTerminus(this.httpServer, terminusConfig);
-    }
-
-    if (this.httpsServer) {
-      createTerminus(this.httpsServer, terminusConfig);
-    }
-  }
-
-  private getAll<Opts = any>(
-    name: string
-  ): {
-    provider: Provider;
-    propertyKey: string;
-    options: Opts;
-  }[] {
-    return this.injector.getProviders().flatMap((provider) => {
-      const metadata = provider.store.get(`terminus:${name}`);
-
-      if (metadata) {
-        return Object.entries(metadata).map(([propertyKey, options]: [string, Opts]) => {
-          return {
-            provider,
-            propertyKey,
-            options
-          };
-        });
-      }
-      return [];
-    });
-  }
-
-  private getHealths() {
-    const subHealths = this.getAll<{name: string}>("health").reduce(
-      (healths, {provider, propertyKey, options: {name}}) => {
-        const instance = this.injector.get<any>(provider.token)!;
-        const callback = async (...args: any[]) => {
-          const result = await instance[propertyKey](...args);
-
-          return {[name]: result};
-        };
-
-        let path = this.getPath(provider, name);
-
-        return {
-          ...healths,
-          [path]: callback
-        };
-      },
-      {} as Record<string, (state: any) => Promise<any>>
-    );
-
-    const healths: Record<string, any> = {
-      ...subHealths,
-      [this.basePath]: (state: any) => {
-        const promises = Object.entries(subHealths).map(([path, callback]) => callback(state));
-
-        return Promise.all(promises);
-      }
-    };
-
-    return healths;
-  }
-
-  private getPath(provider: Provider<any>, name: string) {
-    let path = concatPath(provider.path, name);
-    return path.includes("health") ? path : concatPath(path, this.basePath);
-  }
-
-  private createEmitter(name: string) {
-    return (...args: any[]) => {
-      return this.injector.emit(name, ...args);
-    };
-  }
-}

package/src/decorators/health.ts

@@ -1,28 +0,0 @@
-import {Store} from "@tsed/core";
-
-/**
- * Create a readiness / liveness checks.
- *
- * ```ts
- * import { Health } from "@tsed/terminus";
- *
- * @Controller("/mongo")
- * class MongoCtrl {
- *   @Health("/health")
- *   health() {
- *     // Here check the mongo health
- *     return Promise.resolve();
- *   }
- * }
- *
- * @param name
- * @decorator
- * @terminus
- */
-export function Health(name: string): MethodDecorator {
-  return <Function>(target: Object, propertyKey: string) => {
-    Store.from(target).merge(`terminus:health`, {
-      [propertyKey]: {name}
-    });
-  };
-}

package/src/index.ts

@@ -1,7 +0,0 @@
-/**
- * @file Automatically generated by @tsed/barrels.
- */
-export * from "./decorators/health.js";
-export * from "./interfaces/interfaces.js";
-export * from "./interfaces/TerminusSettings.js";
-export * from "./TerminusModule.js";

package/src/interfaces/TerminusSettings.ts

@@ -1,6 +0,0 @@
-import {TerminusOptions} from "@godaddy/terminus";
-
-export type TerminusSettings = Omit<
-  TerminusOptions,
-  "healthChecks" | "onSignal" | "onSendFailureDuringShutdown" | "onShutdown" | "beforeShutdown" | "onSigterm"
-> & {path?: string};

package/src/interfaces/interfaces.ts

@@ -1,9 +0,0 @@
-import {TerminusSettings} from "./TerminusSettings.js";
-
-declare global {
-  namespace TsED {
-    interface Configuration {
-      terminus: TerminusSettings;
-    }
-  }
-}

package/vitest.config.mts

@@ -1,21 +0,0 @@
-// @ts-ignore
-import {presets} from "@tsed/vitest/presets";
-import {defineConfig} from "vitest/config";
-
-export default defineConfig(
-  {
-    ...presets,
-    test: {
-      ...presets.test,
-      coverage: {
-        ...presets.test.coverage,
-        thresholds: {
-          statements: 0,
-          branches: 0,
-          functions: 0,
-          lines: 0
-        }
-      }
-    }
-  }
-);