Add SentryNavigatorObserver current route to event.app.contexts.viewNames

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Unreleased
+
+- Set `SentryNavigatorObserver` current route as `event.app.contexts.screen` ([#1545](https://github.com/getsentry/sentry-dart/pull/1545))
+
 ## 7.8.0
 
 ### Enhancements

dart/lib/src/protocol/sentry_app.dart

@@ -18,6 +18,7 @@ class SentryApp {
     this.deviceAppHash,
     this.appMemory,
     this.inForeground,
+    this.screen,
   });
 
   /// Human readable application name, as it appears on the platform.
@@ -48,6 +49,9 @@ class SentryApp {
   /// An app is in foreground when it's visible to the user.
   final bool? inForeground;
 
+  /// The current application screen.
+  final String? screen;
+
   /// Deserializes a [SentryApp] from JSON [Map].
   factory SentryApp.fromJson(Map<String, dynamic> data) => SentryApp(
         name: data['app_name'],
@@ -61,6 +65,7 @@ class SentryApp {
         deviceAppHash: data['device_app_hash'],
         appMemory: data['app_memory'],
         inForeground: data['in_foreground'],
+        screen: data['screen'],
       );
 
   /// Produces a [Map] that can be serialized to JSON.
@@ -75,6 +80,7 @@ class SentryApp {
       if (appMemory != null) 'app_memory': appMemory!,
       if (startTime != null) 'app_start_time': startTime!.toIso8601String(),
       if (inForeground != null) 'in_foreground': inForeground!,
+      if (screen != null) 'screen': screen!
     };
   }
 
@@ -88,6 +94,7 @@ class SentryApp {
         deviceAppHash: deviceAppHash,
         appMemory: appMemory,
         inForeground: inForeground,
+        screen: screen,
       );
 
   SentryApp copyWith({
@@ -100,6 +107,7 @@ class SentryApp {
     String? deviceAppHash,
     int? appMemory,
     bool? inForeground,
+    String? screen,
   }) =>
       SentryApp(
         name: name ?? this.name,
@@ -111,5 +119,6 @@ class SentryApp {
         deviceAppHash: deviceAppHash ?? this.deviceAppHash,
         appMemory: appMemory ?? this.appMemory,
         inForeground: inForeground ?? this.inForeground,
+        screen: screen ?? this.screen,
       );
 }

dart/test/protocol/sentry_app_test.dart

@@ -6,15 +6,15 @@ void main() {
   final testStartTime = DateTime.fromMicrosecondsSinceEpoch(0);
 
   final sentryApp = SentryApp(
-    name: 'fixture-name',
-    version: 'fixture-version',
-    identifier: 'fixture-identifier',
-    build: 'fixture-build',
-    buildType: 'fixture-buildType',
-    startTime: testStartTime,
-    deviceAppHash: 'fixture-deviceAppHash',
-    inForeground: true,
-  );
+      name: 'fixture-name',
+      version: 'fixture-version',
+      identifier: 'fixture-identifier',
+      build: 'fixture-build',
+      buildType: 'fixture-buildType',
+      startTime: testStartTime,
+      deviceAppHash: 'fixture-deviceAppHash',
+      inForeground: true,
+      screen: 'fixture-screen');
 
   final sentryAppJson = <String, dynamic>{
     'app_name': 'fixture-name',
@@ -25,6 +25,7 @@ void main() {
     'app_start_time': testStartTime.toIso8601String(),
     'device_app_hash': 'fixture-deviceAppHash',
     'in_foreground': true,
+    'screen': 'fixture-screen',
   };
 
   group('json', () {
@@ -73,6 +74,7 @@ void main() {
         startTime: startTime,
         deviceAppHash: 'hash1',
         inForeground: true,
+        screen: 'screen1',
       );
 
       expect('name1', copy.name);
@@ -83,6 +85,7 @@ void main() {
       expect(startTime, copy.startTime);
       expect('hash1', copy.deviceAppHash);
       expect(true, copy.inForeground);
+      expect('screen1', copy.screen);
     });
   });
 }

flutter/lib/src/event_processor/flutter_enricher_event_processor.dart

@@ -5,6 +5,7 @@ import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 import 'package:sentry/sentry.dart';
 
+import '../navigation/sentry_navigator_observer.dart';
 import '../sentry_flutter_options.dart';
 
 typedef WidgetBindingGetter = WidgetsBinding? Function();
@@ -47,6 +48,11 @@ class FlutterEnricherEventProcessor implements EventProcessor {
       app: _getApp(event.contexts.app),
     );
 
+    final app = contexts.app;
+    if (app != null) {
+      _getAppScreen(contexts, app);
+    }
+
     // Flutter has a lot of Accessibility Settings available and exposes them
     contexts['accessibility'] = _getAccessibilityContext();
 
@@ -237,4 +243,11 @@ class FlutterEnricherEventProcessor implements EventProcessor {
       inForeground: inForeground,
     );
   }
+
+  void _getAppScreen(Contexts contexts, SentryApp app) {
+    final currentRouteName = SentryNavigatorObserver.currentRouteName;
+    if (currentRouteName != null) {
+      contexts.app = app.copyWith(screen: currentRouteName);
+    }
+  }
 }

