feat(api): Add /health endpoint

api/package.json

@@ -24,6 +24,7 @@
     "@nestjs/jwt": "10.2.0",
     "@nestjs/passport": "10.0.3",
     "@nestjs/platform-express": "^10.0.0",
+    "@nestjs/terminus": "10.2.3",
     "@nestjs/typeorm": "^10.0.2",
     "@ts-rest/nest": "3.45.2",
     "bcrypt": "5.1.1",

api/src/app.controller.ts

@@ -3,19 +3,33 @@ import { AppService } from '@api/app.service';
 import { tsRestHandler, TsRestHandler } from '@ts-rest/nest';
 import { contactContract as c } from '@shared/contracts/contact.contract';
 import { Public } from '@api/decorators/is-public.decorator';
+import { ControllerResponse } from '@api/types/controller.type';
+import {
+  HealthCheck,
+  HealthCheckService,
+  TypeOrmHealthIndicator,
+} from '@nestjs/terminus';
 
 @Controller()
 export class AppController {
-  constructor(private readonly appService: AppService) {}
+  constructor(
+    private readonly health: HealthCheckService,
+    private readonly db: TypeOrmHealthIndicator,
+    private readonly appService: AppService,
+  ) {}
 
   @Public()
-  @Get()
-  getHello(): string {
-    return this.appService.getHello();
+  @Get('/health')
+  @HealthCheck({ noCache: true })
+  public checkHealth(): ControllerResponse {
+    return this.health.check([
+      async () => this.db.pingCheck('database', { timeout: 1500 }),
+    ]);
   }
+
   @Public()
   @TsRestHandler(c.contact)
-  async recoverPassword(): Promise<any> {
+  async recoverPassword(): Promise<ControllerResponse> {
     return tsRestHandler(c.contact, async ({ body }) => {
       await this.appService.contact(body);
       return { body: null, status: HttpStatus.CREATED };

api/src/app.module.ts

@@ -17,9 +17,13 @@ import { WidgetsModule } from '@api/modules/widgets/widgets.module';
 import { DataSourceManager } from '@api/infrastructure/data-source-manager';
 import { LoggingModule } from '@api/modules/logging/logging.module';
 import { SQLAdapter } from '@api/infrastructure/sql-adapter';
+import { TerminusModule } from '@nestjs/terminus';
+
+const NODE_ENV = process.env.NODE_ENV;
 
 @Module({
   imports: [
+    TerminusModule.forRoot({ logger: NODE_ENV === 'test' ? false : true }),
     TsRestModule.register({
       isGlobal: true,
       validateRequestBody: true,

api/src/app.service.ts

@@ -4,9 +4,6 @@ import { ContactForm, ContactMailer } from '@api/contact.mailer';
 @Injectable()
 export class AppService {
   constructor(private readonly contactMailer: ContactMailer) {}
-  getHello(): string {
-    return 'Hello World!';
-  }
 
   async contact(contactForm: ContactForm): Promise<void> {
     await this.contactMailer.sendContactMail(contactForm);

api/test/e2e/health/health.spec.ts

@@ -0,0 +1,46 @@
+import { TestManager } from 'api/test/utils/test-manager';
+
+describe('Health', () => {
+  let testManager: TestManager<unknown>;
+
+  beforeAll(async () => {
+    testManager = await TestManager.createTestManager({ logger: false });
+  });
+
+  beforeEach(async () => {
+    await testManager.clearDatabase();
+  });
+
+  afterAll(async () => {
+    await testManager.close();
+  });
+
+  it("Should return the app's health status: OK", async () => {
+    // Given
+    // The app is running
+
+    // When
+    const { statusCode, body } = await testManager.request().get('/health');
+
+    // Then
+    expect(statusCode).toBe(200);
+    expect(body).toStrictEqual({
+      status: 'ok',
+      info: { database: { status: 'up' } },
+      error: {},
+      details: { database: { status: 'up' } },
+    });
+  });
+
+  it("Should return the app's health status: Unavailable", async () => {
+    // Given
+    // The app is running and the database becomes unavailable
+    await testManager.dataSource.destroy();
+
+    // When
+    const { statusCode } = await testManager.request().get('/health');
+
+    // Then
+    expect(statusCode).toBe(503);
+  });
+});