[IBGCORE-17136] Add BugReporting.setVideoRecordingFloatingButtonPosition API (#269)

* Add `Position` enum to ArgsRegistry and Constants

* Add `setVideoRecordingFloatingButtonPosition` on Android

* Add Dart API for `setVideoRecordingFloatingButtonPosition`

* Add `setVideoRecordingFloatingButtonPosition` on iOS

* Update CHANGELOG

* Test `setVideoRecordingFloatingButtonPosition`

* Test iOS `setVideoRecordingFloatingButtonPosition`

* Test Android `setVideoRecordingFloatingButtonPosition`

* Fix typo in CHANGELOG

* Update CHANGELOG

Remove backticks as they cause issues on the dashboard

Author: a7medev

CHANGELOG.md

@@ -1,3 +1,7 @@
+## Unreleased
+
+* Adds BugReporting.setVideoRecordingFloatingButtonPosition API
+
 ## 11.2.0 (2022-09-08)
 
 * Bumps Instabug Android SDK to v11.4.1

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

@@ -5,6 +5,7 @@
 import com.instabug.featuresrequest.ActionType;
 import com.instabug.library.InstabugColorTheme;
 import com.instabug.library.invocation.util.InstabugFloatingButtonEdge;
+import com.instabug.library.invocation.util.InstabugVideoRecordingButtonPosition;
 import com.instabug.library.InstabugCustomTextPlaceHolder;
 import com.instabug.library.extendedbugreport.ExtendedBugReport;
 import com.instabug.library.visualusersteps.State;
@@ -58,6 +59,7 @@ final class ArgsRegistry {
         registerLocaleArgs(ARGS);
         registerInvocationOptionsArgs(ARGS);
         registerInstabugFloatingButtonEdgeArgs(ARGS);
+        registerInstabugVideoRecordingButtonPositionArgs(ARGS);
         registerCustomTextPlaceHolderKeysArgs(ARGS);
         registerInstabugReportTypesArgs(ARGS);
         registerInstabugExtendedBugReportModeArgs(ARGS);
@@ -130,6 +132,13 @@ static void registerInstabugFloatingButtonEdgeArgs(Map<String, Object> args) {
         args.put("FloatingButtonEdge.right", InstabugFloatingButtonEdge.RIGHT);
     }
 
+    static void registerInstabugVideoRecordingButtonPositionArgs(Map<String, Object> args) {
+        args.put("Position.topRight", InstabugVideoRecordingButtonPosition.TOP_RIGHT);
+        args.put("Position.topLeft", InstabugVideoRecordingButtonPosition.TOP_LEFT);
+        args.put("Position.bottomRight", InstabugVideoRecordingButtonPosition.BOTTOM_RIGHT);
+        args.put("Position.bottomLeft", InstabugVideoRecordingButtonPosition.BOTTOM_LEFT);
+    }
+
     static void registerInvocationOptionsArgs(Map<String, Object> args) {
         args.put("InvocationOption.commentFieldRequired", Option.COMMENT_FIELD_REQUIRED);
         args.put("InvocationOption.disablePostSendingDialog", Option.DISABLE_POST_SENDING_DIALOG);

android/src/main/java/com/instabug/flutter/InstabugFlutterPlugin.java

@@ -28,6 +28,7 @@
 import com.instabug.library.invocation.InstabugInvocationEvent;
 import com.instabug.library.invocation.OnInvokeCallback;
 import com.instabug.library.invocation.util.InstabugFloatingButtonEdge;
+import com.instabug.library.invocation.util.InstabugVideoRecordingButtonPosition;
 import com.instabug.library.logging.InstabugLog;
 import com.instabug.library.model.NetworkLog;
 import com.instabug.library.ui.onboarding.WelcomeMessage;
@@ -297,6 +298,16 @@ public void setFloatingButtonEdge(String floatingButtonEdge, int floatingButtonO
         BugReporting.setFloatingButtonOffset(floatingButtonOffset);
     }
 
+    /**
+     * Sets the position of the video recording button when using the screen recording attachment functionality.
+     *
+     * @param videoRecordingButtonPosition position of the video recording floating button on the screen.
+     */
+    public void setVideoRecordingFloatingButtonPosition(String videoRecordingButtonPosition) {
+        InstabugVideoRecordingButtonPosition resolvedVideoRecordingButtonPosition = ArgsRegistry.getDeserializedValue(videoRecordingButtonPosition, InstabugVideoRecordingButtonPosition.class);
+        BugReporting.setVideoRecordingFloatingButtonPosition(resolvedVideoRecordingButtonPosition);
+    }
+
     /**
      * Appends a set of tags to previously added tags of reported feedback, bug or
      * crash.

example/android/app/src/main/kotlin/com/example/InstabugSample/OnMethodCallTests.java

@@ -158,6 +158,15 @@ public void testSetFloatingButtonEdge(){
         verify(instabugMock).setFloatingButtonEdge("FloatingButtonEdge.left", 300);
     }
 
+    public void testSetVideoRecordingFloatingButtonPosition(){
+        String methodName = "setVideoRecordingFloatingButtonPosition";
+        ArrayList<Object> argsList = new ArrayList<>();
+        argsList.add("Position.topRight");
+        Mockito.doNothing().when(instabugMock).setVideoRecordingFloatingButtonPosition(any(String.class));
+        testMethodCall(methodName, argsList);
+        verify(instabugMock).setVideoRecordingFloatingButtonPosition("Position.topRight");
+    }
+
     public void testAddFileAttachmentWithData() {
         String methodName = "addFileAttachmentWithData";
         ArrayList<Object> argsList = new ArrayList<>();

example/android/app/src/test/java/com/example/InstabugSample/InstabugFlutterPluginTest.java

@@ -105,6 +105,14 @@ public void testSetFloatingButtonEdge() {
         new OnMethodCallTests().testSetFloatingButtonEdge();
     }
 
+    /**
+     * (String)
+     */
+    @Test
+    public void testSetVideoRecordingFloatingButtonPosition() {
+        new OnMethodCallTests().testSetVideoRecordingFloatingButtonPosition();
+    }
+
     /**
      * (byte[], String)
      */

example/ios/InstabugSampleTests/InstabugSampleTests.m

@@ -217,6 +217,24 @@ - (void)testSetFloatingButtonEdge {
      [self waitForExpectationsWithTimeout:kTimeout handler:nil];
  }
 
+ - (void)testSetVideoRecordingFloatingButtonPosition {
+     id mock = OCMClassMock([InstabugFlutterPlugin class]);
+     InstabugFlutterPlugin *instabug = [[InstabugFlutterPlugin alloc] init];
+     
+     NSArray *arguments = [NSArray arrayWithObjects:@"Position.topRight", nil];
+     FlutterMethodCall *call = [FlutterMethodCall methodCallWithMethodName:@"setVideoRecordingFloatingButtonPosition:" arguments:arguments];
+     [[[mock stub] classMethod] setVideoRecordingFloatingButtonPosition:@"Position.topRight"];
+
+     XCTestExpectation *expectation = [self expectationWithDescription:@"Result is called"];
+     [instabug handleMethodCall:call result:^(id _Nullable result) {
+         XCTAssertNil(result);
+         [expectation fulfill];
+     }];
+
+     [[[mock verify] classMethod] setVideoRecordingFloatingButtonPosition:@"Position.topRight"];
+     [self waitForExpectationsWithTimeout:kTimeout handler:nil];
+ }
+
  - (void)testAddFileAttachmentWithData {
      id mock = OCMClassMock([InstabugFlutterPlugin class]);
      InstabugFlutterPlugin *instabug = [[InstabugFlutterPlugin alloc] init];

ios/Classes/InstabugFlutterPlugin.h

@@ -109,6 +109,12 @@
  */
 + (void)setFloatingButtonEdge:(NSString *)floatingButtonEdge withTopOffset:(NSNumber *)floatingButtonTopOffset;
 
+/**
+ * Sets the position of the video recording button when using the screen recording attachment functionality.
+ * @param position Position of the video recording floating button on the screen.
+ */
++ (void)setVideoRecordingFloatingButtonPosition:(NSString *)position;
+
 /**
  * Appends a set of tags to previously added tags of reported feedback, bug or crash.
  * @param tags An array of tags to append to current tags.

ios/Classes/InstabugFlutterPlugin.m

@@ -225,6 +225,16 @@ + (void)setFloatingButtonEdge:(NSString *)floatingButtonEdge withTopOffset:(NSNu
     IBGBugReporting.floatingButtonTopOffset = offsetFromTop;
 }
 
+/**
+ * Sets the position of the video recording button when using the screen recording attachment functionality.
+ * @param position Position of the video recording floating button on the screen.
+ */
++ (void)setVideoRecordingFloatingButtonPosition:(NSString *)position {
+    NSDictionary *constants = [self constants];
+    IBGPosition intPosition = ((NSNumber *) constants[position]).doubleValue;
+    IBGBugReporting.videoRecordingFloatingButtonPosition = intPosition;
+}
+
 /**
  * Appends a set of tags to previously added tags of reported feedback, bug or crash.
  * @param tags An array of tags to append to current tags.
@@ -1018,6 +1028,11 @@ + (NSDictionary *)constants {
 
       @"FloatingButtonEdge.left": @(CGRectMinXEdge),
       @"FloatingButtonEdge.right": @(CGRectMaxXEdge),
+      
+      @"Position.topRight": @(IBGPositionTopRight),
+      @"Position.topLeft": @(IBGPositionTopLeft),
+      @"Position.bottomRight": @(IBGPositionBottomRight),
+      @"Position.bottomLeft": @(IBGPositionBottomLeft),
 
       @"InvocationOption.commentFieldRequired": @(IBGBugReportingOptionCommentFieldRequired),
       @"InvocationOption.disablePostSendingDialog": @(IBGBugReportingOptionDisablePostSendingDialog),

lib/src/modules/bug_reporting.dart

@@ -25,6 +25,13 @@ enum ExtendedBugReportMode {
 
 enum FloatingButtonEdge { left, right }
 
+enum Position {
+  topRight,
+  topLeft,
+  bottomRight,
+  bottomLeft,
+}
+
 typedef OnSDKInvokeCallback = void Function();
 typedef OnSDKDismissCallback = void Function(DismissType, ReportType);
 
@@ -191,6 +198,18 @@ class BugReporting {
     );
   }
 
+  /// Sets the position of the video recording button when using the screen recording attachment functionality.
+  /// [position] Position of the video recording floating button on the screen.
+  static Future<void> setVideoRecordingFloatingButtonPosition(
+    Position position,
+  ) async {
+    final params = <dynamic>[position.toString()];
+    return _channel.invokeMethod(
+      'setVideoRecordingFloatingButtonPosition:',
+      params,
+    );
+  }
+
   /// Invoke bug reporting with report type and options.
   /// [reportType] type
   /// [invocationOptions]  List of invocation options

test/instabug_flutter_test.dart

@@ -248,6 +248,20 @@ void main() {
     ]);
   });
 
+  test(
+      'test setVideoRecordingFloatingButtonPosition should be called with argument position',
+      () async {
+    const position = Position.topRight;
+    await BugReporting.setVideoRecordingFloatingButtonPosition(position);
+    final args = <dynamic>[position.toString()];
+    expect(log, <Matcher>[
+      isMethodCall(
+        'setVideoRecordingFloatingButtonPosition:',
+        arguments: args,
+      )
+    ]);
+  });
+
   test('test appendTags should be called with argument List of strings',
       () async {
     const tags = ['tag1', 'tag2'];