WIP - Removed error parser service, Added default plugin for Simple Errors

Author: niemyjski

packages/browser/package.json

@@ -47,7 +47,7 @@
   "scripts": {
     "build": "tsc -p tsconfig.json && esbuild src/index.ts --bundle --sourcemap --target=es2017 --format=esm --outfile=dist/index.bundle.js && esbuild src/index.ts --bundle --minify --sourcemap --target=es2019 --format=esm --outfile=dist/index.bundle.min.js",
     "watch": "tsc -p ../core/tsconfig.json -w --preserveWatchOutput & tsc -p tsconfig.json -w --preserveWatchOutput & esbuild src/index.ts --bundle --sourcemap --target=es2017 --format=esm --watch --outfile=dist/index.bundle.js",
-    "test": ""
+    "test": "jest"
   },
   "sideEffects": false,
   "publishConfig": {

packages/browser/src/BrowserExceptionlessClient.ts

@@ -1,11 +1,11 @@
-import { Configuration, ExceptionlessClient } from "@exceptionless/core";
+import { Configuration, ExceptionlessClient, SimpleErrorPlugin } from "@exceptionless/core";
 
+import { BrowserErrorPlugin } from "./plugins/BrowserErrorPlugin.js";
 import { BrowserGlobalHandlerPlugin } from "./plugins/BrowserGlobalHandlerPlugin.js";
 import { BrowserLifeCyclePlugin } from "./plugins/BrowserLifeCyclePlugin.js";
 import { BrowserModuleInfoPlugin } from "./plugins/BrowserModuleInfoPlugin.js";
 import { BrowserRequestInfoPlugin } from "./plugins/BrowserRequestInfoPlugin.js";
 import { BrowserWrapFunctions } from "./plugins/BrowserWrapFunctions.js";
-import { BrowserErrorParser } from "./services/BrowserErrorParser.js";
 
 export class BrowserExceptionlessClient extends ExceptionlessClient {
   public async startup(
@@ -14,13 +14,15 @@ export class BrowserExceptionlessClient extends ExceptionlessClient {
     const config = this.config;
     if (configurationOrApiKey) {
       config.useLocalStorage();
-      config.services.errorParser = new BrowserErrorParser();
 
       config.addPlugin(new BrowserGlobalHandlerPlugin());
       config.addPlugin(new BrowserLifeCyclePlugin());
       config.addPlugin(new BrowserModuleInfoPlugin());
       config.addPlugin(new BrowserRequestInfoPlugin());
       config.addPlugin(new BrowserWrapFunctions());
+
+      config.removePlugin(new SimpleErrorPlugin());
+      config.addPlugin(new BrowserErrorPlugin());
     }
 
     await super.startup(configurationOrApiKey);

packages/browser/src/index.ts

@@ -1,9 +1,9 @@
+export { BrowserErrorPlugin } from "./plugins/BrowserErrorPlugin.js"
 export { BrowserGlobalHandlerPlugin } from "./plugins/BrowserGlobalHandlerPlugin.js";
 export { BrowserLifeCyclePlugin } from "./plugins/BrowserLifeCyclePlugin.js";
 export { BrowserModuleInfoPlugin } from "./plugins/BrowserModuleInfoPlugin.js";
 export { BrowserRequestInfoPlugin } from "./plugins/BrowserRequestInfoPlugin.js";
 export { BrowserWrapFunctions } from "./plugins/BrowserWrapFunctions.js";
-export { BrowserErrorParser } from "./services/BrowserErrorParser.js";
 export { BrowserExceptionlessClient } from "./BrowserExceptionlessClient.js";
 
 import { BrowserExceptionlessClient } from "./BrowserExceptionlessClient.js";

packages/browser/src/services/BrowserErrorParser.ts renamed to packages/browser/src/plugins/BrowserErrorPlugin.ts

@@ -1,18 +1,48 @@
 import {
-  EventPluginContext,
   ErrorInfo,
-  IErrorParser,
+  EventPluginContext,
+  IEventPlugin,
+  IgnoredErrorProperties,
+  KnownEventDataKeys,
   ParameterInfo,
-  StackFrameInfo
+  StackFrameInfo,
+  stringify,
+  isEmpty
 } from "@exceptionless/core";
 
 import {
   fromError,
   StackFrame
 } from "stacktrace-js";
 
-export class BrowserErrorParser implements IErrorParser {
-  public async parse(context: EventPluginContext, exception: Error): Promise<ErrorInfo> {
+export class BrowserErrorPlugin implements IEventPlugin {
+  public priority = 30;
+  public name = "BrowserErrorPlugin";
+
+  public async run(context: EventPluginContext): Promise<void> {
+    const exception = context.eventContext.getException();
+    if (exception) {
+      context.event.type = "error";
+
+      if (!context.event.data[KnownEventDataKeys.Error]) {
+        const result = await this.parse(exception);
+        if (result) {
+          const exclusions = context.client.config.dataExclusions.concat(IgnoredErrorProperties);
+          const additionalData = JSON.parse(stringify(exception, exclusions));
+          if (!isEmpty(additionalData)) {
+            if (!result.data) {
+              result.data = {};
+            }
+            result.data["@ext"] = additionalData;
+          }
+
+          context.event.data[KnownEventDataKeys.Error] = result;
+        }
+      }
+    }
+  }
+
+  private async parse(exception: Error): Promise<ErrorInfo> {
     function getParameters(parameters: string | string[]): ParameterInfo[] {
       const params: string[] = (typeof parameters === "string" ? [parameters] : parameters) || [];
 

packages/core/test/plugins/default/ErrorPlugin.test.ts renamed to packages/browser/test/plugins/BrowserErrorPlugin.test.ts

@@ -1,9 +1,8 @@
-import { ErrorPlugin } from "../../../src/plugins/default/ErrorPlugin.js";
-import { EventPluginContext } from "../../../src/plugins/EventPluginContext.js";
-import { Event, KnownEventDataKeys } from "../../../src/models/Event.js";
-import { CapturedExceptions } from "./exceptions.js";
-import { createFixture } from "./EventPluginTestFixture.js";
-import { ErrorInfo } from "../../../src/models/data/ErrorInfo.js";
+import { BrowserErrorPlugin } from "../../src/plugins/BrowserErrorPlugin.js";
+import { EventPluginContext } from "./../../../core/src/plugins/EventPluginContext.js";
+import { Event, KnownEventDataKeys } from "./../../../core/src/models/Event.js";
+import { CapturedExceptions } from "./../../../core/test/plugins/default/exceptions.js";
+import { ErrorInfo } from "./../../../core/src/models/data/ErrorInfo.js";
 
 function BaseTestError() {
   this.name = "NotImplementedError";
@@ -18,8 +17,8 @@ function DerivedTestError() {
 
 DerivedTestError.prototype = new BaseTestError();
 
-describe("ErrorPlugin", () => {
-  const target = new ErrorPlugin();
+describe("BrowserErrorPlugin", () => {
+  const target = new BrowserErrorPlugin();
   let context: EventPluginContext;
 
   beforeEach(() => {
@@ -110,3 +109,21 @@ function throwAndCatch(error: any): Error {
     return exception;
   }
 }
+
+function createFixture(): EventPluginContext {
+  const errorParser: IErrorParser = {
+    parse: (c: EventPluginContext, exception: Error) => Promise.resolve({
+      type: exception.name,
+      message: exception.message,
+      stack_trace: null
+    })
+  };
+  const client: ExceptionlessClient = new ExceptionlessClient();
+  client.config.services.errorParser = errorParser;
+
+  const event: Event = {
+    data: {}
+  };
+
+  return new EventPluginContext(client, event);
+}

packages/core/src/configuration/Configuration.ts

@@ -10,7 +10,6 @@ import { EventPluginContext } from "../plugins/EventPluginContext.js";
 import { IEventPlugin } from "../plugins/IEventPlugin.js";
 import { DefaultEventQueue } from "../queue/DefaultEventQueue.js";
 import { IEventQueue } from "../queue/IEventQueue.js";
-import { IErrorParser } from "../services/IErrorParser.js";
 import { ISubmissionClient } from "../submission/ISubmissionClient.js";
 import { DefaultSubmissionClient } from "../submission/DefaultSubmissionClient.js";
 import { guid } from "../Utils.js";
@@ -543,7 +542,6 @@ export class Configuration {
 }
 
 interface IConfigurationServices {
-  errorParser?: IErrorParser;
   lastReferenceIdManager: ILastReferenceIdManager;
   log: ILog;
   submissionClient: ISubmissionClient;

packages/core/src/index.ts

@@ -27,10 +27,10 @@ export type {
 
 export { ConfigurationDefaultsPlugin } from "./plugins/default/ConfigurationDefaultsPlugin.js";
 export { DuplicateCheckerPlugin } from "./plugins/default/DuplicateCheckerPlugin.js";
-export { ErrorPlugin } from "./plugins/default/ErrorPlugin.js";
 export { EventExclusionPlugin } from "./plugins/default/EventExclusionPlugin.js";
 export { HeartbeatPlugin } from "./plugins/default/HeartbeatPlugin.js";
 export { ReferenceIdPlugin } from "./plugins/default/ReferenceIdPlugin.js";
+export { IgnoredErrorProperties, SimpleErrorPlugin } from "./plugins/default/SimpleErrorPlugin.js"
 export { SubmissionMethodPlugin } from "./plugins/default/SubmissionMethodPlugin.js";
 export { EventContext as ContextData } from "./models/EventContext.js";
 export { PluginContext } from "./plugins/PluginContext.js";
@@ -41,8 +41,6 @@ export type { IEventPlugin } from "./plugins/IEventPlugin.js";
 export { DefaultEventQueue } from "./queue/DefaultEventQueue.js";
 export type { IEventQueue } from "./queue/IEventQueue.js";
 
-export type { IErrorParser } from "./services/IErrorParser.js";
-
 export { InMemoryStorage } from "./storage/InMemoryStorage.js";
 export { LocalStorage } from "./storage/LocalStorage.js";
 export type { IStorage } from "./storage/IStorage.js";

packages/core/src/plugins/EventPluginManager.ts

@@ -1,7 +1,7 @@
 import { Configuration } from "../configuration/Configuration.js";
 import { ConfigurationDefaultsPlugin } from "./default/ConfigurationDefaultsPlugin.js";
 import { DuplicateCheckerPlugin } from "./default/DuplicateCheckerPlugin.js";
-import { ErrorPlugin } from "./default/ErrorPlugin.js";
+import { SimpleErrorPlugin } from "./default/SimpleErrorPlugin.js";
 import { EventExclusionPlugin } from "./default/EventExclusionPlugin.js";
 import { SubmissionMethodPlugin } from "./default/SubmissionMethodPlugin.js";
 import { EventPluginContext } from "./EventPluginContext.js";
@@ -57,7 +57,7 @@ export class EventPluginManager {
 
   public static addDefaultPlugins(config: Configuration): void {
     config.addPlugin(new ConfigurationDefaultsPlugin());
-    config.addPlugin(new ErrorPlugin());
+    config.addPlugin(new SimpleErrorPlugin());
     config.addPlugin(new DuplicateCheckerPlugin());
     config.addPlugin(new EventExclusionPlugin());
     config.addPlugin(new SubmissionMethodPlugin());

packages/core/src/plugins/default/ErrorPlugin.ts

@@ -0,0 +1,56 @@
+
+import { EventPluginContext } from "../EventPluginContext.js";
+import { IEventPlugin } from "../IEventPlugin.js";
+import { isEmpty, stringify } from "../../Utils.js";
+import { SimpleError } from "../../models/data/ErrorInfo.js";
+import { KnownEventDataKeys } from "../../models/Event.js";
+
+export const IgnoredErrorProperties: string[] = [
+  "arguments",
+  "column",
+  "columnNumber",
+  "description",
+  "fileName",
+  "message",
+  "name",
+  "number",
+  "line",
+  "lineNumber",
+  "opera#sourceloc",
+  "sourceId",
+  "sourceURL",
+  "stack",
+  "stackArray",
+  "stacktrace"
+];
+
+export class SimpleErrorPlugin implements IEventPlugin {
+  public priority = 30;
+  public name = "SimpleErrorPlugin";
+
+  public async run(context: EventPluginContext): Promise<void> {
+    const exception = context.eventContext.getException();
+    if (exception) {
+      context.event.type = "error";
+
+      if (!context.event.data[KnownEventDataKeys.SimpleError]) {
+        const error = <SimpleError>{
+          type: exception.name || "Error",
+          message: exception.message,
+          stack_trace: exception.stack,
+          data: {}
+        }
+
+        const exclusions = context.client.config.dataExclusions.concat(IgnoredErrorProperties);
+        const additionalData = JSON.parse(stringify(exception, exclusions));
+        if (!isEmpty(additionalData)) {
+          error.data["@ext"] = additionalData;
+        }
+
+        context.event.data[KnownEventDataKeys.SimpleError] = error;
+      }
+    }
+
+    return Promise.resolve();
+  }
+}