WIP - Simplified configuration handlers via proxies, start of integration handlers.

Author: niemyjski

packages/browser/src/plugins/GlobalHandlerPlugin.ts

@@ -0,0 +1,36 @@
+import {
+  ExceptionlessClient,
+  IEventPlugin,
+  PluginContext
+} from "@exceptionless/core";
+
+export class GlobalHandlerPlugin implements IEventPlugin {
+  public priority: number = 100;
+  public name: string = "GlobalHandlerPlugin";
+
+  private client: ExceptionlessClient = null;
+
+  public startup(context: PluginContext): Promise<void> {
+    if (this.client) {
+      return;
+    }
+
+    this.client = context.client;
+    Error.stackTraceLimit = Infinity;
+
+    // TODO: Discus if we want to unwire this handler in suspend?
+    const originalOnError: OnErrorEventHandlerNonNull = globalThis.onerror;
+    globalThis.onerror = (event: Event | string, source?: string, lineno?: number, colno?: number, error?: Error): any => {
+      /*
+      const builder = this.client.createUnhandledException(new Error(stackTrace.message || (options || {}).status || "Script error"), "onerror");
+      builder.pluginContextData["@@_TraceKit.StackTrace"] = stackTrace;
+      void builder.submit(); // TODO: Handle async?
+      */
+
+      // eslint-disable-next-line prefer-rest-params
+      return originalOnError ? originalOnError.apply(this, ...arguments) : false;
+    };
+
+    return Promise.resolve();
+  }
+}

packages/core/src/ExceptionlessClient.ts

@@ -26,7 +26,7 @@ export class ExceptionlessClient {
       }
 
       SettingsManager.applySavedServerSettings(this.config);
-      this.config.onChanged(() => this.updateSettingsTimer(this._timeoutId > 0 ? 5000 : 0));
+      this.config.subscribe(() => this.updateSettingsTimer(this._timeoutId > 0 ? 5000 : 0));
       this.config.services.queue.onEventsPosted(() => this.updateSettingsTimer());
     }
 

packages/core/src/configuration/Configuration.ts

