feat: toRoot option for ExtraErrorData integration

Author: CPatchane

packages/integrations/src/extraerrordata.ts

@@ -4,6 +4,7 @@ import { isError, isPlainObject, logger, normalize } from '@sentry/utils';
 /** JSDoc */
 interface ExtraErrorDataOptions {
   depth?: number;
+  toRoot?: boolean;
 }
 
 /** Patch toString calls to return proper name for wrapped functions */
@@ -21,7 +22,7 @@ export class ExtraErrorData implements Integration {
   /**
    * @inheritDoc
    */
-  public constructor(private readonly _options: ExtraErrorDataOptions = { depth: 3 }) {}
+  public constructor(private readonly _options: ExtraErrorDataOptions = { depth: 3, toRoot: false }) {}
 
   /**
    * @inheritDoc
@@ -89,9 +90,11 @@ export class ExtraErrorData implements Integration {
           // tslint:disable:no-unsafe-any
           extraErrorInfo[key] = value;
         }
-        result = {
-          [name]: extraErrorInfo,
-        };
+        result = this._options.toRoot
+          ? extraErrorInfo
+          : {
+              [name]: extraErrorInfo,
+            };
       }
     } catch (oO) {
       logger.error('Unable to extract extra data from the Error object:', oO);

packages/integrations/test/extraerrordata.test.ts

@@ -3,6 +3,7 @@ import { ExtendedError, SentryEvent } from '@sentry/types';
 import { ExtraErrorData } from '../src/extraerrordata';
 
 const extraErrorData = new ExtraErrorData();
+const extraErrorDataWithToRoot = new ExtraErrorData({ toRoot: true });
 let event: SentryEvent;
 
 describe('ExtraErrorData()', () => {
@@ -63,6 +64,45 @@ describe('ExtraErrorData()', () => {
     });
   });
 
+  it('should append extra data to root if `toRoot` is option provided', () => {
+    event = {
+      extra: {
+        foo: 42,
+      },
+    };
+    const error = new TypeError('foo') as ExtendedError;
+    error.baz = 42;
+
+    const enhancedEvent = extraErrorDataWithToRoot.enhanceEventWithErrorData(event, {
+      originalException: error,
+    });
+
+    expect(enhancedEvent.extra).toEqual({
+      baz: 42,
+      foo: 42,
+    });
+  });
+
+  it('should overwrite to root if data existing in extra field and if `toRoot` is option provided', () => {
+    event = {
+      extra: {
+        foo: 40,
+      },
+    };
+    const error = new TypeError('foo') as ExtendedError;
+    error.baz = 42;
+    error.foo = 42;
+
+    const enhancedEvent = extraErrorDataWithToRoot.enhanceEventWithErrorData(event, {
+      originalException: error,
+    });
+
+    expect(enhancedEvent.extra).toEqual({
+      baz: 42,
+      foo: 42,
+    });
+  });
+
   it('should return event if originalException is not an Error object', () => {
     const error = 'error message, not object';