@seas-computing/nestjs-healthcheck 0.0.5-9 → 0.0.6

package/README.md

@@ -13,9 +13,14 @@ npm install @seas-computing/nestjs-healthcheck
 
 ## Usage
 
-Add the `HealthCheckController` to the consuming application's `AppModule` (or other root module), along with providers for the `CONFIG_SERVICE`, `TypeOrmHealthIndicator`, `HttpHealthIndicator`, and `RedisHealthService`.
+To add the nestjs healthcheck system, you should make the following changes in the consuming application's `AppModule` (or other root module):
+- be sure that the `ConfigModule` is at the top of the imports list
+- import and register the `HealthcheckModule` using `registerAsync`
+- import `TypeOrmModule` and `RedisModule`
 
-Example from makerspace:
+In the `ConfigService`, configuration values (i.e. `HealthcheckModuleOptions`) should be made available and passed as options to the `HealthcheckModule`.
+
+Example `app.module` from [makerspace](https://github.huit.harvard.edu/SEAS/makerspace/blob/feature/add-healthcheck-module/src/server/app.module.ts):
 ```ts
 @Module({
   imports: [
@@ -80,7 +85,27 @@ Example from makerspace:
     AttendanceModule,
     UserModule,
     KioskModule,
-    HealthCheckModule, // Add HealthCheckModule
+    HealthcheckModule.registerAsync({ // Add HealthCheckModule
+      imports: [ConfigModule],
+      inject: [ConfigService],
+      useFactory: (configService: ConfigService): HealthcheckModuleOptions => {
+        const casHealthcheckUrl = configService.casCheckURL;
+        if (!casHealthcheckUrl) throw new Error('casCheckURL is not defined or is invalid in configuration.');
+        try {
+          new URL(casHealthcheckUrl);
+        } catch (error) {
+          if (error instanceof Error) {
+            throw new Error(`casCheckURL is not a valid URL. ${error}`);
+          } else {
+            throw error;
+          }
+        }
+        return {
+          ...configService.healthcheckConfig,
+          casCheckURL: casHealthcheckUrl,
+        };
+      },
+    }),
   ],
   controllers: [],
   providers: [],
@@ -100,4 +125,74 @@ class AppModule implements NestModule {
 
 export { AppModule };
 
+```
+
+Examples of additions to `config.service.ts` from [makerspace](https://github.huit.harvard.edu/SEAS/makerspace/blob/feature/add-healthcheck-module/src/server/config/config.service.ts):
+
+```ts
+/**
+  * Returns the full healthcheck endpoint for HarvardKey CAS, which will be sent to
+  * the Healthcheck Module. It strips out any auth credentials, query strings, and
+  * hashes, normalizes the path to ensure there is only one `/cas` segment, and
+  * appends `/logout` to the end.
+  */
+public get casCheckURL(): string {
+  const {
+    origin,
+    pathname,
+  } = this.casURL;
+  let cleanPath = pathname.replace(/\/$/, '');
+  cleanPath = cleanPath.replace(/\/(login|logout)$/, '');
+  if (!cleanPath.endsWith('/cas')) {
+    cleanPath += '/cas';
+  }
+  return `${origin}${cleanPath}/logout`;
+}
+
+public get healthcheckConfig(): HealthcheckModuleOptions {
+    return {
+      casCheckURL: this.casCheckURL,
+      dbOptions: this.dbOptions,
+      redisUrl: this.redisURL,
+      version: this.buildVersion,
+      strategy: this.isProduction
+        ? HEALTH_STRATEGY_NAME.HEALTHCHECK
+        : HEALTH_STRATEGY_NAME.DEV,
+    };
+  }
+```
+
+## Sample Response
+
+You should receive a response that looks like this:
+
+```json
+{
+  "status": "ok",
+  "info": {
+    "database": {
+      "status": "up"
+    },
+    "harvard-key": {
+      "status": "up"
+    },
+    "redis": {
+      "status": "up",
+      "result": "PONG"
+    }
+  },
+  "error": {},
+  "details": {
+    "database": {
+      "status": "up"
+    },
+    "harvard-key": {
+      "status": "up"
+    },
+    "redis": {
+      "status": "up",
+      "result": "PONG"
+    }
+  }
+}
 ```

package/dist/src/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":";;;AAGA,IAAY,oBAkBX;AAlBD,WAAY,oBAAoB;IAI9B,2DAAmC,CAAA;IAanC,2CAAmB,CAAA;AACrB,CAAC,EAlBW,oBAAoB,oCAApB,oBAAoB,QAkB/B"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":";;;AAGA,IAAY,oBAqBX;AArBD,WAAY,oBAAoB;IAI9B,2DAAmC,CAAA;IAgBnC,2CAAmB,CAAA;AACrB,CAAC,EArBW,oBAAoB,oCAApB,oBAAoB,QAqB/B"}

package/dist/src/healthcheck.controller.d.ts

@@ -9,6 +9,6 @@ export declare class HealthCheckController {
     private redisHealth;
     constructor(config: ConfigServiceInterface, health: HealthCheckService, db: TypeOrmHealthIndicator, http: HttpHealthIndicator, redisHealth: RedisHealthService);
     getHealthCheck(): Promise<HealthCheckResult & {
-        version: string;
+        buildVersion: string;
     }>;
 }

package/dist/src/healthcheck.controller.js

@@ -16,8 +16,8 @@ exports.HealthCheckController = void 0;
 const common_1 = require("@nestjs/common");
 const swagger_1 = require("@nestjs/swagger");
 const terminus_1 = require("@nestjs/terminus");
-const ConfigServiceInterface_1 = require("./types/ConfigServiceInterface");
 const RedisHealthService_1 = require("./RedisHealthService");
+const healthcheck_module_definition_1 = require("./healthcheck.module-definition");
 let HealthCheckController = class HealthCheckController {
     constructor(config, health, db, http, redisHealth) {
         this.config = config;
@@ -29,12 +29,12 @@ let HealthCheckController = class HealthCheckController {
     async getHealthCheck() {
         const status = await this.health.check([
             () => this.db.pingCheck('database'),
-            () => this.http.pingCheck('harvard-key', `${this.config.casBaseURL}/cas/logout`),
+            () => this.http.pingCheck('harvard-key', this.config.casCheckURL),
             async () => this.redisHealth.checkRedisConnection(),
         ]);
         return {
             ...status,
-            version: this.config.buildVersion,
+            buildVersion: this.config.buildVersion,
         };
     }
 };
@@ -56,7 +56,7 @@ __decorate([
 exports.HealthCheckController = HealthCheckController = __decorate([
     (0, swagger_1.ApiTags)('Health Check'),
     (0, common_1.Controller)('health-check'),
-    __param(0, (0, common_1.Inject)(ConfigServiceInterface_1.CONFIG_SERVICE)),
+    __param(0, (0, common_1.Inject)(healthcheck_module_definition_1.MODULE_OPTIONS_TOKEN)),
     __param(1, (0, common_1.Inject)(terminus_1.HealthCheckService)),
     __param(2, (0, common_1.Inject)(terminus_1.TypeOrmHealthIndicator)),
     __param(3, (0, common_1.Inject)(terminus_1.HttpHealthIndicator)),

package/dist/src/healthcheck.controller.js.map

@@ -1 +1 @@
-{"version":3,"file":"healthcheck.controller.js","sourceRoot":"","sources":["../../src/healthcheck.controller.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAAyD;AACzD,6CAAuE;AACvE,+CAAmI;AACnI,2EAAwF;AACxF,6DAA0D;AAInD,IAAM,qBAAqB,GAA3B,MAAM,qBAAqB;IAEhC,YACkC,MAA8B,EAC1B,MAA0B,EACtB,EAA0B,EAC7B,IAAyB,EAC1B,WAA+B;QAJnC,WAAM,GAAN,MAAM,CAAwB;QAC1B,WAAM,GAAN,MAAM,CAAoB;QACtB,OAAE,GAAF,EAAE,CAAwB;QAC7B,SAAI,GAAJ,IAAI,CAAqB;QAC1B,gBAAW,GAAX,WAAW,CAAoB;IAClE,CAAC;IAcS,AAAN,KAAK,CAAC,cAAc;QAEzB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;YACrC,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,UAAU,CAAC;YACnC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CACvB,aAAa,EACb,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,aAAa,CACvC;YACD,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,oBAAoB,EAAE;SACpD,CACA,CAAC;QACF,OAAO;YACL,GAAG,MAAM;YACT,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,YAAY;SAClC,CAAC;IACJ,CAAC;CACF,CAAA;AAtCY,sDAAqB;AAsBnB;IATZ,IAAA,YAAG,EAAC,GAAG,CAAC;IACR,IAAA,sBAAY,EAAC;QACZ,OAAO,EAAE,sDAAsD;KAChE,CAAC;IACD,IAAA,uBAAa,EAAC;QACb,WAAW,EAAE,gBAAgB;QAC7B,OAAO,EAAE,KAAK;KACf,CAAC;IACD,IAAA,sBAAW,GAAE;;;;2DAgBb;gCArCU,qBAAqB;IAFjC,IAAA,iBAAO,EAAC,cAAc,CAAC;IACvB,IAAA,mBAAU,EAAC,cAAc,CAAC;IAItB,WAAA,IAAA,eAAM,EAAC,uCAAc,CAAC,CAAA;IACtB,WAAA,IAAA,eAAM,EAAC,6BAAkB,CAAC,CAAA;IAC1B,WAAA,IAAA,eAAM,EAAC,iCAAsB,CAAC,CAAA;IAC9B,WAAA,IAAA,eAAM,EAAC,8BAAmB,CAAC,CAAA;IAC3B,WAAA,IAAA,eAAM,EAAC,uCAAkB,CAAC,CAAA;6CAHiB,6BAAkB;QAClB,iCAAsB;QACvB,8BAAmB;QACb,uCAAkB;GAP1D,qBAAqB,CAsCjC"}
+{"version":3,"file":"healthcheck.controller.js","sourceRoot":"","sources":["../../src/healthcheck.controller.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAAyD;AACzD,6CAAuE;AACvE,+CAAmI;AAEnI,6DAA0D;AAC1D,mFAAuE;AAIhE,IAAM,qBAAqB,GAA3B,MAAM,qBAAqB;IAEhC,YACwC,MAA8B,EAChC,MAA0B,EACtB,EAA0B,EAC7B,IAAyB,EAC1B,WAA+B;QAJ7B,WAAM,GAAN,MAAM,CAAwB;QAChC,WAAM,GAAN,MAAM,CAAoB;QACtB,OAAE,GAAF,EAAE,CAAwB;QAC7B,SAAI,GAAJ,IAAI,CAAqB;QAC1B,gBAAW,GAAX,WAAW,CAAoB;IAClE,CAAC;IAcS,AAAN,KAAK,CAAC,cAAc;QAEzB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;YACrC,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,UAAU,CAAC;YACnC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CACvB,aAAa,EACb,IAAI,CAAC,MAAM,CAAC,WAAW,CACxB;YACD,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,oBAAoB,EAAE;SACpD,CACA,CAAC;QACF,OAAO;YACL,GAAG,MAAM;YACT,YAAY,EAAE,IAAI,CAAC,MAAM,CAAC,YAAY;SACvC,CAAC;IACJ,CAAC;CACF,CAAA;AAtCY,sDAAqB;AAsBnB;IATZ,IAAA,YAAG,EAAC,GAAG,CAAC;IACR,IAAA,sBAAY,EAAC;QACZ,OAAO,EAAE,sDAAsD;KAChE,CAAC;IACD,IAAA,uBAAa,EAAC;QACb,WAAW,EAAE,gBAAgB;QAC7B,OAAO,EAAE,KAAK;KACf,CAAC;IACD,IAAA,sBAAW,GAAE;;;;2DAgBb;gCArCU,qBAAqB;IAFjC,IAAA,iBAAO,EAAC,cAAc,CAAC;IACvB,IAAA,mBAAU,EAAC,cAAc,CAAC;IAItB,WAAA,IAAA,eAAM,EAAC,oDAAoB,CAAC,CAAA;IAC5B,WAAA,IAAA,eAAM,EAAC,6BAAkB,CAAC,CAAA;IAC1B,WAAA,IAAA,eAAM,EAAC,iCAAsB,CAAC,CAAA;IAC9B,WAAA,IAAA,eAAM,EAAC,8BAAmB,CAAC,CAAA;IAC3B,WAAA,IAAA,eAAM,EAAC,uCAAkB,CAAC,CAAA;6CAHiB,6BAAkB;QAClB,iCAAsB;QACvB,8BAAmB;QACb,uCAAkB;GAP1D,qBAAqB,CAsCjC"}

package/dist/src/index.d.ts

@@ -2,3 +2,6 @@ export { HealthcheckModule } from './healthcheck.module';
 export * from './healthcheck.controller';
 export * from './RedisHealthService';
 export * from './types/ConfigServiceInterface';
+export * from './types/healthcheckModuleOptions';
+export * from './constants';
+export * from './healthcheck.module-definition';

package/dist/src/index.js

@@ -20,4 +20,7 @@ Object.defineProperty(exports, "HealthcheckModule", { enumerable: true, get: fun
 __exportStar(require("./healthcheck.controller"), exports);
 __exportStar(require("./RedisHealthService"), exports);
 __exportStar(require("./types/ConfigServiceInterface"), exports);
+__exportStar(require("./types/healthcheckModuleOptions"), exports);
+__exportStar(require("./constants"), exports);
+__exportStar(require("./healthcheck.module-definition"), exports);
 //# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,2DAAyD;AAAhD,uHAAA,iBAAiB,OAAA;AAC1B,2DAAyC;AACzC,uDAAqC;AACrC,iEAA+C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,2DAAyD;AAAhD,uHAAA,iBAAiB,OAAA;AAC1B,2DAAyC;AACzC,uDAAqC;AACrC,iEAA+C;AAC/C,mEAAiD;AACjD,8CAA4B;AAC5B,kEAAgD"}

package/dist/src/types/ConfigServiceInterface.d.ts

@@ -1,5 +1,4 @@
-export declare const CONFIG_SERVICE = "CONFIG_SERVICE";
 export interface ConfigServiceInterface {
-    casBaseURL: string;
+    casCheckURL: string;
     buildVersion: string;
 }

package/dist/src/types/ConfigServiceInterface.js

@@ -1,5 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CONFIG_SERVICE = void 0;
-exports.CONFIG_SERVICE = 'CONFIG_SERVICE';
 //# sourceMappingURL=ConfigServiceInterface.js.map

package/dist/src/types/ConfigServiceInterface.js.map

@@ -1 +1 @@
-{"version":3,"file":"ConfigServiceInterface.js","sourceRoot":"","sources":["../../../src/types/ConfigServiceInterface.ts"],"names":[],"mappings":";;;AAAa,QAAA,cAAc,GAAG,gBAAgB,CAAC"}
+{"version":3,"file":"ConfigServiceInterface.js","sourceRoot":"","sources":["../../../src/types/ConfigServiceInterface.ts"],"names":[],"mappings":""}

package/dist/src/types/healthcheckModuleOptions.d.ts

@@ -1,9 +1,9 @@
 import { TypeOrmModuleOptions } from '@nestjs/typeorm';
 import { HEALTH_STRATEGY_NAME } from '../constants';
 export interface HealthcheckModuleOptions {
-    casBaseURL: string;
+    casCheckURL: string;
     dbOptions: TypeOrmModuleOptions;
     redisUrl: string;
-    version: string;
+    buildVersion: string;
     strategy: HEALTH_STRATEGY_NAME;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seas-computing/nestjs-healthcheck",
-  "version": "0.0.5-9",
+  "version": "0.0.6",
   "description": "A standalone healthcheck module for NestJS apps",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",