expose proper util to set normalized request

Author: mydea

packages/core/src/index.ts

@@ -68,6 +68,7 @@ export { hasTracingEnabled } from './utils/hasTracingEnabled';
 export { isSentryRequestUrl } from './utils/isSentryRequestUrl';
 export { handleCallbackErrors } from './utils/handleCallbackErrors';
 export { parameterize } from './utils/parameterize';
+export { setNormalizedRequest } from './utils/sdkProcessingMetadata';
 export {
   spanToTraceHeader,
   spanToJSON,

packages/core/src/scope.ts

@@ -24,7 +24,6 @@ import type {
 import { dateTimestampInSeconds, generatePropagationContext, isPlainObject, logger, uuid4 } from '@sentry/utils';
 
 import { updateSession } from './session';
-import { mergeSdkProcessingMetadata } from './utils/mergeSdkProcessingMetadata';
 import { _getSpanForScope, _setSpanForScope } from './utils/spanOnScope';
 
 /**
@@ -480,7 +479,7 @@ class ScopeClass implements ScopeInterface {
    * @inheritDoc
    */
   public setSDKProcessingMetadata(newData: { [key: string]: unknown }): this {
-    this._sdkProcessingMetadata = mergeSdkProcessingMetadata(this._sdkProcessingMetadata, newData);
+    this._sdkProcessingMetadata = { ...this._sdkProcessingMetadata, ...newData };
     return this;
   }
 

packages/core/src/utils/applyScopeDataToEvent.ts

@@ -1,7 +1,7 @@
 import type { Breadcrumb, Event, ScopeData, Span } from '@sentry/types';
 import { arrayify, dropUndefinedKeys } from '@sentry/utils';
 import { getDynamicSamplingContextFromSpan } from '../tracing/dynamicSamplingContext';
-import { mergeSdkProcessingMetadata } from './mergeSdkProcessingMetadata';
+import { mergeSdkProcessingMetadata } from './sdkProcessingMetadata';
 import { getRootSpan, spanToJSON, spanToTraceContext } from './spanUtils';
 
 /**

packages/core/src/utils/mergeSdkProcessingMetadata.ts renamed to packages/core/src/utils/sdkProcessingMetadata.ts

@@ -1,4 +1,5 @@
-import type { ScopeData } from '@sentry/types';
+import type { Request, ScopeData } from '@sentry/types';
+import { getIsolationScope } from '../currentScopes';
 
 /**
  * Merge new SDK processing metadata into existing data.
@@ -28,3 +29,19 @@ export function mergeSdkProcessingMetadata(
 
   return newData;
 }
+
+/**
+ * Set a normalizedRequest on the scope, ensuring it merges with potentially existing request data.
+ * By default, this will put this data on the isolation scope,
+ * but you can also pass a different scope to set the data on.
+ */
+export function setNormalizedRequest(normalizedRequest: Request, scope = getIsolationScope()): void {
+  const normalizedRequestBefore = scope.getScopeData().sdkProcessingMetadata['normalizedRequest'];
+
+  const newNormalizedRequest = {
+    ...(normalizedRequestBefore || {}),
+    ...normalizedRequest,
+  } satisfies Request;
+
+  scope.setSDKProcessingMetadata({ normalizedRequest: newNormalizedRequest });
+}

packages/core/test/lib/scope.test.ts

@@ -211,7 +211,7 @@ describe('Scope', () => {
         expect(scope['_sdkProcessingMetadata'].dogs).toEqual('are great!');
       });
 
-      test('it overwrites arbitrary data', () => {
+      test('it overwrites data', () => {
         const scope = new Scope();
         scope.setSDKProcessingMetadata({ dogs: 'are great!' });
         scope.setSDKProcessingMetadata({ dogs: 'are really great!' });
@@ -225,26 +225,6 @@ describe('Scope', () => {
           obj: { nested2: 'value2' },
         });
       });
-
-      test('it merges normalizedRequest data', () => {
-        const scope = new Scope();
-        scope.setSDKProcessingMetadata({
-          normalizedRequest: {
-            url: 'value1',
-            method: 'value1',
-          },
-        });
-        scope.setSDKProcessingMetadata({
-          normalizedRequest: {
-            url: 'value2',
-            headers: {},
-          },
-        });
-
-        expect(scope['_sdkProcessingMetadata']).toEqual({
-          normalizedRequest: { url: 'value2', method: 'value1', headers: {} },
-        });
-      });
     });
 
     test('set and get propagation context', () => {

packages/core/test/lib/utils/mergeSdkProcessingMetadata.test.ts renamed to packages/core/test/lib/utils/sdkProcessingMetadata.test.ts

@@ -1,4 +1,4 @@
-import { mergeSdkProcessingMetadata } from '../../../src/utils/mergeSdkProcessingMetadata';
+import { mergeSdkProcessingMetadata } from '../../../src/utils/sdkProcessingMetadata';
 
 describe('mergeSdkProcessingMetadata', () => {
   it('works with empty objects', () => {

packages/node/src/integrations/http/SentryHttpInstrumentation.ts

@@ -5,7 +5,7 @@ import { VERSION } from '@opentelemetry/core';
 import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
 import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
 import { getRequestInfo } from '@opentelemetry/instrumentation-http';
-import { addBreadcrumb, getClient, getIsolationScope, withIsolationScope } from '@sentry/core';
+import { addBreadcrumb, getClient, getIsolationScope, setNormalizedRequest, withIsolationScope } from '@sentry/core';
 import type { PolymorphicRequest, Request, SanitizedRequestData } from '@sentry/types';
 import {
   getBreadcrumbLogLevelFromHttpStatusCode,
@@ -153,7 +153,9 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
         patchRequestToCaptureBody(request, normalizedRequest);
 
         // Update the isolation scope, isolate this request
-        isolationScope.setSDKProcessingMetadata({ request, normalizedRequest });
+        // TODO(v9): Stop setting `request`, we only rely on normalizedRequest anymore
+        isolationScope.setSDKProcessingMetadata({ request });
+        setNormalizedRequest(normalizedRequest, isolationScope);
 
         const client = getClient<NodeClient>();
         if (client && client.getOptions().autoSessionTracking) {