[MOB-8680] Add setFloatingButtonEdge API (#233)

* Add setFloatingButtonEdge API - Flutter

* Add setFloatingButtonEdge API - Android

* Add setFloatingButtonEdge API - iOS

* Add setFloatingButtonEdge API tests

* Update CHANGELOG.md

Co-authored-by: Ali Abdelfattah <[email protected]>

Author: DavidMina96

CHANGELOG.md

@@ -1,5 +1,6 @@
 ## master
 
+* Adds BugReporting.setFloatingButtonEdge API
 * Supports starting SDK from Dart only.
 
 ## v10.13.0 (2022-03-31)

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

@@ -4,6 +4,7 @@
 import com.instabug.bug.invocation.Option;
 import com.instabug.featuresrequest.ActionType;
 import com.instabug.library.InstabugColorTheme;
+import com.instabug.library.invocation.util.InstabugFloatingButtonEdge;
 import com.instabug.library.InstabugCustomTextPlaceHolder;
 import com.instabug.library.extendedbugreport.ExtendedBugReport;
 import com.instabug.library.visualusersteps.State;
@@ -56,6 +57,7 @@ final class ArgsRegistry {
         registerColorThemeArgs(ARGS);
         registerLocaleArgs(ARGS);
         registerInvocationOptionsArgs(ARGS);
+        registerInstabugFloatingButtonEdgeArgs(ARGS);
         registerCustomTextPlaceHolderKeysArgs(ARGS);
         registerInstabugReportTypesArgs(ARGS);
         registerInstabugExtendedBugReportModeArgs(ARGS);
@@ -123,6 +125,11 @@ static void registerColorThemeArgs(Map<String, Object> args) {
         args.put("ColorTheme.dark", InstabugColorTheme.InstabugColorThemeDark);
     }
 
+    static void registerInstabugFloatingButtonEdgeArgs(Map<String, Object> args) {
+        args.put("FloatingButtonEdge.left", InstabugFloatingButtonEdge.LEFT);
+        args.put("FloatingButtonEdge.right", InstabugFloatingButtonEdge.RIGHT);
+    }
+
     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/instabugflutter/InstabugFlutterPlugin.java

@@ -26,6 +26,7 @@
 import com.instabug.library.extendedbugreport.ExtendedBugReport;
 import com.instabug.library.invocation.InstabugInvocationEvent;
 import com.instabug.library.invocation.OnInvokeCallback;
+import com.instabug.library.invocation.util.InstabugFloatingButtonEdge;
 import com.instabug.library.logging.InstabugLog;
 import com.instabug.library.model.NetworkLog;
 import com.instabug.library.ui.onboarding.WelcomeMessage;
@@ -282,6 +283,19 @@ public void setColorTheme(String colorTheme) {
         }
     }
 
+    /**
+     * Sets the position of Instabug floating button on the screen.
+     * 
+     * @param floatingButtonEdge    left or right edge of the screen.
+     * @param floatingButtonOffset  offset for the position on the y-axis.
+     */
+    public void setFloatingButtonEdge(String floatingButtonEdge, int floatingButtonOffset) {
+        InstabugFloatingButtonEdge resolvedFloatingButtonEdge = ArgsRegistry.getDeserializedValue(floatingButtonEdge,
+                InstabugFloatingButtonEdge.class);
+        BugReporting.setFloatingButtonEdge(resolvedFloatingButtonEdge);
+        BugReporting.setFloatingButtonOffset(floatingButtonOffset);
+    }
+
     /**
      * 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

@@ -148,6 +148,16 @@ public void testSetPrimaryColor() {
         verify(instabugMock).setPrimaryColor(12312331231233L);
     }
 
+    public void testSetFloatingButtonEdge(){
+        String methodName = "setFloatingButtonEdge";
+        ArrayList<Object> argsList = new ArrayList<>();
+        argsList.add("FloatingButtonEdge.left");
+        argsList.add(300);
+        Mockito.doNothing().when(instabugMock).setFloatingButtonEdge(any(String.class), any(Integer.class));
+        testMethodCall(methodName, argsList);
+        verify(instabugMock).setFloatingButtonEdge("FloatingButtonEdge.left", 300);
+    }
+
     public void testAddFileAttachmentWithData() {
         String methodName = "addFileAttachmentWithData";
         ArrayList<Object> argsList = new ArrayList<>();

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

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

example/ios/InstabugSampleTests/InstabugSampleTests.m

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

ios/Classes/InstabugFlutterPlugin.h

@@ -102,6 +102,13 @@
  */
 + (void)setColorTheme:(NSString *)colorTheme;
 
+/**
+ * Sets the position of Instabug floating button on the screen.
+ * @param floatingButtonEdge  left or right edge of the screen.
+ * @param floatingButtonTopOffset offset for the position on the y-axis.
+ */
++ (void)setFloatingButtonEdge:(NSString *)floatingButtonEdge withTopOffset:(NSNumber *)floatingButtonTopOffset;
+
 /**
  * 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

@@ -212,6 +212,19 @@ + (void)setColorTheme:(NSString*) colorTheme {
     [Instabug setColorTheme:intColorTheme];
 }
 
+/**
+ * Sets the position of Instabug floating button on the screen.
+ * @param floatingButtonEdge  left or right edge of the screen.
+ * @param floatingButtonTopOffset offset for the position on the y-axis.
+ */
++ (void)setFloatingButtonEdge:(NSString *)floatingButtonEdge withTopOffset:(NSNumber *)floatingButtonTopOffset {
+    NSDictionary *constants = [self constants];
+    CGRectEdge intFloatingButtonEdge = ((NSNumber *) constants[floatingButtonEdge]).doubleValue;
+    IBGBugReporting.floatingButtonEdge = intFloatingButtonEdge;
+    double offsetFromTop = [floatingButtonTopOffset doubleValue];
+    IBGBugReporting.floatingButtonTopOffset = offsetFromTop;
+}
+
 /**
  * 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.
@@ -1005,6 +1018,9 @@ + (NSDictionary *)constants {
       @"ColorTheme.dark": @(IBGColorThemeDark),
       @"ColorTheme.light": @(IBGColorThemeLight),
 
+      @"FloatingButtonEdge.left": @(CGRectMinXEdge),
+      @"FloatingButtonEdge.right": @(CGRectMaxXEdge),
+
       @"InvocationOption.commentFieldRequired": @(IBGBugReportingOptionCommentFieldRequired),
       @"InvocationOption.disablePostSendingDialog": @(IBGBugReportingOptionDisablePostSendingDialog),
       @"InvocationOption.emailFieldHidden": @(IBGBugReportingOptionEmailFieldHidden),

lib/BugReporting.dart

@@ -23,6 +23,8 @@ enum ExtendedBugReportMode {
   disabled
 }
 
+enum FloatingButtonEdge { left, right }
+
 class BugReporting {
   static Function? _onInvokeCallback;
   static Function? _onDismissCallback;
@@ -162,6 +164,19 @@ class BugReporting {
     await _channel.invokeMethod<Object>('setInvocationOptions:', params);
   }
 
+  /// Sets the floating button position.
+  /// [floatingButtonEdge] FloatingButtonEdge enum - left or right edge of the screen.
+  /// [offsetFromTop] integer offset for the position on the y-axis.
+  static Future<void> setFloatingButtonEdge(
+      FloatingButtonEdge floatingButtonEdge, int offsetFromTop) async {
+    final List<dynamic> params = <dynamic>[
+      floatingButtonEdge.toString(),
+      offsetFromTop
+    ];
+    await _channel.invokeMethod<Object>(
+        'setFloatingButtonEdge:withTopOffset:', params);
+  }
+
   /// Invoke bug reporting with report type and options.
   /// [reportType] type
   /// [invocationOptions]  List of invocation options

test/instabug_flutter_test.dart

@@ -253,6 +253,24 @@ void main() {
     ]);
   });
 
+  test(
+      'test setFloatingButtonEdge should be called with arguments floatingButtonEdge and offsetFromTop',
+      () async {
+    const FloatingButtonEdge floatingButtonEdge = FloatingButtonEdge.left;
+    const int offsetFromTop = 300;
+    await BugReporting.setFloatingButtonEdge(floatingButtonEdge, offsetFromTop);
+    final List<dynamic> args = <dynamic>[
+      floatingButtonEdge.toString(),
+      offsetFromTop
+    ];
+    expect(log, <Matcher>[
+      isMethodCall(
+        'setFloatingButtonEdge:withTopOffset:',
+        arguments: args,
+      )
+    ]);
+  });
+
   test('test appendTags should be called with argument List of strings',
       () async {
     const List<String> tags = ['tag1', 'tag2'];