chore: add unit test cases for instabug_navigator_observer

Author: AndrewAminInstabug

lib/src/utils/instabug_navigator_observer.dart

@@ -6,7 +6,6 @@ import 'package:instabug_flutter/src/utils/instabug_logger.dart';
 import 'package:instabug_flutter/src/utils/repro_steps_constants.dart';
 import 'package:instabug_flutter/src/utils/screen_loading/screen_loading_manager.dart';
 import 'package:instabug_flutter/src/utils/screen_name_masker.dart';
-import 'package:instabug_flutter/src/utils/screen_rendering/instabug_screen_render_manager.dart';
 
 class InstabugNavigatorObserver extends NavigatorObserver {
   final List<InstabugRoute> _steps = [];
@@ -25,15 +24,7 @@ class InstabugNavigatorObserver extends NavigatorObserver {
       );
 
       // Starts a the new UI trace which is exclusive to screen loading
-      ScreenLoadingManager.I
-          .startUiTrace(maskedScreenName, screenName)
-          .then((uiTraceId) {
-        if (uiTraceId != null &&
-            InstabugScreenRenderManager.I.screenRenderEnabled) {
-          InstabugScreenRenderManager.I
-              .startScreenRenderCollectorForTraceId(uiTraceId);
-        }
-      });
+      ScreenLoadingManager.I.startUiTrace(maskedScreenName, screenName);
 
       // If there is a step that hasn't been pushed yet
       if (_steps.isNotEmpty) {

lib/src/utils/screen_rendering/instabug_screen_render_manager.dart

@@ -269,24 +269,28 @@ class InstabugScreenRenderManager {
     }
 
     if (_isFrozen || _isSlow) {
-      debugPrint("{\n\t$frameTiming\n\t"
-          "Timestamps(${frameTiming.timestampInMicroseconds(
-        FramePhase.buildStart,
-      )}, ${frameTiming.timestampInMicroseconds(
-        FramePhase.buildFinish,
-      )}, ${frameTiming.timestampInMicroseconds(
-        FramePhase.rasterStart,
-      )}, ${frameTiming.timestampInMicroseconds(
-        FramePhase.rasterFinish,
-      )}, ${frameTiming.timestampInMicroseconds(
-        FramePhase.vsyncStart,
-      )}, ${frameTiming.timestampInMicroseconds(
-        FramePhase.rasterFinishWallTime,
-      )}"
-          ")\n}\n");
+      debugPrint(
+        "{\n\t$frameTiming\n\t"
+        "Timestamps(${frameTiming.timestampInMicroseconds(
+          FramePhase.buildStart,
+        )}, ${frameTiming.timestampInMicroseconds(
+          FramePhase.buildFinish,
+        )}, ${frameTiming.timestampInMicroseconds(
+          FramePhase.rasterStart,
+        )}, ${frameTiming.timestampInMicroseconds(
+          FramePhase.rasterFinish,
+        )}, ${frameTiming.timestampInMicroseconds(
+          FramePhase.vsyncStart,
+        )}, ${frameTiming.timestampInMicroseconds(
+          FramePhase.rasterFinishWallTime,
+        )}"
+        ")\n}\n",
+      );
       debugPrint("Device refresh rate: $_deviceRefreshRate FPS");
-      debugPrint("Threshold: $_slowFrameThresholdMs ms\n"
-          "===============================================================================");
+      debugPrint(
+        "Threshold: $_slowFrameThresholdMs ms\n"
+        "===============================================================================",
+      );
     }
   }
 

test/utils/instabug_navigator_observer_test.dart

@@ -5,18 +5,23 @@ import 'package:instabug_flutter/instabug_flutter.dart';
 import 'package:instabug_flutter/src/generated/instabug.api.g.dart';
 import 'package:instabug_flutter/src/utils/screen_loading/screen_loading_manager.dart';
 import 'package:instabug_flutter/src/utils/screen_name_masker.dart';
+import 'package:instabug_flutter/src/utils/screen_rendering/instabug_screen_render_manager.dart';
 import 'package:mockito/annotations.dart';
 import 'package:mockito/mockito.dart';
 
 import 'instabug_navigator_observer_test.mocks.dart';
 
