unit tests

Author: Luca Forstner

packages/browser/test/tracing/browserTracingIntegration.test.ts

@@ -644,15 +644,19 @@ describe('browserTracingIntegration', () => {
 
       expect(oldCurrentScopePropCtx).toEqual({
         traceId: expect.stringMatching(/[a-f0-9]{32}/),
+        sampleRand: expect.any(Number),
       });
       expect(oldIsolationScopePropCtx).toEqual({
         traceId: expect.stringMatching(/[a-f0-9]{32}/),
+        sampleRand: expect.any(Number),
       });
       expect(newCurrentScopePropCtx).toEqual({
         traceId: expect.stringMatching(/[a-f0-9]{32}/),
+        sampleRand: expect.any(Number),
       });
       expect(newIsolationScopePropCtx).toEqual({
         traceId: expect.stringMatching(/[a-f0-9]{32}/),
+        sampleRand: expect.any(Number),
       });
 
       expect(newIsolationScopePropCtx.traceId).not.toEqual(oldIsolationScopePropCtx.traceId);
@@ -676,6 +680,7 @@ describe('browserTracingIntegration', () => {
 
       const propCtxBeforeEnd = getCurrentScope().getPropagationContext();
       expect(propCtxBeforeEnd).toStrictEqual({
+        sampleRand: expect.any(Number),
         traceId: expect.stringMatching(/[a-f0-9]{32}/),
       });
 
@@ -685,13 +690,15 @@ describe('browserTracingIntegration', () => {
       expect(propCtxAfterEnd).toStrictEqual({
         traceId: propCtxBeforeEnd.traceId,
         sampled: true,
+        sampleRand: expect.any(Number),
         dsc: {
           environment: 'production',
           public_key: 'examplePublicKey',
           sample_rate: '1',
           sampled: 'true',
           transaction: 'mySpan',
           trace_id: propCtxBeforeEnd.traceId,
+          sample_rand: expect.any(String),
         },
       });
     });
@@ -714,6 +721,7 @@ describe('browserTracingIntegration', () => {
       const propCtxBeforeEnd = getCurrentScope().getPropagationContext();
       expect(propCtxBeforeEnd).toStrictEqual({
         traceId: expect.stringMatching(/[a-f0-9]{32}/),
+        sampleRand: expect.any(Number),
       });
 
       navigationSpan!.end();
@@ -722,13 +730,15 @@ describe('browserTracingIntegration', () => {
       expect(propCtxAfterEnd).toStrictEqual({
         traceId: propCtxBeforeEnd.traceId,
         sampled: false,
+        sampleRand: expect.any(Number),
         dsc: {
           environment: 'production',
           public_key: 'examplePublicKey',
           sample_rate: '0',
           sampled: 'false',
           transaction: 'mySpan',
           trace_id: propCtxBeforeEnd.traceId,
+          sample_rand: expect.any(String),
         },
       });
     });
@@ -739,7 +749,7 @@ describe('browserTracingIntegration', () => {
       // make sampled false here, so we can see that it's being used rather than the tracesSampleRate-dictated one
       document.head.innerHTML =
         '<meta name="sentry-trace" content="12312012123120121231201212312012-1121201211212012-0">' +
-        '<meta name="baggage" content="sentry-release=2.1.14,foo=bar">';
+        '<meta name="baggage" content="sentry-release=2.1.14,foo=bar,sentry-sample_rand=0.123">';
 
       const client = new BrowserClient(
         getDefaultBrowserClientOptions({
@@ -765,11 +775,12 @@ describe('browserTracingIntegration', () => {
       expect(spanIsSampled(idleSpan)).toBe(false);
 
       expect(dynamicSamplingContext).toBeDefined();
-      expect(dynamicSamplingContext).toStrictEqual({ release: '2.1.14' });
+      expect(dynamicSamplingContext).toStrictEqual({ release: '2.1.14', sample_rand: '0.123' });
 
       // Propagation context keeps the meta tag trace data for later events on the same route to add them to the trace
       expect(propagationContext.traceId).toEqual('12312012123120121231201212312012');
       expect(propagationContext.parentSpanId).toEqual('1121201211212012');
+      expect(propagationContext.sampleRand).toBe(0.123);
     });
 
     it('puts frozen Dynamic Sampling Context on pageload span if sentry-trace data and only 3rd party baggage is present', () => {
@@ -849,6 +860,7 @@ describe('browserTracingIntegration', () => {
         public_key: 'examplePublicKey',
         sample_rate: '1',
         sampled: 'true',
+        sample_rand: expect.any(String),
         trace_id: expect.not.stringContaining('12312012123120121231201212312012'),
       });
 
@@ -861,7 +873,7 @@ describe('browserTracingIntegration', () => {
       // make sampled false here, so we can see that it's being used rather than the tracesSampleRate-dictated one
       document.head.innerHTML =
         '<meta name="sentry-trace" content="12312012123120121231201212312012-1121201211212012-1">' +
-        '<meta name="baggage" content="sentry-release=2.1.14,foo=bar">';
+        '<meta name="baggage" content="sentry-release=2.1.14,foo=bar,sentry-sample_rand=0.555">';
 
       const client = new BrowserClient(
         getDefaultBrowserClientOptions({
@@ -881,7 +893,7 @@ describe('browserTracingIntegration', () => {
         },
         {
           sentryTrace: '12312012123120121231201212312011-1121201211212011-1',
-          baggage: 'sentry-release=2.2.14,foo=bar',
+          baggage: 'sentry-release=2.2.14,foo=bar,sentry-sample_rand=0.123',
         },
       );
 
@@ -898,11 +910,12 @@ describe('browserTracingIntegration', () => {
       expect(spanIsSampled(idleSpan)).toBe(true);
 
       expect(dynamicSamplingContext).toBeDefined();
-      expect(dynamicSamplingContext).toStrictEqual({ release: '2.2.14' });
+      expect(dynamicSamplingContext).toStrictEqual({ release: '2.2.14', sample_rand: '0.123' });
 
       // Propagation context keeps the custom trace data for later events on the same route to add them to the trace
       expect(propagationContext.traceId).toEqual('12312012123120121231201212312011');
       expect(propagationContext.parentSpanId).toEqual('1121201211212011');
+      expect(propagationContext.sampleRand).toEqual(0.123);
     });
   });
 

packages/core/src/types-hoist/tracing.ts

@@ -17,7 +17,8 @@ export interface PropagationContext {
   traceId: string;
 
   /**
-   * TODO
+   * A random between 0 an 1 (including 0, excluding 1) used for sampling in the current execution context.
+   * This should be newly generated when a new trace is started.
    */
   sampleRand: number;
 

packages/core/test/lib/feedback.test.ts

@@ -262,6 +262,7 @@ describe('captureFeedback', () => {
       traceId,
       parentSpanId: spanId,
       dsc,
+      sampleRand: 0.42,
     });
 
     const eventId = captureFeedback({
@@ -351,6 +352,7 @@ describe('captureFeedback', () => {
           sampled: 'true',
           sample_rate: '1',
           transaction: 'test-span',
+          sample_rand: expect.any(String),
         },
       },
       [

packages/core/test/lib/prepareEvent.test.ts

@@ -238,6 +238,7 @@ describe('parseEventHintOrCaptureContext', () => {
       fingerprint: ['xx', 'yy'],
       propagationContext: {
         traceId: 'xxx',
+        sampleRand: Math.random(),
       },
     };
 
@@ -328,7 +329,7 @@ describe('prepareEvent', () => {
       tags: { tag1: 'aa', tag2: 'aa' },
       extra: { extra1: 'aa', extra2: 'aa' },
       contexts: { os: { name: 'os1' }, culture: { display_name: 'name1' } },
-      propagationContext: { traceId: '1' },
+      propagationContext: { traceId: '1', sampleRand: 0.42 },
       fingerprint: ['aa'],
     });
     scope.addBreadcrumb(breadcrumb1);

packages/core/test/lib/scope.test.ts

@@ -32,6 +32,7 @@ describe('Scope', () => {
       eventProcessors: [],
       propagationContext: {
         traceId: expect.any(String),
+        sampleRand: expect.any(Number),
       },
       sdkProcessingMetadata: {},
     });
@@ -57,6 +58,7 @@ describe('Scope', () => {
       eventProcessors: [],
       propagationContext: {
         traceId: expect.any(String),
+        sampleRand: expect.any(Number),
       },
       sdkProcessingMetadata: {},
     });
@@ -90,6 +92,7 @@ describe('Scope', () => {
       eventProcessors: [],
       propagationContext: {
         traceId: expect.any(String),
+        sampleRand: expect.any(Number),
       },
       sdkProcessingMetadata: {},
     });
@@ -101,6 +104,7 @@ describe('Scope', () => {
 
       expect(scope.getScopeData().propagationContext).toEqual({
         traceId: expect.any(String),
+        sampleRand: expect.any(Number),
         sampled: undefined,
         dsc: undefined,
         parentSpanId: undefined,
@@ -228,12 +232,14 @@ describe('Scope', () => {
       const oldPropagationContext = scope.getPropagationContext();
       scope.setPropagationContext({
         traceId: '86f39e84263a4de99c326acab3bfe3bd',
+        sampleRand: 0.42,
         sampled: true,
       });
       expect(scope.getPropagationContext()).not.toEqual(oldPropagationContext);
       expect(scope.getPropagationContext()).toEqual({
         traceId: '86f39e84263a4de99c326acab3bfe3bd',
         sampled: true,
+        sampleRand: 0.42,
       });
     });
 
@@ -293,6 +299,7 @@ describe('Scope', () => {
     expect(scope['_propagationContext']).toEqual({
       traceId: expect.any(String),
       sampled: undefined,
+      sampleRand: expect.any(Number),
     });
     expect(scope['_propagationContext']).not.toEqual(oldPropagationContext);
   });
@@ -420,6 +427,7 @@ describe('Scope', () => {
         propagationContext: {
           traceId: '8949daf83f4a4a70bee4c1eb9ab242ed',
           sampled: true,
+          sampleRand: 0.42,
         },
       };
 
@@ -446,6 +454,7 @@ describe('Scope', () => {
       expect(updatedScope._propagationContext).toEqual({
         traceId: '8949daf83f4a4a70bee4c1eb9ab242ed',
         sampled: true,
+        sampleRand: 0.42,
       });
     });
   });
@@ -493,7 +502,7 @@ describe('Scope', () => {
         tags: { tag1: 'aa', tag2: 'aa' },
         extra: { extra1: 'aa', extra2: 'aa' },
         contexts: { os: { name: 'os1' }, culture: { display_name: 'name1' } },
-        propagationContext: { traceId: '1' },
+        propagationContext: { traceId: '1', sampleRand: 0.42 },
         fingerprint: ['aa'],
       });
       scope.addBreadcrumb(breadcrumb1);

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

@@ -71,6 +71,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
       sample_rate: '0.56',
       trace_id: expect.stringMatching(/^[a-f0-9]{32}$/),
       transaction: 'tx',
+      sample_rand: expect.any(String),
     });
   });
 
@@ -88,6 +89,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
       sample_rate: '1',
       trace_id: expect.stringMatching(/^[a-f0-9]{32}$/),
       transaction: 'tx',
+      sample_rand: expect.any(String),
     });
   });
 
@@ -110,6 +112,7 @@ describe('getDynamicSamplingContextFromSpan', () => {
       sample_rate: '0.56',
       trace_id: expect.stringMatching(/^[a-f0-9]{32}$/),
       transaction: 'tx',
+      sample_rand: undefined, // this is a bit funky admittedly
     });
   });
 

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

@@ -473,6 +473,7 @@ describe('startSpan', () => {
         sample_rate: '1',
         transaction: 'outer transaction',
         sampled: 'true',
+        sample_rand: expect.any(String),
       },
     });
 
@@ -498,6 +499,7 @@ describe('startSpan', () => {
         sample_rate: '1',
         transaction: 'outer transaction',
         sampled: 'true',
+        sample_rand: expect.any(String),
       },
     });
   });
@@ -507,6 +509,7 @@ describe('startSpan', () => {
     withScope(scope => {
       scope.setPropagationContext({
         traceId: '99999999999999999999999999999999',
+        sampleRand: Math.random(),
         dsc: {},
         parentSpanId: '4242424242424242',
       });
@@ -902,6 +905,7 @@ describe('startSpanManual', () => {
         sample_rate: '1',
         transaction: 'outer transaction',
         sampled: 'true',
+        sample_rand: expect.any(String),
       },
     });
 
@@ -927,6 +931,7 @@ describe('startSpanManual', () => {
         sample_rate: '1',
         transaction: 'outer transaction',
         sampled: 'true',
+        sample_rand: expect.any(String),
       },
     });
   });
@@ -945,6 +950,7 @@ describe('startSpanManual', () => {
     withScope(scope => {
       scope.setPropagationContext({
         traceId: '99999999999999999999999999999991',
+        sampleRand: Math.random(),
         dsc: {},
         parentSpanId: '4242424242424242',
       });
@@ -1230,6 +1236,7 @@ describe('startInactiveSpan', () => {
         sample_rate: '1',
         transaction: 'outer transaction',
         sampled: 'true',
+        sample_rand: expect.any(String),
       },
     });
 
@@ -1255,6 +1262,7 @@ describe('startInactiveSpan', () => {
         sample_rate: '1',
         transaction: 'outer transaction',
         sampled: 'true',
+        sample_rand: expect.any(String),
       },
     });
   });
@@ -1269,6 +1277,7 @@ describe('startInactiveSpan', () => {
     withScope(scope => {
       scope.setPropagationContext({
         traceId: '99999999999999999999999999999991',
+        sampleRand: Math.random(),
         dsc: {},
         parentSpanId: '4242424242424242',
       });
@@ -1451,6 +1460,7 @@ describe('continueTrace', () => {
     expect(scope.getPropagationContext()).toEqual({
       sampled: undefined,
       traceId: expect.any(String),
+      sampleRand: expect.any(Number),
     });
 
     expect(scope.getScopeData().sdkProcessingMetadata).toEqual({});
@@ -1472,6 +1482,7 @@ describe('continueTrace', () => {
       sampled: false,
       parentSpanId: '1121201211212012',
       traceId: '12312012123120121231201212312012',
+      sampleRand: expect.any(Number),
     });
 
     expect(scope.getScopeData().sdkProcessingMetadata).toEqual({});
@@ -1492,10 +1503,12 @@ describe('continueTrace', () => {
       dsc: {
         environment: 'production',
         version: '1.0',
+        sample_rand: expect.any(String),
       },
       sampled: true,
       parentSpanId: '1121201211212012',
       traceId: '12312012123120121231201212312012',
+      sampleRand: expect.any(Number),
     });
 
     expect(scope.getScopeData().sdkProcessingMetadata).toEqual({});
@@ -1516,10 +1529,12 @@ describe('continueTrace', () => {
       dsc: {
         environment: 'production',
         version: '1.0',
+        sample_rand: expect.any(String),
       },
       sampled: true,
       parentSpanId: '1121201211212012',
       traceId: '12312012123120121231201212312012',
+      sampleRand: expect.any(Number),
     });
 
     expect(scope.getScopeData().sdkProcessingMetadata).toEqual({});