@seas-computing/nestjs-healthcheck 0.0.13-0 → 0.0.13-1

package/README.md

@@ -1,10 +1,10 @@
 # NestJS HealthCheck Module
 
-The `nestjs-healthcheck` package provides a standlone NestJS module that verifies the availability of essential application dependencies. This includes:
+The `nestjs-healthcheck` package provides a standalone NestJS module that verifies the availability of essential application dependencies. This includes:
   - pinging the application database using `TypeOrmHealthIndicator`
-  - performing an HTTP ping to the HarvardKey (CAS logout) URL uisng `HttpHealthIndicator`
-  - pinging Redis with a custom `RedisHealthService`
-It returns a composite health status result and the current app version. It is intended to be included in a larger application and assumes the presence of a Redis connection and database connection during runtime.
+  - performing an HTTP ping to the HarvardKey OIDC discovery document URL using `HttpHealthIndicator`
+  - pinging Valkey with a custom `ValkeyHealthService`
+It returns a composite health status result and the current app version. It is intended to be included in a larger application and assumes the presence of a Valkey connection and database connection during runtime.
 
 ## Installation
 ```
@@ -16,15 +16,16 @@ npm install @seas-computing/nestjs-healthcheck
 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`
+- import `TypeOrmModule` and `ValkeyModule`
 
 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):
+Example `app.module` from [oap-grad-database](https://github.huit.harvard.edu/SEAS/oap-grad-database/blob/develop/src/server/app.module.ts):
 ```ts
 @Module({
   imports: [
-    ConfigModule, // Ensure this is at the top
+    ConfigModule,  // Ensure this is at the top
+    HealthCheckModule,
     LogModule.registerAsync({
       imports: [ConfigModule],
       inject: [ConfigService],
@@ -35,24 +36,22 @@ Example `app.module` from [makerspace](https://github.huit.harvard.edu/SEAS/make
       imports: [ConfigModule],
       useFactory: (
         config: ConfigService
-      ): HarvardKeyModuleOptions => config.harvardKeyConfig,
+      ) => ({
+        ...config.harvardKeyConfig,
+      }),
     }),
     SessionModule.forRootAsync({
       imports: [ConfigModule],
       inject: [ConfigService],
-      useFactory: async (
+      useFactory: (
         config: ConfigService
-      ): Promise<NestSessionOptions> => {
-        const client = createClient(config.redisClientOptions);
-        // Version 4 of redis does not automatically connect to the server:
-        // https://github.com/redis/node-redis/blob/master/docs/v3-to-v4.md
-        await client.connect();
-        await client.ping();
+      ): NestSessionOptions => {
+        const client = new Redis(config.valkeyClientOptions);
         const store = new RedisStore({
           client,
           prefix: config.get('REDIS_PREFIX'),
         });
-        return config.getSessionSettings(store);
+        return { session: config.getSessionSettings(store) };
       },
     }),
     TypeOrmModule.forRootAsync({
@@ -65,13 +64,12 @@ Example `app.module` from [makerspace](https://github.huit.harvard.edu/SEAS/make
         maxQueryExecutionTime: 1000,
       }),
     }),
-    // Add the Redis module
     RedisModule.forRootAsync({
       imports: [ConfigModule],
       inject: [ConfigService],
       useFactory: (config: ConfigService): RedisModuleOptions => ({
         type: 'single',
-        url: config.redisURL,
+        url: config.valkeyURL,
         options: {
           tls: {
             rejectUnauthorized: false,
@@ -79,31 +77,18 @@ Example `app.module` from [makerspace](https://github.huit.harvard.edu/SEAS/make
         },
       }),
     }),
-    TrainingModule,
-    PersonModule,
-    AffiliationModule,
-    AttendanceModule,
-    UserModule,
-    KioskModule,
-    HealthcheckModule.registerAsync({ // Add HealthCheckModule
+    AdvisorModule,
+    StudentModule,
+    StudentToAdvisorModule,
+    NoteModule,
+    ThesisModule,
+    DegreeProgramModule,
+    MilestonesModule,
+    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,
-        };
+        return configService.healthcheckConfig,
       },
     }),
   ],
@@ -118,7 +103,10 @@ class AppModule implements NestModule {
   configure(consumer: MiddlewareConsumer): void {
     consumer
       .apply(LogMiddleware)
-      .exclude({ path: 'makerspace/health-check', method: RequestMethod.ALL }) // exclude healthcheck
+      .exclude(
+        'heartbeat',
+        { path: 'oapGradDatabase/health-check', method: RequestMethod.ALL }  // exclude healthcheck
+      )
       .forRoutes('*');
   }
 }
@@ -127,33 +115,40 @@ 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):
+Examples of additions to `config.service.ts` from [oap-grad-database](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 {
+ * Returns the OIDC discovery document URL, which will be sent to the
+ * Healthcheck Module. The /.well-known/openid-configuration endpoint
+ * is the standard, unauthenticated health signal exposed by all OIDC
+ * providers.
+ */
+public get oidcCheckURL(): string {
+  return `${this.oidcBaseURL}/.well-known/openid-configuration`;
+}
+
+/**
+ * Returns the Valkey URL
+ */
+public get valkeyURL(): string {
   const {
-    origin,
-    pathname,
-  } = this.casURL;
-  let cleanPath = pathname.replace(/\/$/, '');
-  cleanPath = cleanPath.replace(/\/(login|logout)$/, '');
-  if (!cleanPath.endsWith('/cas')) {
-    cleanPath += '/cas';
+    VALKEY_HOST,
+    VALKEY_PORT,
+    VALKEY_PASSWORD,
+  } = this.env;
+  const valkey = new URL(`rediss://${VALKEY_HOST}:${VALKEY_PORT}`);
+  if (VALKEY_PASSWORD) {
+    valkey.password = VALKEY_PASSWORD;
   }
-  return `${origin}${cleanPath}/logout`;
+  return valkey.toString();
 }
 
 public get healthcheckConfig(): HealthcheckModuleOptions {
     return {
-      casCheckURL: this.casCheckURL,
+      oidcCheckURL: this.oidcCheckURL,
       dbOptions: this.dbOptions,
-      redisUrl: this.redisURL,
+      valkeyURL: this.valkeyURL,
       version: this.buildVersion,
       strategy: this.isProduction
         ? HEALTH_STRATEGY_NAME.HEALTHCHECK
@@ -176,7 +171,7 @@ You should receive a response that looks like this:
     "harvard-key": {
       "status": "up"
     },
-    "redis": {
+    "valkey": {
       "status": "up",
       "result": "PONG"
     }
@@ -189,7 +184,7 @@ You should receive a response that looks like this:
     "harvard-key": {
       "status": "up"
     },
-    "redis": {
+    "valkey": {
       "status": "up",
       "result": "PONG"
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seas-computing/nestjs-healthcheck",
-  "version": "0.0.13-0",
+  "version": "0.0.13-1",
   "description": "A standalone healthcheck module for NestJS apps",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",