feat: pass clientName to createClient function

Overrides the options.redis settings for clientName for creating a new
client

Author: tebriel

PATTERNS.md

@@ -82,14 +82,15 @@ const client = new Redis(REDIS_URL);
 const subscriber = new Redis(REDIS_URL);
 
 const opts = {
-  createClient: function (type) {
+  // redisOpts here will contain at least a property of connectionName which will identify the queue based on its name
+  createClient: function (type, redisOpts) {
     switch (type) {
       case 'client':
         return client;
       case 'subscriber':
         return subscriber;
       case 'bclient':
-        return new Redis(REDIS_URL);
+        return new Redis(REDIS_URL, redisOpts);
       default:
         throw new Error('Unexpected connection type: ', type);
     }

lib/queue.js

@@ -277,7 +277,9 @@ function redisClientGetter(queue, options, initCallback) {
       if (connections[type] != null) {
         return connections[type];
       }
-      const client = (connections[type] = createClient(type, options.redis));
+      const clientOptions = _.assign({}, options.redis);
+      clientOptions.connectionName = this.clientName();
+      const client = (connections[type] = createClient(type, clientOptions));
 
       // Since connections are lazily initialized, we can't check queue.client
       // without initializing a connection. So expose a boolean we can safely

test/test_queue.js

@@ -310,6 +310,11 @@ describe('Queue', () => {
           expect(job.id).to.be.ok;
           expect(job.data.foo).to.be.eql('bar');
         })
+        .then(
+          queueFoo.bclient.client('GETNAME').then(name => {
+            expect(name).to.be.eql(queueFoo.clientName());
+          })
+        )
         .then(() => {
           return queueQux.add({ qux: 'baz' }).then(job => {
             expect(job.id).to.be.ok;