add RequestData integration

Author: lobsterkatie

packages/node/src/index.ts

@@ -47,7 +47,7 @@ export {
 export { NodeClient } from './client';
 export { makeNodeTransport } from './transports';
 export { defaultIntegrations, init, defaultStackParser, lastEventId, flush, close, getSentryRelease } from './sdk';
-export { addRequestDataToEvent, extractRequestData } from './requestdata';
+export { addRequestDataToEvent, DEFAULT_USER_INCLUDES, extractRequestData } from './requestdata';
 export { deepReadDirSync } from './utils';
 
 import { Integrations as CoreIntegrations } from '@sentry/core';

packages/node/src/integrations/index.ts

@@ -6,3 +6,4 @@ export { LinkedErrors } from './linkederrors';
 export { Modules } from './modules';
 export { ContextLines } from './contextlines';
 export { Context } from './context';
+export { RequestData } from './requestdata';

packages/node/src/integrations/requestdata.ts

@@ -0,0 +1,118 @@
+// TODO (v8 or v9): Whenever this becomes a default integration for `@sentry/browser`, move this to `@sentry/core`. For
+// now, we leave it in `@sentry/integrations` so that it doesn't contribute bytes to our CDN bundles.
+
+import { EventProcessor, Hub, Integration } from '@sentry/types';
+
+import { addRequestDataToEvent, AddRequestDataToEventOptions, DEFAULT_USER_INCLUDES } from '../requestdata';
+
+type RequestDataOptions = {
+  /**
+   * Controls what data is pulled from the request and added to the event
+   */
+  include?: {
+    cookies?: boolean;
+    data?: boolean;
+    headers?: boolean;
+    ip?: boolean;
+    query_string?: boolean;
+    url?: boolean;
+    user?: boolean | Array<typeof DEFAULT_USER_INCLUDES[number]>;
+  };
+
+  /**
+   * Function for adding request data to event. Defaults to `addRequestDataToEvent` from `@sentry/node` for now, but
+   * left injectable so this integration can be moved to `@sentry/core` and used in browser-based SDKs in the future.
+   *
+   * @hidden
+   */
+  addRequestData?: typeof addRequestDataToEvent;
+};
+
+const DEFAULT_OPTIONS = {
+  addRequestData: addRequestDataToEvent,
+  include: {
+    cookies: true,
+    data: true,
+    headers: true,
+    ip: false,
+    query_string: true,
+    url: true,
+    user: DEFAULT_USER_INCLUDES,
+  },
+};
+
+/** Add data about a request to an event. Primarily for use in Node-based SDKs, but included in `@sentry/integrations`
+ * so it can be used in cross-platform SDKs like `@sentry/nextjs`. */
+export class RequestData implements Integration {
+  /**
+   * @inheritDoc
+   */
+  public static id: string = 'RequestData';
+
+  /**
+   * @inheritDoc
+   */
+  public name: string = RequestData.id;
+
+  private _options: RequestDataOptions;
+
+  /**
+   * @inheritDoc
+   */
+  public constructor(options: RequestDataOptions = {}) {
+    this._options = {
+      ...DEFAULT_OPTIONS,
+      ...options,
+      include: {
+        // @ts-ignore It's mad because `method` isn't a known `include` key. (It's only here and not set by default in
+        // `addRequestDataToEvent` for legacy reasons. TODO (v8): Change that.)
+        method: true,
+        ...DEFAULT_OPTIONS.include,
+        ...options.include,
+      },
+    };
+  }
+
+  /**
+   * @inheritDoc
+   */
+  public setupOnce(addGlobalEventProcessor: (eventProcessor: EventProcessor) => void, getCurrentHub: () => Hub): void {
+    const { include, addRequestData } = this._options;
+
+    addGlobalEventProcessor(event => {
+      const self = getCurrentHub().getIntegration(RequestData);
+      const req = event.sdkProcessingMetadata && event.sdkProcessingMetadata.request;
+
+      // If the globally installed instance of this integration isn't associated with the current hub, `self` will be
+      // undefined
+      if (!self || !req) {
+        return event;
+      }
+
+      // For some reason TS can't figure out that after the constructor runs, `_addReqDataCallback` will always be defined
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      return addRequestData!(event, req, { include: formatIncludeOption(include) });
+    });
+  }
+}
+
+/** Convert `include` option to match what `addRequestDataToEvent` expects */
+/** TODO: Can possibly be deleted once https://github.com/getsentry/sentry-javascript/issues/5718 is fixed */
+function formatIncludeOption(
+  integrationInclude: RequestDataOptions['include'] = {},
+): AddRequestDataToEventOptions['include'] {
+  const { ip, user, ...requestOptions } = integrationInclude;
+
+  const requestIncludeKeys: string[] = [];
+  for (const [key, value] of Object.entries(requestOptions)) {
+    if (value) {
+      requestIncludeKeys.push(key);
+    }
+  }
+
+  return {
+    ip,
+    user,
+    request: requestIncludeKeys.length !== 0 ? requestIncludeKeys : undefined,
+  };
+}

packages/node/src/requestdata.ts

@@ -10,7 +10,7 @@ const DEFAULT_INCLUDES = {
   user: true,
 };
 const DEFAULT_REQUEST_INCLUDES = ['cookies', 'data', 'headers', 'method', 'query_string', 'url'];
-const DEFAULT_USER_INCLUDES = ['id', 'username', 'email'];
+export const DEFAULT_USER_INCLUDES = ['id', 'username', 'email'];
 
 /**
  * Options deciding what parts of the request to use when enhancing an event