feat(utils/core): Deprecate addRequestDataToEvent and `extractReque…

…stData` (#14430)
getsentry · Nov 22, 2024 · d49f1cb · d49f1cb
1 parent 498d6d1
commit d49f1cb
Show file tree

Hide file tree

Showing 14 changed files with 28 additions and 0 deletions.
diff --git a/docs/migration/draft-v9-migration-guide.md b/docs/migration/draft-v9-migration-guide.md
@@ -11,6 +11,8 @@
 - Deprecated `TransactionNamingScheme` type.
 - Deprecated `validSeverityLevels`. Will not be replaced.
 - Deprecated `urlEncode`. No replacements.
+- Deprecated `addRequestDataToEvent`. Use `addNormalizedRequestDataToEvent` instead.
+- Deprecated `extractRequestData`. Instead manually extract relevant data off request.
 - Deprecated `arrayify`. No replacements.
 
 ## `@sentry/core`

diff --git a/packages/astro/src/index.server.ts b/packages/astro/src/index.server.ts
@@ -12,6 +12,7 @@ export {
   addEventProcessor,
   addIntegration,
   addOpenTelemetryInstrumentation,
+  // eslint-disable-next-line deprecation/deprecation
   addRequestDataToEvent,
   amqplibIntegration,
   anrIntegration,
@@ -39,6 +40,7 @@ export {
   endSession,
   expressErrorHandler,
   expressIntegration,
+  // eslint-disable-next-line deprecation/deprecation
   extractRequestData,
   extraErrorDataIntegration,
   fastifyIntegration,

diff --git a/packages/aws-serverless/src/index.ts b/packages/aws-serverless/src/index.ts
@@ -42,8 +42,10 @@ export {
   flush,
   close,
   getSentryRelease,
+  // eslint-disable-next-line deprecation/deprecation
   addRequestDataToEvent,
   DEFAULT_USER_INCLUDES,
+  // eslint-disable-next-line deprecation/deprecation
   extractRequestData,
   createGetModuleFromFilename,
   anrIntegration,

diff --git a/packages/bun/src/index.ts b/packages/bun/src/index.ts
@@ -64,8 +64,10 @@ export {
   flush,
   close,
   getSentryRelease,
+  // eslint-disable-next-line deprecation/deprecation
   addRequestDataToEvent,
   DEFAULT_USER_INCLUDES,
+  // eslint-disable-next-line deprecation/deprecation
   extractRequestData,
   createGetModuleFromFilename,
   anrIntegration,

diff --git a/packages/core/src/integrations/requestdata.ts b/packages/core/src/integrations/requestdata.ts
@@ -98,6 +98,7 @@ const _requestDataIntegration = ((options: RequestDataIntegrationOptions = {}) =
         return event;
       }
 
+      // eslint-disable-next-line deprecation/deprecation
       return addRequestDataToEvent(event, request, addRequestDataOptions);
     },
   };

diff --git a/packages/core/src/utils-hoist/index.ts b/packages/core/src/utils-hoist/index.ts
@@ -69,9 +69,11 @@ export type { PromiseBuffer } from './promisebuffer';
 export {
   DEFAULT_USER_INCLUDES,
   addNormalizedRequestDataToEvent,
+  // eslint-disable-next-line deprecation/deprecation
   addRequestDataToEvent,
   // eslint-disable-next-line deprecation/deprecation
   extractPathForTransaction,
+  // eslint-disable-next-line deprecation/deprecation
   extractRequestData,
   winterCGHeadersToDict,
   winterCGRequestToRequestData,

diff --git a/packages/core/src/utils-hoist/requestdata.ts b/packages/core/src/utils-hoist/requestdata.ts
@@ -134,6 +134,8 @@ function extractUserData(
  * DEFAULT_REQUEST_INCLUDES if not provided.
  * @param options.deps Injected, platform-specific dependencies
  * @returns An object containing normalized request data
+ *
+ * @deprecated Instead manually normalize the request data into a format that fits `addNormalizedRequestDataToEvent`.
  */
 export function extractRequestData(
   req: PolymorphicRequest,
@@ -318,6 +320,8 @@ export function addNormalizedRequestDataToEvent(
  * @param options.include Flags to control what data is included
  * @param options.deps Injected platform-specific dependencies
  * @returns The mutated `Event` object
+ *
+ * @deprecated Use `addNormalizedRequestDataToEvent` instead.
  */
 export function addRequestDataToEvent(
   event: Event,
@@ -335,6 +339,7 @@ export function addRequestDataToEvent(
       includeRequest.push('ip');
     }
 
+    // eslint-disable-next-line deprecation/deprecation
     const extractedRequestData = extractRequestData(req, { include: includeRequest });
 
     event.request = {

diff --git a/packages/core/test/utils-hoist/requestdata.test.ts b/packages/core/test/utils-hoist/requestdata.test.ts
@@ -1,3 +1,4 @@
+/* eslint-disable deprecation/deprecation */
 import type * as net from 'net';
 import { addRequestDataToEvent, extractPathForTransaction, extractRequestData } from '@sentry/core';
 import type { Event, PolymorphicRequest, TransactionSource, User } from '@sentry/types';

diff --git a/packages/google-cloud-serverless/src/index.ts b/packages/google-cloud-serverless/src/index.ts
@@ -42,8 +42,10 @@ export {
   flush,
   close,
   getSentryRelease,
+  // eslint-disable-next-line deprecation/deprecation
   addRequestDataToEvent,
   DEFAULT_USER_INCLUDES,
+  // eslint-disable-next-line deprecation/deprecation
   extractRequestData,
   createGetModuleFromFilename,
   anrIntegration,

diff --git a/packages/node/src/index.ts b/packages/node/src/index.ts
@@ -57,6 +57,7 @@ export { cron } from './cron';
 
 export type { NodeOptions } from './types';
 
+// eslint-disable-next-line deprecation/deprecation
 export { addRequestDataToEvent, DEFAULT_USER_INCLUDES, extractRequestData } from '@sentry/core';
 
 export {

diff --git a/packages/remix/src/index.server.ts b/packages/remix/src/index.server.ts
@@ -17,6 +17,7 @@ export {
   addEventProcessor,
   addIntegration,
   addOpenTelemetryInstrumentation,
+  // eslint-disable-next-line deprecation/deprecation
   addRequestDataToEvent,
   amqplibIntegration,
   anrIntegration,
@@ -43,6 +44,7 @@ export {
   endSession,
   expressErrorHandler,
   expressIntegration,
+  // eslint-disable-next-line deprecation/deprecation
   extractRequestData,
   extraErrorDataIntegration,
   fastifyIntegration,

diff --git a/packages/solidstart/src/server/index.ts b/packages/solidstart/src/server/index.ts
@@ -8,6 +8,7 @@ export {
   addEventProcessor,
   addIntegration,
   addOpenTelemetryInstrumentation,
+  // eslint-disable-next-line deprecation/deprecation
   addRequestDataToEvent,
   amqplibIntegration,
   anrIntegration,
@@ -34,6 +35,7 @@ export {
   endSession,
   expressErrorHandler,
   expressIntegration,
+  // eslint-disable-next-line deprecation/deprecation
   extractRequestData,
   extraErrorDataIntegration,
   fastifyIntegration,

diff --git a/packages/sveltekit/src/server/index.ts b/packages/sveltekit/src/server/index.ts
@@ -8,6 +8,7 @@ export {
   addEventProcessor,
   addIntegration,
   addOpenTelemetryInstrumentation,
+  // eslint-disable-next-line deprecation/deprecation
   addRequestDataToEvent,
   amqplibIntegration,
   anrIntegration,
@@ -34,6 +35,7 @@ export {
   endSession,
   expressErrorHandler,
   expressIntegration,
+  // eslint-disable-next-line deprecation/deprecation
   extractRequestData,
   extraErrorDataIntegration,
   fastifyIntegration,

diff --git a/packages/utils/src/index.ts b/packages/utils/src/index.ts
@@ -634,9 +634,11 @@ export const extractPathForTransaction = extractPathForTransaction_imported;
 export const DEFAULT_USER_INCLUDES = DEFAULT_USER_INCLUDES_imported;
 
 /** @deprecated Import from `@sentry/core` instead. */
+// eslint-disable-next-line deprecation/deprecation
 export const extractRequestData = extractRequestData_imported;
 
 /** @deprecated Import from `@sentry/core` instead. */
+// eslint-disable-next-line deprecation/deprecation
 export const addRequestDataToEvent = addRequestDataToEvent_imported;
 
 /** @deprecated Import from `@sentry/core` instead. */
-Original file line number
+Diff line change
@@ Expand Up @@
             return event;
           }
+          // eslint-disable-next-line deprecation/deprecation
           return addRequestDataToEvent(event, request, addRequestDataOptions);
         },
       };
@@ Expand Down @@