Revert "ref: Deprecate top-level stacktrace (#2214)"

This reverts commit 36d206c.

Author: kamilogorek

CHANGELOG.md

@@ -2,8 +2,7 @@
 
 ## 5.6.3
 
-- [browser] fix: Don't capture our own XHR events that somehow bubbled-up to global handler (#2221)
-- [core] ref: Soft-deprecate top-level stacktrace event attribute (#2214)
+- [browser] fix: Don't capture our own XHR events that somehow bubbled-up to global handler
 
 ## 5.6.2
 

packages/browser/src/backend.ts

@@ -151,13 +151,9 @@ export class BrowserBackend extends BaseBackend<BrowserOptions> {
     if (this._options.attachStacktrace && hint && hint.syntheticException) {
       const stacktrace = _computeStackTrace(hint.syntheticException);
       const frames = prepareFramesForEvent(stacktrace.stack);
-      event.threads = [
-        {
-          stacktrace: {
-            frames,
-          },
-        },
-      ];
+      event.stacktrace = {
+        frames,
+      };
     }
 
     return SyncPromise.resolve(event);

packages/browser/src/parsers.ts

@@ -45,13 +45,9 @@ export function eventFromPlainObject(exception: {}, syntheticException: Error |
   if (syntheticException) {
     const stacktrace = _computeStackTrace(syntheticException);
     const frames = prepareFramesForEvent(stacktrace.stack);
-    event.threads = [
-      {
-        stacktrace: {
-          frames,
-        },
-      },
-    ];
+    event.stacktrace = {
+      frames,
+    };
   }
 
   return event;

packages/core/src/integrations/inboundfilters.ts

@@ -161,7 +161,6 @@ export class InboundFilters implements Integration {
   /** JSDoc */
   private _getEventFilterUrl(event: Event): string | null {
     try {
-      // tslint:disable-next-line:deprecation
       if (event.stacktrace) {
         // tslint:disable:no-unsafe-any
         const frames = (event as any).stacktrace.frames;
@@ -172,11 +171,6 @@ export class InboundFilters implements Integration {
         const frames = (event as any).exception.values[0].stacktrace.frames;
         return frames[frames.length - 1].filename;
       }
-      if (event.threads) {
-        // tslint:disable:no-unsafe-any
-        const frames = (event as any).threads[0].stacktrace.frames;
-        return frames[frames.length - 1].filename;
-      }
       return null;
     } catch (oO) {
       logger.error(`Cannot extract url for event ${getEventDescription(event)}`);

packages/integrations/src/dedupe.ts

@@ -1,7 +1,5 @@
 import { Event, EventProcessor, Exception, Hub, Integration, StackFrame } from '@sentry/types';
 
-import { getFramesFromEvent } from './helpers';
-
 /** Deduplication filter */
 export class Dedupe implements Integration {
   /**
@@ -88,10 +86,27 @@ export class Dedupe implements Integration {
     return true;
   }
 
+  /** JSDoc */
+  private _getFramesFromEvent(event: Event): StackFrame[] | undefined {
+    const exception = event.exception;
+
+    if (exception) {
+      try {
+        // @ts-ignore
+        return exception.values[0].stacktrace.frames;
+      } catch (_oO) {
+        return undefined;
+      }
+    } else if (event.stacktrace) {
+      return event.stacktrace.frames;
+    }
+    return undefined;
+  }
+
   /** JSDoc */
   private _isSameStacktrace(currentEvent: Event, previousEvent: Event): boolean {
-    let currentFrames = getFramesFromEvent(currentEvent);
-    let previousFrames = getFramesFromEvent(previousEvent);
+    let currentFrames = this._getFramesFromEvent(currentEvent);
+    let previousFrames = this._getFramesFromEvent(previousEvent);
 
     // If no event has a fingerprint, they are assumed to be the same
     if (!currentFrames && !previousFrames) {

packages/integrations/src/helpers.ts

@@ -1,8 +1,6 @@
 import { Event, EventProcessor, Hub, Integration, StackFrame } from '@sentry/types';
 import { basename, relative } from '@sentry/utils';
 
-import { getFramesFromEvent } from './helpers';
-
 type StackFrameIteratee = (frame: StackFrame) => StackFrame;
 
 /** Rewrite event frames paths */
@@ -60,11 +58,30 @@ export class RewriteFrames implements Integration {
 
   /** JSDoc */
   public process(event: Event): Event {
-    const frames = getFramesFromEvent(event) || [];
-    for (const i in frames) {
-      // tslint:disable-next-line
-      frames[i] = this._iteratee(frames[i]);
+    const frames = this._getFramesFromEvent(event);
+    if (frames) {
+      for (const i in frames) {
+        // tslint:disable-next-line
+        frames[i] = this._iteratee(frames[i]);
+      }
     }
     return event;
   }
+
+  /** JSDoc */
+  private _getFramesFromEvent(event: Event): StackFrame[] | undefined {
+    const exception = event.exception;
+
+    if (exception) {
+      try {
+        // tslint:disable-next-line:no-unsafe-any
+        return (exception as any).values[0].stacktrace.frames;
+      } catch (_oO) {
+        return undefined;
+      }
+    } else if (event.stacktrace) {
+      return event.stacktrace.frames;
+    }
+    return undefined;
+  }
 }

packages/integrations/src/rewriteframes.ts

@@ -1,7 +1,5 @@
 import { Event, EventProcessor, Hub, Integration, StackFrame } from '@sentry/types';
 
-import { getFramesFromEvent } from './helpers';
-
 /** Add node transaction to the event */
 export class Transaction implements Integration {
   /**
@@ -30,7 +28,7 @@ export class Transaction implements Integration {
    * @inheritDoc
    */
   public process(event: Event): Event {
-    const frames = getFramesFromEvent(event) || [];
+    const frames = this._getFramesFromEvent(event);
 
     // use for loop so we don't have to reverse whole frames array
     for (let i = frames.length - 1; i >= 0; i--) {
@@ -45,6 +43,12 @@ export class Transaction implements Integration {
     return event;
   }
 
+  /** JSDoc */
+  private _getFramesFromEvent(event: Event): StackFrame[] {
+    const exception = event.exception && event.exception.values && event.exception.values[0];
+    return (exception && exception.stacktrace && exception.stacktrace.frames) || [];
+  }
+
   /** JSDoc */
   private _getTransaction(frame: StackFrame): string {
     return frame.module || frame.function ? `${frame.module || '?'}/${frame.function || '?'}` : '<unknown>';

packages/integrations/src/transaction.ts

@@ -1,13 +1,10 @@
-// tslint:disable:deprecation
-
 import { Event, StackFrame } from '@sentry/types';
 
 import { RewriteFrames } from '../src/rewriteframes';
 
 let rewriteFrames: RewriteFrames;
 let messageEvent: Event;
 let exceptionEvent: Event;
-let threadEvent: Event;
 
 describe('RewriteFrames', () => {
   beforeEach(() => {
@@ -41,22 +38,6 @@ describe('RewriteFrames', () => {
         ],
       },
     };
-    threadEvent = {
-      threads: [
-        {
-          stacktrace: {
-            frames: [
-              {
-                filename: '/www/src/app/file1.js',
-              },
-              {
-                filename: '/www/src/app/file2.js',
-              },
-            ],
-          },
-        },
-      ],
-    };
   });
 
   describe('default iteratee appends basename to `app:///` if frame starts with `/`', () => {
@@ -75,12 +56,6 @@ describe('RewriteFrames', () => {
       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');
     });
-
-    it('transforms threadEvent frames', () => {
-      const event = rewriteFrames.process(threadEvent);
-      expect(event.threads![0].stacktrace!.frames![0].filename).toEqual('app:///file1.js');
-      expect(event.threads![0].stacktrace!.frames![1].filename).toEqual('app:///file2.js');
-    });
   });
 
   describe('can use custom root to perform `relative` on filepaths', () => {
@@ -101,12 +76,6 @@ describe('RewriteFrames', () => {
       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/file2.js');
     });
-
-    it('transforms threadEvent frames', async () => {
-      const event = rewriteFrames.process(threadEvent);
-      expect(event.threads![0].stacktrace!.frames![0].filename).toEqual('app:///src/app/file1.js');
-      expect(event.threads![0].stacktrace!.frames![1].filename).toEqual('app:///src/app/file2.js');
-    });
   });
 
   describe('can use custom iteratee', () => {
@@ -134,13 +103,5 @@ describe('RewriteFrames', () => {
       expect(event.exception!.values![0].stacktrace!.frames![1].filename).toEqual('/www/src/app/file2.js');
       expect(event.exception!.values![0].stacktrace!.frames![1].function).toEqual('whoops');
     });
-
-    it('transforms threadEvent frames', async () => {
-      const event = rewriteFrames.process(threadEvent);
-      expect(event.threads![0].stacktrace!.frames![0].filename).toEqual('/www/src/app/file1.js');
-      expect(event.threads![0].stacktrace!.frames![0].function).toEqual('whoops');
-      expect(event.threads![0].stacktrace!.frames![1].filename).toEqual('/www/src/app/file2.js');
-      expect(event.threads![0].stacktrace!.frames![1].function).toEqual('whoops');
-    });
   });
 });

packages/integrations/test/helpers.test.ts

@@ -130,13 +130,9 @@ export class NodeBackend extends BaseBackend<NodeOptions> {
       if (this._options.attachStacktrace && hint && hint.syntheticException) {
         const stack = hint.syntheticException ? extractStackFromError(hint.syntheticException) : [];
         parseStack(stack, this._options).then(frames => {
-          event.threads = [
-            {
-              stacktrace: {
-                frames: prepareFramesForEvent(frames),
-              },
-            },
-          ];
+          event.stacktrace = {
+            frames: prepareFramesForEvent(frames),
+          };
           resolve(event);
         });
       } else {