add tests

Author: lobsterkatie

packages/core/test/lib/request.test.ts

@@ -0,0 +1,40 @@
+import { Event } from '@sentry/types';
+
+import { API } from '../../src/api';
+import { eventToSentryRequest } from '../../src/request';
+
+describe('eventToSentryRequest', () => {
+  const api = new API('https://[email protected]/12312012');
+  const event: Event = {
+    contexts: { trace: { trace_id: '1231201211212012', span_id: '12261980', op: 'pageload' } },
+    environment: 'dogpark',
+    event_id: '0908201304152013',
+    release: 'off.leash.park',
+    spans: [],
+    transaction: '/dogs/are/great/',
+    type: 'transaction',
+    user: { id: '1121', username: 'CharlieDog', ip_address: '11.21.20.12' },
+  };
+
+  it('adds sampling information to transaction item header', () => {
+    event.tags = { __sentry_samplingMethod: 'client_rate', __sentry_sampleRate: '0.1121', dog: 'Charlie' };
+
+    const result = eventToSentryRequest(event as Event, api);
+
+    const [envelopeHeaderString, itemHeaderString, eventString] = result.body.split('\n');
+
+    const envelope = {
+      envelopeHeader: JSON.parse(envelopeHeaderString),
+      itemHeader: JSON.parse(itemHeaderString),
+      event: JSON.parse(eventString),
+    };
+
+    // the right stuff is added to the item header
+    expect(envelope.itemHeader).toEqual({ type: 'transaction', sample_rates: [{ id: 'client_rate', rate: '0.1121' }] });
+
+    // show that it pops the right tags and leaves the rest alone
+    expect('__sentry_samplingMethod' in envelope.event.tags).toBe(false);
+    expect('__sentry_sampleRate' in envelope.event.tags).toBe(false);
+    expect('dog' in envelope.event.tags).toBe(true);
+  });
+});

packages/tracing/test/hub.test.ts

@@ -171,7 +171,7 @@ describe('Hub', () => {
     });
 
     describe('sample()', () => {
-      it('should not sample transactions when tracing is disabled', () => {
+      it('should set sampled = false when tracing is disabled', () => {
         // neither tracesSampleRate nor tracesSampler is defined -> tracing disabled
         const hub = new Hub(new BrowserClient({}));
         const transaction = hub.startTransaction({ name: 'dogpark' });
@@ -219,7 +219,7 @@ describe('Hub', () => {
         expect(transaction.sampled).toBe(true);
       });
 
-      it('should not try to override positive sampling decision provided in transaction context', () => {
+      it('should not try to override explicitly set positive sampling decision', () => {
         // so that the decision otherwise would be false
         const tracesSampler = jest.fn().mockReturnValue(0);
         const hub = new Hub(new BrowserClient({ tracesSampler }));
@@ -228,7 +228,7 @@ describe('Hub', () => {
         expect(transaction.sampled).toBe(true);
       });
 
-      it('should not try to override negative sampling decision provided in transaction context', () => {
+      it('should not try to override explicitly set negative sampling decision', () => {
         // so that the decision otherwise would be true
         const tracesSampler = jest.fn().mockReturnValue(1);
         const hub = new Hub(new BrowserClient({ tracesSampler }));
@@ -255,6 +255,40 @@ describe('Hub', () => {
         expect(tracesSampler).toHaveBeenCalled();
         expect(transaction.sampled).toBe(true);
       });
+
+      it('should record sampling method when sampling decision is explicitly set', () => {
+        const tracesSampler = jest.fn().mockReturnValue(0.1121);
+        const hub = new Hub(new BrowserClient({ tracesSampler }));
+        const transaction = hub.startTransaction({ name: 'dogpark', sampled: true });
+
+        expect(transaction.tags).toEqual(expect.objectContaining({ __sentry_samplingMethod: 'explicitly_set' }));
+      });
+
+      it('should record sampling method and rate when sampling decision comes from tracesSampler', () => {
+        const tracesSampler = jest.fn().mockReturnValue(0.1121);
+        const hub = new Hub(new BrowserClient({ tracesSampler }));
+        const transaction = hub.startTransaction({ name: 'dogpark' });
+
+        expect(transaction.tags).toEqual(
+          expect.objectContaining({ __sentry_samplingMethod: 'client_sampler', __sentry_sampleRate: '0.1121' }),
+        );
+      });
+
+      it('should record sampling method when sampling decision is inherited', () => {
+        const hub = new Hub(new BrowserClient({ tracesSampleRate: 0.1121 }));
+        const transaction = hub.startTransaction({ name: 'dogpark', parentSampled: true });
+
+        expect(transaction.tags).toEqual(expect.objectContaining({ __sentry_samplingMethod: 'inheritance' }));
+      });
+
+      it('should record sampling method and rate when sampling decision comes from traceSampleRate', () => {
+        const hub = new Hub(new BrowserClient({ tracesSampleRate: 0.1121 }));
+        const transaction = hub.startTransaction({ name: 'dogpark' });
+
+        expect(transaction.tags).toEqual(
+          expect.objectContaining({ __sentry_samplingMethod: 'client_rate', __sentry_sampleRate: '0.1121' }),
+        );
+      });
     });
 
     describe('isValidSampleRate()', () => {