ws plugins will be disabled when config is set to false (#7247)

* ws plugins will be disabled when config is set to false

Author: crysmags

packages/datadog-plugin-ws/src/close.js

@@ -20,11 +20,9 @@ class WSClosePlugin extends TracingPlugin {
 
   bindStart (ctx) {
     const {
-      traceWebsocketMessagesEnabled,
       traceWebsocketMessagesInheritSampling,
       traceWebsocketMessagesSeparateTraces
     } = this.config
-    if (!traceWebsocketMessagesEnabled) return
 
     const { code, data, socket, isPeerClose } = ctx
     if (!socket?.spanContext) return

packages/datadog-plugin-ws/src/index.js

@@ -19,6 +19,10 @@ class WSPlugin extends CompositePlugin {
   }
 
   configure (config) {
+    if (!config.traceWebsocketMessagesEnabled) {
+      super.configure(false)
+      return
+    }
     return super.configure(config)
   }
 }

packages/datadog-plugin-ws/src/producer.js

@@ -19,9 +19,6 @@ class WSProducerPlugin extends TracingPlugin {
   static get kind () { return 'producer' }
 
   bindStart (ctx) {
-    const messagesEnabled = this.config.traceWebsocketMessagesEnabled
-    if (!messagesEnabled) return
-
     const { byteLength, socket, binary } = ctx
     if (!socket.spanContext) return
 

packages/datadog-plugin-ws/src/receiver.js

@@ -20,11 +20,9 @@ class WSReceiverPlugin extends TracingPlugin {
 
   bindStart (ctx) {
     const {
-      traceWebsocketMessagesEnabled,
       traceWebsocketMessagesInheritSampling,
       traceWebsocketMessagesSeparateTraces
     } = this.config
-    if (!traceWebsocketMessagesEnabled) return
 
     const { byteLength, socket, binary } = ctx
     if (!socket.spanContext) return

packages/datadog-plugin-ws/src/server.js

@@ -44,7 +44,6 @@ class WSServerPlugin extends TracingPlugin {
         'http.url': uri,
         'resource.name': `${options.method} ${route}`,
         'span.kind': 'server'
-
       }
 
     }, ctx)

packages/datadog-plugin-ws/test/index.spec.js

@@ -294,34 +294,14 @@ describe('Plugin', () => {
           agent.close({ ritmReset: false, wipe: true })
         })
 
-        it('should not produce message spans when traceWebsocketMessagesEnabled is not set to true', () => {
-          wsServer.on('connection', (ws) => {
-            ws.send('test message')
-          })
-          messageReceived = false
-
-          client.on('message', (data) => {
-            assert.strictEqual(data.toString(), 'test message')
-            messageReceived = true
-          })
-
-          return agent.assertSomeTraces(traces => {
-            assert.strictEqual(traces[0][0].service, 'custom-ws-service')
-            assert.strictEqual(traces[0][0].name, 'web.request')
-            assert.strictEqual(traces[0][0].type, 'websocket')
-          })
-        })
-
-        it('should not produce close event spans when traceWebsocketMessagesEnabled is not set to true', () => {
-          wsServer.on('connection', (ws) => {
-            ws.close()
-          })
-
-          return agent.assertSomeTraces(traces => {
-            assert.strictEqual(traces[0][0].service, 'custom-ws-service')
-            assert.strictEqual(traces[0][0].name, 'web.request')
-            assert.strictEqual(traces[0][0].type, 'websocket')
-          })
+        it('should not initialize sub-plugins when traceWebsocketMessagesEnabled is false', () => {
+          const tracer = require('../../dd-trace')
+          const wsPlugin = tracer._pluginManager._pluginsByName.ws
+
+          assert.strictEqual(wsPlugin.server._enabled, false)
+          assert.strictEqual(wsPlugin.producer._enabled, false)
+          assert.strictEqual(wsPlugin.receiver._enabled, false)
+          assert.strictEqual(wsPlugin.close._enabled, false)
         })
       })
       describe('with WebSocket configurations settings', () => {