Added EventPluginManager tests

Author: niemyjski

dist/exceptionless.d.ts

@@ -120,14 +120,15 @@ export interface IEventPlugin {
     run(context: EventPluginContext, next?: () => void): void;
 }
 export declare class EventPluginContext {
+    cancelled: boolean;
     client: ExceptionlessClient;
     event: IEvent;
     contextData: ContextData;
     constructor(client: ExceptionlessClient, event: IEvent, contextData?: ContextData);
     log: ILog;
 }
 export declare class EventPluginManager {
-    static run(context: EventPluginContext, callback: () => void): void;
+    static run(context: EventPluginContext, callback: (context?: EventPluginContext) => void): void;
     static addDefaultPlugins(config: Configuration): void;
 }
 export declare class ReferenceIdPlugin implements IEventPlugin {
@@ -193,7 +194,7 @@ export declare class Configuration implements IConfigurationSettings {
     enabled: boolean;
     plugins: IEventPlugin[];
     addPlugin(plugin: IEventPlugin): void;
-    addPlugin(name: string, priority: number, pluginAction: (context: EventPluginContext) => void): void;
+    addPlugin(name: string, priority: number, pluginAction: (context: EventPluginContext, next?: () => void) => void): void;
     removePlugin(plugin: IEventPlugin): void;
     removePlugin(name: string): void;
     setVersion(version: string): void;
@@ -224,7 +225,7 @@ export declare class EventBuilder {
     setProperty(name: string, value: any): EventBuilder;
     markAsCritical(critical: boolean): EventBuilder;
     addRequestInfo(request: any): EventBuilder;
-    submit(): void;
+    submit(callback?: (context: EventPluginContext) => void): void;
     private isValidIdentifier(value);
 }
 export interface IError extends IInnerError {
@@ -236,25 +237,25 @@ export declare class ExceptionlessClient {
     constructor(settings: IConfigurationSettings);
     constructor(apiKey: string, serverUrl?: string);
     createException(exception: Error): EventBuilder;
-    submitException(exception: Error): void;
+    submitException(exception: Error, callback?: (context: EventPluginContext) => void): void;
     createUnhandledException(exception: Error, submissionMethod?: string): EventBuilder;
-    submitUnhandledException(exception: Error, submissionMethod?: string): void;
+    submitUnhandledException(exception: Error, submissionMethod?: string, callback?: (context: EventPluginContext) => void): void;
     createFeatureUsage(feature: string): EventBuilder;
-    submitFeatureUsage(feature: string): void;
+    submitFeatureUsage(feature: string, callback?: (context: EventPluginContext) => void): void;
     createLog(message: string): EventBuilder;
     createLog(source: string, message: string): EventBuilder;
     createLog(source: string, message: string, level: string): EventBuilder;
     submitLog(message: string): void;
     submitLog(source: string, message: string): void;
-    submitLog(source: string, message: string, level: string): void;
+    submitLog(source: string, message: string, level: string, callback?: (context: EventPluginContext) => void): void;
     createNotFound(resource: string): EventBuilder;
-    submitNotFound(resource: string): void;
+    submitNotFound(resource: string, callback?: (context: EventPluginContext) => void): void;
     createSessionStart(sessionId: string): EventBuilder;
-    submitSessionStart(sessionId: string): void;
+    submitSessionStart(sessionId: string, callback?: (context: EventPluginContext) => void): void;
     createSessionEnd(sessionId: string): EventBuilder;
-    submitSessionEnd(sessionId: string): void;
+    submitSessionEnd(sessionId: string, callback?: (context: EventPluginContext) => void): void;
     createEvent(pluginContextData?: ContextData): EventBuilder;
-    submitEvent(event: IEvent, pluginContextData?: ContextData): void;
+    submitEvent(event: IEvent, pluginContextData?: ContextData, callback?: (context: EventPluginContext) => void): void;
     getLastReferenceId(): string;
     private static _instance;
     static default: ExceptionlessClient;

dist/exceptionless.js

@@ -36,7 +36,7 @@
     "karma-cli": "0.0.4",
     "karma-jasmine": "~0.3.5",
     "rimraf": "^2.3.3",
-    "tsproject": "^0.8.9",
+    "tsproject": "^0.8.10",
     "typescript": "1.5.0-beta"
   },
   "dependencies": {

dist/exceptionless.js.map

@@ -126,7 +126,7 @@ export class ExceptionlessClient {
     }
 
     var context = new EventPluginContext(this, event, pluginContextData);
-    return EventPluginManager.run(context, (context:EventPluginContext) => {
+    EventPluginManager.run(context, (context:EventPluginContext) => {
       if (!context.cancelled) {
         // ensure all required data
         if (!event.type || event.type.length === 0) {

dist/exceptionless.min.js

@@ -94,8 +94,8 @@ export class Configuration implements IConfigurationSettings {
   }
 
   public addPlugin(plugin:IEventPlugin): void;
-  public addPlugin(name:string, priority:number, pluginAction:(context:EventPluginContext) => void): void;
-  public addPlugin(pluginOrName:IEventPlugin|string, priority?:number, pluginAction?:(context:EventPluginContext) => void): void {
+  public addPlugin(name:string, priority:number, pluginAction:(context:EventPluginContext, next?:() => void) => void): void;
+  public addPlugin(pluginOrName:IEventPlugin|string, priority?:number, pluginAction?:(context:EventPluginContext, next?:() => void) => void): void {
     var plugin:IEventPlugin = !!pluginAction ? { name: <string>pluginOrName, priority: priority, run: pluginAction } : <IEventPlugin>pluginOrName;
     if (!plugin || !plugin.run) {
       this.log.error('Add plugin failed: No run method was defined.');

dist/exceptionless.min.js.map

@@ -0,0 +1,156 @@
+import { Configuration } from '../configuration/Configuration';
+import { ContextData } from 'ContextData';
+import { ExceptionlessClient } from '../ExceptionlessClient';
+import { EventPluginManager } from 'EventPluginManager';
+import { EventPluginContext } from 'EventPluginContext';
+
+describe('EventPluginManager', () => {
+  it('should add items to the event.', (done) => {
+    var client = new ExceptionlessClient({ apiKey:'LhhP1C9gijpSKCslHHCvwdSIz298twx271n1l6xw', serverUrl:'http://localhost:50000'});
+    var context = new EventPluginContext(client, {}, new ContextData());
+    expect(context.event.source).toBeUndefined();
+    expect(context.event.geo).toBeUndefined();
+
+    expect(client.config.plugins).not.toBe(null);
+    while(client.config.plugins.length > 0) {
+      client.config.removePlugin(client.config.plugins[0]);
+    }
+
+    client.config.addPlugin('1', 1, (context:EventPluginContext, next?:() => void) => {
+      setTimeout(() => {
+        context.event.source = 'plugin 1';
+
+        if (next) {
+          next();
+        }
+      }, 500);
+    });
+
+    client.config.addPlugin('2', 2, (context:EventPluginContext, next?:() => void) => {
+      context.event.geo = '43.5775,88.4472';
+
+      if (next) {
+        next();
+      }
+    });
+
+    EventPluginManager.run(context, (context?:EventPluginContext) => {
+      expect(context.cancelled).toBeUndefined();
+      expect(context.event.source).toBe('plugin 1');
+      expect(context.event.geo).toBe('43.5775,88.4472');
+
+      done();
+    });
+  }, 5000);
+
+  it('setting cancel should stop plugin execution.', (done) => {
+    var client = new ExceptionlessClient({ apiKey:'LhhP1C9gijpSKCslHHCvwdSIz298twx271n1l6xw', serverUrl:'http://localhost:50000'});
+    var context = new EventPluginContext(client, {}, new ContextData());
+
+    expect(client.config.plugins).not.toBe(null);
+    while(client.config.plugins.length > 0) {
+      client.config.removePlugin(client.config.plugins[0]);
+    }
+
+    client.config.addPlugin('1', 1, (context:EventPluginContext, next?:() => void) => {
+      context.cancelled = true;
+
+      if (next) {
+        next();
+      }
+    });
+
+    client.config.addPlugin('2', 2, () => {
+      // Fail this test as this plugin should not be called.
+      expect(false).toBe(true);
+    });
+
+    EventPluginManager.run(context, (context?:EventPluginContext) => {
+      expect(context.cancelled).toBe(true);
+      done();
+    });
+  }, 5000);
+
+  it('throwing error should stop plugin execution.', (done) => {
+    var client = new ExceptionlessClient({ apiKey:'LhhP1C9gijpSKCslHHCvwdSIz298twx271n1l6xw', serverUrl:'http://localhost:50000'});
+    var context = new EventPluginContext(client, {}, new ContextData());
+
+    expect(client.config.plugins).not.toBe(null);
+    while(client.config.plugins.length > 0) {
+      client.config.removePlugin(client.config.plugins[0]);
+    }
+
+    client.config.addPlugin('1', 1, () => {
+      throw new Error('Random Error');
+    });
+
+    client.config.addPlugin('2', 2, () => {
+      // Fail this test as this plugin should not be called.
+      expect(false).toBe(true);
+    });
+
+    EventPluginManager.run(context, (context?:EventPluginContext) => {
+      expect(context.cancelled).toBe(true);
+      done();
+    });
+  }, 5000);
+
+  it('throwing async error should stop plugin execution.', (done) => {
+    var client = new ExceptionlessClient({ apiKey:'LhhP1C9gijpSKCslHHCvwdSIz298twx271n1l6xw', serverUrl:'http://localhost:50000'});
+    var context = new EventPluginContext(client, {}, new ContextData());
+
+    expect(client.config.plugins).not.toBe(null);
+    while(client.config.plugins.length > 0) {
+      client.config.removePlugin(client.config.plugins[0]);
+    }
+
+    client.config.addPlugin('1', 1, (context:EventPluginContext, next?:() => void) => {
+      // NOTE: Currently you have to catch it and set cancelled.
+      setTimeout(() => {
+        try {
+          throw new Error('Random Error');
+        } catch (e) {
+          context.cancelled = true;
+        }
+
+        if (next) {
+          next();
+        }
+      }, 500);
+    });
+
+    client.config.addPlugin('2', 2, () => {
+      // Fail this test as this plugin should not be called.
+      expect(false).toBe(true);
+    });
+
+    EventPluginManager.run(context, (context?:EventPluginContext) => {
+      expect(context.cancelled).toBe(true);
+      done();
+    });
+  }, 5000);
+
+  it('should cancel via timeout.', (done) => {
+    var client = new ExceptionlessClient({ apiKey:'LhhP1C9gijpSKCslHHCvwdSIz298twx271n1l6xw', serverUrl:'http://localhost:50000'});
+    var context = new EventPluginContext(client, {}, new ContextData());
+
+    expect(client.config.plugins).not.toBe(null);
+    while(client.config.plugins.length > 0) {
+      client.config.removePlugin(client.config.plugins[0]);
+    }
+
+    client.config.addPlugin('1', 1, (context:EventPluginContext, next?:() => void) => {
+      setTimeout(done, 100)
+    });
+
+    client.config.addPlugin('2', 2, () => {
+      // Fail this test as this plugin should not be called.
+      expect(false).toBe(true);
+    });
+
+    EventPluginManager.run(context, (context?:EventPluginContext) => {
+      // Fail this test as this callback should not be called.
+      expect(false).toBe(true);
+    });
+  }, 500);
+});