[INSD-8643] Add reportError and deprecate reportJSException (#852)

* Check reportJSException error type internally

Enforcing a strong type for this API would require code changes from the
users as the catch block parameter is of type any/unknown, so we handle
the type internally.

* Deprecate reportJSException and add reportError

* Update CHANGELOG.md

* Use reportError in tests

* Use `reportError` API in example app

Author: DavidMina96

CHANGELOG.md

@@ -1,5 +1,6 @@
 ## Unreleased
 
+- Deprecates CrashReporting.reportJSException in favour of a new strongly typed API: CrashReporting.reportError
 - Fixes Survey interface export causing a build error with certain babel versions
 
 ## 11.5.0 (2022-11-28)

example/src/screens/HomeScreen.js

@@ -27,8 +27,10 @@ export function HomeScreen() {
     try {
       throw new Error('Handled Exception From Instabug Test App');
     } catch (err) {
-      CrashReporting.reportJSException(err);
-      Alert.alert('Crash report Sent!');
+      if (err instanceof Error) {
+        CrashReporting.reportError(err);
+        Alert.alert('Crash report Sent!');
+      }
     }
   };
 

src/modules/CrashReporting.ts

@@ -16,10 +16,21 @@ export const setEnabled = (isEnabled: boolean) => {
 };
 
 /**
+ * @deprecated Use {@link reportError} instead.
  * Send handled JS error object
  * @param error Error object to be sent to Instabug's servers
  */
-export const reportJSException = (error: ExtendedError) => {
+export const reportJSException = (error: any) => {
+  if (error instanceof Error) {
+    reportError(error);
+  }
+};
+
+/**
+ * Send handled JS error object
+ * @param error Error object to be sent to Instabug's servers
+ */
+export const reportError = (error: ExtendedError) => {
   const jsStackTrace = InstabugUtils.getStackTrace(error);
 
   const jsonObject = {

tests/modules/CrashReporting.spec.js

@@ -20,7 +20,7 @@ describe('CrashReporting Module', () => {
   it('should call the native method sendHandledJSCrash when platform is ios', () => {
     Platform.OS = 'ios';
     const errorObject = { name: 'TypeError', message: 'Invalid type' };
-    CrashReporting.reportJSException(errorObject);
+    CrashReporting.reportError(errorObject);
 
     const expectedObject = {
       message: 'TypeError - Invalid type',
@@ -38,7 +38,7 @@ describe('CrashReporting Module', () => {
   it('should call the native method sendHandledJSCrash when platform is android', () => {
     Platform.OS = 'android';
     const errorObject = { name: 'TypeError', message: 'Invalid type' };
-    CrashReporting.reportJSException(errorObject);
+    CrashReporting.reportError(errorObject);
 
     const expectedObject = {
       message: 'TypeError - Invalid type',
@@ -75,7 +75,7 @@ describe('CrashReporting Module', () => {
       crashHandler,
     );
 
-    CrashReporting.reportJSException(errorObject);
+    CrashReporting.reportError(errorObject);
     expect(crashHandler).toBeCalledTimes(1);
     expect(crashHandler).toBeCalledWith(expectedObject);
   });