fix: Ws resource now uses the request route (#6587)

Author: crysmags

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

@@ -21,8 +21,10 @@ class WSServerPlugin extends TracingPlugin {
 
     const protocol = `${getRequestProtocol(req)}:`
     const host = options.headers.host
-    const path = req.url
-    const uri = `${protocol}//${host}${path}`
+    const url = req.url
+    const indexOfParam = url.indexOf('?')
+    const route = indexOfParam === -1 ? url : url.slice(0, indexOfParam)
+    const uri = `${protocol}//${host}${route}`
 
     ctx.args = { options }
 
@@ -34,7 +36,7 @@ class WSServerPlugin extends TracingPlugin {
         'http.upgraded': 'websocket',
         'http.method': options.method,
         'http.url': uri,
-        'resource.name': `${options.method} ${path}`,
+        'resource.name': `${options.method} ${route}`,
         'span.kind': 'server'
 
       }

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

@@ -11,10 +11,12 @@ describe('Plugin', () => {
   let clientPort = 6015
   let client
   let messageReceived
+  let route
 
   describe('ws', () => {
     withVersions('ws', 'ws', '>=8.0.0', version => {
       describe('when using WebSocket', () => {
+        route = 'test'
         beforeEach(async () => {
           await agent.load(['ws'], [{
             service: 'some',
@@ -24,7 +26,7 @@ describe('Plugin', () => {
 
           wsServer = new WebSocket.Server({ port: clientPort })
 
-          client = new WebSocket(`ws://localhost:${clientPort}`)
+          client = new WebSocket(`ws://localhost:${clientPort}/${route}?active=true`)
         })
 
         afterEach(async () => {
@@ -99,6 +101,7 @@ describe('Plugin', () => {
           })
           agent.assertSomeTraces(traces => {
             expect(traces[0][0]).to.have.property('name', 'websocket.receive')
+            expect(traces[0][0]).to.have.property('resource', `websocket /${route}`)
           })
             .then(done)
             .catch(done)
@@ -132,7 +135,7 @@ describe('Plugin', () => {
 
           wsServer = new WebSocket.Server({ port: clientPort })
 
-          client = new WebSocket(`ws://localhost:${clientPort}`)
+          client = new WebSocket(`ws://localhost:${clientPort}/${route}?active=true`)
         })
 
         afterEach(async () => {
@@ -156,17 +159,16 @@ describe('Plugin', () => {
           wsServer.on('connection', (ws) => {
             ws.send('test message')
           })
-          messageReceived = false
 
           client.on('message', (data) => {
             expect(data.toString()).to.equal('test message')
-            messageReceived = true
           })
 
           return agent.assertSomeTraces(traces => {
-            expect(traces[0][0]).to.have.property('service', 'custom-ws-service')
+            expect(traces[0][0]).to.have.property('resource', `websocket /${route}`)
             expect(traces[0][0]).to.have.property('name', 'websocket.send')
             expect(traces[0][0]).to.have.property('type', 'websocket')
+            expect(traces[0][0]).to.have.property('service', 'custom-ws-service')
           })
         })
 
@@ -177,7 +179,7 @@ describe('Plugin', () => {
           })
           wsServer.on('message', (data) => {
             expect(data.toString()).to.equal('test message')
-            expect(messageReceived).prototype.equal(true)
+            expect(messageReceived).to.equal(true)
           })
 
           client.on('message', (data) => {