[test-optimization] [SDTEST-1784] Co-relate Playwright tests with RUM sessions (#5509)

Author: Mariovido

integration-tests/ci-visibility/playwright-tests-rum/active-test-span-rum-test.js

@@ -0,0 +1,13 @@
+const { test, expect } = require('@playwright/test')
+
+test.beforeEach(async ({ page }) => {
+  await page.goto(process.env.PW_BASE_URL)
+})
+
+test.describe('playwright', () => {
+  test('should have RUM active', async ({ page }) => {
+    await expect(page.locator('.hello-world')).toHaveText([
+      'Hello World'
+    ])
+  })
+})

integration-tests/ci-visibility/web-app-server.js

@@ -11,6 +11,9 @@ module.exports = http.createServer((req, res) => {
       <title>Hello World</title>
       <script>
         window.DD_RUM = {
+          getInternalContext: () => {
+            return true
+          },
           stopSession: () => {
             return true
           }

integration-tests/playwright/playwright.spec.js

@@ -40,7 +40,9 @@ const {
   TEST_MANAGEMENT_IS_ATTEMPT_TO_FIX,
   TEST_HAS_FAILED_ALL_RETRIES,
   TEST_NAME,
-  TEST_MANAGEMENT_ATTEMPT_TO_FIX_PASSED
+  TEST_MANAGEMENT_ATTEMPT_TO_FIX_PASSED,
+  TEST_IS_RUM_ACTIVE,
+  TEST_BROWSER_VERSION
 } = require('../../packages/dd-trace/src/plugins/util/test')
 const { DD_HOST_CPU_COUNT } = require('../../packages/dd-trace/src/plugins/util/env')
 const { ERROR_MESSAGE } = require('../../packages/dd-trace/src/constants')
@@ -1417,6 +1419,39 @@ versions.forEach((version) => {
           })
         })
       })
+
+      context('correlation between tests and RUM sessions', () => {
+        it('can correlate tests and RUM sessions', (done) => {
+          const receiverPromise = receiver
+            .gatherPayloadsMaxTimeout(({ url }) => url === '/api/v2/citestcycle', (payloads) => {
+              const events = payloads.flatMap(({ payload }) => payload.events)
+              const playwrightTest = events.find(event => event.type === 'test').content
+              assert.include(playwrightTest.meta, {
+                [TEST_BROWSER_NAME]: 'chromium',
+                [TEST_TYPE]: 'browser',
+                [TEST_IS_RUM_ACTIVE]: 'true'
+              })
+              assert.property(playwrightTest.meta, TEST_BROWSER_VERSION)
+            })
+
+          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'
+              },
+              stdio: 'pipe'
+            }
+          )
+
+          childProcess.on('exit', () => {
+            receiverPromise.then(() => done()).catch(done)
+          })
+        })
+      })
     }
   })
 })

packages/datadog-instrumentations/src/helpers/hooks.js

