account-lookup-service 17.11.0-snapshot.0 → 17.11.1-snapshot.0

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.
 
+## [17.11.0](https://github.com/mojaloop/account-lookup-service/compare/v17.10.3...v17.11.0) (2025-07-07)
+
+
+### Features
+
+* **csi-1604:** used ha timeout design with redlock impl ([#556](https://github.com/mojaloop/account-lookup-service/issues/556)) ([17a2477](https://github.com/mojaloop/account-lookup-service/commit/17a24779fb39b09ee535cd908f4f30ab45e57a8e))
+
 ### [17.10.3](https://github.com/mojaloop/account-lookup-service/compare/v17.10.2...v17.10.3) (2025-06-24)
 
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "account-lookup-service",
   "description": "Account Lookup Service is used to validate Party and Participant lookups.",
-  "version": "17.11.0-snapshot.0",
+  "version": "17.11.1-snapshot.0",
   "license": "Apache-2.0",
   "author": "ModusBox",
   "contributors": [
@@ -95,9 +95,9 @@
     "@mojaloop/central-services-health": "15.1.0",
     "@mojaloop/central-services-logger": "11.9.0",
     "@mojaloop/central-services-metrics": "12.6.0",
-    "@mojaloop/central-services-shared": "18.29.0-snapshot.0",
-    "@mojaloop/central-services-stream": "11.8.0",
-    "@mojaloop/database-lib": "11.2.0",
+    "@mojaloop/central-services-shared": "18.29.0",
+    "@mojaloop/central-services-stream": "^11.8.0",
+    "@mojaloop/database-lib": "11.2.1",
     "@mojaloop/event-sdk": "14.6.1",
     "@mojaloop/inter-scheme-proxy-cache-lib": "2.6.0",
     "@mojaloop/ml-schema-transformer-lib": "2.7.1",
@@ -166,7 +166,7 @@
     "axios": "1.10.0",
     "axios-retry": "^4.5.0",
     "docdash": "2.0.2",
-    "dotenv": "^17.0.1",
+    "dotenv": "^17.1.0",
     "get-port": "5.1.1",
     "ioredis-mock": "^8.9.0",
     "jest": "29.7.0",

package/src/api/health.js

@@ -27,7 +27,7 @@
 'use strict'
 
 const HealthCheck = require('@mojaloop/central-services-shared').HealthCheck.HealthCheck
-const { getSubServiceHealthDatastore, getProxyCacheHealth } = require('../lib/healthCheck/subServiceHealth')
+const { getSubServiceHealthDatastore, getProxyCacheHealth, getSubServiceHealthBroker } = require('../lib/healthCheck/subServiceHealth')
 const packageJson = require('../../package.json')
 const Config = require('../lib/config')
 
@@ -36,7 +36,8 @@ const getSubServices = (appConfig, isAdmin) => {
     return [getSubServiceHealthDatastore]
   }
 
-  const subServices = [getSubServiceHealthDatastore]
+  const subServices = [getSubServiceHealthDatastore, getSubServiceHealthBroker]
+
   if (appConfig.PROXY_CACHE_CONFIG.enabled) {
     subServices.push(getProxyCacheHealth)
   }

package/src/handlers/TimeoutHandler.js

@@ -44,17 +44,19 @@ let distLock
 const timeout = async (options) => {
   if (isRunning) return
   const { logger } = options
+  let isAcquired = false
 
   try {
     isRunning = true
-    if (!await distLock?.acquireLock()) return
+    isAcquired = await distLock?.acquireLock()
+    if (!isAcquired) return
     await TimeoutService.timeoutInterschemePartiesLookups(options)
     await TimeoutService.timeoutProxyGetPartiesLookups(options)
     logger.verbose('ALS timeout handler is done')
   } catch (err) {
     logger.error('error in timeout: ', err)
   } finally {
-    await distLock?.releaseLock()
+    if (isAcquired) await distLock.releaseLock()
     isRunning = false
   }
 }
@@ -88,7 +90,7 @@ const register = async (options) => {
 const stop = async () => {
   if (isRegistered) {
     await timeoutJob.stop()
-    // await distLock?.releaseLock()
+    await distLock?.releaseLock()
     isRegistered = false
   }
 }

package/src/handlers/monitoring/plugins/health.js

@@ -20,14 +20,14 @@
 
 const { HealthCheck } = require('@mojaloop/central-services-shared').HealthCheck
 const { defaultHealthHandler } = require('@mojaloop/central-services-health')
-const { getProxyCacheHealth } = require('../../../lib/healthCheck/subServiceHealth')
+const { getProxyCacheHealth, getSubServiceHealthBroker } = require('../../../lib/healthCheck/subServiceHealth')
 const packageJson = require('../../../../package.json')
 
 let healthCheck
 
 const createHealthCheck = ({ proxyCache }) => {
   return new HealthCheck(packageJson, [
-    () => getProxyCacheHealth(proxyCache)
+    () => getProxyCacheHealth(proxyCache), () => getSubServiceHealthBroker()
   ])
 }
 

package/src/lib/config.js

@@ -162,7 +162,6 @@ const config = {
   HANDLERS_TIMEOUT_TIMEXP: RC.HANDLERS.TIMEOUT.TIMEXP,
   HANDLERS_TIMEOUT_TIMEZONE: RC.HANDLERS.TIMEOUT.TIMEZONE,
   HANDLERS_TIMEOUT_BATCH_SIZE: RC.HANDLERS.TIMEOUT.BATCH_SIZE,
-  HANDLERS_TIMEOUT_DIST_LOCK_ENABLED: RC.HANDLERS.TIMEOUT?.DIST_LOCK?.enabled,
   ERROR_HANDLING: RC.ERROR_HANDLING,
   SWITCH_ENDPOINT: RC.SWITCH_ENDPOINT,
   INSTRUMENTATION_METRICS_DISABLED: RC.INSTRUMENTATION.METRICS.DISABLED,

package/src/lib/healthCheck/subServiceHealth.js

@@ -26,6 +26,7 @@
 const { statusEnum, serviceName } = require('@mojaloop/central-services-shared').HealthCheck.HealthCheckEnums
 const { logger } = require('../../lib')
 const MigrationLockModel = require('../../models/misc/migrationLock')
+const Producer = require('@mojaloop/central-services-stream').Util.Producer
 
 /**
  * @function getSubServiceHealthDatastore
@@ -54,6 +55,28 @@ const getSubServiceHealthDatastore = async () => {
   }
 }
 
+/**
+ * @function getSubServiceHealthBroker
+ *
+ * @description Gets the health for the Notification broker
+ * @returns Promise<object> The SubService health object for the broker
+ */
+const getSubServiceHealthBroker = async () => {
+  let status = statusEnum.OK
+  try {
+    await Producer.allConnected()
+    status = statusEnum.OK
+  } catch (err) {
+    logger.isDebugEnabled && logger.debug(`getSubServiceHealthBroker failed with error: ${err.message}.`)
+    status = statusEnum.DOWN
+  }
+
+  return {
+    name: serviceName.broker,
+    status
+  }
+}
+
 /**
  * @function getProxyCacheHealth
  *
@@ -79,5 +102,6 @@ const getProxyCacheHealth = async (proxyCache) => {
 
 module.exports = {
   getSubServiceHealthDatastore,
-  getProxyCacheHealth
+  getProxyCacheHealth,
+  getSubServiceHealthBroker
 }

package/test/unit/api/health.test.js

@@ -86,7 +86,7 @@ describe('/health', () => {
     expect(response.statusCode).toBe(200)
     const payload = JSON.parse(response.payload)
     expect(payload.status).toBe('OK')
-    expect(payload.services.length).toBe(1)
+    expect(payload.services.length).toBe(2)
     expect(payload.services[0].name).toBe('datastore')
   })
 
@@ -108,7 +108,7 @@ describe('/health', () => {
     expect(response.statusCode).toBe(503)
     const payload = JSON.parse(response.payload)
     expect(payload.status).toBe('DOWN')
-    expect(payload.services.length).toBe(1)
+    expect(payload.services.length).toBe(2)
     expect(payload.services[0].name).toBe('datastore')
   })
 
@@ -135,8 +135,8 @@ describe('/health', () => {
       // Assert
       const payload = JSON.parse(response.payload)
       expect(response.statusCode).toBe(200)
-      expect(payload.services.length).toBe(2)
-      expect(payload.services[1].name).toBe('proxyCache')
+      expect(payload.services.length).toBe(3)
+      expect(payload.services[2].name).toBe('proxyCache')
     } finally {
       serverWithProxy && await serverWithProxy.stop()
     }

package/test/unit/handlers/TimeoutHandler.test.js

@@ -84,7 +84,7 @@ describe('TimeoutHandler', () => {
       await TimeoutHandler.stop()
     })
 
-    it('should execute timout service', async () => {
+    it('should execute timeout service', async () => {
       await TimeoutHandler.register(mockOptions)
       jest.spyOn(TimeoutService, 'timeoutInterschemePartiesLookups').mockResolvedValue()
       await TimeoutHandler.timeout(mockOptions)
@@ -93,7 +93,6 @@ describe('TimeoutHandler', () => {
 
     it('should not run if isRunning is true (distLock disabled)', async () => {
       await TimeoutHandler.register(mockOptions)
-      Config.HANDLERS_TIMEOUT_DIST_LOCK_ENABLED = false
       jest.spyOn(TimeoutService, 'timeoutInterschemePartiesLookups').mockImplementation(async () => {
         await wait(1000)
       })
@@ -124,7 +123,7 @@ describe('TimeoutHandler', () => {
       await TimeoutHandler.timeout(mockOptions)
 
       expect(mockDistLock.acquire).toHaveBeenCalledTimes(1)
-      expect(mockDistLock.release).toHaveBeenCalled() // todo: think if we need .release() to have been called
+      expect(mockDistLock.release).not.toHaveBeenCalled()
       expect(TimeoutService.timeoutProxyGetPartiesLookups).not.toHaveBeenCalled()
     })
   })