add tracing enablement check to xhr and fetch callbacks

Author: lobsterkatie

packages/tracing/src/browser/request.ts

@@ -1,7 +1,8 @@
+import { getCurrentHub } from '@sentry/hub';
 import { addInstrumentationHandler, isInstanceOf, isMatchingPattern } from '@sentry/utils';
 
 import { Span } from '../span';
-import { getActiveTransaction } from '../utils';
+import { getActiveTransaction, hasTracingEnabled } from '../utils';
 
 export const DEFAULT_TRACING_ORIGINS = ['localhost', /^\//];
 
@@ -142,7 +143,13 @@ export function fetchCallback(
   shouldCreateSpan: (url: string) => boolean,
   spans: Record<string, Span>,
 ): void {
-  if (!handlerData.fetchData || !shouldCreateSpan(handlerData.fetchData.url)) {
+  const currentClientOptions = getCurrentHub()
+    .getClient()
+    ?.getOptions();
+  if (
+    !(currentClientOptions && hasTracingEnabled(currentClientOptions)) ||
+    !(handlerData.fetchData && shouldCreateSpan(handlerData.fetchData.url))
+  ) {
     return;
   }
 
@@ -209,19 +216,18 @@ export function xhrCallback(
   shouldCreateSpan: (url: string) => boolean,
   spans: Record<string, Span>,
 ): void {
-  if (!handlerData || !handlerData.xhr || !handlerData.xhr.__sentry_xhr__) {
+  const currentClientOptions = getCurrentHub()
+    .getClient()
+    ?.getOptions();
+  if (
+    !(currentClientOptions && hasTracingEnabled(currentClientOptions)) ||
+    !(handlerData.xhr && handlerData.xhr.__sentry_xhr__ && shouldCreateSpan(handlerData.xhr.__sentry_xhr__.url)) ||
+    handlerData.xhr.__sentry_own_request__
+  ) {
     return;
   }
 
   const xhr = handlerData.xhr.__sentry_xhr__;
-  if (!shouldCreateSpan(xhr.url)) {
-    return;
-  }
-
-  // We only capture complete, non-sentry requests
-  if (handlerData.xhr.__sentry_own_request__) {
-    return;
-  }
 
   // check first if the request has finished and is tracked by an existing span which should now end
   if (handlerData.endTimestamp && handlerData.xhr.__sentry_xhr_span_id__) {

packages/tracing/test/browser/request.test.ts

@@ -20,6 +20,7 @@ beforeAll(() => {
   global.Request = {};
 });
 
+const hasTracingEnabled = jest.spyOn(tracingUtils, 'hasTracingEnabled');
 const addInstrumentationHandler = jest.spyOn(utils, 'addInstrumentationHandler');
 const setRequestHeader = jest.fn();
 
@@ -108,6 +109,30 @@ describe('callbacks', () => {
       expect(spans).toEqual({});
     });
 
+    it('does not add fetch request spans if tracing is disabled', () => {
+      hasTracingEnabled.mockReturnValueOnce(false);
+      const spans = {};
+
+      fetchCallback(fetchHandlerData, alwaysCreateSpan, spans);
+      expect(spans).toEqual({});
+    });
+
+    it('does not add fetch request headers if tracing is disabled', () => {
+      hasTracingEnabled.mockReturnValueOnce(false);
+
+      // make a local copy so the global one doesn't get mutated
+      const handlerData: FetchData = {
+        args: ['http://dogs.are.great/', {}],
+        fetchData: { url: 'http://dogs.are.great/', method: 'GET' },
+        startTimestamp: 1353501072000,
+      };
+
+      fetchCallback(handlerData, alwaysCreateSpan, {});
+
+      const headers = (handlerData.args[1].headers as Record<string, string>) || {};
+      expect(headers['sentry-trace']).not.toBeDefined();
+    });
+
     it('creates and finishes fetch span on active transaction', () => {
       const spans = {};
 
@@ -174,6 +199,22 @@ describe('callbacks', () => {
       expect(spans).toEqual({});
     });
 
+    it('does not add xhr request spans if tracing is disabled', () => {
+      hasTracingEnabled.mockReturnValueOnce(false);
+      const spans = {};
+
+      xhrCallback(xhrHandlerData, alwaysCreateSpan, spans);
+      expect(spans).toEqual({});
+    });
+
+    it('does not add xhr request headers if tracing is disabled', () => {
+      hasTracingEnabled.mockReturnValueOnce(false);
+
+      xhrCallback(xhrHandlerData, alwaysCreateSpan, {});
+
+      expect(setRequestHeader).not.toHaveBeenCalled();
+    });
+
     it('adds sentry-trace header to XHR requests', () => {
       xhrCallback(xhrHandlerData, alwaysCreateSpan, {});