[test optimization] Fix test optimization tests in v5 release line (#5844)

Author: juan-fernandez

ci/cypress/plugin.js

@@ -1,3 +1,11 @@
+const { NODE_MAJOR } = require('../../version')
+
+// These polyfills are here because cypress@6.7.0, which we still support for v5, runs its plugin code
+// with Node.js@12.
+if (NODE_MAJOR < 18) {
+  require('./polyfills')
+}
+
 require('../init')
 
 module.exports = require('../../packages/datadog-plugin-cypress/src/plugin')

ci/cypress/polyfills.js

@@ -0,0 +1,23 @@
+if (!Object.hasOwn) {
+  Object.defineProperty(Object, 'hasOwn', {
+    // eslint-disable-next-line prefer-object-has-own
+    value: (obj, prop) => Object.prototype.hasOwnProperty.call(obj, prop),
+    writable: true,
+    configurable: true,
+  })
+}
+
+if (!Array.prototype.at) {
+  // eslint-disable-next-line no-extend-native
+  Object.defineProperty(Array.prototype, 'at', {
+    value: function (n) {
+      const len = this.length
+      if (len === 0) return
+      let index = Math.trunc(n)
+      if (index < 0) index += len
+      return (index < 0 || index >= len) ? undefined : this[index]
+    },
+    writable: true,
+    configurable: true
+  })
+}

integration-tests/ci-visibility/playwright-tests/landing-page-test.js

@@ -5,22 +5,30 @@ test.beforeEach(async ({ page }) => {
   await page.goto(process.env.PW_BASE_URL)
 })
 
+// active span is only supported from >=1.38.0, at which point we add DD_PLAYWRIGHT_WORKER to the env
+function setActiveTestSpanTags (tags) {
+  if (process.env.DD_PLAYWRIGHT_WORKER) {
+    tracer.scope().active().addTags(tags)
+  }
+  return null
+}
+
 test.describe('highest-level-describe', () => {
   test.describe(' leading and trailing spaces ', () => {
     // even empty describe blocks should be allowed
     test.describe(' ', () => {
       test.beforeEach(async ({ page }) => {
-        tracer.scope().active().addTags({
+        setActiveTestSpanTags({
           'custom_tag.beforeEach': 'hello beforeEach'
         })
       })
       test.afterEach(async ({ page }) => {
-        tracer.scope().active().addTags({
+        setActiveTestSpanTags({
           'custom_tag.afterEach': 'hello afterEach'
         })
       })
       test('should work with passing tests', async ({ page }) => {
-        tracer.scope().active().addTags({
+        setActiveTestSpanTags({
           'custom_tag.it': 'hello it'
         })
         await expect(page.locator('.hello-world')).toHaveText([

integration-tests/playwright/playwright.spec.js

@@ -201,13 +201,15 @@ versions.forEach((version) => {
                 JSON.stringify({ arguments: { browser: 'chromium' }, metadata: {} })
               )
               assert.exists(testEvent.content.metrics[DD_HOST_CPU_COUNT])
-              if (testEvent.content.meta[TEST_STATUS] !== 'skip' &&
-                testEvent.content.meta[TEST_SUITE].includes('landing-page-test.js')) {
-                assert.propertyVal(testEvent.content.meta, 'custom_tag.beforeEach', 'hello beforeEach')
-                assert.propertyVal(testEvent.content.meta, 'custom_tag.afterEach', 'hello afterEach')
-              }
-              if (testEvent.content.meta[TEST_NAME].includes('should work with passing tests')) {
-                assert.propertyVal(testEvent.content.meta, 'custom_tag.it', 'hello it')
+              if (version === 'latest' || satisfies(version, '>=1.38.0')) {
+                if (testEvent.content.meta[TEST_STATUS] !== 'skip' &&
+                  testEvent.content.meta[TEST_SUITE].includes('landing-page-test.js')) {
+                  assert.propertyVal(testEvent.content.meta, 'custom_tag.beforeEach', 'hello beforeEach')
+                  assert.propertyVal(testEvent.content.meta, 'custom_tag.afterEach', 'hello afterEach')
+                }
+                if (testEvent.content.meta[TEST_NAME].includes('should work with passing tests')) {
+                  assert.propertyVal(testEvent.content.meta, 'custom_tag.it', 'hello it')
+                }
               }
             })
 

packages/datadog-plugin-cypress/test/app/cypress/plugins/index.js

@@ -1,7 +1 @@
-module.exports = (on, config) => {
-  // We can't use the tracer available in the testing process, because this code is
-  // run in a different process. We need to init a different tracer reporting to the
-  // url set by the plugin agent
-  require('../../../../../dd-trace').init({ startupLogs: false })
-  require('../../../../src/plugin')(on, config)
-}
+module.exports = require('../../../../../../ci/cypress/plugin')

packages/datadog-plugin-cypress/test/index.spec.js

@@ -34,6 +34,9 @@ describe('Plugin', function () {
       return agent.load()
     })
     beforeEach(function (done) {
+      // This test does not check test optimization agentless protocol,
+      // so we'll make the tracer default to reporting to v0.4/traces
+      agent.setAvailableEndpoints([])
       this.timeout(10000)
       agentListenPort = agent.server.address().port
       cypressExecutable = require(`../../../versions/cypress@${version}`).get()