ref: User API to filter sentry requests in breadcrumbs

Author: kamilogorek

packages/browser/src/integrations/breadcrumbs.ts

@@ -1,4 +1,4 @@
-import { Dsn } from '@sentry/core';
+import { API } from '@sentry/core';
 import { getCurrentHub } from '@sentry/hub';
 import { Integration, Severity } from '@sentry/types';
 import { isFunction, isString } from '@sentry/utils/is';
@@ -354,8 +354,7 @@ export class Breadcrumbs implements Integration {
    * Can be disabled or individually configured via the `autoBreadcrumbs` config option
    */
   public install(options: BrowserOptions = {}): void {
-    // TODO: Use API provider instead of raw `new Dsn`
-    const filterUrl = options.dsn && new Dsn(options.dsn).user;
+    const filterUrl = options.dsn && new API(options.dsn).getStoreEndpoint();
 
     if (this.config.console) {
       this.instrumentConsole();

packages/core/src/dsn.ts

@@ -2,7 +2,7 @@ import { DsnComponents, DsnLike, DsnProtocol } from '@sentry/types';
 import { SentryError } from './error';
 
 /** Regular expression used to parse a Dsn. */
-const Dsn_REGEX = /^(?:(\w+):)\/\/(?:(\w+)(?::(\w+))?@)([\w\.-]+)(?::(\d+))?\/(.+)/;
+const DSN_REGEX = /^(?:(\w+):)\/\/(?:(\w+)(?::(\w+))?@)([\w\.-]+)(?::(\d+))?\/(.+)/;
 
 /** The Sentry Dsn, identifying a Sentry instance and project. */
 export class Dsn implements DsnComponents {
@@ -52,7 +52,7 @@ export class Dsn implements DsnComponents {
 
   /** Parses a string into this Dsn. */
   private fromString(str: string): void {
-    const match = Dsn_REGEX.exec(str);
+    const match = DSN_REGEX.exec(str);
     if (!match) {
       throw new SentryError('Invalid Dsn');
     }

packages/core/test/lib/base.test.ts

@@ -4,7 +4,7 @@ import { SentryError } from '../../src/error';
 import { TestBackend } from '../mocks/backend';
 import { TestClient } from '../mocks/client';
 
-const PUBLIC_Dsn = 'https://username@domain/path';
+const PUBLIC_DSN = 'https://username@domain/path';
 
 jest.mock('@sentry/utils/misc', () => ({
   uuid4(): string {
@@ -24,8 +24,8 @@ jest.mock('@sentry/utils/string', () => ({
 describe('BaseClient', () => {
   describe('constructor() / getDsn()', () => {
     test('returns the Dsn', () => {
-      const client = new TestClient({ dsn: PUBLIC_Dsn });
-      expect(client.getDsn()!.toString()).toBe(PUBLIC_Dsn);
+      const client = new TestClient({ dsn: PUBLIC_DSN });
+      expect(client.getDsn()!.toString()).toBe(PUBLIC_DSN);
     });
 
     test('allows missing Dsn', () => {
@@ -40,13 +40,13 @@ describe('BaseClient', () => {
 
   describe('install()', () => {
     test('calls install() on Backend', async () => {
-      const client = new TestClient({ dsn: PUBLIC_Dsn });
+      const client = new TestClient({ dsn: PUBLIC_DSN });
       client.install();
       expect(TestBackend.instance!.installed).toBe(1);
     });
 
     test('calls install() only once', async () => {
-      const client = new TestClient({ dsn: PUBLIC_Dsn });
+      const client = new TestClient({ dsn: PUBLIC_DSN });
       client.install();
       client.install();
       expect(TestBackend.instance!.installed).toBe(1);
@@ -59,7 +59,7 @@ describe('BaseClient', () => {
     });
 
     test('does not install() when disabled', async () => {
-      const client = new TestClient({ enabled: false, dsn: PUBLIC_Dsn });
+      const client = new TestClient({ enabled: false, dsn: PUBLIC_DSN });
       client.install();
       expect(TestBackend.instance!.installed).toBe(0);
     });
@@ -73,7 +73,7 @@ describe('BaseClient', () => {
 
   describe('getOptions()', () => {
     test('returns the options', () => {
-      const options = { dsn: PUBLIC_Dsn, test: true };
+      const options = { dsn: PUBLIC_DSN, test: true };
       const client = new TestClient(options);
       expect(client.getOptions()).toEqual(options);
     });
@@ -142,7 +142,7 @@ describe('BaseClient', () => {
 
   describe('captures', () => {
     test('captures and sends exceptions', async () => {
-      const client = new TestClient({ dsn: PUBLIC_Dsn });
+      const client = new TestClient({ dsn: PUBLIC_DSN });
       const scope = new Scope();
       await client.captureException(new Error('test exception'), undefined, scope);
       expect(TestBackend.instance!.event).toEqual({
@@ -160,7 +160,7 @@ describe('BaseClient', () => {
     });
 
     test('captures and sends messages', async () => {
-      const client = new TestClient({ dsn: PUBLIC_Dsn });
+      const client = new TestClient({ dsn: PUBLIC_DSN });
       const scope = new Scope();
       await client.captureMessage('test message', undefined, undefined, scope);
       expect(TestBackend.instance!.event).toEqual({
@@ -172,7 +172,7 @@ describe('BaseClient', () => {
 
   describe('captureEvent() / prepareEvent()', () => {
     test('skips when disabled', async () => {
-      const client = new TestClient({ enabled: false, dsn: PUBLIC_Dsn });
+      const client = new TestClient({ enabled: false, dsn: PUBLIC_DSN });
       const scope = new Scope();
       await client.captureEvent({}, undefined, scope);
       expect(TestBackend.instance!.event).toBeUndefined();
@@ -186,7 +186,7 @@ describe('BaseClient', () => {
     });
 
     test('sends an event', async () => {
-      const client = new TestClient({ dsn: PUBLIC_Dsn });
+      const client = new TestClient({ dsn: PUBLIC_DSN });
       const scope = new Scope();
       await client.captureEvent({ message: 'message' }, undefined, scope);
       expect(TestBackend.instance!.event!.message).toBe('message');
@@ -198,7 +198,7 @@ describe('BaseClient', () => {
 
     test('adds the configured environment', async () => {
       const client = new TestClient({
-        dsn: PUBLIC_Dsn,
+        dsn: PUBLIC_DSN,
         environment: 'env',
       });
       const scope = new Scope();
@@ -212,7 +212,7 @@ describe('BaseClient', () => {
 
     test('adds the configured release', async () => {
       const client = new TestClient({
-        dsn: PUBLIC_Dsn,
+        dsn: PUBLIC_DSN,
         release: 'v1.0.0',
       });
       const scope = new Scope();
@@ -225,7 +225,7 @@ describe('BaseClient', () => {
     });
 
     test('adds breadcrumbs', async () => {
-      const client = new TestClient({ dsn: PUBLIC_Dsn });
+      const client = new TestClient({ dsn: PUBLIC_DSN });
       const scope = new Scope();
       scope.addBreadcrumb({ message: 'breadcrumb' }, 100);
       await client.captureEvent({ message: 'message' }, undefined, scope);
@@ -237,7 +237,7 @@ describe('BaseClient', () => {
     });
 
     test('limits previously saved breadcrumbs', async () => {
-      const client = new TestClient({ dsn: PUBLIC_Dsn, maxBreadcrumbs: 1 });
+      const client = new TestClient({ dsn: PUBLIC_DSN, maxBreadcrumbs: 1 });
       const scope = new Scope();
       scope.addBreadcrumb({ message: '1' }, 100);
       scope.addBreadcrumb({ message: '2' }, 200);
@@ -250,7 +250,7 @@ describe('BaseClient', () => {
     });
 
     test('adds context data', async () => {
-      const client = new TestClient({ dsn: PUBLIC_Dsn });
+      const client = new TestClient({ dsn: PUBLIC_DSN });
       const scope = new Scope();
       scope.setExtra('b', 'b');
       scope.setTag('a', 'a');
@@ -266,7 +266,7 @@ describe('BaseClient', () => {
     });
 
     test('adds fingerprint', async () => {
-      const client = new TestClient({ dsn: PUBLIC_Dsn });
+      const client = new TestClient({ dsn: PUBLIC_DSN });
       const scope = new Scope();
       scope.setFingerprint(['abcd']);
       await client.captureEvent({ message: 'message' }, undefined, scope);
@@ -279,22 +279,22 @@ describe('BaseClient', () => {
 
     test('calls beforeSend and discards the event', async () => {
       const beforeSend = jest.fn(() => null);
-      const client = new TestClient({ dsn: PUBLIC_Dsn, beforeSend });
+      const client = new TestClient({ dsn: PUBLIC_DSN, beforeSend });
       const scope = new Scope();
       await client.captureEvent({ message: 'hello' }, undefined, scope);
       expect(TestBackend.instance!.event).toBeUndefined();
     });
 
     test('calls beforeSend and uses the new one', async () => {
       const beforeSend = jest.fn(() => ({ message: 'changed' }));
-      const client = new TestClient({ dsn: PUBLIC_Dsn, beforeSend });
+      const client = new TestClient({ dsn: PUBLIC_DSN, beforeSend });
       const scope = new Scope();
       await client.captureEvent({ message: 'hello' }, undefined, scope);
       expect(TestBackend.instance!.event!.message).toBe('changed');
     });
 
     it("doesn't do anything with rate limits yet", async () => {
-      const client = new TestClient({ dsn: PUBLIC_Dsn });
+      const client = new TestClient({ dsn: PUBLIC_DSN });
       TestBackend.instance!.sendEvent = async () => ({ status: Status.RateLimit });
       const scope = new Scope();
       await client.captureEvent({}, undefined, scope);

packages/node/src/integrations/http.ts

@@ -112,12 +112,12 @@ function emitWrapper(origEmit: EventListener): (event: string, response: ServerR
       return origEmit.apply(this, arguments);
     }
 
-    const Dsn = getCurrentHub()
+    const dsn = getCurrentHub()
       .getClient()
       .getDsn();
 
     const isInterestingEvent = event === 'response' || event === 'error';
-    const isNotSentryRequest = Dsn && this.__ravenBreadcrumbUrl && !this.__ravenBreadcrumbUrl.includes(Dsn.host);
+    const isNotSentryRequest = dsn && this.__ravenBreadcrumbUrl && !this.__ravenBreadcrumbUrl.includes(dsn.host);
 
     if (isInterestingEvent && isNotSentryRequest) {
       addBreadcrumb({