feat: add session replay mode argument to reprosteps api (#398)

Jira ID: IBGCRASH-20025

Co-authored-by: Ahmed Mahmoud <[email protected]>

Author: 2 people

android/src/main/java/com/instabug/flutter/modules/InstabugApi.java

@@ -26,7 +26,6 @@
 import com.instabug.library.invocation.InstabugInvocationEvent;
 import com.instabug.library.model.NetworkLog;
 import com.instabug.library.ui.onboarding.WelcomeMessage;
-import com.instabug.library.visualusersteps.State;
 
 import org.json.JSONObject;
 
@@ -276,7 +275,7 @@ public void run() {
     }
 
     @Override
-    public void setReproStepsConfig(@Nullable String bugMode, @Nullable String crashMode) {
+    public void setReproStepsConfig(@Nullable String bugMode, @Nullable String crashMode, @Nullable String sessionReplayMode) {
         try {
             final ReproConfigurations.Builder builder = new ReproConfigurations.Builder();
 
@@ -290,6 +289,11 @@ public void setReproStepsConfig(@Nullable String bugMode, @Nullable String crash
                 builder.setIssueMode(IssueType.Crash, resolvedCrashMode);
             }
 
+            if (sessionReplayMode != null) {
+                final Integer resolvedSessionReplayMode = ArgsRegistry.reproModes.get(sessionReplayMode);
+                builder.setIssueMode(IssueType.SessionReplay, resolvedSessionReplayMode);
+            }
+
             final ReproConfigurations config = builder.build();
 
             Instabug.setReproConfigurations(config);

android/src/test/java/com/instabug/flutter/ApmApiTest.java

@@ -14,6 +14,7 @@
 
 import com.instabug.apm.APM;
 import com.instabug.apm.model.ExecutionTrace;
+import com.instabug.apm.networking.APMNetworkLogger;
 import com.instabug.flutter.generated.ApmPigeon;
 import com.instabug.flutter.modules.ApmApi;
 import com.instabug.flutter.util.GlobalMocks;
@@ -205,6 +206,7 @@ public void testNetworkLogAndroid() {
         data.put("duration", requestDuration);
         data.put("serverErrorMessage", serverErrorMessage);
 
+        MockedConstruction<APMNetworkLogger> mAPMNetworkLogger = mockConstruction(APMNetworkLogger.class);
         MockedConstruction<JSONObject> mJSONObject = mockConstruction(JSONObject.class, (mock, context) -> when(mock.toString(anyInt())).thenReturn("{}"));
 
         api.networkLogAndroid(data);
@@ -228,6 +230,7 @@ public void testNetworkLogAndroid() {
                 serverErrorMessage
         ));
 
+        mAPMNetworkLogger.close();
         mJSONObject.close();
     }
 }

android/src/test/java/com/instabug/flutter/InstabugApiTest.java

@@ -379,19 +379,21 @@ public void testGetUserAttributes() {
     public void testSetReproStepsConfig() {
         String bug = "ReproStepsMode.enabled";
         String crash = "ReproStepsMode.disabled";
+        String sessionReplay = "ReproStepsMode.disabled";
 
         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);
         });
 
-        api.setReproStepsConfig(bug, crash);
+        api.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.Disable);
         verify(builder).build();
 
         mInstabug.verify(() -> Instabug.setReproConfigurations(config));

example/ios/InstabugTests/ApmApiTests.m

