read textScale from sentry widget event processor

Author: denrase

dart/test/protocol/sentry_app_test.dart

@@ -90,7 +90,7 @@ void main() {
         deviceAppHash: 'hash1',
         inForeground: true,
         viewNames: ['screen1'],
-        textScale: 'textScale1'
+        textScale: 'textScale1',
       );
 
       expect('name1', copy.name);

flutter/lib/src/event_processor/flutter_enricher_event_processor.dart

@@ -50,9 +50,7 @@ class FlutterEnricherEventProcessor implements EventProcessor {
 
     final app = contexts.app;
     if (app != null) {
-      contexts.app = _appWithCurrentRouteViewName(app).copyWith(
-        textScale: _retrieveWidgetTextScale(_options.navigatorKey),
-      );
+      contexts.app = _appWithCurrentRouteViewName(app);
     }
 
     // Flutter has a lot of Accessibility Settings available and exposes them
@@ -268,21 +266,6 @@ class FlutterEnricherEventProcessor implements EventProcessor {
     }
     return Localizations.maybeLocaleOf(context);
   }
-
-  String? _retrieveWidgetTextScale(GlobalKey<NavigatorState>? navigatorKey) {
-    final context = navigatorKey?.currentContext;
-    if (context == null) {
-      return null;
-    }
-    final textScaleFactor =
-        MediaQuery.maybeTextScalerOf(context)?.textScaleFactor;
-    if (textScaleFactor == null) {
-      return null;
-    }
-    return textScaleFactor == 1.0
-        ? 'no scaling'
-        : 'linear (${textScaleFactor}x)';
-  }
 }
 
 /// Copied from https://api.flutter.dev/flutter/services/appFlavor-constant.html

flutter/lib/src/event_processor/widget_event_processor.dart

@@ -0,0 +1,35 @@
+import 'dart:async';
+
+import 'package:flutter/widgets.dart';
+
+import '../../sentry_flutter.dart';
+
+class WidgetEventProcessor implements EventProcessor {
+  @override
+  FutureOr<SentryEvent?> apply(SentryEvent event, {Hint? hint}) {
+    if (event is SentryTransaction) {
+      return event;
+    }
+    if (event.exceptions == null && event.throwable == null) {
+      return event;
+    }
+    final context = sentryWidgetGlobalKey.currentContext;
+    if (context == null) {
+      return event;
+    }
+    final textScaleFactor =
+        MediaQuery.maybeTextScalerOf(context)?.textScaleFactor;
+    if (textScaleFactor == null) {
+      return event;
+    }
+    final textScale =
+        textScaleFactor == 1.0 ? 'no scaling' : 'linear (${textScaleFactor}x)';
+    return event.copyWith(
+      contexts: event.contexts.copyWith(
+        app: event.contexts.app?.copyWith(
+          textScale: textScale,
+        ),
+      ),
+    );
+  }
+}

flutter/lib/src/sentry_flutter.dart

@@ -9,6 +9,7 @@ import '../sentry_flutter.dart';
 import 'event_processor/android_platform_exception_event_processor.dart';
 import 'event_processor/flutter_exception_event_processor.dart';
 import 'event_processor/platform_exception_event_processor.dart';
+import 'event_processor/widget_event_processor.dart';
 import 'integrations/connectivity/connectivity_integration.dart';
 import 'integrations/screenshot_integration.dart';
 import 'native/factory.dart';
@@ -110,12 +111,13 @@ mixin SentryFlutter {
       options.addScopeObserver(NativeScopeObserver(_native!));
     }
 
-    var flutterEventProcessor = FlutterEnricherEventProcessor(options);
-    options.addEventProcessor(flutterEventProcessor);
+    options.addEventProcessor(FlutterEnricherEventProcessor(options));
+    options.addEventProcessor(WidgetEventProcessor());
 
     if (options.platformChecker.platform.isAndroid) {
-      options
-          .addEventProcessor(AndroidPlatformExceptionEventProcessor(options));
+      options.addEventProcessor(
+        AndroidPlatformExceptionEventProcessor(options),
+      );
     }
 
     options.addEventProcessor(PlatformExceptionEventProcessor());

flutter/lib/src/sentry_widget.dart

@@ -1,6 +1,11 @@
 import 'package:flutter/cupertino.dart';
+import 'package:meta/meta.dart';
 import '../sentry_flutter.dart';
 
+/// Key which is used to identify the [SentryWidget]
+@internal
+final sentryWidgetGlobalKey = GlobalKey(debugLabel: 'sentry_widget');
+
 /// This widget serves as a wrapper to include Sentry widgets such
 /// as [SentryScreenshotWidget] and [SentryUserInteractionWidget].
 class SentryWidget extends StatefulWidget {
@@ -18,6 +23,9 @@ class _SentryWidgetState extends State<SentryWidget> {
     Widget content = widget.child;
     content = SentryScreenshotWidget(child: content);
     content = SentryUserInteractionWidget(child: content);
-    return content;
+    return Container(
+      key: sentryWidgetGlobalKey,
+      child: content,
+    );
   }
 }

flutter/test/event_processor/flutter_enricher_event_processor_test.dart

@@ -138,30 +138,6 @@ void main() {
       expect(event?.contexts.culture?.locale, 'de-DE');
     });
 
-    testWidgets(
-        'GIVEN MaterialApp WHEN setting sentryNavigatorKey THEN enrich event app with textScale',
-        (WidgetTester tester) async {
-      GlobalKey<NavigatorState> navigatorKey = GlobalKey<NavigatorState>();
-
-      await tester.pumpWidget(MaterialApp(
-        navigatorKey: navigatorKey,
-        home: Material(),
-      ));
-
-      final enricher = fixture.getSut(
-        binding: () => tester.binding,
-        optionsBuilder: (options) {
-          options.navigatorKey = navigatorKey;
-          return options;
-        },
-      );
-
-      tester.binding.handleAppLifecycleStateChanged(AppLifecycleState.resumed);
-      final event = await enricher.apply(SentryEvent());
-
-      expect(event?.contexts.app?.textScale, 'no scaling');
-    });
-
     testWidgets('app context in foreground', (WidgetTester tester) async {
       final enricher = fixture.getSut(
         binding: () => tester.binding,

flutter/test/event_processor/widget_event_processor_test.dart

@@ -0,0 +1,44 @@
+import 'package:flutter/widgets.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:sentry_flutter/sentry_flutter.dart';
+import 'package:sentry_flutter/src/event_processor/widget_event_processor.dart';
+
+void main() {
+  TestWidgetsFlutterBinding.ensureInitialized();
+  late Fixture fixture;
+
+  setUp(() {
+    fixture = Fixture();
+  });
+
+  testWidgets('adds screenshot attachment dart:io', (tester) async {
+    await tester.runAsync(() async {
+      final sut = fixture.getSut();
+      await tester.pumpWidget(
+        SentryWidget(
+          child: Text(
+            'Catching Pokémon is a snap!',
+            textDirection: TextDirection.ltr,
+          ),
+        ),
+      );
+
+      final throwable = Exception();
+      SentryEvent? event = SentryEvent(throwable: throwable);
+      event = event.copyWith(
+        contexts: event.contexts.copyWith(
+          app: SentryApp(),
+        ),
+      );
+      event = await sut.apply(event);
+
+      expect(event?.contexts.app?.textScale, 'no scaling');
+    });
+  });
+}
+
+class Fixture {
+  WidgetEventProcessor getSut() {
+    return WidgetEventProcessor();
+  }
+}