@mojaloop/database-lib 11.0.5 → 11.1.0

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 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.0](https://github.com/mojaloop/database-lib/compare/v11.0.6...v11.1.0) (2024-12-20)
+
+
+### Features
+
+* add maxPendingAcquire handling and related methods ([#165](https://github.com/mojaloop/database-lib/issues/165)) ([62f80a9](https://github.com/mojaloop/database-lib/commit/62f80a99b922a86d7a8b711c9d58f2ac89ac7d12))
+
+### [11.0.6](https://github.com/mojaloop/database-lib/compare/v11.0.5...v11.0.6) (2024-06-26)
+
 ### [11.0.5](https://github.com/mojaloop/database-lib/compare/v11.0.4...v11.0.5) (2024-04-11)
 
 ### [11.0.4](https://github.com/mojaloop/database-lib/compare/v11.0.3...v11.0.4) (2024-04-09)

package/audit-ci.jsonc

@@ -10,6 +10,7 @@
     "GHSA-xvch-5gv4-984h",
     "GHSA-p8p7-x288-28g6",
     "GHSA-72xf-g2v4-qvf3",
-    "GHSA-w5p7-h5w8-2hfq"
+    "GHSA-w5p7-h5w8-2hfq",
+    "GHSA-3xgq-45jj-v275" // pre-commit uses an old version of cross-spawn
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/database-lib",
-  "version": "11.0.5",
+  "version": "11.1.0",
   "description": "Shared database code for central services",
   "main": "src/index.js",
   "license": "Apache-2.0",
@@ -41,25 +41,43 @@
     "release": "standard-version --releaseCommitMessageFormat 'chore(release): {{currentTag}} [skip ci]'"
   },
   "dependencies": {
+    "@mojaloop/central-services-error-handling": "13.0.2",
     "knex": "3.1.0",
     "lodash": "4.17.21",
     "mysql": "2.18.1"
   },
   "overrides": {
-    "tar": "6.2.1"
+    "tar": "6.2.1",
+    "@mojaloop/ml-schema-transformer-lib": {
+      "@mojaloop/central-services-shared": {
+        "shins": {
+          "ajv": "6.12.3",
+          "ejs": "3.1.10",
+          "sanitize-html": "2.12.1",
+          "yargs-parser": "18.1.1",
+          "markdown-it": "12.3.2"
+        },
+        "widdershins": {
+          "swagger2openapi": "7.0.8",
+          "yargs-parser": "13.1.2",
+          "markdown-it": "12.3.2"
+        }
+      }
+    }
   },
   "devDependencies": {
-    "audit-ci": "^6.6.1",
-    "npm-check-updates": "16.14.18",
-    "nyc": "15.1.0",
+    "@mojaloop/sdk-standard-components": ">=19.x.x",
+    "audit-ci": "^7.1.0",
+    "npm-check-updates": "17.1.11",
+    "nyc": "17.1.0",
     "pre-commit": "1.2.2",
     "proxyquire": "2.1.3",
-    "sinon": "17.0.1",
-    "standard": "17.1.0",
+    "sinon": "19.0.2",
+    "standard": "17.1.2",
     "standard-version": "9.5.0",
     "tap-spec": "^5.0.0",
     "tap-xunit": "2.4.1",
-    "tape": "5.7.5",
+    "tape": "5.9.0",
     "tapes": "4.1.0"
   },
   "publishConfig": {

package/src/database.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const Knex = require('knex')
+const ErrorHandler = require('@mojaloop/central-services-error-handling')
 const Table = require('./table')
 const Utils = require('./utils.js')
 
@@ -73,6 +74,7 @@ class Database {
     }
 
     this._schema = config.connection.database
+    this._maxPendingAcquire = config.maxPendingAcquire
     this._knex = await configureKnex(config)
     this._tables = await this._listTables()
     await this._setTableProperties()
@@ -117,9 +119,25 @@ class Database {
     }
     return this._listTableQueries[dbType](this._knex)
   }
+
+  assertPendingAcquires () {
+    if (this._maxPendingAcquire && this._maxPendingAcquire < this._knex.client.pool.numPendingAcquires()) {
+      throw ErrorHandler.CreateFSPIOPError(
+        ErrorHandler.Enums.FSPIOPErrorCodes.SERVICE_CURRENTLY_UNAVAILABLE,
+        `DB Pool pending acquires ${this._knex.client.pool.numPendingAcquires()} > ${this._maxPendingAcquire}`
+      )
+    }
+  }
+
+  getPendingAcquires () {
+    if (!this._knex) {
+      throw new Error('The database must be connected to get the number of pending acquires')
+    }
+    return this._knex.client.pool.numPendingAcquires()
+  }
 }
 
-const configureKnex = async (config) => {
+const configureKnex = async ({ maxPendingAcquire, ...config }) => {
   return Knex(config)
 }
 

package/test/unit/database.test.js

@@ -54,7 +54,7 @@ Test('database', databaseTest => {
 
     knexConnStub = sandbox.stub()
     knexConnStub.destroy = sandbox.stub()
-    knexConnStub.client = { config: { client: 'mysql' } }
+    knexConnStub.client = { config: { client: 'mysql' }, pool: { numPendingAcquires () {} } }
     knexConnStub.withArgs('information_schema.tables').returns({ where: sandbox.stub().withArgs('TABLE_SCHEMA', 'databaseSchema').returns({ select: sandbox.stub().withArgs('TABLE_NAME').returns(Promise.resolve(tableNames)) }) })
     knexConnStub.withArgs('pg_catalog.pg_tables').returns({ where: sandbox.stub().withArgs({ schemaname: 'public' }).returns({ select: sandbox.stub().withArgs('tablename').returns(Promise.resolve(tableNames)) }) })
 
@@ -313,5 +313,74 @@ Test('database', databaseTest => {
     fromTest.end()
   })
 
+  databaseTest.test('assertPendingAcquires should', assertPendingAcquiresTest => {
+    assertPendingAcquiresTest.test('throw error if pending acquires exceed maxPendingAcquire', async test => {
+      // Arrange
+      const maxPendingAcquire = 5
+      const config = { ...connectionConfig, maxPendingAcquire }
+      await dbInstance.connect(config)
+      sandbox.stub(dbInstance._knex.client.pool, 'numPendingAcquires').returns(6)
+
+      // Act & Assert
+      try {
+        dbInstance.assertPendingAcquires()
+        test.fail('Should have thrown error')
+      } catch (err) {
+        test.equal(err.httpStatusCode, 503, 'Max pending acquires exceeded http status code 503')
+        test.equal(err.message, `DB Pool pending acquires 6 > ${maxPendingAcquire}`)
+      }
+
+      test.end()
+    })
+
+    assertPendingAcquiresTest.test('not throw error if pending acquires are within limit', async test => {
+      // Arrange
+      const maxPendingAcquire = 5
+      const config = { ...connectionConfig, maxPendingAcquire }
+      await dbInstance.connect(config)
+      sandbox.stub(dbInstance._knex.client.pool, 'numPendingAcquires').returns(4)
+
+      // Act & Assert
+      try {
+        dbInstance.assertPendingAcquires()
+        test.pass('No error thrown')
+      } catch (err) {
+        test.fail('Should not have thrown error')
+      }
+
+      test.end()
+    })
+
+    assertPendingAcquiresTest.end()
+  })
+
+  databaseTest.test('getPendingAcquires should', getPendingAcquiresTest => {
+    getPendingAcquiresTest.test('return the number of pending acquires', async test => {
+      // Arrange
+      const pendingAcquires = 3
+      await dbInstance.connect(connectionConfig)
+      sandbox.stub(dbInstance._knex.client.pool, 'numPendingAcquires').returns(pendingAcquires)
+
+      // Act
+      const result = dbInstance.getPendingAcquires()
+
+      // Assert
+      test.equal(result, pendingAcquires)
+      test.end()
+    })
+
+    getPendingAcquiresTest.test('throw error if database is not connected', test => {
+      try {
+        dbInstance.getPendingAcquires()
+        test.fail('Should have thrown error')
+      } catch (err) {
+        test.equal(err.message, 'The database must be connected to get the number of pending acquires')
+        test.end()
+      }
+    })
+
+    getPendingAcquiresTest.end()
+  })
+
   databaseTest.end()
 })