misc: Update comments and remove redundent branch in extractExceptionKeysForMessage

kamilogorek · kamilogorek · commit 50d139cdf96c · 2019-10-03T10:38:04.000+02:00
diff --git a/packages/browser/src/eventbuilder.ts b/packages/browser/src/eventbuilder.ts
@@ -54,11 +54,14 @@ export function eventFromUnknownInput(exception: unknown, syntheticException?: E
     return event;
   }
 
-  // If none of previous checks were valid, then it means that
-  // it's not a DOMError/DOMException
-  // it's not a plain Object
-  // it's not a valid ErrorEvent (one with an error property)
-  // it's not an Error
+  // If none of previous checks were valid, then it means that it's not:
+  // - an instance of DOMError
+  // - an instance of DOMException
+  // - an instance of Event
+  // - an instance of Error
+  // - a valid ErrorEvent (one with an error property)
+  // - a plain Object
+  //
   // So bail out and capture it as a simple message:
   event = eventFromString(exception as string, syntheticException);
   addExceptionTypeValue(event, `${exception}`, undefined);
diff --git a/packages/utils/src/object.ts b/packages/utils/src/object.ts
@@ -316,20 +316,14 @@ export function normalize(input: any, depth?: number): any {
   }
 }
 
-/** Merges provided array of keys into */
+/**
+ * Given any captured exception, extract its keys and create a sorted
+ * and truncated list that will be used inside the event message.
+ * eg. `Non-error exception captured with keys: foo, bar, baz`
+ */
 export function extractExceptionKeysForMessage(exception: any, maxLength: number = 40): string {
   // tslint:disable:strict-type-predicates
   const keys = Object.keys(getWalkSource(exception));
-
-  // TODO: Extract keys for a specific types here
-  if (typeof Event !== 'undefined' && exception instanceof Event) {
-    // keys = [];
-  } else if (typeof CustomEvent !== 'undefined' && exception instanceof CustomEvent) {
-    // keys = [];
-  } else if (typeof ErrorEvent !== 'undefined' && exception instanceof ErrorEvent) {
-    // keys = [];
-  }
-
   keys.sort();
 
   if (!keys.length) {