@@ -111,6 +111,7 @@ module.exports = {
   pino: () => require('../pino'),
   'pino-pretty': () => require('../pino'),
   playwright: () => require('../playwright'),
+  'playwright-core': () => require('../playwright'),
   'promise-js': () => require('../promise-js'),
   promise: () => require('../promise'),
   protobufjs: () => require('../protobufjs'),

packages/datadog-instrumentations/src/playwright.js

@@ -23,6 +23,7 @@ const testSuiteStartCh = channel('ci:playwright:test-suite:start')
 const testSuiteFinishCh = channel('ci:playwright:test-suite:finish')
 
 const workerReportCh = channel('ci:playwright:worker:report')
+const testPageGotoCh = channel('ci:playwright:test:page-goto')
 
 const testToAr = new WeakMap()
 const testSuiteToAr = new Map()
@@ -783,6 +784,37 @@ addHook({
   return processHostPackage
 })
 
+addHook({
+  name: 'playwright-core',
+  file: 'lib/client/page.js',
+  versions: ['>=1.38.0']
+}, (pagePackage) => {
+  shimmer.wrap(pagePackage.Page.prototype, 'goto', goto => async function (url, options) {
+    const response = await goto.apply(this, arguments)
+
+    const page = this
+
+    const isRumActive = await page.evaluate(() => {
+      if (window.DD_RUM && window.DD_RUM.getInternalContext) {
+        return !!window.DD_RUM.getInternalContext()
+      } else {
+        return false
+      }
+    })
+
+    if (isRumActive) {
+      testPageGotoCh.publish({
+        isRumActive,
+        page
+      })
+    }
+
+    return response
+  })
+
+  return pagePackage
+})
+
 // Only in worker
 addHook({
   name: 'playwright',
@@ -822,6 +854,55 @@ addHook({
         browserName
       })
 
+      let existAfterEachHook = false
+
+      // We try to find an existing afterEach hook with _ddHook to avoid adding a new one
+      for (const hook of test.parent._hooks) {
+        if (hook.type === 'afterEach' && hook._ddHook) {
+          existAfterEachHook = true
+          break
+        }
+      }
+
+      // In cases where there is no afterEach hook with _ddHook, we need to add one
+      if (!existAfterEachHook) {
+        test.parent._hooks.push({
+          type: 'afterEach',
+          fn: async function ({ page }) {
+            try {
+              if (page) {
+                const isRumActive = await page.evaluate(() => {
+                  if (window.DD_RUM && window.DD_RUM.stopSession) {
+                    window.DD_RUM.stopSession()
+                    return true
+                  } else {
+                    return false
+                  }
+                })
+
+                if (isRumActive) {
+                  const url = page.url()
+                  if (url) {
+                    const domain = new URL(url).hostname
+                    await page.context().addCookies([{
+                      name: 'datadog-ci-visibility-test-execution-id',
+                      value: '',
+                      domain,
+                      expires: 0,
+                      path: '/'
+                    }])
+                  }
+                }
+              }
+            } catch (e) {
+              // ignore errors
+            }
+          },
+          title: 'afterEach hook',
+          _ddHook: true
+        })
+      }
+
       res = _runTest.apply(this, arguments)
 
       testInfo = this._currentTest

packages/datadog-plugin-playwright/src/index.js

@@ -31,7 +31,9 @@ const {
   TEST_MODULE,
   TEST_SUITE,
   TEST_SUITE_ID,
-  TEST_NAME
+  TEST_NAME,
+  TEST_IS_RUM_ACTIVE,
+  TEST_BROWSER_VERSION
 } = require('../../dd-trace/src/plugins/util/test')
 const { RESOURCE_NAME } = require('../../../ext/tags')
 const { COMPONENT } = require('../../dd-trace/src/constants')
@@ -147,6 +149,36 @@ class PlaywrightPlugin extends CiPlugin {
       this.telemetry.ciVisEvent(TELEMETRY_EVENT_FINISHED, 'suite')
     })
 
+    this.addSub('ci:playwright:test:page-goto', ({
+      isRumActive,
+      page
+    }) => {
+      const store = storage('legacy').getStore()
+      const span = store && store.span
+      if (!span) return
+
+      if (isRumActive) {
+        span.setTag(TEST_IS_RUM_ACTIVE, 'true')
+
+        if (page) {
+          const browserVersion = page.context().browser().version()
+
+          if (browserVersion) {
+            span.setTag(TEST_BROWSER_VERSION, browserVersion)
+          }
+
+          const url = page.url()
+          const domain = new URL(url).hostname
+          page.context().addCookies([{
+            name: 'datadog-ci-visibility-test-execution-id',
+            value: span.context().toTraceId(),
+            domain,
+            path: '/'
+          }])
+        }
+      }
+    })
+
     this.addSub('ci:playwright:test:start', ({
       testName,
       testSuiteAbsolutePath,
@@ -240,6 +272,8 @@ class PlaywrightPlugin extends CiPlugin {
       const span = store && store.span
       if (!span) return
 
+      const isRUMActive = span.context()._tags[TEST_IS_RUM_ACTIVE]
+
       span.setTag(TEST_STATUS, testStatus)
 
       if (error) {
@@ -307,6 +341,7 @@ class PlaywrightPlugin extends CiPlugin {
         {
           hasCodeOwners: !!span.context()._tags[TEST_CODE_OWNERS],
           isNew,
+          isRum: isRUMActive,
           browserDriver: 'playwright'
         }
       )