ref(utils): dsn

Author: JonasBa

packages/core/src/api.ts

@@ -1,5 +1,5 @@
 import { DsnLike, SdkMetadata } from '@sentry/types';
-import { Dsn, urlEncode } from '@sentry/utils';
+import { Dsn, makeDsn, urlEncode } from '@sentry/utils';
 
 const SENTRY_API_VERSION = '7';
 
@@ -40,7 +40,7 @@ export class API {
   /** Create a new instance of API */
   public constructor(dsn: DsnLike, metadata: SdkMetadata = {}, tunnel?: string) {
     this.dsn = dsn;
-    this._dsnObject = new Dsn(dsn);
+    this._dsnObject = makeDsn(dsn);
     this.metadata = metadata;
     this._tunnel = tunnel;
   }
@@ -89,7 +89,7 @@ export function initAPIDetails(dsn: DsnLike, metadata?: SdkMetadata, tunnel?: st
   return {
     initDsn: dsn,
     metadata: metadata || {},
-    dsn: new Dsn(dsn),
+    dsn: makeDsn(dsn),
     tunnel,
   } as APIDetails;
 }
@@ -171,7 +171,7 @@ export function getReportDialogEndpoint(
     user?: { name?: string; email?: string };
   },
 ): string {
-  const dsn = new Dsn(dsnLike);
+  const dsn = makeDsn(dsnLike);
   const endpoint = `${getBaseApiEndpoint(dsn)}embed/error-page/`;
 
   let encodedOptions = `dsn=${dsn.toString()}`;

packages/core/src/baseclient.ts

@@ -18,6 +18,7 @@ import {
   isPrimitive,
   isThenable,
   logger,
+  makeDsn,
   normalize,
   SentryError,
   SyncPromise,
@@ -93,7 +94,7 @@ export abstract class BaseClient<B extends Backend, O extends Options> implement
     this._options = options;
 
     if (options.dsn) {
-      this._dsn = new Dsn(options.dsn);
+      this._dsn = makeDsn(options.dsn);
     }
   }
 

packages/core/test/lib/api.test.ts

@@ -1,5 +1,5 @@
 /* eslint-disable deprecation/deprecation */
-import { Dsn } from '@sentry/utils';
+import { makeDsn } from '@sentry/utils';
 
 import { API, getReportDialogEndpoint, getRequestHeaders } from '../../src/api';
 
@@ -25,12 +25,12 @@ describe('API', () => {
   });
 
   test('getRequestHeaders', () => {
-    expect(getRequestHeaders(new Dsn(dsnPublic), 'a', '1.0')).toMatchObject({
+    expect(getRequestHeaders(makeDsn(dsnPublic), 'a', '1.0')).toMatchObject({
       'Content-Type': 'application/json',
       'X-Sentry-Auth': expect.stringMatching(/^Sentry sentry_version=\d, sentry_client=a\/1\.0, sentry_key=abc$/),
     });
 
-    expect(getRequestHeaders(new Dsn(legacyDsn), 'a', '1.0')).toMatchObject({
+    expect(getRequestHeaders(makeDsn(legacyDsn), 'a', '1.0')).toMatchObject({
       'Content-Type': 'application/json',
       'X-Sentry-Auth': expect.stringMatching(
         /^Sentry sentry_version=\d, sentry_client=a\/1\.0, sentry_key=abc, sentry_secret=123$/,
@@ -119,6 +119,6 @@ describe('API', () => {
   });
 
   test('getDsn', () => {
-    expect(new API(dsnPublic).getDsn()).toEqual(new Dsn(dsnPublic));
+    expect(new API(dsnPublic).getDsn()).toEqual(makeDsn(dsnPublic));
   });
 });

packages/node/src/backend.ts

@@ -3,10 +3,10 @@ import { Event, EventHint, Mechanism, SeverityLevel, Transport, TransportOptions
 import {
   addExceptionMechanism,
   addExceptionTypeValue,
-  Dsn,
   extractExceptionKeysForMessage,
   isError,
   isPlainObject,
+  makeDsn,
   normalizeToSize,
   SyncPromise,
 } from '@sentry/utils';
@@ -108,7 +108,7 @@ export class NodeBackend extends BaseBackend<NodeOptions> {
       return super._setupTransport();
     }
 
-    const dsn = new Dsn(this._options.dsn);
+    const dsn = makeDsn(this._options.dsn);
 
     const transportOptions: TransportOptions = {
       ...this._options.transportOptions,

packages/utils/src/dsn.ts

@@ -3,12 +3,14 @@ import { DsnComponents, DsnLike, DsnProtocol } from '@sentry/types';
 import { isDebugBuild } from './env';
 import { SentryError } from './error';
 
+export interface Dsn extends DsnComponents {
+  /** Protocol used to connect to Sentry. */
+  toString(withPassword: boolean): string;
+}
+
 /** Regular expression used to parse a Dsn. */
 const DSN_REGEX = /^(?:(\w+):)\/\/(?:(\w+)(?::(\w+))?@)([\w.-]+)(?::(\d+))?\/(.+)/;
 
-/** Error message */
-const ERROR_MESSAGE = 'Invalid Dsn';
-
 function isValidProtocol(protocol?: string): protocol is DsnProtocol {
   return protocol === 'http' || protocol === 'https';
 }
@@ -34,7 +36,7 @@ function dsnFromString(str: string): Dsn {
   const match = DSN_REGEX.exec(str);
 
   if (!match) {
-    throw new SentryError(ERROR_MESSAGE);
+    throw new SentryError('Invalid Dsn');
   }
 
   const [protocol, publicKey, pass = '', host, port = '', lastPath] = match.slice(1);
@@ -54,11 +56,7 @@ function dsnFromString(str: string): Dsn {
     }
   }
 
-  if (isValidProtocol(protocol)) {
-    return dsnFromComponents({ host, pass, path, projectId, port, protocol: protocol, publicKey });
-  }
-
-  throw new SentryError(ERROR_MESSAGE);
+  return dsnFromComponents({ host, pass, path, projectId, port, protocol: protocol as DsnProtocol, publicKey });
 }
 
 function dsnFromComponents(components: DsnComponents): Dsn {
@@ -83,55 +81,39 @@ function validateDsn(dsn: Dsn): boolean {
   if (isDebugBuild()) {
     const { port, projectId, protocol } = dsn;
 
-    ['protocol', 'publicKey', 'host', 'projectId'].forEach(component => {
+    const requiredComponents: ReadonlyArray<keyof DsnComponents> = ['protocol', 'publicKey', 'host', 'projectId'];
+    requiredComponents.forEach(component => {
       if (!dsn[component]) {
-        throw new SentryError(`${ERROR_MESSAGE}: ${component} missing`);
+        throw new SentryError(`Invalid Dsn: ${component} missing`);
       }
     });
 
     if (!projectId.match(/^\d+$/)) {
-      throw new SentryError(`${ERROR_MESSAGE}: Invalid projectId ${projectId}`);
+      throw new SentryError(`Invalid Dsn: Invalid projectId ${projectId}`);
     }
 
     if (isValidProtocol(protocol)) {
-      throw new SentryError(`${ERROR_MESSAGE}: Invalid protocol ${protocol}`);
+      throw new SentryError(`Invalid Dsn: Invalid protocol ${protocol}`);
     }
 
     if (port && isNaN(parseInt(port, 10))) {
-      throw new SentryError(`${ERROR_MESSAGE}: Invalid port ${port}`);
+      throw new SentryError(`Invalid Dsn: Invalid port ${port}`);
     }
   }
 
   return true;
 }
 
-function makeDsn(from: DsnLike): Dsn {
-  let dsn = typeof from === 'string' ? dsnFromString(from) : dsnFromComponents(from);
+/** The Sentry Dsn, identifying a Sentry instance and project. */
+export function makeDsn(from: DsnLike): Dsn {
+  const components = typeof from === 'string' ? dsnFromString(from) : dsnFromComponents(from);
 
-  return {
-    ...dsn,
-    toString: () => dsntoString(dsn),
+  validateDsn(components);
+
+  const dsn: Dsn = {
+    ...components,
+    toString: (withPassword: boolean) => dsntoString(dsn),
   };
-}
-/** The Sentry Dsn, identifying a Sentry instance and project. */
-export class Dsn implements DsnComponents {
-  /** Protocol used to connect to Sentry. */
-  public protocol!: DsnProtocol;
-  /** Public authorization key (deprecated, renamed to publicKey). */
-  public user!: string;
-  /** Public authorization key. */
-  public publicKey!: string;
-  /** Private authorization key (deprecated, optional). */
-  public pass!: string;
-  /** Hostname of the Sentry instance. */
-  public host!: string;
-  /** Port of the Sentry instance. */
-  public port!: string;
-  /** Path */
-  public path!: string;
-  /** Project ID */
-  public projectId!: string;
-
-  /** Creates a new Dsn component */
-  public constructor(from: DsnLike) {}
+
+  return dsn;
 }