@seas-computing/nestjs-healthcheck 0.0.5-14 → 0.0.5-15

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):
+- import and register the `HealthcheckModule` using `registerAsync`
+- be sure that the `ConfigModule` is at the top of the imports list
+- import `TypeOrmHealthIndicator`, `HttpHealthIndicator`, and `RedisHealthService`
 
-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/package.json

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