ref: Move common integrations to the core package

Author: kamilogorek

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Unreleased
 
 - [browser] feat: Better dedupe integration event description
+- [core] ref: Move Dedupe, FunctionString, InboundFilters and SdkInformation integrations to the core package
 
 ## 4.0.2
 

packages/browser/src/backend.ts

@@ -11,12 +11,6 @@ import { BeaconTransport, FetchTransport, XHRTransport } from './transports';
  * @see BrowserClient for more information.
  */
 export interface BrowserOptions extends Options {
-  /**
-   * A pattern for error messages which should not be sent to Sentry. By
-   * default, all errors will be sent.
-   */
-  ignoreErrors?: Array<string | RegExp>;
-
   /**
    * A pattern for error URLs which should not be sent to Sentry.
    * To whitelist certain errors instead, use {@link Options.whitelistUrls}.

packages/browser/src/integrations/index.ts

@@ -1,11 +1,7 @@
 export { GlobalHandlers } from './globalhandlers';
-export { Dedupe } from './dedupe';
-export { FunctionToString } from './functiontostring';
 export { TryCatch } from './trycatch';
 export { Breadcrumbs } from './breadcrumbs';
 export { LinkedErrors } from './linkederrors';
-export { SDKInformation } from './sdkinformation';
-export { InboundFilters } from './inboundfilters';
 export { ReportingObserver } from './reportingobserver';
 
 export { Ember } from './pluggable/ember';

packages/browser/src/sdk.ts

@@ -1,29 +1,28 @@
-import { getCurrentHub, initAndBind } from '@sentry/core';
+import { getCurrentHub, initAndBind, Integrations as CoreIntegrations } from '@sentry/core';
 import { DsnLike } from '@sentry/types';
 import { BrowserOptions } from './backend';
 import { BrowserClient } from './client';
-import {
-  Breadcrumbs,
-  Dedupe,
-  FunctionToString,
-  GlobalHandlers,
-  InboundFilters,
-  LinkedErrors,
-  ReportingObserver,
-  SDKInformation,
-  TryCatch,
-} from './integrations';
+import { Breadcrumbs, GlobalHandlers, LinkedErrors, ReportingObserver, TryCatch } from './integrations';
+import { SDK_NAME, SDK_VERSION } from './version';
 
 export const defaultIntegrations = [
-  new Dedupe(),
-  new FunctionToString(),
+  // Common
+  new CoreIntegrations.Dedupe(),
+  new CoreIntegrations.InboundFilters(),
+  new CoreIntegrations.FunctionToString(),
+  new CoreIntegrations.SDKInformation({
+    name: 'npm:@sentry/browser',
+    sdkName: SDK_NAME,
+    sdkVersion: SDK_VERSION,
+  }),
+  // Native Wrappers
   new TryCatch(),
   new Breadcrumbs(),
+  // Global Handlers
   new GlobalHandlers(),
-  new LinkedErrors(),
   new ReportingObserver(),
-  new SDKInformation(),
-  new InboundFilters(),
+  // Misc
+  new LinkedErrors(),
 ];
 
 /**

packages/core/src/integrations/dedupe.ts

@@ -0,0 +1,208 @@
+import { configureScope } from '@sentry/minimal';
+import { Integration, SentryEvent, SentryException, StackFrame } from '@sentry/types';
+import { getEventDescription } from '@sentry/utils/misc';
+import { logger } from '../logger';
+
+/** Deduplication filter */
+export class Dedupe implements Integration {
+  /**
+   * @inheritDoc
+   */
+  private previousEvent?: SentryEvent;
+
+  /**
+   * @inheritDoc
+   */
+  public name: string = 'Dedupe';
+
+  /**
+   * @inheritDoc
+   */
+  public install(): void {
+    configureScope(scope => {
+      scope.addEventProcessor(async (currentEvent: SentryEvent) => {
+        // Juuust in case something goes wrong
+        try {
+          if (this.shouldDropEvent(currentEvent, this.previousEvent)) {
+            return null;
+          }
+        } catch (_oO) {
+          return (this.previousEvent = currentEvent);
+        }
+
+        return (this.previousEvent = currentEvent);
+      });
+    });
+  }
+
+  /** JSDoc */
+  public shouldDropEvent(currentEvent: SentryEvent, previousEvent?: SentryEvent): boolean {
+    if (!previousEvent) {
+      return false;
+    }
+
+    if (this.isSameMessageEvent(currentEvent, previousEvent)) {
+      logger.warn(
+        `Event dropped due to being a duplicate of previous event (same message).\nEvent: ${getEventDescription(
+          currentEvent,
+        )}`,
+      );
+      return true;
+    }
+
+    if (this.isSameExceptionEvent(currentEvent, previousEvent)) {
+      logger.warn(
+        `Event dropped due to being a duplicate of previous event (same exception).\nEvent: ${getEventDescription(
+          currentEvent,
+        )}`,
+      );
+      return true;
+    }
+
+    return false;
+  }
+
+  /** JSDoc */
+  private isSameMessageEvent(currentEvent: SentryEvent, previousEvent: SentryEvent): boolean {
+    const currentMessage = currentEvent.message;
+    const previousMessage = previousEvent.message;
+
+    // If no event has a message, they were both exceptions, so bail out
+    if (!currentMessage && !previousMessage) {
+      return false;
+    }
+
+    // If only one event has a stacktrace, but not the other one, they are not the same
+    if ((currentMessage && !previousMessage) || (!currentMessage && previousMessage)) {
+      return false;
+    }
+
+    if (currentMessage !== previousMessage) {
+      return false;
+    }
+
+    if (!this.isSameFingerprint(currentEvent, previousEvent)) {
+      return false;
+    }
+
+    if (!this.isSameStacktrace(currentEvent, previousEvent)) {
+      return false;
+    }
+
+    return true;
+  }
+
+  /** JSDoc */
+  private getFramesFromEvent(event: SentryEvent): StackFrame[] | undefined {
+    const exception = event.exception;
+
+    if (exception) {
+      try {
+        // @ts-ignore
+        return exception.values[0].stacktrace.frames;
+      } catch (_oO) {
+        return undefined;
+      }
+    } else if (event.stacktrace) {
+      return event.stacktrace.frames;
+    } else {
+      return undefined;
+    }
+  }
+
+  /** JSDoc */
+  private isSameStacktrace(currentEvent: SentryEvent, previousEvent: SentryEvent): boolean {
+    let currentFrames = this.getFramesFromEvent(currentEvent);
+    let previousFrames = this.getFramesFromEvent(previousEvent);
+
+    // If no event has a fingerprint, they are assumed to be the same
+    if (!currentFrames && !previousFrames) {
+      return true;
+    }
+
+    // If only one event has a stacktrace, but not the other one, they are not the same
+    if ((currentFrames && !previousFrames) || (!currentFrames && previousFrames)) {
+      return false;
+    }
+
+    currentFrames = currentFrames as StackFrame[];
+    previousFrames = previousFrames as StackFrame[];
+
+    // If number of frames differ, they are not the same
+    if (previousFrames.length !== currentFrames.length) {
+      return false;
+    }
+
+    // Otherwise, compare the two
+    for (let i = 0; i < previousFrames.length; i++) {
+      const frameA = previousFrames[i];
+      const frameB = currentFrames[i];
+
+      if (
+        frameA.filename !== frameB.filename ||
+        frameA.lineno !== frameB.lineno ||
+        frameA.colno !== frameB.colno ||
+        frameA.function !== frameB.function
+      ) {
+        return false;
+      }
+    }
+
+    return true;
+  }
+
+  /** JSDoc */
+  private getExceptionFromEvent(event: SentryEvent): SentryException | undefined {
+    return event.exception && event.exception.values && event.exception.values[0];
+  }
+
+  /** JSDoc */
+  private isSameExceptionEvent(currentEvent: SentryEvent, previousEvent: SentryEvent): boolean {
+    const previousException = this.getExceptionFromEvent(previousEvent);
+    const currentException = this.getExceptionFromEvent(currentEvent);
+
+    if (!previousException || !currentException) {
+      return false;
+    }
+
+    if (previousException.type !== currentException.type || previousException.value !== currentException.value) {
+      return false;
+    }
+
+    if (!this.isSameFingerprint(currentEvent, previousEvent)) {
+      return false;
+    }
+
+    if (!this.isSameStacktrace(currentEvent, previousEvent)) {
+      return false;
+    }
+
+    return true;
+  }
+
+  /** JSDoc */
+  private isSameFingerprint(currentEvent: SentryEvent, previousEvent: SentryEvent): boolean {
+    let currentFingerprint = currentEvent.fingerprint;
+    let previousFingerprint = previousEvent.fingerprint;
+
+    // If no event has a fingerprint, they are assumed to be the same
+    if (!currentFingerprint && !previousFingerprint) {
+      return true;
+    }
+
+    // If only one event has a fingerprint, but not the other one, they are not the same
+    if ((currentFingerprint && !previousFingerprint) || (!currentFingerprint && previousFingerprint)) {
+      return false;
+    }
+
+    currentFingerprint = currentFingerprint as string[];
+    previousFingerprint = previousFingerprint as string[];
+
+    // Otherwise, compare the two
+    try {
+      return !!(currentFingerprint.join('') === previousFingerprint.join(''));
+    } catch (_oO) {
+      return false;
+    }
+  }
+}

packages/browser/src/integrations/functiontostring.ts renamed to packages/core/src/integrations/functiontostring.ts

@@ -16,6 +16,7 @@ export class FunctionToString implements Integration {
 
     Function.prototype.toString = function(this: SentryWrappedFunction, ...args: any[]): string {
       const context = this.__sentry__ ? this.__sentry_original__ : this;
+      // tslint:disable-next-line:no-unsafe-any
       return originalFunctionToString.apply(context, args);
     };
   }

packages/browser/src/integrations/inboundfilters.ts renamed to packages/core/src/integrations/inboundfilters.ts

@@ -1,13 +1,20 @@
-import { configureScope, logger } from '@sentry/core';
+import { configureScope } from '@sentry/minimal';
 import { Integration, SentryEvent } from '@sentry/types';
 import { isRegExp } from '@sentry/utils/is';
 import { getEventDescription } from '@sentry/utils/misc';
-import { BrowserOptions } from '../backend';
+import { logger } from '../logger';
 
 // "Script error." is hard coded into browsers for errors that it can't read.
 // this is the result of a script being pulled in from an external domain and CORS.
 const DEFAULT_IGNORE_ERRORS = [/^Script error\.?$/, /^Javascript error: Script error\.? on line 0$/];
 
+/** JSDoc */
+interface InboundFiltersOptions {
+  ignoreErrors?: Array<string | RegExp>;
+  blacklistUrls?: Array<string | RegExp>;
+  whitelistUrls?: Array<string | RegExp>;
+}
+
 /** Inbound filters configurable by the user */
 export class InboundFilters implements Integration {
   /** JSDoc */
@@ -24,7 +31,7 @@ export class InboundFilters implements Integration {
   /**
    * @inheritDoc
    */
-  public install(options: BrowserOptions = {}): void {
+  public install(options: InboundFiltersOptions = {}): void {
     this.configureOptions(options);
 
     configureScope(scope => {
@@ -108,7 +115,7 @@ export class InboundFilters implements Integration {
   }
 
   /** JSDoc */
-  private configureOptions(options: BrowserOptions): void {
+  private configureOptions(options: InboundFiltersOptions): void {
     if (options.ignoreErrors) {
       this.ignoreErrors = [...DEFAULT_IGNORE_ERRORS, ...options.ignoreErrors];
     }
@@ -122,13 +129,12 @@ export class InboundFilters implements Integration {
 
   /** JSDoc */
   private getPossibleEventMessages(event: SentryEvent): string[] {
-    const evt = event as any;
-
-    if (evt.message) {
-      return [evt.message];
-    } else if (evt.exception) {
+    if (event.message) {
+      return [event.message];
+    } else if (event.exception) {
       try {
-        const { type, value } = evt.exception.values[0];
+        // tslint:disable-next-line:no-unsafe-any
+        const { type, value } = (event as any).exception.values[0];
         return [`${value}`, `${type}: ${value}`];
       } catch (oO) {
         logger.error(`Cannot extract message for event ${getEventDescription(event)}`);
@@ -141,13 +147,13 @@ export class InboundFilters implements Integration {
 
   /** JSDoc */
   private getEventFilterUrl(event: SentryEvent): string | null {
-    const evt = event as any;
-
     try {
-      if (evt.stacktrace) {
-        return evt.stacktrace.frames[0].filename;
-      } else if (evt.exception) {
-        return evt.exception.values[0].stacktrace.frames[0].filename;
+      if (event.stacktrace) {
+        // tslint:disable-next-line:no-unsafe-any
+        return (event as any).stacktrace.frames[0].filename;
+      } else if (event.exception) {
+        // tslint:disable-next-line:no-unsafe-any
+        return (event as any).exception.values[0].stacktrace.frames[0].filename;
       } else {
         return null;
       }

packages/core/src/integrations/index.ts

@@ -1 +1,6 @@
+export { Dedupe } from './dedupe';
+export { FunctionToString } from './functiontostring';
+export { SDKInformation } from './sdkinformation';
+export { InboundFilters } from './inboundfilters';
+
 export { Debug } from './pluggable/debug';