@@ -61,7 +61,8 @@ - (void)testStartExecutionTraceWhenTraceNotNil {
     NSString *name = @"trace-name";
     XCTestExpectation *expectation = [self expectationWithDescription:@"Call completion handler"];
 
-    OCMStub([self.mAPM startExecutionTraceWithName:name]).andReturn([IBGExecutionTrace new]);
+    IBGExecutionTrace *mTrace = OCMClassMock([IBGExecutionTrace class]);
+    OCMStub([self.mAPM startExecutionTraceWithName:name]).andReturn(mTrace);
 
     [self.api startExecutionTraceId:expectedId name:name completion:^(NSString *actualId, FlutterError *error) {
         [expectation fulfill];
@@ -124,7 +125,7 @@ - (void)testStartUITrace {
 
 - (void)testEndUITrace {
     FlutterError *error;
-    
+
     [self.api endUITraceWithError:&error];
 
     OCMVerify([self.mAPM endUITrace]);

example/ios/InstabugTests/InstabugApiTests.m

@@ -285,12 +285,14 @@ - (void)testGetUserAttributes {
 - (void)testSetReproStepsConfig {
     NSString *bugMode = @"ReproStepsMode.enabled";
     NSString *crashMode = @"ReproStepsMode.disabled";
+    NSString *sessionReplayMode = @"ReproStepsMode.disabled";
     FlutterError *error;
 
-    [self.api setReproStepsConfigBugMode:bugMode crashMode:crashMode error:&error];
+    [self.api setReproStepsConfigBugMode:bugMode crashMode:crashMode sessionReplayMode:sessionReplayMode error:&error];
 
     OCMVerify([self.mInstabug setReproStepsFor:IBGIssueTypeBug withMode:IBGUserStepsModeEnable]);
     OCMVerify([self.mInstabug setReproStepsFor:IBGIssueTypeCrash withMode:IBGUserStepsModeDisable]);
+    OCMVerify([self.mInstabug setReproStepsFor:IBGIssueTypeSessionReplay withMode:IBGUserStepsModeDisable]);
 }
 
 - (void)testReportScreenChange {

ios/Classes/Modules/InstabugApi.m

@@ -149,7 +149,7 @@ - (void)getUserAttributesWithCompletion:(nonnull void (^)(NSDictionary<NSString
     completion(Instabug.userAttributes, nil);
 }
 
-- (void)setReproStepsConfigBugMode:(nullable NSString *)bugMode crashMode:(nullable NSString *)crashMode error:(FlutterError * _Nullable __autoreleasing * _Nonnull)error {
+- (void)setReproStepsConfigBugMode:(nullable NSString *)bugMode crashMode:(nullable NSString *)crashMode sessionReplayMode:(nullable NSString *)sessionReplayMode error:(FlutterError * _Nullable __autoreleasing * _Nonnull)error {
     if (bugMode != nil) {
         IBGUserStepsMode resolvedBugMode = ArgsRegistry.reproModes[bugMode].integerValue;
         [Instabug setReproStepsFor:IBGIssueTypeBug withMode:resolvedBugMode];
@@ -159,6 +159,11 @@ - (void)setReproStepsConfigBugMode:(nullable NSString *)bugMode crashMode:(nulla
         IBGUserStepsMode resolvedCrashMode = ArgsRegistry.reproModes[crashMode].integerValue;
         [Instabug setReproStepsFor:IBGIssueTypeCrash withMode:resolvedCrashMode];
     }
+    
+    if (sessionReplayMode != nil) {
+        IBGUserStepsMode resolvedSessionReplayMode = ArgsRegistry.reproModes[sessionReplayMode].integerValue;
+        [Instabug setReproStepsFor:IBGIssueTypeSessionReplay withMode:resolvedSessionReplayMode];
+    }
 }
 
 - (UIImage *)getImageForAsset:(NSString *)assetName {

lib/src/modules/instabug.dart

@@ -351,31 +351,36 @@ class Instabug {
     }
   }
 
-  /// Sets the repro steps mode for bugs and crashes.
+  /// Sets the repro steps mode for Bug Reporting, Crash Reporting and Session Replay.
   ///
   /// [bug] repro steps mode for bug reports.
   /// [crash] repro steps mode for crash reports.
-  /// [all] repro steps mode for both bug and crash reports, when present it
-  /// overrides [bug] and [crash].
+  /// [sessionReplay] repro steps mode for session replay.
+  /// [all] repro steps mode for bug reports, crash reports and session replay.
+  /// If [all] is set, it will override the other modes.
   ///
   /// Example:
   /// ```dart
   /// Instabug.setReproStepsConfig(
   ///   bug: ReproStepsMode.enabled,
   ///   crash: ReproStepsMode.disabled,
+  ///   sessionReplay: ReproStepsMode.enabled,
   /// );
   ///  ```
   static Future<void> setReproStepsConfig({
     ReproStepsMode? bug,
     ReproStepsMode? crash,
+    ReproStepsMode? sessionReplay,
     ReproStepsMode? all,
   }) async {
     var bugMode = bug;
     var crashMode = crash;
+    var sessionReplayMode = sessionReplay;
 
     if (all != null) {
       bugMode = all;
       crashMode = all;
+      sessionReplayMode = all;
     }
 
     // There's an issue with crashes repro steps with screenshots in the iOS SDK
@@ -389,6 +394,7 @@ class Instabug {
     return _host.setReproStepsConfig(
       bugMode.toString(),
       crashMode.toString(),
+      sessionReplayMode.toString(),
     );
   }
 

pigeons/instabug.api.dart

@@ -39,7 +39,11 @@ abstract class InstabugHostApi {
   @async
   Map<String, String>? getUserAttributes();
 
-  void setReproStepsConfig(String? bugMode, String? crashMode);
+  void setReproStepsConfig(
+    String? bugMode,
+    String? crashMode,
+    String? sessionReplayMode,
+  );
   void reportScreenChange(String screenName);
 
   void setCustomBrandingImage(String light, String dark);

test/instabug_test.dart

@@ -276,16 +276,22 @@ void main() {
   test('[setReproStepsConfig] should call host method', () async {
     const bug = ReproStepsMode.enabled;
     const crash = ReproStepsMode.enabledWithNoScreenshots;
+    const sessionReplay = ReproStepsMode.disabled;
 
     when(mBuildInfo.isIOS).thenReturn(false);
 
     await Instabug.setReproStepsConfig(
       bug: bug,
       crash: crash,
+      sessionReplay: sessionReplay,
     );
 
     verify(
-      mHost.setReproStepsConfig(bug.toString(), crash.toString()),
+      mHost.setReproStepsConfig(
+        bug.toString(),
+        crash.toString(),
+        sessionReplay.toString(),
+      ),
     ).called(1);
   });
 
@@ -297,7 +303,7 @@ void main() {
     await Instabug.setReproStepsConfig(all: all);
 
     verify(
-      mHost.setReproStepsConfig(all.toString(), all.toString()),
+      mHost.setReproStepsConfig(all.toString(), all.toString(), all.toString()),
     ).called(1);
   });