Add graceful shutdown

Author: Immanuel Pelzer

.gitlab-ci.yml

@@ -20,8 +20,6 @@ variables:
   RABBITMQ_DEFAULT_PASS: "guest"
   ESLINT_CODE_QUALITY_REPORT: gl-codequality.json
 
-services:
-  - r.unueng.com/cloud/rabbitmq-plugins:3.9-1
 
 setup:
   stage: build
@@ -39,12 +37,18 @@ test:
   script:
   # Wait for RabbitMQ to be running
   - while ! nc -z localhost 15692 ; do sleep 1 ; done
+  - npm run test-graceful-shutdown
   - npm run test
   - npm run test-coverage
   cache:
     policy: pull
     paths:
     - node_modules/
+  services:
+  - name: r.unueng.com/cloud/rabbitmq-plugins:3.9-1
+    alias: rabbitmq
+  - name: mongo:6.0
+    alias: mongodb
   coverage: '/Statements.*?(\d+(?:\.\d+)?)%/'
   artifacts:
     reports:

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+# [5.3.0] - 2023-04-26
+
+- Add graceful shutdown for Mongoose, Express and AMQP. Mongoose is optional
+
 # [5.2.0] - 2023-04-18
 
 - Update dependency `got` to latest version

examples/pagination/service.js

@@ -1,3 +1,4 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
 import mongoose from 'mongoose'
 
 // https://github.com/aravindnc/mongoose-paginate-v2

lib/helpers/mongo.js

@@ -0,0 +1,21 @@
+import debugFactory from 'debug'
+
+const debug = debugFactory('taube-mongo')
+
+/**
+ * Only shutdown mongoose if it is available.
+ */
+async function shutdown() {
+  try {
+    // eslint-disable-next-line import/no-extraneous-dependencies
+    const mymodule = await import('mongoose')
+    const mongoose = mymodule?.default
+    await mongoose?.disconnect()
+    debug('Mongoose - disconnected')
+  } catch (error) {
+    debug('Error during mongoose shutdown. Might occur if mongoose is not installed and is expected.')
+    debug(error)
+  }
+}
+
+export default { shutdown }

lib/http.js

@@ -4,8 +4,11 @@ import express from 'express'
 import http from 'http'
 import { createMiddleware, getSummary, getContentType } from '@promster/express'
 import { errors } from 'celebrate'
+import debugFactory from 'debug'
 import config from './config/index.js'
 
+const debug = debugFactory('taube-http')
+
 // Setup express
 const app = express()
 app.use(express.json({ limit: config.http.limit }))
@@ -84,10 +87,20 @@ function getPort() {
   return server.address().port
 }
 
+function shutdown() {
+  return new Promise((resolve) => {
+    server.close(() => {
+      debug('Taube: Express closed')
+      resolve()
+    })
+  })
+}
+
 export default {
   server,
   getPort,
   init,
   app,
   ensureErrorHandlingMiddlewareIsLast,
+  shutdown,
 }

lib/index.js

@@ -19,6 +19,7 @@ import QueueWorkerExponentialRetries from './components/queue-worker-exponential
 
 import http from './http.js'
 import amqp from './amqp.js'
+import mongoHelper from './helpers/mongo.js'
 
 // Export all components as named
 export { default as Joi } from 'joi'
@@ -40,9 +41,14 @@ export { default as http } from './http.js'
 export { default as amqp } from './amqp.js'
 
 export const shutdown = async() => {
+  await http.shutdown()
   await amqp.shutdown()
+  await mongoHelper.shutdown()
 }
 
+process.on('SIGTERM', shutdown)
+process.on('SIGINT', shutdown)
+
 // Build a default export to make migration to ESM easy
 const taube = {
   Requester,