adding health checks for database and website

Author: pSharpX

package-lock.json

@@ -24,6 +24,7 @@
     "@nestjs/microservices": "^8.1.2",
     "@nestjs/passport": "^8.0.1",
     "@nestjs/platform-express": "^8.1.2",
+    "@nestjs/terminus": "^8.0.1",
     "@nestjs/typeorm": "^8.0.2",
     "axios": "^0.24.0",
     "class-transformer": "^0.4.0",

package.json

@@ -29,6 +29,8 @@ import { CorsMiddleware } from './middlewares/cors/cors.middleware';
 import { ConfigModule, ConfigService } from '@nestjs/config';
 import { CatalogModule } from './catalog/catalog.module';
 import { AuthModule } from './auth/auth.module';
+import { TerminusModule } from '@nestjs/terminus';
+import { HealthController } from './management/health/health.controller';
 import databaseConfiguration from './config/database/database.configuration';
 import thirdpartyConfiguration from './config/thirdparty/thirdparty.configuration';
 
@@ -49,6 +51,7 @@ import thirdpartyConfiguration from './config/thirdparty/thirdparty.configuratio
     }),
     CatalogModule,
     AuthModule,
+    TerminusModule,
   ],
   controllers: [
     AppController,
@@ -58,6 +61,7 @@ import thirdpartyConfiguration from './config/thirdparty/thirdparty.configuratio
     ItemController,
     CategoryController,
     AuthController,
+    HealthController,
   ],
   providers: [
     AppService,

src/app.module.ts

@@ -5,19 +5,16 @@ import { useContainer } from 'class-validator';
 
 async function bootstrap() {
   const app = await NestFactory.create(AppModule);
-  // useContainer(app, {fallbackOnErrors: true});
+
   useContainer(app.select(AppModule), { fallbackOnErrors: true });
   app.enableCors({
     origin: 'http://localhost:3000',
   });
   app.useGlobalPipes(
     new ValidationPipe({
       transform: true,
-      // whitelist: true,
-      // forbidNonWhitelisted: false,
-      // disableErrorMessages: true,
     }),
   );
-  await app.listen(3001);
+  await app.listen(3000);
 }
 bootstrap();

src/main.ts

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

src/management/health/health.controller.spec.ts

@@ -0,0 +1,30 @@
+import { Controller, Get } from '@nestjs/common';
+import {
+  HealthCheck,
+  HealthCheckService,
+  HttpHealthIndicator,
+  TypeOrmHealthIndicator,
+} from '@nestjs/terminus';
+
+@Controller('health')
+export class HealthController {
+  constructor(
+    private health: HealthCheckService,
+    private http: HttpHealthIndicator,
+    private db: TypeOrmHealthIndicator,
+  ) {}
+
+  @Get('nestjs')
+  @HealthCheck()
+  checkServiceStatus() {
+    return this.health.check([
+      () => this.http.pingCheck('nestjs-docs', 'https://docs.nestjs.com'),
+    ]);
+  }
+
+  @Get('database')
+  @HealthCheck()
+  checkDatabaseStatus() {
+    return this.health.check([() => this.db.pingCheck('myapp')]);
+  }
+}

src/management/health/health.controller.ts

@@ -143,4 +143,4 @@ export class ItemService implements IItemService {
       );
     });
   }
-}
+}