s/parseRequest/addRequestDataToEvent

Author: lobsterkatie

packages/nextjs/src/utils/instrumentServer.ts

@@ -1,10 +1,10 @@
 /* eslint-disable max-lines */
 import {
+  addRequestDataToEvent,
   captureException,
   configureScope,
   deepReadDirSync,
   getCurrentHub,
-  parseRequest,
   startTransaction,
 } from '@sentry/node';
 import { extractTraceparentData, getActiveTransaction, hasTracingEnabled } from '@sentry/tracing';
@@ -244,7 +244,7 @@ function makeWrappedReqHandler(origReqHandler: ReqHandler): WrappedReqHandler {
       const currentScope = getCurrentHub().getScope();
 
       if (currentScope) {
-        currentScope.addEventProcessor(event => parseRequest(event, nextReq));
+        currentScope.addEventProcessor(event => addRequestDataToEvent(event, nextReq));
 
         // We only want to record page and API requests
         if (hasTracingEnabled() && shouldTraceRequest(nextReq.url, publicDirFiles)) {

packages/nextjs/src/utils/withSentry.ts

@@ -1,4 +1,4 @@
-import { captureException, flush, getCurrentHub, parseRequest, startTransaction } from '@sentry/node';
+import { addRequestDataToEvent, captureException, flush, getCurrentHub, startTransaction } from '@sentry/node';
 import { extractTraceparentData, hasTracingEnabled } from '@sentry/tracing';
 import { Transaction } from '@sentry/types';
 import {
@@ -41,7 +41,7 @@ export const withSentry = (origHandler: NextApiHandler): WrappedNextApiHandler =
       const currentScope = getCurrentHub().getScope();
 
       if (currentScope) {
-        currentScope.addEventProcessor(event => parseRequest(event, req));
+        currentScope.addEventProcessor(event => addRequestDataToEvent(event, req));
 
         if (hasTracingEnabled()) {
           // If there is a trace header set, extract the data from it (parentSpanId, traceId, and sampling decision)

packages/node/src/handlers.ts

@@ -3,15 +3,15 @@ import { captureException, getCurrentHub, startTransaction, withScope } from '@s
 import { Event, ExtractedNodeRequestData, Span } from '@sentry/types';
 import {
   addExpressReqToTransaction,
+  addRequestDataToEvent,
+  AddRequestDataToEventOptions,
   ExpressRequest as _ExpressRequest,
   extractExpressTransactionName,
   extractRequestData as _extractRequestData,
   extractTraceparentData,
   isString,
   logger,
   parseBaggageString,
-  parseRequest as _parseRequest,
-  ParseRequestOptions as _ParseRequestOptions,
 } from '@sentry/utils';
 import * as domain from 'domain';
 import * as http from 'http';
@@ -74,7 +74,7 @@ export function tracingHandler(): (
   };
 }
 
-export type RequestHandlerOptions = ParseRequestOptions & {
+export type RequestHandlerOptions = AddRequestDataToEventOptions & {
   flushTimeout?: number;
 };
 
@@ -126,7 +126,7 @@ export function requestHandler(
       const currentHub = getCurrentHub();
 
       currentHub.configureScope(scope => {
-        scope.addEventProcessor((event: Event) => parseRequest(event, req, options));
+        scope.addEventProcessor((event: Event) => addRequestDataToEvent(event, req, options));
         const client = currentHub.getClient<NodeClient>();
         if (isAutoSessionTrackingEnabled(client)) {
           const scope = currentHub.getScope();
@@ -247,9 +247,9 @@ export function errorHandler(options?: {
 // TODO (v8 / #5190): Remove this
 /**
  * Options deciding what parts of the request to use when enhancing an event
- * @deprecated `Handlers.ParseRequestOptions` is deprecated.Use `ParseRequestOptions` instead
+ * @deprecated `Handlers.ParseRequestOptions` is deprecated.Use `AddRequestDataToEventOptions` instead
  */
-export type ParseRequestOptions = _ParseRequestOptions;
+export type ParseRequestOptions = AddRequestDataToEventOptions;
 
 // TODO (v8 / #5190): Remove this
 /**
@@ -258,12 +258,12 @@ export type ParseRequestOptions = _ParseRequestOptions;
  * @param event Will be mutated and enriched with req data
  * @param req Request object
  * @param options object containing flags to enable functionality
- * @deprecated `Handlers.parseRequest` is deprecated. Use `parseRequest` instead.
+ * @deprecated `Handlers.parseRequest` is deprecated. Use `addRequestDataToEvent` instead.
  * @hidden
  */
 // eslint-disable-next-line deprecation/deprecation
 export function parseRequest(event: Event, req: ExpressRequest, options?: ParseRequestOptions): Event {
-  return _parseRequest(event, req, options);
+  return addRequestDataToEvent(event, req, options);
 }
 
 // TODO (v8 / #5190): Remove this

packages/node/src/index.ts

@@ -15,7 +15,7 @@ export type {
   Thread,
   User,
 } from '@sentry/types';
-export type { ParseRequestOptions, ExpressRequest } from '@sentry/utils';
+export type { AddRequestDataToEventOptions, ExpressRequest } from '@sentry/utils';
 
 export type { NodeOptions } from './types';
 
@@ -42,7 +42,7 @@ export {
   setUser,
   withScope,
 } from '@sentry/core';
-export { parseRequest, extractRequestData } from '@sentry/utils';
+export { addRequestDataToEvent, extractRequestData } from '@sentry/utils';
 
 export { NodeClient } from './client';
 export { makeNodeTransport } from './transports';

packages/serverless/src/gcpfunction/http.ts

@@ -1,9 +1,9 @@
 import {
+  addRequestDataToEvent,
+  AddRequestDataToEventOptions,
   captureException,
   flush,
   getCurrentHub,
-  parseRequest,
-  parseRequestOptions,
   startTransaction,
 } from '@sentry/node';
 import { extractTraceparentData } from '@sentry/tracing';
@@ -12,10 +12,18 @@ import { isString, logger, parseBaggageString, stripUrlQueryAndFragment } from '
 import { domainify, getActiveDomain, proxyFunction } from './../utils';
 import { HttpFunction, WrapperOptions } from './general';
 
-export interface HttpFunctionWrapperOptions extends WrapperOptions {
-  parseRequestOptions: ParseRequestOptions;
+// TODO (v8 / #5190): Remove this
+interface OldHttpFunctionWrapperOptions extends WrapperOptions {
+  /**
+   * @deprecated Use `addRequestDataToEventOptions` instead.
+   */
+  parseRequestOptions: AddRequestDataToEventOptions;
+}
+interface NewHttpFunctionWrapperOptions extends WrapperOptions {
+  addRequestDataToEventOptions: AddRequestDataToEventOptions;
 }
 
+export type HttpFunctionWrapperOptions = OldHttpFunctionWrapperOptions | NewHttpFunctionWrapperOptions;
 
 /**
  * Wraps an HTTP function handler adding it error capture and tracing capabilities.
@@ -44,9 +52,13 @@ export function wrapHttpFunction(
 
 /** */
 function _wrapHttpFunction(fn: HttpFunction, wrapOptions: Partial<HttpFunctionWrapperOptions> = {}): HttpFunction {
+  // TODO (v8 / #5190): Remove this
+  // eslint-disable-next-line deprecation/deprecation
+  const { parseRequestOptions } = wrapOptions as OldHttpFunctionWrapperOptions;
+
   const options: HttpFunctionWrapperOptions = {
     flushTimeout: 2000,
-    parseRequestOptions: {},
+    addRequestDataToEventOptions: parseRequestOptions ? parseRequestOptions : {},
     ...wrapOptions,
   };
   return (req, res) => {
@@ -76,7 +88,7 @@ function _wrapHttpFunction(fn: HttpFunction, wrapOptions: Partial<HttpFunctionWr
     // since functions-framework creates a domain for each incoming request.
     // So adding of event processors every time should not lead to memory bloat.
     getCurrentHub().configureScope(scope => {
-      scope.addEventProcessor(event => parseRequest(event, req, options.parseRequestOptions));
+      scope.addEventProcessor(event => addRequestDataToEvent(event, req, options.addRequestDataToEventOptions));
       // We put the transaction on the scope so users can attach children to it
       scope.setSpan(transaction);
     });

packages/utils/src/requestdata.ts

@@ -233,7 +233,7 @@ export function extractRequestData(
 /**
  * Options deciding what parts of the request to use when enhancing an event
  */
-export interface ParseRequestOptions {
+export interface AddRequestDataToEventOptions {
   ip?: boolean;
   request?: boolean | string[];
   serverName?: boolean;
@@ -250,7 +250,11 @@ export interface ParseRequestOptions {
  * @param options object containing flags to enable functionality
  * @hidden
  */
-export function parseRequest(event: Event, req: ExpressRequest, options?: ParseRequestOptions): Event {
+export function addRequestDataToEvent(
+  event: Event,
+  req: ExpressRequest,
+  options?: AddRequestDataToEventOptions,
+): Event {
   // eslint-disable-next-line no-param-reassign
   options = {
     ip: false,