fix propagator!!

Author: mydea

packages/opentelemetry/src/propagator.ts

@@ -1,4 +1,5 @@
 import type { Baggage, Context, Span, TextMapGetter, TextMapSetter } from '@opentelemetry/api';
+import { SpanKind } from '@opentelemetry/api';
 import { INVALID_TRACEID } from '@opentelemetry/api';
 import { context } from '@opentelemetry/api';
 import { propagation, trace } from '@opentelemetry/api';
@@ -32,6 +33,7 @@ import { DEBUG_BUILD } from './debug-build';
 import { getScopesFromContext, setScopesOnContext } from './utils/contextData';
 import { generateSpanContextForPropagationContext } from './utils/generateSpanContextForPropagationContext';
 import { getSamplingDecision } from './utils/getSamplingDecision';
+import { getSpanKind } from './utils/getSpanKind';
 import { setIsSetup } from './utils/setupCheck';
 
 /** Get the Sentry propagation context from a span context. */
@@ -86,9 +88,14 @@ export class SentryPropagator extends W3CBaggagePropagator {
 
     const activeSpan = trace.getSpan(context);
     const url = activeSpan && getCurrentURL(activeSpan);
+    // We only want to check the URL against tracePropagationTargets for outgoing request spans
+    // In other cases, we always inject the trace data
+    const shouldCheckUrl =
+      activeSpan && (spanToJSON(activeSpan).op === 'http.client' || getSpanKind(activeSpan) === SpanKind.CLIENT);
 
     const tracePropagationTargets = getClient()?.getOptions()?.tracePropagationTargets;
     if (
+      shouldCheckUrl &&
       typeof url === 'string' &&
       tracePropagationTargets &&
       !this._shouldInjectTraceData(tracePropagationTargets, url)

packages/opentelemetry/src/utils/getTraceData.ts

@@ -11,16 +11,16 @@ import { getContextFromScope } from './contextData';
 export function getTraceData({ span }: { span?: Span } = {}): SerializedTraceData {
   const headersObject: Record<string, string> = {};
 
+  let ctx = api.context.active();
+
   if (span) {
     const { scope } = getCapturedScopesOnSpan(span);
     // fall back to current context if for whatever reason we can't find the one of the span
-    const ctx = (scope && getContextFromScope(scope)) || api.trace.setSpan(api.context.active(), span);
-
-    api.propagation.inject(ctx, headersObject);
-  } else {
-    api.propagation.inject(api.context.active(), headersObject);
+    ctx = (scope && getContextFromScope(scope)) || api.trace.setSpan(api.context.active(), span);
   }
 
+  api.propagation.inject(ctx, headersObject);
+
   if (!headersObject['sentry-trace']) {
     return {};
   }

packages/opentelemetry/test/propagator.test.ts

@@ -1,5 +1,6 @@
 import {
   ROOT_CONTEXT,
+  SpanKind,
   TraceFlags,
   context,
   defaultTextMapGetter,
@@ -8,7 +9,8 @@ import {
   trace,
 } from '@opentelemetry/api';
 import { suppressTracing } from '@opentelemetry/core';
-import { getCurrentScope, withScope } from '@sentry/core';
+import { ATTR_URL_FULL, SEMATTRS_HTTP_URL } from '@opentelemetry/semantic-conventions';
+import { SEMANTIC_ATTRIBUTE_SENTRY_OP, getCurrentScope, withScope } from '@sentry/core';
 
 import { SENTRY_BAGGAGE_HEADER, SENTRY_SCOPES_CONTEXT_KEY, SENTRY_TRACE_HEADER } from '../src/constants';
 import { SentryPropagator } from '../src/propagator';
@@ -28,6 +30,7 @@ describe('SentryPropagator', () => {
       release: '1.0.0',
       enableTracing: true,
       dsn: 'https://abc@domain/123',
+      tracePropagationTargets: ['/path2'],
     });
   });
 
@@ -545,6 +548,111 @@ describe('SentryPropagator', () => {
       expect(carrier[SENTRY_TRACE_HEADER]).toBe(undefined);
       expect(carrier[SENTRY_BAGGAGE_HEADER]).toBe(undefined);
     });
+
+    it.each([
+      [
+        {
+          attributes: { [ATTR_URL_FULL]: 'https://domain.com/path2' },
+          kind: SpanKind.CLIENT,
+        },
+        true,
+      ],
+      [
+        {
+          // eslint-disable-next-line deprecation/deprecation
+          attributes: { [SEMATTRS_HTTP_URL]: 'https://domain.com/path2' },
+          kind: SpanKind.CLIENT,
+        },
+        true,
+      ],
+      [
+        {
+          attributes: { [ATTR_URL_FULL]: 'https://domain.com/path3' },
+          kind: SpanKind.CLIENT,
+        },
+        false,
+      ],
+      [
+        {
+          // eslint-disable-next-line deprecation/deprecation
+          attributes: { [SEMATTRS_HTTP_URL]: 'https://domain.com/path3' },
+          kind: SpanKind.CLIENT,
+        },
+        false,
+      ],
+      [
+        {
+          attributes: { [ATTR_URL_FULL]: 'https://domain.com/path2' },
+        },
+        true,
+      ],
+      [
+        {
+          // eslint-disable-next-line deprecation/deprecation
+          attributes: { [SEMATTRS_HTTP_URL]: 'https://domain.com/path2' },
+        },
+        true,
+      ],
+      [
+        {
+          attributes: { [ATTR_URL_FULL]: 'https://domain.com/path3' },
+        },
+        true,
+      ],
+      [
+        {
+          // eslint-disable-next-line deprecation/deprecation
+          attributes: { [SEMATTRS_HTTP_URL]: 'https://domain.com/path3' },
+        },
+        true,
+      ],
+      [
+        {
+          attributes: { [ATTR_URL_FULL]: 'https://domain.com/path3' },
+          kind: SpanKind.SERVER,
+        },
+        true,
+      ],
+      [
+        {
+          // eslint-disable-next-line deprecation/deprecation
+          attributes: { [SEMATTRS_HTTP_URL]: 'https://domain.com/path3' },
+          kind: SpanKind.SERVER,
+        },
+        true,
+      ],
+      [
+        {
+          attributes: {
+            [ATTR_URL_FULL]: 'https://domain.com/path3',
+            [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.client',
+          },
+        },
+        false,
+      ],
+      [
+        {
+          attributes: {
+            // eslint-disable-next-line deprecation/deprecation
+            [SEMATTRS_HTTP_URL]: 'https://domain.com/path3',
+            [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'http.client',
+          },
+        },
+        false,
+      ],
+    ])('for %p injection is %p', (spanContext, shouldInject) => {
+      trace.getTracer('test').startActiveSpan('test', spanContext, span => {
+        propagator.inject(context.active(), carrier, defaultTextMapSetter);
+
+        if (shouldInject) {
+          expect(carrier[SENTRY_TRACE_HEADER]).toBe(`${span.spanContext().traceId}-${span.spanContext().spanId}-1`);
+          expect(carrier[SENTRY_BAGGAGE_HEADER]).toMatch(/.+/);
+        } else {
+          expect(carrier[SENTRY_TRACE_HEADER]).toBe(undefined);
+          expect(carrier[SENTRY_BAGGAGE_HEADER]).toBe(undefined);
+        }
+      });
+    });
   });
 
   describe('extract', () => {