feat: add custom app rating api (#1186)

* map: custom app rating api

* chore: revert non-related committed files

* chore: apply lint fix

* fix: remove useless comments

* chore: rename willRedirectToAppStore to willRedirectToStore,
chore: add the changes to CHANGELOG.md

* chore: add the changes to CHANGELOG.md

* update: test function name to follow the new naming conversions,
update: function (willRedirectToStore)implementation to be able to support older versions

* Update CHANGELOG.md

Co-authored-by: Ahmed Mahmoud <[email protected]>

---------

Co-authored-by: Ahmed Mahmoud <[email protected]>

Author: AndrewAminInstabug

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [Unreleased](https://github.com/Instabug/Instabug-React-Native/compare/v12.9.0...dev)
+
+### Added
+
+- Add `Instabug.willRedirectToStore` API for use in custom app rating prompts ([#1186](https://github.com/Instabug/Instabug-React-Native/pull/1186)).
+
 ## [12.9.0](https://github.com/Instabug/Instabug-React-Native/compare/v12.8.0...dev)(April 2, 2024)
 
 ### Added

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

@@ -1056,6 +1056,20 @@ public void run() {
         });
     }
 
+    @ReactMethod
+    public void willRedirectToStore() {
+        MainThreadHandler.runOnMainThread(new Runnable() {
+            @Override
+            public void run() {
+                try {
+                    Instabug.willRedirectToStore();
+                } catch (Exception e) {
+                    e.printStackTrace();
+                }
+            }
+        });
+    }
+
     /**
      * Map between the exported JS constant and the arg key in {@link ArgsRegistry}.
      * The constant name and the arg key should match to be able to resolve the

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

@@ -576,4 +576,13 @@ public void testIdentifyUserWithId() {
         verify(Instabug.class,times(1));
         Instabug.clearAllExperiments();
     }
+
+    @Test
+    public void testWillRedirectToStore() {
+        // when
+        rnModule.willRedirectToStore();
+
+        // then
+        mockInstabug.verify(() -> Instabug.willRedirectToStore());
+    }
 }

examples/default/ios/InstabugTests/InstabugSampleTests.m

@@ -340,6 +340,19 @@ - (void)testShow {
 }
 
 
+- (void)testWillRedirectToStore {
+
+    id mock = OCMClassMock([Instabug class]);
+
+    [self.instabugBridge willRedirectToStore];
+
+    OCMVerify([mock willRedirectToAppStore]);
+
+    [mock stopMocking];
+}
+
+
+
 /*
  +------------------------------------------------------------------------+
  |                              Log Module                                |

ios/RNInstabug/InstabugReactBridge.h

@@ -82,6 +82,8 @@
 
 - (void)show;
 
+- (void) willRedirectToStore;
+
 
 /*
  +------------------------------------------------------------------------+

ios/RNInstabug/InstabugReactBridge.m

@@ -382,6 +382,10 @@ - (dispatch_queue_t)methodQueue {
     [Instabug clearAllExperiments];
 }
 
+RCT_EXPORT_METHOD(willRedirectToStore){
+    [Instabug willRedirectToAppStore];
+}
+
 - (NSDictionary *)constantsToExport {
     return ArgsRegistry.getAll;
 }

src/modules/Instabug.ts

@@ -559,6 +559,13 @@ export const clearAllExperiments = () => {
   NativeInstabug.clearAllExperiments();
 };
 
+/**
+ * This API has to be call when using custom app rating prompt
+ */
+export const willRedirectToStore = () => {
+  NativeInstabug.willRedirectToStore();
+};
+
 export const componentDidAppearListener = (event: ComponentDidAppearEvent) => {
   if (_isFirstScreen) {
     _lastScreen = event.componentName;

src/native/NativeInstabug.ts

@@ -105,6 +105,7 @@ export interface InstabugNativeModule extends NativeModule {
   logInfoToReport(log: string): void;
   addFileAttachmentWithURLToReport(url: string, filename?: string): void;
   addFileAttachmentWithDataToReport(data: string, filename?: string): void;
+  willRedirectToStore(): void;
 }
 
 export const NativeInstabug = NativeModules.Instabug;

test/mocks/mockInstabug.ts

@@ -64,6 +64,7 @@ const mockInstabug: InstabugNativeModule = {
   addFileAttachmentWithURLToReport: jest.fn(),
   addFileAttachmentWithDataToReport: jest.fn(),
   setNetworkLoggingEnabled: jest.fn(),
+  willRedirectToStore: jest.fn(),
 };
 
 export default mockInstabug;

test/modules/Instabug.spec.ts

@@ -769,4 +769,9 @@ describe('Instabug Module', () => {
     Instabug.clearAllExperiments();
     expect(NativeInstabug.clearAllExperiments).toBeCalledTimes(1);
   });
+
+  it('should call the native willRedirectToStore method', () => {
+    Instabug.willRedirectToStore();
+    expect(NativeInstabug.willRedirectToStore).toBeCalledTimes(1);
+  });
 });