fix tests, add tests

Author: Lms24

packages/astro/src/server/meta.ts

@@ -1,5 +1,8 @@
-import { getDynamicSamplingContextFromClient, spanToTraceHeader } from '@sentry/core';
-import { getDynamicSamplingContextFromSpan } from '@sentry/core/src/tracing/dynamicSamplingContext';
+import {
+  getDynamicSamplingContextFromClient,
+  getDynamicSamplingContextFromSpan,
+  spanToTraceHeader,
+} from '@sentry/core';
 import type { Client, Scope, Span } from '@sentry/types';
 import {
   TRACEPARENT_REGEXP,

packages/astro/test/server/meta.test.ts

@@ -25,6 +25,10 @@ const mockedScope = {
 describe('getTracingMetaTags', () => {
   it('returns the tracing tags from the span, if it is provided', () => {
     {
+      vi.spyOn(SentryCore, 'getDynamicSamplingContextFromSpan').mockReturnValueOnce({
+        environment: 'production',
+      });
+
       const tags = getTracingMetaTags(mockedSpan, mockedScope, mockedClient);
 
       expect(tags).toEqual({

packages/core/src/tracing/dynamicSamplingContext.ts

@@ -1,4 +1,4 @@
-import type { Client, DynamicSamplingContext, Scope, Span } from '@sentry/types';
+import type { Client, DynamicSamplingContext, Scope, Span, Transaction } from '@sentry/types';
 import { dropUndefinedKeys } from '@sentry/utils';
 
 import { DEFAULT_ENVIRONMENT } from '../constants';
@@ -38,7 +38,7 @@ export function getDynamicSamplingContextFromClient(
 /**
  * A Span with a frozen dynamic sampling context.
  */
-type TransactionWithV7FrozenDsc = Span & { _frozenDynamicSamplingContext?: DynamicSamplingContext };
+type TransactionWithV7FrozenDsc = Transaction & { _frozenDynamicSamplingContext?: DynamicSamplingContext };
 
 /**
  * Creates a dynamic sampling context from a span (and client and scope)
@@ -48,29 +48,30 @@ type TransactionWithV7FrozenDsc = Span & { _frozenDynamicSamplingContext?: Dynam
  * @returns a dynamic sampling context
  */
 export function getDynamicSamplingContextFromSpan(span: Span): Readonly<Partial<DynamicSamplingContext>> {
-  // As long as we use `Transaction`s internally, this should be fine.
-  // TODO: We need to replace this with a `getRootSpan(span)` function though
-  const txn = span.transaction;
-
-  // TODO (v8): Remove v7FrozenDsc as a Transaction will no longer have _frozenDynamicSamplingContext
-  // For now we need to avoid breaking users who directly created a txn with a DSC, where this field is still set.
-  // @see Transaction class constructor
-  const v7FrozenDsc = (txn as TransactionWithV7FrozenDsc)._frozenDynamicSamplingContext;
-  if (v7FrozenDsc) {
-    return v7FrozenDsc;
-  }
-
   const client = getClient();
   if (!client) {
     return {};
   }
 
   // passing emit=false here to only emit later once the DSC is actually populated
   const dsc = getDynamicSamplingContextFromClient(span.traceId, client, getCurrentScope(), false);
+
+  const txn = span.transaction as TransactionWithV7FrozenDsc | undefined;
   if (!txn) {
     return dsc;
   }
 
+  // As long as we use `Transaction`s internally, this should be fine.
+  // TODO: We need to replace this with a `getRootSpan(span)` function though
+
+  // TODO (v8): Remove v7FrozenDsc as a Transaction will no longer have _frozenDynamicSamplingContext
+  // For now we need to avoid breaking users who directly created a txn with a DSC, where this field is still set.
+  // @see Transaction class constructor
+  const v7FrozenDsc = txn && txn._frozenDynamicSamplingContext;
+  if (v7FrozenDsc) {
+    return v7FrozenDsc;
+  }
+
   const maybeSampleRate = txn.metadata.sampleRate;
   if (maybeSampleRate !== undefined) {
     dsc.sample_rate = `${maybeSampleRate}`;

packages/core/test/lib/tracing/dynamicSamplingContext.test.ts

@@ -0,0 +1,77 @@
+import type { TransactionSource } from '@sentry/types';
+import { Hub, makeMain } from '../../../src';
+import { Transaction, getDynamicSamplingContextFromSpan } from '../../../src/tracing';
+import { TestClient, getDefaultTestClientOptions } from '../../mocks/client';
+
+describe('getDynamicSamplingContextFromSpan', () => {
+  beforeEach(() => {
+    const options = getDefaultTestClientOptions({ tracesSampleRate: 0.0, release: '1.0.1' });
+    const client = new TestClient(options);
+    const hub = new Hub(client);
+    makeMain(hub);
+  });
+
+  afterEach(() => {
+    jest.resetAllMocks();
+  });
+
+  test('returns the DSC provided during transaction creation', () => {
+    const transaction = new Transaction({
+      name: 'tx',
+      metadata: { dynamicSamplingContext: { environment: 'myEnv' } },
+    });
+
+    const dynamicSamplingContext = getDynamicSamplingContextFromSpan(transaction);
+
+    expect(dynamicSamplingContext).toStrictEqual({ environment: 'myEnv' });
+  });
+
+  test('returns a new DSC, if no DSC was provided during transaction creation', () => {
+    const transaction = new Transaction({
+      name: 'tx',
+      metadata: {
+        sampleRate: 0.56,
+      },
+    });
+
+    const dynamicSamplingContext = getDynamicSamplingContextFromSpan(transaction);
+
+    expect(dynamicSamplingContext).toStrictEqual({
+      release: '1.0.1',
+      environment: 'production',
+      sample_rate: '0.56',
+      trace_id: expect.any(String),
+      transaction: 'tx',
+    });
+  });
+
+  describe('Including transaction name in DSC', () => {
+    test('is not included if transaction source is url', () => {
+      const transaction = new Transaction({
+        name: 'tx',
+        metadata: {
+          source: 'url',
+        },
+      });
+
+      const dsc = getDynamicSamplingContextFromSpan(transaction);
+      expect(dsc.transaction).toBeUndefined();
+    });
+
+    test.each([
+      ['is included if transaction source is parameterized route/url', 'route'],
+      ['is included if transaction source is a custom name', 'custom'],
+    ])('%s', (_: string, source) => {
+      const transaction = new Transaction({
+        name: 'tx',
+        metadata: {
+          ...(source && { source: source as TransactionSource }),
+        },
+      });
+
+      const dsc = getDynamicSamplingContextFromSpan(transaction);
+
+      expect(dsc.transaction).toEqual('tx');
+    });
+  });
+});