feat: add setNDKCrashesEnabled API (#1132)

ahmedAlaaInstabug · abdelhamid-f-nasser · a7medev · web-flow · commit 3fae0beaad29 · 2024-02-19T14:28:32.000+02:00
* feat_add_setNDKCrashesEnabled * fix android_testing issue * rename_test_cases * fix_pr_comments * feat/add-ndk-demo-crash-buttons * chore: add ChangeLog changes * Update CHANGELOG.md Co-authored-by: Abdelhamid Nasser <38096011+abdelhamid-f-nasser@users.noreply.github.com> * feat: add more crash scenarios to example app (#1131) * feat(example): add nested complex views (#1111) Jira ID: MOB-13737 * fix hybrid mode code push version init (#1108) * chore(android): ignore jetbrains ide run configurations (#1110) Jira ID: MOB-13736 * ci: migrate macos machines to m1 (#1114) * feat: support identify user by id (#1115) Jira ID: MOB-13746 * ci: replace d11 cluster url in UploadSourcemaps (#1122) * fix(android): resolve private views through UI manager directly (#1121) * feat: support switching to native network interception (#1120) * feat(example): Add more sdk crashes buttons * chore(android): ignore jetbrains ide run configurations (#1110) Jira ID: MOB-13736 * feat(example): Add more sdk crashes buttons * fix dev merge issue * feat_add_crash_buttons * feat_add_crash_buttons * feat_add_crash_buttons * fix: PlatformListTile typo name --------- Co-authored-by: Abdelhamid Nasser <38096011+abdelhamid-f-nasser@users.noreply.github.com> Co-authored-by: Ahmed Mahmoud <68241710+a7medev@users.noreply.github.com> Co-authored-by: AbdElHamid Nasser <anasser@instabug.com> * feat_add_setNDKCrashesEnabled * fix android_testing issue * rename_test_cases * fix_pr_comments * feat/add-ndk-demo-crash-buttons * chore: add ChangeLog changes * Update CHANGELOG.md Co-authored-by: Abdelhamid Nasser <38096011+abdelhamid-f-nasser@users.noreply.github.com> * fix:lint issue * fix: CHANGELOG typo issue Co-authored-by: Abdelhamid Nasser <38096011+abdelhamid-f-nasser@users.noreply.github.com> --------- Co-authored-by: Abdelhamid Nasser <38096011+abdelhamid-f-nasser@users.noreply.github.com> Co-authored-by: Ahmed Mahmoud <68241710+a7medev@users.noreply.github.com> Co-authored-by: AbdElHamid Nasser <anasser@instabug.com>
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## [Unreleased](https://github.com/Instabug/Instabug-React-Native/compare/v12.7.1...dev)
+
+### Added
+
+- Support enabling NDK crash capturing on Android ([#1132](https://github.com/Instabug/Instabug-React-Native/pull/1132)).
+
 ## [12.7.1](https://github.com/Instabug/Instabug-React-Native/compare/v12.7.0...v12.7.1) (February 15, 2024)
 
 ### Changed
diff --git a/android/src/main/java/com/instabug/reactlibrary/RNInstabugCrashReportingModule.java b/android/src/main/java/com/instabug/reactlibrary/RNInstabugCrashReportingModule.java
@@ -113,6 +113,28 @@ public void run() {
                  }
              }
          });
+     }
 
+    /**
+     * Enables and disables capturing native C++ NDK crash reporting.
+     *
+     * @param isEnabled boolean indicating enabled or disabled.
+     */
+    @ReactMethod
+    public void setNDKCrashesEnabled(final boolean isEnabled) {
+        MainThreadHandler.runOnMainThread(new Runnable() {
+            @Override
+            public void run() {
+                try {
+                    if (isEnabled) {
+                        CrashReporting.setNDKCrashesState(Feature.State.ENABLED);
+                    } else {
+                        CrashReporting.setNDKCrashesState(Feature.State.DISABLED);
+                    }
+                } catch (Exception e) {
+                    e.printStackTrace();
+                }
+            }
+        });
     }
 }
