From 48da4bc54a891adc188674c690b83884b367f7ae Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Fri, 22 Nov 2024 11:22:29 +0000 Subject: [PATCH] feat(utils/core): Deprecate `addRequestDataToEvent` and `extractRequestData` --- docs/migration/draft-v9-migration-guide.md | 2 ++ packages/astro/src/index.server.ts | 2 ++ packages/aws-serverless/src/index.ts | 2 ++ packages/bun/src/index.ts | 2 ++ packages/core/src/integrations/requestdata.ts | 1 + packages/core/src/utils-hoist/index.ts | 2 ++ packages/core/src/utils-hoist/requestdata.ts | 5 +++++ packages/core/test/utils-hoist/requestdata.test.ts | 1 + packages/google-cloud-serverless/src/index.ts | 2 ++ packages/node/src/index.ts | 1 + packages/remix/src/index.server.ts | 2 ++ packages/solidstart/src/server/index.ts | 2 ++ packages/sveltekit/src/server/index.ts | 2 ++ packages/utils/src/index.ts | 2 ++ 14 files changed, 28 insertions(+) diff --git a/docs/migration/draft-v9-migration-guide.md b/docs/migration/draft-v9-migration-guide.md index 1b8cab48aec0..fa628a7b8a74 100644 --- a/docs/migration/draft-v9-migration-guide.md +++ b/docs/migration/draft-v9-migration-guide.md @@ -8,6 +8,8 @@ be removed in v9. - Deprecated `TransactionNamingScheme` type. - Deprecated `urlEncode`. No replacements. +- Deprecated `addRequestDataToEvent`. Use `addNormalizedRequestDataToEvent` instead. +- Deprecated `extractRequestData`. Instead manually extract relevant data off request. ## `@sentry/core` diff --git a/packages/astro/src/index.server.ts b/packages/astro/src/index.server.ts index 92e175b9205e..922fdd15dce1 100644 --- 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 index e5e38100a257..369e8824a3b9 100644 --- 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 index 29776ef4ab1d..02718da1153c 100644 --- 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 index ae016959d9c3..cce86a8966c8 100644 --- 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 index b6bb7151a7e3..7f1c45335685 100644 --- a/packages/core/src/utils-hoist/index.ts +++ b/packages/core/src/utils-hoist/index.ts @@ -68,9 +68,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 index 5a40c1fa5945..975b993f69c7 100644 --- 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 index 0b1f198ebddc..3df3ee7e84eb 100644 --- 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 index 5be557af86c5..415062811fb8 100644 --- 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 index 2df1e48767ce..df6cce5383a3 100644 --- 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 index d61f759dbf38..2e7dd3708806 100644 --- 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 index b2faa21768ba..d709a373e501 100644 --- 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 index c954d4b1bf78..4247dd46ff7a 100644 --- 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 index 17e2bb02aa99..4112ae78653c 100644 --- a/packages/utils/src/index.ts +++ b/packages/utils/src/index.ts @@ -154,7 +154,9 @@ export { // eslint-disable-next-line deprecation/deprecation extractPathForTransaction, DEFAULT_USER_INCLUDES, + // eslint-disable-next-line deprecation/deprecation extractRequestData, + // eslint-disable-next-line deprecation/deprecation addRequestDataToEvent, _asyncNullishCoalesce, _asyncOptionalChain,