add is_first logic

Author: IlyasShabi

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

@@ -72,11 +72,12 @@ describe('Endpoints collection', () => {
 
       const expectedEndpoints = getExpectedEndpoints(framework)
       const endpointsFound = []
+      const isFirstFlags = []
 
       await agent.assertTelemetryReceived(msg => {
         const { payload } = msg
         if (payload.request_type === 'app-endpoints') {
-          expect(payload.payload.is_first).to.be.true
+          isFirstFlags.push(Boolean(payload.payload.is_first))
 
           if (payload.payload.endpoints) {
             payload.payload.endpoints.forEach(endpoint => {
@@ -92,6 +93,9 @@ describe('Endpoints collection', () => {
         }
       }, 'app-endpoints', 5_000, 2)
 
+      const trueCount = isFirstFlags.filter(v => v === true).length
+      expect(trueCount).to.equal(1)
+
       // Check that all expected endpoints were found
       expectedEndpoints.forEach(expected => {
         const found = endpointsFound.find(e =>

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

@@ -31,15 +31,15 @@ app.route({
 app.all('/wildcard', async (_, reply) => reply.send('ok'))
 
 // Nested routes with Router
-app.register(async function (fastify) {
-  fastify.put('/nested/:id', async (_, reply) => reply.send('ok'))
+app.register(async function (router) {
+  router.put('/nested/:id', async (_, reply) => reply.send('ok'))
 }, { prefix: '/v1' })
 
 // Deeply nested routes
-app.register(async function (fastify) {
-  fastify.register(async function (subFastify) {
-    subFastify.get('/deep', async (_, reply) => reply.send('ok'))
-    subFastify.post('/deep/:id', async (_, reply) => reply.send('ok'))
+app.register(async function (router) {
+  router.register(async function (subRouter) {
+    subRouter.get('/deep', async (_, reply) => reply.send('ok'))
+    subRouter.post('/deep/:id', async (_, reply) => reply.send('ok'))
   }, { prefix: '/sub' })
 }, { prefix: '/api' })
 

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

@@ -17,6 +17,7 @@ let updateRetryData
  */
 const pendingEndpoints = new Map()
 let flushScheduled = false
+let isFirstPayload = true
 
 function endpointKey (method, path) {
   return `${method} ${path}`
@@ -81,7 +82,7 @@ function flushAndSend () {
   }
 
   const payloadObj = {
-    is_first: true,
+    is_first: isFirstPayload,
     endpoints: buildEndpointObjects(batchEndpoints)
   }
 
@@ -99,6 +100,10 @@ function flushAndSend () {
 
   sendData(config, application, host, reqType, payload, updateRetryData)
 
+  if (isFirstPayload) {
+    isFirstPayload = false
+  }
+
   // If more endpoints accumulated while sending, schedule another flush.
   if (pendingEndpoints.size) scheduleFlush()
 }

packages/dd-trace/test/config.spec.js

@@ -1448,6 +1448,7 @@ describe('Config', () => {
       appsec: {
         apiSecurity: {
           enabled: true,
+          endpointCollectionEnabled: false,
           endpointCollectionMessageLimit: 150
         },
         blockedTemplateGraphql: BLOCKED_TEMPLATE_GRAPHQL_PATH,
@@ -1555,7 +1556,7 @@ describe('Config', () => {
 
     expect(config).to.have.nested.property('apmTracingEnabled', true)
     expect(config).to.have.nested.property('appsec.apiSecurity.enabled', true)
-    expect(config).to.have.nested.property('appsec.apiSecurity.endpointCollectionEnabled', true)
+    expect(config).to.have.nested.property('appsec.apiSecurity.endpointCollectionEnabled', false)
     expect(config).to.have.nested.property('appsec.apiSecurity.endpointCollectionMessageLimit', 150)
     expect(config).to.have.nested.property('appsec.blockedTemplateGraphql', BLOCKED_TEMPLATE_GRAPHQL)
     expect(config).to.have.nested.property('appsec.blockedTemplateHtml', BLOCKED_TEMPLATE_HTML)
@@ -1720,9 +1721,7 @@ describe('Config', () => {
     expect(config).to.have.deep.property('appsec', {
       apiSecurity: {
         enabled: true,
-        sampleDelay: 30,
-        endpointCollectionEnabled: true,
-        endpointCollectionMessageLimit: 300
+        sampleDelay: 30
       },
       blockedTemplateGraphql: undefined,
       blockedTemplateHtml: undefined,

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

@@ -86,6 +86,20 @@ describe('endpoints telemetry', () => {
       expect(resources).to.include('POST /api')
     })
 
+    it('should set is_first=true only for the first payload', () => {
+      fastifyRouteCh.publish({ routeOptions: { method: 'GET', path: '/one' } })
+      fastifyRouteCh.publish({ routeOptions: { method: 'POST', path: '/two' } })
+
+      scheduledCallbacks.forEach(cb => cb())
+
+      expect(sendData.callCount).to.equal(2)
+      const firstPayload = sendData.firstCall.args[4]
+      const secondPayload = sendData.secondCall.args[4]
+
+      expect(firstPayload).to.have.property('is_first', true)
+      expect(Boolean(secondPayload.is_first)).to.equal(false)
+    })
+
     it('should record fastify wildcard when all methods provided', () => {
       fastifyRouteCh.publish({
         routeOptions: {