diff --git a/android/src/test/java/com/instabug/reactlibrary/RNInstabugCrashReportingModuleTest.java b/android/src/test/java/com/instabug/reactlibrary/RNInstabugCrashReportingModuleTest.java
@@ -1,9 +1,85 @@
 package com.instabug.reactlibrary;
 
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.mockStatic;
+
+import android.os.Looper;
+
+import com.instabug.crash.CrashReporting;
+import com.instabug.library.Feature;
+import com.instabug.reactlibrary.util.GlobalMocks;
+import com.instabug.reactlibrary.utils.MainThreadHandler;
+
+import org.junit.After;
+import org.junit.Before;
 import org.junit.Test;
+import org.mockito.MockedStatic;
+import org.mockito.Mockito;
+import org.mockito.invocation.InvocationOnMock;
+import org.mockito.stubbing.Answer;
 
 
 public class RNInstabugCrashReportingModuleTest {
+    private final RNInstabugCrashReportingModule rnModule = new RNInstabugCrashReportingModule(null);
+
+    // Mock Objects
+    private MockedStatic<Looper> mockLooper;
+    private MockedStatic<MainThreadHandler> mockMainThreadHandler;
+    private MockedStatic<CrashReporting> mockCrashReporting;
+
+
+    @Before
+    public void mockMainThreadHandler() throws Exception {
+        // Mock static functions
+        mockLooper = mockStatic(Looper.class);
+        mockMainThreadHandler = mockStatic(MainThreadHandler.class);
+        mockCrashReporting = mockStatic(CrashReporting.class);
+        // Mock Looper class
+        Looper mockMainThreadLooper = mock(Looper.class);
+        Mockito.when(Looper.getMainLooper()).thenReturn(mockMainThreadLooper);
+
+
+        // Override runOnMainThread
+        Answer<Boolean> handlerPostAnswer = new Answer<Boolean>() {
+            @Override
+            public Boolean answer(InvocationOnMock invocation) throws Throwable {
+                invocation.getArgument(0, Runnable.class).run();
+                return true;
+            }
+        };
+        Mockito.doAnswer(handlerPostAnswer).when(MainThreadHandler.class);
+        MainThreadHandler.runOnMainThread(any(Runnable.class));
+    }
+
+    @After
+    public void tearDown() {
+        // Remove static mocks
+        mockLooper.close();
+        mockMainThreadHandler.close();
+        mockCrashReporting.close();
+    }
+
+    /********Crashes*********/
+
+    @Test
+    public void testSetNDKCrashesEnabledGivenTrue() {
+        // when
+        rnModule.setNDKCrashesEnabled(true);
+
+//then
+        mockCrashReporting.verify(() -> CrashReporting.setNDKCrashesState(Feature.State.ENABLED));
+    }
+
+    @Test
+    public void testSetNDKCrashesEnabledGivenFalse() {
+        // when
+        rnModule.setNDKCrashesEnabled(false);
+
+        //then
+        mockCrashReporting.verify(() -> CrashReporting.setNDKCrashesState(Feature.State.DISABLED));
+    }
+
     @Test
     public void givenString$sendHandledJSCrash_whenQuery_thenShouldCallNativeApiWithArgs() throws Exception {
 //        JSONObject json = mock(JSONObject.class);
diff --git a/android/src/test/java/com/instabug/reactlibrary/RNInstabugRepliesModuleTest.java b/android/src/test/java/com/instabug/reactlibrary/RNInstabugRepliesModuleTest.java
@@ -10,6 +10,7 @@
 import com.facebook.react.bridge.WritableMap;
 import com.instabug.chat.Replies;
 import com.instabug.library.Feature;
+import com.instabug.reactlibrary.utils.InstabugUtil;
 import com.instabug.reactlibrary.utils.MapUtil;
 import com.instabug.reactlibrary.utils.MainThreadHandler;
 
@@ -42,13 +43,15 @@ public class RNInstabugRepliesModuleTest {
     private MockedStatic<Looper> mockLooper;
     private MockedStatic <MainThreadHandler> mockMainThreadHandler;
     private MockedStatic <Replies> mockReplies;
+    private MockedStatic <InstabugUtil> mockInstabugUtil;
 
     @Before
     public void mockMainThreadHandler() throws Exception {
         // Mock static functions
         mockReplies = mockStatic(Replies.class);
         mockLooper = mockStatic(Looper.class);
         mockMainThreadHandler = mockStatic(MainThreadHandler.class);
+        mockInstabugUtil = mockStatic(InstabugUtil.class);
 
         // Mock Looper class
         Looper mockMainThreadLooper = mock(Looper.class);
@@ -71,6 +74,7 @@ public void tearDown() {
         mockLooper.close();
         mockMainThreadHandler.close();
         mockReplies.close();
+        mockInstabugUtil.close();
     }
 
     /********Replies*********/
diff --git a/src/modules/CrashReporting.ts b/src/modules/CrashReporting.ts
@@ -2,6 +2,7 @@ import type { ExtendedError } from 'react-native/Libraries/Core/Devtools/parseEr
 
 import { NativeCrashReporting } from '../native/NativeCrashReporting';
 import InstabugUtils from '../utils/InstabugUtils';
+import { Platform } from 'react-native';
 
 /**
  * Enables and disables everything related to crash reporting including intercepting
@@ -19,3 +20,13 @@ export const setEnabled = (isEnabled: boolean) => {
 export const reportError = (error: ExtendedError) => {
   return InstabugUtils.sendCrashReport(error, NativeCrashReporting.sendHandledJSCrash);
 };
+
+/**
+ * Enables and disables capturing native C++ NDK crashes.
+ * @param isEnabled
+ */
+export const setNDKCrashesEnabled = (isEnabled: boolean) => {
+  if (Platform.OS === 'android') {
+    NativeCrashReporting.setNDKCrashesEnabled(isEnabled);
+  }
+};
diff --git a/src/native/NativeCrashReporting.ts b/src/native/NativeCrashReporting.ts
@@ -16,6 +16,7 @@ export interface CrashReportingNativeModule extends NativeModule {
   setEnabled(isEnabled: boolean): void;
   sendJSCrash(data: CrashData | string): Promise<void>;
   sendHandledJSCrash(data: CrashData | string): Promise<void>;
+  setNDKCrashesEnabled(isEnabled: boolean): Promise<void>;
 }
 
 export const NativeCrashReporting = NativeModules.IBGCrashReporting;
diff --git a/test/mocks/mockCrashReporting.ts b/test/mocks/mockCrashReporting.ts
@@ -6,6 +6,7 @@ const mockCrashReporting: CrashReportingNativeModule = {
   setEnabled: jest.fn(),
   sendHandledJSCrash: jest.fn(),
   sendJSCrash: jest.fn(),
+  setNDKCrashesEnabled: jest.fn(),
 };
 
 export default mockCrashReporting;
diff --git a/test/modules/CrashReporting.spec.ts b/test/modules/CrashReporting.spec.ts
@@ -3,6 +3,7 @@ import '../mocks/mockInstabugUtils';
 import * as CrashReporting from '../../src/modules/CrashReporting';
 import { NativeCrashReporting } from '../../src/native/NativeCrashReporting';
 import InstabugUtils from '../../src/utils/InstabugUtils';
+import { Platform } from 'react-native';
 
 describe('CrashReporting Module', () => {
   it('should call the native method setEnabled', () => {
@@ -22,4 +23,19 @@ describe('CrashReporting Module', () => {
       NativeCrashReporting.sendHandledJSCrash,
     );
   });
+
+  it('should call the native method setNDKCrashesEnabled for Android platform', () => {
+    Platform.OS = 'android';
+    CrashReporting.setNDKCrashesEnabled(true);
+
+    expect(NativeCrashReporting.setNDKCrashesEnabled).toBeCalledTimes(1);
+    expect(NativeCrashReporting.setNDKCrashesEnabled).toBeCalledWith(true);
+  });
+
+  it('should not call the native method setNDKCrashesEnabled for ios platform', () => {
+    Platform.OS = 'ios';
+    CrashReporting.setNDKCrashesEnabled(true);
+
+    expect(NativeCrashReporting.setNDKCrashesEnabled).not.toBeCalled();
+  });
 });

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@ export interface CrashReportingNativeModule extends NativeModule {`
`16`	`16`	`setEnabled(isEnabled: boolean): void;`
`17`	`17`	`sendJSCrash(data: CrashData \| string): Promise<void>;`
`18`	`18`	`sendHandledJSCrash(data: CrashData \| string): Promise<void>;`
	`19`	`+ setNDKCrashesEnabled(isEnabled: boolean): Promise<void>;`
`19`	`20`	`}`
`20`	`21`
`21`	`22`	`export const NativeCrashReporting = NativeModules.IBGCrashReporting;`