ref(utils): drop dsn toString class method

Author: JonasBa

packages/browser/src/transports/base.ts

@@ -14,6 +14,7 @@ import {
 } from '@sentry/types';
 import {
   dateTimestampInSeconds,
+  dsnToString,
   eventStatusFromHttpCode,
   getGlobalObject,
   logger,
@@ -116,7 +117,7 @@ export abstract class BaseTransport implements Transport {
 
     const url = getEnvelopeEndpointWithUrlEncodedAuth(this._api.dsn, this._api.tunnel);
     // Envelope header is required to be at least an empty object
-    const envelopeHeader = JSON.stringify({ ...(this._api.tunnel && { dsn: this._api.dsn.toString() }) });
+    const envelopeHeader = JSON.stringify({ ...(this._api.tunnel && { dsn: dsntoString(this._api.dsn) }) });
     const itemHeaders = JSON.stringify({
       type: 'client_report',
     });

packages/core/src/api.ts

@@ -174,7 +174,7 @@ export function getReportDialogEndpoint(
   const dsn = makeDsn(dsnLike);
   const endpoint = `${getBaseApiEndpoint(dsn)}embed/error-page/`;
 
-  let encodedOptions = `dsn=${dsn.toString()}`;
+  let encodedOptions = `dsn=${dsnToString(dsn)}`;
   for (const key in dialogOptions) {
     if (key === 'dsn') {
       continue;

packages/core/src/request.ts

@@ -33,7 +33,7 @@ export function sessionToSentryRequest(session: Session | SessionAggregates, api
   const envelopeHeaders = JSON.stringify({
     sent_at: new Date().toISOString(),
     ...(sdkInfo && { sdk: sdkInfo }),
-    ...(!!api.tunnel && { dsn: api.dsn.toString() }),
+    ...(!!api.tunnel && { dsn: dsnToString(api.dsn) }),
   });
   // I know this is hacky but we don't want to add `session` to request type since it's never rate limited
   const type: SentryRequestType = 'aggregates' in session ? ('sessions' as SentryRequestType) : 'session';
@@ -81,7 +81,7 @@ export function eventToSentryRequest(event: Event, api: APIDetails): SentryReque
       event_id: event.event_id,
       sent_at: new Date().toISOString(),
       ...(sdkInfo && { sdk: sdkInfo }),
-      ...(!!api.tunnel && { dsn: api.dsn.toString() }),
+      ...(!!api.tunnel && { dsn: dsnToString(api.dsn) }),
     });
     const itemHeaders = JSON.stringify({
       type: eventType,

packages/types/src/dsn.ts

@@ -23,17 +23,3 @@ export interface DsnComponents {
 
 /** Anything that can be parsed into a Dsn. */
 export type DsnLike = string | DsnComponents;
-
-/** The Sentry Dsn, identifying a Sentry instance and project. */
-export interface Dsn extends DsnComponents {
-  /**
-   * Renders the string representation of this Dsn.
-   *
-   * By default, this will render the public representation without the password
-   * component. To get the deprecated private representation, set `withPassword`
-   * to true.
-   *
-   * @param withPassword When set to true, the password will be included.
-   */
-  toString(withPassword?: boolean): string;
-}

packages/types/src/index.ts

@@ -1,7 +1,7 @@
 export { Breadcrumb, BreadcrumbHint } from './breadcrumb';
 export { Client } from './client';
 export { Context, Contexts } from './context';
-export { Dsn, DsnComponents, DsnLike, DsnProtocol } from './dsn';
+export { DsnComponents, DsnLike, DsnProtocol } from './dsn';
 export { DebugImage, DebugImageType, DebugMeta } from './debugMeta';
 export { ExtendedError } from './error';
 export { Event, EventHint } from './event';

packages/utils/src/dsn.ts

@@ -19,7 +19,7 @@ function isValidProtocol(protocol?: string): protocol is DsnProtocol {
  *
  * @param withPassword When set to true, the password will be included.
  */
-function dsntoString(dsn: Dsn, withPassword: boolean = false): string {
+export function dsnToString(dsn: Dsn, withPassword: boolean = false): string {
   const { host, path, pass, port, projectId, protocol, publicKey } = dsn;
   return (
     `${protocol}://${publicKey}${withPassword && pass ? `:${pass}` : ''}` +
@@ -72,28 +72,30 @@ function dsnFromComponents(components: DsnComponents): Dsn {
   };
 }
 
-function validateDsn(dsn: Dsn): boolean {
-  if (isDebugBuild()) {
-    const { port, projectId, protocol } = dsn;
+function validateDsn(dsn: Dsn): boolean | void {
+  if (!isDebugBuild()) {
+    return;
+  }
 
-    const requiredComponents: ReadonlyArray<keyof DsnComponents> = ['protocol', 'publicKey', 'host', 'projectId'];
-    requiredComponents.forEach(component => {
-      if (!dsn[component]) {
-        throw new SentryError(`Invalid Dsn: ${component} missing`);
-      }
-    });
+  const { port, projectId, protocol } = dsn;
 
-    if (!projectId.match(/^\d+$/)) {
-      throw new SentryError(`Invalid Dsn: Invalid projectId ${projectId}`);
+  const requiredComponents: ReadonlyArray<keyof DsnComponents> = ['protocol', 'publicKey', 'host', 'projectId'];
+  requiredComponents.forEach(component => {
+    if (!dsn[component]) {
+      throw new SentryError(`Invalid Dsn: ${component} missing`);
     }
+  });
 
-    if (!isValidProtocol(protocol)) {
-      throw new SentryError(`Invalid Dsn: Invalid protocol ${protocol}`);
-    }
+  if (!projectId.match(/^\d+$/)) {
+    throw new SentryError(`Invalid Dsn: Invalid projectId ${projectId}`);
+  }
 
-    if (port && isNaN(parseInt(port, 10))) {
-      throw new SentryError(`Invalid Dsn: Invalid port ${port}`);
-    }
+  if (!isValidProtocol(protocol)) {
+    throw new SentryError(`Invalid Dsn: Invalid protocol ${protocol}`);
+  }
+
+  if (port && isNaN(parseInt(port, 10))) {
+    throw new SentryError(`Invalid Dsn: Invalid port ${port}`);
   }
 
   return true;
@@ -105,10 +107,5 @@ export function makeDsn(from: DsnLike): Dsn {
 
   validateDsn(components);
 
-  const dsn: Dsn = {
-    ...components,
-    toString: (withPassword?: boolean) => dsntoString(dsn, withPassword),
-  };
-
-  return dsn;
+  return components;
 }

packages/utils/test/dsn.test.ts

@@ -1,6 +1,6 @@
 import { isDebugBuild } from '@sentry/utils';
 
-import { makeDsn } from '../src/dsn';
+import { makeDsn, dsnToString } from '../src/dsn';
 import { SentryError } from '../src/error';
 
 function testIf(condition: boolean): jest.It {
@@ -165,27 +165,27 @@ describe('Dsn', () => {
   describe('toString', () => {
     test('excludes the password by default', () => {
       const dsn = makeDsn('https://abc:[email protected]:1234/123');
-      expect(dsn.toString()).toBe('https://[email protected]:1234/123');
+      expect(dsnToString(dsn)).toBe('https://[email protected]:1234/123');
     });
 
     test('optionally includes the password', () => {
       const dsn = makeDsn('https://abc:[email protected]:1234/123');
-      expect(dsn.toString(true)).toBe('https://abc:[email protected]:1234/123');
+      expect(dsnToString(dsn, true)).toBe('https://abc:[email protected]:1234/123');
     });
 
     test('renders no password if missing', () => {
       const dsn = makeDsn('https://[email protected]:1234/123');
-      expect(dsn.toString(true)).toBe('https://[email protected]:1234/123');
+      expect(dsnToString(dsn, true)).toBe('https://[email protected]:1234/123');
     });
 
     test('renders no port if missing', () => {
       const dsn = makeDsn('https://[email protected]/123');
-      expect(dsn.toString()).toBe('https://[email protected]/123');
+      expect(dsnToString(dsn)).toBe('https://[email protected]/123');
     });
 
     test('renders the full path correctly', () => {
       const dsn = makeDsn('https://[email protected]/sentry/custom/installation/321');
-      expect(dsn.toString()).toBe('https://[email protected]/sentry/custom/installation/321');
+      expect(dsnToString(dsn)).toBe('https://[email protected]/sentry/custom/installation/321');
     });
   });
 });