@seas-computing/nestjs-healthcheck 0.0.0 → 0.0.2

package/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2025 President and Fellows of Harvard College. All rights
+reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+may be used to endorse or promote products derived from this software without
+specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
+USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,103 @@
+# NestJS HealthCheck Module
+
+The `nestjs-healthcheck` package provides a standlone 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.
+
+## Installation
+```
+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`.
+
+Example from makerspace:
+```ts
+@Module({
+  imports: [
+    ConfigModule, // Ensure this is at the top
+    LogModule.registerAsync({
+      imports: [ConfigModule],
+      inject: [ConfigService],
+      useFactory: (config: ConfigService) => config.logLevel,
+    }),
+    HarvardKeyModule.registerAsync({
+      inject: [ConfigService],
+      imports: [ConfigModule],
+      useFactory: (
+        config: ConfigService
+      ): HarvardKeyModuleOptions => config.harvardKeyConfig,
+    }),
+    SessionModule.forRootAsync({
+      imports: [ConfigModule],
+      inject: [ConfigService],
+      useFactory: async (
+        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();
+        const store = new RedisStore({
+          client,
+          prefix: config.get('REDIS_PREFIX'),
+        });
+        return config.getSessionSettings(store);
+      },
+    }),
+    TypeOrmModule.forRootAsync({
+      imports: [ConfigModule],
+      inject: [ConfigService],
+      useFactory: (
+        config: ConfigService
+      ): TypeOrmModuleOptions => ({
+        ...config.dbOptions,
+        maxQueryExecutionTime: 1000,
+      }),
+    }),
+    // Add the Redis module
+    RedisModule.forRootAsync({
+      imports: [ConfigModule],
+      inject: [ConfigService],
+      useFactory: (config: ConfigService): RedisModuleOptions => ({
+        type: 'single',
+        url: config.redisURL,
+        options: {
+          tls: {
+            rejectUnauthorized: false,
+          },
+        },
+      }),
+    }),
+    TrainingModule,
+    PersonModule,
+    AffiliationModule,
+    AttendanceModule,
+    UserModule,
+    KioskModule,
+    HealthCheckModule, // Add HealthCheckModule
+  ],
+  controllers: [],
+  providers: [],
+})
+
+class AppModule implements NestModule {
+  /**
+   * Apply our logging middleware for all routes except the healthcheck
+   */
+  configure(consumer: MiddlewareConsumer): void {
+    consumer
+      .apply(LogMiddleware)
+      .exclude({ path: 'makerspace/health-check', method: RequestMethod.ALL }) // exclude healthcheck
+      .forRoutes('*');
+  }
+}
+
+export { AppModule };
+
+```

package/dist/src/RedisHealthService.d.ts

@@ -0,0 +1,7 @@
+import { HealthIndicatorResult } from '@nestjs/terminus';
+import { Redis } from 'ioredis';
+export declare class RedisHealthService {
+    private readonly redisClient;
+    constructor(redisClient: Redis);
+    checkRedisConnection(): Promise<HealthIndicatorResult>;
+}

package/dist/src/RedisHealthService.js

@@ -0,0 +1,57 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisHealthService = void 0;
+const common_1 = require("@nestjs/common");
+const ioredis_1 = require("ioredis");
+const ioredis_2 = require("@nestjs-modules/ioredis");
+let RedisHealthService = class RedisHealthService {
+    constructor(redisClient) {
+        this.redisClient = redisClient;
+    }
+    async checkRedisConnection() {
+        try {
+            const result = await this.redisClient.ping();
+            return {
+                redis: {
+                    status: 'up',
+                    result,
+                },
+            };
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                return {
+                    redis: {
+                        status: 'down',
+                        message: error.message,
+                    },
+                };
+            }
+            return {
+                redis: {
+                    status: 'down',
+                    message: 'Could not connect to Redis.',
+                },
+            };
+        }
+    }
+};
+exports.RedisHealthService = RedisHealthService;
+exports.RedisHealthService = RedisHealthService = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, ioredis_2.InjectRedis)()),
+    __metadata("design:paramtypes", [ioredis_1.Redis])
+], RedisHealthService);
+//# sourceMappingURL=RedisHealthService.js.map

