use booleans for user property in RequestData integration include option

Author: lobsterkatie

packages/node/src/integrations/requestdata.ts

@@ -4,12 +4,7 @@
 import { EventProcessor, Hub, Integration, Transaction } from '@sentry/types';
 import { extractPathForTransaction } from '@sentry/utils';
 
-import {
-  addRequestDataToEvent,
-  AddRequestDataToEventOptions,
-  DEFAULT_USER_INCLUDES,
-  TransactionNamingScheme,
-} from '../requestdata';
+import { addRequestDataToEvent, AddRequestDataToEventOptions, TransactionNamingScheme } from '../requestdata';
 
 type RequestDataOptions = {
   /**
@@ -22,7 +17,13 @@ type RequestDataOptions = {
     ip?: boolean;
     query_string?: boolean;
     url?: boolean;
-    user?: boolean | Array<typeof DEFAULT_USER_INCLUDES[number]>;
+    user?:
+      | boolean
+      | {
+          id?: boolean;
+          username?: boolean;
+          email?: boolean;
+        };
   };
 
   /** Whether to identify transactions by parameterized path, parameterized path with method, or handler name */
@@ -46,7 +47,11 @@ const DEFAULT_OPTIONS = {
     ip: false,
     query_string: true,
     url: true,
-    user: DEFAULT_USER_INCLUDES,
+    user: {
+      id: true,
+      username: true,
+      email: true,
+    },
   },
   transactionNamingScheme: 'methodpath',
 };
@@ -79,6 +84,14 @@ export class RequestData implements Integration {
         method: true,
         ...DEFAULT_OPTIONS.include,
         ...options.include,
+        user:
+          options.include && typeof options.include.user === 'boolean'
+            ? options.include.user
+            : {
+                ...DEFAULT_OPTIONS.include.user,
+                // Unclear why TS still thinks `options.include.user` could be a boolean at this point
+                ...((options.include || {}).user as Record<string, boolean>),
+              },
       },
     };
   }
@@ -152,9 +165,24 @@ function formatIncludeOption(
     }
   }
 
+  let addReqDataUserOpt;
+  if (user === undefined) {
+    addReqDataUserOpt = true;
+  } else if (typeof user === 'boolean') {
+    addReqDataUserOpt = user;
+  } else {
+    const userIncludeKeys: string[] = [];
+    for (const [key, value] of Object.entries(user)) {
+      if (value) {
+        userIncludeKeys.push(key);
+      }
+    }
+    addReqDataUserOpt = userIncludeKeys;
+  }
+
   return {
     ip,
-    user,
+    user: addReqDataUserOpt,
     request: requestIncludeKeys.length !== 0 ? requestIncludeKeys : undefined,
   };
 }