[test-optimization] [SDTEST-1163] Playwright active test span (#4843)

Author: juan-fernandez

ci/init.js

@@ -7,6 +7,8 @@ const isJestWorker = !!process.env.JEST_WORKER_ID
 const isCucumberWorker = !!process.env.CUCUMBER_WORKER_ID
 const isMochaWorker = !!process.env.MOCHA_WORKER_ID
 
+const isPlaywrightWorker = !!process.env.DD_PLAYWRIGHT_WORKER
+
 const packageManagers = [
   'npm',
   'yarn',
@@ -67,6 +69,12 @@ if (isMochaWorker) {
   }
 }
 
+if (isPlaywrightWorker) {
+  options.experimental = {
+    exporter: 'playwright_worker'
+  }
+}
+
 if (shouldInit) {
   tracer.init(options)
   tracer.use('fs', false)

ext/exporters.d.ts

@@ -5,7 +5,8 @@ declare const exporters: {
   AGENT_PROXY: 'agent_proxy',
   JEST_WORKER: 'jest_worker',
   CUCUMBER_WORKER: 'cucumber_worker',
-  MOCHA_WORKER: 'mocha_worker'
+  MOCHA_WORKER: 'mocha_worker',
+  PLAYWRIGHT_WORKER: 'playwright_worker'
 }
 
 export = exporters

ext/exporters.js

@@ -6,5 +6,6 @@ module.exports = {
   AGENT_PROXY: 'agent_proxy',
   JEST_WORKER: 'jest_worker',
   CUCUMBER_WORKER: 'cucumber_worker',
-  MOCHA_WORKER: 'mocha_worker'
+  MOCHA_WORKER: 'mocha_worker',
+  PLAYWRIGHT_WORKER: 'playwright_worker'
 }

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

@@ -0,0 +1,24 @@
+const { test, expect } = require('@playwright/test')
+const tracer = require('dd-trace')
+
+test.beforeEach(async ({ page }) => {
+  await page.goto(process.env.PW_BASE_URL)
+})
+
+test.describe('playwright', () => {
+  test('should be able to grab the active test span and add a custom span', async ({ page }) => {
+    const customSpan = tracer.startSpan('my custom span', {
+      childOf: tracer.scope().active()
+    })
+
+    customSpan.addTags({
+      'test.really_custom_tag': 'this is really custom'
+    })
+
+    customSpan.finish()
+
+    await expect(page.locator('.hello-world')).toHaveText([
+      'Hello World'
+    ])
+  })
+})

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

@@ -0,0 +1,20 @@
+const { test, expect } = require('@playwright/test')
+const tracer = require('dd-trace')
+
+test.beforeEach(async ({ page }) => {
+  await page.goto(process.env.PW_BASE_URL)
+})
+
+test.describe('playwright', () => {
+  test('should be able to grab the active test span', async ({ page }) => {
+    const testSpan = tracer.scope().active()
+
+    testSpan.addTags({
+      'test.custom_tag': 'this is custom'
+    })
+
+    await expect(page.locator('.hello-world')).toHaveText([
+      'Hello World'
+    ])
+  })
+})

integration-tests/playwright/playwright.spec.js

@@ -1350,5 +1350,73 @@ versions.forEach((version) => {
         })
       })
     })
+
+    if (version === 'latest') {
+      context('active test span', () => {
+        it('can grab the test span and add tags', (done) => {
+          const receiverPromise = receiver
+            .gatherPayloadsMaxTimeout(({ url }) => url === '/api/v2/citestcycle', (payloads) => {
+              const events = payloads.flatMap(({ payload }) => payload.events)
+
+              const test = events.find(event => event.type === 'test').content
+
+              assert.equal(test.meta['test.custom_tag'], 'this is custom')
+            })
+
+          childProcess = exec(
+            './node_modules/.bin/playwright test -c playwright.config.js active-test-span-tags-test.js',
+            {
+              cwd,
+              env: {
+                ...getCiVisAgentlessConfig(receiver.port),
+                PW_BASE_URL: `http://localhost:${webAppPort}`,
+                TEST_DIR: './ci-visibility/playwright-tests-active-test-span'
+              },
+              stdio: 'pipe'
+            }
+          )
+
+          childProcess.on('exit', () => {
+            receiverPromise.then(() => done()).catch(done)
+          })
+        })
+
+        it('can grab the test span and add spans', (done) => {
+          const receiverPromise = receiver
+            .gatherPayloadsMaxTimeout(({ url }) => url === '/api/v2/citestcycle', (payloads) => {
+              const events = payloads.flatMap(({ payload }) => payload.events)
+
+              const test = events.find(event => event.type === 'test').content
+              const spans = events.filter(event => event.type === 'span').map(event => event.content)
+
+              const customSpan = spans.find(span => span.name === 'my custom span')
+
+              assert.exists(customSpan)
+              assert.equal(customSpan.meta['test.really_custom_tag'], 'this is really custom')
+
+              // custom span is children of active test span
+              assert.equal(customSpan.trace_id.toString(), test.trace_id.toString())
+              assert.equal(customSpan.parent_id.toString(), test.span_id.toString())
+            })
+
+          childProcess = exec(
+            './node_modules/.bin/playwright test -c playwright.config.js active-test-span-custom-span-test.js',
+            {
+              cwd,
+              env: {
+                ...getCiVisAgentlessConfig(receiver.port),
+                PW_BASE_URL: `http://localhost:${webAppPort}`,
+                TEST_DIR: './ci-visibility/playwright-tests-active-test-span'
+              },
+              stdio: 'pipe'
+            }
+          )
+
+          childProcess.on('exit', () => {
+            receiverPromise.then(() => done()).catch(done)
+          })
+        })
+      })
+    }
   })
 })