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

feat/screen-render-testing

Author: AndrewAminInstabug

example/ios/Podfile

@@ -30,7 +30,7 @@ target 'Runner' do
 
   use_frameworks!
   use_modular_headers!
-  pod 'Instabug', :podspec => 'https://ios-releases.instabug.com/custom/faeture-screen_rendering-release/15.1.13/Instabug.podspec'
+  pod 'Instabug', :podspec => 'https://ios-releases.instabug.com/custom/faeture-screen_rendering-release/15.1.17/Instabug.podspec'
   flutter_install_all_ios_pods File.dirname(File.realpath(__FILE__))
 end
 

example/ios/Podfile.lock

@@ -1,14 +1,14 @@
 PODS:
   - Flutter (1.0.0)
-  - Instabug (15.1.13)
+  - Instabug (15.1.17)
   - instabug_flutter (14.3.0):
     - Flutter
-    - Instabug (= 15.1.13)
+    - Instabug (= 15.1.17)
   - OCMock (3.6)
 
 DEPENDENCIES:
   - Flutter (from `Flutter`)
-  - Instabug (from `https://ios-releases.instabug.com/custom/faeture-screen_rendering-release/15.1.13/Instabug.podspec`)
+  - Instabug (from `https://ios-releases.instabug.com/custom/faeture-screen_rendering-release/15.1.17/Instabug.podspec`)
   - instabug_flutter (from `.symlinks/plugins/instabug_flutter/ios`)
   - OCMock (= 3.6)
 
@@ -20,16 +20,16 @@ EXTERNAL SOURCES:
   Flutter:
     :path: Flutter
   Instabug:
-    :podspec: https://ios-releases.instabug.com/custom/faeture-screen_rendering-release/15.1.13/Instabug.podspec
+    :podspec: https://ios-releases.instabug.com/custom/faeture-screen_rendering-release/15.1.17/Instabug.podspec
   instabug_flutter:
     :path: ".symlinks/plugins/instabug_flutter/ios"
 
 SPEC CHECKSUMS:
   Flutter: e0871f40cf51350855a761d2e70bf5af5b9b5de7
-  Instabug: 697dc090bbdb9b99a9a91758558f8a2014ee5725
-  instabug_flutter: 1093324eaca70f9d310a4bc7f1f3537c746c1d6c
+  Instabug: 316559a02c9b752a3854a6453c2fa414d36252f3
+  instabug_flutter: 7ae7f3d1c47b9a699e76a7358b6a3e818a253ac3
   OCMock: 5ea90566be239f179ba766fd9fbae5885040b992
 
-PODFILE CHECKSUM: 509cc3728286920762d8cbecfac090a3af93635d
+PODFILE CHECKSUM: 8f3e14dab36cc02b0a8767c3086e109fadaa55f3
 
 COCOAPODS: 1.15.2

ios/instabug_flutter.podspec

@@ -17,6 +17,6 @@ Pod::Spec.new do |s|
   s.pod_target_xcconfig   = { 'OTHER_LDFLAGS' => '-framework "Flutter" -framework "InstabugSDK"'}
 
   s.dependency 'Flutter'
-  s.dependency 'Instabug', '15.1.13'
+  s.dependency 'Instabug', '15.1.17'
 end
 

lib/src/modules/apm.dart

