rename field to sdkProcessingMetadata

Author: lobsterkatie

packages/core/src/request.ts

@@ -64,7 +64,7 @@ export function eventToSentryRequest(event: Event, api: APIDetails): SentryReque
   }
 
   // prevent this data from being sent to sentry
-  delete event.processingMetadata;
+  delete event.sdkProcessingMetadata;
 
   const req: SentryRequest = {
     body: JSON.stringify(sdkInfo ? enhanceEventWithSdkInfo(event, api.metadata.sdk) : event),

packages/core/test/lib/request.test.ts

@@ -164,7 +164,7 @@ describe('eventToSentryRequest', () => {
   });
 
   it('removes processing metadata before serializing event', () => {
-    event.processingMetadata = { dogs: 'are great!' };
+    event.sdkProcessingMetadata = { dogs: 'are great!' };
 
     const result = eventToSentryRequest(event, api);
     const envelope = parseEnvelopeRequest(result);

packages/hub/src/scope.ts

@@ -79,7 +79,7 @@ export class Scope implements ScopeInterface {
    * A place to stash data which is needed at some point in the SDK's event processing pipeline but which shouldn't get
    * sent to Sentry
    */
-  protected _processingMetadata?: { [key: string]: any } = {};
+  protected _sdkProcessingMetadata?: { [key: string]: any } = {};
 
   /**
    * Inherit values from the parent scope.
@@ -447,16 +447,16 @@ export class Scope implements ScopeInterface {
     event.breadcrumbs = [...(event.breadcrumbs || []), ...this._breadcrumbs];
     event.breadcrumbs = event.breadcrumbs.length > 0 ? event.breadcrumbs : undefined;
 
-    event.processingMetadata = this._processingMetadata;
+    event.sdkProcessingMetadata = this._sdkProcessingMetadata;
 
     return this._notifyEventProcessors([...getGlobalEventProcessors(), ...this._eventProcessors], event, hint);
   }
 
   /**
    * Add data which will be accessible during event processing but won't get sent to Sentry
    */
-  public setProcessingMetadata(newData: { [key: string]: any }): this {
-    this._processingMetadata = { ...this._processingMetadata, ...newData };
+  public setSDKProcessingMetadata(newData: { [key: string]: any }): this {
+    this._sdkProcessingMetadata = { ...this._sdkProcessingMetadata, ...newData };
 
     return this;
   }

packages/hub/test/scope.test.ts

@@ -131,8 +131,8 @@ describe('Scope', () => {
 
     test('setProcessingMetadata', () => {
       const scope = new Scope();
-      scope.setProcessingMetadata({ dogs: 'are great!' });
-      expect((scope as any)._processingMetadata.dogs).toEqual('are great!');
+      scope.setSDKProcessingMetadata({ dogs: 'are great!' });
+      expect((scope as any)._sdkProcessingMetadata.dogs).toEqual('are great!');
     });
 
     test('chaining', () => {
@@ -206,7 +206,7 @@ describe('Scope', () => {
       scope.setTransactionName('/abc');
       scope.addBreadcrumb({ message: 'test' });
       scope.setContext('os', { id: '1' });
-      scope.setProcessingMetadata({ dogs: 'are great!' });
+      scope.setSDKProcessingMetadata({ dogs: 'are great!' });
 
       const event: Event = {};
       return scope.applyToEvent(event).then(processedEvent => {
@@ -218,7 +218,7 @@ describe('Scope', () => {
         expect(processedEvent!.transaction).toEqual('/abc');
         expect(processedEvent!.breadcrumbs![0]).toHaveProperty('message', 'test');
         expect(processedEvent!.contexts).toEqual({ os: { id: '1' } });
-        expect(processedEvent!.processingMetadata).toEqual({ dogs: 'are great!' });
+        expect(processedEvent!.sdkProcessingMetadata).toEqual({ dogs: 'are great!' });
       });
     });
 

packages/types/src/event.ts

@@ -45,7 +45,7 @@ export interface Event {
   measurements?: Measurements;
   debug_meta?: DebugMeta;
   // A place to stash data which is needed at some point in the SDK's event processing pipeline but which shouldn't get sent to Sentry
-  processingMetadata?: { [key: string]: any };
+  sdkProcessingMetadata?: { [key: string]: any };
 }
 
 /** JSDoc */