feat: add new session replay argument for repro steps api (#1033)

Jira ID: IBGCRASH-20025

Author: abdelhamid-f-nasser

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

@@ -5,7 +5,6 @@
 import com.instabug.bug.BugReporting;
 import com.instabug.bug.invocation.Option;
 import com.instabug.featuresrequest.ActionType;
-
 import com.instabug.library.InstabugColorTheme;
 import com.instabug.library.InstabugCustomTextPlaceHolder.Key;
 import com.instabug.library.OnSdkDismissCallback.DismissType;

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

@@ -39,8 +39,6 @@ public String getName() {
 
     /**
      * Sets the printed logs priority. Filter to one of the following levels.
-     *
-     * @param logLevel the priority level.
      */
     @ReactMethod
     public void ibgSleep() {

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

@@ -742,17 +742,19 @@ public void run() {
     }
 
     @ReactMethod
-    public void setReproStepsConfig(final String bugMode, final String crashMode) {
+    public void setReproStepsConfig(final String bugMode, final String crashMode, final String sessionReplayMode) {
         MainThreadHandler.runOnMainThread(new Runnable() {
             @Override
             public void run() {
                 try {
                     final Integer resolvedBugMode = ArgsRegistry.reproModes.get(bugMode);
                     final Integer resolvedCrashMode = ArgsRegistry.reproModes.get(crashMode);
+                    final Integer resolvedSessionReplayMode = ArgsRegistry.reproModes.get(sessionReplayMode);
 
                     final ReproConfigurations config = new ReproConfigurations.Builder()
                             .setIssueMode(IssueType.Bug, resolvedBugMode)
                             .setIssueMode(IssueType.Crash, resolvedCrashMode)
+                            .setIssueMode(IssueType.SessionReplay, resolvedSessionReplayMode)
                             .build();
 
                     Instabug.setReproConfigurations(config);

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

@@ -261,19 +261,21 @@ public void tearDown() {
     public void givenArg$setReproStepsConfig_whenQuery_thenShouldCallNativeApiWithArg() {
         String bug = "reproStepsEnabled";
         String crash = "reproStepsDisabled";
+        String sessionReplay = "reproStepsEnabled";
 
         ReproConfigurations config = mock(ReproConfigurations.class);
         MockedConstruction<ReproConfigurations.Builder> mReproConfigurationsBuilder = mockConstruction(ReproConfigurations.Builder.class, (mock, context) -> {
             when(mock.setIssueMode(anyInt(), anyInt())).thenReturn(mock);
             when(mock.build()).thenReturn(config);
         });
 
-        rnModule.setReproStepsConfig(bug, crash);
+        rnModule.setReproStepsConfig(bug, crash, sessionReplay);
 
         ReproConfigurations.Builder builder = mReproConfigurationsBuilder.constructed().get(0);
 
         verify(builder).setIssueMode(IssueType.Bug, ReproMode.EnableWithScreenshots);
         verify(builder).setIssueMode(IssueType.Crash, ReproMode.Disable);
+        verify(builder).setIssueMode(IssueType.SessionReplay, ReproMode.EnableWithScreenshots);
         verify(builder).build();
 
         mockInstabug.verify(() -> Instabug.setReproConfigurations(config));

examples/default/ios/InstabugTests/InstabugSampleTests.m

@@ -214,11 +214,13 @@ - (void)testSetReproStepsConfig {
   id mock = OCMClassMock([Instabug class]);
   IBGUserStepsMode bugMode = IBGUserStepsModeDisable;
   IBGUserStepsMode crashMode = IBGUserStepsModeEnable;
+  IBGUserStepsMode sessionReplayMode = IBGUserStepsModeEnabledWithNoScreenshots;
 
-  [self.instabugBridge setReproStepsConfig:bugMode :crashMode];
+  [self.instabugBridge setReproStepsConfig:bugMode :crashMode :sessionReplayMode];
 
   OCMVerify([mock setReproStepsFor:IBGIssueTypeBug withMode:bugMode]);
   OCMVerify([mock setReproStepsFor:IBGIssueTypeCrash withMode:crashMode]);
+ OCMVerify([mock setReproStepsFor:IBGIssueTypeSessionReplay withMode:sessionReplayMode]);
 }
 
 - (void)testSetUserAttribute {

ios/RNInstabug/InstabugReactBridge.h

@@ -57,7 +57,7 @@
 
 - (void)logVerbose:(NSString *)log;
 
-- (void)setReproStepsConfig:(IBGUserStepsMode)bugMode:(IBGUserStepsMode)crashMode;
+- (void)setReproStepsConfig:(IBGUserStepsMode)bugMode:(IBGUserStepsMode)crashMode:(IBGUserStepsMode)sessionReplayMode;
 
 - (void)setUserAttribute:(NSString *)key withValue:(NSString *)value;
 

ios/RNInstabug/InstabugReactBridge.m

@@ -67,9 +67,10 @@ - (dispatch_queue_t)methodQueue {
     IBGAPM.hotAppLaunchEnabled = NO;
 }
 
-RCT_EXPORT_METHOD(setReproStepsConfig:(IBGUserStepsMode)bugMode :(IBGUserStepsMode)crashMode) {
+RCT_EXPORT_METHOD(setReproStepsConfig:(IBGUserStepsMode)bugMode :(IBGUserStepsMode)crashMode:(IBGUserStepsMode)sessionReplayMode) {
     [Instabug setReproStepsFor:IBGIssueTypeBug withMode:bugMode];
     [Instabug setReproStepsFor:IBGIssueTypeCrash withMode:crashMode];
+   [Instabug setReproStepsFor:IBGIssueTypeSessionReplay withMode:sessionReplayMode];
 }
 
 RCT_EXPORT_METHOD(setFileAttachment:(NSString *)fileLocation) {

src/models/ReproConfig.ts

@@ -2,23 +2,30 @@ import type { ReproStepsMode } from '../utils/Enums';
 
 export interface ReproConfig {
   /**
-   * Repro steps mode for bug reporting.
+   * Repro steps mode for Bug Reporting.
    *
    * @default ReproStepsMode.enabled
    */
   bug?: ReproStepsMode;
 
   /**
-   * Repro steps mode for crash reporting.
+   * Repro steps mode for Crash Reporting.
    *
    * @default ReproStepsMode.enabledWithNoScreenshots
    */
   crash?: ReproStepsMode;
 
   /**
-   * Repro steps mode for both bug and crash reporting.
+   * Repro steps mode for Session Replay.
    *
-   * When this is set, `bug` and `crash` will be ignored.
+   * @default ReproStepsMode.enabled
+   */
+  sessionReplay?: ReproStepsMode;
+
+  /**
+   * Repro steps mode for Bug Reporting, Crash Reporting, and Session Replay.
+   *
+   * When this is set, `bug`, `crash`, and `sessionReplay` will be ignored.
    */
   all?: ReproStepsMode;
 }

src/modules/Instabug.ts

@@ -313,16 +313,19 @@ export const clearLogs = () => {
  * Instabug.setReproStepsConfig({
  *   bug: ReproStepsMode.enabled,
  *   crash: ReproStepsMode.disabled,
+ *   sessionReplay: ReproStepsMode.enabled,
  * });
  * ```
  */
 export const setReproStepsConfig = (config: ReproConfig) => {
   let bug = config.bug ?? ReproStepsMode.enabled;
   let crash = config.crash ?? ReproStepsMode.enabledWithNoScreenshots;
+  let sessionReplay = config.sessionReplay ?? ReproStepsMode.enabled;
 
   if (config.all != null) {
     bug = config.all;
     crash = config.all;
+    sessionReplay = config.all;
   }
 
   // There's an issue with crashes repro steps with screenshots in the iOS SDK
@@ -334,7 +337,7 @@ export const setReproStepsConfig = (config: ReproConfig) => {
     crash = ReproStepsMode.enabledWithNoScreenshots;
   }
 
-  NativeInstabug.setReproStepsConfig(bug, crash);
+  NativeInstabug.setReproStepsConfig(bug, crash, sessionReplay);
 };
 
 /**

src/native/NativeInstabug.ts

@@ -37,7 +37,11 @@ export interface InstabugNativeModule extends NativeModule {
   setNetworkLoggingEnabled(isEnabled: boolean): void;
 
   // Repro Steps APIs //
-  setReproStepsConfig(bugMode: ReproStepsMode, crashMode: ReproStepsMode): void;
+  setReproStepsConfig(
+    bugMode: ReproStepsMode,
+    crashMode: ReproStepsMode,
+    sessionReplay: ReproStepsMode,
+  ): void;
   setTrackUserSteps(isEnabled: boolean): void;
   reportScreenChange(firstScreen: string): void;
   addPrivateView(nativeTag: number | null): void;