Disable ScreenshotIntegration, WidgetsBindingIntegration and SentryWidget in multi-view apps

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Features
+
+- Add `MultiViewHelper` to make the sentry plugin multiview aware for the web platform and automatically disable `SentryScreenshotWidget`, `SentryUserInteractionWidget` and `WidgetsBindingIntegration` in multi-view applications.([#2366](https://github.com/getsentry/sentry-dart/pull/2366))
+
 ### Enhancements
 
 - Cache parsed DSN ([#2365](https://github.com/getsentry/sentry-dart/pull/2365))

flutter/lib/src/sentry_flutter.dart

@@ -24,6 +24,7 @@
 import 'profiling.dart';
 import 'renderer/renderer.dart';
 import 'span_frame_metrics_collector.dart';
+import 'utils/multi_view_helper.dart';
 import 'version.dart';
 import 'view_hierarchy/view_hierarchy_integration.dart';
 
@@ -163,8 +164,16 @@
     // 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 (MultiViewHelper.isMultiViewEnabled()) {
+      // ignore: invalid_use_of_internal_member
+      options.logger(
+        SentryLevel.debug,
+        '`WidgetsBindingIntegration` is not available in multi-view applications.',
+      );
+    } else {
+      // 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.
@@ -180,7 +189,8 @@
     }
 
     final renderer = options.rendererWrapper.getRenderer();
-    if (!platformChecker.isWeb || renderer == FlutterRenderer.canvasKit) {
+    if (!MultiViewHelper.isMultiViewEnabled() && !platformChecker.isWeb ||
+        renderer == FlutterRenderer.canvasKit) {
       integrations.add(ScreenshotIntegration());
     }
 

flutter/lib/src/sentry_widget.dart

@@ -1,6 +1,7 @@
 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,7 +12,13 @@
 class SentryWidget extends StatefulWidget {
   final Widget child;
 
-  const SentryWidget({super.key, required this.child});
+  SentryWidget({
+    super.key,
+    required this.child,
+    @internal Hub? hub,
+  });
+
+  final bool _isMultiViewEnabled = MultiViewHelper.isMultiViewEnabled();
 
   @override
   _SentryWidgetState createState() => _SentryWidgetState();
@@ -21,6 +28,14 @@
   @override
   Widget build(BuildContext context) {
     Widget content = widget.child;
+    if (widget._isMultiViewEnabled) {
+      // ignore: invalid_use_of_internal_member
+      Sentry.currentHub.options.logger(
+        SentryLevel.debug,
+        '`SentryScreenshotWidget` and `SentryUserInteractionWidget` is not available in multi-view applications.',
+      );
+      return content;
+    }
     content = SentryScreenshotWidget(child: content);
     content = SentryUserInteractionWidget(child: content);
     return Container(

flutter/lib/src/utils/multi_view_helper.dart

@@ -0,0 +1,14 @@
+import 'dart:ui';
+import 'package:meta/meta.dart';
+
+@internal
+class MultiViewHelper {
+  static bool isMultiViewEnabled() {
+    final dynamic uncheckedImplicitView = PlatformDispatcher.instance;
+    try {
+      return null == uncheckedImplicitView.implicitView;
+    } on NoSuchMethodError catch (_) {
+      return false;
+    }
+  }
+}