feat: add get session replay link API (#1142)

Jira ID: MOB-14010

Author: ahmedAlaaInstabug

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Added
 
+- Add `SessionReplay.getSessionReplayLink` API which retrieves the current session's replay link ([#1142](https://github.com/Instabug/Instabug-React-Native/pull/1142)).
 - Support setting the Code Push version after SDK initialization ([#1143](https://github.com/Instabug/Instabug-React-Native/pull/1143)).
 
 ## [12.7.1](https://github.com/Instabug/Instabug-React-Native/compare/v12.7.0...v12.7.1) (February 15, 2024)

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

@@ -1,8 +1,13 @@
 package com.instabug.reactlibrary;
 
+import androidx.annotation.Nullable;
+
+import com.facebook.react.bridge.Promise;
 import com.facebook.react.bridge.ReactApplicationContext;
 import com.facebook.react.bridge.ReactContextBaseJavaModule;
 import com.facebook.react.bridge.ReactMethod;
+import com.instabug.chat.Replies;
+import com.instabug.library.OnSessionReplayLinkReady;
 import com.instabug.library.sessionreplay.SessionReplay;
 import com.instabug.reactlibrary.utils.MainThreadHandler;
 
@@ -76,4 +81,22 @@ public void run() {
             }
         });
     }
+
+    @ReactMethod
+    public void getSessionReplayLink(Promise promise) {
+        MainThreadHandler.runOnMainThread(new Runnable() {
+            @Override
+            public void run() {
+                SessionReplay.getSessionReplayLink(new OnSessionReplayLinkReady() {
+                    @Override
+                    public void onSessionReplayLinkReady(@Nullable String link) {
+
+                        promise.resolve(link);
+                    }
+                });
+            }
+        });
+
+
+    }
 }

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

@@ -1,19 +1,27 @@
 package com.instabug.reactlibrary;
 
 import static org.mockito.Matchers.any;
+import static org.mockito.Mockito.doAnswer;
+import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.mockStatic;
+import static org.mockito.Mockito.timeout;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
 
+import android.os.Handler;
 import android.os.Looper;
 
 import com.facebook.react.bridge.Arguments;
 import com.facebook.react.bridge.JavaOnlyArray;
+import com.facebook.react.bridge.Promise;
 import com.facebook.react.bridge.ReadableArray;
 import com.facebook.react.bridge.WritableArray;
+import com.instabug.chat.Replies;
 import com.instabug.featuresrequest.ActionType;
 import com.instabug.featuresrequest.FeatureRequests;
 import com.instabug.library.Feature;
+import com.instabug.library.OnSessionReplayLinkReady;
 import com.instabug.library.sessionreplay.SessionReplay;
 import com.instabug.reactlibrary.utils.MainThreadHandler;
 
@@ -96,6 +104,29 @@ public void testSetInstabugLogsEnabled() {
         mockSessionReplay.verifyNoMoreInteractions();
     }
 
