[ci-visibility] Add gatherPayloadsMaxTimeout, a faster version of gatherPayloads (#2957)

Author: juan-fernandez

integration-tests/ci-visibility-intake.js

@@ -169,6 +169,39 @@ class FakeCiVisIntake extends FakeAgent {
     infoResponse = DEFAULT_INFO_RESPONSE
   }
 
+  // Similar to gatherPayloads but resolves if enough payloads have been gathered
+  // to make the assertions pass. It times out after maxGatheringTime so it should
+  // always be faster or as fast as gatherPayloads
+  gatherPayloadsMaxTimeout (payloadMatch, onPayload, maxGatheringTime = 15000) {
+    const payloads = []
+    return new Promise((resolve, reject) => {
+      const timeoutId = setTimeout(() => {
+        try {
+          onPayload(payloads)
+          resolve()
+        } catch (e) {
+          reject(e)
+        } finally {
+          this.off('message', messageHandler)
+        }
+      }, maxGatheringTime)
+      const messageHandler = (message) => {
+        if (!payloadMatch || payloadMatch(message)) {
+          payloads.push(message)
+          try {
+            onPayload(payloads)
+            clearTimeout(timeoutId)
+            this.off('message', messageHandler)
+            resolve()
+          } catch (e) {
+            // we'll try again when a new payload arrives
+          }
+        }
+      }
+      this.on('message', messageHandler)
+    })
+  }
+
   gatherPayloads (payloadMatch, gatheringTime = 15000) {
     const payloads = []
     return new Promise((resolve, reject) => {

integration-tests/cypress/cypress.spec.js

@@ -61,7 +61,7 @@ versions.forEach((version) => {
             ? getCiVisAgentlessConfig(receiver.port) : getCiVisEvpProxyConfig(receiver.port)
           const reportUrl = reportMethod === 'agentless' ? '/api/v2/citestcycle' : '/evp_proxy/v2/api/v2/citestcycle'
 
-          receiver.gatherPayloads(({ url }) => url === reportUrl, 25000).then((payloads) => {
+          receiver.gatherPayloadsMaxTimeout(({ url }) => url === reportUrl, payloads => {
             const events = payloads.flatMap(({ payload }) => payload.events)
 
             const testSessionEvent = events.find(event => event.type === 'test_session_end')
@@ -141,9 +141,7 @@ versions.forEach((version) => {
               assert.equal(testModuleId.toString(10), testModuleEventContent.test_module_id.toString(10))
               assert.equal(testSessionId.toString(10), testSessionEventContent.test_session_id.toString(10))
             })
-
-            done()
-          }).catch(done)
+          }, 25000).then(() => done()).catch(done)
 
           const {
             NODE_OPTIONS, // NODE_OPTIONS dd-trace config does not work with cypress
@@ -160,7 +158,7 @@ versions.forEach((version) => {
                 ...restEnvVars,
                 CYPRESS_BASE_URL: `http://localhost:${webAppPort}`
               },
-              stdio: 'on'
+              stdio: 'pipe'
             }
           )
         })

integration-tests/playwright/playwright.spec.js

@@ -58,7 +58,7 @@ versions.forEach((version) => {
             ? getCiVisAgentlessConfig(receiver.port) : getCiVisEvpProxyConfig(receiver.port)
           const reportUrl = reportMethod === 'agentless' ? '/api/v2/citestcycle' : '/evp_proxy/v2/api/v2/citestcycle'
 
-          receiver.gatherPayloads(({ url }) => url === reportUrl).then((payloads) => {
+          receiver.gatherPayloadsMaxTimeout(({ url }) => url === reportUrl, payloads => {
             const events = payloads.flatMap(({ payload }) => payload.events)
 
             const testSessionEvent = events.find(event => event.type === 'test_session_end')
@@ -99,9 +99,7 @@ versions.forEach((version) => {
               assert.equal(stepEvent.content.name, 'playwright.step')
               assert.property(stepEvent.content.meta, 'playwright.step')
             })
-
-            done()
-          }).catch(done)
+          }).then(() => done()).catch(done)
 
           childProcess = exec(
             './node_modules/.bin/playwright test -c playwright.config.js',
@@ -119,7 +117,8 @@ versions.forEach((version) => {
     })
     it('works when tests are compiled to a different location', (done) => {
       let testOutput = ''
-      receiver.gatherPayloads(({ url }) => url === '/api/v2/citestcycle').then((payloads) => {
+
+      receiver.gatherPayloadsMaxTimeout(({ url }) => url === '/api/v2/citestcycle', payloads => {
         const events = payloads.flatMap(({ payload }) => payload.events)
         const testEvents = events.filter(event => event.type === 'test')
         assert.includeMembers(testEvents.map(test => test.content.resource), [
@@ -129,8 +128,7 @@ versions.forEach((version) => {
         assert.include(testOutput, '1 passed')
         assert.include(testOutput, '1 skipped')
         assert.notInclude(testOutput, 'TypeError')
-        done()
-      }).catch(done)
+      }).then(() => done()).catch(done)
 
       childProcess = exec(
         'node ./node_modules/typescript/bin/tsc' +