dd-trace 6.3.0 → 6.5.0

package/packages/datadog-instrumentations/src/oracledb.js

@@ -144,8 +144,8 @@ addHook({ name: 'oracledb', versions: ['>=5'], file: 'lib/oracledb.js' }, oracle
   shimmer.wrap(oracledb.Pool.prototype, 'getConnection', getConnection => {
     return function wrappedGetConnection (...args) {
       let callback
-      if (typeof args[args.length - 1] === 'function') {
-        callback = args[args.length - 1]
+      if (typeof args.at(-1) === 'function') {
+        callback = args.at(-1)
       }
       if (callback) {
         args[args.length - 1] = shimmer.wrapFunction(callback, callback => (err, connection) => {

package/packages/datadog-instrumentations/src/pg.js

@@ -97,7 +97,7 @@ function wrapQuery (query) {
 
         // Based on: https://github.com/brianc/node-postgres/blob/54eb0fa216aaccd727765641e7d1cf5da2bc483d/packages/pg/lib/client.js#L510
         const reusingQuery = typeof pgQuery.submit === 'function'
-        const callback = args[args.length - 1]
+        const callback = args.at(-1)
 
         finish(error)
 
@@ -197,7 +197,7 @@ function wrapPoolQuery (query) {
     const ctx = { query: pgQuery, abortController }
 
     return startPoolQueryCh.runStores(ctx, () => {
-      const cb = args[args.length - 1]
+      const cb = args.at(-1)
 
       if (abortController.signal.aborted) {
         const error = abortController.signal.reason || new Error('Aborted')

package/packages/datadog-instrumentations/src/playwright.js

@@ -25,6 +25,9 @@ const log = require('../../dd-trace/src/log')
 const {
   getValueFromEnvSources,
 } = require('../../dd-trace/src/config/helper')
+const {
+  RUM_TEST_EXECUTION_ID_COOKIE_NAME: RUM_COOKIE_NAME,
+} = require('../../dd-trace/src/ci-visibility/rum')
 const { DD_MAJOR } = require('../../../version')
 const { addHook, channel, tracingChannel } = require('./helpers/instrument')
 
@@ -33,6 +36,7 @@ const testFinishCh = channel('ci:playwright:test:finish')
 const testSkipCh = channel('ci:playwright:test:skip')
 
 const testSessionStartCh = channel('ci:playwright:session:start')
+const testSessionConfigurationCh = channel('ci:playwright:session:configuration')
 const testSessionFinishCh = channel('ci:playwright:session:finish')
 
 const libraryConfigurationCh = channel('ci:playwright:library-configuration')
@@ -51,6 +55,9 @@ const dispatcherRunCh = tracingChannel('orchestrion:playwright:Dispatcher_run')
 const dispatcherCreateWorkerCh = tracingChannel('orchestrion:playwright:Dispatcher_createWorker')
 const processHostStartRunnerCh = tracingChannel('orchestrion:playwright:ProcessHost_startRunner')
 const createRootSuiteCh = tracingChannel('orchestrion:playwright:createRootSuite')
+const artifactsRecorderScreenshotPathCh =
+  tracingChannel('orchestrion:playwright:ArtifactsRecorder_createScreenshotAttachmentPath')
+const snapshotRecorderScreenshotPathCh = tracingChannel('orchestrion:playwright:SnapshotRecorder_createAttachmentPath')
 const pageGotoCh = tracingChannel('orchestrion:playwright-core:Page_goto')
 
 const testToCtx = new WeakMap()
@@ -61,6 +68,8 @@ const testsToTestStatuses = new Map()
 
 const RUM_FLUSH_WAIT_TIME = getValueFromEnvSources('DD_CIVISIBILITY_RUM_FLUSH_WAIT_MILLIS')
 const DD_PROPERTIES_TIMEOUT = 5000
+const isFailureScreenshotUploadEnabled =
+  getValueFromEnvSources('DD_TEST_FAILURE_SCREENSHOTS_ENABLED') === true
 
 let applyRepeatEachIndex = null
 
@@ -115,8 +124,21 @@ const EFD_RETRY_COUNT_RESPONSE = 'ddEfdRetryCountResponse'
 const DD_PROPERTIES_REQUEST = 'ddPropertiesRequest'
 const DD_PROPERTIES_RESPONSE = 'ddProperties'
 const kDdPlaywrightDisabledTestIds = Symbol('ddPlaywrightDisabledTestIds')
+const kDdPlaywrightFailureScreenshots = Symbol('ddPlaywrightFailureScreenshots')
 const kDdPlaywrightWorkerHostInstrumented = Symbol('ddPlaywrightWorkerHostInstrumented')
 const kDdPlaywrightWorkerInstrumented = Symbol('ddPlaywrightWorkerInstrumented')
+const PLAYWRIGHT_FAILURE_SCREENSHOT_PATH_RE = /(?:^|[\\/])test-failed-\d+\.png$/
+const automaticFailureScreenshotPaths = new Set()
+
+/**
+ * Returns whether Playwright's internal screenshot recorder created an attachment.
+ *
+ * @param {object} attachment - Playwright attachment payload
+ * @returns {boolean}
+ */
+function isAutomaticFailureScreenshotAttachment (attachment) {
+  return typeof attachment?.path === 'string' && automaticFailureScreenshotPaths.delete(attachment.path)
+}
 
 function isValidKnownTests (receivedKnownTests) {
   return !!receivedKnownTests.playwright
@@ -501,6 +523,23 @@ function getProjectsFromRunner (runner, configArg) {
   })
 }
 
+/**
+ * Returns whether at least one Playwright project captures automatic screenshots for failed tests.
+ *
+ * @param {Array<object>} projects - Playwright projects with resolved use options
+ * @returns {boolean} Whether failure screenshot capture is enabled
+ */
+function isFailureScreenshotCaptureEnabled (projects) {
+  for (const project of projects) {
+    const screenshot = project.use?.screenshot
+    const mode = typeof screenshot === 'object' && screenshot !== null ? screenshot.mode : screenshot
+    if (mode === 'on' || mode === 'only-on-failure' || mode === 'on-first-failure') {
+      return true
+    }
+  }
+  return false
+}
+
 function getProjectsFromDispatcher (dispatcher) {
   const bundledConfig = dispatcher._testRun?.config?.config?.projects
   if (bundledConfig) {
@@ -993,6 +1032,7 @@ function onDispatcherCreateWorker (dispatcher, worker) {
 
   const projects = getProjectsFromDispatcher(dispatcher)
   sessionProjects = projects
+  const automaticFailureScreenshotPathsByTestId = new Map()
 
   if (disabledTestIds.size && !worker[kDdPlaywrightWorkerHostInstrumented] &&
       typeof worker.runTestGroup === 'function') {
@@ -1021,6 +1061,16 @@ function onDispatcherCreateWorker (dispatcher, worker) {
     const shouldCreateTestSpan = test.expectedStatus === 'skipped'
     testBeginHandler(test, browser, shouldCreateTestSpan)
   })
+  worker.on('attach', ({ testId, path, _ddIsAutomaticFailureScreenshot }) => {
+    if (!_ddIsAutomaticFailureScreenshot) return
+
+    let screenshotPaths = automaticFailureScreenshotPathsByTestId.get(testId)
+    if (!screenshotPaths) {
+      screenshotPaths = new Set()
+      automaticFailureScreenshotPathsByTestId.set(testId, screenshotPaths)
+    }
+    screenshotPaths.add(path)
+  })
   worker.on('testEnd', ({ testId, status, errors, annotations }) => {
     const test = getTestByTestId(dispatcher, testId)
     if (!test) return
@@ -1043,6 +1093,20 @@ function onDispatcherCreateWorker (dispatcher, worker) {
       }
     )
     const testResult = test.results.at(-1)
+    const automaticFailureScreenshotPaths = automaticFailureScreenshotPathsByTestId.get(testId)
+    automaticFailureScreenshotPathsByTestId.delete(testId)
+    if (testStatus === 'fail' && automaticFailureScreenshotPaths?.size && testResult?.attachments?.length) {
+      const screenshots = []
+      for (const attachment of testResult.attachments) {
+        if (automaticFailureScreenshotPaths.has(attachment.path)) {
+          screenshots.push(attachment)
+        }
+      }
+      if (screenshots.length) {
+        worker[kDdPlaywrightFailureScreenshots] ??= []
+        worker[kDdPlaywrightFailureScreenshots].push(screenshots)
+      }
+    }
     const isAtrRetry = testResult?.retry > 0 &&
       isFlakyTestRetriesEnabled &&
       !test._ddIsAttemptToFix &&
@@ -1145,9 +1209,16 @@ function runAllTestsWrapper (runAllTests, playwrightVersion) {
     let onDone
 
     rootDir = getRootDir(this, config)
+    const projects = getProjectsFromRunner(this, config)
+    const isFailureScreenshotEnabled = isFailureScreenshotCaptureEnabled(projects)
     const processArgv = process.argv.slice(2).join(' ')
     const command = `playwright ${processArgv}`
-    testSessionStartCh.publish({ command, frameworkVersion: playwrightVersion, rootDir })
+    testSessionStartCh.publish({
+      command,
+      frameworkVersion: playwrightVersion,
+      rootDir,
+      isFailureScreenshotEnabled,
+    })
 
     try {
       const { err, libraryConfig } = await getChannelPromise(
@@ -1174,6 +1245,8 @@ function runAllTestsWrapper (runAllTests, playwrightVersion) {
       log.error('Playwright session start error', e)
     }
 
+    testSessionConfigurationCh.publish({ isFailureScreenshotEnabled })
+
     const isTestOptimizationSupported = satisfies(playwrightVersion, MINIMUM_SUPPORTED_VERSION_RANGE_EFD)
     const shouldGetKnownTests = isKnownTestsEnabled && isTestOptimizationSupported
     const shouldGetTestManagementTests = isTestManagementTestsEnabled && isTestOptimizationSupported
@@ -1239,8 +1312,6 @@ function runAllTestsWrapper (runAllTests, playwrightVersion) {
       }
     }
 
-    const projects = getProjectsFromRunner(this, config)
-
     // ATR and `--retries` are now compatible with Test Management.
     // Test Management tests have their retries set to 0 at the test level,
     // preventing them from being retried by ATR or `--retries`.
@@ -1288,7 +1359,7 @@ function runAllTestsWrapper (runAllTests, playwrightVersion) {
 
       for (const [fqn, testStatuses] of testsToTestStatuses.entries()) {
         // Only count as failed if the final status (after retries) is 'fail'
-        const lastStatus = testStatuses[testStatuses.length - 1]
+        const lastStatus = testStatuses.at(-1)
         if (lastStatus === 'fail') {
           totalFailedTestCount += 1
           if (quarantinedButNotAttemptToFixFqns.has(fqn)) {
@@ -1439,6 +1510,23 @@ pageGotoCh.subscribe({
   },
 })
 
+/**
+ * Records a path created by Playwright's automatic screenshot recorder.
+ *
+ * @param {object} ctx - Orchestrion context
+ * @returns {void}
+ */
+function recordAutomaticFailureScreenshotPath (ctx) {
+  if (isFailureScreenshotUploadEnabled &&
+    typeof ctx.result === 'string' &&
+    PLAYWRIGHT_FAILURE_SCREENSHOT_PATH_RE.test(ctx.result)) {
+    automaticFailureScreenshotPaths.add(ctx.result)
+  }
+}
+
+artifactsRecorderScreenshotPathCh.subscribe({ end: recordAutomaticFailureScreenshotPath })
+snapshotRecorderScreenshotPathCh.subscribe({ end: recordAutomaticFailureScreenshotPath })
+
 if (DD_MAJOR < 6) { // <1.38.0 is only supported up to version 5
   addHook({
     name: '@playwright/test',
@@ -1750,7 +1838,10 @@ function finishProcessHostStartRunner (processHost) {
     }
     // These messages are [code, payload]. The payload is test data
     if (Array.isArray(message) && message[0] === PLAYWRIGHT_WORKER_TRACE_PAYLOAD_CODE) {
-      workerReportCh.publish(message[1])
+      workerReportCh.publish({
+        serializedTraces: message[1],
+        screenshots: processHost[kDdPlaywrightFailureScreenshots]?.shift(),
+      })
     }
   })
 }
@@ -1774,23 +1865,64 @@ addHook({
 })
 
 async function handlePageGoto (page) {
+  if (!testPageGotoCh.hasSubscribers || !page || typeof page.evaluate !== 'function') {
+    return
+  }
+
+  let rumState
   try {
-    if (page && typeof page.evaluate === 'function') {
-      const { isRumInstrumented, isRumActive, rumSamplingRate } = await page.evaluate(detectRum)
-      if (isRumInstrumented && rumSamplingRate < 100 && !isRumActive) {
-        log.debug("RUM was detected on the page, but it isn't active because the sampling rate is below 100%")
-      }
+    rumState = await page.evaluate(detectRum)
+  } catch (error) {
+    // Redirects and closed contexts can make page evaluation fail after a successful navigation.
+    log.error('Playwright RUM detection error', error)
+    return
+  }
 
-      if (isRumActive) {
-        testPageGotoCh.publish({
-          isRumActive,
-          page,
-        })
-      }
-    }
-  } catch (e) {
-    // ignore errors such as redirects, context destroyed, etc
-    log.error('goto hook error', e)
+  if (!rumState) {
+    return
+  }
+
+  const { isRumInstrumented, isRumActive, rumSamplingRate } = rumState
+  if (isRumInstrumented && rumSamplingRate < 100 && !isRumActive) {
+    log.debug("RUM was detected on the page, but it isn't active because the sampling rate is below 100%")
+  }
+  if (!isRumActive) {
+    return
+  }
+
+  let browserVersion
+  try {
+    browserVersion = page.context().browser()?.version()
+  } catch (error) {
+    log.error('Playwright browser metadata error', error)
+  }
+
+  const context = {
+    isRumActive,
+    browserVersion,
+    testExecutionId: undefined,
+  }
+  try {
+    testPageGotoCh.publish(context)
+  } catch (error) {
+    log.error('Playwright RUM correlation channel error', error)
+    return
+  }
+
+  if (!context.testExecutionId) {
+    return
+  }
+
+  try {
+    const domain = new URL(page.url()).hostname
+    await page.context().addCookies([{
+      name: RUM_COOKIE_NAME,
+      value: context.testExecutionId,
+      domain,
+      path: '/',
+    }])
+  } catch (error) {
+    log.error('Playwright RUM correlation cookie error', error)
   }
 }
 
@@ -1918,10 +2050,11 @@ function instrumentWorkerMainMethods (workerMain) {
                   if (url) {
                     const domain = new URL(url).hostname
                     await page.context().addCookies([{
-                      name: 'datadog-ci-visibility-test-execution-id',
+                      name: RUM_COOKIE_NAME,
                       value: '',
                       domain,
                       path: '/',
+                      expires: 0,
                     }])
                   } else {
                     log.error('RUM is active but page.url() is not available')
@@ -2042,7 +2175,9 @@ function instrumentWorkerMainMethods (workerMain) {
   // We reproduce what happens in `Dispatcher#_onStepBegin` and `Dispatcher#_onStepEnd`,
   // since `startTime` and `duration` are not available directly in the worker process
   shimmer.wrap(workerMain, 'dispatchEvent', dispatchEvent => function (event, payload) {
-    if (event === 'stepBegin') {
+    if (event === 'testBegin' || event === 'testEnd') {
+      automaticFailureScreenshotPaths.clear()
+    } else if (event === 'stepBegin') {
       stepInfoByStepId[payload.stepId] = {
         startTime: payload.wallTime,
         title: payload.title,
@@ -2058,6 +2193,8 @@ function instrumentWorkerMainMethods (workerMain) {
         duration: payload.wallTime - stepInfo.startTime,
         error: payload.error,
       })
+    } else if (event === 'attach' && isAutomaticFailureScreenshotAttachment(payload)) {
+      payload._ddIsAutomaticFailureScreenshot = true
     }
     return dispatchEvent.apply(this, arguments)
   })

package/packages/datadog-instrumentations/src/process.js

@@ -1,5 +1,7 @@
 'use strict'
 
+const { syncBuiltinESMExports } = require('node:module')
+
 const { channel } = require('dc-polyfill')
 const shimmer = require('../../datadog-shimmer')
 
@@ -26,4 +28,5 @@ if (process.setUncaughtExceptionCaptureCallback) {
         return result
       }
     })
+  syncBuiltinESMExports()
 }