fix: Detect internal sentry requests

HazAT · kamilogorek · commit 4db1f1908ed2 · 2019-11-01T11:25:42.000+01:00
diff --git a/packages/core/src/api.ts b/packages/core/src/api.ts
@@ -28,7 +28,7 @@ export class API {
   public getStoreEndpointWithUrlEncodedAuth(): string {
     const dsn = this._dsnObject;
     const auth = {
-      sentry_key: dsn.user,
+      sentry_key: dsn.user, // sentry_key is currently used in tracing integration to identify internal sentry requests
       sentry_version: SENTRY_API_VERSION,
     };
     // Auth is intentionally sent as part of query string (NOT as custom HTTP header)
diff --git a/packages/hub/test/span.test.ts b/packages/hub/test/span.test.ts
@@ -23,6 +23,18 @@ describe('Span', () => {
       const from = Span.fromTraceparent('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-0') as any;
       expect(from.sampled).toBeFalsy();
     });
+
+    test('just sample rate', () => {
+      const from = Span.fromTraceparent('0') as any;
+      expect(from._traceId).toHaveLength(32);
+      expect(from._spanId).toHaveLength(16);
+      expect(from.sampled).toBeFalsy();
+
+      const from2 = Span.fromTraceparent('1') as any;
+      expect(from2._traceId).toHaveLength(32);
+      expect(from2._spanId).toHaveLength(16);
+      expect(from2.sampled).toBeTruthy();
+    });
   });
 
   test('fromTraceparent - invalid', () => {
diff --git a/packages/integrations/src/tracing.ts b/packages/integrations/src/tracing.ts
@@ -93,10 +93,16 @@ export class Tracing implements Integration {
             const url = self._xhrUrl;
             const headers = getCurrentHub().traceHeaders();
             // tslint:disable-next-line: prefer-for-of
-            const isWhitelisted = self._options.tracingOrigins.some((origin: string | RegExp) =>
+            let isWhitelisted = self._options.tracingOrigins.some((origin: string | RegExp) =>
               isMatchingPattern(url, origin),
             );
 
+            if (isMatchingPattern(url, 'sentry_key')) {
+              // If sentry_key is in the url, it's an internal store request to sentry
+              // we do not want to add the trace header to store requests
+              isWhitelisted = false;
+            }
+
             if (isWhitelisted && this.setRequestHeader) {
               Object.keys(headers).forEach(key => {
                 this.setRequestHeader(key, headers[key]);
@@ -121,30 +127,37 @@ export class Tracing implements Integration {
     fill(getGlobalObject<Window>(), 'fetch', function(originalFetch: () => void): () => void {
       return function(...args: any[]): void {
         // @ts-ignore
-        const self = getCurrentHub().getIntegration(Tracing);
+        const hub = getCurrentHub();
+        const self = hub.getIntegration(Tracing);
         if (self && self._options.tracingOrigins) {
           const url = args[0] as string;
           const options = (args[1] = (args[1] as { [key: string]: any }) || {});
 
-          let whiteListed = false;
+          let isWhitelisted = false;
           self._options.tracingOrigins.forEach((whiteListUrl: string | RegExp) => {
-            if (!whiteListed) {
-              whiteListed = isMatchingPattern(url, whiteListUrl);
+            if (!isWhitelisted) {
+              isWhitelisted = isMatchingPattern(url, whiteListUrl);
             }
           });
 
-          if (whiteListed) {
+          if (isMatchingPattern(url, 'sentry_key')) {
+            // If sentry_key is in the url, it's an internal store request to sentry
+            // we do not want to add the trace header to store requests
+            isWhitelisted = false;
+          }
+
+          if (isWhitelisted) {
             if (options.headers) {
               if (Array.isArray(options.headers)) {
-                options.headers = [...options.headers, ...Object.entries(getCurrentHub().traceHeaders())];
+                options.headers = [...options.headers, ...Object.entries(hub.traceHeaders())];
               } else {
                 options.headers = {
                   ...options.headers,
-                  ...getCurrentHub().traceHeaders(),
+                  ...hub.traceHeaders(),
                 };
               }
             } else {
-              options.headers = getCurrentHub().traceHeaders();
+              options.headers = hub.traceHeaders();
             }
           }
         }
