move CrossPlatformRequest to types package

Author: lobsterkatie

packages/node/src/index.ts

@@ -1,6 +1,7 @@
 export type {
   Breadcrumb,
   BreadcrumbHint,
+  CrossPlatformRequest,
   Request,
   SdkInfo,
   Event,
@@ -15,7 +16,7 @@ export type {
   Thread,
   User,
 } from '@sentry/types';
-export type { AddRequestDataToEventOptions, CrossPlatformRequest } from '@sentry/utils';
+export type { AddRequestDataToEventOptions } from '@sentry/utils';
 
 export type { NodeOptions } from './types';
 

packages/node/src/requestDataDeprecated.ts

@@ -6,11 +6,10 @@
 
 /* eslint-disable deprecation/deprecation */
 /* eslint-disable @typescript-eslint/no-explicit-any */
-import { Event, ExtractedNodeRequestData } from '@sentry/types';
+import { CrossPlatformRequest, Event, ExtractedNodeRequestData } from '@sentry/types';
 import {
   addRequestDataToEvent,
   AddRequestDataToEventOptions,
-  CrossPlatformRequest,
   extractRequestData as _extractRequestData,
 } from '@sentry/utils';
 import * as cookie from 'cookie';

packages/node/src/sdk.ts

@@ -1,12 +1,11 @@
 /* eslint-disable max-lines */
 import { getCurrentHub, getIntegrationsToSetup, initAndBind, Integrations as CoreIntegrations } from '@sentry/core';
 import { getMainCarrier, setHubOnCarrier } from '@sentry/hub';
-import { Event, ExtractedNodeRequestData, SessionStatus, StackParser } from '@sentry/types';
+import { CrossPlatformRequest, Event, ExtractedNodeRequestData, SessionStatus, StackParser } from '@sentry/types';
 import {
   addRequestDataToEvent as _addRequestDataToEvent,
   AddRequestDataToEventOptions,
   createStackParser,
-  CrossPlatformRequest,
   extractRequestData as _extractRequestData,
   getGlobalObject,
   logger,

packages/tracing/src/integrations/node/express.ts

@@ -1,12 +1,6 @@
 /* eslint-disable max-lines */
-import { Integration, Transaction } from '@sentry/types';
-import {
-  CrossPlatformRequest,
-  extractPathForTransaction,
-  getNumberOfUrlSegments,
-  isRegExp,
-  logger,
-} from '@sentry/utils';
+import { CrossPlatformRequest, Integration, Transaction } from '@sentry/types';
+import { extractPathForTransaction, getNumberOfUrlSegments, isRegExp, logger } from '@sentry/utils';
 
 type Method =
   | 'all'

packages/types/src/index.ts

@@ -39,7 +39,7 @@ export type { Mechanism } from './mechanism';
 export type { ExtractedNodeRequestData, HttpHeaderValue, Primitive, WorkerLocation } from './misc';
 export type { ClientOptions, Options } from './options';
 export type { Package } from './package';
-export type { PolymorphicEvent } from './polymorphics';
+export type { PolymorphicEvent, CrossPlatformRequest } from './polymorphics';
 export type { QueryParams, Request } from './request';
 export type { Runtime } from './runtime';
 export type { CaptureContext, Scope, ScopeContext } from './scope';

packages/types/src/polymorphics.ts

@@ -1,6 +1,8 @@
 /**
  * Event-like interface that's usable in browser and node.
  *
+ * Note: Here we mean the kind of events handled by event listeners, not our `Event` type.
+ *
  * Property availability taken from https://developer.mozilla.org/en-US/docs/Web/API/Event#browser_compatibility
  */
 export interface PolymorphicEvent {
@@ -9,3 +11,68 @@ export interface PolymorphicEvent {
   readonly target?: unknown;
   readonly currentTarget?: unknown;
 }
+
+/** A `Request` type compatible with Node, Express, browser, etc., because everything is optional */
+export type CrossPlatformRequest = BaseRequest &
+  BrowserRequest &
+  NodeRequest &
+  ExpressRequest &
+  KoaRequest &
+  NextjsRequest;
+
+type BaseRequest = {
+  method?: string;
+  url?: string;
+};
+
+type BrowserRequest = BaseRequest;
+
+type NodeRequest = BaseRequest & {
+  headers?: {
+    [key: string]: string | string[] | undefined;
+  };
+  protocol?: string;
+  socket?: {
+    encrypted?: boolean;
+    remoteAddress?: string;
+  };
+};
+
+type KoaRequest = NodeRequest & {
+  host?: string;
+  hostname?: string;
+  ip?: string;
+  originalUrl?: string;
+};
+
+type NextjsRequest = NodeRequest & {
+  cookies?: {
+    [key: string]: string;
+  };
+  query?: {
+    [key: string]: any;
+  };
+};
+
+type ExpressRequest = NodeRequest & {
+  baseUrl?: string;
+  body?: string | { [key: string]: any };
+  host?: string;
+  hostname?: string;
+  ip?: string;
+  originalUrl?: string;
+  route?: {
+    path: string;
+    stack: [
+      {
+        name: string;
+      },
+    ];
+  };
+  query?: {
+    [key: string]: any;
+  };
+  user?: {
+    [key: string]: any;
+  };
+};

packages/types/src/transaction.ts

@@ -1,6 +1,7 @@
 import { Baggage } from './baggage';
 import { MeasurementUnit } from './measurement';
 import { ExtractedNodeRequestData, Primitive, WorkerLocation } from './misc';
+import { CrossPlatformRequest } from './polymorphics';
 import { Span, SpanContext } from './span';
 /**
  * Interface holding Transaction-specific properties

packages/utils/src/requestdata.ts

@@ -12,7 +12,7 @@
 /* eslint-disable max-lines */
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
-import { Event, ExtractedNodeRequestData, Transaction, TransactionSource } from '@sentry/types';
+import { CrossPlatformRequest, Event, ExtractedNodeRequestData, Transaction, TransactionSource } from '@sentry/types';
 
 import { isPlainObject, isString } from './is';
 import { normalize } from './normalize';
@@ -27,71 +27,6 @@ const DEFAULT_INCLUDES = {
 const DEFAULT_REQUEST_INCLUDES = ['cookies', 'data', 'headers', 'method', 'query_string', 'url'];
 const DEFAULT_USER_INCLUDES = ['id', 'username', 'email'];
 
-type BaseRequest = {
-  method?: string;
-  url?: string;
-};
-
-type BrowserRequest = BaseRequest;
-
-type NodeRequest = BaseRequest & {
-  headers?: {
-    [key: string]: string | string[] | undefined;
-  };
-  protocol?: string;
-  socket?: {
-    encrypted?: boolean;
-    remoteAddress?: string;
-  };
-};
-
-type KoaRequest = NodeRequest & {
-  host?: string;
-  hostname?: string;
-  ip?: string;
-  originalUrl?: string;
-};
-
-type NextjsRequest = NodeRequest & {
-  cookies?: {
-    [key: string]: string;
-  };
-  query?: {
-    [key: string]: any;
-  };
-};
-
-type ExpressRequest = NodeRequest & {
-  baseUrl?: string;
-  body?: string | { [key: string]: any };
-  host?: string;
-  hostname?: string;
-  ip?: string;
-  originalUrl?: string;
-  route?: {
-    path: string;
-    stack: [
-      {
-        name: string;
-      },
-    ];
-  };
-  query?: {
-    [key: string]: any;
-  };
-  user?: {
-    [key: string]: any;
-  };
-};
-
-/** A `Request` type compatible with Node, Express, browser, etc., because everything is optional */
-export type CrossPlatformRequest = BaseRequest &
-  BrowserRequest &
-  NodeRequest &
-  ExpressRequest &
-  KoaRequest &
-  NextjsRequest;
-
 type InjectedNodeDeps = {
   cookie: {
     parse: (cookieStr: string) => Record<string, string>;