@mojaloop/central-services-shared 18.34.1 → 18.34.2

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.
 
+### [18.34.2](https://github.com/mojaloop/central-services-shared/compare/v18.34.1...v18.34.2) (2025-10-10)
+
+
+### Bug Fixes
+
+* **csi-1259:** update getAllProxiesNames to return only isActive proxies ([#488](https://github.com/mojaloop/central-services-shared/issues/488)) ([5d05786](https://github.com/mojaloop/central-services-shared/commit/5d05786a18740a90f851d4d80c8835fdde260a32))
+
 ### [18.34.1](https://github.com/mojaloop/central-services-shared/compare/v18.34.0...v18.34.1) (2025-10-06)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/central-services-shared",
-  "version": "18.34.1",
+  "version": "18.34.2",
   "description": "Shared code for mojaloop central services",
   "license": "Apache-2.0",
   "author": "ModusBox",
@@ -97,9 +97,9 @@
     "@mojaloop/central-services-error-handling": "13.1.3",
     "@mojaloop/central-services-logger": "11.10.1",
     "@mojaloop/central-services-metrics": "12.8.0",
-    "@mojaloop/event-sdk": "14.8.0",
+    "@mojaloop/event-sdk": "14.8.1",
     "@mojaloop/sdk-standard-components": "19.18.0",
-    "@opentelemetry/auto-instrumentations-node": "^0.64.6",
+    "@opentelemetry/auto-instrumentations-node": "^0.65.0",
     "@types/hapi__joi": "17.1.15",
     "ajv": "^8.17.1",
     "ajv-formats": "^3.0.1",

package/src/index.d.ts

@@ -647,7 +647,7 @@ declare namespace CentralServicesShared {
 
   type ProxyNames = string[]
   interface Proxies extends Cacheable {
-    getAllProxiesNames(switchUrl: string): Promise<ProxyNames>
+    getAllProxiesNames(switchUrl: string, onlyActive?: boolean): Promise<ProxyNames>
     invalidateProxiesCache(): Promise<void>
   }
 

package/src/util/proxies.js

@@ -111,14 +111,13 @@ exports.initializeCache = async (policyOptions, config) => {
 }
 
 /**
-* @function getAllProxiesNames
-* @description It returns a list of allProxies names from the cache if the cache is still valid, otherwise it will refresh the cache and return the value
+* Returns a list of allProxies names from the cache if the cache is still valid, otherwise it will refresh the cache and return the value
 *
 * @param {string} switchUrl the endpoint for the switch
-*
+* @param {boolean} [onlyActive] if true, returns only active proxies (isActive === 1), defaults to false
 * @returns {string[]} - Returns list of allProxies names, throws error if failure occurs
 */
-exports.getAllProxiesNames = async (switchUrl) => {
+exports.getAllProxiesNames = async (switchUrl, onlyActive = false) => {
   const histTimer = Metrics.getHistogram(
     'getAllProxiesNames',
     'getAllProxiesNames - Metrics for getAllProxies with cache hit rate',
@@ -148,6 +147,9 @@ exports.getAllProxiesNames = async (switchUrl) => {
       await policy.drop(cacheKey)
       throw ErrorHandler.Factory.createFSPIOPErrorFromErrorInformation(proxies.errorInformation)
     }
+    if (onlyActive) {
+      proxies = proxies.filter(p => p.isActive === 1)
+    }
     return proxies.map(p => p.name)
   } catch (err) {
     histTimer({ success: false, hit: false })

package/test/unit/util/proxies.test.js

@@ -0,0 +1,134 @@
+/*****
+ License
+ --------------
+ Copyright © 2020-2025 Mojaloop Foundation
+ The Mojaloop files are made available by the Mojaloop Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+
+ Contributors
+ --------------
+ This is the official list of the Mojaloop project contributors for this file.
+ Names of the original copyright holders (individuals or organizations)
+ should be listed with a '*' in the first column. People who have
+ contributed from an organization can be listed under the organization
+ that actually holds the copyright for their contributions (see the
+ Mojaloop Foundation for an example). Those individuals should have
+ their names indented and be marked with a '-'. Email address can be added
+ optionally within square brackets <email>.
+
+ * Mojaloop Foundation
+ * Eugen Klymniuk <eugen.klymniuk@infitx.com>
+
+ --------------
+ ******/
+
+'use strict'
+
+const Test = require('tapes')(require('tape'))
+const Sinon = require('sinon')
+
+const proxies = require('#src/util/proxies')
+const request = require('#src/util/request')
+const Http = require('#src/util/index').Http
+const Config = require('#test/util/config')
+const Helper = require('#test/util/helper')
+
+Test('Proxies Participants Test', proxiesTest => {
+  let sandbox
+  const hubName = 'Hub'
+  const hubNameRegex = /^Hub$/i
+
+  const mockProxiesResponse = {
+    data: [
+      { name: 'proxy1', isActive: 1 },
+      { name: 'proxy2', isActive: 0 },
+      { name: 'proxy3', isActive: 1 },
+      { name: 'proxy4', isActive: 0 }
+    ]
+  }
+
+  proxiesTest.beforeEach(async test => {
+    sandbox = Sinon.createSandbox()
+    sandbox.stub(request, 'sendRequest')
+    sandbox.stub(Http, 'SwitchDefaultHeaders').returns(Helper.defaultHeaders())
+    test.end()
+  })
+
+  proxiesTest.afterEach(async test => {
+    sandbox.restore()
+    test.end()
+  })
+
+  proxiesTest.test('getAllProxiesNames method Tests', async (getAllProxiesNamesTest) => {
+    getAllProxiesNamesTest.test('should return all proxy names when onlyActive is false', async (test) => {
+      await proxies.initializeCache(Config.ENDPOINT_CACHE_CONFIG, { hubName, hubNameRegex })
+      request.sendRequest.returns(Promise.resolve(mockProxiesResponse))
+
+      try {
+        const result = await proxies.getAllProxiesNames(Config.ENDPOINT_SOURCE_URL, false)
+        test.equal(result.length, 4, 'Should return all 4 proxies')
+        test.deepEqual(result, ['proxy1', 'proxy2', 'proxy3', 'proxy4'], 'Should return all proxy names')
+        await proxies.stopCache()
+        test.end()
+      } catch (err) {
+        test.fail('Error thrown', err)
+        test.end()
+      }
+    })
+
+    getAllProxiesNamesTest.test('should return all proxy names when onlyActive is not provided (default)', async (test) => {
+      await proxies.initializeCache(Config.ENDPOINT_CACHE_CONFIG, { hubName, hubNameRegex })
+      request.sendRequest.returns(Promise.resolve(mockProxiesResponse))
+
+      try {
+        const result = await proxies.getAllProxiesNames(Config.ENDPOINT_SOURCE_URL)
+        test.equal(result.length, 4, 'Should return all 4 proxies')
+        test.deepEqual(result, ['proxy1', 'proxy2', 'proxy3', 'proxy4'], 'Should return all proxy names')
+        await proxies.stopCache()
+        test.end()
+      } catch (err) {
+        test.fail('Error thrown', err)
+        test.end()
+      }
+    })
+
+    getAllProxiesNamesTest.test('should return only active proxy names when onlyActive is true', async (test) => {
+      await proxies.initializeCache(Config.ENDPOINT_CACHE_CONFIG, { hubName, hubNameRegex })
+      request.sendRequest.returns(Promise.resolve(mockProxiesResponse))
+
+      try {
+        const result = await proxies.getAllProxiesNames(Config.ENDPOINT_SOURCE_URL, true)
+        test.equal(result.length, 2, 'Should return only 2 active proxies')
+        test.deepEqual(result, ['proxy1', 'proxy3'], 'Should return only active proxy names')
+        await proxies.stopCache()
+        test.end()
+      } catch (err) {
+        test.fail('Error thrown', err)
+        test.end()
+      }
+    })
+
+    await getAllProxiesNamesTest.end()
+  })
+
+  proxiesTest.test('initializeCache method Tests', async (initCacheTest) => {
+    initCacheTest.test('should initialize cache and return true', async (test) => {
+      try {
+        const result = await proxies.initializeCache(Config.ENDPOINT_CACHE_CONFIG, { hubName, hubNameRegex })
+        test.equal(result, true, 'The results match')
+        await proxies.stopCache()
+        test.end()
+      } catch (err) {
+        test.fail('Error thrown', err)
+        test.end()
+      }
+    })
+
+    await initCacheTest.end()
+  })
+
+  proxiesTest.end()
+})