@mojaloop/central-services-shared 18.33.3 → 18.33.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.
 
+### [18.33.4](https://github.com/mojaloop/central-services-shared/compare/v18.33.3...v18.33.4) (2025-09-23)
+
+
+### Bug Fixes
+
+* recreate redis clients on specific errors ([#484](https://github.com/mojaloop/central-services-shared/issues/484)) ([2b15867](https://github.com/mojaloop/central-services-shared/commit/2b158676c1aee4f47ea0bd43a5449b154dbaa073))
+
 ### [18.33.3](https://github.com/mojaloop/central-services-shared/compare/v18.33.2...v18.33.3) (2025-09-22)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/central-services-shared",
-  "version": "18.33.3",
+  "version": "18.33.4",
   "description": "Shared code for mojaloop central services",
   "license": "Apache-2.0",
   "author": "ModusBox",
@@ -95,7 +95,7 @@
   },
   "devDependencies": {
     "@mojaloop/central-services-error-handling": "13.1.2",
-    "@mojaloop/central-services-logger": "11.10.0",
+    "@mojaloop/central-services-logger": "11.10.1",
     "@mojaloop/central-services-metrics": "12.7.1",
     "@mojaloop/event-sdk": "14.7.0",
     "@mojaloop/sdk-standard-components": "19.17.0",

package/src/util/redis/pubSub.js

@@ -34,6 +34,7 @@ const isClusterConfig = (config) => { return 'cluster' in config }
 const { rethrowRedisError } = require('../rethrow')
 const { REDIS_SUCCESS, REDIS_IS_CONNECTED_STATUSES } = require('../../constants')
 const { retryCommand } = require('./shared')
+const RECREATE_RE = /Cannot read properties of undefined \(reading 'getInstance'\)|Too many Cluster redirections/
 
 class PubSub {
   /**
@@ -63,6 +64,36 @@ class PubSub {
       : new Redis(this.config)
   }
 
+  retry (client, fn, log, retryAttempts, retryDelayMs) {
+    return retryCommand(
+      async () => {
+        try {
+          return await fn()
+        } catch (err) {
+          if (RECREATE_RE.test(err.message)) {
+            if (client === 'publisher') {
+              const duplicateClient = this.publisherClient.duplicate()
+              log.warn('Recreated publisher due to error: ' + err.message)
+              this.publisherClient.quit()
+              this.publisherClient = duplicateClient
+              this.addEventListeners(duplicateClient)
+            } else if (client === 'subscriber') {
+              const duplicateClient = this.subscriberClient.duplicate()
+              log.warn('Recreated subscriber due to error: ' + err.message)
+              this.subscriberClient.quit()
+              this.subscriberClient = duplicateClient
+              this.addEventListeners(duplicateClient)
+            }
+          }
+          throw err
+        }
+      },
+      log,
+      retryAttempts,
+      retryDelayMs
+    )
+  }
+
   async connect () {
     try {
       await retryCommand(() => this.publisherClient.connect(), this.log, this.retryAttempts, this.retryDelayMs)
@@ -91,8 +122,8 @@ class PubSub {
 
   async healthCheck () {
     try {
-      const publisherStatus = await retryCommand(() => this.publisherClient.ping(), this.log, this.retryAttempts, this.retryDelayMs)
-      const subscriberStatus = await retryCommand(() => this.subscriberClient.ping(), this.log, this.retryAttempts, this.retryDelayMs)
+      const publisherStatus = await this.retry('publisher', () => this.publisherClient.ping(), this.log, this.retryAttempts, this.retryDelayMs)
+      const subscriberStatus = await this.retry('subscriber', () => this.subscriberClient.ping(), this.log, this.retryAttempts, this.retryDelayMs)
       const isHealthy = publisherStatus === 'PONG' && subscriberStatus === 'PONG'
       this.log.debug(`Redis health check: ${isHealthy ? 'Healthy' : 'Unhealthy'}`)
       return isHealthy
@@ -123,9 +154,9 @@ class PubSub {
     try {
       await this.ensureConnected(this.publisherClient)
       if (this.isCluster) {
-        await retryCommand(() => this.publisherClient.spublish(channel, JSON.stringify(message)), this.log, this.retryAttempts, this.retryDelayMs)
+        await this.retry('publisher', () => this.publisherClient.spublish(channel, JSON.stringify(message)), this.log, this.retryAttempts, this.retryDelayMs)
       } else {
-        await retryCommand(() => this.publisherClient.publish(channel, JSON.stringify(message)), this.log, this.retryAttempts, this.retryDelayMs)
+        await this.retry('publisher', () => this.publisherClient.publish(channel, JSON.stringify(message)), this.log, this.retryAttempts, this.retryDelayMs)
       }
       this.log.info(`Message published to channel: ${channel}`)
     } catch (err) {
@@ -139,7 +170,7 @@ class PubSub {
       await this.ensureConnected(this.subscriberClient)
       let listener
       if (this.isCluster) {
-        await retryCommand(() => this.subscriberClient.ssubscribe(channel), this.log, this.retryAttempts, this.retryDelayMs)
+        await this.retry('subscriber', () => this.subscriberClient.ssubscribe(channel), this.log, this.retryAttempts, this.retryDelayMs)
         listener = (subscribedChannel, message) => {
           if (subscribedChannel === channel) {
             callback(JSON.parse(message))
@@ -148,7 +179,7 @@ class PubSub {
         this.subscriberClient.on('smessage', listener)
         this._channelListeners.set(channel, { event: 'smessage', listener })
       } else {
-        await retryCommand(() => this.subscriberClient.subscribe(channel), this.log, this.retryAttempts, this.retryDelayMs)
+        await this.retry('subscriber', () => this.subscriberClient.subscribe(channel), this.log, this.retryAttempts, this.retryDelayMs)
         listener = (subscribedChannel, message) => {
           if (subscribedChannel === channel) {
             callback(JSON.parse(message))
@@ -175,9 +206,9 @@ class PubSub {
         this._channelListeners.delete(channel)
       }
       if (this.isCluster) {
-        await retryCommand(() => this.subscriberClient.sunsubscribe(channel), this.log, this.retryAttempts, this.retryDelayMs)
+        await this.retry('subscriber', () => this.subscriberClient.sunsubscribe(channel), this.log, this.retryAttempts, this.retryDelayMs)
       } else {
-        await retryCommand(() => this.subscriberClient.unsubscribe(channel), this.log, this.retryAttempts, this.retryDelayMs)
+        await this.retry('subscriber', () => this.subscriberClient.unsubscribe(channel), this.log, this.retryAttempts, this.retryDelayMs)
       }
       this.log.info(`Unsubscribed from channel: ${channel}`)
     } catch (err) {

package/test/unit/util/redis/pubSub.test.js

@@ -48,6 +48,7 @@ Test('PubSub', (t) => {
       connect: sandbox.stub().resolves(),
       quit: sandbox.stub().resolves(),
       on: sandbox.stub().returnsThis(),
+      duplicate: sandbox.stub().returnsThis(),
       status: 'ready'
     }
     subscriberClientStub = {
@@ -61,6 +62,7 @@ Test('PubSub', (t) => {
       quit: sandbox.stub().resolves(),
       removeAllListeners: sandbox.stub().resolves(),
       removeListener: sandbox.stub(),
+      duplicate: sandbox.stub().returnsThis(),
       status: 'ready'
     }
 
@@ -114,6 +116,25 @@ Test('PubSub', (t) => {
     t.end()
   })
 
+  t.test('should recreate publisher when publishing throws a specific error', async (t) => {
+    const config = {}
+    const pubSub = new PubSub(config, publisherClientStub, subscriberClientStub)
+    const channel = 'test-channel'
+    const message = { key: 'value' }
+    const error = new Error('Too many Cluster redirections')
+
+    pubSub.publisherClient.publish.rejects(error)
+
+    try {
+      await pubSub.publish(channel, message)
+      t.fail('Should have thrown an error')
+    } catch (err) {
+      t.deepEqual(err, constructSystemExtensionError(error, '["redis"]'), 'Error thrown and rethrown correctly')
+      t.ok(pubSub.publisherClient.duplicate.calledOnce, 'publisherClient duplicate called')
+    }
+    t.end()
+  })
+
   t.test('should subscribe to a channel and handle messages', async (t) => {
     const config = {}
     const pubSub = new PubSub(config, publisherClientStub, subscriberClientStub)
@@ -540,6 +561,27 @@ Test('PubSub', (t) => {
     t.end()
   })
 
+  t.test('should recreate subscriber when subscribing to a channel throws specific error', async (t) => {
+    const config = { cluster: [{ host: '127.0.0.1', port: 6379 }] }
+    const error = new Error('Cannot read properties of undefined (reading \'getInstance\')')
+    const subscriberClient = {
+      ...subscriberClientStub,
+      ssubscribe: sandbox.stub().rejects(error)
+    }
+    const pubSub = new PubSub(config, publisherClientStub, subscriberClient)
+    const channel = 'cluster-channel'
+    const callback = sinon.stub()
+
+    try {
+      await pubSub.subscribe(channel, callback)
+      t.fail('Should have thrown an error')
+    } catch (err) {
+      t.deepEqual(err, constructSystemExtensionError(error, '["redis"]'), 'Error thrown and rethrown correctly')
+      t.ok(pubSub.subscriberClient.duplicate.calledOnce, 'subscriberClient duplicate called')
+    }
+    t.end()
+  })
+
   t.test('should unsubscribe from a channel using sunsubscribe in cluster mode', async (t) => {
     const config = { cluster: [{ host: '127.0.0.1', port: 6379 }] }
     const subscriberClient = {