[MOB-8359] Add Expirements APIs (#671)

* Add Android Experiments API methods

* Add iOS Experiments API methods

* Add JavaScript Experiments APIs methods

* Add Experiments types

* Add Experiments APIs to iOS native header file

* Test Experiments API methods

* Test Android Experiments APIs

* Test iOS Experiments APIs

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

Author: a7medev

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 * Bumps Instabug iOS SDK to v10.11.8
 * Bumps Instabug Android SDK to v10.13.0
+* Adds Instabug Experiments APIs
 * Adds defensive type checking in Instabug logging APIs
 * Excludes unnecessary files from the published npm package
 * Fixes an issue with GraphQL requests not being grouped correctly

InstabugSample/ios/InstabugSampleTests/InstabugSampleTests.m

@@ -397,4 +397,29 @@ - (void)testClearLogs {
   OCMVerify([mock clearAllLogs]);
 }
 
+- (void)testAddExperiments {
+  id mock = OCMClassMock([Instabug class]);
+  NSArray *experiments = @[@"exp1", @"exp2"];
+
+  OCMStub([mock addExperiments:experiments]);
+  [self.instabugBridge addExperiments:experiments];
+  OCMVerify([mock addExperiments:experiments]);
+}
+
+- (void)testRemoveExperiments {
+  id mock = OCMClassMock([Instabug class]);
+  NSArray *experiments = @[@"exp1", @"exp2"];
+
+  OCMStub([mock removeExperiments:experiments]);
+  [self.instabugBridge removeExperiments:experiments];
+  OCMVerify([mock removeExperiments:experiments]);
+}
+
+- (void)testClearAllExperiments {
+  id mock = OCMClassMock([Instabug class]);
+  OCMStub([mock clearAllExperiments]);
+  [self.instabugBridge clearAllExperiments];
+  OCMVerify([mock clearAllExperiments]);
+}
+
 @end

__tests__/index.spec.js

@@ -66,6 +66,9 @@ describe('Instabug Module', () => {
   const sendHandledJSCrash = sinon.spy(NativeModules.Instabug, 'sendHandledJSCrash');
   const sendJSCrash = sinon.spy(NativeModules.Instabug, 'sendJSCrash');
   const reportScreenChange = sinon.spy(NativeModules.Instabug, 'reportScreenChange');
+  const addExperiments = sinon.spy(NativeModules.Instabug, 'addExperiments');
+  const removeExperiments = sinon.spy(NativeModules.Instabug, 'removeExperiments');
+  const clearAllExperiments = sinon.spy(NativeModules.Instabug, 'clearAllExperiments');
 
   beforeEach(() => {
     startWithToken.resetHistory();
@@ -699,4 +702,20 @@ describe('Instabug Module', () => {
 
   });
 
+  it('should call native addExperiments method', () => {
+    const experiments = ['exp1', 'exp2'];
+    Instabug.addExperiments(experiments);
+    expect(addExperiments.calledOnceWithExactly(experiments)).toBeTruthy();
+  });
+
+  it('should call native removeExperiments method', () => {
+    const experiments = ['exp1', 'exp2'];
+    Instabug.removeExperiments(experiments);
+    expect(removeExperiments.calledOnceWithExactly(experiments)).toBeTruthy();
+  });
+
+  it('should call native clearAllExperiments method', () => {
+    Instabug.clearAllExperiments();
+    expect(clearAllExperiments.calledOnce).toBeTruthy();
+  });
 });

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

@@ -2361,6 +2361,52 @@ private void sendEvent(ReactApplicationContext reactContext,
                 .emit(eventName, params);
     }
 
+    @ReactMethod
+    public void addExperiments(final ReadableArray experiments) {
+        MainThreadHandler.runOnMainThread(new Runnable() {
+            @Override
+            public void run() {
+                try {
+                    Object[] objectArray = ArrayUtil.toArray(experiments);
+                    String[] stringArray = Arrays.copyOf(objectArray, objectArray.length, String[].class);
+                    Instabug.addExperiments(Arrays.asList(stringArray));
+                } catch (Exception e) {
+                    e.printStackTrace();
+                }
+            }
+        });
+    }
+
+    @ReactMethod
+    public void removeExperiments(final ReadableArray experiments) {
+        MainThreadHandler.runOnMainThread(new Runnable() {
+            @Override
+            public void run() {
+                try {
+                    Object[] objectArray = ArrayUtil.toArray(experiments);
+                    String[] stringArray = Arrays.copyOf(objectArray, objectArray.length, String[].class);
+                    Instabug.removeExperiments(Arrays.asList(stringArray));
+                } catch (Exception e) {
+                    e.printStackTrace();
+                }
+            }
+        });
+    }
+
+    @ReactMethod
+    public void clearAllExperiments() {
+        MainThreadHandler.runOnMainThread(new Runnable() {
+            @Override
+            public void run() {
+                try {
+                    Instabug.clearAllExperiments();
+                } catch (Exception e) {
+                    e.printStackTrace();
+                }
+            }
+        });
+    }
+
     @Override
     public Map<String, Object> getConstants() {
         final Map<String, Object> constants = new HashMap<>();

android/src/test/java/com/instabug/reactlibrary/RNInstabugReactnativeModuleTest.java

@@ -33,8 +33,10 @@
 
 import java.lang.reflect.Field;
 import java.lang.reflect.Method;
+import java.sql.Array;
 import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Locale;
 import java.util.Map;
 import java.util.concurrent.Executors;
@@ -570,4 +572,51 @@ public void tearDown() {
 
     }
 
+    @Test
+    public void givenArg$addExperiments_whenQuery_thenShouldCallNativeApiWithArg() {
+        // given
+        JavaOnlyArray array = new JavaOnlyArray();
+        array.pushString("exp1");
+        array.pushString("exp2");
+
+        // when
+        rnModule.addExperiments(array);
+
+        // then
+        verify(Instabug.class,times(1));
+        List<String> expectedList = new ArrayList<String>();
+        expectedList.add("exp1");
+        expectedList.add("exp2");
+        Instabug.addExperiments(expectedList);
+    }
+
+    @Test
+    public void givenArg$removeExperiments_whenQuery_thenShouldCallNativeApiWithArg() {
+        // given
+        JavaOnlyArray array = new JavaOnlyArray();
+        array.pushString("exp1");
+        array.pushString("exp2");
+
+        // when
+        rnModule.removeExperiments(array);
+
+        // then
+        verify(Instabug.class,times(1));
+        List<String> expectedList = new ArrayList<String>();
+        expectedList.add("exp1");
+        expectedList.add("exp2");
+        Instabug.removeExperiments(expectedList);
+    }
+
+    @Test
+    public void given$clearAllExperiments_whenQuery_thenShouldCallNativeApi() {
+        // given
+
+        // when
+        rnModule.clearAllExperiments();
+
+        // then
+        verify(Instabug.class,times(1));
+        Instabug.clearAllExperiments();
+    }
 }

index.d.ts

@@ -1173,6 +1173,24 @@ export function onStateChange(
 export function reportScreenChange(
   screenName: string
 ): void;
+
+/**
+   * Add experiments to next report.
+   * @param {string[]} experiments An array of experiments to add to the next report.
+   */
+export function addExperiments(experiments:string[]): void;
+
+/**
+ * Remove experiments from next report.
+ * @param {string[]} experiments An array of experiments to remove from the next report.
+ */
+export function removeExperiments(experiments: string[]): void;
+
+/**
+ * Clear all experiments
+ */
+export function clearAllExperiments(): void;
+
 export function componentDidAppearListener(componentObj:
   { componentId: any, componentName: any, passProps: any }
 ): void;

index.js

@@ -835,6 +835,29 @@ const InstabugModule = {
     Instabug.reportScreenChange(screenName);
   },
 
+  /**
+   * Add experiments to next report.
+   * @param {string[]} experiments An array of experiments to add to the next report.
+   */
+  addExperiments(experiments) {
+    Instabug.addExperiments(experiments);
+  },
+
+  /**
+   * Remove experiments from next report.
+   * @param {string[]} experiments An array of experiments to remove from the next report.
+   */
+  removeExperiments(experiments) {
+    Instabug.removeExperiments(experiments);
+  },
+
+  /**
+   * Clear all experiments
+   */
+  clearAllExperiments() {
+    Instabug.clearAllExperiments();
+  },  
+
   componentDidAppearListener({ componentId, componentName, passProps }) {
     if (_isFirstScreen) {
       _lastScreen = componentName;

ios/RNInstabug/InstabugReactBridge.h

@@ -108,4 +108,14 @@
 
 - (void)setNetworkLoggingEnabled:(BOOL)isEnabled;
 
+/*
+ +------------------------------------------------------------------------+
+ |                              Experiments                               |
+ +------------------------------------------------------------------------+
+ */
+
+- (void)addExperiments:(NSArray *)experiments;
+- (void)removeExperiments:(NSArray *)experiments;
+- (void)clearAllExperiments;
+
 @end

ios/RNInstabug/InstabugReactBridge.m

@@ -434,6 +434,18 @@ - (dispatch_queue_t)methodQueue {
     }
 }
 
+RCT_EXPORT_METHOD(addExperiments:(NSArray *)experiments) {
+    [Instabug addExperiments:experiments];
+}
+
+RCT_EXPORT_METHOD(removeExperiments:(NSArray *)experiments) {
+    [Instabug removeExperiments:experiments];
+}
+
+RCT_EXPORT_METHOD(clearAllExperiments) {
+    [Instabug clearAllExperiments];
+}
+
 - (NSDictionary *)constantsToExport
 {
     return @{ @"invocationEventNone" : @(IBGInvocationEventNone),

jest/mockInstabug.js

@@ -49,6 +49,9 @@ jest.mock("react-native", () => {
     sendHandledJSCrash: jest.fn(),
     sendJSCrash: jest.fn(),
     reportScreenChange: jest.fn(),
+    addExperiments: jest.fn(),
+    removeExperiments: jest.fn(),
+    clearAllExperiments: jest.fn(),
   };
   RN.NativeModules.IBGBugReporting = {
     setFloatingButtonEdge: jest.fn(),