dd-trace 5.102.0 → 5.104.0

package/packages/datadog-plugin-graphql/src/tools/transforms.js

@@ -1,108 +1,126 @@
-// file mostly untouched from apollo-graphql
+'use strict'
 
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const ddGlobal = globalThis[Symbol.for('dd-trace')];
-const visitor_1 = ddGlobal.graphql_visitor;
-const printer_1 = ddGlobal.graphql_printer;
-const utilities_1 = ddGlobal.graphql_utilities;
-const lodash_sortby_1 = __importDefault(require("../../../../vendor/dist/lodash.sortby"));
-function hideLiterals(ast) {
-    return visitor_1.visit(ast, {
-        IntValue(node) {
-            return Object.assign({}, node, { value: "0" });
-        },
-        FloatValue(node) {
-            return Object.assign({}, node, { value: "0" });
-        },
-        StringValue(node) {
-            return Object.assign({}, node, { value: "", block: false });
-        },
-        ListValue(node) {
-            return Object.assign({}, node, { values: [] });
-        },
-        ObjectValue(node) {
-            return Object.assign({}, node, { fields: [] });
-        }
-    });
+Object.defineProperty(exports, '__esModule', { value: true })
+
+const ddGlobal = globalThis[Symbol.for('dd-trace')]
+const visitor = ddGlobal.graphql_visitor
+const printer = ddGlobal.graphql_printer
+const utilities = ddGlobal.graphql_utilities
+
+function dropUnusedDefinitions (ast, operationName) {
+  const separated = utilities.separateOperations(ast)[operationName]
+  if (!separated) {
+    return ast
+  }
+  return separated
 }
-exports.hideLiterals = hideLiterals;
-function hideStringAndNumericLiterals(ast) {
-    return visitor_1.visit(ast, {
-        IntValue(node) {
-            return Object.assign({}, node, { value: "0" });
-        },
-        FloatValue(node) {
-            return Object.assign({}, node, { value: "0" });
-        },
-        StringValue(node) {
-            return Object.assign({}, node, { value: "", block: false });
-        }
-    });
+
+// One walk replaces Apollo's `hideLiterals` + `removeAliases` + `sortAST` +
+// the `StringValue` pre-pass that used to live in `printWithReducedWhitespace`.
+// The byte output is unchanged: hideLiterals had already collapsed every
+// `StringValue.value` to '', so the original hex round-trip degenerated to
+// hex('') === '' anyway.
+function transformForSignature (ast) {
+  return visitor.visit(ast, {
+    IntValue (node) {
+      return { ...node, value: '0' }
+    },
+    FloatValue (node) {
+      return { ...node, value: '0' }
+    },
+    StringValue (node) {
+      return { ...node, value: '', block: false }
+    },
+    ListValue (node) {
+      return { ...node, values: [] }
+    },
+    ObjectValue (node) {
+      return { ...node, fields: [] }
+    },
+    Field (node) {
+      return {
+        ...node,
+        alias: undefined,
+        arguments: sortByName(node.arguments),
+      }
+    },
+    OperationDefinition (node) {
+      return {
+        ...node,
+        variableDefinitions: sortByVariableName(node.variableDefinitions),
+      }
+    },
+    SelectionSet (node) {
+      return { ...node, selections: sortByKindThenName(node.selections) }
+    },
+    FragmentSpread (node) {
+      return { ...node, directives: sortByName(node.directives) }
+    },
+    InlineFragment (node) {
+      return { ...node, directives: sortByName(node.directives) }
+    },
+    FragmentDefinition (node) {
+      return {
+        ...node,
+        directives: sortByName(node.directives),
+        variableDefinitions: sortByVariableName(node.variableDefinitions),
+      }
+    },
+    Directive (node) {
+      return { ...node, arguments: sortByName(node.arguments) }
+    },
+  })
 }
-exports.hideStringAndNumericLiterals = hideStringAndNumericLiterals;
-function dropUnusedDefinitions(ast, operationName) {
-    const separated = utilities_1.separateOperations(ast)[operationName];
-    if (!separated) {
-        return ast;
-    }
-    return separated;
+
+function printWithReducedWhitespace (ast) {
+  return printer.print(ast)
+    .replaceAll(/\s+/g, ' ')
+    .replaceAll(/ (?=[^_a-zA-Z0-9])|(?<=[^_a-zA-Z0-9]) /g, '')
 }
-exports.dropUnusedDefinitions = dropUnusedDefinitions;
-function sorted(items) {
-    if (items) {
-        return lodash_sortby_1.default.apply(null, arguments);
-    }
-    return undefined;
+
+function sortByName (items) {
+  if (!items) return
+  return [...items].sort(byName)
 }
-function sortAST(ast) {
-    return visitor_1.visit(ast, {
-        OperationDefinition(node) {
-            return Object.assign({}, node, { variableDefinitions: sorted(node.variableDefinitions, "variable.name.value") });
-        },
-        SelectionSet(node) {
-            return Object.assign({}, node, { selections: lodash_sortby_1.default(node.selections, "kind", "name.value") });
-        },
-        Field(node) {
-            return Object.assign({}, node, { arguments: sorted(node.arguments, "name.value") });
-        },
-        FragmentSpread(node) {
-            return Object.assign({}, node, { directives: sorted(node.directives, "name.value") });
-        },
-        InlineFragment(node) {
-            return Object.assign({}, node, { directives: sorted(node.directives, "name.value") });
-        },
-        FragmentDefinition(node) {
-            return Object.assign({}, node, { directives: sorted(node.directives, "name.value"), variableDefinitions: sorted(node.variableDefinitions, "variable.name.value") });
-        },
-        Directive(node) {
-            return Object.assign({}, node, { arguments: sorted(node.arguments, "name.value") });
-        }
-    });
+
+function byName (a, b) {
+  const left = a.name.value
+  const right = b.name.value
+  if (left < right) return -1
+  if (left > right) return 1
+  return 0
 }
-exports.sortAST = sortAST;
-function removeAliases(ast) {
-    return visitor_1.visit(ast, {
-        Field(node) {
-            return Object.assign({}, node, { alias: undefined });
-        }
-    });
+
+function sortByVariableName (items) {
+  if (!items) return
+  return [...items].sort(byVariableName)
 }
-exports.removeAliases = removeAliases;
-function printWithReducedWhitespace(ast) {
-    const sanitizedAST = visitor_1.visit(ast, {
-        StringValue(node) {
-            return Object.assign({}, node, { value: Buffer.from(node.value, "utf8").toString("hex"), block: false });
-        }
-    });
-    const withWhitespace = printer_1.print(sanitizedAST);
-    const minimizedButStillHex = withWhitespace
-        .replace(/\s+/g, " ")
-        .replace(/([^_a-zA-Z0-9]) /g, (_, c) => c)
-        .replace(/ ([^_a-zA-Z0-9])/g, (_, c) => c);
-    return minimizedButStillHex.replace(/"([a-f0-9]+)"/g, (_, hex) => JSON.stringify(Buffer.from(hex, "hex").toString("utf8")));
+
+function byVariableName (a, b) {
+  const left = a.variable.name.value
+  const right = b.variable.name.value
+  if (left < right) return -1
+  if (left > right) return 1
+  return 0
+}
+
+// SelectionSet children include InlineFragment, which has no `name`, so the
+// secondary key falls back to undefined and stable sort keeps sibling order.
+function sortByKindThenName (items) {
+  return [...items].sort(byKindThenName)
 }
-exports.printWithReducedWhitespace = printWithReducedWhitespace;
+
+function byKindThenName (a, b) {
+  if (a.kind < b.kind) return -1
+  if (a.kind > b.kind) return 1
+  const left = a.name?.value
+  const right = b.name?.value
+  if (left === right) return 0
+  if (left === undefined) return 1
+  if (right === undefined) return -1
+  return left < right ? -1 : 1
+}
+
+exports.dropUnusedDefinitions = dropUnusedDefinitions
+exports.transformForSignature = transformForSignature
+exports.printWithReducedWhitespace = printWithReducedWhitespace

package/packages/datadog-plugin-graphql/src/utils.js

@@ -7,7 +7,10 @@ function extractErrorIntoSpanEvent (config, span, exc) {
     attributes.type = exc.name
   }
 
-  if (exc.stack) {
+  // graphql-js validation errors carry a lazy `.stack` accessor; reading it
+  // here is the only consumer in the pipeline and pays full V8 symbolisation.
+  const isValidationOnly = exc.locations && !exc.path && !exc.originalError?.stack
+  if (!isValidationOnly && exc.stack) {
     attributes.stacktrace = exc.stack
   }
 
@@ -44,6 +47,35 @@ function extractErrorIntoSpanEvent (config, span, exc) {
   span.addEvent('dd.graphql.query.error', attributes, Date.now())
 }
 
+let tools
+
+function getSignature (document, operationName, operationType, calculate) {
+  if (calculate !== false && tools !== false) {
+    try {
+      try {
+        tools ||= require('./tools')
+      } catch (e) {
+        tools = false
+        throw e
+      }
+
+      return tools.defaultEngineReportingSignature(document, operationName)
+    } catch {
+      // safety net
+    }
+  }
+
+  if (operationType) {
+    if (operationName) {
+      return `${operationType} ${operationName}`
+    }
+    return operationType
+  }
+
+  return operationName ?? ''
+}
+
 module.exports = {
   extractErrorIntoSpanEvent,
+  getSignature,
 }

package/packages/datadog-plugin-grpc/src/client.js

@@ -86,12 +86,11 @@ class GrpcClientPlugin extends ClientPlugin {
       // The only scheme we want to support here is ipv[46]:port, although
       // more are supported by the library
       // https://github.com/grpc/grpc/blob/v1.60.0/doc/naming.md
-      const parts = peer.split(':')
-      if (/^\d+/.test(parts.at(-1))) {
-        const port = parts.at(-1)
-        const ip = parts.slice(0, -1).join(':')
-        span.setTag('network.destination.ip', ip)
-        span.setTag('network.destination.port', port)
+      const colonIndex = peer.lastIndexOf(':')
+      const tail = colonIndex === -1 ? '' : peer.slice(colonIndex + 1)
+      if (tail && /^\d+$/.test(tail)) {
+        span.setTag('network.destination.ip', peer.slice(0, colonIndex))
+        span.setTag('network.destination.port', tail)
       } else {
         span.setTag('network.destination.ip', peer)
       }
@@ -121,7 +120,7 @@ function inject (tracer, span, metadata) {
 
   tracer.inject(span, TEXT_MAP, carrier)
 
-  for (const key in carrier) {
+  for (const key of Object.keys(carrier)) {
     metadata.set(key, carrier[key])
   }
 }

package/packages/datadog-plugin-grpc/src/util.js

@@ -3,46 +3,81 @@
 const pick = require('../../datadog-core/src/utils/src/pick')
 const log = require('../../dd-trace/src/log')
 
+/**
+ * @typedef {object} ParsedMethodPath
+ * @property {string} name
+ * @property {string} service
+ * @property {string} package
+ */
+
+// Sentinel returned by `getFilter` when the user has not configured a metadata
+// filter. `addMetadataTags` short-circuits on this identity to skip the
+// `metadata.getMap()` clone in the default no-filter case.
 function getEmptyObject () {
   return {}
 }
 
-module.exports = {
-  getMethodMetadata (path, kind) {
-    const tags = {
-      path,
-      kind,
-      name: '',
-      service: '',
-      package: '',
+/**
+ * gRPC method paths are stable per service definition (e.g.
+ * `/pkg.Service/Method`); a service typically only has a small finite set.
+ * Cache the parsed `{name, service, package}` triple by path so we skip the
+ * `path.split('/')` + `serviceParts.split('.')` + `serviceParts.pop()` work
+ * on every call.
+ *
+ * @type {Map<string, ParsedMethodPath>}
+ */
+const methodPathCache = new Map()
+
+/**
+ * @param {string} path
+ * @returns {ParsedMethodPath}
+ */
+function parseMethodPath (path) {
+  const methodParts = path.split('/')
+
+  if (methodParts.length > 2) {
+    const serviceParts = methodParts[1].split('.')
+    return {
+      name: methodParts[2],
+      service: serviceParts.pop(),
+      package: serviceParts.join('.'),
     }
+  }
 
-    if (typeof path !== 'string') return tags
+  return { name: methodParts.at(-1), service: '', package: '' }
+}
 
-    const methodParts = path.split('/')
+module.exports = {
+  getEmptyObject,
 
-    if (methodParts.length > 2) {
-      const serviceParts = methodParts[1].split('.')
-      const name = methodParts[2]
-      const service = serviceParts.pop()
-      const pkg = serviceParts.join('.')
+  getMethodMetadata (path, kind) {
+    if (typeof path !== 'string') {
+      return { path, kind, name: '', service: '', package: '' }
+    }
 
-      tags.name = name
-      tags.service = service
-      tags.package = pkg
-    } else {
-      tags.name = methodParts.at(-1)
+    let parsed = methodPathCache.get(path)
+    if (parsed === undefined) {
+      parsed = parseMethodPath(path)
+      methodPathCache.set(path, parsed)
     }
 
-    return tags
+    return {
+      path,
+      kind,
+      name: parsed.name,
+      service: parsed.service,
+      package: parsed.package,
+    }
   },
 
   addMetadataTags (span, metadata, filter, type) {
     if (!metadata || typeof metadata.getMap !== 'function') return
+    // Default no-op filter: skip the full metadata clone via `getMap()`.
+    if (filter === getEmptyObject) return
 
     const values = filter(metadata.getMap())
 
-    for (const key in values) {
+    for (const key of Object.keys(values)) {
       span.setTag(`grpc.${type}.metadata.${key}`, values[key])
     }
   },

package/packages/datadog-plugin-http/src/client.js

@@ -39,10 +39,10 @@ class HttpClientPlugin extends ClientPlugin {
     // TODO delegate to super.startspan
     const span = this.startSpan(this.operationName(), {
       childOf,
-      integrationName: this.constructor.id,
+      integrationName: this.component,
       service: this.serviceName({ pluginConfig: this.config, sessionDetails: extractSessionDetails(options) }),
       meta: {
-        [COMPONENT]: this.constructor.id,
+        [COMPONENT]: this.component,
         'span.kind': 'client',
         'resource.name': method,
         'span.type': 'http',

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

@@ -21,6 +21,7 @@ const {
   TEST_SOURCE_START,
   TEST_ITR_UNSKIPPABLE,
   TEST_ITR_FORCED_RUN,
+  TEST_ITR_SKIPPING_ENABLED,
   TEST_CODE_OWNERS,
   ITR_CORRELATION_ID,
   TEST_SOURCE_FILE,
@@ -107,6 +108,7 @@ class JestPlugin extends CiPlugin {
       process.on('message', handler)
     }
     this.testSuiteSpanPerTestSuiteAbsolutePath = new Map()
+    this.pendingTestSuiteFinishes = new Set()
 
     this.addSub('ci:jest:session:finish', ({
       status,
@@ -123,58 +125,66 @@ class JestPlugin extends CiPlugin {
       isTestManagementTestsEnabled,
       onDone,
     }) => {
-      this.testSessionSpan.setTag(TEST_STATUS, status)
-      this.testModuleSpan.setTag(TEST_STATUS, status)
+      const finishSession = () => {
+        this.testSessionSpan.setTag(TEST_STATUS, status)
+        this.testModuleSpan.setTag(TEST_STATUS, status)
 
-      if (error) {
-        this.testSessionSpan.setTag('error', error)
-        this.testModuleSpan.setTag('error', error)
-      }
-
-      addIntelligentTestRunnerSpanTags(
-        this.testSessionSpan,
-        this.testModuleSpan,
-        {
-          isSuitesSkipped,
-          isSuitesSkippingEnabled,
-          isCodeCoverageEnabled,
-          testCodeCoverageLinesTotal,
-          skippingType: 'suite',
-          skippingCount: numSkippedSuites,
-          hasUnskippableSuites,
-          hasForcedToRunSuites,
+        if (error) {
+          this.testSessionSpan.setTag('error', error)
+          this.testModuleSpan.setTag('error', error)
         }
-      )
 
-      if (isEarlyFlakeDetectionEnabled) {
-        this.testSessionSpan.setTag(TEST_EARLY_FLAKE_ENABLED, 'true')
-      }
-      if (isEarlyFlakeDetectionFaulty) {
-        this.testSessionSpan.setTag(TEST_EARLY_FLAKE_ABORT_REASON, 'faulty')
-      }
-      if (isTestManagementTestsEnabled) {
-        this.testSessionSpan.setTag(TEST_MANAGEMENT_ENABLED, 'true')
-      }
+        addIntelligentTestRunnerSpanTags(
+          this.testSessionSpan,
+          this.testModuleSpan,
+          {
+            isSuitesSkipped,
+            isSuitesSkippingEnabled,
+            isCodeCoverageEnabled,
+            testCodeCoverageLinesTotal,
+            skippingType: 'suite',
+            skippingCount: numSkippedSuites,
+            hasUnskippableSuites,
+            hasForcedToRunSuites,
+          }
+        )
 
-      this.testModuleSpan.finish()
-      this.telemetry.ciVisEvent(TELEMETRY_EVENT_FINISHED, 'module')
-      this.testSessionSpan.finish()
-      this.telemetry.ciVisEvent(TELEMETRY_EVENT_FINISHED, 'session', {
-        hasFailedTestReplay: this.libraryConfig?.isDiEnabled || undefined,
-      })
-      finishAllTraceSpans(this.testSessionSpan)
+        if (isEarlyFlakeDetectionEnabled) {
+          this.testSessionSpan.setTag(TEST_EARLY_FLAKE_ENABLED, 'true')
+        }
+        if (isEarlyFlakeDetectionFaulty) {
+          this.testSessionSpan.setTag(TEST_EARLY_FLAKE_ABORT_REASON, 'faulty')
+        }
+        if (isTestManagementTestsEnabled) {
+          this.testSessionSpan.setTag(TEST_MANAGEMENT_ENABLED, 'true')
+        }
 
-      this.telemetry.count(TELEMETRY_TEST_SESSION, {
-        provider: this.ciProviderName,
-        autoInjected: !!this._tracerConfig.DD_CIVISIBILITY_AUTO_INSTRUMENTATION_PROVIDER,
-      })
+        this.testModuleSpan.finish()
+        this.telemetry.ciVisEvent(TELEMETRY_EVENT_FINISHED, 'module')
+        this.testSessionSpan.finish()
+        this.telemetry.ciVisEvent(TELEMETRY_EVENT_FINISHED, 'session', {
+          hasFailedTestReplay: this.libraryConfig?.isDiEnabled || undefined,
+        })
+        finishAllTraceSpans(this.testSessionSpan)
+
+        this.telemetry.count(TELEMETRY_TEST_SESSION, {
+          provider: this.ciProviderName,
+          autoInjected: !!this._tracerConfig.DD_CIVISIBILITY_AUTO_INSTRUMENTATION_PROVIDER,
+        })
+
+        appClosingTelemetry()
+        this.tracer._exporter.flush(() => {
+          if (onDone) {
+            onDone()
+          }
+        })
+      }
 
-      appClosingTelemetry()
-      this.tracer._exporter.flush(() => {
-        if (onDone) {
-          onDone()
-        }
-      })
+      if (this.pendingTestSuiteFinishes.size > 0) {
+        Promise.all(this.pendingTestSuiteFinishes).then(finishSession)
+      } else {
+        finishSession()
+      }
     })
 
     // Test suites can be run in a different process from jest's main one.
@@ -197,6 +207,7 @@ class JestPlugin extends CiPlugin {
         config._ddIsDiEnabled = this.libraryConfig?.isDiEnabled ?? false
         config._ddIsKnownTestsEnabled = this.libraryConfig?.isKnownTestsEnabled ?? false
         config._ddIsImpactedTestsEnabled = this.libraryConfig?.isImpactedTestsEnabled ?? false
+        config._ddItrSkippingEnabledTags = this.getSessionItrSkippingEnabledTags()
       }
     })
 
@@ -217,6 +228,7 @@ class JestPlugin extends CiPlugin {
         _ddForcedToRun,
         _ddUnskippable,
         _ddTestCodeCoverageEnabled,
+        _ddItrSkippingEnabledTags: itrSkippingEnabledTags,
       } = testEnvironmentOptions
 
       const testSessionSpanContext = this.tracer.extract('text_map', {
@@ -228,6 +240,7 @@ class JestPlugin extends CiPlugin {
         ...getTestSuiteCommonTags(testCommand, frameworkVersion, testSuite, 'jest'),
         // requestErrorTags from test env options may be undefined
         ...(requestErrorTags !== undefined && requestErrorTags !== null ? requestErrorTags : {}),
+        ...(itrSkippingEnabledTags !== undefined && itrSkippingEnabledTags !== null ? itrSkippingEnabledTags : {}),
       }
 
       if (_ddUnskippable) {
@@ -305,10 +318,18 @@ class JestPlugin extends CiPlugin {
       }
     })
 
-    this.addSub('ci:jest:test-suite:finish', ({ status, errorMessage, error, testSuiteAbsolutePath }) => {
+    this.addSub('ci:jest:test-suite:finish', ({
+      status,
+      errorMessage,
+      error,
+      testSuiteAbsolutePath,
+      waitForFinish,
+      onDone,
+    }) => {
       const testSuiteSpan = this.testSuiteSpanPerTestSuiteAbsolutePath.get(testSuiteAbsolutePath)
       if (!testSuiteSpan) {
         log.warn('"ci:jest:test-suite:finish": no span found for test suite absolute path %s', testSuiteAbsolutePath)
+        onDone?.()
         return
       }
       testSuiteSpan.setTag(TEST_STATUS, status)
@@ -319,8 +340,13 @@ class JestPlugin extends CiPlugin {
         testSuiteSpan.setTag('error', new Error(errorMessage))
         testSuiteSpan.setTag(TEST_STATUS, 'fail')
       }
-      // We need to give the potential error in 'ci:jest:test-suite:error' time to be published
-      process.nextTick(() => {
+      let resolvePendingFinish
+      const pendingFinish = new Promise(resolve => {
+        resolvePendingFinish = resolve
+      })
+      this.pendingTestSuiteFinishes.add(pendingFinish)
+
+      const finish = () => {
         testSuiteSpan.finish()
         this.telemetry.ciVisEvent(TELEMETRY_EVENT_FINISHED, 'suite')
         // Suites potentially run in a different process than the session,
@@ -334,7 +360,19 @@ class JestPlugin extends CiPlugin {
         }
         this.removeAllDiProbes()
         this.testSuiteSpanPerTestSuiteAbsolutePath.delete(testSuiteAbsolutePath)
-      })
+        this.pendingTestSuiteFinishes.delete(pendingFinish)
+        resolvePendingFinish()
+        if (onDone) {
+          onDone()
+        }
+      }
+
+      if (waitForFinish) {
+        // Give late async work time to run before Jest restarts a worker because of workerIdleMemoryLimit.
+        realSetTimeout(finish)
+      } else {
+        process.nextTick(finish)
+      }
     })
 
     this.addSub('ci:jest:test-suite:error', ({ error, errorMessage, testSuiteAbsolutePath }) => {
@@ -558,6 +596,10 @@ class JestPlugin extends CiPlugin {
       extraTags[TEST_HAS_DYNAMIC_NAME] = 'true'
     }
     const testSuiteSpan = this.testSuiteSpanPerTestSuiteAbsolutePath.get(testSuiteAbsolutePath) || this.testSuiteSpan
+    const skippingEnabled = testSuiteSpan?.context()._tags?.[TEST_ITR_SKIPPING_ENABLED]
+    if (skippingEnabled !== undefined) {
+      extraTags[TEST_ITR_SKIPPING_ENABLED] = skippingEnabled
+    }
 
     return super.startTestSpan(name, suite, testSuiteSpan, extraTags)
   }