+    @Test
+    public void testGetSessionReplayLink() {
+        Promise promise = mock(Promise.class);
+        String link="instabug link";
+
+        mockSessionReplay.when(() -> SessionReplay.getSessionReplayLink(any())).thenAnswer(
+                invocation -> {
+                    OnSessionReplayLinkReady callback = (OnSessionReplayLinkReady) invocation.getArguments()[0];
+                    callback.onSessionReplayLinkReady(link);
+                    return callback;
+                });
+        sessionReplayModule.getSessionReplayLink(promise);
+
+
+        mockSessionReplay.verify(() -> SessionReplay.getSessionReplayLink(any()));
+        mockSessionReplay.verifyNoMoreInteractions();
+
+
+        verify(promise).resolve(link);
+
+
+    }
+
     @Test
     public void testSetUserStepsEnabled() {
 

examples/default/ios/InstabugTests/InstabugSessionReplayTests.m

@@ -52,5 +52,22 @@ - (void)testSetUserStepsEnabled {
   OCMVerify([self.mSessionReplay setUserStepsEnabled:enabled]);
 }
 
+- (void)testGetSessionReplayLink {
+    NSString *link = @"link";
+    XCTestExpectation *expectation = [self expectationWithDescription:@"Call completion handler"];
+
+    RCTPromiseResolveBlock resolve = ^(NSString *result) {
+        [expectation fulfill];
+        XCTAssertEqualObjects(result, link);
+    };
+
+    RCTPromiseRejectBlock reject = ^(NSString *code, NSString *message, NSError *error) {
+    };
+    OCMStub([self.mSessionReplay sessionReplayLink]).andReturn(link);
+    [self.bridge getSessionReplayLink:resolve :reject];
+    OCMVerify([self.mSessionReplay sessionReplayLink]);
+    [self waitForExpectations:@[expectation] timeout:5.0];
+
+}
 
 @end

examples/default/src/navigation/HomeStack.tsx

@@ -15,6 +15,7 @@ import { FlatListScreen } from '../screens/user-steps/FlatListScreen';
 import { ComplexViewsScreen } from '../screens/user-steps/ComplexViewsScreen';
 import { SectionListScreen } from '../screens/user-steps/SectionListScreen';
 import { GesturesScreen } from '../screens/user-steps/GesturesScreen';
+import { SessionReplayScreen } from '../screens/SessionReplayScreen';
 
 export type HomeStackParamList = {
   Home: undefined;
@@ -30,6 +31,7 @@ export type HomeStackParamList = {
   ComplexViews: undefined;
   SectionList: undefined;
   Gestures: undefined;
+  SessionReplay: undefined;
 };
 
 const HomeStack = createNativeStackNavigator<HomeStackParamList>();
@@ -55,6 +57,12 @@ export const HomeStackNavigator: React.FC = () => {
       />
       <HomeStack.Screen name="Replies" component={RepliesScreen} />
       <HomeStack.Screen name="Surveys" component={SurveysScreen} />
+      <HomeStack.Screen
+        name="SessionReplay"
+        component={SessionReplayScreen}
+        options={{ title: 'Session Replay' }}
+      />
+
       <HomeStack.Screen
         name="UserSteps"
         component={UserStepsScreen}

examples/default/src/screens/HomeScreen.tsx

@@ -17,6 +17,7 @@ export const HomeScreen: React.FC<NativeStackScreenProps<HomeStackParamList, 'Ho
       <ListTile title="Replies" onPress={() => navigation.navigate('Replies')} />
       <ListTile title="Surveys" onPress={() => navigation.navigate('Surveys')} />
       <ListTile title="User Steps" onPress={() => navigation.navigate('UserSteps')} />
+      <ListTile title="Session Replay" onPress={() => navigation.navigate('SessionReplay')} />
     </Screen>
   );
 };

examples/default/src/screens/SessionReplayScreen.tsx

@@ -0,0 +1,30 @@
+import React from 'react';
+
+import { SessionReplay } from 'instabug-reactnative';
+import { useToast } from 'native-base';
+
+import { ListTile } from '../components/ListTile';
+import { Screen } from '../components/Screen';
+
+export const SessionReplayScreen: React.FC = () => {
+  const toast = useToast();
+  return (
+    <Screen>
+      <ListTile
+        title="Show Current Session link"
+        onPress={async () => {
+          const link = await SessionReplay.getSessionReplayLink();
+          if (link === null) {
+            toast.show({
+              description: 'link not found',
+            });
+          } else {
+            toast.show({
+              description: link,
+            });
+          }
+        }}
+      />
+    </Screen>
+  );
+};

ios/RNInstabug/InstabugSessionReplayBridge.h

@@ -18,6 +18,7 @@
 
 - (void)setUserStepsEnabled:(BOOL)isEnabled;
 
+- (void)getSessionReplayLink:(RCTPromiseResolveBlock)resolve :(RCTPromiseRejectBlock)reject;
 
 @end
 

ios/RNInstabug/InstabugSessionReplayBridge.m

@@ -39,6 +39,12 @@ + (BOOL)requiresMainQueueSetup
     IBGSessionReplay.userStepsEnabled = isEnabled;
 }
 
+RCT_EXPORT_METHOD(getSessionReplayLink:
+    (RCTPromiseResolveBlock) resolve :(RCTPromiseRejectBlock)reject) {
+    NSString *link = IBGSessionReplay.sessionReplayLink;
+    resolve(link);
+}
+
 @synthesize description;
 
 @synthesize hash;

src/modules/SessionReplay.ts

@@ -63,3 +63,15 @@ export const setInstabugLogsEnabled = (isEnabled: boolean) => {
 export const setUserStepsEnabled = (isEnabled: boolean) => {
   NativeSessionReplay.setUserStepsEnabled(isEnabled);
 };
+
+/**
+ * Retrieves current session's replay link.
+ *
+ * @example
+ * ```ts
+ * SessionReplay.getSessionReplayLink();
+ * ```
+ */
+export const getSessionReplayLink = async (): Promise<string> => {
+  return NativeSessionReplay.getSessionReplayLink();
+};

src/native/NativeSessionReplay.ts

@@ -7,6 +7,7 @@ export interface SessionReplayNativeModule extends NativeModule {
   setNetworkLogsEnabled(isEnabled: boolean): void;
   setInstabugLogsEnabled(isEnabled: boolean): void;
   setUserStepsEnabled(isEnabled: boolean): void;
+  getSessionReplayLink(): Promise<string>;
 }
 
 export const NativeSessionReplay = NativeModules.IBGSessionReplay;

test/mocks/mockSessionReplay.ts

@@ -7,6 +7,7 @@ const mockSessionReplay: SessionReplayNativeModule = {
   setNetworkLogsEnabled: jest.fn(),
   setInstabugLogsEnabled: jest.fn(),
   setUserStepsEnabled: jest.fn(),
+  getSessionReplayLink: jest.fn().mockReturnValue('link'),
 };
 
 export default mockSessionReplay;

test/modules/SessionReplay.spec.ts

@@ -29,4 +29,11 @@ describe('Session Replay Module', () => {
     expect(NativeSessionReplay.setUserStepsEnabled).toBeCalledTimes(1);
     expect(NativeSessionReplay.setUserStepsEnabled).toBeCalledWith(true);
   });
+
+  it('should call the native method getSessionReplayLink', () => {
+    SessionReplay.getSessionReplayLink();
+
+    expect(NativeSessionReplay.getSessionReplayLink).toBeCalledTimes(1);
+    expect(NativeSessionReplay.getSessionReplayLink).toReturnWith('link');
+  });
 });