Disable ScreenshotIntegration, WidgetsBindingIntegration and SentryWidget in multi-view apps

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Features
+
+- Disable `ScreenshotIntegration`, `WidgetsBindingIntegration` and `SentryWidget` in multi-view apps #2366 ([#2366](https://github.com/getsentry/sentry-dart/pull/2366))
+
 ### Deprecations
 
 - Deprecate `autoAppStart` and `setAppStartEnd` ([#2681](https://github.com/getsentry/sentry-dart/pull/2681))

flutter/example/integration_test/web_sdk_test.dart

@@ -124,6 +124,41 @@ void main() {
         // sent in the JS layer
         expect(jsEventJson, equals(dartEventJson));
       });
+
+      testWidgets('includes single-view supporting integrations',
+          (tester) async {
+        SentryFlutterOptions? confOptions;
+
+        await restoreFlutterOnErrorAfter(() async {
+          await SentryFlutter.init((options) {
+            options.enableSentryJs = true;
+            options.dsn = fakeDsn;
+            options.attachScreenshot = true;
+
+            confOptions = options;
+          }, appRunner: () async {
+            await tester.pumpWidget(
+              SentryWidget(child: const app.MyApp()),
+            );
+          });
+        });
+        expect(
+          confOptions?.sdk.integrations.contains("screenshotIntegration"),
+          isTrue,
+        );
+        expect(
+          confOptions?.sdk.integrations.contains("widgetsBindingIntegration"),
+          isTrue,
+        );
+        expect(
+          find.byType(SentryScreenshotWidget),
+          findsOneWidget,
+        );
+        expect(
+          find.byType(SentryUserInteractionWidget),
+          findsOneWidget,
+        );
+      });
     });
 
     group('disabled', () {

flutter/lib/src/integrations/on_error_integration.dart

@@ -1,11 +1,8 @@
-import 'dart:ui';
-
-import 'package:flutter/widgets.dart';
 import 'package:sentry/sentry.dart';
-import '../sentry_flutter_options.dart';
-
 // ignore: implementation_imports
 import 'package:sentry/src/utils/stacktrace_utils.dart';
+import '../sentry_flutter_options.dart';
+import '../utils/platform_dispatcher_wrapper.dart';
 
 typedef ErrorCallback = bool Function(Object exception, StackTrace stackTrace);
 
@@ -110,45 +107,3 @@ 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.
-@visibleForTesting
-class PlatformDispatcherWrapper {
-  PlatformDispatcherWrapper(this._dispatcher);
-
-  final PlatformDispatcher? _dispatcher;
-
-  /// 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

@@ -10,6 +10,14 @@ class ScreenshotIntegration implements Integration<SentryFlutterOptions> {
 
   @override
   void call(Hub hub, SentryFlutterOptions options) {
+    if (options.isMultiViewApp) {
+      // 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

@@ -12,6 +12,14 @@ class WidgetsBindingIntegration implements Integration<SentryFlutterOptions> {
 
   @override
   void call(Hub hub, SentryFlutterOptions options) {
+    if (options.isMultiViewApp) {
+      // 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

@@ -26,6 +26,7 @@ import 'native/sentry_native_binding.dart';
 import 'profiling.dart';
 import 'renderer/renderer.dart';
 import 'replay/integration.dart';
+import 'utils/platform_dispatcher_wrapper.dart';
 import 'version.dart';
 import 'view_hierarchy/view_hierarchy_integration.dart';
 
@@ -66,8 +67,8 @@ mixin SentryFlutter {
       _native = createBinding(options);
     }
 
-    final platformDispatcher = PlatformDispatcher.instance;
-    final wrapper = PlatformDispatcherWrapper(platformDispatcher);
+    final wrapper = PlatformDispatcherWrapper(PlatformDispatcher.instance);
+    options.isMultiViewApp = wrapper.isMultiViewEnabled(options);
 
     // Flutter Web doesn't capture [Future] errors if using [PlatformDispatcher.onError] and not
     // the [runZonedGuarded].
@@ -85,8 +86,10 @@ 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,
+    );
     for (final defaultIntegration in defaultIntegrations) {
       options.addIntegration(defaultIntegration);
     }

flutter/lib/src/sentry_flutter_options.dart

@@ -238,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

@@ -10,8 +10,22 @@ final sentryWidgetGlobalKey = GlobalKey(debugLabel: 'sentry_widget');
 /// as [SentryScreenshotWidget] and [SentryUserInteractionWidget].
 class SentryWidget extends StatefulWidget {
   final Widget child;
+  late final Hub _hub;
 
-  const SentryWidget({super.key, required this.child});
+  SentryWidget({
+    super.key,
+    required this.child,
+    @internal Hub? hub,
+  }) {
+    _hub = hub ?? HubAdapter();
+  }
+
+  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();
@@ -21,11 +35,20 @@ class _SentryWidgetState extends State<SentryWidget> {
   @override
   Widget build(BuildContext context) {
     Widget content = widget.child;
-    content = SentryScreenshotWidget(child: content);
-    content = SentryUserInteractionWidget(child: content);
-    return Container(
-      key: sentryWidgetGlobalKey,
-      child: content,
-    );
+    if (widget._options?.isMultiViewApp ?? false) {
+      // ignore: invalid_use_of_internal_member
+      Sentry.currentHub.options.logger(
+        SentryLevel.debug,
+        '`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,
+      );
+    }
   }
 }

flutter/lib/src/utils/platform_dispatcher_wrapper.dart

@@ -0,0 +1,70 @@
+import 'dart:ui';
+
+import 'package:meta/meta.dart';
+import 'package:sentry/sentry.dart';
+import '../integrations/on_error_integration.dart';
+import '../sentry_flutter_options.dart';
+
+/// 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/test/integrations/not_initialized_widgets_binding_on_error_integration_test.dart

@@ -2,6 +2,7 @@ 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/on_error_integration_test.dart

@@ -2,6 +2,7 @@ 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/screenshot_integration_test.dart

@@ -41,17 +41,34 @@ void main() {
 
     integration(fixture.hub, fixture.options);
 
-    expect(fixture.options.sdk.integrations.contains('screenshotIntegration'),
-        true);
+    expect(
+      fixture.options.sdk.integrations.contains('screenshotIntegration'),
+      true,
+    );
   });
 
   test('screenshotIntegration does not add integration to the sdk list', () {
     final integration = fixture.getSut(attachScreenshot: false);
 
     integration(fixture.hub, fixture.options);
 
-    expect(fixture.options.sdk.integrations.contains('screenshotIntegration'),
-        false);
+    expect(
+      fixture.options.sdk.integrations.contains('screenshotIntegration'),
+      false,
+    );
+  });
+
+  test(
+      'screenshotIntegration does not add integration to the sdk list for multiview app',
+      () {
+    final integration = fixture.getSut();
+    fixture.options.isMultiViewApp = true;
+    integration(fixture.hub, fixture.options);
+
+    expect(
+      fixture.options.sdk.integrations.contains('screenshotIntegration'),
+      false,
+    );
   });
 
   test('screenshotIntegration close resets processor', () {