Auto Transactions

CHANGELOG.md

@@ -1,5 +1,6 @@
 # Unreleased
 
+* Feat: Automatically create transactions when navigating between screens (#643)
 # 6.2.2
 
 * Fix: ConcurrentModificationError in when finishing span (#664)

dart/lib/src/hub.dart

@@ -3,7 +3,6 @@ import 'dart:collection';
 
 import 'package:meta/meta.dart';
 
-import 'noop_sentry_span.dart';
 import 'protocol.dart';
 import 'scope.dart';
 import 'sentry_client.dart';
@@ -340,6 +339,8 @@ class Hub {
     String operation, {
     String? description,
     bool? bindToScope,
+    bool? waitForChildren,
+    Duration? autoFinishAfter,
     Map<String, dynamic>? customSamplingContext,
   }) =>
       startTransactionWithContext(
@@ -349,6 +350,8 @@ class Hub {
           description: description,
         ),
         bindToScope: bindToScope,
+        waitForChildren: waitForChildren,
+        autoFinishAfter: autoFinishAfter,
         customSamplingContext: customSamplingContext,
       );
 
@@ -357,6 +360,8 @@ class Hub {
     SentryTransactionContext transactionContext, {
     Map<String, dynamic>? customSamplingContext,
     bool? bindToScope,
+    bool? waitForChildren,
+    Duration? autoFinishAfter,
   }) {
     if (!_isEnabled) {
       _options.logger(
@@ -380,8 +385,12 @@ class Hub {
         transactionContext = transactionContext.copyWith(sampled: sampled);
       }
 
-      final tracer = SentryTracer(transactionContext, this);
-
+      final tracer = SentryTracer(
+        transactionContext,
+        this,
+        waitForChildren: waitForChildren ?? false,
+        autoFinishAfter: autoFinishAfter,
+      );
       if (bindToScope ?? false) {
         item.scope.span = tracer;
       }

dart/lib/src/hub_adapter.dart

@@ -102,11 +102,15 @@ class HubAdapter implements Hub {
     SentryTransactionContext transactionContext, {
     Map<String, dynamic>? customSamplingContext,
     bool? bindToScope,
+    bool? waitForChildren,
+    Duration? autoFinishAfter,
   }) =>
       Sentry.startTransactionWithContext(
         transactionContext,
         customSamplingContext: customSamplingContext,
         bindToScope: bindToScope,
+        waitForChildren: waitForChildren,
+        autoFinishAfter: autoFinishAfter,
       );
 
   @override
@@ -115,13 +119,17 @@ class HubAdapter implements Hub {
     String operation, {
     String? description,
     bool? bindToScope,
+    bool? waitForChildren,
+    Duration? autoFinishAfter,
     Map<String, dynamic>? customSamplingContext,
   }) =>
       Sentry.startTransaction(
         name,
         operation,
         description: description,
         bindToScope: bindToScope,
+        waitForChildren: waitForChildren,
+        autoFinishAfter: autoFinishAfter,
         customSamplingContext: customSamplingContext,
       );
 

dart/lib/src/noop_hub.dart

@@ -4,7 +4,6 @@ import 'protocol.dart';
 import 'sentry_client.dart';
 import 'sentry_user_feedback.dart';
 import 'tracing.dart';
-import 'noop_sentry_span.dart';
 
 class NoOpHub implements Hub {
   NoOpHub._();
@@ -79,6 +78,8 @@ class NoOpHub implements Hub {
     String operation, {
     String? description,
     bool? bindToScope,
+    bool? waitForChildren,
+    Duration? autoFinishAfter,
     Map<String, dynamic>? customSamplingContext,
   }) =>
       NoOpSentrySpan();
@@ -88,6 +89,8 @@ class NoOpHub implements Hub {
     SentryTransactionContext transactionContext, {
     Map<String, dynamic>? customSamplingContext,
     bool? bindToScope,
+    bool? waitForChildren,
+    Duration? autoFinishAfter,
   }) =>
       NoOpSentrySpan();
 

dart/lib/src/protocol/breadcrumb.dart

@@ -1,7 +1,6 @@
 import 'package:meta/meta.dart';
 
 import '../utils.dart';
-import 'sentry_level.dart';
 import '../protocol.dart';
 
 /// Structed data to describe more information pior to the event captured.

dart/lib/src/protocol/sentry_span.dart

@@ -1,3 +1,5 @@
+import 'dart:async';
+
 import '../hub.dart';
 import '../protocol.dart';
 
@@ -17,6 +19,7 @@ class SentrySpan extends ISentrySpan {
 
   SpanStatus? _status;
   final Map<String, String> _tags = {};
+  void Function()? _finishedCallback;
 
   @override
   bool? sampled;
@@ -26,8 +29,10 @@ class SentrySpan extends ISentrySpan {
     this._context,
     this._hub, {
     bool? sampled,
+    Function()? finishedCallback,
   }) {
     this.sampled = sampled;
+    _finishedCallback = finishedCallback;
   }
 
   @override
@@ -45,6 +50,8 @@ class SentrySpan extends ISentrySpan {
     if (_throwable != null) {
       _hub.setSpanContext(_throwable, this, _tracer.name);
     }
+    _finishedCallback?.call();
+    await super.finish(status: status);
   }
 
   @override

dart/lib/src/protocol/sentry_transaction.dart

@@ -2,7 +2,6 @@ import 'package:meta/meta.dart';
 
 import '../protocol.dart';
 import '../sentry_tracer.dart';
-import 'sentry_span.dart';
 import '../utils.dart';
 
 @immutable

dart/lib/src/sentry.dart

@@ -229,13 +229,17 @@ class Sentry {
     String operation, {
     String? description,
     bool? bindToScope,
+    bool? waitForChildren,
+    Duration? autoFinishAfter,
     Map<String, dynamic>? customSamplingContext,
   }) =>
       _hub.startTransaction(
         name,
         operation,
         description: description,
         bindToScope: bindToScope,
+        waitForChildren: waitForChildren,
+        autoFinishAfter: autoFinishAfter,
         customSamplingContext: customSamplingContext,
       );
 
@@ -244,11 +248,15 @@ class Sentry {
     SentryTransactionContext transactionContext, {
     Map<String, dynamic>? customSamplingContext,
     bool? bindToScope,
+    bool? waitForChildren,
+    Duration? autoFinishAfter,
   }) =>
       _hub.startTransactionWithContext(
         transactionContext,
         customSamplingContext: customSamplingContext,
         bindToScope: bindToScope,
+        waitForChildren: waitForChildren,
+        autoFinishAfter: autoFinishAfter,
       );
 
   /// Gets the current active transaction or span.

dart/lib/src/sentry_envelope.dart

@@ -6,8 +6,6 @@ import 'utils.dart';
 import 'sentry_attachment/sentry_attachment.dart';
 import 'sentry_envelope_header.dart';
 import 'sentry_envelope_item.dart';
-import 'protocol/sentry_event.dart';
-import 'protocol/sdk_version.dart';
 import 'sentry_user_feedback.dart';
 
 /// Class representation of `Envelope` file.

dart/lib/src/sentry_envelope_item.dart

@@ -3,7 +3,6 @@ import 'protocol.dart';
 import 'utils.dart';
 import 'sentry_attachment/sentry_attachment.dart';
 import 'sentry_item_type.dart';
-import 'protocol/sentry_event.dart';
 import 'sentry_envelope_item_header.dart';
 import 'sentry_user_feedback.dart';
 

dart/lib/src/sentry_span_interface.dart

@@ -24,9 +24,7 @@ abstract class ISentrySpan {
   void removeData(String key);
 
   /// Sets span timestamp marking this span as finished.
-  Future<void> finish({
-    SpanStatus? status,
-  });
+  Future<void> finish({SpanStatus? status}) async {}
 
   /// Gets span status.
   SpanStatus? get status;

dart/lib/src/sentry_tracer.dart

@@ -1,52 +1,65 @@
+import 'dart:async';
+
 import 'package:meta/meta.dart';
 
 import '../sentry.dart';
+import 'sentry_tracer_finish_status.dart';
 
 @internal
 class SentryTracer extends ISentrySpan {
   final Hub _hub;
+  late bool _waitForChildren;
   late String name;
 
-  // missing waitForChildren
-
   late final SentrySpan _rootSpan;
   final List<SentrySpan> _children = [];
   final Map<String, String> _extra = {};
+  Timer? _autoFinishAfterTimer;
+  var _finishStatus = SentryTracerFinishStatus.notFinishing();
 
-  SentryTracer(SentryTransactionContext transactionContext, this._hub) {
+  SentryTracer(SentryTransactionContext transactionContext, this._hub,
+      {bool waitForChildren = false, Duration? autoFinishAfter}) {
     _rootSpan = SentrySpan(
       this,
       transactionContext,
       _hub,
       sampled: transactionContext.sampled,
     );
+    _waitForChildren = waitForChildren;
+    if (autoFinishAfter != null) {
+      _autoFinishAfterTimer = Timer(autoFinishAfter, () async {
+        await finish(status: status ?? SpanStatus.ok());
+      });
+    }
     name = transactionContext.name;
   }
 
   @override
   Future<void> finish({SpanStatus? status}) async {
-    if (finished) {
-      return;
-    }
-
-    await _rootSpan.finish(status: status);
-
-    // finish unfinished spans otherwise transaction gets dropped
-    for (final span in _children) {
-      if (!span.finished) {
-        await span.finish(status: SpanStatus.deadlineExceeded());
+    _autoFinishAfterTimer?.cancel();
+    _finishStatus = SentryTracerFinishStatus.finishing(status);
+    if (!_rootSpan.finished &&
+        (!_waitForChildren || _haveAllChildrenFinished())) {
+      _rootSpan.status ??= status;
+      await _rootSpan.finish();
+
+      // finish unfinished spans otherwise transaction gets dropped
+      for (final span in _children) {
+        if (!span.finished) {
+          await span.finish(status: SpanStatus.deadlineExceeded());
+        }
       }
-    }
 
-    // remove from scope
-    _hub.configureScope((scope) {
-      if (scope.span == this) {
-        scope.span = null;
-      }
-    });
+      // remove from scope
+      _hub.configureScope((scope) {
+        if (scope.span == this) {
+          scope.span = null;
+        }
+      });
 
-    final transaction = SentryTransaction(this);
-    await _hub.captureTransaction(transaction);
+      final transaction = SentryTransaction(this);
+      await _hub.captureTransaction(transaction);
+    }
   }
 
   @override
@@ -110,18 +123,18 @@ class SentryTracer extends ISentrySpan {
     }
 
     final context = SentrySpanContext(
-      traceId: _rootSpan.context.traceId,
-      parentSpanId: parentSpanId,
-      operation: operation,
-      description: description,
-    );
-
-    final child = SentrySpan(
-      this,
-      context,
-      _hub,
-      sampled: _rootSpan.sampled,
-    );
+        traceId: _rootSpan.context.traceId,
+        parentSpanId: parentSpanId,
+        operation: operation,
+        description: description);
+
+    final child = SentrySpan(this, context, _hub, sampled: _rootSpan.sampled,
+        finishedCallback: () {
+      final finishStatus = _finishStatus;
+      if (finishStatus.finishing) {
+        finish(status: finishStatus.status);
+      }
+    });
 
     _children.add(child);
 
@@ -163,4 +176,13 @@ class SentryTracer extends ISentrySpan {
 
   @override
   SentryTraceHeader toSentryTrace() => _rootSpan.toSentryTrace();
+
+  bool _haveAllChildrenFinished() {
+    for (final child in children) {
+      if (!child.finished) {
+        return false;
+      }
+    }
+    return true;
+  }
 }

dart/lib/src/sentry_tracer_finish_status.dart

@@ -0,0 +1,17 @@
+import 'package:meta/meta.dart';
+
+import '../sentry.dart';
+
+@internal
+class SentryTracerFinishStatus {
+  final bool finishing;
+  final SpanStatus? status;
+
+  SentryTracerFinishStatus.finishing(SpanStatus? status)
+      : finishing = true,
+        status = status;
+
+  SentryTracerFinishStatus.notFinishing()
+      : finishing = false,
+        status = null;
+}

dart/lib/src/sentry_traces_sampler.dart

@@ -3,7 +3,6 @@ import 'dart:math';
 import 'package:meta/meta.dart';
 
 import '../sentry.dart';
-import 'tracing.dart';
 
 @internal
 class SentryTracesSampler {

dart/test/contexts_test.dart

@@ -6,7 +6,6 @@ import 'dart:convert';
 
 import 'package:collection/collection.dart';
 import 'package:sentry/sentry.dart';
-import 'package:sentry/src/protocol/sentry_gpu.dart';
 import 'package:test/test.dart';
 
 void main() {