dd-trace 6.3.0 → 6.5.0

package/packages/datadog-plugin-aws-sdk/src/services/sns.js

@@ -2,7 +2,6 @@
 const { DsmPathwayCodec, getHeadersSize } = require('../../../dd-trace/src/datastreams')
 const log = require('../../../dd-trace/src/log')
 const BaseAwsSdkPlugin = require('../base')
-const { isEmpty } = require('../util')
 
 class Sns extends BaseAwsSdkPlugin {
   static id = 'sns'
@@ -71,6 +70,12 @@ class Sns extends BaseAwsSdkPlugin {
     }
   }
 
+  /**
+   * @param {import('../../../dd-trace/src/opentracing/span') | null} span
+   * @param {{ Message?: string, MessageAttributes?: Record<string, object> }} params
+   * @param {string | undefined} topicArn
+   * @param {boolean} injectTraceContext
+   */
   injectToMessage (span, params, topicArn, injectTraceContext) {
     if (!params.MessageAttributes) {
       params.MessageAttributes = {}
@@ -79,37 +84,32 @@ class Sns extends BaseAwsSdkPlugin {
       return
     }
 
-    const ddInfo = {}
+    let ddInfo
     // for now, we only want to inject to the first message, this may change for batches in the future
     if (injectTraceContext) {
-      this.tracer.inject(span, 'text_map', ddInfo)
-      // add ddInfo before checking DSM so we can include DD attributes in payload size
-      params.MessageAttributes._datadog = {
-        DataType: 'Binary',
-        BinaryValue: ddInfo,
-      }
+      ddInfo = this.tracer.inject(span, 'text_map')
     }
 
     if (this.config.dsmEnabled) {
-      if (!params.MessageAttributes._datadog) {
-        params.MessageAttributes._datadog = {
-          DataType: 'Binary',
-          BinaryValue: ddInfo,
-        }
+      // Add the placeholder before the checkpoint so its payload size includes DD attributes.
+      params.MessageAttributes._datadog = {
+        DataType: 'Binary',
+        BinaryValue: ddInfo ?? {},
       }
 
       const dataStreamsContext = this.setDSMCheckpoint(span, params, topicArn)
-      DsmPathwayCodec.encode(dataStreamsContext, ddInfo)
+      ddInfo = DsmPathwayCodec.encode(dataStreamsContext, ddInfo) ?? ddInfo
     }
 
-    if (isEmpty(ddInfo)) {
-      if (params.MessageAttributes._datadog) {
-        // let's avoid adding any additional information to payload if we failed to inject
-        delete params.MessageAttributes._datadog
-      }
-    } else {
+    if (ddInfo) {
       // BINARY types are automatically base64 encoded
-      params.MessageAttributes._datadog.BinaryValue = Buffer.from(JSON.stringify(ddInfo))
+      params.MessageAttributes._datadog = {
+        DataType: 'Binary',
+        BinaryValue: Buffer.from(JSON.stringify(ddInfo)),
+      }
+    } else if (params.MessageAttributes._datadog) {
+      // let's avoid adding any additional information to payload if we failed to inject
+      delete params.MessageAttributes._datadog
     }
   }
 

package/packages/datadog-plugin-aws-sdk/src/services/sqs.js

@@ -3,7 +3,7 @@
 const log = require('../../../dd-trace/src/log')
 const BaseAwsSdkPlugin = require('../base')
 const { DsmPathwayCodec, getHeadersSize } = require('../../../dd-trace/src/datastreams')
-const { extractQueueMetadata, isEmpty } = require('../util')
+const { extractQueueMetadata } = require('../util')
 
 /**
  * @typedef {{
@@ -322,6 +322,12 @@ class Sqs extends BaseAwsSdkPlugin {
     }
   }
 
+  /**
+   * @param {import('../../../dd-trace/src/opentracing/span') | null} span
+   * @param {{ MessageBody?: string, MessageAttributes?: Record<string, object> } | undefined} params
+   * @param {string} queueUrl
+   * @param {boolean} injectTraceContext
+   */
   injectToMessage (span, params, queueUrl, injectTraceContext) {
     if (!params) {
       params = {}
@@ -333,10 +339,10 @@ class Sqs extends BaseAwsSdkPlugin {
       return
     }
 
-    const ddInfo = {}
+    let ddInfo
     // For now we only inject to the first message; batches may change later.
     if (injectTraceContext) {
-      this.tracer.inject(span, 'text_map', ddInfo)
+      ddInfo = this.tracer.inject(span, 'text_map')
     }
 
     if (this.config.dsmEnabled) {
@@ -344,19 +350,19 @@ class Sqs extends BaseAwsSdkPlugin {
       // matches the on-wire payload, then update with the encoded context.
       params.MessageAttributes._datadog = {
         DataType: 'String',
-        StringValue: JSON.stringify(ddInfo),
+        StringValue: JSON.stringify(ddInfo ?? {}),
       }
       const dataStreamsContext = this.setDSMCheckpoint(span, params, queueUrl)
-      if (dataStreamsContext) {
-        DsmPathwayCodec.encode(dataStreamsContext, ddInfo)
+      ddInfo = DsmPathwayCodec.encode(dataStreamsContext, ddInfo) ?? ddInfo
+      if (ddInfo) {
         params.MessageAttributes._datadog.StringValue = JSON.stringify(ddInfo)
-      } else if (isEmpty(ddInfo)) {
+      } else {
         delete params.MessageAttributes._datadog
       }
       return
     }
 
-    if (isEmpty(ddInfo)) return
+    if (!ddInfo) return
 
     params.MessageAttributes._datadog = {
       DataType: 'String',

package/packages/datadog-plugin-aws-sdk/src/util.js

@@ -120,8 +120,8 @@ const extractQueueMetadata = queueURL => {
 
   if (parts.length < minParts) return null
 
-  const accountId = parts[parts.length - 2]
-  const queueName = parts[parts.length - 1]
+  const accountId = parts.at(-2)
+  const queueName = parts.at(-1)
   const host = hasScheme ? parts[1] : parts[0]
 
   let region = 'us-east-1' // Default region if not found in URL
@@ -143,31 +143,9 @@ const extractQueueMetadata = queueURL => {
   return { queueName, arn }
 }
 
-/**
- * Returns true when `obj` has no own enumerable properties. The
- * `for-in` loop with an early return is the only allocation-free shape
- * for this check; benchmarks pin it as 1.3-1.4x faster than
- * `Object.keys(obj).length === 0` across small / medium / large
- * objects, and this is the hot path on every AWS messaging send.
- *
- * Callers in this package only pass plain objects they construct
- * locally, so prototype-enumerable keys are not a concern here. Do not
- * reuse this helper on caller-supplied objects without revisiting that
- * assumption.
- *
- * @param {object} obj
- * @returns {boolean}
- */
-const isEmpty = obj => {
-  // eslint-disable-next-line no-unreachable-loop
-  for (const _ in obj) return false
-  return true
-}
-
 module.exports = {
   generatePointerHash,
   encodeValue,
   extractPrimaryKeys,
   extractQueueMetadata,
-  isEmpty,
 }

package/packages/datadog-plugin-cucumber/src/index.js

@@ -438,7 +438,7 @@ class CucumberPlugin extends CiPlugin {
         const isModified = isModifiedTest(
           testScenarioPath,
           scenario.location.line,
-          scenario.steps[scenario.steps.length - 1].location.line,
+          scenario.steps.at(-1).location.line,
           modifiedFiles,
           'cucumber'
         )

package/packages/datadog-plugin-cypress/src/cypress-plugin.js

@@ -2,15 +2,15 @@
 
 // Capture real timers at module load, before any test can install fake timers.
 const { performance } = require('perf_hooks')
-const { statSync } = require('node:fs')
 const { basename } = require('node:path')
 const dateNow = Date.now
 
 const { createCoverageMap } = require('../../../vendor/dist/istanbul-lib-coverage')
 const satisfies = require('../../../vendor/dist/semifies')
+const { RUM_TEST_EXECUTION_ID_COOKIE_NAME } = require('../../dd-trace/src/ci-visibility/rum')
 const {
   TEST_STATUS,
-  TEST_IS_RUM_ACTIVE,
+  setRumTestTags,
   TEST_CODE_OWNERS,
   getTestEnvironmentMetadata,
   getTestLevelsMetadataTags,
@@ -79,14 +79,19 @@ const {
   getMaxEfdRetryCount,
   getPullRequestBaseBranch,
   TEST_FINAL_STATUS,
-  TEST_FAILURE_SCREENSHOT_UPLOADED,
-  TEST_FAILURE_SCREENSHOT_UPLOAD_ERROR,
   getTestOptimizationRequestResults,
 } = require('../../dd-trace/src/plugins/util/test')
 const { isMarkedAsUnskippable } = require('../../datadog-plugin-jest/src/util')
 const { ORIGIN_KEY, COMPONENT } = require('../../dd-trace/src/constants')
 const { RESOURCE_NAME } = require('../../../ext/tags')
 const getConfig = require('../../dd-trace/src/config')
+const {
+  SCREENSHOT_UPLOAD_RESULT_ERROR,
+  SCREENSHOT_UPLOAD_RESULT_UPLOADED,
+  getScreenshotCapturedAtMs,
+  getScreenshotUploadResult,
+  setScreenshotUploadTags,
+} = require('../../dd-trace/src/ci-visibility/test-screenshot')
 const { appClosing: appClosingTelemetry } = require('../../dd-trace/src/telemetry')
 const log = require('../../dd-trace/src/log')
 
@@ -141,8 +146,6 @@ const CYPRESS_STATUS_TO_TEST_STATUS = {
 }
 
 const SCREENSHOT_ATTEMPT_RE = /\(attempt \d+\)/
-const SCREENSHOT_UPLOAD_RESULT_UPLOADED = 'uploaded'
-const SCREENSHOT_UPLOAD_RESULT_ERROR = 'error'
 
 function getScreenshotFilePath (screenshot) {
   return typeof screenshot === 'string' ? screenshot : screenshot?.path
@@ -155,31 +158,6 @@ function isFailureScreenshotByMetadata (screenshot, screenshotFilePath) {
   return screenshotFilePath.includes('(failed)')
 }
 
-/**
- * Resolves a screenshot's capture time (epoch ms) for the media upload. Cypress
- * screenshot objects carry an ISO `takenAt`; falls back to the file's mtime, then
- * to the current time. Stamped once here and reused on retry via the idempotency
- * key, so the stored object is overwritten rather than duplicated.
- *
- * @param {object|string} screenshot - Cypress screenshot object or path
- * @param {string} filePath - Resolved screenshot file path
- * @returns {number} Capture time in epoch milliseconds
- */
-function getScreenshotCapturedAtMs (screenshot, filePath) {
-  const takenAt = screenshot !== null && typeof screenshot === 'object' ? screenshot.takenAt : undefined
-  if (takenAt) {
-    const parsedMs = new Date(takenAt).getTime()
-    if (Number.isInteger(parsedMs) && parsedMs > 0) {
-      return parsedMs
-    }
-  }
-  try {
-    return Math.floor(statSync(filePath).mtimeMs)
-  } catch {
-    return dateNow()
-  }
-}
-
 function isFailureScreenshotForUpload (screenshot) {
   const screenshotFilePath = getScreenshotFilePath(screenshot)
   if (!screenshotFilePath) {
@@ -240,27 +218,6 @@ function getTestScreenshots (cypressTest, attemptIndex, specScreenshots) {
   return specScreenshots.filter(screenshot => isScreenshotForTestAttempt(screenshot, titleParts, attemptIndex))
 }
 
-function getScreenshotUploadResult (uploadResults) {
-  let hasUploaded = false
-  for (const uploadResult of uploadResults) {
-    if (uploadResult === SCREENSHOT_UPLOAD_RESULT_ERROR) {
-      return SCREENSHOT_UPLOAD_RESULT_ERROR
-    }
-    if (uploadResult === SCREENSHOT_UPLOAD_RESULT_UPLOADED) {
-      hasUploaded = true
-    }
-  }
-  return hasUploaded ? SCREENSHOT_UPLOAD_RESULT_UPLOADED : undefined
-}
-
-function setScreenshotUploadTags (testSpan, uploadResult) {
-  if (uploadResult === SCREENSHOT_UPLOAD_RESULT_ERROR) {
-    testSpan.setTag(TEST_FAILURE_SCREENSHOT_UPLOAD_ERROR, 'true')
-  } else if (uploadResult === SCREENSHOT_UPLOAD_RESULT_UPLOADED) {
-    testSpan.setTag(TEST_FAILURE_SCREENSHOT_UPLOADED, 'true')
-  }
-}
-
 function getSessionStatus (summary) {
   if (summary.totalFailed !== undefined && summary.totalFailed > 0) {
     return 'fail'
@@ -901,6 +858,12 @@ class CypressPlugin {
           if (isFlakyTestRetriesEnabled && this.isTestIsolationEnabled) {
             this.isFlakyTestRetriesEnabled = true
             this.flakyTestRetriesCount = flakyTestRetriesCount ?? 0
+            if (typeof this.cypressConfig.retries === 'number') {
+              this.cypressConfig.retries = {
+                openMode: this.cypressConfig.retries,
+                runMode: this.cypressConfig.retries,
+              }
+            }
             this.cypressConfig.retries.runMode = this.flakyTestRetriesCount
           } else {
             this.flakyTestRetriesCount = 0
@@ -1444,13 +1407,13 @@ class CypressPlugin {
     // and create a skipped test span for each of them
     for (const { title } of cypressTests) {
       const cypressTestName = title.join(' ')
-      const isTestFinished = finishedTests.find(({ testName }) => cypressTestName === testName)
+      const isTestFinished = finishedTests.some(({ testName }) => cypressTestName === testName)
 
       if (isTestFinished) {
         continue
       }
 
-      const isSkippedByItr = this.testsToSkip.find(test =>
+      const isSkippedByItr = this.testsToSkip.some(test =>
         cypressTestName === test.name && spec.relative === test.suite
       )
       const testSourceFile = spec.absolute && this.repositoryRoot
@@ -1721,6 +1684,7 @@ class CypressPlugin {
           repositoryRoot: this.repositoryRoot,
           isTestIsolationEnabled: this.isTestIsolationEnabled,
           rumFlushWaitMillis: this.rumFlushWaitMillis,
+          rumTestExecutionIdCookieName: RUM_TEST_EXECUTION_ID_COOKIE_NAME,
         }
 
         this.testSuiteSpan ||= this.getTestSuiteSpan({ testSuite, testSuiteAbsolutePath })
@@ -1835,21 +1799,19 @@ class CypressPlugin {
         }
         this.activeTestSpan.setTag(TEST_STATUS, testStatus)
 
-        // Save the test status to know if it has passed all retries
-        if (this.testStatuses[testName]) {
-          this.testStatuses[testName].push(testStatus)
+        const testIdentifier = `${testSuite}\0${testName}`
+        let testStatuses = this.testStatuses[testIdentifier]
+        if (testStatuses) {
+          testStatuses.push(testStatus)
         } else {
-          this.testStatuses[testName] = [testStatus]
+          testStatuses = this.testStatuses[testIdentifier] = [testStatus]
         }
-        const testStatuses = this.testStatuses[testName]
         const activeSpanTags = this.activeTestSpan.context().getTags()
 
         if (error) {
           this.activeTestSpan.setTag('error', error)
         }
-        if (isRUMActive) {
-          this.activeTestSpan.setTag(TEST_IS_RUM_ACTIVE, 'true')
-        }
+        setRumTestTags(this.activeTestSpan, isRUMActive)
         // Source-line resolution strategy:
         // 1. If plain JS and no source map, trust invocationDetails.line directly.
         // 2. Otherwise, try invocationDetails.stack line mapped through source map.

package/packages/datadog-plugin-cypress/src/index.js

@@ -80,7 +80,12 @@ class CypressPlugin extends Plugin {
         // Already initialized by manual plugin call — just chain user handlers.
         // Pass the plugin's afterScreenshot so chaining a user handler doesn't drop the upload
         // (the chained registration replaces the one plugin.js set, so it must include it).
-        for (const h of userAfterSpecHandlers) on('after:spec', h)
+        if (userAfterSpecHandlers.length > 0) {
+          on('after:spec', (spec, results) => userAfterSpecHandlers.reduce(
+            (chain, handler) => chain.then(() => handler(spec, results)),
+            Promise.resolve()
+          ))
+        }
         registerAfterScreenshot(datadogAfterScreenshotHandler)
         registerAfterRunWithCleanup()
         payload.registered = true

package/packages/datadog-plugin-cypress/src/support.js

@@ -1,7 +1,7 @@
 'use strict'
 
-const DD_CIVISIBILITY_TEST_EXECUTION_ID_COOKIE_NAME = 'datadog-ci-visibility-test-execution-id'
 let rumFlushWaitMillis = 500
+let rumTestExecutionIdCookieName
 
 let isEarlyFlakeDetectionEnabled = false
 let isKnownTestsEnabled = false
@@ -129,6 +129,89 @@ function runBeforeEachTask (test) {
   })
 }
 
+/**
+ * @param {string} message
+ * @param {unknown} error
+ * @returns {false}
+ */
+function logRumCorrelationCookieError (message, error) {
+  try {
+    Cypress.log({
+      name: 'dd-trace',
+      message,
+      consoleProps: () => ({ Error: error }),
+    })
+  } catch (loggingError) {
+    // eslint-disable-next-line no-console
+    console.error(message, error, loggingError)
+  }
+  return false
+}
+
+/**
+ * @param {unknown} error
+ * @returns {false}
+ */
+function handleRumCorrelationCookieError (error) {
+  return logRumCorrelationCookieError('Could not set the RUM correlation cookie', error)
+}
+
+/**
+ * @param {unknown} error
+ * @returns {false}
+ */
+function handleRumCorrelationCookieCleanupError (error) {
+  return logRumCorrelationCookieError('Could not clear the previous RUM correlation cookie', error)
+}
+
+/**
+ * @param {string} traceId
+ * @returns {Promise<boolean>}
+ */
+function setRumCorrelationCookie (traceId) {
+  if (typeof cy.now !== 'function') {
+    return Cypress.Promise.resolve(handleRumCorrelationCookieError(new Error('Cypress cy.now is not available')))
+  }
+
+  let clearCookiePromise = Cypress.Promise.resolve()
+  if (!isTestIsolationEnabled) {
+    clearCookiePromise = Cypress.Promise.try(() => {
+      return cy.now('clearCookie', rumTestExecutionIdCookieName, { log: false })
+    }).then(undefined, handleRumCorrelationCookieCleanupError)
+  }
+
+  return clearCookiePromise.then(() => {
+    return Cypress.Promise.try(() => {
+      return cy.now('setCookie', rumTestExecutionIdCookieName, traceId, { log: false })
+    })
+  }).then(() => true, handleRumCorrelationCookieError)
+}
+
+/**
+ * @param {boolean} isCookieSet
+ * @returns {void}
+ */
+function restartRumSession (isCookieSet) {
+  if (!isCookieSet || isTestIsolationEnabled || !originalWindow) {
+    return
+  }
+
+  const rum = safeGetRum(originalWindow)
+  if (rum) {
+    try {
+      const evt = new originalWindow.MouseEvent('click', { bubbles: true, cancelable: true })
+      // The browser-sdk addEventListener wrapper filters out untrusted synthetic events
+      // unless __ddIsTrusted is set. Set it so the click triggers expandOrRenewSession().
+      // See: https://github.com/DataDog/browser-sdk/blob/v6.27.1/packages/core/src/browser/addEventListener.ts#L119
+      Object.defineProperty(evt, '__ddIsTrusted', { value: true })
+      originalWindow.dispatchEvent(evt)
+    } catch {}
+    if (rum.startView) {
+      rum.startView()
+    }
+  }
+}
+
 // Catch test failures for quarantined tests and suppress them
 // By not re-throwing the error, Cypress marks the test as passed
 // This allows quarantined tests to run but not affect the exit code
@@ -150,6 +233,8 @@ Cypress.on('fail', (err, runnable) => {
   // If command:end fired for all commands (none in-flight) but the last command
   // has no error, it means command:end fired before the error was attached to it.
   if (!hadInFlightCommands && currentTestCommands.length > 0) {
+    // We have to support very old cypress versions in v5
+    // eslint-disable-next-line unicorn/prefer-at
     const lastCommand = currentTestCommands[currentTestCommands.length - 1]
     if (!lastCommand.error) {
       lastCommand.error = { message: err.message, stack: err.stack, name: err.name }
@@ -316,36 +401,16 @@ beforeEach(function () {
     if (shouldDiscard) {
       this.currentTest._ddShouldDiscard = true
     }
+    let rumCookiePromise
     if (traceId) {
-      cy.setCookie(DD_CIVISIBILITY_TEST_EXECUTION_ID_COOKIE_NAME, traceId).then(() => {
-        // When testIsolation:false, the page is not reset between tests, so the RUM session
-        // stopped in afterEach must be explicitly restarted so events in this test are
-        // associated with the new testExecutionId.
-        //
-        // After stopSession(), the RUM SDK creates a new session upon a user interaction
-        // (click, scroll, keydown, or touchstart). We dispatch a synthetic click on the window
-        // to trigger session renewal, then call startView() to establish a view boundary.
-        if (!isTestIsolationEnabled && originalWindow) {
-          const rum = safeGetRum(originalWindow)
-          if (rum) {
-            try {
-              const evt = new originalWindow.MouseEvent('click', { bubbles: true, cancelable: true })
-              // The browser-sdk addEventListener wrapper filters out untrusted synthetic events
-              // unless __ddIsTrusted is set. Set it so the click triggers expandOrRenewSession().
-              // See: https://github.com/DataDog/browser-sdk/blob/v6.27.1/packages/core/src/browser/addEventListener.ts#L119
-              Object.defineProperty(evt, '__ddIsTrusted', { value: true })
-              originalWindow.dispatchEvent(evt)
-            } catch {}
-            if (rum.startView) {
-              rum.startView()
-            }
-          }
-        }
-      })
+      rumCookiePromise = setRumCorrelationCookie(traceId)
     }
     if (shouldSkip) {
       this.skip()
     }
+    if (rumCookiePromise) {
+      return rumCookiePromise.then(restartRumSession)
+    }
   }).then(() => {
     // Clear any commands accumulated during DD-owned setup (e.g. setCookie, RUM restart)
     // so they are not reported as user test steps.
@@ -370,6 +435,7 @@ before(function () {
       isImpactedTestsEnabled = suiteConfig.isImpactedTestsEnabled
       isModifiedTest = suiteConfig.isModifiedTest
       isTestIsolationEnabled = suiteConfig.isTestIsolationEnabled
+      rumTestExecutionIdCookieName = suiteConfig.rumTestExecutionIdCookieName
       if (Number.isFinite(suiteConfig.rumFlushWaitMillis)) {
         rumFlushWaitMillis = suiteConfig.rumFlushWaitMillis
       }

package/packages/datadog-plugin-electron/src/ipc.js

@@ -46,7 +46,7 @@ class ElectronRendererReceivePlugin extends ConsumerPlugin {
 
     if (channel?.startsWith('datadog:')) return
 
-    const childOf = this._tracer.extract('text_map', args[args.length - 1])
+    const childOf = this._tracer.extract('text_map', args.at(-1))
 
     if (childOf) {
       args.pop()