package/dist/src/RedisHealthService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RedisHealthService.js","sourceRoot":"","sources":["../../src/RedisHealthService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAA4C;AAE5C,qCAAgC;AAChC,qDAAsD;AAS/C,IAAM,kBAAkB,GAAxB,MAAM,kBAAkB;IAC7B,YACkC,WAAkB;QAAlB,gBAAW,GAAX,WAAW,CAAO;IACjD,CAAC;IAEG,KAAK,CAAC,oBAAoB;QAC/B,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;YAE7C,OAAO;gBACL,KAAK,EAAE;oBACL,MAAM,EAAE,IAAI;oBACZ,MAAM;iBACP;aACF,CAAC;QACJ,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;gBAC3B,OAAO;oBACL,KAAK,EAAE;wBACL,MAAM,EAAE,MAAM;wBACd,OAAO,EAAE,KAAK,CAAC,OAAO;qBACvB;iBACF,CAAC;YACJ,CAAC;YACD,OAAO;gBACL,KAAK,EAAE;oBACL,MAAM,EAAE,MAAM;oBACd,OAAO,EAAE,6BAA6B;iBACvC;aACF,CAAC;QACJ,CAAC;IACH,CAAC;CACF,CAAA;AAhCY,gDAAkB;6BAAlB,kBAAkB;IAD9B,IAAA,mBAAU,GAAE;IAGR,WAAA,IAAA,qBAAW,GAAE,CAAA;qCAA+B,eAAK;GAFzC,kBAAkB,CAgC9B"}

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

@@ -0,0 +1,11 @@
+import { HealthCheckService, HealthCheckResult, HttpHealthIndicator } from '@nestjs/terminus';
+import { RedisHealthService } from './RedisHealthService';
+export declare class HealthCheckController {
+    private health;
+    private http;
+    private redisHealth;
+    constructor(health: HealthCheckService, http: HttpHealthIndicator, redisHealth: RedisHealthService);
+    getHealthCheck(): Promise<HealthCheckResult & {
+        version: string;
+    }>;
+}

package/dist/src/healthcheck.controller.js

@@ -0,0 +1,62 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HealthCheckController = void 0;
+const common_1 = require("@nestjs/common");
+const swagger_1 = require("@nestjs/swagger");
+const terminus_1 = require("@nestjs/terminus");
+const RedisHealthService_1 = require("./RedisHealthService");
+let HealthCheckController = class HealthCheckController {
+    constructor(health, http, redisHealth) {
+        this.health = health;
+        this.http = http;
+        this.redisHealth = redisHealth;
+    }
+    async getHealthCheck() {
+        const status = await this.health.check([
+            () => this.http.pingCheck('harvard-key', `/cas/logout`),
+            async () => this.redisHealth.checkRedisConnection(),
+        ]);
+        return {
+            ...status,
+            version: 'version',
+        };
+    }
+};
+exports.HealthCheckController = HealthCheckController;
+__decorate([
+    (0, common_1.Get)('/'),
+    (0, swagger_1.ApiOperation)({
+        summary: 'While the server is active, return a 200 status code',
+    }),
+    (0, swagger_1.ApiOkResponse)({
+        description: 'A 200 response',
+        isArray: false,
+    }),
+    (0, terminus_1.HealthCheck)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], HealthCheckController.prototype, "getHealthCheck", null);
+exports.HealthCheckController = HealthCheckController = __decorate([
+    (0, swagger_1.ApiTags)('Health Check'),
+    (0, common_1.Controller)('health-check'),
+    __param(0, (0, common_1.Inject)(terminus_1.HealthCheckService)),
+    __param(1, (0, common_1.Inject)(terminus_1.HttpHealthIndicator)),
+    __param(2, (0, common_1.Inject)(RedisHealthService_1.RedisHealthService)),
+    __metadata("design:paramtypes", [terminus_1.HealthCheckService,
+        terminus_1.HttpHealthIndicator,
+        RedisHealthService_1.RedisHealthService])
+], HealthCheckController);
+//# sourceMappingURL=healthcheck.controller.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"healthcheck.controller.js","sourceRoot":"","sources":["../../src/healthcheck.controller.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAAyD;AACzD,6CAAuE;AACvE,+CAA2G;AAC3G,6DAA0D;AAInD,IAAM,qBAAqB,GAA3B,MAAM,qBAAqB;IAEhC,YAEsC,MAA0B,EAEzB,IAAyB,EAC1B,WAA+B;QAH/B,WAAM,GAAN,MAAM,CAAoB;QAEzB,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;YAErC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CACvB,aAAa,EACb,aAAa,CACd;YACD,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,oBAAoB,EAAE;SACpD,CACA,CAAC;QACF,OAAO;YACL,GAAG,MAAM;YACT,OAAO,EAAE,SAAS;SACnB,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;IAKtB,WAAA,IAAA,eAAM,EAAC,6BAAkB,CAAC,CAAA;IAE1B,WAAA,IAAA,eAAM,EAAC,8BAAmB,CAAC,CAAA;IAC3B,WAAA,IAAA,eAAM,EAAC,uCAAkB,CAAC,CAAA;qCAHiB,6BAAkB;QAEnB,8BAAmB;QACb,uCAAkB;GAP1D,qBAAqB,CAsCjC"}

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

@@ -0,0 +1,3 @@
+declare class HealthCheckModule {
+}
+export { HealthCheckModule };

package/dist/src/healthcheck.module.js

