Merge pull request #560 from Instabug/fix/setVideoRecordingFloatingButtonPosition

[INSD-5219] Fix BugReporting.setVideoRecordingFloatingButtonPosition

Author: Ali Abdelfattah

CHANGELOG.md

@@ -1,7 +1,8 @@
-## v10.3.0 (2021-04-21)
+## v10.3.0 (2021-04-22)
 
-* Updates Instabug Android and iOS SDKs
-* Migrates iOS to XCFramework
+* Updates Instabug Android and iOS SDKs.
+* Migrates iOS to XCFramework.
+* Deprecates Instabug.setVideoRecordingFloatingButtonPosition in favor of BugReporting.setVideoRecordingFloatingButtonPosition.
 
 ## v10.0.0 (2021-02-16)
 

__tests__/bugReporting.spec.js

@@ -35,6 +35,7 @@ describe('Testing BugReporting Module', () => {
   const didSelectPromptOptionHandler = sinon.spy(NativeModules.IBGBugReporting, 'setDidSelectPromptOptionHandler');
   const setFloatingButtonEdge = sinon.spy(NativeModules.IBGBugReporting, 'setFloatingButtonEdge');
   const setEnabledAttachmentTypes = sinon.spy(NativeModules.IBGBugReporting, 'setEnabledAttachmentTypes');
+  const setVideoRecordingFloatingButtonPosition = sinon.spy(NativeModules.IBGBugReporting, 'setVideoRecordingFloatingButtonPosition');
 
 
   beforeEach(() => {
@@ -265,4 +266,12 @@ describe('Testing BugReporting Module', () => {
 
   });
 
+  it('should call the native method setVideoRecordingFloatingButtonPosition', () => {
+
+    const position = 30;
+    BugReporting.setVideoRecordingFloatingButtonPosition(position);
+
+    expect(setVideoRecordingFloatingButtonPosition.calledOnceWithExactly(position)).toBe(true);
+
+  });
 });

__tests__/index.spec.js

@@ -56,7 +56,6 @@ describe('Instabug Module', () => {
   const enable = sinon.spy(NativeModules.Instabug, 'enable');
   const disable = sinon.spy(NativeModules.Instabug, 'disable');
   const isRunningLive = sinon.spy(NativeModules.Instabug, 'isRunningLive');
-  const setVideoRecordingFloatingButtonPosition = sinon.spy(NativeModules.Instabug, 'setVideoRecordingFloatingButtonPosition');
   const showWelcomeMessageWithMode = sinon.spy(NativeModules.Instabug, 'showWelcomeMessageWithMode');
   const setWelcomeMessageMode = sinon.spy(NativeModules.Instabug, 'setWelcomeMessageMode');
   const setFileAttachment = sinon.spy(NativeModules.Instabug, 'setFileAttachment');
@@ -503,15 +502,6 @@ describe('Instabug Module', () => {
 
   });
 
-  it('should call the native method setVideoRecordingFloatingButtonPosition', () => {
-
-    const position = 30;
-    Instabug.setVideoRecordingFloatingButtonPosition(position);
-
-    expect(setVideoRecordingFloatingButtonPosition.calledOnceWithExactly(position)).toBe(true);
-
-  });
-
   it('should call the native method showWelcomeMessageWithMode', () => {
 
     const mode = Instabug.welcomeMessageMode.beta;
@@ -710,5 +700,3 @@ describe('Instabug Module', () => {
   });
 
 });
-
-

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

@@ -418,25 +418,6 @@ public void run() {
         });
     }
 
-    /**
-     * Sets the default corner at which the video recording floating button will be shown
-     *
-     * @param corner corner to stick the video recording floating button to
-     */
-    @ReactMethod
-    public void setVideoRecordingFloatingButtonPosition(final String corner) {
-        MainThreadHandler.runOnMainThread(new Runnable() {
-            @Override
-            public void run() {
-                try {
-                    BugReporting.setVideoRecordingFloatingButtonPosition(getVideoRecordingButtonCorner(corner));
-                } catch (Exception e) {
-                    e.printStackTrace();
-                }
-            }
-        });
-    }
-
     /**
      * The file at filePath will be uploaded along upcoming reports with the name
      * fileNameWithExtension

index.d.ts

@@ -39,6 +39,9 @@ export namespace BugReporting {
     autoScreenRecordingMaxDuration: number
   ): void;
   function setViewHierarchyEnabled(viewHierarchyEnabled: boolean): void;
+  function setVideoRecordingFloatingButtonPosition(
+    position: BugReporting.position
+  ): void;
   enum invocationEvent {
     none,
     shake,
@@ -68,6 +71,12 @@ export namespace BugReporting {
     commentFieldRequired,
     disablePostSendingDialog
   }
+  enum position {
+    bottomRight,
+    topRight,
+    bottomLeft,
+    topLeft
+  }
 }
 export namespace Chats {
   function setEnabled(isEnabled: boolean): void;

index.js

@@ -666,7 +666,9 @@ const InstabugModule = {
     }
   },
 
+  /* istanbul ignore next */
   /**
+   * @deprecated use {@link BugReporting.setVideoRecordingFloatingButtonPosition}
    * Sets the default position at which the Instabug screen recording button will be shown.
    * Different orientations are already handled.
    * (Default for `position` is `bottomRight`)
@@ -675,7 +677,7 @@ const InstabugModule = {
    * or `bottomRight` to show on the bottom right of scrren.
    */
   setVideoRecordingFloatingButtonPosition(position) {
-    Instabug.setVideoRecordingFloatingButtonPosition(position);
+    BugReporting.setVideoRecordingFloatingButtonPosition(position);
   },
 
   /* istanbul ignore next */

jest/mockBugReporting.js

@@ -18,7 +18,8 @@ jest.mock('NativeModules', () => {
           setAutoScreenRecordingMaxDuration: jest.fn(),
           setViewHierarchyEnabled: jest.fn(),
           setEnabledAttachmentTypes: jest.fn(),
-          setDidSelectPromptOptionHandler: jest.fn()
+          setDidSelectPromptOptionHandler: jest.fn(),
+          setVideoRecordingFloatingButtonPosition: jest.fn(),
       },
       Instabug: {}
     };

jest/mockInstabug.js

@@ -48,15 +48,14 @@ jest.mock('NativeModules', () => {
             getReport: jest.fn(),
             sendHandledJSCrash: jest.fn(),
             sendJSCrash: jest.fn(),
-            reportScreenChange: jest.fn()
-
+            reportScreenChange: jest.fn(),
         },
         IBGBugReporting: {
             setFloatingButtonEdge: jest.fn(),
             setEnabledAttachmentTypes: jest.fn(),
         },
         IBGReplies: {
             setPushNotificationsEnabled: jest.fn(),
-        }
+        },
     };
 });

