feat(healthz): add app version to response body

Author: borjapazr

src/application/health/health-status.response.ts

@@ -1,10 +1,13 @@
 import { HealthStatus } from '@domain/health/health-status';
+import { AppInfo } from '@presentation/config/app.config';
 
 class HealthStatusResponse {
   readonly status: string;
 
   readonly message: string;
 
+  readonly appVersion = AppInfo.APP_VERSION;
+
   constructor(status: string, message: string) {
     this.status = status;
     this.message = message;

src/presentation/app.ts

@@ -122,6 +122,7 @@ class App {
        Version: ${AppInfo.APP_VERSION}
        Port: ${this.port}
        Base Path: ${this.basePath}
+       OpenApi Spec Path: ${this.basePath}/spec
        Environment: ${this.env}
        Author: ${AppInfo.AUTHOR_NAME}
        Email: ${AppInfo.AUTHOR_EMAIL}

src/presentation/controllers/health/health.oas.yml

@@ -36,6 +36,14 @@ components:
           type: string
           description: Description of server status
           example: '🚀 To infinity and beyond!'
+        timestamp:
+          type: string
+          description: Timestamp of server status
+          example: '2020-01-01T00:00:00Z'
+        appVersion:
+          type: string
+          description: Application version
+          example: '1.0.0'
     ErrorResponse:
       type: object
       properties:
@@ -51,3 +59,11 @@ components:
           type: string
           description: Error description
           example: 'Unexpected internal server error'
+        timestamp:
+          type: string
+          description: Timestamp of server status
+          example: '2020-01-01T00:00:00Z'
+        appVersion:
+          type: string
+          description: Application version
+          example: '1.0.0'

src/presentation/errors/error.response.ts

@@ -1,10 +1,14 @@
+import { AppInfo } from '@presentation/config/app.config';
+
 class ErrorResponse {
   public status: number;
 
   public code: string;
 
   public message: string;
 
+  readonly appVersion = AppInfo.APP_VERSION;
+
   constructor(status: number, code: string, message: string) {
     this.status = status;
     this.code = code;

test/integration/healthcheck/health-checker.int.ts

@@ -1,11 +1,11 @@
 import { HealthCheckerUseCase } from '@application/health/health-checker.usecase';
-import { HealthStatus } from '@domain/health/health-status';
+import { HealthStatusResponse } from '@application/health/health-status.response';
 
 describe('Testing health check use case', () => {
   it('should return ALIVE health status', () => {
     const healthCheckerUseCase = new HealthCheckerUseCase();
     return expect(healthCheckerUseCase.execute()).resolves.toEqual(
-      new HealthStatus('ALIVE', '🚀 To infinity and beyond!')
+      new HealthStatusResponse('ALIVE', '🚀 To infinity and beyond!')
     );
   });
 });