-@GenerateMocks([InstabugHostApi])
-@GenerateNiceMocks([MockSpec<ScreenLoadingManager>()])
+@GenerateMocks([
+  InstabugHostApi,
+  ScreenLoadingManager,
+  InstabugScreenRenderManager,
+])
 void main() {
   TestWidgetsFlutterBinding.ensureInitialized();
 
   final mHost = MockInstabugHostApi();
   final mScreenLoadingManager = MockScreenLoadingManager();
+  final mScreenRenderManager = MockInstabugScreenRenderManager();
 
   late InstabugNavigatorObserver observer;
   const screen = '/screen';
@@ -35,6 +40,7 @@ void main() {
     previousRoute = createRoute(previousScreen);
 
     ScreenNameMasker.I.setMaskingCallback(null);
+    when(mScreenRenderManager.screenRenderEnabled).thenReturn(false);
   });
 
   test('should report screen change when a route is pushed', () {
@@ -57,6 +63,9 @@ void main() {
       'should report screen change when a route is popped and previous is known',
       () {
     fakeAsync((async) {
+      when(mScreenLoadingManager.startUiTrace(previousScreen, previousScreen))
+          .thenAnswer((realInvocation) async => null);
+
       observer.didPop(route, previousRoute);
 
       async.elapse(const Duration(milliseconds: 1000));
@@ -94,6 +103,9 @@ void main() {
       final route = createRoute('');
       const fallback = 'N/A';
 
+      when(mScreenLoadingManager.startUiTrace(fallback, fallback))
+          .thenAnswer((realInvocation) async => null);
+
       observer.didPush(route, previousRoute);
 
       async.elapse(const Duration(milliseconds: 1000));
@@ -111,6 +123,9 @@ void main() {
   test('should mask screen name when masking callback is set', () {
     const maskedScreen = 'maskedScreen';
 
+    when(mScreenLoadingManager.startUiTrace(maskedScreen, screen))
+        .thenAnswer((realInvocation) async => null);
+
     ScreenNameMasker.I.setMaskingCallback((_) => maskedScreen);
 
     fakeAsync((async) {
@@ -127,6 +142,62 @@ void main() {
       ).called(1);
     });
   });
+
+  test('should start new screen render collector when a route is pushed', () {
+    fakeAsync((async) async {
+      const traceID = 123;
+
+      when(mScreenLoadingManager.startUiTrace(screen, screen))
+          .thenAnswer((_) async => traceID);
+      when(mScreenRenderManager.screenRenderEnabled).thenReturn(true);
+
+      observer.didPush(route, previousRoute);
+
+      async.elapse(const Duration(milliseconds: 1000));
+
+      verify(
+        mScreenRenderManager.startScreenRenderCollectorForTraceId(traceID),
+      ).called(1);
+    });
+  });
+
+  test(
+      'should not start new screen render collector when a route is pushed and [traceID] is null',
+      () {
+    fakeAsync((async) async {
+      when(mScreenLoadingManager.startUiTrace(screen, screen))
+          .thenAnswer((_) async => null);
+
+      when(mScreenRenderManager.screenRenderEnabled).thenReturn(true);
+
+      observer.didPush(route, previousRoute);
+
+      async.elapse(const Duration(milliseconds: 1000));
+
+      verifyNever(
+        mScreenRenderManager.startScreenRenderCollectorForTraceId(any),
+      );
+    });
+  });
+
+  test(
+      'should not start new screen render collector when a route is pushed and [mScreenRenderManager.screenRenderEnabled] is false',
+      () {
+    fakeAsync((async) async {
+      when(mScreenLoadingManager.startUiTrace(screen, screen))
+          .thenAnswer((_) async => 123);
+
+      when(mScreenRenderManager.screenRenderEnabled).thenReturn(false);
+
+      observer.didPush(route, previousRoute);
+
+      async.elapse(const Duration(milliseconds: 1000));
+
+      verifyNever(
+        mScreenRenderManager.startScreenRenderCollectorForTraceId(any),
+      );
+    });
+  });
 }
 
 Route createRoute(String? name) {