fix: Make RewriteFrame integration process all exceptions

CHANGELOG.md

@@ -4,6 +4,8 @@
 
 Coming soon...
 
+- [integrations] fix: Make RewriteFrame integration process all exceptions (#2362)
+
 ## 5.10.2
 
 - [browser] fix: Always trigger default browser onerror handler (#2348)

packages/integrations/src/rewriteframes.ts

@@ -1,4 +1,4 @@
-import { Event, EventProcessor, Hub, Integration, StackFrame } from '@sentry/types';
+import { Event, EventProcessor, Hub, Integration, StackFrame, Stacktrace } from '@sentry/types';
 import { basename, relative } from '@sentry/utils';
 
 type StackFrameIteratee = (frame: StackFrame) => StackFrame;
@@ -69,29 +69,54 @@ export class RewriteFrames implements Integration {
 
   /** JSDoc */
   public process(event: Event): Event {
-    const frames = this._getFramesFromEvent(event);
-    if (frames) {
-      for (const i in frames) {
-        // tslint:disable-next-line
-        frames[i] = this._iteratee(frames[i]);
-      }
+    if (event.exception && Array.isArray(event.exception.values)) {
+      return this._processExceptionsEvent(event);
+    }
+
+    if (event.stacktrace) {
+      return this._processStacktraceEvent(event);
     }
+
     return event;
   }
 
   /** JSDoc */
-  private _getFramesFromEvent(event: Event): StackFrame[] | undefined {
-    const exception = event.exception;
+  private _processExceptionsEvent(event: Event): Event {
+    try {
+      return {
+        ...event,
+        exception: {
+          ...event.exception,
+          // The check for this is performed inside `process` call itself, safe to skip here
+          // tslint:disable-next-line:no-non-null-assertion
+          values: event.exception!.values!.map(value => ({
+            ...value,
+            stacktrace: this._processStacktrace(value.stacktrace),
+          })),
+        },
+      };
+    } catch (_oO) {
+      return event;
+    }
+  }
 
-    if (exception) {
-      try {
-        return exception.values && exception.values[0].stacktrace && exception.values[0].stacktrace.frames;
-      } catch (_oO) {
-        return undefined;
-      }
-    } else if (event.stacktrace) {
-      return event.stacktrace.frames;
+  /** JSDoc */
+  private _processStacktraceEvent(event: Event): Event {
+    try {
+      return {
+        ...event,
+        stacktrace: this._processStacktrace(event.stacktrace),
+      };
+    } catch (_oO) {
+      return event;
     }
-    return undefined;
+  }
+
+  /** JSDoc */
+  private _processStacktrace(stacktrace?: Stacktrace): Stacktrace {
+    return {
+      ...stacktrace,
+      frames: stacktrace && stacktrace.frames && stacktrace.frames.map(f => this._iteratee(f)),
+    };
   }
 }

packages/integrations/test/rewriteframes.test.ts

@@ -6,52 +6,53 @@ let rewriteFrames: RewriteFrames;
 let messageEvent: Event;
 let exceptionEvent: Event;
 let windowsExceptionEvent: Event;
+let multipleStacktracesEvent: Event;
 
 describe('RewriteFrames', () => {
   beforeEach(() => {
     messageEvent = {
       stacktrace: {
-        frames: [
-          {
-            filename: '/www/src/app/file1.js',
-          },
+        frames: [{ filename: '/www/src/app/file1.js' }, { filename: '/www/src/app/mo\\dule/file2.js' }],
+      },
+    };
+    exceptionEvent = {
+      exception: {
+        values: [
           {
-            filename: '/www/src/app/mo\\dule/file2.js',
+            stacktrace: {
+              frames: [{ filename: '/www/src/app/file1.js' }, { filename: '/www/src/app/mo\\dule/file2.js' }],
+            },
           },
         ],
       },
     };
-    exceptionEvent = {
+    windowsExceptionEvent = {
       exception: {
         values: [
           {
             stacktrace: {
-              frames: [
-                {
-                  filename: '/www/src/app/file1.js',
-                },
-                {
-                  filename: '/www/src/app/mo\\dule/file2.js',
-                },
-              ],
+              frames: [{ filename: 'C:\\www\\src\\app\\file1.js' }, { filename: 'C:\\www\\src\\app\\file2.js' }],
             },
           },
         ],
       },
     };
-    windowsExceptionEvent = {
+    multipleStacktracesEvent = {
       exception: {
         values: [
           {
             stacktrace: {
-              frames: [
-                {
-                  filename: 'C:\\www\\src\\app\\file1.js',
-                },
-                {
-                  filename: 'C:\\www\\src\\app\\file2.js',
-                },
-              ],
+              frames: [{ filename: '/www/src/app/file1.js' }, { filename: '/www/src/app/mo\\dule/file2.js' }],
+            },
+          },
+          {
+            stacktrace: {
+              frames: [{ filename: '/www/src/app/file3.js' }, { filename: '/www/src/app/mo\\dule/file4.js' }],
+            },
+          },
+          {
+            stacktrace: {
+              frames: [{ filename: '/www/src/app/file5.js' }, { filename: '/www/src/app/mo\\dule/file6.js' }],
             },
           },
         ],
@@ -125,20 +126,103 @@ describe('RewriteFrames', () => {
       });
     });
 
-    it('transforms messageEvent frames', async () => {
+    it('transforms messageEvent frames', () => {
       const event = rewriteFrames.process(messageEvent);
       expect(event.stacktrace!.frames![0].filename).toEqual('/www/src/app/file1.js');
       expect(event.stacktrace!.frames![0].function).toEqual('whoops');
       expect(event.stacktrace!.frames![1].filename).toEqual('/www/src/app/mo\\dule/file2.js');
       expect(event.stacktrace!.frames![1].function).toEqual('whoops');
     });
 
-    it('transforms exceptionEvent frames', async () => {
+    it('transforms exceptionEvent frames', () => {
       const event = rewriteFrames.process(exceptionEvent);
       expect(event.exception!.values![0].stacktrace!.frames![0].filename).toEqual('/www/src/app/file1.js');
       expect(event.exception!.values![0].stacktrace!.frames![0].function).toEqual('whoops');
       expect(event.exception!.values![0].stacktrace!.frames![1].filename).toEqual('/www/src/app/mo\\dule/file2.js');
       expect(event.exception!.values![0].stacktrace!.frames![1].function).toEqual('whoops');
     });
   });
+
+  describe('can process events that contain multiple stacktraces', () => {
+    it('with defaults', () => {
+      rewriteFrames = new RewriteFrames();
+      const event = rewriteFrames.process(multipleStacktracesEvent);
+      // first stacktrace
+      expect(event.exception!.values![0].stacktrace!.frames![0].filename).toEqual('app:///file1.js');
+      expect(event.exception!.values![0].stacktrace!.frames![1].filename).toEqual('app:///file2.js');
+      // second stacktrace
+      expect(event.exception!.values![1].stacktrace!.frames![0].filename).toEqual('app:///file3.js');
+      expect(event.exception!.values![1].stacktrace!.frames![1].filename).toEqual('app:///file4.js');
+      // third stacktrace
+      expect(event.exception!.values![2].stacktrace!.frames![0].filename).toEqual('app:///file5.js');
+      expect(event.exception!.values![2].stacktrace!.frames![1].filename).toEqual('app:///file6.js');
+    });
+
+    it('with custom root', () => {
+      rewriteFrames = new RewriteFrames({
+        root: '/www',
+      });
+      const event = rewriteFrames.process(multipleStacktracesEvent);
+      // first stacktrace
+      expect(event.exception!.values![0].stacktrace!.frames![0].filename).toEqual('app:///src/app/file1.js');
+      expect(event.exception!.values![0].stacktrace!.frames![1].filename).toEqual('app:///src/app/mo\\dule/file2.js');
+      // second stacktrace
+      expect(event.exception!.values![1].stacktrace!.frames![0].filename).toEqual('app:///src/app/file3.js');
+      expect(event.exception!.values![1].stacktrace!.frames![1].filename).toEqual('app:///src/app/mo\\dule/file4.js');
+      // third stacktrace
+      expect(event.exception!.values![2].stacktrace!.frames![0].filename).toEqual('app:///src/app/file5.js');
+      expect(event.exception!.values![2].stacktrace!.frames![1].filename).toEqual('app:///src/app/mo\\dule/file6.js');
+    });
+
+    it('with custom iteratee', () => {
+      rewriteFrames = new RewriteFrames({
+        iteratee: (frame: StackFrame) => ({
+          ...frame,
+          function: 'whoops',
+        }),
+      });
+      const event = rewriteFrames.process(multipleStacktracesEvent);
+      // first stacktrace
+      expect(event.exception!.values![0].stacktrace!.frames![0].filename).toEqual('/www/src/app/file1.js');
+      expect(event.exception!.values![0].stacktrace!.frames![0].function).toEqual('whoops');
+      expect(event.exception!.values![0].stacktrace!.frames![1].filename).toEqual('/www/src/app/mo\\dule/file2.js');
+      expect(event.exception!.values![0].stacktrace!.frames![1].function).toEqual('whoops');
+      // second stacktrace
+      expect(event.exception!.values![1].stacktrace!.frames![0].filename).toEqual('/www/src/app/file3.js');
+      expect(event.exception!.values![1].stacktrace!.frames![0].function).toEqual('whoops');
+      expect(event.exception!.values![1].stacktrace!.frames![1].filename).toEqual('/www/src/app/mo\\dule/file4.js');
+      expect(event.exception!.values![1].stacktrace!.frames![1].function).toEqual('whoops');
+      // third stacktrace
+      expect(event.exception!.values![2].stacktrace!.frames![0].filename).toEqual('/www/src/app/file5.js');
+      expect(event.exception!.values![2].stacktrace!.frames![0].function).toEqual('whoops');
+      expect(event.exception!.values![2].stacktrace!.frames![1].filename).toEqual('/www/src/app/mo\\dule/file6.js');
+      expect(event.exception!.values![2].stacktrace!.frames![1].function).toEqual('whoops');
+    });
+  });
+
+  describe('bails when unable to extract frames', () => {
+    it('no exception values', () => {
+      rewriteFrames = new RewriteFrames({});
+      const brokenEvent = {
+        exception: {
+          values: undefined,
+        },
+      };
+      expect(rewriteFrames.process(brokenEvent)).toEqual(brokenEvent);
+    });
+
+    it('no frames', () => {
+      rewriteFrames = new RewriteFrames({});
+      const brokenEvent = {
+        exception: {
+          values: [
+            {
+              stacktrace: {},
+            },
+          ],
+        },
+      };
+      expect(rewriteFrames.process(brokenEvent)).toEqual(brokenEvent);
+    });
+  });
 });