Merge branch 'main' into feat/multiview-aware

Author: denrase

.github/workflows/flutter_test.yml

@@ -173,7 +173,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Install Chrome Browser
-        uses: browser-actions/setup-chrome@facf10a55b9caf92e0cc749b4f82bf8220989148 # [email protected].2
+        uses: browser-actions/setup-chrome@c785b87e244131f27c9f19c1a33e2ead956ab7ce # [email protected].3
         with:
           chrome-version: stable
       - run: chrome --version

.github/workflows/release.yml

@@ -19,7 +19,7 @@ jobs:
     steps:
       - name: Get auth token
         id: token
-        uses: actions/create-github-app-token@c1a285145b9d317df6ced56c09f525b5c2b6f755 # v1.11.1
+        uses: actions/create-github-app-token@67e27a7eb7db372a1c61a7f9bdab8699e9ee57f7 # v1.11.3
         with:
           app-id: ${{ vars.SENTRY_RELEASE_BOT_CLIENT_ID }}
           private-key: ${{ secrets.SENTRY_RELEASE_BOT_PRIVATE_KEY }}

.github/workflows/testflight.yml

@@ -16,7 +16,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: subosito/flutter-action@f2c4f6686ca8e8d6e6d0f28410eeef506ed66aff # [email protected]
       - run: xcodes select 15.0.1
-      - uses: ruby/setup-ruby@1287d2b408066abada82d5ad1c63652e758428d9 # pin@v1.214.0
+      - uses: ruby/setup-ruby@d781c1b4ed31764801bfae177617bb0446f5ef8d # pin@v1.218.0
         with:
           ruby-version: '2.7.5'
           bundler-cache: true

CHANGELOG.md

@@ -5,12 +5,74 @@
 ### Features
 
 - Disable `ScreenshotIntegration`, `WidgetsBindingIntegration` and `SentryWidget` in multi-view apps #2366 ([#2366](https://github.com/getsentry/sentry-dart/pull/2366))
