Attempt to fix an issue where data items are not excluded properly.

We still need to implement depth on stringily and make sure request
info like cookies, query strings, post_data are being checked for
excluded items.

@frank, I moved some things to functions as it takes it off the
prototype (shrinks code at the expense of uglier code). Also, I was
trying to see if we could share the stringify code for extra error
properties but we might need to revert that change.

Author: niemyjski

src/EventBuilder.ts

@@ -99,7 +99,15 @@ export class EventBuilder {
     return this;
   }
 
-  public setProperty(name:string, value:any): EventBuilder {
+  /**
+   * Adds the object to extended data. Uses @excludedPropertyNames
+   * to exclude data from being included in the event.
+   * @param name The data object to add.
+   * @param value The name of the object to add.
+   * @param maxDepth The max depth of the object to include.
+   * @param excludedPropertyNames Any property names that should be excluded.
+   */
+  public setProperty(name:string, value:any, maxDepth?:number, excludedPropertyNames?:string[]): EventBuilder {
     if (!name || (value === undefined || value == null)) {
       return this;
     }
@@ -108,7 +116,7 @@ export class EventBuilder {
       this.target.data = {};
     }
 
-    this.target.data[name] = value;
+    this.target.data[name] = JSON.parse(Utils.stringify(value, this.client.config.dataExclusions.concat(excludedPropertyNames || []), maxDepth));
     return this;
   }
 

src/ExceptionlessClient.ts

@@ -176,6 +176,7 @@ export class ExceptionlessClient {
    * @param referenceId The reference id of the event to update.
    * @param email The user's email address to set on the event.
    * @param description The user's description of the event.
+   * @param callback The submission response.
    */
   public updateUserEmailAndDescription(referenceId:string, email:string, description:string, callback?:(response:SubmissionResponse) => void) {
     if (!referenceId || !email || !description || !this.config.enabled) {

src/Utils-spec.ts

@@ -95,7 +95,7 @@ describe('Utils', () => {
       });
 
       it('*Address', () => {
-        let event = {"type":"usage","source":"about" };
+        let event = { type:'usage', source:'about' };
         expect(Utils.stringify(event, ['*Address'])).toBe(JSON.stringify(event));
       });
     });

src/Utils.ts

@@ -17,9 +17,9 @@ export class Utils {
     return target;
   }
 
-  public static getHashCode(source:string): string {
+  public static getHashCode(source:string): number {
     if (!source || source.length === 0) {
-      return null;
+      return 0;
     }
 
     let hash:number = 0;
@@ -29,7 +29,7 @@ export class Utils {
       hash |= 0;
     }
 
-    return hash.toString();
+    return hash;
   }
 
   public static getCookies(cookies:string): Object {
@@ -107,7 +107,13 @@ export class Utils {
     return Math.floor(Math.random() * 9007199254740992);
   }
 
-  public static stringify(data:any, exclusions?:string[]): string {
+  /**
+   * Stringifys an object with optional exclusions and max depth.
+   * @param data The data object to add.
+   * @param exclusions Any property names that should be excluded.
+   * @param maxDepth The max depth of the object to include.
+   */
+  public static stringify(data:any, exclusions?:string[], maxDepth?:number): string {
     function checkForMatch(pattern:string, value:string): boolean {
       if (!pattern || !value || typeof value !== 'string') {
         return false;

src/plugins/default/ConfigurationDefaultsPlugin.ts

@@ -1,23 +1,25 @@
 import { IEventPlugin } from '../IEventPlugin';
 import { EventPluginContext } from '../EventPluginContext';
+import { Utils } from '../../Utils';
 
 export class ConfigurationDefaultsPlugin implements IEventPlugin {
   public priority:number = 10;
   public name:string = 'ConfigurationDefaultsPlugin';
 
   public run(context:EventPluginContext, next?:() => void): void {
-    let defaultTags:string[] = context.client.config.defaultTags || [];
+    let config = context.client.config;
+    let defaultTags:string[] = config.defaultTags || [];
     for (let index = 0; index < defaultTags.length; index++) {
       let tag = defaultTags[index];
       if (!!tag && context.event.tags.indexOf(tag) < 0) {
         context.event.tags.push(tag);
       }
     }
 
-    let defaultData:Object = context.client.config.defaultData || {};
+    let defaultData:Object = config.defaultData || {};
     for (let key in defaultData) {
       if (!!defaultData[key]) {
-        context.event.data[key] = defaultData[key];
+        context.event.data[key] = JSON.parse(Utils.stringify(defaultData[key], config.dataExclusions));
       }
     }
 

src/plugins/default/DuplicateCheckerPlugin.ts

@@ -1,10 +1,9 @@
 import { IInnerError } from '../../models/IInnerError';
 import { IStackFrame } from '../../models/IStackFrame';
-
 import { ILog } from '../../logging/ILog';
-
 import { IEventPlugin } from '../IEventPlugin';
 import { EventPluginContext } from '../EventPluginContext';
+import { Utils } from '../../Utils';
 
 const ERROR_KEY: string = '@error';
 const WINDOW_MILLISECONDS = 2000;
@@ -17,71 +16,56 @@ export class DuplicateCheckerPlugin implements IEventPlugin {
   private recentlyProcessedErrors: TimestampedHash[] = [];
 
   public run(context: EventPluginContext, next?: () => void): void {
-    if (context.event.type === 'error') {
-      let error = context.event.data[ERROR_KEY];
-      let isDuplicate = this.checkDuplicate(error, context.log);
-      if (isDuplicate) {
-        context.cancelled = true;
-        return;
+    function checkDuplicate(error: IInnerError, log: ILog): boolean {
+      function getHashCodeForError(err: IInnerError): number {
+        if (!err.stack_trace) {
+          return null;
+        }
+
+        return Utils.getHashCode(JSON.stringify(err.stack_trace));
       }
-    }
 
-    next && next();
-  }
+      let now = Date.now();
+      let repeatWindow = now - WINDOW_MILLISECONDS;
+      let hashCode: number;
+      while (error) {
+        hashCode = getHashCodeForError(error);
 
-  private getNow() {
-    return Date.now();
-  }
+        // make sure that we don't process the same error multiple times within the repeat window
+        if (hashCode && this.recentlyProcessedErrors.some(h =>
+          h.hash === hashCode && h.timestamp >= repeatWindow)) {
+          log.info(`Ignoring duplicate error event: hash=${hashCode}`);
+          return true;
+        }
+
+        // add this exception to our list of recent errors that we have processed
+        this.recentlyProcessedErrors.push({ hash: hashCode, timestamp: now });
 
-  private checkDuplicate(error: IInnerError, log: ILog): boolean {
-    let now = this.getNow();
-    let repeatWindow = now - WINDOW_MILLISECONDS;
-    let hashCode: number;
-    while (error) {
-      hashCode = getHashCodeForError(error);
+        // only keep the last 10 recent errors
+        while (this.recentlyProcessedErrors.length > MAX_QUEUE_LENGTH) {
+          this.recentlyProcessedErrors.shift();
+        }
 
-      // make sure that we don't process the same error multiple times within the repeat window
-      if (hashCode && this.recentlyProcessedErrors.some(h =>
-        h.hash === hashCode && h.timestamp >= repeatWindow)) {
-        log.info(`Ignoring duplicate error event: hash=${hashCode}`);
-        return true;
+        error = error.inner;
       }
 
-      // add this exception to our list of recent errors that we have processed
-      this.recentlyProcessedErrors.push({ hash: hashCode, timestamp: now });
+      return false;
+    }
 
-      // only keep the last 10 recent errors
-      while (this.recentlyProcessedErrors.length > MAX_QUEUE_LENGTH) {
-        this.recentlyProcessedErrors.shift();
+    if (context.event.type === 'error') {
+      let error = context.event.data[ERROR_KEY];
+      let isDuplicate = checkDuplicate(error, context.log);
+      if (isDuplicate) {
+        context.cancelled = true;
+        return;
       }
-
-      error = error.inner;
     }
 
-    return false;
+    next && next();
   }
 }
 
 interface TimestampedHash {
   hash: number;
   timestamp: number;
 }
-
-function getHashCodeForError(error: IInnerError): number {
-  if (!error.stack_trace) {
-    return null;
-  }
-
-  let stack = JSON.stringify(error.stack_trace);
-  return getHashCode(stack);
-}
-
-function getHashCode(s: string): number {
-  let hash = 0, length = s.length, char;
-  for (let i = 0; i < length; i++) {
-    char = s.charCodeAt(i);
-    hash = ((hash << 5) - hash) + char;
-    hash |= 0;
-  }
-  return hash;
-}

src/plugins/default/ErrorPlugin-spec.ts

@@ -11,7 +11,7 @@ import { createFixture } from './EventPluginTestFixture';
 function BaseTestError() {
   this.name = 'NotImplementedError';
   this.someProperty = 'Test';
-};
+}
 
 BaseTestError.prototype = new Error();
 
@@ -22,7 +22,6 @@ function DerivedTestError() {
 DerivedTestError.prototype = new BaseTestError();
 
 describe('ErrorPlugin', () => {
-
   let target = new ErrorPlugin();
   let contextData: ContextData;
   let context: EventPluginContext;
@@ -45,9 +44,7 @@ describe('ErrorPlugin', () => {
   }
 
   describe('additional data', () => {
-
     describeForCapturedExceptions((exception) => {
-
       it('should ignore default error properties', () => {
         contextData.setException(exception);
         target.run(context);

src/plugins/default/ErrorPlugin.ts

@@ -1,5 +1,6 @@
 import { IEventPlugin } from '../IEventPlugin';
 import { EventPluginContext } from '../EventPluginContext';
+import { Utils } from '../../Utils';
 
 export class ErrorPlugin implements IEventPlugin {
   public priority: number = 30;
@@ -25,26 +26,26 @@ export class ErrorPlugin implements IEventPlugin {
 
   public run(context: EventPluginContext, next?: () => void): void {
     const ERROR_KEY: string = '@error'; // optimization for minifier.
-    const EXTRA_PROPERTIES_KEY: string = '@ext';
 
     let exception = context.contextData.getException();
     if (!!exception) {
       context.event.type = 'error';
 
       if (!context.event.data[ERROR_KEY]) {
-        let parser = context.client.config.errorParser;
+        let config = context.client.config;
+        let parser = config.errorParser;
         if (!parser) {
           throw new Error('No error parser was defined.');
         }
 
         let result = parser.parse(context, exception);
         if (!!result) {
-          let additionalData = this.getAdditionalData(exception);
+          let additionalData = JSON.parse(Utils.stringify(exception, config.dataExclusions.concat(this.ignoredProperties)));
           if (!!additionalData) {
             if (!result.data) {
               result.data = {};
             }
-            result.data[EXTRA_PROPERTIES_KEY] = additionalData;
+            result.data['@ext'] = additionalData;
           }
 
           context.event.data[ERROR_KEY] = result;
@@ -54,21 +55,4 @@ export class ErrorPlugin implements IEventPlugin {
 
     next && next();
   }
-
-  private getAdditionalData(exception: Error): { [key: string]: any } {
-    let additionalData = {};
-    for (var key in exception) {
-      if (this.ignoredProperties.indexOf(key) >= 0) {
-        continue;
-      }
-      let value = exception[key];
-      if (typeof value !== 'function') {
-        additionalData[key] = value;
-      }
-    }
-
-    return Object.getOwnPropertyNames(additionalData).length
-      ? additionalData
-      : null;
-  }
 }

src/plugins/default/EventPluginTestFixture.ts

@@ -5,6 +5,7 @@ import { IError } from '../../models/IError';
 import { IErrorParser } from '../../services/IErrorParser';
 import { IStackFrame } from '../../models/IStackFrame';
 
+// TODO: This should use the real object instances and inject the error parser.
 export function createFixture() {
   let contextData: ContextData;
   let context: EventPluginContext;
@@ -21,6 +22,7 @@ export function createFixture() {
   };
   client = {
     config: {
+      dataExclusions:[],
       errorParser,
       log: {
         info: () => { }

src/services/DefaultModuleCollector.ts

@@ -10,7 +10,7 @@ export class DefaultModuleCollector implements IModuleCollector {
     }
 
     let modules:IModule[] = [];
-    let scripts = document.getElementsByTagName('script');
+    let scripts:NodeListOf<HTMLScriptElement> = document.getElementsByTagName('script');
     if (scripts && scripts.length > 0) {
       for (let index = 0; index < scripts.length; index++) {
         if (scripts[index].src) {
@@ -23,7 +23,7 @@ export class DefaultModuleCollector implements IModuleCollector {
           modules.push({
             module_id: index,
             name: 'Script Tag',
-            version: Utils.getHashCode(scripts[index].innerHTML)
+            version: Utils.getHashCode(scripts[index].innerHTML).toString()
           });
         }
       }