move multiview check to init

Author: denrase

flutter/lib/src/integrations/on_error_integration.dart

@@ -1,14 +1,12 @@
 import 'dart:ui';
 
-import 'package:flutter/widgets.dart';
+import 'package:meta/meta.dart';
 import 'package:sentry/sentry.dart';
 import '../sentry_flutter_options.dart';
 
 // ignore: implementation_imports
 import 'package:sentry/src/utils/stacktrace_utils.dart';
 
-import '../utils/platform_dispatcher_wrapper.dart';
-
 typedef ErrorCallback = bool Function(Object exception, StackTrace stackTrace);
 
 /// Integration which captures `PlatformDispatcher.onError`
@@ -112,3 +110,66 @@ class OnErrorIntegration implements Integration<SentryFlutterOptions> {
     }
   }
 }
+
+/// This class wraps the `this as dynamic` hack in a type-safe manner.
+/// It helps to introduce code, which uses newer features from Flutter
+/// without breaking Sentry on older versions of Flutter.
+// Should not become part of public API.
+@internal
+class PlatformDispatcherWrapper {
+  PlatformDispatcherWrapper(this._dispatcher);
+
+  final PlatformDispatcher? _dispatcher;
+
+  bool isMultiViewEnabled(SentryFlutterOptions options) {
+    try {
+      return ((_dispatcher as dynamic)?.implicitView as FlutterView?) == null;
+    } on NoSuchMethodError {
+      // This error is expected on pre 3.10.0 Flutter version
+      return false;
+    } catch (exception, stacktrace) {
+      // This error is neither expected on pre 3.10.0 nor on >= 3.10.0 Flutter versions
+      options.logger(
+        SentryLevel.debug,
+        'An unexpected exception was thrown, please create an issue at https://github.com/getsentry/sentry-dart/issues',
+        exception: exception,
+        stackTrace: stacktrace,
+      );
+      if (options.automatedTestMode) {
+        rethrow;
+      }
+      return false;
+    }
+  }
+
+  /// Should not be accessed if [isOnErrorSupported] == false
+  ErrorCallback? get onError =>
+      (_dispatcher as dynamic)?.onError as ErrorCallback?;
+
+  /// Should not be accessed if [isOnErrorSupported] == false
+  set onError(ErrorCallback? callback) {
+    (_dispatcher as dynamic)?.onError = callback;
+  }
+
+  bool isOnErrorSupported(SentryFlutterOptions options) {
+    try {
+      onError;
+    } on NoSuchMethodError {
+      // This error is expected on pre 3.1 Flutter version
+      return false;
+    } catch (exception, stacktrace) {
+      // This error is neither expected on pre 3.1 nor on >= 3.1 Flutter versions
+      options.logger(
+        SentryLevel.debug,
+        'An unexpected exception was thrown, please create an issue at https://github.com/getsentry/sentry-dart/issues',
+        exception: exception,
+        stackTrace: stacktrace,
+      );
+      if (options.automatedTestMode) {
+        rethrow;
+      }
+      return false;
+    }
+    return true;
+  }
+}

flutter/lib/src/integrations/screenshot_integration.dart

@@ -1,7 +1,6 @@
 import 'package:sentry/sentry.dart';
 import '../event_processor/screenshot_event_processor.dart';
 import '../sentry_flutter_options.dart';
-import '../utils/multi_view_helper.dart';
 
 /// Adds [ScreenshotEventProcessor] to options event processors if
 /// [SentryFlutterOptions.attachScreenshot] is true
