Fix tests. Refactor event context.

Author: ejsmith

packages/core/src/EventBuilder.ts

@@ -1,33 +1,23 @@
 import { ExceptionlessClient } from "./ExceptionlessClient.js";
-import {
-  Event,
-  KnownEventDataKeys
-} from "./models/Event.js";
+import { Event, KnownEventDataKeys } from "./models/Event.js";
 import { ManualStackingInfo } from "./models/data/ManualStackingInfo.js";
 import { RequestInfo } from "./models/data/RequestInfo.js";
 import { UserInfo } from "./models/data/UserInfo.js";
-import { ContextData } from "./plugins/ContextData.js";
+import { EventContext } from "./models/EventContext.js";
+import { isEmpty, stringify } from "./Utils.js";
 import { EventPluginContext } from "./plugins/EventPluginContext.js";
-import {
-  isEmpty,
-  stringify
-} from "./Utils.js";
 
 export class EventBuilder {
   public target: Event;
   public client: ExceptionlessClient;
-  public pluginContextData: ContextData;
+  public context: EventContext;
 
   private _validIdentifierErrorMessage = "must contain between 8 and 100 alphanumeric or '-' characters.";
 
-  constructor(
-    event: Event,
-    client: ExceptionlessClient,
-    pluginContextData?: ContextData,
-  ) {
+  constructor(event: Event, client: ExceptionlessClient, context?: EventContext) {
     this.target = event;
     this.client = client;
-    this.pluginContextData = pluginContextData || new ContextData();
+    this.context = context || new EventContext();
   }
 
   public setType(type: string): EventBuilder {
@@ -59,7 +49,6 @@ export class EventBuilder {
    * Allows you to reference a parent event by its ReferenceId property. This allows you to have parent and child relationships.
    * @param name Reference name
    * @param id The reference id that points to a specific event
-   * @returns {EventBuilder}
    */
   public setEventReference(name: string, id: string): EventBuilder {
     if (!name) {
@@ -100,10 +89,7 @@ export class EventBuilder {
   public setUserIdentity(userInfo: UserInfo): EventBuilder;
   public setUserIdentity(identity: string): EventBuilder;
   public setUserIdentity(identity: string, name: string): EventBuilder;
-  public setUserIdentity(
-    userInfoOrIdentity: UserInfo | string,
-    name?: string,
-  ): EventBuilder {
+  public setUserIdentity(userInfoOrIdentity: UserInfo | string, name?: string): EventBuilder {
     const userInfo = typeof userInfoOrIdentity !== "string"
       ? userInfoOrIdentity
       : { identity: userInfoOrIdentity, name };
@@ -120,12 +106,8 @@ export class EventBuilder {
    *
    * @param emailAddress The email address
    * @param description The user"s description of the event.
-   * @returns {EventBuilder}
    */
-  public setUserDescription(
-    emailAddress: string,
-    description: string,
-  ): EventBuilder {
+  public setUserDescription(emailAddress: string, description: string): EventBuilder {
     if (emailAddress && description) {
       this.setProperty(KnownEventDataKeys.UserDescription, {
         email_address: emailAddress,
@@ -141,12 +123,8 @@ export class EventBuilder {
    * stacking information.
    * @param signatureData A dictionary of strings to use for stacking.
    * @param title An optional title for the stacking information.
-   * @returns {EventBuilder}
    */
-  public setManualStackingInfo(
-    signatureData: Record<string, string>,
-    title?: string,
-  ): EventBuilder {
+  public setManualStackingInfo(signatureData: Record<string, string>, title?: string): EventBuilder {
     if (signatureData) {
       const stack: ManualStackingInfo = { signature_data: signatureData };
       if (title) {
@@ -163,12 +141,8 @@ export class EventBuilder {
    * Changes default stacking behavior by setting the stacking key.
    * @param manualStackingKey The manual stacking key.
    * @param title An optional title for the stacking information.
-   * @returns {EventBuilder}
    */
-  public setManualStackingKey(
-    manualStackingKey: string,
-    title?: string,
-  ): EventBuilder {
+  public setManualStackingKey(manualStackingKey: string, title?: string): EventBuilder {
     if (manualStackingKey) {
       const data = { ManualStackingKey: manualStackingKey };
       this.setManualStackingInfo(data, title);
@@ -180,7 +154,6 @@ export class EventBuilder {
   /**
    * Sets the event value.
    * @param value The value of the event.
-   * @returns {EventBuilder}
    */
   public setValue(value: number): EventBuilder {
     if (value) {
@@ -203,12 +176,7 @@ export class EventBuilder {
    * @param maxDepth The max depth of the object to include.
    * @param excludedPropertyNames Any property names that should be excluded.
    */
-  public setProperty(
-    name: string,
-    value: unknown,
-    maxDepth?: number,
-    excludedPropertyNames?: string[],
-  ): EventBuilder {
+  public setProperty(name: string, value: unknown, maxDepth?: number, excludedPropertyNames?: string[]): EventBuilder {
     if (!name || (value === undefined || value == null)) {
       return this;
     }
@@ -241,14 +209,14 @@ export class EventBuilder {
 
   public addRequestInfo(request: RequestInfo): EventBuilder {
     if (request) {
-      this.pluginContextData[KnownEventDataKeys.RequestInfo] = request;
+      this.context[KnownEventDataKeys.RequestInfo] = request;
     }
 
     return this;
   }
 
   public submit(): Promise<EventPluginContext> {
-    return this.client.submitEvent(this.target, this.pluginContextData);
+    return this.client.submitEvent(this.target, this.context);
   }
 
   private isValidIdentifier(value: string): boolean {

packages/core/src/ExceptionlessClient.ts

@@ -3,7 +3,7 @@ import { SettingsManager } from "./configuration/SettingsManager.js";
 import { EventBuilder } from "./EventBuilder.js";
 import { Event, KnownEventDataKeys } from "./models/Event.js";
 import { UserDescription } from "./models/data/UserDescription.js";
-import { ContextData } from "./plugins/ContextData.js";
+import { EventContext } from "./models/EventContext.js";
 import { EventPluginContext } from "./plugins/EventPluginContext.js";
 import { EventPluginManager } from "./plugins/EventPluginManager.js";
 import { PluginContext } from "./plugins/PluginContext.js";
@@ -86,7 +86,7 @@ export class ExceptionlessClient {
   }
 
   public createException(exception: Error): EventBuilder {
-    const pluginContextData = new ContextData();
+    const pluginContextData = new EventContext();
     pluginContextData.setException(exception);
     return this.createEvent(pluginContextData).setType("error");
   }
@@ -97,8 +97,8 @@ export class ExceptionlessClient {
 
   public createUnhandledException(exception: Error, submissionMethod?: string): EventBuilder {
     const builder = this.createException(exception);
-    builder.pluginContextData.markAsUnhandledError();
-    builder.pluginContextData.setSubmissionMethod(submissionMethod || "");
+    builder.context.markAsUnhandledError();
+    builder.context.setSubmissionMethod(submissionMethod || "");
 
     return builder;
   }
@@ -192,28 +192,28 @@ export class ExceptionlessClient {
     }
   }
 
-  public createEvent(pluginContextData?: ContextData): EventBuilder {
-    return new EventBuilder({ date: new Date() }, this, pluginContextData);
+  public createEvent(context?: EventContext): EventBuilder {
+    return new EventBuilder({ date: new Date() }, this, context);
   }
 
   /**
-   * Submits the event to be sent to the server.
+   * Submits the event to the server.
    *
-   * @param event The event data.
-   * @param pluginContextData Any contextual data objects to be used by Exceptionless plugins to gather default information for inclusion in the report information.
-   * @param callback
+   * @param event The event
+   * @param context Contextual data used by event plugins to enrich the event details
    */
-  public async submitEvent(event: Event, pluginContextData?: ContextData): Promise<EventPluginContext> {
-    const context = new EventPluginContext(this, event, pluginContextData);
+  public async submitEvent(event: Event, context?: EventContext): Promise<EventPluginContext> {
+    const pluginContext = new EventPluginContext(this, event, context);
+
     if (!event) {
       context.cancelled = true;
-      return context;
+      return pluginContext;
     }
 
     if (!this.config.enabled || !this.config.isValid) {
       this.config.services.log.info("Event submission is currently disabled.");
       context.cancelled = true;
-      return context;
+      return pluginContext;
     }
 
     if (!event.data) {
@@ -224,13 +224,12 @@ export class ExceptionlessClient {
       event.tags = [];
     }
 
-    await EventPluginManager.run(context);
+    await EventPluginManager.run(pluginContext);
     if (context.cancelled) {
-      return context;
+      return pluginContext;
     }
 
-    const config = context.client.config;
-    const ev = context.event;
+    const ev = pluginContext.event;
 
     // ensure all required data
     if (!ev.type || ev.type.length === 0) {
@@ -241,14 +240,14 @@ export class ExceptionlessClient {
       ev.date = new Date();
     }
 
-    await config.services.queue.enqueue(ev);
+    await this.config.services.queue.enqueue(ev);
 
     if (ev.reference_id && ev.reference_id.length > 0) {
-      context.log.info(`Setting last reference id "${ev.reference_id}"`);
-      config.services.lastReferenceIdManager.setLast(ev.reference_id);
+      pluginContext.log.info(`Setting last reference id "${ev.reference_id}"`);
+      this.config.services.lastReferenceIdManager.setLast(ev.reference_id);
     }
 
-    return context;
+    return pluginContext;
   }
 
   /**

packages/core/src/index.ts

@@ -32,7 +32,7 @@ export { EventExclusionPlugin } from "./plugins/default/EventExclusionPlugin.js"
 export { HeartbeatPlugin } from "./plugins/default/HeartbeatPlugin.js";
 export { ReferenceIdPlugin } from "./plugins/default/ReferenceIdPlugin.js";
 export { SubmissionMethodPlugin } from "./plugins/default/SubmissionMethodPlugin.js";
-export { ContextData } from "./plugins/ContextData.js";
+export { EventContext as ContextData } from "./models/EventContext.js";
 export { PluginContext } from "./plugins/PluginContext.js";
 export { EventPluginContext } from "./plugins/EventPluginContext.js";
 export { EventPluginManager } from "./plugins/EventPluginManager.js";

packages/core/src/plugins/ContextData.ts renamed to packages/core/src/models/EventContext.ts

@@ -5,8 +5,7 @@ const enum KnownContextKeys {
   SubmissionMethod = "@@_SubmissionMethod"
 }
 
-// TODO: Look into ways of improving this.
-export class ContextData implements Record<string, unknown> {
+export class EventContext implements Record<string, unknown> {
   [x: string]: unknown;
 
   public getException(): Error | null {

packages/core/src/plugins/EventPluginContext.ts

@@ -1,18 +1,14 @@
 import { ExceptionlessClient } from "../ExceptionlessClient.js";
 import { ILog } from "../logging/ILog.js";
 import { Event } from "../models/Event.js";
-import { ContextData } from "./ContextData.js";
-import { PluginContext } from "./PluginContext.js";
+import { EventContext } from "../models/EventContext.js";
 
-export class EventPluginContext extends PluginContext {
+export class EventPluginContext {
   public cancelled = false;
 
-  constructor(
-    client: ExceptionlessClient,
-    public event: Event,
-    public contextData: ContextData = new ContextData()
-  ) {
-    super(client);
+  constructor(public client: ExceptionlessClient, public event: Event, public eventContext: EventContext = null) {
+    if (!this.eventContext)
+      this.eventContext = new EventContext();
   }
 
   public get log(): ILog {

packages/core/src/plugins/PluginContext.ts

@@ -1,7 +1,6 @@
 import { ExceptionlessClient } from "../ExceptionlessClient.js";
 import { ILog } from "../logging/ILog.js";
 
-
 export class PluginContext {
   constructor(public client: ExceptionlessClient) { }
 

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

@@ -27,7 +27,7 @@ export class ErrorPlugin implements IEventPlugin {
       "stacktrace"
     ];
 
-    const exception = context.contextData.getException();
+    const exception = context.eventContext.getException();
     if (exception) {
       context.event.type = "error";
 

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

@@ -7,7 +7,7 @@ export class SubmissionMethodPlugin implements IEventPlugin {
   public name = "SubmissionMethodPlugin";
 
   public run(context: EventPluginContext): Promise<void> {
-    const submissionMethod = context.contextData.getSubmissionMethod();
+    const submissionMethod = context.eventContext.getSubmissionMethod();
     if (submissionMethod) {
       context.event.data[KnownEventDataKeys.SubmissionMethod] = submissionMethod;
     }

packages/core/src/storage/LocalStorage.ts

@@ -4,10 +4,11 @@ export class LocalStorage implements IStorage {
   constructor(private prefix: string = "exceptionless-", private storage: Storage = globalThis.localStorage) { }
 
   public length(): Promise<number> {
-    return Promise.resolve(this.getKeys().length);
+    return Promise.resolve(this.storage.length);
   }
 
   public clear(): Promise<void> {
+    return Promise.resolve(this.storage.clear());
     for (const key of this.getKeys()) {
       this.storage.removeItem(this.getKey(key));
     }

packages/core/test/plugins/EventPluginManager.test.ts

@@ -1,4 +1,4 @@
-import { ContextData } from "../../src/plugins/ContextData.js";
+import { EventContext } from "../../src/models/EventContext.js";
 import { ExceptionlessClient } from "../../src/ExceptionlessClient.js";
 import { EventPluginContext } from "../../src/plugins/EventPluginContext.js";
 import { EventPluginManager } from "../../src/plugins/EventPluginManager.js";
@@ -9,7 +9,7 @@ describe("EventPluginManager", () => {
     const client = new ExceptionlessClient();
     client.config.apiKey = "UNIT_TEST_API_KEY";
 
-    const context = new EventPluginContext(client, {}, new ContextData());
+    const context = new EventPluginContext(client, {});
     expect(context.event.source).toBeUndefined();
     expect(context.event.geo).toBeUndefined();
 
@@ -38,7 +38,7 @@ describe("EventPluginManager", () => {
     const client = new ExceptionlessClient();
     client.config.apiKey = "UNIT_TEST_API_KEY";
 
-    const context = new EventPluginContext(client, {}, new ContextData());
+    const context = new EventPluginContext(client, {});
     expect(client.config.plugins).not.toBeNull();
     while (client.config.plugins.length > 0) {
       client.config.removePlugin(client.config.plugins[0]);
@@ -60,7 +60,7 @@ describe("EventPluginManager", () => {
   test("throwing error should stop plugin execution.", async () => {
     const client = new ExceptionlessClient();
     client.config.apiKey = "UNIT_TEST_API_KEY";
-    const context = new EventPluginContext(client, {}, new ContextData());
+    const context = new EventPluginContext(client, {});
 
     expect(client.config.plugins).not.toBeNull();
     while (client.config.plugins.length > 0) {
@@ -82,7 +82,7 @@ describe("EventPluginManager", () => {
   test("should cancel via timeout.", async () => {
     const client = new ExceptionlessClient();
     client.config.apiKey = "UNIT_TEST_API_KEY";
-    const context = new EventPluginContext(client, {}, new ContextData());
+    const context = new EventPluginContext(client, {});
 
     expect(client.config.plugins).not.toBeNull();
     while (client.config.plugins.length > 0) {
@@ -104,7 +104,7 @@ describe("EventPluginManager", () => {
   test("should ensure config plugins are not wrapped.", async () => {
     const client = new ExceptionlessClient();
     client.config.apiKey = "UNIT_TEST_API_KEY";
-    const context = new EventPluginContext(client, {}, new ContextData());
+    const context = new EventPluginContext(client, {});
 
     expect(client.config.plugins).not.toBeNull();
     while (client.config.plugins.length > 0) {