@mojaloop/database-lib 11.1.4-snapshot.1 → 11.1.4

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [11.1.4](https://github.com/mojaloop/database-lib/compare/v11.1.3...v11.1.4) (2025-03-13)
+
+
+### Bug Fixes
+
+* process termination handling ([#169](https://github.com/mojaloop/database-lib/issues/169)) ([d0de3e1](https://github.com/mojaloop/database-lib/commit/d0de3e1924ee36ddd5018054140d2962a2353892))
+
 ### [11.1.3](https://github.com/mojaloop/database-lib/compare/v11.1.2...v11.1.3) (2025-02-21)
 
 ### [11.1.2](https://github.com/mojaloop/database-lib/compare/v11.1.1...v11.1.2) (2025-01-27)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/database-lib",
-  "version": "11.1.4-snapshot.1",
+  "version": "11.1.4",
   "description": "Shared database code for central services",
   "main": "src/index.js",
   "license": "Apache-2.0",
@@ -44,6 +44,7 @@
   },
   "dependencies": {
     "@mojaloop/central-services-error-handling": "13.0.7",
+    "async-exit-hook": "^2.0.1",
     "knex": "3.1.0",
     "lodash": "4.17.21",
     "mysql": "2.18.1"

package/src/database.js

@@ -4,6 +4,7 @@ const Knex = require('knex')
 const ErrorHandler = require('@mojaloop/central-services-error-handling')
 const Table = require('./table')
 const Utils = require('./utils.js')
+const exitHook = require('async-exit-hook')
 
 /* Default config to fall back to when using deprecated URI connection string */
 const defaultConfig = {
@@ -29,7 +30,6 @@ class Database {
     this._knex = null
     this._tables = []
     this._schema = null
-    this._signalHandlersRegistered = false // Track if signal handlers are already registered
 
     this._listTableQueries = {
       mysql: (knex) => {
@@ -80,26 +80,17 @@ class Database {
     this._tables = await this._listTables()
     await this._setTableProperties()
 
-    // Register signal handlers only once
-    if (!this._signalHandlersRegistered) {
-      process.on('SIGINT', async () => {
-        await this._handleShutdown('SIGINT')
-      })
-      process.on('SIGTERM', async () => {
-        await this._handleShutdown('SIGTERM')
-      })
-      this._signalHandlersRegistered = true
-    }
+    exitHook(callback => {
+      this.disconnect().finally(callback)
+    })
   }
 
   async disconnect () {
     if (this._knex) {
-      console.log('Closing database connection...')
       this._removeTableProperties()
       this._tables = []
       await this._knex.destroy()
       this._knex = null
-      console.log('Database connection closed.')
     }
   }
 
@@ -149,13 +140,6 @@ class Database {
     }
     return this._knex.client.pool.numPendingAcquires()
   }
-
-  async _handleShutdown (signal) {
-    console.log(`Received ${signal}, shutting down database...`)
-    await this.disconnect()
-    console.log('Cleanup complete. Exiting process.')
-    process.exit(0)
-  }
 }
 
 const configureKnex = async ({ maxPendingAcquire, ...config }) => {

package/test/unit/database.test.js

@@ -13,6 +13,7 @@ Test('database', databaseTest => {
   let knexConnStub
   let Database
   let dbInstance
+  let exitHookStub
 
   const connectionConfig = {
     client: 'mysql',
@@ -52,6 +53,8 @@ Test('database', databaseTest => {
   databaseTest.beforeEach(t => {
     sandbox = Sinon.createSandbox()
 
+    exitHookStub = sandbox.stub()
+
     knexConnStub = sandbox.stub()
     knexConnStub.destroy = sandbox.stub()
     knexConnStub.client = { config: { client: 'mysql' }, pool: { numPendingAcquires () {} } }
@@ -62,7 +65,7 @@ Test('database', databaseTest => {
 
     tableStub = sandbox.stub()
 
-    Database = Proxyquire(`${src}/database`, { knex: knexStub, './table': tableStub })
+    Database = Proxyquire(`${src}/database`, { knex: knexStub, './table': tableStub, 'async-exit-hook': exitHookStub })
     dbInstance = new Database()
 
     t.end()
@@ -383,50 +386,34 @@ Test('database', databaseTest => {
   })
 
   databaseTest.test('connect should', connectTest => {
-    connectTest.test('register signal handlers only once', async test => {
-      const processOnStub = sandbox.stub(process, 'on')
-
-      await dbInstance.connect(connectionConfig)
-      await dbInstance.connect(connectionConfig)
-
-      test.ok(processOnStub.calledTwice)
-      test.ok(processOnStub.calledWith('SIGINT'))
-      test.ok(processOnStub.calledWith('SIGTERM'))
-      test.equal(dbInstance._signalHandlersRegistered, true)
-
-      processOnStub.restore()
-      test.end()
-    })
-
-    connectTest.test('handle SIGINT signal', async test => {
-      const processOnStub = sandbox.stub(process, 'on')
-      const handleShutdownStub = sandbox.stub(dbInstance, '_handleShutdown')
-
+    connectTest.test('register exit hook', async test => {
+      // Act
       await dbInstance.connect(connectionConfig)
-      const sigintHandler = processOnStub.firstCall.args[1]
 
-      await sigintHandler()
-
-      test.ok(handleShutdownStub.calledOnceWith('SIGINT'))
+      // Assert
+      test.ok(exitHookStub.calledOnce)
+      test.ok(exitHookStub.calledWith(Sinon.match.func))
 
-      processOnStub.restore()
-      handleShutdownStub.restore()
+      // Cleanup
       test.end()
     })
 
-    connectTest.test('handle SIGTERM signal', async test => {
-      const processOnStub = sandbox.stub(process, 'on')
-      const handleShutdownStub = sandbox.stub(dbInstance, '_handleShutdown')
-
+    connectTest.test('call disconnect on process exit', async test => {
+      // Arrange
+      // Simulate process exit by manually calling the registered function
       await dbInstance.connect(connectionConfig)
-      const sigtermHandler = processOnStub.secondCall.args[1]
+      const exitCallback = exitHookStub.firstCall.args[0] // Get the first function registered
+      const disconnectStub = sandbox.stub(dbInstance, 'disconnect').resolves()
 
-      await sigtermHandler()
+      // Act
+      exitCallback() // Simulate process exit
 
-      test.ok(handleShutdownStub.calledOnceWith('SIGTERM'))
+      // Assert
+      test.ok(exitHookStub.calledOnce)
+      test.ok(disconnectStub.calledOnce)
 
-      processOnStub.restore()
-      handleShutdownStub.restore()
+      // Cleanup
+      disconnectStub.restore()
       test.end()
     })