refactor: extract shared crash reporting logic (#1010)

Jira ID: MOB-12538

- refactor: extract duplicate crash reporting code
- chore: Resolve utils lint issues
- test: add sendCrashReport tests in utils
- test: refactor tests validating sendCrashReport
- chore: exclude local history from .gitignore
- test: refactor errorMock to use TypeError

Author: Abd ElHamid Nasser

.gitignore

@@ -60,3 +60,7 @@ android/keystores/debug.keystore
 
 # Bundle artifact
 *.jsbundle
+/examples/default/ios/main.jsbundle.map
+
+# Vscode local history
+.history/

src/modules/CrashReporting.ts

@@ -1,7 +1,5 @@
-import { Platform } from 'react-native';
 import type { ExtendedError } from 'react-native/Libraries/Core/Devtools/parseErrorStack';
 
-import type { CrashData } from '../native/NativeCrashReporting';
 import { NativeCrashReporting } from '../native/NativeCrashReporting';
 import InstabugUtils from '../utils/InstabugUtils';
 
@@ -30,20 +28,5 @@ export const reportJSException = (error: any) => {
  * @param error Error object to be sent to Instabug's servers
  */
 export const reportError = (error: ExtendedError) => {
-  const jsStackTrace = InstabugUtils.getStackTrace(error);
-
-  const jsonObject: CrashData = {
-    message: error.name + ' - ' + error.message,
-    e_message: error.message,
-    e_name: error.name,
-    os: Platform.OS,
-    platform: 'react_native',
-    exception: jsStackTrace,
-  };
-
-  if (Platform.OS === 'android') {
-    NativeCrashReporting.sendHandledJSCrash(JSON.stringify(jsonObject));
-  } else {
-    NativeCrashReporting.sendHandledJSCrash(jsonObject);
-  }
+  InstabugUtils.sendCrashReport(error, NativeCrashReporting.sendHandledJSCrash);
 };

src/utils/InstabugUtils.ts

@@ -68,23 +68,7 @@ export const captureJsErrors = () => {
   const originalErrorHandler = ErrorUtils.getGlobalHandler();
 
   const instabugErrorHandler: ErrorHandlerCallback = (err) => {
-    const jsStackTrace = getStackTrace(err);
-
-    // JSON object to be sent to the native SDK
-    const jsonObject: CrashData = {
-      message: err.name + ' - ' + err.message,
-      e_message: err.message,
-      e_name: err.name,
-      os: Platform.OS,
-      platform: 'react_native',
-      exception: jsStackTrace,
-    };
-
-    if (Platform.OS === 'android') {
-      NativeCrashReporting.sendJSCrash(JSON.stringify(jsonObject));
-    } else {
-      NativeCrashReporting.sendJSCrash(jsonObject);
-    }
+    sendCrashReport(err, NativeCrashReporting.sendJSCrash);
   };
 
   ErrorUtils.setGlobalHandler((err, isFatal) => {
@@ -124,6 +108,40 @@ export const invokeDeprecatedCallback = <T>(callback?: (arg: T) => void, arg?: T
   }
 };
 
+/**
+ * Sends crash report to Instabug's servers based on @param sendFunction
+ *
+ * @param error Error object to be sent to Instabug's servers
+ * @param remoteSenderCallback Function to send the crash report to Instabug's servers
+ *
+ * @example
+ * `sendCrashReport(error, NativeCrashReporting.sendHandledJSCrash);`
+ * or
+ * `sendCrashReport(error, NativeCrashReporting.sendJSCrash);`
+ *
+ */
+export function sendCrashReport(
+  error: ExtendedError,
+  remoteSenderCallback: (json: CrashData | string) => void,
+) {
+  const jsStackTrace = getStackTrace(error);
+
+  const jsonObject: CrashData = {
+    message: error.name + ' - ' + error.message,
+    e_message: error.message,
+    e_name: error.name,
+    os: Platform.OS,
+    platform: 'react_native',
+    exception: jsStackTrace,
+  };
+
+  if (Platform.OS === 'android') {
+    remoteSenderCallback(JSON.stringify(jsonObject));
+  } else {
+    remoteSenderCallback(jsonObject);
+  }
+}
+
 export default {
   parseErrorStack,
   captureJsErrors,
@@ -132,4 +150,5 @@ export default {
   getStackTrace,
   stringifyIfNotString,
   invokeDeprecatedCallback,
+  sendCrashReport,
 };

test/mocks/mockInstabugUtils.ts

@@ -7,6 +7,7 @@ jest.mock('../../src/utils/InstabugUtils', () => {
     captureJsErrors: jest.fn(),
     getActiveRouteName: jest.fn(),
     stringifyIfNotString: jest.fn(),
+    sendCrashReport: jest.fn(),
     getStackTrace: jest.fn().mockReturnValue('javascriptStackTrace'),
     getFullRoute: jest.fn().mockImplementation(() => 'ScreenName'),
   };

test/modules/CrashReporting.spec.ts

@@ -1,9 +1,8 @@
 import '../mocks/mockInstabugUtils';
 
-import { Platform } from 'react-native';
-
 import * as CrashReporting from '../../src/modules/CrashReporting';
 import { NativeCrashReporting } from '../../src/native/NativeCrashReporting';
+import InstabugUtils from '../../src/utils/InstabugUtils';
 
 describe('CrashReporting Module', () => {
   it('should call the native method setEnabled', () => {
@@ -13,39 +12,14 @@ describe('CrashReporting Module', () => {
     expect(NativeCrashReporting.setEnabled).toBeCalledWith(true);
   });
 
-  it('should call the native method sendHandledJSCrash with JSON object when platform is iOS', () => {
-    Platform.OS = 'ios';
-    const error = { name: 'TypeError', message: 'Invalid type' };
+  it('should call the native method sendCrashReporting with JSON object and sendHandledJsCrash as a callback', () => {
+    const error = new TypeError('Invalid type');
     CrashReporting.reportError(error);
 
-    const expected = {
-      message: 'TypeError - Invalid type',
-      e_message: 'Invalid type',
-      e_name: 'TypeError',
-      os: 'ios',
-      platform: 'react_native',
-      exception: 'javascriptStackTrace',
-    };
-
-    expect(NativeCrashReporting.sendHandledJSCrash).toBeCalledTimes(1);
-    expect(NativeCrashReporting.sendHandledJSCrash).toBeCalledWith(expected);
-  });
-
-  it('should call the native method sendHandledJSCrash with stringified JSON object when platform is Android', () => {
-    Platform.OS = 'android';
-    const error = { name: 'TypeError', message: 'Invalid type' };
-    CrashReporting.reportError(error);
-
-    const expected = JSON.stringify({
-      message: 'TypeError - Invalid type',
-      e_message: 'Invalid type',
-      e_name: 'TypeError',
-      os: 'android',
-      platform: 'react_native',
-      exception: 'javascriptStackTrace',
-    });
-
-    expect(NativeCrashReporting.sendHandledJSCrash).toBeCalledTimes(1);
-    expect(NativeCrashReporting.sendHandledJSCrash).toBeCalledWith(expected);
+    expect(InstabugUtils.sendCrashReport).toBeCalledTimes(1);
+    expect(InstabugUtils.sendCrashReport).toBeCalledWith(
+      error,
+      NativeCrashReporting.sendHandledJSCrash,
+    );
   });
 });

test/utils/InstabugUtils.spec.ts

@@ -7,7 +7,7 @@ import parseErrorStackLib from 'react-native/Libraries/Core/Devtools/parseErrorS
 import * as Instabug from '../../src/modules/Instabug';
 import { NativeCrashReporting } from '../../src/native/NativeCrashReporting';
 import { InvocationEvent } from '../../src/utils/Enums';
-import InstabugUtils from '../../src/utils/InstabugUtils';
+import InstabugUtils, { getStackTrace, sendCrashReport } from '../../src/utils/InstabugUtils';
 
 describe('Test global error handler', () => {
   beforeEach(() => {
@@ -220,4 +220,45 @@ describe('Instabug Utils', () => {
     mockDev.mockRestore();
     consoleWarnSpy.mockRestore();
   });
+
+  it('should call remoteSenderCallback with the correct JSON object on Android', () => {
+    const remoteSenderCallback = NativeCrashReporting.sendHandledJSCrash;
+    Platform.OS = 'android';
+    const errorMock = new TypeError('Invalid type');
+    const jsStackTrace = getStackTrace(errorMock);
+
+    sendCrashReport(errorMock, remoteSenderCallback);
+
+    const expectedMap = {
+      message: 'TypeError - Invalid type',
+      e_message: 'Invalid type',
+      e_name: 'TypeError',
+      os: 'android',
+      platform: 'react_native',
+      exception: jsStackTrace,
+    };
+    const expectedJsonObject = JSON.stringify(expectedMap);
+    expect(remoteSenderCallback).toHaveBeenCalledTimes(1);
+    expect(remoteSenderCallback).toHaveBeenCalledWith(expectedJsonObject);
+  });
+
+  it('should call remoteSenderCallback with the correct JSON object on iOS', () => {
+    const remoteSenderCallback = NativeCrashReporting.sendHandledJSCrash;
+    Platform.OS = 'ios';
+    const errorMock = new TypeError('Invalid type');
+    const jsStackTrace = getStackTrace(errorMock);
+
+    sendCrashReport(errorMock, remoteSenderCallback);
+
+    const expectedMap = {
+      message: 'TypeError - Invalid type',
+      e_message: 'Invalid type',
+      e_name: 'TypeError',
+      os: 'ios',
+      platform: 'react_native',
+      exception: jsStackTrace,
+    };
+    expect(remoteSenderCallback).toHaveBeenCalledTimes(1);
+    expect(remoteSenderCallback).toHaveBeenCalledWith(expectedMap);
+  });
 });