fix(aap): Fix endpoint operation name for detected endpoints (#7217)

Author: CarlesDD

integration-tests/appsec/endpoints-collection.spec.js

@@ -169,14 +169,15 @@ describe('Endpoints collection', () => {
       assert.strictEqual(trueCount, 1)
 
       // Check that all expected endpoints were found
+      const expectedOperationName = `${framework}.request`
       expectedEndpoints.forEach(expected => {
         const found = endpointsFound.find(e =>
           e.method === expected.method && e.path === expected.path
         )
 
         assert.ok(found)
         assert.strictEqual(found.type, 'REST')
-        assert.strictEqual(found.operation_name, 'http.request')
+        assert.strictEqual(found.operation_name, expectedOperationName)
         assert.strictEqual(found.resource_name, `${expected.method} ${expected.path}`)
       })
 

packages/dd-trace/src/telemetry/endpoints.js

@@ -15,7 +15,7 @@ let updateRetryData
 
 /**
  * Keep track of endpoints that still need to be sent.
- * Map key is `${METHOD} ${PATH}`, value is { method, path }
+ * Map key is `${METHOD} ${PATH}`, value is { method, path, operationName }
  */
 const pendingEndpoints = new Map()
 const wildcardEndpoints = new Set()
@@ -32,11 +32,11 @@ function scheduleFlush () {
   setImmediate(flushAndSend).unref()
 }
 
-function recordEndpoint (method, path) {
+function recordEndpoint (method, path, operationName) {
   const key = endpointKey(method, path)
   if (pendingEndpoints.has(key)) return
 
-  pendingEndpoints.set(key, { method: method.toUpperCase(), path })
+  pendingEndpoints.set(key, { method: method.toUpperCase(), path, operationName })
   scheduleFlush()
 }
 
@@ -46,7 +46,7 @@ function onFastifyRoute (routeData) {
 
   const methods = Array.isArray(routeOptions.method) ? routeOptions.method : [routeOptions.method]
   for (const method of methods) {
-    recordEndpoint(method, routeOptions.path)
+    recordEndpoint(method, routeOptions.path, 'fastify.request')
   }
 }
 
@@ -56,7 +56,7 @@ function onExpressRoute ({ method, path }) {
   // If wildcard already recorded for this path, skip specific methods
   if (wildcardEndpoints.has(path)) return
 
-  recordEndpoint(method, path)
+  recordEndpoint(method, path, 'express.request')
 
   // If this is a wildcard event, record it and mark path as wildcarded
   if (method === '*') {
@@ -66,17 +66,17 @@ function onExpressRoute ({ method, path }) {
 
   // Express automatically adds HEAD support for GET routes
   if (method.toUpperCase() === 'GET') {
-    recordEndpoint('HEAD', path)
+    recordEndpoint('HEAD', path, 'express.request')
   }
 }
 
 function buildEndpointObjects (endpoints) {
-  return endpoints.map(({ method, path }) => {
+  return endpoints.map(({ method, path, operationName }) => {
     return {
       type: 'REST',
       method,
       path,
-      operation_name: 'http.request',
+      operation_name: operationName,
       resource_name: endpointKey(method, path)
     }
   })

packages/dd-trace/test/telemetry/endpoints.spec.js

@@ -107,21 +107,21 @@ describe('endpoints telemetry', () => {
           type: 'REST',
           method: 'GET',
           path: '/api',
-          operation_name: 'http.request',
+          operation_name: 'fastify.request',
           resource_name: 'GET /api'
         },
         {
           type: 'REST',
           method: 'POST',
           path: '/api',
-          operation_name: 'http.request',
+          operation_name: 'fastify.request',
           resource_name: 'POST /api'
         },
         {
           type: 'REST',
           method: 'PUT',
           path: '/api',
-          operation_name: 'http.request',
+          operation_name: 'fastify.request',
           resource_name: 'PUT /api'
         }
       ])
@@ -170,6 +170,42 @@ describe('endpoints telemetry', () => {
       assert.deepStrictEqual(resources, ['GET /test', 'HEAD /test'])
     })
 
+    it('should use express.request as operation_name for express routes', () => {
+      expressRouteCh.publish({ method: 'POST', path: '/express-test' })
+
+      scheduledCallbacks.forEach(cb => cb())
+
+      sinon.assert.calledOnce(sendData)
+      const payload = sendData.firstCall.args[4]
+      assertObjectContains(payload.endpoints, [
+        {
+          type: 'REST',
+          method: 'POST',
+          path: '/express-test',
+          operation_name: 'express.request',
+          resource_name: 'POST /express-test'
+        }
+      ])
+    })
+
+    it('should use express.request as operation_name for router routes', () => {
+      routerRouteCh.publish({ method: 'DELETE', path: '/router-test' })
+
+      scheduledCallbacks.forEach(cb => cb())
+
+      sinon.assert.calledOnce(sendData)
+      const payload = sendData.firstCall.args[4]
+      assertObjectContains(payload.endpoints, [
+        {
+          type: 'REST',
+          method: 'DELETE',
+          path: '/router-test',
+          operation_name: 'express.request',
+          resource_name: 'DELETE /router-test'
+        }
+      ])
+    })
+
     it('should record express wildcard and ignore subsequent specific methods for same path', () => {
       expressRouteCh.publish({ method: '*', path: '/all' })
       expressRouteCh.publish({ method: 'GET', path: '/all' })