add healthcheck endpoint (#171)

Author: bmbferreira

package-lock.json

@@ -30,6 +30,7 @@
     "@nestjs/platform-socket.io": "^8.4.1",
     "@nestjs/schedule": "^1.0.2",
     "@nestjs/swagger": "^5.2.0",
+    "@nestjs/terminus": "^8.0.8",
     "@nestjs/websockets": "^8.4.1",
     "@prisma/client": "^2.12.1",
     "ajv": "^8.10.0",

package.json

@@ -11,6 +11,8 @@ import { APP_FILTER, APP_INTERCEPTOR } from '@nestjs/core';
 import { HttpExceptionFilter } from './http-exception.filter';
 import { CompareModule } from './compare/compare.module';
 import { ScheduleModule } from '@nestjs/schedule';
+import { TerminusModule } from '@nestjs/terminus';
+import { HealthController } from './health/health.controller';
 
 @Module({
   imports: [
@@ -23,6 +25,7 @@ import { ScheduleModule } from '@nestjs/schedule';
     ProjectsModule,
     TestRunsModule,
     TestVariationsModule,
+    TerminusModule,
     CompareModule,
   ],
   providers: [
@@ -36,5 +39,6 @@ import { ScheduleModule } from '@nestjs/schedule';
       useClass: CacheInterceptor,
     },
   ],
+  controllers: [HealthController],
 })
 export class AppModule {}

src/app.module.ts

@@ -0,0 +1,24 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { HealthCheckService } from '@nestjs/terminus';
+import { PrismaService } from '../prisma/prisma.service';
+import { HealthController } from './health.controller';
+
+describe('Health Controller', () => {
+  let controller: HealthController;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      controllers: [HealthController],
+      providers: [
+        { provide: HealthCheckService, useValue: {} },
+        { provide: PrismaService, useValue: {} },
+      ],
+    }).compile();
+
+    controller = module.get<HealthController>(HealthController);
+  });
+
+  it('should be defined', () => {
+    expect(controller).toBeDefined();
+  });
+});

src/health/health.controller.spec.ts

@@ -0,0 +1,19 @@
+import { Controller, Get } from '@nestjs/common';
+import { HealthCheckService, HealthCheck } from '@nestjs/terminus';
+import { PrismaService } from '../prisma/prisma.service';
+
+@Controller('health')
+export class HealthController {
+    constructor(
+        private health: HealthCheckService,
+        private readonly prismaService: PrismaService
+      ) {}
+
+    @Get()
+    @HealthCheck()
+    check() {
+        return this.health.check([
+        () => this.prismaService.$queryRaw('SELECT 1'),
+        ]);
+    }
+}