Merge branch 'dev' of https://github.com/Instabug/Instabug-Flutter into feat/support-app-flows

Author: abdelhamid-f-nasser

CHANGELOG.md

@@ -4,11 +4,12 @@
 
 ### Added
 
-- Add support for App Flows APIs `APM.startFlow`, `APM.endFlow` and `APM.setFlowAttribute` ([#1138](https://github.com/Instabug/Instabug-Flutter/pull/446)).
+- Add `SessionReplay.getSessionReplayLink` API which retrieves the current session's replay link ([#445](hhttps://github.com/Instabug/Instabug-Flutter/pull/445)).
+- Add support for App Flows APIs `APM.startFlow`, `APM.endFlow` and `APM.setFlowAttribute` ([#446](https://github.com/Instabug/Instabug-Flutter/pull/446)).
 
 ### Deprecated
 
-- Deprecate execution traces APIs `APM.startExecutionTrace`, `APM.setExecutionTraceAttribute`, `APM.endExecutionTrace`, `Trace.setAttribute` and `Trace.end` in favor of the new app flow APIs ([#1138](https://github.com/Instabug/Instabug-Flutter/pull/446)).
+- Deprecate execution traces APIs `APM.startExecutionTrace`, `APM.setExecutionTraceAttribute`, `APM.endExecutionTrace`, `Trace.setAttribute` and `Trace.end` in favor of the new app flow APIs ([#446](https://github.com/Instabug/Instabug-Flutter/pull/446)).
 
 ## [12.7.0](https://github.com/Instabug/Instabug-Flutter/compare/v12.5.0...v12.7.0) (February 15, 2024)
 

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

@@ -1,8 +1,10 @@
 package com.instabug.flutter.modules;
 
 import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
 
 import com.instabug.flutter.generated.SessionReplayPigeon;
+import com.instabug.library.OnSessionReplayLinkReady;
 import com.instabug.library.sessionreplay.SessionReplay;
 
 import io.flutter.plugin.common.BinaryMessenger;
@@ -33,4 +35,11 @@ public void setInstabugLogsEnabled(@NonNull Boolean isEnabled) {
     public void setUserStepsEnabled(@NonNull Boolean isEnabled) {
         SessionReplay.setUserStepsEnabled(isEnabled);
     }
+
+    @Override
+    public void getSessionReplayLink(@NonNull SessionReplayPigeon.Result<String> result) {
+        SessionReplay.getSessionReplayLink(result::success);
+    }
+
+
 }

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

@@ -4,10 +4,13 @@
 import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.mockStatic;
+import static org.mockito.Mockito.timeout;
+import static org.mockito.Mockito.verify;
 
 import com.instabug.flutter.generated.SessionReplayPigeon;
 import com.instabug.flutter.modules.SessionReplayApi;
 import com.instabug.flutter.util.GlobalMocks;
+import com.instabug.library.OnSessionReplayLinkReady;
 import com.instabug.library.sessionreplay.SessionReplay;
 
 import org.junit.After;
@@ -81,6 +84,28 @@ public void testSetUserStepsEnabled() {
 
         mSessionReplay.verify(() -> SessionReplay.setUserStepsEnabled(true));
     }
+    @Test
+    public void testGetSessionReplayLink() {
+        SessionReplayPigeon.Result<String> result = mock(SessionReplayPigeon.Result.class);
+        String link="instabug link";
+
+        mSessionReplay.when(() -> SessionReplay.getSessionReplayLink(any())).thenAnswer(
+                invocation -> {
+                    OnSessionReplayLinkReady callback = (OnSessionReplayLinkReady) invocation.getArguments()[0];
+                    callback.onSessionReplayLinkReady(link);
+                    return callback;
+                });
+        api.getSessionReplayLink(result);
+
+
+        mSessionReplay.verify(() -> SessionReplay.getSessionReplayLink(any()));
+        mSessionReplay.verifyNoMoreInteractions();
+
+
+        verify(result, timeout(1000)).success(link);
+
+
+    }
 
 }
 

example/ios/InstabugTests/SessionReplayApiTests.m

@@ -1,4 +1,6 @@
 #import <XCTest/XCTest.h>
+#import <instabug_flutter/InstabugFlutterPlugin.h>
+#import <instabug_flutter/SessionReplayApi.h>
 #import "OCMock/OCMock.h"
 #import "SessionReplayApi.h"
 #import "Instabug/IBGSessionReplay.h"
@@ -54,4 +56,17 @@ - (void)testSetUserStepsEnabled {
     OCMVerify([self.mSessionReplay setUserStepsEnabled:YES]);
 }
 
+- (void)testGetSessionReplayLink {
+    NSString *link = @"link";
+    id result = ^(NSString * result, FlutterError * error) {
+        XCTAssertEqualObjects(result, link);
+    };
+
+    OCMStub([self.mSessionReplay sessionReplayLink]).andReturn(link);
+    [self.api getSessionReplayLinkWithCompletion:result];
+    OCMVerify([self.mSessionReplay sessionReplayLink]);
+
+}
+
+
 @end

example/lib/main.dart

@@ -170,6 +170,23 @@ class _MyHomePageState extends State<MyHomePage> {
     Surveys.showSurvey('PMqUZXqarkOR2yGKiENB4w');
   }
 
+  final _scaffoldKey=GlobalKey<ScaffoldState>();
+
+  void getCurrentSessionReplaylink() async {
+    final result=await SessionReplay.getSessionReplayLink();
+    if(result==null){
+      const snackBar = SnackBar(
+        content: Text('No Link Found'),
+      );
+      ScaffoldMessenger.of(_scaffoldKey.currentContext!).showSnackBar(snackBar);
+    }else{
+      var  snackBar = SnackBar(
+        content: Text(result),
+      );
+      ScaffoldMessenger.of(_scaffoldKey.currentContext!).showSnackBar(snackBar);
+    }
+  }
+
   void showFeatureRequests() {
     FeatureRequests.show();
   }
@@ -204,6 +221,7 @@ class _MyHomePageState extends State<MyHomePage> {
   @override
   Widget build(BuildContext context) {
     return Scaffold(
+      key: _scaffoldKey,
       appBar: AppBar(title: Text(widget.title)),
       body: SingleChildScrollView(
           physics: ClampingScrollPhysics(),
@@ -362,6 +380,13 @@ class _MyHomePageState extends State<MyHomePage> {
                     ),
                     child: const Text('Dark'),
                   ),
+
+
+                  SectionTitle('Sessions Replay'),
+                  InstabugButton(
+                    onPressed: getCurrentSessionReplaylink,
+                    text: 'Get current session replay link',
+                  ),
                 ],
               ),
             ],

ios/Classes/Modules/SessionReplayApi.m

@@ -27,4 +27,11 @@ - (void)setUserStepsEnabledIsEnabled:(nonnull NSNumber *)isEnabled error:(Flutte
     IBGSessionReplay.userStepsEnabled = [isEnabled boolValue];
 }
 
+- (void)getSessionReplayLinkWithCompletion:(void (^)(NSString *, FlutterError *))completion {
+   NSString * link= IBGSessionReplay.sessionReplayLink;
+   completion(link,nil);
+
+}
+
+
 @end

lib/src/modules/session_replay.dart

@@ -63,4 +63,15 @@ class SessionReplay {
   static Future<void> setUserStepsEnabled(bool isEnabled) async {
     return _host.setUserStepsEnabled(isEnabled);
   }
+
+  /// Retrieves current session's replay link.
+  ///
+  /// Example:
+  ///
+  /// ```dart
+  /// await SessionReplay.getSessionReplayLink();
+  /// ```
+  static Future<String> getSessionReplayLink() async {
+    return _host.getSessionReplayLink();
+  }
 }

pigeons/session_replay.api.dart

@@ -6,4 +6,8 @@ abstract class SessionReplayHostApi {
   void setNetworkLogsEnabled(bool isEnabled);
   void setInstabugLogsEnabled(bool isEnabled);
   void setUserStepsEnabled(bool isEnabled);
+  @async
+  String getSessionReplayLink();
+
+
 }

test/session_replay_test.dart

@@ -47,6 +47,7 @@ void main() {
     ).called(1);
   });
 
+
   test('[setUserStepsEnabled] should call host method', () async {
     const isEnabled = true;
     await SessionReplay.setUserStepsEnabled(isEnabled);
@@ -55,4 +56,15 @@ void main() {
       mHost.setUserStepsEnabled(isEnabled),
     ).called(1);
   });
+
+  test('[getSessionReplayLink] should call host method', () async {
+    const link = 'link';
+    when(mHost.getSessionReplayLink()).thenAnswer((_) async => link);
+
+   final result= await SessionReplay.getSessionReplayLink();
+    expect(result, link);
+    verify(
+      mHost.getSessionReplayLink(),
+    ).called(1);
+  });
 }