flutter/lib/src/navigation/sentry_navigator_observer.dart

@@ -85,6 +85,11 @@ class SentryNavigatorObserver extends RouteObserver<PageRoute<dynamic>> {
 
   ISentrySpan? _transaction;
 
+  static String? _currentRouteName;
+
+  /// Get the current route of the observer.
+  static String? get currentRouteName => _currentRouteName;
+
   @override
   void didPush(Route<dynamic> route, Route<dynamic>? previousRoute) {
     super.didPush(route, previousRoute);
@@ -201,6 +206,7 @@ class SentryNavigatorObserver extends RouteObserver<PageRoute<dynamic>> {
         }
       },
     );
+    _currentRouteName = name;
 
     // if _enableAutoTransactions is enabled but there's no traces sample rate
     if (_transaction is NoOpSentrySpan) {

flutter/test/event_processor/flutter_enricher_event_processor_test.dart

@@ -322,6 +322,24 @@ void main() {
           .length;
       expect(ioEnricherCount, 1);
     });
+
+    testWidgets('adds SentryNavigatorObserver.currentRouteName as app.screen',
+        (tester) async {
+      final observer = SentryNavigatorObserver();
+      final route =
+          fixture.route(RouteSettings(name: 'fixture-currentRouteName'));
+      observer.didPush(route, null);
+
+      final eventWithContextsApp =
+          SentryEvent(contexts: Contexts(app: SentryApp()));
+
+      final enricher = fixture.getSut(
+        binding: () => tester.binding,
+      );
+      final event = await enricher.apply(eventWithContextsApp);
+
+      expect(event?.contexts.app?.screen, 'fixture-currentRouteName');
+    });
   });
 }
 
@@ -342,6 +360,11 @@ class Fixture {
     )..reportPackages = reportPackages;
     return FlutterEnricherEventProcessor(options);
   }
+
+  PageRoute<dynamic> route(RouteSettings? settings) => PageRouteBuilder<void>(
+        pageBuilder: (_, __, ___) => Container(),
+        settings: settings,
+      );
 }
 
 void loadTestPackage() {

flutter/test/sentry_navigator_observer_test.dart

@@ -368,6 +368,26 @@ void main() {
         expect(scope.span, span);
       });
     });
+
+    test('exposes current route name', () {
+      const name = 'Current Route';
+      final currentRoute = route(RouteSettings(name: name));
+
+      const op = 'navigation';
+      final hub = _MockHub();
+      final span = getMockSentryTracer(name: name);
+      when(span.context).thenReturn(SentrySpanContext(operation: op));
+      _whenAnyStart(hub, span);
+
+      final sut = fixture.getSut(
+        hub: hub,
+        autoFinishAfter: Duration(seconds: 5),
+      );
+
+      sut.didPush(currentRoute, null);
+
+      expect(SentryNavigatorObserver.currentRouteName, 'Current Route');
+    });
   });
 
   group('RouteObserverBreadcrumb', () {