Merge pull request #19954 from mozilla/add-service-endpoints

feat(payments-api): Add version and heartbeat endpoints to payments-api

Author: david1alvarez

apps/payments/api/src/app/app.controller.spec.ts

@@ -13,9 +13,26 @@ describe('AppController', () => {
   });
 
   describe('getData', () => {
-    it('should return "Hello API"', () => {
+    it('should return "Hello world"', () => {
       const appController = app.get<AppController>(AppController);
-      expect(appController.getData()).toEqual({ message: 'Hello API' });
+      expect(appController.getData()).toEqual({ message: 'Hello world' });
+    });
+  });
+
+  describe('service status endpoints', () => {
+    it('__heartbeat__ should return empty object', () => {
+      const appController = app.get<AppController>(AppController);
+      expect(appController.__heartbeat__()).toEqual({});
+    });
+
+    it('__lbheartbeat__ should return empty object', () => {
+      const appController = app.get<AppController>(AppController);
+      expect(appController.__lbheartbeat__()).toEqual({});
+    });
+
+    it('__version__ should return version object', () => {
+      const appController = app.get<AppController>(AppController);
+      expect(appController.__version__()).toEqual({ version: '0.0.0' });
     });
   });
 });

apps/payments/api/src/app/app.controller.ts

@@ -9,4 +9,19 @@ export class AppController {
   getData() {
     return this.appService.getData();
   }
+
+  @Get('__lbheartbeat__')
+  __lbheartbeat__() {
+    return this.appService.__lbheartbeat__();
+  }
+
+  @Get('__heartbeat__')
+  __heartbeat__() {
+    return this.appService.__heartbeat__();
+  }
+
+  @Get('__version__')
+  __version__() {
+    return this.appService.__version__();
+  }
 }

apps/payments/api/src/app/app.service.spec.ts

@@ -17,4 +17,18 @@ describe('AppService', () => {
       expect(service.getData()).toEqual({ message: 'Hello API' });
     });
   });
+
+  describe('service status endpoints', () => {
+    it('__heartbeat__ should return empty object', () => {
+      expect(service.__heartbeat__()).toEqual({});
+    });
+
+    it('__lbheartbeat__ should return empty object', () => {
+      expect(service.__lbheartbeat__()).toEqual({});
+    });
+
+    it('__version__ should return version object', () => {
+      expect(service.__version__()).toEqual({ version: '0.0.0' });
+    });
+  });
 });

apps/payments/api/src/app/app.service.ts

@@ -1,18 +1,26 @@
 import { Injectable } from '@nestjs/common';
-import { RootConfig } from '../config';
 
 @Injectable()
 export class AppService {
-  constructor(private config: RootConfig) {}
+  constructor() {}
 
-  getData(): {
-    message: string;
-    config: RootConfig;
-  } {
-    console.log('All config', this.config);
+  getData() {
     return {
-      message: 'Hello API',
-      config: this.config,
+      message: 'Hello world',
+    };
+  }
+
+  __heartbeat__() {
+    return {};
+  }
+
+  __lbheartbeat__() {
+    return {};
+  }
+
+  __version__() {
+    return {
+      version: '0.0.0',
     };
   }
 }