feat: Prefix all private methods with _

Mangle _ props

Author: HazAT

packages/browser/rollup.config.js

@@ -15,6 +15,9 @@ const terserInstance = terser({
     // We need those full names to correctly detect our internal frames for stripping.
     // I listed all of them here just for the clarity sake, as they are all used in the frames manipulation process.
     reserved: ['captureException', 'captureMessage', 'sentryWrapped'],
+    properties: {
+      regex: /^_/,
+    },
   },
 });
 

packages/browser/src/backend.ts

@@ -36,16 +36,18 @@ export class BrowserBackend extends BaseBackend<BrowserOptions> {
   /**
    * @inheritdoc
    */
-  protected setupTransport(): Transport {
-    if (!this.options.dsn) {
+  protected _setupTransport(): Transport {
+    if (!this._options.dsn) {
       // We return the noop transport here in case there is no Dsn.
-      return super.setupTransport();
+      return super._setupTransport();
     }
 
-    const transportOptions = this.options.transportOptions ? this.options.transportOptions : { dsn: this.options.dsn };
+    const transportOptions = this._options.transportOptions
+      ? this._options.transportOptions
+      : { dsn: this._options.dsn };
 
-    if (this.options.transport) {
-      return new this.options.transport(transportOptions);
+    if (this._options.transport) {
+      return new this._options.transport(transportOptions);
     } else if (supportsBeacon()) {
       return new BeaconTransport(transportOptions);
     } else if (supportsFetch()) {
@@ -65,7 +67,7 @@ export class BrowserBackend extends BaseBackend<BrowserOptions> {
       const errorEvent = exception as ErrorEvent;
       exception = errorEvent.error; // tslint:disable-line:no-parameter-reassignment
       event = eventFromStacktrace(computeStackTrace(exception as Error));
-      return SyncPromise.resolve(this.buildEvent(event, hint));
+      return SyncPromise.resolve(this._buildEvent(event, hint));
     } else if (isDOMError(exception as DOMError) || isDOMException(exception as DOMException)) {
       // If it is a DOMError or DOMException (which are legacy APIs, but still supported in some browsers)
       // then we just extract the name and message, as they don't provide anything else
@@ -77,12 +79,12 @@ export class BrowserBackend extends BaseBackend<BrowserOptions> {
 
       return this.eventFromMessage(message, Severity.Error, hint).then(messageEvent => {
         addExceptionTypeValue(messageEvent, message);
-        return SyncPromise.resolve(this.buildEvent(messageEvent, hint));
+        return SyncPromise.resolve(this._buildEvent(messageEvent, hint));
       });
     } else if (isError(exception as Error)) {
       // we have a real Error object, do nothing
       event = eventFromStacktrace(computeStackTrace(exception as Error));
-      return SyncPromise.resolve(this.buildEvent(event, hint));
+      return SyncPromise.resolve(this._buildEvent(event, hint));
     } else if (isPlainObject(exception as {}) && hint && hint.syntheticException) {
       // If it is plain Object, serialize it manually and extract options
       // This will allow us to group events based on top-level keys
@@ -94,7 +96,7 @@ export class BrowserBackend extends BaseBackend<BrowserOptions> {
         synthetic: true,
         type: 'generic',
       });
-      return SyncPromise.resolve(this.buildEvent(event, hint));
+      return SyncPromise.resolve(this._buildEvent(event, hint));
     }
 
     // If none of previous checks were valid, then it means that
@@ -110,14 +112,14 @@ export class BrowserBackend extends BaseBackend<BrowserOptions> {
         synthetic: true,
         type: 'generic',
       });
-      return SyncPromise.resolve(this.buildEvent(messageEvent, hint));
+      return SyncPromise.resolve(this._buildEvent(messageEvent, hint));
     });
   }
 
   /**
    * This is an internal helper function that creates an event.
    */
-  private buildEvent(event: Event, hint?: EventHint): Event {
+  private _buildEvent(event: Event, hint?: EventHint): Event {
     return {
       ...event,
       event_id: hint && hint.event_id,
@@ -134,7 +136,7 @@ export class BrowserBackend extends BaseBackend<BrowserOptions> {
       message,
     };
 
-    if (this.options.attachStacktrace && hint && hint.syntheticException) {
+    if (this._options.attachStacktrace && hint && hint.syntheticException) {
       const stacktrace = computeStackTrace(hint.syntheticException);
       const frames = prepareFramesForEvent(stacktrace.stack);
       event.stacktrace = {

packages/browser/src/client.ts

@@ -50,7 +50,7 @@ export class BrowserClient extends BaseClient<BrowserBackend, BrowserOptions> {
   /**
    * @inheritDoc
    */
-  protected prepareEvent(event: Event, scope?: Scope, hint?: EventHint): SyncPromise<Event | null> {
+  protected _prepareEvent(event: Event, scope?: Scope, hint?: EventHint): SyncPromise<Event | null> {
     event.platform = event.platform || 'javascript';
     event.sdk = {
       ...event.sdk,
@@ -65,7 +65,7 @@ export class BrowserClient extends BaseClient<BrowserBackend, BrowserOptions> {
       version: SDK_VERSION,
     };
 
-    return super.prepareEvent(event, scope, hint);
+    return super._prepareEvent(event, scope, hint);
   }
 
   /**
@@ -80,7 +80,7 @@ export class BrowserClient extends BaseClient<BrowserBackend, BrowserOptions> {
       return;
     }
 
-    if (!this.isEnabled()) {
+    if (!this._isEnabled()) {
       logger.error('Trying to call showReportDialog with Sentry Client is disabled');
       return;
     }

packages/browser/src/integrations/breadcrumbs.ts

@@ -48,13 +48,13 @@ export class Breadcrumbs implements Integration {
   public static id: string = 'Breadcrumbs';
 
   /** JSDoc */
-  private readonly options: BreadcrumbIntegrations;
+  private readonly _options: BreadcrumbIntegrations;
 
   /**
    * @inheritDoc
    */
   public constructor(options?: BreadcrumbIntegrations) {
-    this.options = {
+    this._options = {
       beacon: true,
       console: true,
       dom: true,
@@ -67,7 +67,7 @@ export class Breadcrumbs implements Integration {
   }
 
   /** JSDoc */
-  private instrumentBeacon(): void {
+  private _instrumentBeacon(): void {
     if (!supportsBeacon()) {
       return;
     }
@@ -117,7 +117,7 @@ export class Breadcrumbs implements Integration {
   }
 
   /** JSDoc */
-  private instrumentConsole(): void {
+  private _instrumentConsole(): void {
     if (!('console' in global)) {
       return;
     }
@@ -162,7 +162,7 @@ export class Breadcrumbs implements Integration {
   }
 
   /** JSDoc */
-  private instrumentDOM(): void {
+  private _instrumentDOM(): void {
     if (!('document' in global)) {
       return;
     }
@@ -173,7 +173,7 @@ export class Breadcrumbs implements Integration {
   }
 
   /** JSDoc */
-  private instrumentFetch(): void {
+  private _instrumentFetch(): void {
     if (!supportsNativeFetch()) {
       return;
     }
@@ -260,7 +260,7 @@ export class Breadcrumbs implements Integration {
   }
 
   /** JSDoc */
-  private instrumentHistory(): void {
+  private _instrumentHistory(): void {
     if (!supportsHistory()) {
       return;
     }
@@ -330,7 +330,7 @@ export class Breadcrumbs implements Integration {
   }
 
   /** JSDoc */
-  private instrumentXHR(): void {
+  private _instrumentXHR(): void {
     if (!('XMLHttpRequest' in global)) {
       return;
     }
@@ -471,23 +471,23 @@ export class Breadcrumbs implements Integration {
    *  - History API
    */
   public setupOnce(): void {
-    if (this.options.console) {
-      this.instrumentConsole();
+    if (this._options.console) {
+      this._instrumentConsole();
     }
-    if (this.options.dom) {
-      this.instrumentDOM();
+    if (this._options.dom) {
+      this._instrumentDOM();
     }
-    if (this.options.xhr) {
-      this.instrumentXHR();
+    if (this._options.xhr) {
+      this._instrumentXHR();
     }
-    if (this.options.fetch) {
-      this.instrumentFetch();
+    if (this._options.fetch) {
+      this._instrumentFetch();
     }
-    if (this.options.beacon) {
-      this.instrumentBeacon();
+    if (this._options.beacon) {
+      this._instrumentBeacon();
     }
-    if (this.options.history) {
-      this.instrumentHistory();
+    if (this._options.history) {
+      this._instrumentHistory();
     }
   }
 }

packages/browser/src/integrations/globalhandlers.ts

@@ -32,11 +32,11 @@ export class GlobalHandlers implements Integration {
   public static id: string = 'GlobalHandlers';
 
   /** JSDoc */
-  private readonly options: GlobalHandlersIntegrations;
+  private readonly _options: GlobalHandlersIntegrations;
 
   /** JSDoc */
   public constructor(options?: GlobalHandlersIntegrations) {
-    this.options = {
+    this._options = {
       onerror: true,
       onunhandledrejection: true,
       ...options,
@@ -68,16 +68,19 @@ export class GlobalHandlers implements Integration {
       }
       const self = getCurrentHub().getIntegration(GlobalHandlers);
       if (self) {
-        getCurrentHub().captureEvent(self.eventFromGlobalHandler(stack), { originalException: error, data: { stack } });
+        getCurrentHub().captureEvent(self._eventFromGlobalHandler(stack), {
+          data: { stack },
+          originalException: error,
+        });
       }
     });
 
-    if (this.options.onerror) {
+    if (this._options.onerror) {
       logger.log('Global Handler attached: onerror');
       installGlobalHandler();
     }
 
-    if (this.options.onunhandledrejection) {
+    if (this._options.onunhandledrejection) {
       logger.log('Global Handler attached: onunhandledrejection');
       installGlobalUnhandledRejectionHandler();
     }
@@ -88,7 +91,7 @@ export class GlobalHandlers implements Integration {
    *
    * @param stacktrace TraceKitStackTrace to be converted to an Event.
    */
-  private eventFromGlobalHandler(stacktrace: TraceKitStackTrace): Event {
+  private _eventFromGlobalHandler(stacktrace: TraceKitStackTrace): Event {
     const event = eventFromStacktrace(stacktrace);
 
     const data: { [key: string]: string } = {

packages/browser/src/integrations/linkederrors.ts

@@ -21,19 +21,19 @@ export class LinkedErrors implements Integration {
   /**
    * @inheritDoc
    */
-  private readonly key: string;
+  private readonly _key: string;
 
   /**
    * @inheritDoc
    */
-  private readonly limit: number;
+  private readonly _limit: number;
 
   /**
    * @inheritDoc
    */
   public constructor(options: { key?: string; limit?: number } = {}) {
-    this.key = options.key || DEFAULT_KEY;
-    this.limit = options.limit || DEFAULT_LIMIT;
+    this._key = options.key || DEFAULT_KEY;
+    this._limit = options.limit || DEFAULT_LIMIT;
   }
 
   /**
@@ -56,7 +56,7 @@ export class LinkedErrors implements Integration {
     if (!event.exception || !event.exception.values || !hint || !(hint.originalException instanceof Error)) {
       return event;
     }
-    const linkedErrors = this.walkErrorTree(hint.originalException, this.key);
+    const linkedErrors = this.walkErrorTree(hint.originalException, this._key);
     event.exception.values = [...linkedErrors, ...event.exception.values];
     return event;
   }
@@ -65,7 +65,7 @@ export class LinkedErrors implements Integration {
    * @inheritDoc
    */
   public walkErrorTree(error: ExtendedError, key: string, stack: Exception[] = []): Exception[] {
-    if (!(error[key] instanceof Error) || stack.length + 1 >= this.limit) {
+    if (!(error[key] instanceof Error) || stack.length + 1 >= this._limit) {
       return stack;
     }
     const stacktrace = computeStackTrace(error[key]);

packages/browser/src/integrations/trycatch.ts

@@ -6,7 +6,7 @@ import { breadcrumbEventHandler, keypressEventHandler, wrap } from './helpers';
 /** Wrap timer functions and event targets to catch errors and provide better meta data */
 export class TryCatch implements Integration {
   /** JSDoc */
-  private ignoreOnError: number = 0;
+  private _ignoreOnError: number = 0;
 
   /**
    * @inheritDoc
@@ -19,7 +19,7 @@ export class TryCatch implements Integration {
   public static id: string = 'TryCatch';
 
   /** JSDoc */
-  private wrapTimeFunction(original: () => void): () => number {
+  private _wrapTimeFunction(original: () => void): () => number {
     return function(this: any, ...args: any[]): number {
       const originalCallback = args[0];
       args[0] = wrap(originalCallback, {
@@ -34,7 +34,7 @@ export class TryCatch implements Integration {
   }
 
   /** JSDoc */
-  private wrapRAF(original: any): (callback: () => void) => any {
+  private _wrapRAF(original: any): (callback: () => void) => any {
     return function(this: any, callback: () => void): () => void {
       return original(
         wrap(callback, {
@@ -52,7 +52,7 @@ export class TryCatch implements Integration {
   }
 
   /** JSDoc */
-  private wrapEventTarget(target: string): void {
+  private _wrapEventTarget(target: string): void {
     const global = getGlobalObject() as { [key: string]: any };
     const proto = global[target] && global[target].prototype;
 
@@ -168,13 +168,13 @@ export class TryCatch implements Integration {
    * and provide better metadata.
    */
   public setupOnce(): void {
-    this.ignoreOnError = this.ignoreOnError;
+    this._ignoreOnError = this._ignoreOnError;
 
     const global = getGlobalObject();
 
-    fill(global, 'setTimeout', this.wrapTimeFunction.bind(this));
-    fill(global, 'setInterval', this.wrapTimeFunction.bind(this));
-    fill(global, 'requestAnimationFrame', this.wrapRAF.bind(this));
+    fill(global, 'setTimeout', this._wrapTimeFunction.bind(this));
+    fill(global, 'setInterval', this._wrapTimeFunction.bind(this));
+    fill(global, 'requestAnimationFrame', this._wrapRAF.bind(this));
 
     [
       'EventTarget',
@@ -206,7 +206,7 @@ export class TryCatch implements Integration {
       'XMLHttpRequest',
       'XMLHttpRequestEventTarget',
       'XMLHttpRequestUpload',
-    ].forEach(this.wrapEventTarget.bind(this));
+    ].forEach(this._wrapEventTarget.bind(this));
   }
 }
 

packages/browser/src/transports/base.ts

@@ -11,7 +11,7 @@ export abstract class BaseTransport implements Transport {
   public url: string;
 
   /** A simple buffer holding all requests. */
-  protected readonly buffer: PromiseBuffer<Response> = new PromiseBuffer(30);
+  protected readonly _buffer: PromiseBuffer<Response> = new PromiseBuffer(30);
 
   public constructor(public options: TransportOptions) {
     this.url = new API(this.options.dsn).getStoreEndpointWithUrlEncodedAuth();
@@ -28,6 +28,6 @@ export abstract class BaseTransport implements Transport {
    * @inheritDoc
    */
   public async close(timeout?: number): Promise<boolean> {
-    return this.buffer.drain(timeout);
+    return this._buffer.drain(timeout);
   }
 }