modules/BugReporting.js

@@ -168,6 +168,18 @@ export default {
     IBGBugReporting.setAutoScreenRecordingMaxDuration(autoScreenRecordingMaxDuration);
   },
 
+  /**
+   * Sets the default position at which the Instabug screen recording button will be shown.
+   * Different orientations are already handled.
+   * (Default for `position` is `bottomRight`)
+   *
+   * @param position is of type position `topLeft` to show on the top left of screen,
+   * or `bottomRight` to show on the bottom right of scrren.
+   */
+  setVideoRecordingFloatingButtonPosition(position) {
+    IBGBugReporting.setVideoRecordingFloatingButtonPosition(position);
+  },
+
   /**
    * @summary Enables/disables inspect view hierarchy when reporting a bug/feedback.
    * @param {boolean} viewHierarchyEnabled A boolean to set whether view hierarchy are enabled
@@ -287,5 +299,17 @@ export default {
     emailFieldOptional: Instabug.optionEmailFieldOptional,
     commentFieldRequired: Instabug.optionCommentFieldRequired,
     disablePostSendingDialog: Instabug.optionDisablePostSendingDialog
-  }
+  },
+
+  /**
+   * Instabug floating buttons positions.
+   * @readonly
+   * @enum {number}
+   */
+   position: {
+    bottomRight: Instabug.bottomRight,
+    topRight: Instabug.topRight,
+    bottomLeft: Instabug.bottomLeft,
+    topLeft: Instabug.topLeft
+  },
 };