feat: clean up graceful-shutdown process + introduce stop and clearDBs methods in mock server

packages/api/package.json

@@ -25,6 +25,7 @@
     "express-session": "^1.17.3",
     "express-winston": "^4.2.0",
     "extract-domain": "^2.4.1",
+    "http-graceful-shutdown": "^3.1.13",
     "isemail": "^3.2.0",
     "jsonwebtoken": "^9.0.0",
     "lodash": "^4.17.21",

packages/api/src/clickhouse/__tests__/clickhouse.test.ts

@@ -3,8 +3,6 @@ import ms from 'ms';
 
 import {
   buildMetricSeries,
-  clearClickhouseTables,
-  closeDB,
   generateBuildTeamEventFn,
   getServer,
   mockLogsPropertyTypeMappingsModel,
@@ -22,12 +20,11 @@ describe('clickhouse', () => {
   });
 
   afterAll(async () => {
-    await server.closeHttpServer();
-    await closeDB();
+    await server.stop();
   });
 
   afterEach(async () => {
-    await clearClickhouseTables();
+    await server.clearDBs();
     jest.clearAllMocks();
   });
 

packages/api/src/clickhouse/__tests__/clickhouseGetMultiSeriesChart.test.ts

@@ -2,11 +2,7 @@ import _ from 'lodash';
 import ms from 'ms';
 
 import * as clickhouse from '@/clickhouse';
-import {
-  buildMetricSeries,
-  clearClickhouseTables,
-  getServer,
-} from '@/fixtures';
+import { buildMetricSeries, getServer } from '@/fixtures';
 
 describe('clickhouse - getMultiSeriesChart', () => {
   const server = getServer();
@@ -20,11 +16,11 @@ describe('clickhouse - getMultiSeriesChart', () => {
   });
 
   afterAll(async () => {
-    await server.closeHttpServer();
+    await server.stop();
   });
 
   afterEach(async () => {
-    await clearClickhouseTables();
+    await server.clearDBs();
     jest.clearAllMocks();
   });
 

packages/api/src/fixtures.ts

@@ -63,6 +63,8 @@ export const initCiEnvs = async () => {
 };
 
 class MockServer extends Server {
+  protected shouldHandleGracefulShutdown = false;
+
   getHttpServer() {
     return this.httpServer;
   }
@@ -75,17 +77,28 @@ class MockServer extends Server {
     await initCiEnvs();
   }
 
-  closeHttpServer() {
+  stop() {
     return new Promise<void>((resolve, reject) => {
       this.httpServer.close(err => {
         if (err) {
           reject(err);
           return;
         }
-        resolve();
+        super
+          .shutdown()
+          .then(() => resolve())
+          .catch(err => reject(err));
       });
     });
   }
+
+  clearDBs() {
+    return Promise.all([
+      clearDBCollections(),
+      clearClickhouseTables(),
+      clearRedis(),
+    ]);
+  }
 }
 
 class MockAPIServer extends MockServer {
@@ -113,10 +126,6 @@ export const getAgent = (server: MockServer) =>
 export const getLoggedInAgent = async (server: MockServer) => {
   const agent = getAgent(server);
 
-  await agent
-    .post('/register/password')
-    .send({ ...MOCK_USER, confirmPassword: 'wrong-password' })
-    .expect(400);
   await agent
     .post('/register/password')
     .send({ ...MOCK_USER, confirmPassword: MOCK_USER.password })
@@ -129,8 +138,6 @@ export const getLoggedInAgent = async (server: MockServer) => {
     throw Error('team or user not found');
   }
 
-  await user.save();
-
   // login app
   await agent.post('/login/password').send(MOCK_USER).expect(302);
 

packages/api/src/index.ts

@@ -1,9 +1,9 @@
 import { serializeError } from 'serialize-error';
 
-import * as config from './config';
-import Server from './server';
-import { isOperationalError } from './utils/errors';
-import logger from './utils/logger';
+import * as config from '@/config';
+import Server from '@/server';
+import { isOperationalError } from '@/utils/errors';
+import logger from '@/utils/logger';
 
 const server = new Server();
 
@@ -22,16 +22,4 @@ process.on('unhandledRejection', (err: any) => {
   logger.error(serializeError(err));
 });
 
-// graceful shutdown
-process.on('SIGTERM', () => {
-  logger.info('SIGTERM signal received.');
-
-  if (config.IS_DEV) {
-    logger.info('Http server is forced to stop immediately.');
-    process.exit(0);
-  }
-
-  server.stop();
-});
-
 server.start().catch(e => logger.error(serializeError(e)));

packages/api/src/routers/aggregator/__tests__/root.test.ts

@@ -2,13 +2,7 @@ import _ from 'lodash';
 
 import * as clickhouse from '@/clickhouse';
 import { createTeam } from '@/controllers/team';
-import {
-  clearClickhouseTables,
-  clearDBCollections,
-  closeDB,
-  getAgent,
-  getServer,
-} from '@/fixtures';
+import { getAgent, getServer } from '@/fixtures';
 import { sleep } from '@/utils/common';
 
 describe('aggregator root router', () => {
@@ -19,13 +13,11 @@ describe('aggregator root router', () => {
   });
 
   afterEach(async () => {
-    await clearDBCollections();
-    await clearClickhouseTables();
+    await server.clearDBs();
   });
 
   afterAll(async () => {
-    await server.closeHttpServer();
-    await closeDB();
+    await server.stop();
   });
 
   it('GET /health', async () => {

packages/api/src/routers/api/__tests__/alerts.test.ts

@@ -1,11 +1,4 @@
-import {
-  clearDBCollections,
-  closeDB,
-  getLoggedInAgent,
-  getServer,
-  makeAlert,
-  makeChart,
-} from '@/fixtures';
+import { getLoggedInAgent, getServer, makeAlert, makeChart } from '@/fixtures';
 
 const MOCK_DASHBOARD = {
   name: 'Test Dashboard',
@@ -21,12 +14,11 @@ describe('alerts router', () => {
   });
 
   afterEach(async () => {
-    await clearDBCollections();
+    await server.clearDBs();
   });
 
   afterAll(async () => {
-    await server.closeHttpServer();
-    await closeDB();
+    await server.stop();
   });
 
   it('has alerts attached to dashboards', async () => {

packages/api/src/routers/api/__tests__/chart.test.ts

@@ -2,10 +2,6 @@ import ms from 'ms';
 
 import * as clickhouse from '@/clickhouse';
 import {
-  clearClickhouseTables,
-  clearDBCollections,
-  clearRedis,
-  closeDB,
   generateBuildTeamEventFn,
   getLoggedInAgent,
   getServer,
@@ -20,14 +16,11 @@ describe('charts router', () => {
   });
 
   afterEach(async () => {
-    await clearDBCollections();
-    await clearClickhouseTables();
-    await clearRedis();
+    await server.clearDBs();
   });
 
   afterAll(async () => {
-    await server.closeHttpServer();
-    await closeDB();
+    await server.stop();
   });
 
   it('GET /chart/services', async () => {

packages/api/src/routers/api/__tests__/dashboard.test.ts

@@ -1,11 +1,4 @@
-import {
-  clearDBCollections,
-  closeDB,
-  getLoggedInAgent,
-  getServer,
-  makeAlert,
-  makeChart,
-} from '@/fixtures';
+import { getLoggedInAgent, getServer, makeAlert, makeChart } from '@/fixtures';
 
 const MOCK_DASHBOARD = {
   name: 'Test Dashboard',
@@ -21,12 +14,11 @@ describe('dashboard router', () => {
   });
 
   afterEach(async () => {
-    await clearDBCollections();
+    await server.clearDBs();
   });
 
   afterAll(async () => {
-    await server.closeHttpServer();
-    await closeDB();
+    await server.stop();
   });
 
   it('deletes attached alerts when deleting charts', async () => {

packages/api/src/routers/api/__tests__/metrics.test.ts

@@ -1,13 +1,5 @@
 import * as clickhouse from '@/clickhouse';
-import {
-  buildMetricSeries,
-  clearClickhouseTables,
-  clearDBCollections,
-  clearRedis,
-  closeDB,
-  getLoggedInAgent,
-  getServer,
-} from '@/fixtures';
+import { buildMetricSeries, getLoggedInAgent, getServer } from '@/fixtures';
 
 describe('metrics router', () => {
   const server = getServer();
@@ -17,14 +9,11 @@ describe('metrics router', () => {
   });
 
   afterEach(async () => {
-    await clearDBCollections();
-    await clearClickhouseTables();
-    await clearRedis();
+    await server.clearDBs();
   });
 
   afterAll(async () => {
-    await server.closeHttpServer();
-    await closeDB();
+    await server.stop();
   });
 
   it('GET /metrics/tags', async () => {

packages/api/src/routers/api/__tests__/team.test.ts

@@ -1,11 +1,6 @@
 import _ from 'lodash';
 
-import {
-  clearDBCollections,
-  closeDB,
-  getLoggedInAgent,
-  getServer,
-} from '@/fixtures';
+import { getLoggedInAgent, getServer } from '@/fixtures';
 
 describe('team router', () => {
   const server = getServer();
@@ -15,12 +10,11 @@ describe('team router', () => {
   });
 
   afterEach(async () => {
-    await clearDBCollections();
+    await server.clearDBs();
   });
 
   afterAll(async () => {
-    await server.closeHttpServer();
-    await closeDB();
+    await server.stop();
   });
 
   it('GET /team', async () => {

packages/api/src/routers/external-api/__tests__/alerts.test.ts

@@ -1,8 +1,6 @@
 import _ from 'lodash';
 
 import {
-  clearDBCollections,
-  closeDB,
   getLoggedInAgent,
   getServer,
   makeChart,
@@ -29,12 +27,11 @@ describe('/api/v1/alerts', () => {
   });
 
   afterEach(async () => {
-    await clearDBCollections();
+    await server.clearDBs();
   });
 
   afterAll(async () => {
-    await server.closeHttpServer();
-    await closeDB();
+    await server.stop();
   });
 
   it('CRUD Dashboard Alerts', async () => {

packages/api/src/routers/external-api/__tests__/charts.test.ts

@@ -3,8 +3,6 @@ import ms from 'ms';
 
 import * as clickhouse from '@/clickhouse';
 import {
-  clearDBCollections,
-  closeDB,
   generateBuildTeamEventFn,
   getLoggedInAgent,
   getServer,
@@ -19,12 +17,11 @@ describe('/api/v1/charts/series', () => {
   });
 
   afterEach(async () => {
-    await clearDBCollections();
+    await server.clearDBs();
   });
 
   afterAll(async () => {
-    await server.closeHttpServer();
-    await closeDB();
+    await server.stop();
   });
 
   const now = new Date('2022-01-05').getTime();

packages/api/src/routers/external-api/__tests__/dashboard.test.ts

@@ -1,8 +1,6 @@
 import _ from 'lodash';
 
 import {
-  clearDBCollections,
-  closeDB,
   getLoggedInAgent,
   getServer,
   makeExternalAlert,
@@ -37,12 +35,11 @@ describe('dashboard router', () => {
   });
 
   afterEach(async () => {
-    await clearDBCollections();
+    await server.clearDBs();
   });
 
   afterAll(async () => {
-    await server.closeHttpServer();
-    await closeDB();
+    await server.stop();
   });
 
   it('CRUD /dashboards', async () => {