chore: enhance expo router tracking support (#1272)

Author: kholood-ea

CHANGELOG.md

@@ -2,9 +2,9 @@
 
 ## [Unreleased](https://github.com/Instabug/Instabug-React-Native/compare/v13.3.0...dev)
 
-### Fixed
+### Added
 
-- Fix Omitted non-error objects when logging errors to ensure only error objects are supported.([#1279](https://github.com/Instabug/Instabug-React-Native/pull/1279)).
+- Add support for Expo Router navigation tracking ([#1270](https://github.com/Instabug/Instabug-React-Native/pull/1270)).
 
 ## [13.3.0](https://github.com/Instabug/Instabug-React-Native/compare/v13.2.0...v13.3.0) (August 4, 2024)
 

examples/default/src/App.tsx

@@ -35,7 +35,9 @@ export const App: React.FC = () => {
   }, []);
 
   useEffect(() => {
-    Instabug.setNavigationListener(navigationRef);
+    const unregisterListener = Instabug.setNavigationListener(navigationRef);
+
+    return unregisterListener;
   }, [navigationRef]);
 
   return (

src/modules/Instabug.ts

@@ -544,7 +544,7 @@ export const onStateChange = (state?: NavigationStateV5) => {
 export const setNavigationListener = (
   navigationRef: NavigationContainerRefWithCurrent<ReactNavigation.RootParamList>,
 ) => {
-  navigationRef.addListener('state', () => {
+  return navigationRef.addListener('state', () => {
     onStateChange(navigationRef.getRootState());
   });
 };

test/modules/Instabug.spec.ts

@@ -238,20 +238,39 @@ describe('Instabug Module', () => {
   });
 
   it('setNavigationListener should call the onStateChange on a screen change', async () => {
+    const mockedState = { routes: [{ name: 'ScreenName' }], index: 0 };
+
     const mockNavigationContainerRef = {
       current: null,
       navigate: jest.fn(),
       reset: jest.fn(),
       goBack: jest.fn(),
       dispatch: jest.fn(),
-      getRootState: jest.fn(),
+      getRootState: () => mockedState,
       canGoBack: jest.fn(),
-      addListener: jest.fn(),
+
+      addListener: jest.fn((event, callback) => {
+        expect(event).toBe('state');
+        callback(mockedState);
+        return jest.fn();
+      }),
       removeListener: jest.fn(),
     } as unknown as NavigationContainerRefWithCurrent<ReactNavigation.RootParamList>;
 
+    const onStateChangeMock = jest.fn();
+
+    jest.spyOn(Instabug, 'onStateChange').mockImplementation(onStateChangeMock);
+
     Instabug.setNavigationListener(mockNavigationContainerRef);
+
     expect(mockNavigationContainerRef.addListener).toBeCalledTimes(1);
+    expect(mockNavigationContainerRef.addListener).toHaveBeenCalledWith(
+      'state',
+      expect.any(Function),
+    );
+
+    expect(onStateChangeMock).toBeCalledTimes(1);
+    expect(onStateChangeMock).toHaveBeenCalledWith(mockNavigationContainerRef.getRootState());
   });
 
   it('should call the native method init', () => {