feat: add healthcheck

Author: angristan

package-lock.json

@@ -40,6 +40,7 @@
     "@nestjs/passport": "^7.1.5",
     "@nestjs/platform-express": "7.6.17",
     "@nestjs/swagger": "^4.8.0",
+    "@nestjs/terminus": "^7.2.0",
     "@nestjs/typeorm": "^7.1.5",
     "argon2": "^0.27.2",
     "bull": "^3.22.6",

package.json

@@ -1,6 +1,7 @@
 import { BullModule } from '@nestjs/bull';
 import { Module } from '@nestjs/common';
 import { ConfigModule } from '@nestjs/config';
+import { TerminusModule } from '@nestjs/terminus';
 import { TypeOrmModule } from '@nestjs/typeorm';
 import { RedisModule } from 'nestjs-redis';
 import { AppController } from './app.controller';
@@ -9,6 +10,7 @@ import ormconfig from './ormconfig';
 import redisconfig from './redisconfig';
 import { SubmissionsModule } from './submissions/submissions.module';
 import { UsersModule } from './users/users.module';
+import { HealthController } from './health/health.controller';
 
 @Module({
   imports: [
@@ -21,8 +23,9 @@ import { UsersModule } from './users/users.module';
       redis: redisconfig,
     }),
     RedisModule.register(redisconfig),
+    TerminusModule,
   ],
-  controllers: [AppController],
+  controllers: [AppController, HealthController],
   providers: [],
 })
 export class AppModule {}

src/app.module.ts

@@ -0,0 +1,26 @@
+import { Controller, Get } from '@nestjs/common';
+import {
+  HealthCheck,
+  HealthCheckResult,
+  HealthCheckService,
+  HealthIndicatorResult,
+  TypeOrmHealthIndicator,
+} from '@nestjs/terminus';
+import { RedisService } from 'nestjs-redis';
+
+@Controller('health')
+export class HealthController {
+  constructor(
+    private health: HealthCheckService,
+    private db: TypeOrmHealthIndicator,
+    private redis: RedisService,
+  ) {}
+
+  @Get()
+  @HealthCheck()
+  check(): Promise<HealthCheckResult> {
+    return this.health.check([
+      (): Promise<HealthIndicatorResult> => this.db.pingCheck('database'),
+    ]);
+  }
+}