fix: Updated shimmer.setupSubscribers to properly setup and skip subscribers that are disabled (#3275)

Author: bizob2828

lib/shimmer.js

@@ -395,7 +395,7 @@ const shimmer = (module.exports = {
             'Skipping subscriber %s because it is disabled in the config',
             subscriber.id
           )
-          return
+          continue
         }
 
         subscriber.enable()

lib/subscribers/base.js

@@ -18,7 +18,8 @@ class Subscriber {
     this.opaque = false
     this.prefix = 'orchestrion:'
     this.requireActiveTx = true
-    this.channel = tracingChannel(`${this.prefix}${this.packageName}:${this.channelName}`)
+    this.id = `${this.prefix}${this.packageName}:${this.channelName}`
+    this.channel = tracingChannel(this.id)
     this.store = agent.tracer._contextManager._asyncLocalStorage
   }
 

test/unit/shimmer.test.js

@@ -842,6 +842,51 @@ test('Shimmer with logger mock', async (t) => {
   )
 })
 
+test('Shimmer subscriber setup/teardown', async (t) => {
+  t.beforeEach((ctx) => {
+    ctx.nr = {}
+    const sandbox = sinon.createSandbox()
+    const loggerMock = require('./mocks/logger')(sandbox)
+    const shimmer = proxyquire('../../lib/shimmer', {
+      './logger': {
+        child: sandbox.stub().callsFake(() => loggerMock)
+      }
+    })
+    const agent = helper.loadMockedAgent({}, true)
+    agent.config.instrumentation.pino.enabled = false
+    agent.config.instrumentation.ioredis.enabled = true
+    ctx.nr = {
+      agent,
+      sandbox,
+      shimmer,
+      loggerMock
+    }
+  })
+
+  t.afterEach((ctx) => {
+    const { agent, sandbox, shimmer } = ctx.nr
+    sandbox.restore()
+    clearCachedModules([TEST_MODULE_RELATIVE_PATH])
+    helper.unloadAgent(agent, shimmer)
+  })
+
+  await t.test('should setup subscribers that are enabled', (t) => {
+    const { agent, shimmer } = t.nr
+    assert.ok(!shimmer._subscribers, 'should not have subscribers before setup')
+    shimmer.setupSubscribers(agent)
+    assert.ok(!shimmer._subscribers['orchestrion:pino:nr_asJson'])
+    assert.ok(shimmer._subscribers['orchestrion:ioredis:nr_sendCommand'])
+  })
+
+  await t.test('should teardown subscribers that are enabled', (t) => {
+    const { agent, shimmer } = t.nr
+    assert.ok(!shimmer._subscribers, 'should not have subscribers before setup')
+    shimmer.setupSubscribers(agent)
+    shimmer.teardownSubscribers()
+    assert.deepEqual(shimmer._subscribers, {}, 'should not have subscribers after teardown')
+  })
+})
+
 function clearCachedModules(modules) {
   modules.forEach((moduleName) => {
     try {