@@ -11,15 +10,6 @@ class ScreenshotIntegration implements Integration<SentryFlutterOptions> {
 
   @override
   void call(Hub hub, SentryFlutterOptions options) {
-    if (MultiViewHelper.isMultiViewEnabled()) {
-      // ignore: invalid_use_of_internal_member
-      options.logger(
-        SentryLevel.debug,
-        '`ScreenshotIntegration` is not available in multi-view applications.',
-      );
-      return;
-    }
-
     if (options.attachScreenshot) {
       _options = options;
       final screenshotEventProcessor = ScreenshotEventProcessor(options);

flutter/lib/src/integrations/widgets_binding_integration.dart

@@ -1,6 +1,5 @@
 import 'package:sentry/sentry.dart';
 import '../sentry_flutter_options.dart';
-import '../utils/multi_view_helper.dart';
 import '../widgets_binding_observer.dart';
 
 /// Integration that captures certain window and device events.
@@ -13,15 +12,6 @@ class WidgetsBindingIntegration implements Integration<SentryFlutterOptions> {
 
   @override
   void call(Hub hub, SentryFlutterOptions options) {
-    if (MultiViewHelper.isMultiViewEnabled()) {
-      // ignore: invalid_use_of_internal_member
-      options.logger(
-        SentryLevel.debug,
-        '`WidgetsBindingIntegration` is not available in multi-view applications.',
-      );
-      return;
-    }
-
     _options = options;
     final observer = SentryWidgetsBindingObserver(
       hub: hub,

flutter/lib/src/sentry_flutter.dart

@@ -25,8 +25,6 @@ import 'native/native_scope_observer.dart';
 import 'native/sentry_native_binding.dart';
 import 'profiling.dart';
 import 'renderer/renderer.dart';
-import 'span_frame_metrics_collector.dart';
-import 'utils/platform_dispatcher_wrapper.dart';
 import 'replay/integration.dart';
 import 'version.dart';
 import 'view_hierarchy/view_hierarchy_integration.dart';
@@ -68,8 +66,9 @@ mixin SentryFlutter {
       _native = createBinding(options);
     }
 
-    final platformDispatcher = PlatformDispatcher.instance;
-    final wrapper = PlatformDispatcherWrapper(platformDispatcher);
+    final wrapper = PlatformDispatcherWrapper(PlatformDispatcher.instance);
+    final isMultiViewApp = wrapper.isMultiViewEnabled(options);
+    options.isMultiViewApp = isMultiViewApp; // TODO @denis Make testable/mockable
 
     // Flutter Web doesn't capture [Future] errors if using [PlatformDispatcher.onError] and not
     // the [runZonedGuarded].
@@ -87,8 +86,11 @@ mixin SentryFlutter {
 
     // first step is to install the native integration and set default values,
     // so we are able to capture future errors.
-    final defaultIntegrations =
-        _createDefaultIntegrations(options, isOnErrorSupported);
+    final defaultIntegrations = _createDefaultIntegrations(
+      options,
+      isOnErrorSupported,
+      isMultiViewApp,
+    );
     for (final defaultIntegration in defaultIntegrations) {
       options.addIntegration(defaultIntegration);
     }
@@ -157,6 +159,7 @@ mixin SentryFlutter {
   static List<Integration> _createDefaultIntegrations(
     SentryFlutterOptions options,
     bool isOnErrorSupported,
+    bool isMultiViewApp,
   ) {
     final integrations = <Integration>[];
     final platformChecker = options.platformChecker;
@@ -172,8 +175,10 @@ mixin SentryFlutter {
     // Will catch any errors that may occur in the Flutter framework itself.
     integrations.add(FlutterErrorIntegration());
 
-    // This tracks Flutter application events, such as lifecycle events.
-    integrations.add(WidgetsBindingIntegration());
+    if (!isMultiViewApp) {
+      // This tracks Flutter application events, such as lifecycle events.
+      integrations.add(WidgetsBindingIntegration());
+    }
 
     // The ordering here matters, as we'd like to first start the native integration.
     // That allow us to send events to the network and then the Flutter integrations.
@@ -198,7 +203,8 @@ mixin SentryFlutter {
     }
 
     final renderer = options.rendererWrapper.getRenderer();
-    if (!platformChecker.isWeb || renderer == FlutterRenderer.canvasKit) {
+    if ((!platformChecker.isWeb || renderer == FlutterRenderer.canvasKit) &&
+        !isMultiViewApp) {
       integrations.add(ScreenshotIntegration());
     }
 

flutter/lib/src/sentry_flutter_options.dart

@@ -1,4 +1,5 @@
 import 'dart:async';
+import 'dart:ui';
 
 import 'package:file/file.dart';
 import 'package:file/local.dart';
@@ -7,6 +8,7 @@ import 'package:flutter/widgets.dart';
 import 'package:meta/meta.dart' as meta;
 import 'package:sentry/sentry.dart';
 
+import '../sentry_flutter.dart';
 import 'binding_wrapper.dart';
 import 'event_processor/screenshot_event_processor.dart';
 import 'navigation/time_to_display_tracker.dart';
@@ -236,6 +238,9 @@ class SentryFlutterOptions extends SentryOptions {
   @meta.internal
   late RendererWrapper rendererWrapper = RendererWrapper();
 
+  @meta.internal
+  bool isMultiViewApp = false;
+
   @meta.internal
   late MethodChannel methodChannel = const MethodChannel('sentry_flutter');
 

flutter/lib/src/sentry_widget.dart

@@ -1,7 +1,6 @@
 import 'package:flutter/cupertino.dart';
 import 'package:meta/meta.dart';
 import '../sentry_flutter.dart';
-import 'utils/multi_view_helper.dart';
 
 /// Key which is used to identify the [SentryWidget]
 @internal
@@ -11,14 +10,22 @@ final sentryWidgetGlobalKey = GlobalKey(debugLabel: 'sentry_widget');
 /// as [SentryScreenshotWidget] and [SentryUserInteractionWidget].
 class SentryWidget extends StatefulWidget {
   final Widget child;
+  late final Hub _hub;
 
   SentryWidget({
     super.key,
     required this.child,
     @internal Hub? hub,
-  });
+  }) {
+    _hub = hub ?? HubAdapter();
+  }
 
-  final bool _isMultiViewEnabled = MultiViewHelper.isMultiViewEnabled();
+  SentryFlutterOptions? get _options =>
+      // ignore: invalid_use_of_internal_member
+      _hub.options is SentryFlutterOptions
+          // ignore: invalid_use_of_internal_member
+          ? _hub.options as SentryFlutterOptions?
+          : null;
 
   @override
   _SentryWidgetState createState() => _SentryWidgetState();
@@ -28,19 +35,20 @@ class _SentryWidgetState extends State<SentryWidget> {
   @override
   Widget build(BuildContext context) {
     Widget content = widget.child;
-    if (widget._isMultiViewEnabled) {
+    if (widget._options?.isMultiViewApp ?? false) {
       // ignore: invalid_use_of_internal_member
       Sentry.currentHub.options.logger(
         SentryLevel.debug,
-        '`SentryScreenshotWidget` and `SentryUserInteractionWidget` is not available in multi-view applications.',
+        '`SentryWidget` is not available in multi-view apps.',
       );
       return content;
+    } else {
+      content = SentryScreenshotWidget(child: content);
+      content = SentryUserInteractionWidget(child: content);
+      return Container(
+        key: sentryWidgetGlobalKey,
+        child: content,
+      );
     }
-    content = SentryScreenshotWidget(child: content);
-    content = SentryUserInteractionWidget(child: content);
-    return Container(
-      key: sentryWidgetGlobalKey,
-      child: content,
-    );
   }
 }

flutter/lib/src/utils/multi_view_helper.dart

@@ -2,7 +2,6 @@ import 'package:flutter_test/flutter_test.dart';
 import 'package:mockito/mockito.dart';
 import 'package:sentry/sentry.dart';
 import 'package:sentry_flutter/src/integrations/on_error_integration.dart';
-import 'package:sentry_flutter/src/utils/platform_dispatcher_wrapper.dart';
 
 import '../mocks.dart';
 import '../mocks.mocks.dart';

flutter/lib/src/utils/platform_dispatcher_wrapper.dart

@@ -2,7 +2,6 @@ import 'package:flutter_test/flutter_test.dart';
 import 'package:mockito/mockito.dart';
 import 'package:sentry/sentry.dart';
 import 'package:sentry_flutter/src/integrations/on_error_integration.dart';
-import 'package:sentry_flutter/src/utils/platform_dispatcher_wrapper.dart';
 
 import '../mocks.dart';
 import '../mocks.mocks.dart';

flutter/test/integrations/not_initialized_widgets_binding_on_error_integration_test.dart

@@ -732,6 +732,8 @@ void main() {
       );
     });
   });
+
+  // TODO @denis Test isMultiViewApp...
 }
 
 MockSentryNativeBinding mockNativeBinding() {