dd-trace 5.7.0 → 5.9.0

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

@@ -15,7 +15,7 @@ const startTCPCh = channel('apm:net:tcp:start')
 const finishTCPCh = channel('apm:net:tcp:finish')
 const errorTCPCh = channel('apm:net:tcp:error')
 
-const connectionCh = channel(`apm:net:tcp:connection`)
+const connectionCh = channel('apm:net:tcp:connection')
 
 const names = ['net', 'node:net']
 

package/packages/datadog-instrumentations/src/passport-utils.js

@@ -10,6 +10,7 @@ function wrapVerifiedAndPublish (username, password, verified, type) {
     return verified
   }
 
+  // eslint-disable-next-line n/handle-callback-err
   return shimmer.wrap(verified, function (err, user, info) {
     const credentials = { type, username }
     passportVerifyChannel.publish({ credentials, user })

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

@@ -1,6 +1,9 @@
+const semver = require('semver')
+
 const { addHook, channel, AsyncResource } = require('./helpers/instrument')
 const shimmer = require('../../datadog-shimmer')
-const { parseAnnotations } = require('../../dd-trace/src/plugins/util/test')
+const { parseAnnotations, getTestSuitePath } = require('../../dd-trace/src/plugins/util/test')
+const log = require('../../dd-trace/src/log')
 
 const testStartCh = channel('ci:playwright:test:start')
 const testFinishCh = channel('ci:playwright:test:finish')
@@ -8,6 +11,9 @@ const testFinishCh = channel('ci:playwright:test:finish')
 const testSessionStartCh = channel('ci:playwright:session:start')
 const testSessionFinishCh = channel('ci:playwright:session:finish')
 
+const libraryConfigurationCh = channel('ci:playwright:library-configuration')
+const knownTestsCh = channel('ci:playwright:known-tests')
+
 const testSuiteStartCh = channel('ci:playwright:test-suite:start')
 const testSuiteFinishCh = channel('ci:playwright:test-suite:finish')
 
@@ -16,6 +22,8 @@ const testSuiteToAr = new Map()
 const testSuiteToTestStatuses = new Map()
 const testSuiteToErrors = new Map()
 
+let applyRepeatEachIndex = null
+
 let startedSuites = []
 
 const STATUS_TO_TEST_STATUS = {
@@ -26,6 +34,44 @@ const STATUS_TO_TEST_STATUS = {
 }
 
 let remainingTestsByFile = {}
+let isEarlyFlakeDetectionEnabled = false
+let earlyFlakeDetectionNumRetries = 0
+let knownTests = {}
+let rootDir = ''
+const MINIMUM_SUPPORTED_VERSION_EFD = '1.38.0'
+
+function isNewTest (test) {
+  const testSuite = getTestSuitePath(test._requireFile, rootDir)
+  const testsForSuite = knownTests?.playwright?.[testSuite] || []
+
+  return !testsForSuite.includes(test.title)
+}
+
+function getSuiteType (test, type) {
+  let suite = test.parent
+  while (suite && suite._type !== type) {
+    suite = suite.parent
+  }
+  return suite
+}
+
+// Copy of Suite#_deepClone but with a function to filter tests
+function deepCloneSuite (suite, filterTest) {
+  const copy = suite._clone()
+  for (const entry of suite._entries) {
+    if (entry.constructor.name === 'Suite') {
+      copy._addSuite(deepCloneSuite(entry, filterTest))
+    } else {
+      if (filterTest(entry)) {
+        const copiedTest = entry._clone()
+        copiedTest._ddIsNew = true
+        copiedTest._ddIsEfdRetry = true
+        copy._addTest(copiedTest)
+      }
+    }
+  }
+  return copy
+}
 
 function getTestsBySuiteFromTestGroups (testGroups) {
   return testGroups.reduce((acc, { requireFile, tests }) => {
@@ -153,8 +199,11 @@ function getTestSuiteError (testSuiteAbsolutePath) {
 function testBeginHandler (test, browserName) {
   const {
     _requireFile: testSuiteAbsolutePath,
-    title: testName, _type,
-    location: { line: testSourceLine }
+    title: testName,
+    _type,
+    location: {
+      line: testSourceLine
+    }
   } = test
 
   if (_type === 'beforeAll' || _type === 'afterAll') {
@@ -198,7 +247,14 @@ function testEndHandler (test, annotations, testStatus, error, isTimeout) {
   const testResult = results[results.length - 1]
   const testAsyncResource = testToAr.get(test)
   testAsyncResource.runInAsyncScope(() => {
-    testFinishCh.publish({ testStatus, steps: testResult.steps, error, extraTags: annotationTags })
+    testFinishCh.publish({
+      testStatus,
+      steps: testResult.steps,
+      error,
+      extraTags: annotationTags,
+      isNew: test._ddIsNew,
+      isEfdRetry: test._ddIsEfdRetry
+    })
   })
 
   if (testSuiteToTestStatuses.has(testSuiteAbsolutePath)) {
@@ -309,14 +365,56 @@ function dispatcherHookNew (dispatcherExport, runWrapper) {
 
 function runnerHook (runnerExport, playwrightVersion) {
   shimmer.wrap(runnerExport.Runner.prototype, 'runAllTests', runAllTests => async function () {
+    let onDone
+
     const testSessionAsyncResource = new AsyncResource('bound-anonymous-fn')
-    const rootDir = getRootDir(this)
+
+    rootDir = getRootDir(this)
 
     const processArgv = process.argv.slice(2).join(' ')
     const command = `playwright ${processArgv}`
     testSessionAsyncResource.runInAsyncScope(() => {
       testSessionStartCh.publish({ command, frameworkVersion: playwrightVersion, rootDir })
     })
+
+    const configurationPromise = new Promise((resolve) => {
+      onDone = resolve
+    })
+
+    testSessionAsyncResource.runInAsyncScope(() => {
+      libraryConfigurationCh.publish({ onDone })
+    })
+
+    try {
+      const { err, libraryConfig } = await configurationPromise
+      if (!err) {
+        isEarlyFlakeDetectionEnabled = libraryConfig.isEarlyFlakeDetectionEnabled
+        earlyFlakeDetectionNumRetries = libraryConfig.earlyFlakeDetectionNumRetries
+      }
+    } catch (e) {
+      log.error(e)
+    }
+
+    if (isEarlyFlakeDetectionEnabled && semver.gte(playwrightVersion, MINIMUM_SUPPORTED_VERSION_EFD)) {
+      const knownTestsPromise = new Promise((resolve) => {
+        onDone = resolve
+      })
+      testSessionAsyncResource.runInAsyncScope(() => {
+        knownTestsCh.publish({ onDone })
+      })
+
+      try {
+        const { err, knownTests: receivedKnownTests } = await knownTestsPromise
+        if (!err) {
+          knownTests = receivedKnownTests
+        } else {
+          isEarlyFlakeDetectionEnabled = false
+        }
+      } catch (err) {
+        log.error(err)
+      }
+    }
+
     const projects = getProjectsFromRunner(this)
 
     const runAllTestsReturn = await runAllTests.apply(this, arguments)
@@ -334,12 +432,15 @@ function runnerHook (runnerExport, playwrightVersion) {
 
     const sessionStatus = runAllTestsReturn.status || runAllTestsReturn
 
-    let onDone
     const flushWait = new Promise(resolve => {
       onDone = resolve
     })
     testSessionAsyncResource.runInAsyncScope(() => {
-      testSessionFinishCh.publish({ status: STATUS_TO_TEST_STATUS[sessionStatus], onDone })
+      testSessionFinishCh.publish({
+        status: STATUS_TO_TEST_STATUS[sessionStatus],
+        isEarlyFlakeDetectionEnabled,
+        onDone
+      })
     })
     await flushWait
 
@@ -394,3 +495,53 @@ addHook({
   file: 'lib/runner/dispatcher.js',
   versions: ['>=1.38.0']
 }, (dispatcher) => dispatcherHookNew(dispatcher, dispatcherRunWrapperNew))
+
+// Hook used for early flake detection. EFD only works from >=1.38.0
+addHook({
+  name: 'playwright',
+  file: 'lib/common/suiteUtils.js',
+  versions: [`>=${MINIMUM_SUPPORTED_VERSION_EFD}`]
+}, suiteUtilsPackage => {
+  // We grab `applyRepeatEachIndex` to use it later
+  // `applyRepeatEachIndex` needs to be applied to a cloned suite
+  applyRepeatEachIndex = suiteUtilsPackage.applyRepeatEachIndex
+  return suiteUtilsPackage
+})
+
+// Hook used for early flake detection. EFD only works from >=1.38.0
+addHook({
+  name: 'playwright',
+  file: 'lib/runner/loadUtils.js',
+  versions: [`>=${MINIMUM_SUPPORTED_VERSION_EFD}`]
+}, (loadUtilsPackage) => {
+  const oldCreateRootSuite = loadUtilsPackage.createRootSuite
+
+  async function newCreateRootSuite () {
+    const rootSuite = await oldCreateRootSuite.apply(this, arguments)
+    if (!isEarlyFlakeDetectionEnabled) {
+      return rootSuite
+    }
+    const newTests = rootSuite
+      .allTests()
+      .filter(isNewTest)
+
+    newTests.forEach(newTest => {
+      newTest._ddIsNew = true
+      if (newTest.expectedStatus !== 'skipped') {
+        const fileSuite = getSuiteType(newTest, 'file')
+        const projectSuite = getSuiteType(newTest, 'project')
+        for (let repeatEachIndex = 0; repeatEachIndex < earlyFlakeDetectionNumRetries; repeatEachIndex++) {
+          const copyFileSuite = deepCloneSuite(fileSuite, isNewTest)
+          applyRepeatEachIndex(projectSuite._fullProject, copyFileSuite, repeatEachIndex + 1)
+          projectSuite._addSuite(copyFileSuite)
+        }
+      }
+    })
+
+    return rootSuite
+  }
+
+  loadUtilsPackage.createRootSuite = newCreateRootSuite
+
+  return loadUtilsPackage
+})

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

@@ -45,7 +45,9 @@ addHook({ name: 'rhea', versions: ['>=1'], file: 'lib/link.js' }, obj => {
     const { host, port } = getHostAndPort(this.connection)
 
     const targetAddress = this.options && this.options.target &&
-      this.options.target.address ? this.options.target.address : undefined
+      this.options.target.address
+      ? this.options.target.address
+      : undefined
 
     const asyncResource = new AsyncResource('bound-anonymous-fn')
     return asyncResource.runInAsyncScope(() => {
@@ -187,7 +189,8 @@ function patchCircularBuffer (proto, Session) {
               if (shouldPop) {
                 const remoteState = entry.remote_state
                 const state = remoteState && remoteState.constructor
-                  ? entry.remote_state.constructor.composite_type : undefined
+                  ? entry.remote_state.constructor.composite_type
+                  : undefined
                 asyncResource.runInAsyncScope(() => {
                   exports.beforeFinish(entry, state)
                   finishSendCh.publish()

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

@@ -7,7 +7,7 @@ const {
 } = require('./helpers/instrument')
 const shimmer = require('../../datadog-shimmer')
 
-addHook({ name: 'tedious', versions: [ '>=1.0.0' ] }, tedious => {
+addHook({ name: 'tedious', versions: ['>=1.0.0'] }, tedious => {
   const startCh = channel('apm:tedious:request:start')
   const finishCh = channel('apm:tedious:request:finish')
   const errorCh = channel('apm:tedious:request:error')

package/packages/datadog-plugin-apollo/src/gateway/execute.js

@@ -0,0 +1,12 @@
+'use strict'
+
+const ApolloBasePlugin = require('../../../dd-trace/src/plugins/apollo')
+
+class ApolloGatewayExecutePlugin extends ApolloBasePlugin {
+  static get operation () { return 'execute' }
+  static get prefix () {
+    return 'tracing:apm:apollo:gateway:execute'
+  }
+}
+
+module.exports = ApolloGatewayExecutePlugin

package/packages/datadog-plugin-apollo/src/gateway/fetch.js

@@ -0,0 +1,36 @@
+'use strict'
+
+const { storage } = require('../../../datadog-core')
+const ApolloBasePlugin = require('../../../dd-trace/src/plugins/apollo')
+
+class ApolloGatewayFetchPlugin extends ApolloBasePlugin {
+  static get operation () { return 'fetch' }
+  static get prefix () {
+    return 'tracing:apm:apollo:gateway:fetch'
+  }
+
+  bindStart (ctx) {
+    const store = storage.getStore()
+    const childOf = store ? store.span : null
+
+    const spanData = {
+      childOf,
+      service: this.getServiceName(),
+      type: this.constructor.type,
+      meta: {}
+    }
+
+    const serviceName = ctx?.attributes?.service
+
+    if (serviceName) { spanData.meta.serviceName = serviceName }
+
+    const span = this.startSpan(this.getOperationName(), spanData, false)
+
+    ctx.parentStore = store
+    ctx.currentStore = { ...store, span }
+
+    return ctx.currentStore
+  }
+}
+
+module.exports = ApolloGatewayFetchPlugin

package/packages/datadog-plugin-apollo/src/gateway/index.js

@@ -0,0 +1,36 @@
+'use strict'
+
+const { storage } = require('../../../datadog-core')
+const CompositePlugin = require('../../../dd-trace/src/plugins/composite')
+const ApolloGatewayExecutePlugin = require('./execute')
+const ApolloGatewayPostProcessingPlugin = require('./postprocessing')
+const ApolloGatewayRequestPlugin = require('./request')
+const ApolloGatewayPlanPlugin = require('./plan')
+const ApolloGatewayValidatePlugin = require('./validate')
+const ApolloGatewayFetchPlugin = require('./fetch')
+
+class ApolloGatewayPlugin extends CompositePlugin {
+  static get id () { return 'gateway' }
+  static get plugins () {
+    return {
+      execute: ApolloGatewayExecutePlugin,
+      postprocessing: ApolloGatewayPostProcessingPlugin,
+      request: ApolloGatewayRequestPlugin,
+      plan: ApolloGatewayPlanPlugin,
+      fetch: ApolloGatewayFetchPlugin,
+      validate: ApolloGatewayValidatePlugin
+    }
+  }
+
+  constructor (...args) {
+    super(...args)
+    this.addSub('apm:apollo:gateway:general:error', (ctx) => {
+      const store = storage.getStore()
+      const span = store?.span
+      if (!span) return
+      span.setTag('error', ctx.error)
+    })
+  }
+}
+
+module.exports = ApolloGatewayPlugin

package/packages/datadog-plugin-apollo/src/gateway/plan.js

@@ -0,0 +1,12 @@
+'use strict'
+
+const ApolloBasePlugin = require('../../../dd-trace/src/plugins/apollo')
+
+class ApolloGatewayPlanPlugin extends ApolloBasePlugin {
+  static get operation () { return 'plan' }
+  static get prefix () {
+    return 'tracing:apm:apollo:gateway:plan'
+  }
+}
+
+module.exports = ApolloGatewayPlanPlugin

package/packages/datadog-plugin-apollo/src/gateway/postprocessing.js

@@ -0,0 +1,12 @@
+'use strict'
+
+const ApolloBasePlugin = require('../../../dd-trace/src/plugins/apollo')
+
+class ApolloGatewayPostProcessingPlugin extends ApolloBasePlugin {
+  static get operation () { return 'postprocessing' }
+  static get prefix () {
+    return 'tracing:apm:apollo:gateway:postprocessing'
+  }
+}
+
+module.exports = ApolloGatewayPostProcessingPlugin

package/packages/datadog-plugin-apollo/src/gateway/request.js

@@ -0,0 +1,124 @@
+'use strict'
+
+const { storage } = require('../../../datadog-core')
+const ApolloBasePlugin = require('../../../dd-trace/src/plugins/apollo')
+
+let tools
+
+const OPERATION_DEFINITION = 'OperationDefinition'
+const FRAGMENT_DEFINITION = 'FragmentDefinition'
+
+class ApolloGatewayRequestPlugin extends ApolloBasePlugin {
+  static get operation () { return 'request' }
+  static get prefix () {
+    return 'tracing:apm:apollo:gateway:request'
+  }
+
+  bindStart (ctx) {
+    const store = storage.getStore()
+    const childOf = store ? store.span : null
+    const spanData = {
+      childOf,
+      service: this.serviceName(
+        { id: `${this.constructor.id}.${this.constructor.operation}`, pluginConfig: this.config }),
+      type: this.constructor.type,
+      kind: this.constructor.kind,
+      meta: {}
+    }
+
+    const { requestContext, gateway } = ctx
+
+    if (requestContext?.operationName) {
+      spanData.meta['graphql.operation.name'] = requestContext.operationName
+    }
+    if ((this.config.source || gateway?.config?.telemetry?.includeDocument) && requestContext?.source) {
+      spanData.meta['graphql.source'] = requestContext.source
+    }
+
+    const operationContext =
+    buildOperationContext(gateway.schema, requestContext.document, requestContext.request.operationName)
+
+    if (operationContext?.operation?.operation) {
+      const document = requestContext?.document
+      const type = operationContext?.operation?.operation
+      const name = operationContext?.operation?.name && operationContext?.operation?.name?.value
+
+      spanData.resource = getSignature(document, name, type, this?.config?.signature)
+      spanData.meta['graphql.operation.type'] = type
+    }
+    const span = this.startSpan(this.operationName({ id: `${this.constructor.id}.${this.constructor.operation}` }),
+      spanData, false)
+
+    ctx.parentStore = store
+    ctx.currentStore = { ...store, span }
+    return ctx.currentStore
+  }
+
+  asyncStart (ctx) {
+    const errors = ctx?.result?.errors
+    // apollo gateway catches certain errors and returns them in the result object
+    // we want to capture these errors as spans
+    if (errors instanceof Array &&
+      errors[errors.length - 1] && errors[errors.length - 1].stack && errors[errors.length - 1].message) {
+      ctx.currentStore.span.setTag('error', errors[errors.length - 1])
+    }
+    ctx.currentStore.span.finish()
+    return ctx.parentStore
+  }
+}
+
+function buildOperationContext (schema, operationDocument, operationName) {
+  let operation
+  let operationCount = 0
+  const fragments = Object.create(null)
+  try {
+    operationDocument.definitions.forEach(definition => {
+      switch (definition.kind) {
+        case OPERATION_DEFINITION:
+          operationCount++
+          if (!operationName && operationCount > 1) {
+            return
+          }
+          if (
+            !operationName ||
+            (definition.name && definition.name.value === operationName)
+          ) {
+            operation = definition
+          }
+          break
+        case FRAGMENT_DEFINITION:
+          fragments[definition.name.value] = definition
+          break
+      }
+    })
+  } catch (e) {
+    // safety net
+  }
+
+  return {
+    schema,
+    operation,
+    fragments
+  }
+}
+
+function getSignature (document, operationName, operationType, calculate) {
+  if (calculate !== false && tools !== false) {
+    try {
+      try {
+        tools = tools || require('../../../datadog-plugin-graphql/src/tools')
+      } catch (e) {
+        tools = false
+        throw e
+      }
+
+      return tools.defaultEngineReportingSignature(document, operationName)
+    } catch (e) {
+      // safety net
+    }
+  }
+
+  return [operationType, operationName].filter(val => val).join(' ')
+}
+
+module.exports = ApolloGatewayRequestPlugin

package/packages/datadog-plugin-apollo/src/gateway/validate.js

@@ -0,0 +1,25 @@
+'use strict'
+
+const ApolloBasePlugin = require('../../../dd-trace/src/plugins/apollo')
+
+class ApolloGatewayValidatePlugin extends ApolloBasePlugin {
+  static get operation () { return 'validate' }
+  static get prefix () {
+    return 'tracing:apm:apollo:gateway:validate'
+  }
+
+  end (ctx) {
+    const result = ctx.result
+    const span = ctx.currentStore?.span
+
+    if (!span) return
+
+    if (result instanceof Array &&
+      result[result.length - 1] && result[result.length - 1].stack && result[result.length - 1].message) {
+      span.setTag('error', result[result.length - 1])
+    }
+    span.finish()
+  }
+}
+
+module.exports = ApolloGatewayValidatePlugin

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

@@ -0,0 +1,15 @@
+'use strict'
+
+const CompositePlugin = require('../../dd-trace/src/plugins/composite')
+const ApolloGatewayPlugin = require('./gateway')
+
+class ApolloPlugin extends CompositePlugin {
+  static get id () { return 'apollo' }
+  static get plugins () {
+    return {
+      gateway: ApolloGatewayPlugin
+    }
+  }
+}
+
+module.exports = ApolloPlugin

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

@@ -37,10 +37,10 @@ class BaseAwsSdkPlugin extends ClientPlugin {
         'service.name': this.serviceName(),
         'aws.operation': operation,
         'aws.region': awsRegion,
-        'region': awsRegion,
-        'aws_service': awsService,
+        region: awsRegion,
+        aws_service: awsService,
         'aws.service': awsService,
-        'component': 'aws-sdk'
+        component: 'aws-sdk'
       }
       if (this.requestTags) this.requestTags.set(request, tags)
 

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

@@ -13,7 +13,7 @@ class CloudwatchLogs extends BaseAwsSdkPlugin {
     return Object.assign(tags, {
       'resource.name': `${operation} ${params.logGroupName}`,
       'aws.cloudwatch.logs.log_group_name': params.logGroupName,
-      'loggroupname': params.logGroupName
+      loggroupname: params.logGroupName
     })
   }
 }

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

@@ -14,7 +14,7 @@ class DynamoDb extends BaseAwsSdkPlugin {
         Object.assign(tags, {
           'resource.name': `${operation} ${params.TableName}`,
           'aws.dynamodb.table_name': params.TableName,
-          'tablename': params.TableName
+          tablename: params.TableName
         })
       }
 
@@ -30,7 +30,7 @@ class DynamoDb extends BaseAwsSdkPlugin {
             Object.assign(tags, {
               'resource.name': `${operation} ${tableName}`,
               'aws.dynamodb.table_name': tableName,
-              'tablename': tableName
+              tablename: tableName
             })
           }
         }

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

@@ -11,7 +11,7 @@ class EventBridge extends BaseAwsSdkPlugin {
     return {
       'resource.name': operation ? `${operation} ${params.source}` : params.source,
       'aws.eventbridge.source': `${params.source}`,
-      'rulename': `${rulename}`
+      rulename: `${rulename}`
     }
   }
 

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

@@ -69,7 +69,7 @@ class Kinesis extends BaseAwsSdkPlugin {
     return {
       'resource.name': `${operation} ${params.StreamName}`,
       'aws.kinesis.stream_name': params.StreamName,
-      'streamname': params.StreamName
+      streamname: params.StreamName
     }
   }
 

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

@@ -13,7 +13,7 @@ class Lambda extends BaseAwsSdkPlugin {
 
     return Object.assign(tags, {
       'resource.name': `${operation} ${params.FunctionName}`,
-      'functionname': params.FunctionName,
+      functionname: params.FunctionName,
       'aws.lambda': params.FunctionName
     })
   }

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

@@ -13,7 +13,7 @@ class Redshift extends BaseAwsSdkPlugin {
     return Object.assign(tags, {
       'resource.name': `${operation} ${params.ClusterIdentifier}`,
       'aws.redshift.cluster_identifier': params.ClusterIdentifier,
-      'clusteridentifier': params.ClusterIdentifier
+      clusteridentifier: params.ClusterIdentifier
     })
   }
 }

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

@@ -14,7 +14,7 @@ class S3 extends BaseAwsSdkPlugin {
     return Object.assign(tags, {
       'resource.name': `${operation} ${params.Bucket}`,
       'aws.s3.bucket_name': params.Bucket,
-      'bucketname': params.Bucket
+      bucketname: params.Bucket
     })
   }
 }

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

@@ -23,7 +23,7 @@ class Sns extends BaseAwsSdkPlugin {
     return {
       'resource.name': `${operation} ${params.TopicArn || response.data.TopicArn}`,
       'aws.sns.topic_arn': TopicArn,
-      'topicname': topicName
+      topicname: topicName
     }
 
     // TODO: should arn be sanitized or quantized in some way here,