feat(api): add check on each database on healthcheck/db route

Author: aurelie-crouillebois

api/db/database-connection.js

@@ -42,8 +42,16 @@ export class DatabaseConnection {
     configureConnectionExtension(this.knex);
   }
 
+  async checkStatus() {
+    try {
+      await this.knex.raw('SELECT 1');
+    } catch (cause) {
+      throw new Error(`Connection to database ${this.#name} not available.`, { cause });
+    }
+  }
+
   async prepare() {
-    await this.knex.raw('SELECT 1');
+    await this.checkStatus();
     logger.info(`Connection to database ${this.#name} established.`);
   }
 

api/db/database-connections.js

@@ -14,6 +14,10 @@ class DatabaseConnections {
   async disconnect() {
     return Promise.all(this.#connections.map((connection) => connection.disconnect()));
   }
+
+  async checkStatuses() {
+    return Promise.all(this.#connections.map((connection) => connection.checkStatus()));
+  }
 }
 
 export const databaseConnections = new DatabaseConnections();

api/src/shared/application/healthcheck/healthcheck-controller.js

@@ -1,6 +1,6 @@
 import Boom from '@hapi/boom';
 
-import { knex } from '../../../../db/knex-database-connection.js';
+import { databaseConnections } from '../../../../db/database-connections.js';
 import packageJSON from '../../../../package.json' with { type: 'json' };
 import * as network from '../../../identity-access-management/infrastructure/utils/network.js';
 import { config } from '../../config.js';
@@ -22,10 +22,10 @@ const get = function (request) {
 
 const checkDbStatus = async function () {
   try {
-    await knex.raw('SELECT 1 FROM knex_migrations_lock');
-    return { message: 'Connection to database ok' };
-  } catch {
-    throw Boom.serverUnavailable('Connection to database failed');
+    await databaseConnections.checkStatuses();
+    return { message: 'Connection to databases ok' };
+  } catch (error) {
+    throw Boom.serverUnavailable(`Connection to databases failed: ${error.message}`);
   }
 };
 

api/tests/shared/acceptance/application/healthcheck.route.test.js

@@ -1,3 +1,4 @@
+import { databaseConnection } from '../../../../datamart/knex-database-connection.js';
 import { createServer, expect } from '../../../test-helper.js';
 
 describe('Acceptance | Shared | Application | Route | healthcheck', function () {
@@ -24,4 +25,39 @@ describe('Acceptance | Shared | Application | Route | healthcheck', function ()
       expect(response.result).to.equal('https://app.pix.org');
     });
   });
+
+  describe('GET /api/healthcheck/db', function () {
+    it('returns an HTTP status code 200 when all databases are available', async function () {
+      // given
+      const options = {
+        method: 'GET',
+        url: '/api/healthcheck/db',
+      };
+
+      // when
+      const response = await server.inject(options);
+
+      // then
+      expect(response.statusCode).to.equal(200);
+      expect(response.result.message).to.equal('Connection to databases ok');
+    });
+
+    it('returns an HTTP status code 503 when at least one database is not available', async function () {
+      // given
+      const options = {
+        method: 'GET',
+        url: '/api/healthcheck/db',
+      };
+      await databaseConnection.disconnect();
+
+      // when
+      const response = await server.inject(options);
+
+      // then
+      expect(response.statusCode).to.equal(503);
+      expect(response.result.message).to.equal(
+        'Connection to databases failed: Connection to database datamart not available.',
+      );
+    });
+  });
 });

api/tests/shared/unit/application/healthcheck/healthcheck-controller_test.js

@@ -1,4 +1,3 @@
-import { knex } from '../../../../../db/knex-database-connection.js';
 import { healthcheckController } from '../../../../../src/shared/application/healthcheck/healthcheck-controller.js';
 import { redisMonitor } from '../../../../../src/shared/infrastructure/utils/redis-monitor.js';
 import { expect, hFake, sinon } from '../../../../test-helper.js';
@@ -22,35 +21,6 @@ describe('Unit | Controller | healthcheckController', function () {
     });
   });
 
-  describe('#checkDbStatus', function () {
-    beforeEach(function () {
-      sinon.stub(knex, 'raw');
-    });
-
-    it('should check if DB connection is successful', async function () {
-      // given
-      knex.raw.resolves();
-
-      // when
-      const response = await healthcheckController.checkDbStatus();
-
-      // then
-      expect(response).to.include.keys('message');
-      expect(response['message']).to.equal('Connection to database ok');
-    });
-
-    it('should reply with a 503 error when the connection with the database is KO', function () {
-      // given
-      knex.raw.rejects();
-
-      // when
-      const promise = healthcheckController.checkDbStatus(null, hFake);
-
-      // then
-      expect(promise).to.be.rejectedWith(/Connection to database failed/);
-    });
-  });
-
   describe('#checkRedisStatus', function () {
     beforeEach(function () {
       sinon.stub(redisMonitor, 'ping');