+### Other
+
+- Remove macOS display refresh rate support ([#2628](https://github.com/getsentry/sentry-dart/pull/2628))
+  - Can't reliably detect on multi-monitor systems and on older macOS versions.
+  - Not very meaningful, as other applications may be running in parallel and affecting it.
+
+### Dependencies
+
+- Bump Native SDK from v0.7.19 to v0.7.20 ([#2652](https://github.com/getsentry/sentry-dart/pull/2652))
+  - [changelog](https://github.com/getsentry/sentry-native/blob/master/CHANGELOG.md#0720)
+  - [diff](https://github.com/getsentry/sentry-native/compare/0.7.19...0.7.20)
+
+## 8.13.0
+
+### Breaking changes
+
+- Remove Metrics API ([#2571](https://github.com/getsentry/sentry-dart/pull/2571))
+  - The Metrics product never reached maturity from beta and has officially ended in October 7th, 2024
+  - Read [this post](https://sentry.zendesk.com/hc/en-us/articles/26369339769883-Metrics-Beta-Ended-on-October-7th) for more information
+
+### Features
+
+- Add `beforeCapture` for View Hierarchy ([#2523](https://github.com/getsentry/sentry-dart/pull/2523))
+  - View hierarchy calls are now debounced for 2 seconds.
+- JS SDK integration ([#2572](https://github.com/getsentry/sentry-dart/pull/2572))
+  - Enable the integration by setting `options.enableSentryJs = true`
+  - Features:
+    - Sending envelopes through Sentry JS transport layer
+    - Capturing native JS errors
+- Add SentryReplayQuality setting (`options.experimental.replay.quality`) ([#2582](https://github.com/getsentry/sentry-dart/pull/2582))
+- SPM Support ([#2280](https://github.com/getsentry/sentry-dart/pull/2280))
+
+### Enhancements
+
+- Replay: improve iOS native interop performance ([#2530](https://github.com/getsentry/sentry-dart/pull/2530), [#2573](https://github.com/getsentry/sentry-dart/pull/2573))
+- Replay: improve orientation change tracking accuracy on Android ([#2540](https://github.com/getsentry/sentry-dart/pull/2540))
+- Print a warning if the rate limit was reached ([#2595](https://github.com/getsentry/sentry-dart/pull/2595))
+- Add replay masking config to tags and report SDKs versions ([#2592](https://github.com/getsentry/sentry-dart/pull/2592))
+- Enable `options.debug` when in debug mode ([#2597](https://github.com/getsentry/sentry-dart/pull/2597))
+- Propagate sample seed in baggage header ([#2629](https://github.com/getsentry/sentry-dart/pull/2629))
+  - Read more about the specs [here](https://develop.sentry.dev/sdk/telemetry/traces/#propagated-random-value)
+- Finish and start new transaction when tapping same element again ([#2623](https://github.com/getsentry/sentry-dart/pull/2623))
+
+### Fixes
+
+- Replay: fix masking for frames captured during UI changes ([#2553](https://github.com/getsentry/sentry-dart/pull/2553), [#2657](https://github.com/getsentry/sentry-dart/pull/2657))
+- Replay: fix widget masks overlap when navigating between screens ([#2486](https://github.com/getsentry/sentry-dart/pull/2486), [#2576](https://github.com/getsentry/sentry-dart/pull/2576))
+- WASM compat for Drift ([#2580](https://github.com/getsentry/sentry-dart/pull/2580))
+- Fix image flickering when using `SentryAssetBundle` ([#2577](https://github.com/getsentry/sentry-dart/pull/2577))
+- Fix print recursion detection ([#2624](https://github.com/getsentry/sentry-dart/pull/2624))
+
+### Misc
+
+- Transfer ownership of `sentry_link` to Sentry. You can view the changelog for the previous versions [here](https://github.com/getsentry/sentry-dart/blob/main/link/CHANGELOG_OLD.md) ([#2338](https://github.com/getsentry/sentry-dart/pull/2338))
+  - No functional changes have been made. This version is identical to the previous one.
+  - Change license from Apache to MIT
 
 ### Dependencies
 
-- Bump Cocoa SDK from v8.44.0-beta.1 to v8.44.0 ([#2649](https://github.com/getsentry/sentry-dart/pull/2649))
+- Bump Native SDK from v0.7.17 to v0.7.19 ([#2578](https://github.com/getsentry/sentry-dart/pull/2578), [#2588](https://github.com/getsentry/sentry-dart/pull/2588))
+  - [changelog](https://github.com/getsentry/sentry-native/blob/master/CHANGELOG.md#0719)
+  - [diff](https://github.com/getsentry/sentry-native/compare/0.7.17...0.7.19)
+- Bump Android SDK from v7.19.0 to v7.20.1 ([#2536](https://github.com/getsentry/sentry-dart/pull/2536), [#2549](https://github.com/getsentry/sentry-dart/pull/2549), [#2593](https://github.com/getsentry/sentry-dart/pull/2593))
+  - [changelog](https://github.com/getsentry/sentry-java/blob/main/CHANGELOG.md#7201)
+  - [diff](https://github.com/getsentry/sentry-java/compare/7.20.0...7.20.1)
+- Bump Cocoa SDK from v8.42.0 to v8.44.0 ([#2542](https://github.com/getsentry/sentry-dart/pull/2542), [#2548](https://github.com/getsentry/sentry-dart/pull/2548), [#2598](https://github.com/getsentry/sentry-dart/pull/2598), [#2649](https://github.com/getsentry/sentry-dart/pull/2649))
   - [changelog](https://github.com/getsentry/sentry-cocoa/blob/main/CHANGELOG.md#8440)
-  - [diff](https://github.com/getsentry/sentry-cocoa/compare/8.44.0-beta.1...8.44.0)
+  - [diff](https://github.com/getsentry/sentry-cocoa/compare/8.42.0...8.44.0)
 
 ## 8.13.0-beta.3
 

dart/lib/src/sentry_baggage.dart

@@ -1,11 +1,12 @@
 import 'package:meta/meta.dart';
-import 'scope.dart';
 import 'protocol.dart';
-
+import 'scope.dart';
 import 'sentry_options.dart';
 
 class SentryBaggage {
   static const String _sampleRateKeyName = 'sentry-sample_rate';
+  static const String _sampleRandKeyName = 'sentry-sample_rand';
+
   static const int _maxChars = 8192;
   static const int _maxListMember = 64;
 
@@ -194,6 +195,10 @@ class SentryBaggage {
     set(_sampleRateKeyName, value);
   }
 
+  void setSampleRand(String value) {
+    set(_sampleRandKeyName, value);
+  }
+
   void setSampled(String value) {
     set('sentry-sampled', value);
   }
@@ -207,6 +212,15 @@ class SentryBaggage {
     return double.tryParse(sampleRate);
   }
 
+  double? getSampleRand() {
+    final sampleRand = get(_sampleRandKeyName);
+    if (sampleRand == null) {
+      return null;
+    }
+
+    return double.tryParse(sampleRand);
+  }
+
   void setReplayId(String value) => set('sentry-replay_id', value);
 
   SentryId? getReplayId() {

dart/lib/src/sentry_run_zoned_guarded.dart

@@ -29,7 +29,7 @@ class SentryRunZonedGuarded {
 
     final sentryZoneSpecification = ZoneSpecification.from(
       zoneSpecification ?? ZoneSpecification(),
-      print: (self, parent, zone, line) async {
+      print: (self, parent, zone, line) {
         final options = hub.options;
 
         if (userPrint != null) {
@@ -61,12 +61,12 @@ class SentryRunZonedGuarded {
 
         try {
           _isPrinting = true;
-          await hub.addBreadcrumb(
+          unawaited(hub.addBreadcrumb(
             Breadcrumb.console(
               message: line,
               level: SentryLevel.debug,
             ),
-          );
+          ));
           parent.print(zone, line);
         } finally {
           _isPrinting = false;

dart/lib/src/sentry_trace_context_header.dart

@@ -1,7 +1,7 @@
 import 'package:meta/meta.dart';
 
-import 'protocol/sentry_id.dart';
 import 'protocol/access_aware_map.dart';
+import 'protocol/sentry_id.dart';
 import 'sentry_baggage.dart';
 import 'sentry_options.dart';
 
@@ -15,6 +15,7 @@ class SentryTraceContextHeader {
     this.userSegment,
     this.transaction,
     this.sampleRate,
+    this.sampleRand,
     this.sampled,
     this.unknown,
     this.replayId,
@@ -30,6 +31,7 @@ class SentryTraceContextHeader {
   final String? userSegment;
   final String? transaction;
   final String? sampleRate;
+  final String? sampleRand;
   final String? sampled;
 
   @internal
@@ -102,6 +104,9 @@ class SentryTraceContextHeader {
     if (sampleRate != null) {
       baggage.setSampleRate(sampleRate!);
     }
+    if (sampleRand != null) {
+      baggage.setSampleRand(sampleRand!);
+    }
     if (sampled != null) {
       baggage.setSampled(sampled!);
     }
@@ -113,6 +118,7 @@ class SentryTraceContextHeader {
 
   factory SentryTraceContextHeader.fromBaggage(SentryBaggage baggage) {
     return SentryTraceContextHeader(
+      // TODO: implement and use proper get methods here
       SentryId.fromId(baggage.get('sentry-trace_id').toString()),
       baggage.get('sentry-public_key').toString(),
       release: baggage.get('sentry-release'),

dart/lib/src/sentry_tracer.dart

@@ -385,6 +385,7 @@ class SentryTracer extends ISentrySpan {
       transaction:
           _isHighQualityTransactionName(transactionNameSource) ? name : null,
       sampleRate: _sampleRateToString(_rootSpan.samplingDecision?.sampleRate),
+      sampleRand: _sampleRandToString(_rootSpan.samplingDecision?.sampleRand),
       sampled: _rootSpan.samplingDecision?.sampled.toString(),
     );
 
@@ -398,6 +399,13 @@ class SentryTracer extends ISentrySpan {
     return sampleRate != null ? SampleRateFormat().format(sampleRate) : null;
   }
 
+  String? _sampleRandToString(double? sampleRand) {
+    if (!isValidSampleRand(sampleRand)) {
+      return null;
+    }
+    return sampleRand != null ? SampleRateFormat().format(sampleRand) : null;
+  }
+
   bool _isHighQualityTransactionName(SentryTransactionNameSource source) {
     return source != SentryTransactionNameSource.url;
   }

dart/lib/src/sentry_traces_sampler.dart

@@ -31,12 +31,9 @@ class SentryTracesSampler {
     final tracesSampler = _options.tracesSampler;
     if (tracesSampler != null) {
       try {
-        final result = tracesSampler(samplingContext);
-        if (result != null) {
-          return SentryTracesSamplingDecision(
-            _sample(result),
-            sampleRate: result,
-          );
+        final sampleRate = tracesSampler(samplingContext);
+        if (sampleRate != null) {
+          return _makeSampleDecision(sampleRate);
         }
       } catch (exception, stackTrace) {
         _options.logger(
@@ -64,10 +61,7 @@ class SentryTracesSampler {
     double? optionsOrDefaultRate = optionsRate ?? defaultRate;
 
     if (optionsOrDefaultRate != null) {
-      return SentryTracesSamplingDecision(
-        _sample(optionsOrDefaultRate),
-        sampleRate: optionsOrDefaultRate,
-      );
+      return _makeSampleDecision(optionsOrDefaultRate);
     }
 
     return SentryTracesSamplingDecision(false);
@@ -78,8 +72,18 @@ class SentryTracesSampler {
     if (optionsRate == null || !tracesSamplingDecision.sampled) {
       return false;
     }
-    return _sample(optionsRate);
+    return _isSampled(optionsRate);
   }
 
-  bool _sample(double result) => !(result < _random.nextDouble());
+  SentryTracesSamplingDecision _makeSampleDecision(double sampleRate) {
+    final sampleRand = _random.nextDouble();
+    final sampled = _isSampled(sampleRate, sampleRand: sampleRand);
+    return SentryTracesSamplingDecision(sampled,
+        sampleRate: sampleRate, sampleRand: sampleRand);
+  }
+
+  bool _isSampled(double sampleRate, {double? sampleRand}) {
+    final rand = sampleRand ?? _random.nextDouble();
+    return rand <= sampleRate;
+  }
 }

dart/lib/src/sentry_traces_sampling_decision.dart

@@ -2,8 +2,10 @@ class SentryTracesSamplingDecision {
   SentryTracesSamplingDecision(
     this.sampled, {
     this.sampleRate,
+    this.sampleRand,
   });
 
   final bool sampled;
   final double? sampleRate;
+  final double? sampleRand;
 }

dart/lib/src/sentry_transaction_context.dart

@@ -1,27 +1,27 @@
 import 'package:meta/meta.dart';
-import 'sentry_trace_origins.dart';
 
 import 'protocol.dart';
 import 'sentry_baggage.dart';
+import 'sentry_trace_origins.dart';
 import 'tracing.dart';
 
 @immutable
 class SentryTransactionContext extends SentrySpanContext {
   final String name;
-  final SentryTracesSamplingDecision? parentSamplingDecision;
   final SentryTransactionNameSource? transactionNameSource;
   final SentryTracesSamplingDecision? samplingDecision;
+  final SentryTracesSamplingDecision? parentSamplingDecision;
 
   SentryTransactionContext(
     this.name,
     String operation, {
     super.description,
-    this.parentSamplingDecision,
     super.traceId,
     super.spanId,
     super.parentSpanId,
     this.transactionNameSource,
     this.samplingDecision,
+    this.parentSamplingDecision,
     super.origin,
   }) : super(
           operation: operation,
@@ -35,6 +35,7 @@ class SentryTransactionContext extends SentrySpanContext {
     SentryBaggage? baggage,
   }) {
     final sampleRate = baggage?.getSampleRate();
+    final sampleRand = baggage?.getSampleRand();
     return SentryTransactionContext(
       name,
       operation,
@@ -44,6 +45,7 @@ class SentryTransactionContext extends SentrySpanContext {
           ? SentryTracesSamplingDecision(
               traceHeader.sampled!,
               sampleRate: sampleRate,
+              sampleRand: sampleRand,
             )
           : null,
       transactionNameSource:

dart/lib/src/utils/tracing_utils.dart

@@ -80,3 +80,10 @@ bool isValidSampleRate(double? sampleRate) {
   }
   return !sampleRate.isNaN && sampleRate >= 0.0 && sampleRate <= 1.0;
 }
+
+bool isValidSampleRand(double? sampleRand) {
+  if (sampleRand == null) {
+    return false;
+  }
+  return !sampleRand.isNaN && sampleRand >= 0.0 && sampleRand < 1.0;
+}

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.13.0-beta.3';
+const String sdkVersion = '8.13.0';
 
 String sdkName(bool isWeb) => isWeb ? _browserSdkName : _ioSdkName;
 

dart/pubspec.yaml

@@ -1,5 +1,5 @@
 name: sentry
-version: 8.13.0-beta.3
+version: 8.13.0
 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/sentry_baggage_header_test.dart

@@ -21,6 +21,7 @@ void main() {
       baggage.setUserSegment('userSegment');
       baggage.setTransaction('transaction');
       baggage.setSampleRate('1.0');
+      baggage.setSampleRand('0.4');
       baggage.setSampled('false');
       final replayId = SentryId.newId().toString();
       baggage.setReplayId(replayId);
@@ -37,6 +38,7 @@ void main() {
           'sentry-user_segment=userSegment,'
           'sentry-transaction=transaction,'
           'sentry-sample_rate=1.0,'
+          'sentry-sample_rand=0.4,'
           'sentry-sampled=false,'
           'sentry-replay_id=$replayId');
     });