@@ -392,10 +392,10 @@ class APM {
   ///
   /// Returns:
   ///   A Future<void> is being returned.
-  static Future<void> setScreenRenderEnabled(bool isEnabled) {
-    return _host.setScreenRenderEnabled(isEnabled).then((_) {
+  static Future<void> setScreenRenderEnabled(bool isEnabled) async {
+    return _host.setScreenRenderEnabled(isEnabled).then((_) async {
       if (isEnabled) {
-        InstabugScreenRenderManager.I.init(WidgetsBinding.instance);
+        await InstabugScreenRenderManager.I.init(WidgetsBinding.instance);
       } else {
         InstabugScreenRenderManager.I.dispose();
       }

lib/src/modules/instabug.dart

@@ -23,9 +23,7 @@ import 'package:instabug_flutter/src/utils/feature_flags_manager.dart';
 import 'package:instabug_flutter/src/utils/ibg_build_info.dart';
 import 'package:instabug_flutter/src/utils/instabug_logger.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:instabug_flutter/src/utils/screen_rendering/instabug_widget_binding_observer.dart';
-import 'package:instabug_flutter/src/utils/ui_trace/flags_config.dart';
 import 'package:meta/meta.dart';
 
 enum InvocationEvent {
@@ -198,10 +196,6 @@ class Instabug {
       debugLogsLevel.toString(),
     );
 
-    if (await FlagsConfig.screenRendering.isEnabled()) {
-      InstabugScreenRenderManager.I.init(WidgetsBinding.instance);
-    }
-
     return FeatureFlagsManager().registerW3CFlagsListener();
   }
 

lib/src/utils/instabug_navigator_observer.dart

@@ -66,18 +66,18 @@ class InstabugNavigatorObserver extends NavigatorObserver {
   }
 
   FutureOr<void> _startScreenRenderCollector(int? uiTraceId) async {
-    final isScreenRender = await FlagsConfig.screenRendering.isEnabled();
-    _checkForScreenRenderInitialization(isScreenRender);
-    if (uiTraceId != null && isScreenRender) {
+    final isScreenRenderEnabled = await FlagsConfig.screenRendering.isEnabled();
+    await _checkForScreenRenderInitialization(isScreenRenderEnabled);
+    if (uiTraceId != null && isScreenRenderEnabled) {
       InstabugScreenRenderManager.I
           .startScreenRenderCollectorForTraceId(uiTraceId);
     }
   }
 
-  void _checkForScreenRenderInitialization(bool isScreenRender) {
+  Future<void> _checkForScreenRenderInitialization(bool isScreenRender) async {
     if (isScreenRender) {
       if (!InstabugScreenRenderManager.I.screenRenderEnabled) {
-        InstabugScreenRenderManager.I.init(WidgetsBinding.instance);
+        await InstabugScreenRenderManager.I.init(WidgetsBinding.instance);
       }
     } else {
       if (InstabugScreenRenderManager.I.screenRenderEnabled) {

lib/src/utils/screen_rendering/instabug_screen_render_manager.dart

@@ -1,5 +1,5 @@
 import 'dart:async';
-import 'dart:ui';
+import 'dart:ui' show TimingsCallback, FrameTiming, FramePhase;
 
 import 'package:flutter/widgets.dart';
 import 'package:instabug_flutter/src/models/instabug_frame_data.dart';
@@ -18,14 +18,14 @@ enum UiTraceType {
 @internal
 class InstabugScreenRenderManager {
   WidgetsBinding? _widgetsBinding;
-  late int _buildTime;
-  late int _rasterTime;
-  late int _totalTime;
+  late int _buildTimeMs;
+  late int _rasterTimeMs;
+  late int _totalTimeMs;
   late TimingsCallback _timingsCallback;
   late InstabugScreenRenderData _screenRenderForAutoUiTrace;
   late InstabugScreenRenderData _screenRenderForCustomUiTrace;
-  int _slowFramesTotalDurationMs = 0;
-  int _frozenFramesTotalDurationMs = 0;
+  int _slowFramesTotalDurationMicro = 0;
+  int _frozenFramesTotalDurationMicro = 0;
   int? _epochOffset;
   bool _isTimingsListenerAttached = false;
   bool screenRenderEnabled = false;
@@ -42,7 +42,7 @@ class InstabugScreenRenderManager {
   /// Default frozen frame threshold in milliseconds (700ms)
   final _frozenFrameThresholdMs = 700;
 
-  final _microsecondsPerMillisecond = 1000;
+  // final _microsecondsPerMillisecond = 1000;
 
   InstabugScreenRenderManager._();
 
@@ -75,46 +75,45 @@ class InstabugScreenRenderManager {
     }
   }
 
-  /// analyze frame data in order to detect slow/frozen frame.
+  /// Analyze frame data to detect slow or frozen frames efficiently.
   @visibleForTesting
   void analyzeFrameTiming(FrameTiming frameTiming) {
-    _buildTime = frameTiming.buildDuration.inMilliseconds;
-    _rasterTime = frameTiming.rasterDuration.inMilliseconds;
-    _totalTime = frameTiming.totalSpan.inMilliseconds;
-
-    if (_isUiFrozen) {
-      _frozenFramesTotalDurationMs += _buildTime;
-    } else if (_isRasterFrozen) {
-      _frozenFramesTotalDurationMs += _rasterTime;
-    } else if (_isTotalTimeLarge) {
-      _frozenFramesTotalDurationMs += _totalTime;
-    }
-    if (_isUiSlow) {
-      _slowFramesTotalDurationMs += _buildTime;
-    } else if (_isRasterSlow) {
-      _slowFramesTotalDurationMs += _rasterTime;
-    }
+    _buildTimeMs = frameTiming.buildDuration.inMilliseconds;
+    _rasterTimeMs = frameTiming.rasterDuration.inMilliseconds;
+    _totalTimeMs = frameTiming.totalSpan.inMilliseconds;
 
-    if (_isUiDelayed) {
+    if (_isTotalTimeLarge) {
+      final micros = frameTiming.totalSpan.inMicroseconds;
+      _frozenFramesTotalDurationMicro += micros;
       _onDelayedFrameDetected(
         _getMicrosecondsSinceEpoch(
-          frameTiming.timestampInMicroseconds(FramePhase.buildStart),
+          frameTiming.timestampInMicroseconds(FramePhase.vsyncStart),
         ),
-        _buildTime,
+        micros,
       );
-    } else if (_isRasterDelayed) {
+      return;
+    }
+
+    if (_isUiSlow) {
+      final micros = frameTiming.buildDuration.inMicroseconds;
+      _slowFramesTotalDurationMicro += micros;
       _onDelayedFrameDetected(
         _getMicrosecondsSinceEpoch(
-          frameTiming.timestampInMicroseconds(FramePhase.rasterStart),
+          frameTiming.timestampInMicroseconds(FramePhase.buildStart),
         ),
-        _rasterTime,
+        micros,
       );
-    } else if (_isTotalTimeLarge) {
+      return;
+    }
+
+    if (_isRasterSlow) {
+      final micros = frameTiming.rasterDuration.inMicroseconds;
+      _slowFramesTotalDurationMicro += micros;
       _onDelayedFrameDetected(
         _getMicrosecondsSinceEpoch(
-          frameTiming.timestampInMicroseconds(FramePhase.vsyncStart),
+          frameTiming.timestampInMicroseconds(FramePhase.rasterStart),
         ),
-        _totalTime,
+        micros,
       );
     }
   }
@@ -215,23 +214,15 @@ class InstabugScreenRenderManager {
 
   /// --------------------------- private methods ---------------------
 
-  bool get _isUiDelayed => _isUiSlow || _isUiFrozen;
-
-  bool get _isRasterDelayed => _isRasterSlow || _isRasterFrozen;
-
   bool get _isUiSlow =>
-      _buildTime > _slowFrameThresholdMs &&
-      _buildTime < _frozenFrameThresholdMs;
+      _buildTimeMs > _slowFrameThresholdMs &&
+      _buildTimeMs < _frozenFrameThresholdMs;
 
   bool get _isRasterSlow =>
-      _rasterTime > _slowFrameThresholdMs &&
-      _rasterTime < _frozenFrameThresholdMs;
-
-  bool get _isTotalTimeLarge => _totalTime >= _frozenFrameThresholdMs;
-
-  bool get _isUiFrozen => _buildTime >= _frozenFrameThresholdMs;
+      _rasterTimeMs > _slowFrameThresholdMs &&
+      _rasterTimeMs < _frozenFrameThresholdMs;
 
-  bool get _isRasterFrozen => _rasterTime >= _frozenFrameThresholdMs;
+  bool get _isTotalTimeLarge => _totalTimeMs >= _frozenFrameThresholdMs;
 
   /// Calculate the target time for the frame to be drawn in milliseconds based on the device refresh rate.
   double _targetMsPerFrame(double displayRefreshRate) =>
@@ -302,18 +293,17 @@ class InstabugScreenRenderManager {
 
   /// Reset the memory cashed data
   void _resetCachedFrameData() {
-    _slowFramesTotalDurationMs = 0;
-    _frozenFramesTotalDurationMs = 0;
+    _slowFramesTotalDurationMicro = 0;
+    _frozenFramesTotalDurationMicro = 0;
     _delayedFrames.clear();
   }
 
   /// Save Slow/Frozen Frames data
-  void _onDelayedFrameDetected(int startTime, int durationInMilliseconds) {
+  void _onDelayedFrameDetected(int startTime, int durationInMicroseconds) {
     _delayedFrames.add(
       InstabugFrameData(
         startTime,
-        durationInMilliseconds *
-            _microsecondsPerMillisecond, // Convert duration from milliseconds to microSeconds
+        durationInMicroseconds,
       ),
     );
   }
@@ -342,8 +332,8 @@ class InstabugScreenRenderManager {
     try {
       // Save the end time for the running ui trace, it's only needed in Android SDK.
       screenRenderData.saveEndTime();
-
       await APM.endScreenRenderForAutoUiTrace(screenRenderData);
+
       return true;
     } catch (error, stackTrace) {
       _logExceptionErrorAndStackTrace(error, stackTrace);
@@ -370,9 +360,9 @@ class InstabugScreenRenderManager {
   /// or synced with the native side.
   void _updateCustomUiData() {
     _screenRenderForCustomUiTrace.slowFramesTotalDurationMicro +=
-        _slowFramesTotalDurationMs * _microsecondsPerMillisecond;
+        _slowFramesTotalDurationMicro;
     _screenRenderForCustomUiTrace.frozenFramesTotalDurationMicro +=
-        _frozenFramesTotalDurationMs * _microsecondsPerMillisecond;
+        _frozenFramesTotalDurationMicro;
     _screenRenderForCustomUiTrace.frameData.addAll(_delayedFrames);
   }
 
@@ -385,9 +375,9 @@ class InstabugScreenRenderManager {
   /// or synced with the native side.
   void _updateAutoUiData() {
     _screenRenderForAutoUiTrace.slowFramesTotalDurationMicro +=
-        _slowFramesTotalDurationMs * _microsecondsPerMillisecond;
+        _slowFramesTotalDurationMicro;
     _screenRenderForAutoUiTrace.frozenFramesTotalDurationMicro +=
-        _frozenFramesTotalDurationMs * _microsecondsPerMillisecond;
+        _frozenFramesTotalDurationMicro;
     _screenRenderForAutoUiTrace.frameData.addAll(_delayedFrames);
   }
 
@@ -426,9 +416,7 @@ class InstabugScreenRenderManager {
   @visibleForTesting
   void setFrameData(InstabugScreenRenderData data) {
     _delayedFrames.addAll(data.frameData);
-    _frozenFramesTotalDurationMs =
-        data.frozenFramesTotalDurationMicro ~/ _microsecondsPerMillisecond;
-    _slowFramesTotalDurationMs =
-        data.slowFramesTotalDurationMicro ~/ _microsecondsPerMillisecond;
+    _frozenFramesTotalDurationMicro = data.frozenFramesTotalDurationMicro;
+    _slowFramesTotalDurationMicro = data.slowFramesTotalDurationMicro;
   }
 }

test/utils/screen_render/instabug_screen_render_manager_test.dart

@@ -380,40 +380,19 @@ void main() {
     });
 
     test(
-        'should detect frozen frame on build thread when durations are greater than or equal 700 ms',
+        'should detect frozen frame when durations are greater than or equal 700 ms',
         () {
-      const buildDuration = 700;
-      when(mockFrameTiming.buildDuration)
-          .thenReturn(const Duration(milliseconds: buildDuration));
-      manager.startScreenRenderCollectorForTraceId(1); // start new collector
-      manager.analyzeFrameTiming(mockFrameTiming); // mock frame timing
-      manager.stopScreenRenderCollector(); // should save data
-
-      expect(manager.screenRenderForAutoUiTrace.frameData.length, 1);
-      expect(
-        manager.screenRenderForAutoUiTrace.frozenFramesTotalDurationMicro,
-        buildDuration * 1000,
-      ); // * 1000 to convert from milliseconds to microseconds
-      expect(
-        manager.screenRenderForAutoUiTrace.slowFramesTotalDurationMicro,
-        0,
-      );
-    });
-
-    test(
-        'should detect frozen frame on raster thread when durations are greater than or equal 700 ms',
-        () {
-      const rasterBuild = 700;
-      when(mockFrameTiming.buildDuration)
-          .thenReturn(const Duration(milliseconds: rasterBuild));
+      const totalTime = 700;
+      when(mockFrameTiming.totalSpan)
+          .thenReturn(const Duration(milliseconds: totalTime));
       manager.startScreenRenderCollectorForTraceId(1); // start new collector
       manager.analyzeFrameTiming(mockFrameTiming); // mock frame timing
       manager.stopScreenRenderCollector(); // should save data
 
       expect(manager.screenRenderForAutoUiTrace.frameData.length, 1);
       expect(
         manager.screenRenderForAutoUiTrace.frozenFramesTotalDurationMicro,
-        rasterBuild * 1000,
+        totalTime * 1000,
       ); // * 1000 to convert from milliseconds to microseconds
       expect(
         manager.screenRenderForAutoUiTrace.slowFramesTotalDurationMicro,