fix(microservices): prevent error logs during redis client shutdown

Author: Jan Rocek

packages/microservices/client/client-redis.ts

@@ -54,10 +54,10 @@ export class ClientRedis extends ClientProxy<RedisEvents, RedisStatus> {
   }
 
   public async close() {
+    this.isManuallyClosed = true;
     this.pubClient && (await this.pubClient.quit());
     this.subClient && (await this.subClient.quit());
     this.pubClient = this.subClient = null;
-    this.isManuallyClosed = true;
     this.pendingEventListeners = [];
   }
 

packages/microservices/test/client/client-redis.spec.ts

@@ -190,8 +190,12 @@ describe('ClientRedis', () => {
     beforeEach(() => {
       pubClose = sinon.spy();
       subClose = sinon.spy();
-      pub = { quit: pubClose };
-      sub = { quit: subClose };
+      pub = {
+        quit: pubClose,
+      };
+      sub = {
+        quit: subClose,
+      };
       untypedClient.pubClient = pub;
       untypedClient.subClient = sub;
     });
@@ -213,6 +217,36 @@ describe('ClientRedis', () => {
       await client.close();
       expect(subClose.called).to.be.false;
     });
+    it.only('should have isManuallyClosed set to true when "end" event is handled during close', async () => {
+      let endHandler: Function | undefined;
+      sub.on = (event, handler) => {
+        if (event === 'end') endHandler = handler;
+      };
+      sub.quit = async () => {
+        if (endHandler) {
+          endHandler();
+          expect(untypedClient.isManuallyClosed).to.be.true;
+        }
+      };
+      client.registerEndListener(sub);
+      await client.close();
+    });
+
+    it.only('should not log error when "end" event is handled during close', async () => {
+      let endHandler: Function | undefined;
+      const logError = sinon.spy(untypedClient.logger, 'error');
+      sub.on = (event, handler) => {
+        if (event === 'end') endHandler = handler;
+      };
+      sub.quit = async () => {
+        if (endHandler) {
+          endHandler();
+        }
+      };
+      client.registerEndListener(sub);
+      await client.close();
+      expect(logError.called).to.be.false;
+    });
   });
   describe('connect', () => {
     let createClientSpy: sinon.SinonSpy;