Merge pull request #610 from Instabug/feat/screen-render-testing

chore: update capture screen rendering logic

Author: AndrewAminInstabug

android/build.gradle

@@ -52,7 +52,7 @@ android {
 }
 
 dependencies {
-    api 'com.instabug.library:instabug:15.0.0.6969715-SNAPSHOT'
+    api 'com.instabug.library:instabug:15.0.2.7020723-SNAPSHOT'
     testImplementation 'junit:junit:4.13.2'
     testImplementation "org.mockito:mockito-inline:3.12.1"
     testImplementation "io.mockk:mockk:1.13.13"

example/pubspec.lock

@@ -107,7 +107,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "14.3.0"
+    version: "15.0.2"
   instabug_http_client:
     dependency: "direct main"
     description:

lib/src/utils/screen_loading/screen_loading_manager.dart

@@ -148,10 +148,6 @@ class ScreenLoadingManager {
     try {
       resetDidStartScreenLoading();
 
-      final isSDKBuilt =
-          await _checkInstabugSDKBuilt("APM.InstabugCaptureScreenLoading");
-      if (!isSDKBuilt) return null;
-
       // TODO: On Android, FlagsConfig.apm.isEnabled isn't implemented correctly
       // so we skip the isApmEnabled check on Android and only check on iOS.
       // This is a temporary fix until we implement the isEnabled check correctly.

lib/src/utils/screen_rendering/instabug_screen_render_manager.dart

@@ -26,9 +26,10 @@ class InstabugScreenRenderManager {
   late InstabugScreenRenderData _screenRenderForCustomUiTrace;
   int _slowFramesTotalDurationMs = 0;
   int _frozenFramesTotalDurationMs = 0;
+  int? _epochOffset;
   bool _isTimingsListenerAttached = false;
   bool screenRenderEnabled = false;
-  int? _epochOffset;
+  bool _isWidgetBindingObserverAdded = false;
 
   final List<InstabugFrameData> _delayedFrames = [];
 
@@ -139,9 +140,8 @@ class InstabugScreenRenderManager {
 
       //Sync the captured screen render data of the Custom UI trace when starting new one
       if (type == UiTraceType.custom) {
-        // Report only if the collector was active and has captured data
-        if (_screenRenderForCustomUiTrace.isActive &&
-            _screenRenderForCustomUiTrace.isNotEmpty) {
+        // Report only if the collector was active
+        if (_screenRenderForCustomUiTrace.isActive) {
           _reportScreenRenderForCustomUiTrace(_screenRenderForCustomUiTrace);
           _screenRenderForCustomUiTrace.clear();
         }
@@ -150,9 +150,8 @@ class InstabugScreenRenderManager {
 
       //Sync the captured screen render data of the Auto UI trace when starting new one
       if (type == UiTraceType.auto) {
-        // Report only if the collector was active and has captured data
-        if (_screenRenderForAutoUiTrace.isActive &&
-            _screenRenderForAutoUiTrace.isNotEmpty) {
+        // Report only if the collector was active
+        if (_screenRenderForAutoUiTrace.isActive) {
           _reportScreenRenderForAutoUiTrace(_screenRenderForAutoUiTrace);
           _screenRenderForAutoUiTrace.clear();
         }
@@ -172,14 +171,12 @@ class InstabugScreenRenderManager {
       }
 
       // Sync Screen Render data for custom ui trace if exists
-      if (_screenRenderForCustomUiTrace.isActive &&
-          _screenRenderForCustomUiTrace.isNotEmpty) {
+      if (_screenRenderForCustomUiTrace.isActive) {
         _reportScreenRenderForCustomUiTrace(_screenRenderForCustomUiTrace);
       }
 
       // Sync Screen Render data for auto ui trace if exists
-      if (_screenRenderForAutoUiTrace.isActive &&
-          _screenRenderForAutoUiTrace.isNotEmpty) {
+      if (_screenRenderForAutoUiTrace.isActive) {
         _reportScreenRenderForAutoUiTrace(_screenRenderForAutoUiTrace);
       }
     } catch (error, stackTrace) {
@@ -211,6 +208,7 @@ class InstabugScreenRenderManager {
   void dispose() {
     _resetCachedFrameData();
     _removeFrameTimings();
+    _removeWidgetBindingObserver();
     _widgetsBinding = null;
     screenRenderEnabled = false;
   }
@@ -244,8 +242,26 @@ class InstabugScreenRenderManager {
       APM.getDeviceRefreshRate();
 
   /// add new [WidgetsBindingObserver] to track app lifecycle.
-  void _addWidgetBindingObserver() =>
-      _widgetsBinding?.addObserver(InstabugWidgetsBindingObserver.instance);
+  void _addWidgetBindingObserver() {
+    if (_widgetsBinding == null) {
+      return;
+    }
+    if (!_isWidgetBindingObserverAdded) {
+      _widgetsBinding!.addObserver(InstabugWidgetsBindingObserver.instance);
+      _isWidgetBindingObserverAdded = true;
+    }
+  }
+
+  /// remove [WidgetsBindingObserver] from [WidgetsBinding]
+  void _removeWidgetBindingObserver() {
+    if (_widgetsBinding == null) {
+      return;
+    }
+    if (_isWidgetBindingObserverAdded) {
+      _widgetsBinding!.removeObserver(InstabugWidgetsBindingObserver.instance);
+      _isWidgetBindingObserverAdded = false;
+    }
+  }
 
   /// Initialize the static variables
   Future<void> _initStaticValues() async {

lib/src/utils/screen_rendering/instabug_widget_binding_observer.dart

@@ -20,12 +20,9 @@ class InstabugWidgetsBindingObserver extends WidgetsBindingObserver {
   static const tag = "InstabugWidgetsBindingObserver";
 
   static void dispose() {
-    if (InstabugScreenRenderManager.I.screenRenderEnabled) {
-      InstabugScreenRenderManager.I.dispose();
-    }
-    // For Flutter 2.10.5 version
-    // ignore: invalid_null_aware_operator
-    WidgetsBinding.instance?.removeObserver(_instance);
+    // Always call dispose to ensure proper cleanup with tracking flags
+    // The dispose method is safe to call multiple times due to state tracking
+    InstabugScreenRenderManager.I.dispose();
   }
 
   void _handleResumedState() {

test/utils/screen_loading/screen_loading_manager_test.dart

@@ -168,25 +168,6 @@ void main() {
       when(mDateTime.now()).thenReturn(time);
     });
 
-    test('[startUiTrace] with SDK not build should Log error', () async {
-      mScreenLoadingManager.currentUiTrace = uiTrace;
-      when(mInstabugHost.isBuilt()).thenAnswer((_) async => false);
-
-      await ScreenLoadingManager.I.startUiTrace(screenName);
-
-      final actualUiTrace = ScreenLoadingManager.I.currentUiTrace;
-      expect(actualUiTrace, null);
-
-      verify(
-        mInstabugLogger.e(
-          'Instabug API {APM.InstabugCaptureScreenLoading} was called before the SDK is built. To build it, first by following the instructions at this link:\n'
-          'https://docs.instabug.com/reference#showing-and-manipulating-the-invocation',
-          tag: APM.tag,
-        ),
-      ).called(1);
-      verifyNever(mApmHost.startCpUiTrace(any, any, any));
-    });
-
     test('[startUiTrace] with APM disabled on iOS Platform should Log error',
         () async {
       mScreenLoadingManager.currentUiTrace = uiTrace;