feat: support IdentifyUserWithId

Support the identifyUser method which accepts the ID of the user.

Author: abdelhamid-f-nasser

android/src/main/java/com/instabug/reactlibrary/RNInstabugReactnativeModule.java

@@ -292,15 +292,19 @@ public void run() {
      *
      * @param userName  Username.
      * @param userEmail User's default email
+     * @param userId User's ID
      */
     @ReactMethod
-    @Deprecated
-    public void identifyUser(final String userEmail, final String userName) {
+    public void identifyUser(
+            final String userEmail,
+            final String userName,
+            @Nullable final String userId
+    ) {
         MainThreadHandler.runOnMainThread(new Runnable() {
             @Override
             public void run() {
                 try {
-                    Instabug.identifyUser(userName, userEmail);
+                    Instabug.identifyUser(userName, userEmail, userId);
                 } catch (Exception e) {
                     e.printStackTrace();
                 }

android/src/test/java/com/instabug/reactlibrary/RNInstabugReactnativeModuleTest.java

@@ -205,11 +205,26 @@ public void tearDown() {
 
         String email = "[email protected]";
         String userName = "salmaali";
+        String id = null;
         // when
-        rnModule.identifyUser(email, userName);
+        rnModule.identifyUser(email, userName, id);
         // then
         verify(Instabug.class,times(1));
-        Instabug.identifyUser(userName, email);
+        Instabug.identifyUser(userName, email, id);
+    }
+
+    @Test
+    public void givenArgs$identifyUserwithId_whenQuery_thenShouldCallNativeApiWithArgs() {
+        // given
+
+        String email = "[email protected]";
+        String userName = "salmaali";
+        String id = "salmaali";
+        // when
+        rnModule.identifyUser(email, userName, id);
+        // then
+        verify(Instabug.class,times(1));
+        Instabug.identifyUser(userName, email, id);
     }
 
     @Test

examples/default/ios/InstabugTests/InstabugSampleTests.m

@@ -188,8 +188,19 @@ - (void)testIdentifyUser {
   NSString *name = @"this is my name";
 
   OCMStub([mock identifyUserWithEmail:email name:name]);
-  [self.instabugBridge identifyUser:email name:name];
-  OCMVerify([mock identifyUserWithEmail:email name:name]);
+  [self.instabugBridge identifyUser:email name:name id:nil];
+  OCMVerify([mock identifyUserWithID:nil email:email name:name]);
+}
+
+- (void)testIdentifyUserWithID {
+  id mock = OCMClassMock([Instabug class]);
+  NSString *email = @"[email protected]";
+  NSString *name = @"this is my name";
+  NSString *id = @"this is my id";
+
+  OCMStub([mock identifyUserWithID:id email:email name:name]);
+  [self.instabugBridge identifyUser:email name:name id:id];
+  OCMVerify([mock identifyUserWithID:id email:email name:name]);
 }
 
 - (void)testLogOut {

ios/RNInstabug/InstabugReactBridge.h

@@ -49,7 +49,7 @@
 
 - (void)setString:(NSString *)value toKey:(NSString *)key;
 
-- (void)identifyUser:(NSString *)email name:(NSString *)name;
+- (void)identifyUser:(NSString *)email name:(NSString *)name id:(nullable NSString *)id;
 
 - (void)logOut;
 

ios/RNInstabug/InstabugReactBridge.m

@@ -191,8 +191,12 @@ - (dispatch_queue_t)methodQueue {
     [Instabug clearFileAttachments];
 }
 
-RCT_EXPORT_METHOD(identifyUser:(NSString *)email name:(NSString *)name) {
-    [Instabug identifyUserWithEmail:email name:name];
+RCT_EXPORT_METHOD(identifyUser:(NSString *)email name:(NSString *)name id:(nullable NSString *)id) {
+    [Instabug identifyUserWithID:id email:email name:name];
+}
+
+RCT_EXPORT_METHOD(identifyUserWithID:(NSString *)userID email:(NSString *)email name:(NSString *)name) {
+    [Instabug identifyUserWithID:userID email:email name:name];
 }
 
 RCT_EXPORT_METHOD(logOut) {

src/modules/Instabug.ts

@@ -196,15 +196,16 @@ export const setString = (key: StringKey, string: string) => {
 };
 
 /**
- * Sets the default value of the user's email and hides the email field from the reporting UI
+ * Sets the default value of the user's email and ID and hides the email field from the reporting UI
  * and set the user's name to be included with all reports.
  * It also reset the chats on device to that email and removes user attributes,
  * user data and completed surveys.
  * @param email Email address to be set as the user's email.
  * @param name Name of the user to be set.
+ * @param id optional ID of the user to be set.
  */
-export const identifyUser = (email: string, name: string) => {
-  NativeInstabug.identifyUser(email, name);
+export const identifyUser = (email: string, name: string, id?: string) => {
+  NativeInstabug.identifyUser(email, name, id);
 };
 
 /**
@@ -227,7 +228,7 @@ export const logUserEvent = (name: string) => {
 
 /**
  * Appends a log message to Instabug internal log.
- * These logs are then sent along the next uploaded report.
+ * These logs are then sent aalong the next uploaded report.
  * All log messages are timestamped.
  * Logs aren't cleared per single application run.
  * If you wish to reset the logs, use {@link clearLogs()}

src/native/NativeInstabug.ts

@@ -62,7 +62,8 @@ export interface InstabugNativeModule extends NativeModule {
   clearLogs(): void;
 
   // User APIs //
-  identifyUser(email: string, name: string): void;
+  identifyUser(email: string, name: string, id?: string): void;
+  identifyUserWithId(email: string, name: string, id: string): void;
   logOut(): void;
   logUserEvent(name: string): void;
   setUserData(data: string): void;

test/mocks/mockInstabug.ts

@@ -25,6 +25,7 @@ const mockInstabug: InstabugNativeModule = {
   getTags: jest.fn(),
   setString: jest.fn(),
   identifyUser: jest.fn(),
+  identifyUserWithId: jest.fn(),
   logOut: jest.fn(),
   logUserEvent: jest.fn(),
   logVerbose: jest.fn(),

test/modules/Instabug.spec.ts

@@ -412,6 +412,48 @@ describe('Instabug Module', () => {
     expect(NativeInstabug.identifyUser).toBeCalledWith(email, name);
   });
 
+  it('identifyUser when id is empty should call the native method identifyUser', () => {
+    const email = '[email protected]';
+    const name = 'Instabug';
+    const id = '';
+    Instabug.identifyUser(email, name, id);
+
+    expect(NativeInstabug.identifyUser).toBeCalledTimes(1);
+    expect(NativeInstabug.identifyUser).toBeCalledWith(email, name);
+  });
+
+  it('identifyUser when id is undefined should call the native method identifyUser', () => {
+    const email = '[email protected]';
+    const name = 'Instabug';
+    const id = undefined;
+    Instabug.identifyUser(email, name, id);
+
+    expect(NativeInstabug.identifyUser).toBeCalledTimes(1);
+    expect(NativeInstabug.identifyUser).toBeCalledWith(email, name);
+  });
+
+  it('identifyUser when id is present should call the Android native method identifyUser', () => {
+    Platform.OS = 'android';
+    const email = '[email protected]';
+    const name = 'Instabug';
+    const id = 'id';
+    Instabug.identifyUser(email, name, id);
+
+    expect(NativeInstabug.identifyUser).toBeCalledTimes(1);
+    expect(NativeInstabug.identifyUser).toBeCalledWith(email, name, id);
+  });
+
+  it('identifyUser when id is present should call the iOS native method identifyUserWithID', () => {
+    Platform.OS = 'ios';
+    const email = '[email protected]';
+    const name = 'Instabug';
+    const id = 'id';
+    Instabug.identifyUser(email, name, id);
+
+    expect(NativeInstabug.identifyUserWithId).toBeCalledTimes(1);
+    expect(NativeInstabug.identifyUserWithId).toBeCalledWith(email, name, id);
+  });
+
   it('should call the native method logOut', () => {
     Instabug.logOut();