Merge branch 'main' into feat/cache-screenshots

Author: buenaflor

.github/workflows/flutter_test.yml

@@ -81,7 +81,7 @@ jobs:
 
       - name: build apk
         working-directory: ./flutter/example/android
-        run: flutter build apk --debug
+        run: flutter build apk --debug --target-platform=android-x64
 
       - name: launch android emulator & run android native test
         uses: reactivecircus/android-emulator-runner@62dbb605bba737720e10b196cb4220d374026a6d #[email protected]

.github/workflows/testflight.yml

@@ -16,7 +16,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: subosito/flutter-action@44ac965b96f18d999802d4b807e3256d5a3f9fa1 # [email protected]
       - run: xcodes select 15.0.1
-      - uses: ruby/setup-ruby@7bae1d00b5db9166f4f0fc47985a3a5702cb58f0 # pin@v1.197.0
+      - uses: ruby/setup-ruby@7d3497fd78c07c0d84ebafa58d8dac60cd1f0763 # pin@v1.199.0
         with:
           ruby-version: '2.7.5'
           bundler-cache: true

CHANGELOG.md

@@ -1,9 +1,59 @@
 # Changelog
 
-## Unreleased
+## 8.10.1
+
+### Fixes
+
+- Android build error when compiling ([#2397](https://github.com/getsentry/sentry-dart/pull/2397))
+
+## 8.10.0
 
 ### Features
 
+- Emit `transaction.data` inside `contexts.trace.data` ([#2284](https://github.com/getsentry/sentry-dart/pull/2284))
+- Blocking app starts span if "appLaunchedInForeground" is false. (Android only) ([#2291](https://github.com/getsentry/sentry-dart/pull/2291))
+- Replay: user-configurable masking (redaction) for widget classes and specific widget instances. ([#2324](https://github.com/getsentry/sentry-dart/pull/2324))
+  Some examples of the configuration:
+
+  ```dart
+  await SentryFlutter.init(
+    (options) {
+      ...
+      options.experimental.replay.mask<IconButton>();
+      options.experimental.replay.unmask<Image>();
+      options.experimental.replay.maskCallback<Text>(
+          (Element element, Text widget) =>
+              (widget.data?.contains('secret') ?? false)
+                  ? SentryMaskingDecision.mask
+                  : SentryMaskingDecision.continueProcessing);
+    },
+    appRunner: () => runApp(MyApp()),
+  );
+  ```
+
+  Also, you can wrap any of your widgets with `SentryMask()` or `SentryUnmask()` widgets to mask/unmask them, respectively. For example:
+
+  ```dart
+   SentryUnmask(Text('Not secret at all'));
+  ```
+
+- Support `captureFeedback` ([#2230](https://github.com/getsentry/sentry-dart/pull/2230))
+  - Deprecated `Sentry.captureUserFeedback`, use `captureFeedback` instead.
+  - Deprecated `Hub.captureUserFeedback`, use `captureFeedback` instead.
+  - Deprecated `SentryClient.captureUserFeedback`, use `captureFeedback` instead.
+  - Deprecated `SentryUserFeedback`, use `SentryFeedback` instead.
+- Add `SentryFeedbackWidget` ([#2240](https://github.com/getsentry/sentry-dart/pull/2240))
+
+  ```dart
+  Navigator.push(
+    context,
+    MaterialPageRoute(
+      builder: (context) => SentryFeedbackWidget(associatedEventId: id),
+      fullscreenDialog: true,
+    ),
+  );
+  ```
+  
 - Add screenshot to `SentryFeedbackWidget` ([#2369](https://github.com/getsentry/sentry-dart/pull/2369))
   - Use `SentryFlutter.captureScreenshot` to create a screenshot attachment
   - Call `SentryFeedbackWidget` with this attachment to add it to the user feedback
@@ -29,11 +79,49 @@
 
 ### Enhancements
 
+- Avoid sending too many empty client reports when Http Transport is used ([#2380](https://github.com/getsentry/sentry-dart/pull/2380))
 - Cache parsed DSN ([#2365](https://github.com/getsentry/sentry-dart/pull/2365))
 - Handle backpressure earlier in pipeline ([#2371](https://github.com/getsentry/sentry-dart/pull/2371))
   - Drops max un-awaited parallel tasks earlier, so event processors & callbacks are not executed for them. 
   - Change by setting `SentryOptions.maxQueueSize`. Default is 30.
+- Use native spotlight integrations on Flutter Android, iOS, macOS ([#2285](https://github.com/getsentry/sentry-dart/pull/2285))
+- Improve app start integration ([#2266](https://github.com/getsentry/sentry-dart/pull/2266))
+  - Fixes pendingTimer during tests ([#2103](https://github.com/getsentry/sentry-dart/issues/2103))
+  - Fixes transaction slows app start ([#2233](https://github.com/getsentry/sentry-dart/issues/2233))
+- Only store slow and frozen frames for frame delay calculation ([#2337](https://github.com/getsentry/sentry-dart/pull/2337))
+- Add ReplayIntegration to the integrations list on events when replay is enabled. ([#2349](https://github.com/getsentry/sentry-dart/pull/2349))
+
+### Fixes
+
+- App lag with frame tracking enabled when span finishes after a long time ([#2311](https://github.com/getsentry/sentry-dart/pull/2311))
+- Only start frame tracking if we receive valid display refresh data ([#2307](https://github.com/getsentry/sentry-dart/pull/2307))
+- Rounding error used on frames.total and reject frame measurements if frames.total is less than frames.slow or frames.frozen ([#2308](https://github.com/getsentry/sentry-dart/pull/2308))
+- iOS replay integration when only `onErrorSampleRate` is specified ([#2306](https://github.com/getsentry/sentry-dart/pull/2306))
+- Fix TTID timing issue ([#2326](https://github.com/getsentry/sentry-dart/pull/2326))
+- TTFD fixes
+  - Start missing TTFD for root screen transaction ([#2332](https://github.com/getsentry/sentry-dart/pull/2332))
+  - Match TTFD to TTID end timespan if TTFD is unfinished when user navigates to another screen ([#2347](https://github.com/getsentry/sentry-dart/pull/2347))
+  - TTFD measurements should only be added for successful TTFD spans ([#2348](https://github.com/getsentry/sentry-dart/pull/2348))
+  - Error when calling `SentryFlutter.reportFullyDisplayed()` twice ([#2339](https://github.com/getsentry/sentry-dart/pull/2339))
+- Accessing invalid json fields from `fetchNativeAppStart` should return null ([#2340](https://github.com/getsentry/sentry-dart/pull/2340))
+
+### Deprecate
+
+- Metrics API ([#2312](https://github.com/getsentry/sentry-dart/pull/2312))
+  - Learn more: https://sentry.zendesk.com/hc/en-us/articles/26369339769883-Metrics-Beta-Coming-to-an-End
 
+### Dependencies
+
+- Bump Native SDK from v0.7.10 to v0.7.12 ([#2390](https://github.com/getsentry/sentry-dart/pull/2390))
+  - [changelog](https://github.com/getsentry/sentry-native/blob/master/CHANGELOG.md#0712)
+  - [diff](https://github.com/getsentry/sentry-native/compare/0.7.10...0.7.12)
+- Bump Android SDK from v7.15.0 to v7.16.0 ([#2373](https://github.com/getsentry/sentry-dart/pull/2373))
+  - [changelog](https://github.com/getsentry/sentry-java/blob/main/CHANGELOG.md#7160)
+  - [diff](https://github.com/getsentry/sentry-java/compare/7.15.0...7.16.0)
+- Bump Cocoa SDK from v8.37.0 to v8.40.1 ([#2394](https://github.com/getsentry/sentry-dart/pull/2394))
+  - [changelog](https://github.com/getsentry/sentry-cocoa/blob/main/CHANGELOG.md#8401)
+  - [diff](https://github.com/getsentry/sentry-cocoa/compare/8.37.0...8.40.1)
+
 ## 8.10.0-beta.2
 
 ### Fixes

dart/lib/src/sentry_client.dart

@@ -20,6 +20,7 @@ import 'sentry_options.dart';
 import 'sentry_stack_trace_factory.dart';
 import 'sentry_trace_context_header.dart';
 import 'sentry_user_feedback.dart';
+import 'transport/client_report_transport.dart';
 import 'transport/data_category.dart';
 import 'transport/http_transport.dart';
 import 'transport/noop_transport.dart';
@@ -54,10 +55,17 @@ class SentryClient {
     if (options.sendClientReports) {
       options.recorder = ClientReportRecorder(options.clock);
     }
+    RateLimiter? rateLimiter;
     if (options.transport is NoOpTransport) {
-      final rateLimiter = RateLimiter(options);
+      rateLimiter = RateLimiter(options);
       options.transport = HttpTransport(options, rateLimiter);
     }
+    // rateLimiter is null if FileSystemTransport is active since Native SDKs take care of rate limiting
+    options.transport = ClientReportTransport(
+      rateLimiter,
+      options,
+      options.transport,
+    );
     // TODO: Web might change soon to use the JS SDK so we can remove it here later on
     final enableFlutterSpotlight = (options.spotlight.enabled &&
         (options.platformChecker.isWeb ||
@@ -427,7 +435,7 @@ class SentryClient {
 
   /// Reports the [envelope] to Sentry.io.
   Future<SentryId?> captureEnvelope(SentryEnvelope envelope) {
-    return _attachClientReportsAndSend(envelope);
+    return _options.transport.send(envelope);
   }
 
   /// Reports the [userFeedback] to Sentry.io.
@@ -439,7 +447,7 @@ class SentryClient {
       _options.sdk,
       dsn: _options.dsn,
     );
-    return _attachClientReportsAndSend(envelope);
+    return _options.transport.send(envelope);
   }
 
   /// Reports the [feedback] to Sentry.io.
@@ -469,7 +477,7 @@ class SentryClient {
       _options.sdk,
       dsn: _options.dsn,
     );
-    final id = await _attachClientReportsAndSend(envelope);
+    final id = await _options.transport.send(envelope);
     return id ?? SentryId.empty();
   }
 
@@ -621,10 +629,4 @@ class SentryClient {
     }
     return DataCategory.error;
   }
-
-  Future<SentryId?> _attachClientReportsAndSend(SentryEnvelope envelope) {
-    final clientReport = _options.recorder.flush();
-    envelope.addClientReport(clientReport);
-    return _options.transport.send(envelope);
-  }
 }

dart/lib/src/transport/client_report_transport.dart

@@ -0,0 +1,56 @@
+import 'package:meta/meta.dart';
+import '../../sentry.dart';
+import '../sentry_envelope_header.dart';
+import 'rate_limiter.dart';
+
+/// Decorator that handles attaching of client reports in tandem with rate
+/// limiting. The rate limiter is optional.
+@internal
+class ClientReportTransport implements Transport {
+  final RateLimiter? _rateLimiter;
+  final SentryOptions _options;
+  final Transport _transport;
+
+  ClientReportTransport(this._rateLimiter, this._options, this._transport);
+
+  @visibleForTesting
+  get rateLimiter => _rateLimiter;
+
+  int _numberOfDroppedEnvelopes = 0;
+
+  @visibleForTesting
+  get numberOfDroppedEvents => _numberOfDroppedEnvelopes;
+
+  @override
+  Future<SentryId?> send(SentryEnvelope envelope) async {
+    final rateLimiter = _rateLimiter;
+
+    SentryEnvelope? filteredEnvelope = envelope;
+    if (rateLimiter != null) {
+      filteredEnvelope = rateLimiter.filter(envelope);
+    }
+    if (filteredEnvelope == null) {
+      _numberOfDroppedEnvelopes += 1;
+    }
+    if (_numberOfDroppedEnvelopes >= 10) {
+      // Create new envelope that could only contain client reports
+      filteredEnvelope = SentryEnvelope(
+        SentryEnvelopeHeader(SentryId.newId(), _options.sdk),
+        [],
+      );
+    }
+    if (filteredEnvelope == null) {
+      return SentryId.empty();
+    }
+    _numberOfDroppedEnvelopes = 0;
+
+    final clientReport = _options.recorder.flush();
+    filteredEnvelope.addClientReport(clientReport);
+
+    if (filteredEnvelope.items.isNotEmpty) {
+      return _transport.send(filteredEnvelope);
+    } else {
+      return SentryId.empty();
+    }
+  }
+}

dart/lib/src/transport/http_transport.dart

@@ -35,14 +35,9 @@ class HttpTransport implements Transport {
 
   @override
   Future<SentryId?> send(SentryEnvelope envelope) async {
-    final filteredEnvelope = _rateLimiter.filter(envelope);
-    if (filteredEnvelope == null) {
-      return SentryId.empty();
-    }
-    filteredEnvelope.header.sentAt = _options.clock();
+    envelope.header.sentAt = _options.clock();
 
-    final streamedRequest =
-        await _requestHandler.createRequest(filteredEnvelope);
+    final streamedRequest = await _requestHandler.createRequest(envelope);
 
     final response = await _options.httpClient
         .send(streamedRequest)

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

dart/pubspec.yaml

@@ -1,5 +1,5 @@
 name: sentry
-version: 8.10.0-beta.2
+version: 8.10.1
 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/exception_identifier_test.dart

@@ -126,7 +126,7 @@ void main() {
 
   group('Integration test', () {
     setUp(() {
-      fixture.options.transport = MockTransport();
+      fixture.options.transport = fixture.mockTransport;
     });
 
     test(
@@ -139,7 +139,7 @@ void main() {
 
       await client.captureException(ObfuscatedException());
 
-      final transport = fixture.options.transport as MockTransport;
+      final transport = fixture.mockTransport;
       final capturedEnvelope = transport.envelopes.first;
       final capturedEvent = await eventFromEnvelope(capturedEnvelope);
 
@@ -154,7 +154,7 @@ void main() {
 
       await client.captureException(ObfuscatedException());
 
-      final transport = fixture.options.transport as MockTransport;
+      final transport = fixture.mockTransport;
       final capturedEnvelope = transport.envelopes.first;
       final capturedEvent = await eventFromEnvelope(capturedEnvelope);
 
@@ -165,6 +165,7 @@ void main() {
 }
 
 class Fixture {
+  final mockTransport = MockTransport();
   SentryOptions options = defaultTestOptions();
 }
 

dart/test/mocks/mock_transport.dart

@@ -16,6 +16,8 @@ class MockTransport implements Transport {
     return _calls;
   }
 
+  bool parseFromEnvelope = true;
+
   bool called(int calls) {
     return _calls == calls;
   }
@@ -28,7 +30,9 @@ class MockTransport implements Transport {
     // failure causes. Instead, we log them and check on access to [calls].
     try {
       envelopes.add(envelope);
-      await _eventFromEnvelope(envelope);
+      if (parseFromEnvelope) {
+        await _eventFromEnvelope(envelope);
+      }
     } catch (e, stack) {
       _exceptions += '$e\n$stack\n\n';
       rethrow;