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

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Features
+
+- Add `SentryNavigatorObserver` current route to `event.app.contexts.viewNames` ([#1545](https://github.com/getsentry/sentry-dart/pull/1545))
+
 ### Fixes
 
 - Normalize data properties of `SentryUser` and `Breadcrumb` before sending over method channel ([#1591](https://github.com/getsentry/sentry-dart/pull/1591))

dart/lib/src/protocol/sentry_app.dart

@@ -18,6 +18,7 @@ class SentryApp {
     this.deviceAppHash,
     this.appMemory,
     this.inForeground,
+    this.viewNames,
   });
 
   /// Human readable application name, as it appears on the platform.
@@ -48,20 +49,27 @@ class SentryApp {
   /// An app is in foreground when it's visible to the user.
   final bool? inForeground;
 
+  /// The names of the currently visible views.
+  final List<String>? viewNames;
+
   /// Deserializes a [SentryApp] from JSON [Map].
-  factory SentryApp.fromJson(Map<String, dynamic> data) => SentryApp(
-        name: data['app_name'],
-        version: data['app_version'],
-        identifier: data['app_identifier'],
-        build: data['app_build'],
-        buildType: data['build_type'],
-        startTime: data['app_start_time'] != null
-            ? DateTime.tryParse(data['app_start_time'])
-            : null,
-        deviceAppHash: data['device_app_hash'],
-        appMemory: data['app_memory'],
-        inForeground: data['in_foreground'],
-      );
+  factory SentryApp.fromJson(Map<String, dynamic> data) {
+    final viewNamesJson = data['view_names'] as List<dynamic>?;
+    return SentryApp(
+      name: data['app_name'],
+      version: data['app_version'],
+      identifier: data['app_identifier'],
+      build: data['app_build'],
+      buildType: data['build_type'],
+      startTime: data['app_start_time'] != null
+          ? DateTime.tryParse(data['app_start_time'])
+          : null,
+      deviceAppHash: data['device_app_hash'],
+      appMemory: data['app_memory'],
+      inForeground: data['in_foreground'],
+      viewNames: viewNamesJson?.map((e) => e as String).toList(),
+    );
+  }
 
   /// Produces a [Map] that can be serialized to JSON.
   Map<String, dynamic> toJson() {
@@ -71,10 +79,11 @@ class SentryApp {
       if (identifier != null) 'app_identifier': identifier!,
       if (build != null) 'app_build': build!,
       if (buildType != null) 'build_type': buildType!,
+      if (startTime != null) 'app_start_time': startTime!.toIso8601String(),
       if (deviceAppHash != null) 'device_app_hash': deviceAppHash!,
       if (appMemory != null) 'app_memory': appMemory!,
-      if (startTime != null) 'app_start_time': startTime!.toIso8601String(),
       if (inForeground != null) 'in_foreground': inForeground!,
+      if (viewNames != null && viewNames!.isNotEmpty) 'view_names': viewNames!,
     };
   }
 
@@ -88,6 +97,7 @@ class SentryApp {
         deviceAppHash: deviceAppHash,
         appMemory: appMemory,
         inForeground: inForeground,
+        viewNames: viewNames,
       );
 
   SentryApp copyWith({
@@ -100,6 +110,7 @@ class SentryApp {
     String? deviceAppHash,
     int? appMemory,
     bool? inForeground,
+    List<String>? viewNames,
   }) =>
       SentryApp(
         name: name ?? this.name,
@@ -111,5 +122,6 @@ class SentryApp {
         deviceAppHash: deviceAppHash ?? this.deviceAppHash,
         appMemory: appMemory ?? this.appMemory,
         inForeground: inForeground ?? this.inForeground,
+        viewNames: viewNames ?? this.viewNames,
       );
 }

dart/test/protocol/sentry_app_test.dart

@@ -14,6 +14,7 @@ void main() {
     startTime: testStartTime,
     deviceAppHash: 'fixture-deviceAppHash',
     inForeground: true,
+    viewNames: ['fixture-viewName', 'fixture-viewName2'],
   );
 
   final sentryAppJson = <String, dynamic>{
@@ -25,25 +26,36 @@ void main() {
     'app_start_time': testStartTime.toIso8601String(),
     'device_app_hash': 'fixture-deviceAppHash',
     'in_foreground': true,
+    'view_names': ['fixture-viewName', 'fixture-viewName2'],
   };
 
   group('json', () {
     test('toJson', () {
       final json = sentryApp.toJson();
 
-      expect(
-        MapEquality().equals(sentryAppJson, json),
-        true,
-      );
+      expect(json['app_name'], 'fixture-name');
+      expect(json['app_version'], 'fixture-version');
+      expect(json['app_identifier'], 'fixture-identifier');
+      expect(json['app_build'], 'fixture-build');
+      expect(json['build_type'], 'fixture-buildType');
+      expect(json['app_start_time'], testStartTime.toIso8601String());
+      expect(json['device_app_hash'], 'fixture-deviceAppHash');
+      expect(json['in_foreground'], true);
+      expect(json['view_names'], ['fixture-viewName', 'fixture-viewName2']);
     });
     test('fromJson', () {
       final sentryApp = SentryApp.fromJson(sentryAppJson);
       final json = sentryApp.toJson();
 
-      expect(
-        MapEquality().equals(sentryAppJson, json),
-        true,
-      );
+      expect(json['app_name'], 'fixture-name');
+      expect(json['app_version'], 'fixture-version');
+      expect(json['app_identifier'], 'fixture-identifier');
+      expect(json['app_build'], 'fixture-build');
+      expect(json['build_type'], 'fixture-buildType');
+      expect(json['app_start_time'], testStartTime.toIso8601String());
+      expect(json['device_app_hash'], 'fixture-deviceAppHash');
+      expect(json['in_foreground'], true);
+      expect(json['view_names'], ['fixture-viewName', 'fixture-viewName2']);
     });
   });
 
@@ -73,6 +85,7 @@ void main() {
         startTime: startTime,
         deviceAppHash: 'hash1',
         inForeground: true,
+        viewNames: ['screen1'],
       );
 
       expect('name1', copy.name);
@@ -83,6 +96,7 @@ void main() {
       expect(startTime, copy.startTime);
       expect('hash1', copy.deviceAppHash);
       expect(true, copy.inForeground);
+      expect(['screen1'], copy.viewNames);
     });
   });
 }

dio/test/dio_event_processor_test.dart

@@ -67,7 +67,7 @@ void main() {
         throwable: throwable,
         exceptions: [
           fixture.sentryError(throwable),
-          fixture.sentryError(dioError)
+          fixture.sentryError(dioError),
         ],
       );
       final processedEvent = sut.apply(event) as SentryEvent;
@@ -96,7 +96,7 @@ void main() {
         throwable: throwable,
         exceptions: [
           fixture.sentryError(throwable),
-          fixture.sentryError(dioError)
+          fixture.sentryError(dioError),
         ],
       );
       final processedEvent = sut.apply(event) as SentryEvent;
@@ -125,7 +125,7 @@ void main() {
         throwable: throwable,
         exceptions: [
           fixture.sentryError(throwable),
-          fixture.sentryError(dioError)
+          fixture.sentryError(dioError),
         ],
       );
       final processedEvent = sut.apply(event) as SentryEvent;
@@ -177,7 +177,7 @@ void main() {
           throwable: throwable,
           exceptions: [
             fixture.sentryError(throwable),
-            fixture.sentryError(dioError)
+            fixture.sentryError(dioError),
           ],
         );
         final processedEvent = sut.apply(event) as SentryEvent;
@@ -207,7 +207,7 @@ void main() {
           data: 'foobar',
           headers: Headers.fromMap(<String, List<String>>{
             'foo': ['bar'],
-            'set-cookie': ['foo=bar']
+            'set-cookie': ['foo=bar'],
           }),
           requestOptions: request,
           isRedirect: true,
@@ -219,7 +219,7 @@ void main() {
         throwable: throwable,
         exceptions: [
           fixture.sentryError(throwable),
-          fixture.sentryError(dioError)
+          fixture.sentryError(dioError),
         ],
       );
       final processedEvent = sut.apply(event) as SentryEvent;
@@ -248,7 +248,7 @@ void main() {
         response: Response<dynamic>(
           data: 'foobar',
           headers: Headers.fromMap(<String, List<String>>{
-            'foo': ['bar']
+            'foo': ['bar'],
           }),
           requestOptions: request,
           isRedirect: true,
@@ -260,7 +260,7 @@ void main() {
         throwable: throwable,
         exceptions: [
           fixture.sentryError(throwable),
-          fixture.sentryError(dioError)
+          fixture.sentryError(dioError),
         ],
       );
       final processedEvent = sut.apply(event) as SentryEvent;
@@ -320,7 +320,7 @@ void main() {
           throwable: throwable,
           exceptions: [
             fixture.sentryError(throwable),
-            fixture.sentryError(dioError)
+            fixture.sentryError(dioError),
           ],
         );
         final processedEvent = sut.apply(event) as SentryEvent;
@@ -338,7 +338,7 @@ void main() {
       final dataByType = {
         ResponseType.plain: ['plain'],
         ResponseType.bytes: [
-          [1337]
+          [1337],
         ],
         ResponseType.json: [
           9001,
@@ -347,7 +347,7 @@ void main() {
           true,
           ['list'],
           {'map-key': 'map-value'},
-        ]
+        ],
       };
 
       for (final entry in dataByType.entries) {
@@ -375,7 +375,7 @@ void main() {
             throwable: throwable,
             exceptions: [
               fixture.sentryError(throwable),
-              fixture.sentryError(dioError)
+              fixture.sentryError(dioError),
             ],
           );
           final processedEvent = sut.apply(event) as SentryEvent;

dio/test/failed_request_interceptor_test.dart

@@ -113,7 +113,7 @@ class Fixture {
 
   FailedRequestInterceptor getSut({
     List<SentryStatusCode> failedRequestStatusCodes = const [
-      SentryStatusCode.defaultRange()
+      SentryStatusCode.defaultRange(),
     ],
     List<String> failedRequestTargets = const ['.*'],
   }) {

dio/test/mocks.dart

@@ -42,7 +42,7 @@ final fakeEvent = SentryEvent(
       type: 'navigation',
       data: <String, dynamic>{'screen': 'MainActivity', 'state': 'created'},
       level: SentryLevel.info,
-    )
+    ),
   ],
   contexts: Contexts(
     operatingSystem: const SentryOperatingSystem(

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,13 @@ class FlutterEnricherEventProcessor implements EventProcessor {
       inForeground: inForeground,
     );
   }
+
+  void _getAppScreen(Contexts contexts, SentryApp app) {
+    final currentRouteName = SentryNavigatorObserver.currentRouteName;
+    if (currentRouteName != null) {
+      final viewNames = app.viewNames ?? [];
+      viewNames.add(currentRouteName);
+      contexts.app = app.copyWith(viewNames: viewNames);
+    }
+  }
 }

flutter/lib/src/navigation/sentry_navigator_observer.dart

@@ -23,6 +23,9 @@ typedef AdditionalInfoExtractor = Map<String, dynamic>? Function(
 /// The [RouteSettings] is null if a developer has not specified any
 /// RouteSettings.
 ///
+/// The current route name will also be set to [SentryEvent]
+/// `contexts.app.view_names` by [FlutterEnricherEventProcessor].
+///
 /// [SentryNavigatorObserver] must be added to the [navigation observer](https://api.flutter.dev/flutter/material/MaterialApp/navigatorObservers.html) of
 /// your used app. This is an example for [MaterialApp](https://api.flutter.dev/flutter/material/MaterialApp/navigatorObservers.html),
 /// but the integration for [CupertinoApp](https://api.flutter.dev/flutter/cupertino/CupertinoApp/navigatorObservers.html)
@@ -85,6 +88,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);
@@ -204,6 +212,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?.viewNames, ['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() {