Flutter replay for Android

CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 8.6.0-alpha.2
+
+### Features
+
+- Android Session Replay Alpha ([#2032](https://github.com/getsentry/sentry-dart/pull/2032))
+
+  To try out replay, you can set following options:
+
+  ```dart
+  await SentryFlutter.init(
+    (options) {
+      ...
+      options.experimental.replay.sessionSampleRate = 1.0;
+      options.experimental.replay.errorSampleRate = 1.0;
+    },
+    appRunner: () => runApp(MyApp()),
+  );
+  ```
+
+  Access is limited to early access orgs on Sentry. If you're interested, [sign up for the waitlist](https://sentry.io/lp/mobile-replay-beta/)
+
 ## Unreleased 
 
 ### Improvements
@@ -50,11 +71,11 @@ SentryFlutter.init((options) =>
   - This allows viewing the correct dart formatted raw stacktrace in the Sentry UI
 - Support `ignoredExceptionsForType` ([#2150](https://github.com/getsentry/sentry-dart/pull/2150))
   - Filter out exception types by calling `SentryOptions.addExceptionFilterForType(Type exceptionType)`
-  
+
 ### Fixes
 
 - Disable sff & frame delay detection on web, linux and windows ([#2182](https://github.com/getsentry/sentry-dart/pull/2182))
-  - Display refresh rate is locked at 60 for these platforms which can lead to inaccurate metrics 
+  - Display refresh rate is locked at 60 for these platforms which can lead to inaccurate metrics
 
 ### Improvements
 

dart/lib/src/protocol/breadcrumb.dart

@@ -50,6 +50,10 @@ class Breadcrumb {
     String? httpQuery,
     String? httpFragment,
   }) {
+    // The timestamp is used as the request-end time, so we need to set it right
+    // now and not rely on the default constructor.
+    timestamp ??= getUtcDateTime();
+
     return Breadcrumb(
       type: 'http',
       category: 'http',
@@ -65,6 +69,11 @@ class Breadcrumb {
         if (responseBodySize != null) 'response_body_size': responseBodySize,
         if (httpQuery != null) 'http.query': httpQuery,
         if (httpFragment != null) 'http.fragment': httpFragment,
+        if (requestDuration != null)
+          'start_timestamp':
+              timestamp.millisecondsSinceEpoch - requestDuration.inMilliseconds,
+        if (requestDuration != null)
+          'end_timestamp': timestamp.millisecondsSinceEpoch,
       },
     );
   }
@@ -95,11 +104,32 @@ class Breadcrumb {
     String? viewClass,
   }) {
     final newData = data ?? {};
+    var path = '';
+
     if (viewId != null) {
       newData['view.id'] = viewId;
+      path = viewId;
+    }
+
+    if (newData.containsKey('label')) {
+      if (path.isEmpty) {
+        path = newData['label'];
+      } else {
+        path = "$path, label: ${newData['label']}";
+      }
     }
+
     if (viewClass != null) {
       newData['view.class'] = viewClass;
+      if (path.isEmpty) {
+        path = viewClass;
+      } else {
+        path = "$viewClass($path)";
+      }
+    }
+
+    if (path.isNotEmpty && !newData.containsKey('path')) {
+      newData['path'] = path;
     }
 
     return Breadcrumb(

dart/lib/src/protocol/sentry_trace_context.dart

@@ -17,6 +17,9 @@ class SentryTraceContext {
   /// Id of a parent span
   final SpanId? parentSpanId;
 
+  /// Replay associated with this trace.
+  final SentryId? replayId;
+
   /// Whether the span is sampled or not
   final bool? sampled;
 
@@ -45,6 +48,9 @@ class SentryTraceContext {
           ? null
           : SpanId.fromId(json['parent_span_id'] as String),
       traceId: SentryId.fromId(json['trace_id'] as String),
+      replayId: json['replay_id'] == null
+          ? null
+          : SentryId.fromId(json['replay_id'] as String),
       description: json['description'] as String?,
       status: json['status'] == null
           ? null
@@ -61,6 +67,7 @@ class SentryTraceContext {
       'trace_id': traceId.toString(),
       'op': operation,
       if (parentSpanId != null) 'parent_span_id': parentSpanId!.toString(),
+      if (replayId != null) 'replay_id': replayId!.toString(),
       if (description != null) 'description': description,
       if (status != null) 'status': status!.toString(),
       if (origin != null) 'origin': origin,
@@ -76,6 +83,7 @@ class SentryTraceContext {
         parentSpanId: parentSpanId,
         sampled: sampled,
         origin: origin,
+        replayId: replayId,
       );
 
   SentryTraceContext({
@@ -87,16 +95,17 @@ class SentryTraceContext {
     this.description,
     this.status,
     this.origin,
+    this.replayId,
   })  : traceId = traceId ?? SentryId.newId(),
         spanId = spanId ?? SpanId.newId();
 
   @internal
   factory SentryTraceContext.fromPropagationContext(
       PropagationContext propagationContext) {
     return SentryTraceContext(
-      traceId: propagationContext.traceId,
-      spanId: propagationContext.spanId,
-      operation: 'default',
-    );
+        traceId: propagationContext.traceId,
+        spanId: propagationContext.spanId,
+        operation: 'default',
+        replayId: propagationContext.baggage?.getReplayId());
   }
 }

dart/lib/src/scope.dart

@@ -97,6 +97,13 @@ class Scope {
   /// they must be JSON-serializable.
   Map<String, dynamic> get extra => Map.unmodifiable(_extra);
 
+  /// Active replay recording.
+  @internal
+  SentryId? get replayId => _replayId;
+  @internal
+  set replayId(SentryId? value) => _replayId = value;
+  SentryId? _replayId;
+
   final Contexts _contexts = Contexts();
 
   /// Unmodifiable map of the scope contexts key/value
@@ -237,6 +244,7 @@ class Scope {
     _tags.clear();
     _extra.clear();
     _eventProcessors.clear();
+    _replayId = null;
 
     _clearBreadcrumbsSync();
     _setUserSync(null);
@@ -429,7 +437,8 @@ class Scope {
       ..fingerprint = List.from(fingerprint)
       .._transaction = _transaction
       ..span = span
-      .._enableScopeSync = false;
+      .._enableScopeSync = false
+      .._replayId = _replayId;
 
     clone._setUserSync(user);
 

dart/lib/src/sentry_baggage.dart

@@ -111,6 +111,9 @@ class SentryBaggage {
       // ignore: deprecated_member_use_from_same_package
       setUserSegment(scope.user!.segment!);
     }
+    if (scope.replayId != null && scope.replayId != SentryId.empty()) {
+      setReplayId(scope.replayId.toString());
+    }
   }
 
   static Map<String, String> _extractKeyValuesFromBaggageString(
@@ -205,5 +208,12 @@ class SentryBaggage {
     return double.tryParse(sampleRate);
   }
 
+  void setReplayId(String value) => set('sentry-replay_id', value);
+
+  SentryId? getReplayId() {
+    final replayId = get('sentry-replay_id');
+    return replayId == null ? null : SentryId.fromId(replayId);
+  }
+
   Map<String, String> get keyValues => Map.unmodifiable(_keyValues);
 }

dart/lib/src/sentry_client.dart

@@ -157,15 +157,15 @@ class SentryClient {
 
     var traceContext = scope?.span?.traceContext();
     if (traceContext == null) {
-      if (scope?.propagationContext.baggage == null) {
-        scope?.propagationContext.baggage =
-            SentryBaggage({}, logger: _options.logger);
-        scope?.propagationContext.baggage?.setValuesFromScope(scope, _options);
-      }
       if (scope != null) {
+        scope.propagationContext.baggage ??=
+            SentryBaggage({}, logger: _options.logger)
+              ..setValuesFromScope(scope, _options);
         traceContext = SentryTraceContextHeader.fromBaggage(
             scope.propagationContext.baggage!);
       }
+    } else {
+      traceContext.replayId = scope?.replayId;
     }
 
     final envelope = SentryEnvelope.fromEvent(

dart/lib/src/sentry_trace_context_header.dart

@@ -1,3 +1,5 @@
+import 'package:meta/meta.dart';
+
 import 'protocol/sentry_id.dart';
 import 'sentry_baggage.dart';
 import 'sentry_options.dart';
@@ -13,6 +15,7 @@ class SentryTraceContextHeader {
     this.transaction,
     this.sampleRate,
     this.sampled,
+    this.replayId,
   });
 
   final SentryId traceId;
@@ -27,6 +30,9 @@ class SentryTraceContextHeader {
   final String? sampleRate;
   final String? sampled;
 
+  @internal
+  SentryId? replayId;
+
   /// Deserializes a [SentryTraceContextHeader] from JSON [Map].
   factory SentryTraceContextHeader.fromJson(Map<String, dynamic> json) {
     return SentryTraceContextHeader(
@@ -39,6 +45,8 @@ class SentryTraceContextHeader {
       transaction: json['transaction'],
       sampleRate: json['sample_rate'],
       sampled: json['sampled'],
+      replayId:
+          json['replay_id'] == null ? null : SentryId.fromId(json['replay_id']),
     );
   }
 
@@ -55,6 +63,7 @@ class SentryTraceContextHeader {
       if (transaction != null) 'transaction': transaction,
       if (sampleRate != null) 'sample_rate': sampleRate,
       if (sampled != null) 'sampled': sampled,
+      if (replayId != null) 'replay_id': replayId.toString(),
     };
   }
 
@@ -88,6 +97,9 @@ class SentryTraceContextHeader {
     if (sampled != null) {
       baggage.setSampled(sampled!);
     }
+    if (replayId != null) {
+      baggage.setReplayId(replayId.toString());
+    }
     return baggage;
   }
 
@@ -97,6 +109,7 @@ class SentryTraceContextHeader {
       baggage.get('sentry-public_key').toString(),
       release: baggage.get('sentry-release'),
       environment: baggage.get('sentry-environment'),
+      replayId: baggage.getReplayId(),
     );
   }
 }

dart/lib/src/version.dart

@@ -9,7 +9,7 @@
 library version;
 
 /// The SDK version reported to Sentry.io in the submitted events.
-const String sdkVersion = '8.5.0';
+const String sdkVersion = '8.6.0-alpha.2';
 
 String sdkName(bool isWeb) => isWeb ? _browserSdkName : _ioSdkName;
 

dart/pubspec.yaml

@@ -1,5 +1,5 @@
 name: sentry
-version: 8.5.0
+version: 8.6.0-alpha.2
 description: >
   A crash reporting library for Dart that sends crash reports to Sentry.io.
   This library supports Dart VM and Web. For Flutter consider sentry_flutter instead.

dart/test/protocol/breadcrumb_test.dart

@@ -86,7 +86,7 @@ void main() {
           level: SentryLevel.fatal,
           reason: 'OK',
           statusCode: 200,
-          requestDuration: Duration.zero,
+          requestDuration: Duration(milliseconds: 55),
           timestamp: DateTime.now(),
           requestBodySize: 2,
           responseBodySize: 3,
@@ -103,17 +103,43 @@ void main() {
           'method': 'GET',
           'status_code': 200,
           'reason': 'OK',
-          'duration': '0:00:00.000000',
+          'duration': '0:00:00.055000',
           'request_body_size': 2,
           'response_body_size': 3,
           'http.query': 'foo=bar',
-          'http.fragment': 'baz'
+          'http.fragment': 'baz',
+          'start_timestamp': breadcrumb.timestamp.millisecondsSinceEpoch - 55,
+          'end_timestamp': breadcrumb.timestamp.millisecondsSinceEpoch
         },
         'level': 'fatal',
         'type': 'http',
       });
     });
 
+    test('Breadcrumb http', () {
+      final breadcrumb = Breadcrumb.http(
+        url: Uri.parse('https://example.org'),
+        method: 'GET',
+        requestDuration: Duration(milliseconds: 10),
+      );
+      final json = breadcrumb.toJson();
+
+      expect(json, {
+        'timestamp':
+            formatDateAsIso8601WithMillisPrecision(breadcrumb.timestamp),
+        'category': 'http',
+        'data': {
+          'url': 'https://example.org',
+          'method': 'GET',
+          'duration': '0:00:00.010000',
+          'start_timestamp': breadcrumb.timestamp.millisecondsSinceEpoch - 10,
+          'end_timestamp': breadcrumb.timestamp.millisecondsSinceEpoch
+        },
+        'level': 'info',
+        'type': 'http',
+      });
+    });
+
     test('Minimal Breadcrumb http', () {
       final breadcrumb = Breadcrumb.http(
         url: Uri.parse('https://example.org'),
@@ -192,6 +218,7 @@ void main() {
           'foo': 'bar',
           'view.id': 'foo',
           'view.class': 'bar',
+          'path': 'bar(foo)',
         },
       });
     });

dart/test/protocol/sentry_baggage_header_test.dart

@@ -22,11 +22,23 @@ void main() {
       baggage.setTransaction('transaction');
       baggage.setSampleRate('1.0');
       baggage.setSampled('false');
+      final replayId = SentryId.newId().toString();
+      baggage.setReplayId(replayId);
 
       final baggageHeader = SentryBaggageHeader.fromBaggage(baggage);
 
-      expect(baggageHeader.value,
-          'sentry-trace_id=$id,sentry-public_key=publicKey,sentry-release=release,sentry-environment=environment,sentry-user_id=userId,sentry-user_segment=userSegment,sentry-transaction=transaction,sentry-sample_rate=1.0,sentry-sampled=false');
+      expect(
+          baggageHeader.value,
+          'sentry-trace_id=$id,'
+          'sentry-public_key=publicKey,'
+          'sentry-release=release,'
+          'sentry-environment=environment,'
+          'sentry-user_id=userId,'
+          'sentry-user_segment=userSegment,'
+          'sentry-transaction=transaction,'
+          'sentry-sample_rate=1.0,'
+          'sentry-sampled=false,'
+          'sentry-replay_id=$replayId');
     });
   });
 }