create node wrapper for functions to pass node deps automatically

Author: lobsterkatie

packages/node/src/index.ts

@@ -15,6 +15,7 @@ export type {
   Thread,
   User,
 } from '@sentry/types';
+export type { AddRequestDataToEventOptions, CrossPlatformRequest } from '@sentry/utils';
 
 export type { NodeOptions } from './types';
 
@@ -44,7 +45,17 @@ export {
 
 export { NodeClient } from './client';
 export { makeNodeTransport } from './transports';
-export { defaultIntegrations, init, defaultStackParser, lastEventId, flush, close, getSentryRelease } from './sdk';
+export {
+  addRequestDataToEvent,
+  extractRequestData,
+  defaultIntegrations,
+  init,
+  defaultStackParser,
+  lastEventId,
+  flush,
+  close,
+  getSentryRelease,
+} from './sdk';
 export { deepReadDirSync } from './utils';
 
 import { Integrations as CoreIntegrations } from '@sentry/core';

packages/node/src/sdk.ts

@@ -1,8 +1,20 @@
+/* eslint-disable max-lines */
 import { getCurrentHub, getIntegrationsToSetup, initAndBind, Integrations as CoreIntegrations } from '@sentry/core';
 import { getMainCarrier, setHubOnCarrier } from '@sentry/hub';
-import { SessionStatus, StackParser } from '@sentry/types';
-import { createStackParser, getGlobalObject, logger, stackParserFromStackParserOptions } from '@sentry/utils';
+import { Event, ExtractedNodeRequestData, SessionStatus, StackParser } from '@sentry/types';
+import {
+  addRequestDataToEvent as _addRequestDataToEvent,
+  AddRequestDataToEventOptions,
+  createStackParser,
+  CrossPlatformRequest,
+  extractRequestData as _extractRequestData,
+  getGlobalObject,
+  logger,
+  stackParserFromStackParserOptions,
+} from '@sentry/utils';
+import * as cookie from 'cookie';
 import * as domain from 'domain';
+import * as url from 'url';
 
 import { NodeClient } from './client';
 import { Console, ContextLines, Http, LinkedErrors, OnUncaughtException, OnUnhandledRejection } from './integrations';
@@ -255,3 +267,51 @@ function startSessionTracking(): void {
     if (session && !terminalStates.includes(session.status)) hub.endSession();
   });
 }
+
+/**
+ * Add data from the given request to the given event
+ *
+ * (Note that there is no sister function to this one in `@sentry/browser`, because the whole point of this wrapper is
+ * to pass along injected dependencies, which isn't necessary in a browser context. Isomorphic packages like
+ * `@sentry/nextjs` should export directly from `@sentry/utils` in their browser index file.)
+ *
+ * @param event The event to which the request data will be added
+ * @param req Request object
+ * @param options.include Flags to control what data is included
+ * @hidden
+ */
+export function addRequestDataToEvent(
+  event: Event,
+  req: CrossPlatformRequest,
+  options?: Omit<AddRequestDataToEventOptions, 'deps'>,
+): Event {
+  return _addRequestDataToEvent(event, req, {
+    ...options,
+    // We have to inject these node-only dependencies because we can't import them in `@sentry/utils`, where the
+    // original function lives
+    deps: { cookie, url },
+  });
+}
+
+/**
+ * Normalize data from the request object, accounting for framework differences.
+ *
+ * (Note that there is no sister function to this one in `@sentry/browser`, because the whole point of this wrapper is
+ * to inject dependencies, which isn't necessary in a browser context. Isomorphic packages like `@sentry/nextjs` should
+ * export directly from `@sentry/utils` in their browser index file.)
+ *
+ * @param req The request object from which to extract data
+ * @param options.keys An optional array of keys to include in the normalized data. Defaults to DEFAULT_REQUEST_KEYS if
+ * not provided.
+ * @returns An object containing normalized request data
+ */
+export function extractRequestData(
+  req: CrossPlatformRequest,
+  options?: {
+    include?: string[];
+  },
+): ExtractedNodeRequestData {
+  // We have to inject these node-only dependencies because we can't import them in `@sentry/utils`, where the original
+  // function lives
+  return _extractRequestData(req, { ...options, deps: { cookie, url } });
+}