feat: Allow configuring user attributes to pick from req

Author: steelbrain

CHANGELOG.md

@@ -27,6 +27,7 @@
 - [hub] fix: Correctly store and retrieve Hub from domain when one is active
 - [hub] fix: Copy over user data when cloning scope
 - [node] feat: Allow requestHandler to be configured
+- [node] feat: Allow pick any user attributes from requestHandler
 - [node] feat: Make node transactions a pluggable integration with tests
 - [node] feat: Transactions handling for RequestHandler in Express/Hapi
 - [node] fix: Dont wrap native modules more than once to prevent leaks

packages/node/src/handlers.ts

@@ -114,11 +114,15 @@ function extractRequestData(req: { [key: string]: any }): { [key: string]: strin
   return request;
 }
 
+/** Default user keys that'll be used to extract data from the request */
+const DEFAULT_USER_KEYS = ['id', 'username', 'email'];
+
 /** JSDoc */
-function extractUserData(req: { [key: string]: any }): { [key: string]: string } {
+function extractUserData(req: { [key: string]: any }, keys: boolean | string[]): { [key: string]: string } {
   const user: { [key: string]: string } = {};
+  const attributes = Array.isArray(keys) ? keys : DEFAULT_USER_KEYS;
 
-  ['id', 'username', 'email'].forEach(key => {
+  attributes.forEach(key => {
     if ({}.hasOwnProperty.call(req.user, key)) {
       user[key] = (req.user as { [key: string]: string })[key];
     }
@@ -151,7 +155,7 @@ function parseRequest(
     request?: boolean;
     serverName?: boolean;
     transaction?: boolean | TransactionTypes;
-    user?: boolean;
+    user?: boolean | string[];
     version?: boolean;
   },
 ): SentryEvent {
@@ -186,7 +190,7 @@ function parseRequest(
   if (options.user && req.user) {
     event.user = {
       ...event.user,
-      ...extractUserData(req),
+      ...extractUserData(req, options.user),
     };
   }
 
@@ -205,7 +209,7 @@ export function requestHandler(options?: {
   request?: boolean;
   serverName?: boolean;
   transaction?: boolean | TransactionTypes;
-  user?: boolean;
+  user?: boolean | string[];
   version?: boolean;
 }): (req: http.IncomingMessage, res: http.ServerResponse, next: (error?: any) => void) => void {
   return function sentryRequestMiddleware(