chore(android): Change from deprecated user.others to user.data (#2555)

Author: krystofwoldrich

android/src/main/java/io/sentry/react/RNSentryModule.java

@@ -297,45 +297,49 @@ private static PackageInfo getPackageInfo(Context ctx) {
     }
 
     @ReactMethod
-    public void setUser(final ReadableMap user, final ReadableMap otherUserKeys) {
+    public void setUser(final ReadableMap userKeys, final ReadableMap userDataKeys) {
         Sentry.configureScope(scope -> {
-            if (user == null && otherUserKeys == null) {
+            if (userKeys == null && userDataKeys == null) {
                 scope.setUser(null);
             } else {
                 User userInstance = new User();
 
-                if (user != null) {
-                    if (user.hasKey("email")) {
-                        userInstance.setEmail(user.getString("email"));
+                if (userKeys != null) {
+                    if (userKeys.hasKey("email")) {
+                        userInstance.setEmail(userKeys.getString("email"));
                     }
 
-                    if (user.hasKey("id")) {
-                        userInstance.setId(user.getString("id"));
+                    if (userKeys.hasKey("id")) {
+                        userInstance.setId(userKeys.getString("id"));
                     }
 
-                    if (user.hasKey("username")) {
-                        userInstance.setUsername(user.getString("username"));
+                    if (userKeys.hasKey("username")) {
+                        userInstance.setUsername(userKeys.getString("username"));
                     }
 
-                    if (user.hasKey("ip_address")) {
-                        userInstance.setIpAddress(user.getString("ip_address"));
+                    if (userKeys.hasKey("ip_address")) {
+                        userInstance.setIpAddress(userKeys.getString("ip_address"));
+                    }
+
+                    if (userKeys.hasKey("segment")) {
+                        userInstance.setSegment(userKeys.getString("segment"));
                     }
                 }
 
-                if (otherUserKeys != null) {
-                    HashMap<String, String> otherUserKeysMap = new HashMap<>();
-                    ReadableMapKeySetIterator it = otherUserKeys.keySetIterator();
+                if (userDataKeys != null) {
+                    HashMap<String, String> userDataMap = new HashMap<>();
+                    ReadableMapKeySetIterator it = userDataKeys.keySetIterator();
                     while (it.hasNextKey()) {
                         String key = it.nextKey();
-                        String value = otherUserKeys.getString(key);
+                        String value = userDataKeys.getString(key);
 
                         // other is ConcurrentHashMap and can't have null values
                         if (value != null) {
-                            otherUserKeysMap.put(key, value);
+                            userDataMap.put(key, value);
                         }
                     }
 
-                    userInstance.setOthers(otherUserKeysMap);
+                    userInstance.setData(userDataMap);
                 }
 
                 scope.setUser(userInstance);

ios/RNSentry.m

@@ -296,24 +296,26 @@ - (void)setEventEnvironmentTag:(SentryEvent *)event
     resolve(@YES);
 }
 
-RCT_EXPORT_METHOD(setUser:(NSDictionary *)user
-                  otherUserKeys:(NSDictionary *)otherUserKeys
+RCT_EXPORT_METHOD(setUser:(NSDictionary *)userKeys
+                  otherUserKeys:(NSDictionary *)userDataKeys
 )
 {
     [SentrySDK configureScope:^(SentryScope * _Nonnull scope) {
-        if (nil == user && nil == otherUserKeys) {
+        if (nil == userKeys && nil == userDataKeys) {
             [scope setUser:nil];
         } else {
             SentryUser* userInstance = [[SentryUser alloc] init];
 
-            if (nil != user) {
-                [userInstance setUserId:user[@"id"]];
-                [userInstance setEmail:user[@"email"]];
-                [userInstance setUsername:user[@"username"]];
+            if (nil != userKeys) {
+                [userInstance setUserId:userKeys[@"id"]];
+                [userInstance setIpAddress:userKeys[@"ip_address"]];
+                [userInstance setEmail:userKeys[@"email"]];
+                [userInstance setUsername:userKeys[@"username"]];
+                [userInstance setSegment:userKeys[@"segment"]];
             }
 
-            if (nil != otherUserKeys) {
-                [userInstance setData:otherUserKeys];
+            if (nil != userDataKeys) {
+                [userInstance setData:userDataKeys];
             }
 
             [scope setUser:userInstance];

sample/src/screens/HomeScreen.tsx

@@ -39,6 +39,8 @@ const HomeScreen = (props: Props) => {
       id: 'test-id-0',
       email: '[email protected]',
       username: 'USER-TEST',
+      ip_address: '1.1.1.1',
+      segment: 'test-segment',
       specialField: 'special user field',
       specialFieldNumber: 418,
     });

src/js/user.ts

@@ -0,0 +1,4 @@
+import { User } from '@sentry/types';
+
+/** Requires all the keys defined on User interface to be present on an object */
+export type RequiredKeysUser = { [P in keyof Required<User>]: User[P] | undefined; };

src/js/wrapper.ts

@@ -21,6 +21,7 @@ import {
 } from './definitions';
 import { isHardCrash } from './misc';
 import { ReactNativeOptions } from './options';
+import { RequiredKeysUser } from './user';
 import { utf8ToBytes } from './vendor';
 
 const RNSentry = NativeModules.RNSentry as SentryNativeBridgeModule | undefined;
@@ -279,21 +280,23 @@ export const NATIVE: SentryNativeWrapper = {
       throw this._NativeClientError;
     }
 
-    // separate and serialze all non-default user keys.
-    let defaultUserKeys = null;
-    let otherUserKeys = null;
+    // separate and serialize all non-default user keys.
+    let userKeys = null;
+    let userDataKeys = null;
     if (user) {
-      const { id, ip_address, email, username, ...otherKeys } = user;
-      defaultUserKeys = this._serializeObject({
-        email,
+      const { id, ip_address, email, username, segment, ...otherKeys } = user;
+      const requiredUser: RequiredKeysUser = {
         id,
         ip_address,
+        email,
         username,
-      });
-      otherUserKeys = this._serializeObject(otherKeys);
+        segment,
+      };
+      userKeys = this._serializeObject(requiredUser);
+      userDataKeys = this._serializeObject(otherKeys);
     }
 
-    RNSentry.setUser(defaultUserKeys, otherUserKeys);
+    RNSentry.setUser(userKeys, userDataKeys);
   },
 
   /**