@@ -21,8 +21,21 @@ import { guid } from "../Utils.js";
 import { KnownEventDataKeys } from "../models/Event.js";
 
 export class Configuration {
+  private handler = {
+    set: (target, key, value) => {
+      console.log(key, ` set to ${value}`);
+      target[key] = value;
+      return true;
+    }
+  };
+
+  constructor() {
+    // TODO: Verify this works in derived classes.
+    return new Proxy(this, this.handler);
+  }
+
   // TODO: add flag if your suspended.
-  // change version to be a string.
+  // TODO: change version to be a string.
   /**
    * A default list of tags that will automatically be added to every
    * report submitted to the server.
@@ -57,12 +70,12 @@ export class Configuration {
       submissionClient?: ISubmissionClient,
       storage: IStorageProvider,
       queue: IEventQueue
-    } = {
+  } = new Proxy({
       lastReferenceIdManager: new DefaultLastReferenceIdManager(),
       log: new NullLog(),
       storage: new InMemoryStorageProvider(),
       queue: new DefaultEventQueue(this)
-    };
+  }, this.handler);
 
   /**
    * Maximum number of events that should be sent to the server together in a batch. (Defaults to 50)
@@ -140,11 +153,11 @@ export class Configuration {
   private _plugins: IEventPlugin[] = [];
 
   /**
-   * A list of handlers that will be fired when configuration changes.
+   * A list of subscribers that will be fired when configuration changes.
    * @type {Array}
    * @private
    */
-  private _handlers: Array<(config: Configuration) => void> = [];
+  private _subscribers: Array<(config: Configuration) => void> = [];
 
   /**
    * The API key that will be used when sending events to the server.
@@ -611,17 +624,17 @@ export class Configuration {
     this.services.log = new ConsoleLog();
   }
 
-  public onChanged(handler: (config: Configuration) => void): void {
-    handler && this._handlers.push(handler);
+  public subscribe(handler: (config: Configuration) => void): void {
+    handler && this._subscribers.push(handler);
   }
 
   protected changed() {
-    const handlers = this._handlers; // optimization for minifier.
+    const handlers = this._subscribers; // optimization for minifier.
     for (const handler of handlers) {
       try {
         handler(this);
       } catch (ex) {
-        this.services.log.error(`Error calling onChanged handler: ${ex}`);
+        this.services.log.error(`Error calling subscribe handler: ${ex}`);
       }
     }
   }

packages/core/src/configuration/SettingsManager.ts

@@ -12,18 +12,6 @@ export class ClientSettings {
 export class SettingsManager {
   private static _isUpdatingSettings: boolean = false;
 
-  /**
-   * A list of handlers that will be fired when the settings change.
-   * @type {Array}
-   * @private
-   */
-  private static _handlers: Array<(config: Configuration) => void> = [];
-
-  // TODO: see if this is still needed.
-  public static onChanged(handler: (config: Configuration) => void): void {
-    handler && this._handlers.push(handler);
-  }
-
   public static applySavedServerSettings(config: Configuration): void {
     if (!config || !config.isValid) {
       return;
@@ -32,7 +20,6 @@ export class SettingsManager {
     const savedSettings = this.getSavedServerSettings(config);
     config.services.log.info(`Applying saved settings: v${savedSettings.version}`);
     config.settings = merge(config.settings, savedSettings.settings);
-    this.changed(config);
   }
 
   public static getVersion(config: Configuration): number {
@@ -79,7 +66,7 @@ export class SettingsManager {
         return;
       }
 
-      config.settings = merge(config.settings, response.data.settings);
+      const settings = merge(config.settings, response.data.settings);
 
       // TODO: Store snapshot of settings after reading from config and attributes and use that to revert to defaults.
       // Remove any existing server settings that are not in the new server settings.
@@ -89,28 +76,17 @@ export class SettingsManager {
           continue;
         }
 
-        delete config.settings[key];
+        delete settings[key];
       }
 
+      config.settings = settings;
       config.services.storage.settings.save(response.data);
       log.info(`Updated settings: v${response.data.version}`);
-      this.changed(config);
     } finally {
       this._isUpdatingSettings = false;
     }
   }
 
-  private static changed(config: Configuration) {
-    const handlers = this._handlers; // optimization for minifier.
-    for (const handler of handlers) {
-      try {
-        handler(config);
-      } catch (ex) {
-        config.services.log.error(`Error calling onChanged handler: ${ex}`);
-      }
-    }
-  }
-
   private static getSavedServerSettings(config: Configuration): ClientSettings {
     const item = config.services.storage.settings.get()[0];
     if (item && item.value && item.value.version && item.value.settings) {

packages/core/src/index.ts

@@ -38,6 +38,7 @@ export { ReferenceIdPlugin } from "./plugins/default/ReferenceIdPlugin.js";
 export { RequestInfoPlugin } from "./plugins/default/RequestInfoPlugin.js";
 export { SubmissionMethodPlugin } from "./plugins/default/SubmissionMethodPlugin.js";
 export { ContextData } from "./plugins/ContextData.js";
+export { PluginContext } from "./plugins/PluginContext.js";
 export { EventPluginContext } from "./plugins/EventPluginContext.js";
 export { EventPluginManager } from "./plugins/EventPluginManager.js";
 export { IEventPlugin } from "./plugins/IEventPlugin.js";

packages/core/src/plugins/EventPluginManager.ts

@@ -45,6 +45,10 @@ export class EventPluginManager {
         break;
       }
 
+      if (!plugin.run) {
+        continue;
+      }
+
       try {
         await plugin.run(context);
       } catch (ex) {

packages/core/src/plugins/IEventPlugin.ts

@@ -6,5 +6,5 @@ export interface IEventPlugin {
   name?: string;
   startup?(context: PluginContext): Promise<void>;
   suspend?(context: PluginContext): Promise<void>;
-  run(context: EventPluginContext): Promise<void>;
+  run?(context: EventPluginContext): Promise<void>;
 }

packages/core/test/configuration/SettingsManager.test.ts

@@ -6,12 +6,11 @@ describe("SettingsManager", () => {
     const config = new Configuration();
     config.apiKey = "UNIT_TEST_API_KEY";
 
-    SettingsManager.onChanged((configuration: Configuration) => {
+    config.subscribe((configuration: Configuration) => {
       expect(configuration.settings).not.toBeUndefined();
       done();
     });
 
     SettingsManager.applySavedServerSettings(config);
-    (SettingsManager as any)._handlers = [];
   });
 });

packages/core/test/plugins/default/EventPluginTestFixture.ts

@@ -9,7 +9,7 @@ export function createFixture(): { contextData: ContextData, context: EventPlugi
     parse: (c: EventPluginContext, exception: Error) => Promise.resolve({
       type: exception.name,
       message: exception.message,
-      stack_trace: (exception as any).testStack || null
+      stack_trace: null
     })
   };
   const client: ExceptionlessClient = new ExceptionlessClient();