[test-optimization] [SDTEST-1871] Add tests for Playwright when redirecting (#5607)

Mariovido · watson · commit d4dee159d669 · 2025-04-29T19:06:13.000+02:00
diff --git a/integration-tests/ci-visibility/web-app-server-with-redirect.js b/integration-tests/ci-visibility/web-app-server-with-redirect.js
@@ -0,0 +1,11 @@
+// File to spin an HTTP server that returns an HTML for playwright to visit
+const http = require('http')
+
+module.exports = http.createServer((req, res) => {
+  res.setHeader('Content-Type', 'text/html')
+  res.writeHead(200)
+  res.end(`
+    <!DOCTYPE html>
+    <meta http-equiv="refresh" content="0; url=https://playwright.dev/" />
+  `)
+})
diff --git a/integration-tests/playwright/playwright.spec.js b/integration-tests/playwright/playwright.spec.js
@@ -12,6 +12,7 @@ const {
 } = require('../helpers')
 const { FakeCiVisIntake } = require('../ci-visibility-intake')
 const webAppServer = require('../ci-visibility/web-app-server')
+const webAppServerWithRedirect = require('../ci-visibility/web-app-server-with-redirect')
 const {
   TEST_STATUS,
   TEST_SOURCE_START,
@@ -54,7 +55,7 @@ const versions = ['1.18.0', 'latest']
 
 versions.forEach((version) => {
   describe(`playwright@${version}`, () => {
-    let sandbox, cwd, receiver, childProcess, webAppPort
+    let sandbox, cwd, receiver, childProcess, webAppPort, webPortWithRedirect
 
     before(async function () {
       // bump from 60 to 90 seconds because playwright is heavy
@@ -67,11 +68,14 @@ versions.forEach((version) => {
       execSync('npx playwright install chromium', { cwd, env: restOfEnv, stdio: 'inherit' })
       webAppPort = await getPort()
       webAppServer.listen(webAppPort)
+      webPortWithRedirect = await getPort()
+      webAppServerWithRedirect.listen(webPortWithRedirect)
     })
 
     after(async () => {
       await sandbox.remove()
       await new Promise(resolve => webAppServer.close(resolve))
+      await new Promise(resolve => webAppServerWithRedirect.close(resolve))
     })
 
     beforeEach(async function () {
@@ -1429,35 +1433,52 @@ versions.forEach((version) => {
       })
 
       context('correlation between tests and RUM sessions', () => {
-        it('can correlate tests and RUM sessions', (done) => {
-          const receiverPromise = receiver
+        const getTestAssertions = ({ isRedirecting }) =>
+          receiver
             .gatherPayloadsMaxTimeout(({ url }) => url === '/api/v2/citestcycle', (payloads) => {
               const events = payloads.flatMap(({ payload }) => payload.events)
               const playwrightTest = events.find(event => event.type === 'test').content
+              if (isRedirecting) {
+                assert.notProperty(playwrightTest.meta, TEST_IS_RUM_ACTIVE)
+                assert.notProperty(playwrightTest.meta, TEST_BROWSER_VERSION)
+              } else {
+                assert.property(playwrightTest.meta, TEST_IS_RUM_ACTIVE, 'true')
+                assert.property(playwrightTest.meta, TEST_BROWSER_VERSION)
+              }
               assert.include(playwrightTest.meta, {
                 [TEST_BROWSER_NAME]: 'chromium',
-                [TEST_TYPE]: 'browser',
-                [TEST_IS_RUM_ACTIVE]: 'true'
+                [TEST_TYPE]: 'browser'
               })
-              assert.property(playwrightTest.meta, TEST_BROWSER_VERSION)
             })
 
+        const runTest = (done, { isRedirecting }, extraEnvVars) => {
+          const testAssertionsPromise = getTestAssertions({ isRedirecting })
+
           childProcess = exec(
             './node_modules/.bin/playwright test -c playwright.config.js active-test-span-rum-test.js',
             {
               cwd,
               env: {
                 ...getCiVisAgentlessConfig(receiver.port),
-                PW_BASE_URL: `http://localhost:${webAppPort}`,
-                TEST_DIR: './ci-visibility/playwright-tests-rum'
+                PW_BASE_URL: `http://localhost:${isRedirecting ? webPortWithRedirect : webAppPort}`,
+                TEST_DIR: './ci-visibility/playwright-tests-rum',
+                ...extraEnvVars
               },
               stdio: 'pipe'
             }
           )
 
           childProcess.on('exit', () => {
-            receiverPromise.then(() => done()).catch(done)
+            testAssertionsPromise.then(() => done()).catch(done)
           })
+        }
+
+        it('can correlate tests and RUM sessions', (done) => {
+          runTest(done, { isRedirecting: false })
+        })
+
+        it('do not crash when redirecting and RUM sessions are not active', (done) => {
+          runTest(done, { isRedirecting: true })
         })
       })
     }