@@ -0,0 +1,30 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HealthCheckModule = void 0;
+const common_1 = require("@nestjs/common");
+const terminus_1 = require("@nestjs/terminus");
+const axios_1 = require("@nestjs/axios");
+const typeorm_1 = require("@nestjs/typeorm");
+const healthcheck_controller_1 = require("./healthcheck.controller");
+const RedisHealthService_1 = require("./RedisHealthService");
+let HealthCheckModule = class HealthCheckModule {
+};
+exports.HealthCheckModule = HealthCheckModule;
+exports.HealthCheckModule = HealthCheckModule = __decorate([
+    (0, common_1.Module)({
+        imports: [
+            terminus_1.TerminusModule,
+            axios_1.HttpModule,
+            typeorm_1.TypeOrmModule.forFeature([]),
+        ],
+        controllers: [healthcheck_controller_1.HealthCheckController],
+        providers: [RedisHealthService_1.RedisHealthService],
+    })
+], HealthCheckModule);
+//# sourceMappingURL=healthcheck.module.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"healthcheck.module.js","sourceRoot":"","sources":["../../src/healthcheck.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAAwC;AACxC,+CAAkD;AAClD,yCAA2C;AAC3C,6CAAgD;AAChD,qEAAiE;AACjE,6DAA0D;AAY1D,IAAM,iBAAiB,GAAvB,MAAM,iBAAiB;CAAG,CAAA;AAEjB,8CAAiB;4BAFpB,iBAAiB;IAVtB,IAAA,eAAM,EAAC;QACN,OAAO,EAAE;YACP,yBAAc;YACd,kBAAU;YACV,uBAAa,CAAC,UAAU,CAAC,EAAE,CAAC;SAC7B;QACD,WAAW,EAAE,CAAC,8CAAqB,CAAC;QACpC,SAAS,EAAE,CAAC,uCAAkB,CAAC;KAChC,CAAC;GAEI,iBAAiB,CAAG"}

package/dist/src/index.d.ts

@@ -0,0 +1,4 @@
+export * from './healthcheck.module';
+export * from './healthcheck.controller';
+export * from './RedisHealthService';
+export * from './types/ConfigServiceInterface';

package/dist/src/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./healthcheck.module"), exports);
+__exportStar(require("./healthcheck.controller"), exports);
+__exportStar(require("./RedisHealthService"), exports);
+__exportStar(require("./types/ConfigServiceInterface"), exports);
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAqC;AACrC,2DAAyC;AACzC,uDAAqC;AACrC,iEAA+C"}

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

@@ -0,0 +1,4 @@
+export interface ConfigServiceInterface {
+    casBaseURL: string;
+    buildVersion: string;
+}

package/dist/src/types/ConfigServiceInterface.js

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

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

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

package/package.json

@@ -1,12 +1,54 @@
 {
   "name": "@seas-computing/nestjs-healthcheck",
-  "version": "0.0.0",
+  "version": "0.0.2",
   "description": "A standalone healthcheck module for NestJS apps",
-  "main": "index.js",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "files": [
+    "lib/*",
+    "LICENSE",
+    "dist/src"
+  ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "rimraf dist/ && tsc",
+    "test": "nyc mocha --require ts-node/register \"test/**/*.test.ts\"",
+    "lint": "eslint --ext=ts,tsx,js ./src",
+    "test:watch": "TS_NODE_TRANSPILE_ONLY=true mocha --watch",
+    "typecheck": "tsc --noEmit",
+    "prepare": "npm run build"
   },
+  "keywords": [],
   "author": "Amalya Megerman",
-  "license": "BSD-3-Clause",
-  "private": false
+  "license": "MIT",
+  "peerDependencies": {
+    "@nestjs-modules/ioredis": "^2.0.2",
+    "@nestjs/axios": "^4.0.0",
+    "@nestjs/common": "^10.4.15",
+    "@nestjs/config": "^4.0.2",
+    "@nestjs/core": "^10.4.15",
+    "@nestjs/swagger": "^7.1.16",
+    "@nestjs/terminus": "^11.0.0",
+    "@nestjs/testing": "^10.1.0",
+    "@nestjs/typeorm": "^11.0.0",
+    "ioredis": "^5.6.1",
+    "redis": "^4.7.0",
+    "reflect-metadata": "^0.1.13",
+    "sinon": "^20.0.0",
+    "typeorm": "^0.3.22",
+    "typescript": "^5.1.6"
+  },
+  "devDependencies": {
+    "@nestjs/swagger": "^7.4.2",
+    "@nestjs/testing": "^10.1.0",
+    "@seas-computing/eslint-config": "^0.0.3",
+    "@types/mocha": "^10.0.1",
+    "@types/node": "^20.4.2",
+    "@types/sinon": "^17.0.4",
+    "eslint": "^9.24.0",
+    "mocha": "^10.2.0",
+    "nyc": "^15.1.0",
+    "rimraf": "^6.0.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.3"
+  }
 }