Flutter 7 GA (#6468)

marandaneto · web-flow · commit bf5e32240a1f · 2023-03-15T14:07:06.000+01:00
diff --git a/src/docs/product/data-management-settings/scrubbing/advanced-datascrubbing.mdx b/src/docs/product/data-management-settings/scrubbing/advanced-datascrubbing.mdx
@@ -87,7 +87,7 @@ Selectors allow you to restrict rules to certain parts of the event. This is use
 - `$http.headers.x-custom-token` to scrub the request header `X-Custom-Token`
 - `$user.ip_address` to scrub the user's IP address
 - `$frame.vars.foo` to scrub a stack trace frame variable called `foo`
-- `contexts.device.timezone` to scrub a key from the Device context
+- `contexts.device.timezone` or `contexts.culture.timezone` to scrub a key from the Device context
 - `tags.server_name` to scrub the tag `server_name`
 
 All key names are treated case-insensitively.
diff --git a/src/platform-includes/configuration/auto-session-tracking/flutter.mdx b/src/platform-includes/configuration/auto-session-tracking/flutter.mdx
@@ -8,7 +8,7 @@ import 'package:sentry_flutter/sentry_flutter.dart';
 
 Future<void> main() async {
   await SentryFlutter.init(
-    (options) => options.autoSessionTrackingIntervalMillis = 60000
+    (options) => options.autoSessionTrackingInterval = const Duration(milliseconds: 60000)
     appRunner: () => runApp(MyApp()),
   );
 }
diff --git a/src/platform-includes/configuration/before-breadcrumb-hint/dart.mdx b/src/platform-includes/configuration/before-breadcrumb-hint/dart.mdx
@@ -1,7 +1,7 @@
 ```dart
 import 'package:sentry/sentry.dart';
 
-Breadcrumb beforeBreadcrumb(Breadcrumb crumb, {dynamic hint}) {
+Breadcrumb beforeBreadcrumb(Breadcrumb crumb, {Hint? hint}) {
   return hint is MyHint ? null : crumb;
 }
 
diff --git a/src/platform-includes/configuration/before-send-fingerprint/dart.mdx b/src/platform-includes/configuration/before-send-fingerprint/dart.mdx
@@ -1,7 +1,7 @@
 ```dart
 import 'package:sentry/sentry.dart';
 
-FutureOr<SentryEvent?> beforeSend(SentryEvent event, {dynamic hint}) async {
+FutureOr<SentryEvent?> beforeSend(SentryEvent event, {Hint? hint}) async {
   if (event.throwable is DatabaseException) {
     event = event.copyWith(fingerprint: ['database-connection-error']);
   }
diff --git a/src/platform-includes/configuration/before-send-hint/dart.mdx b/src/platform-includes/configuration/before-send-hint/dart.mdx
@@ -1,7 +1,7 @@
 ```dart
 import 'package:sentry/sentry.dart';
 
-FutureOr<SentryEvent?> beforeSend(SentryEvent event, {dynamic hint}) async {
+FutureOr<SentryEvent?> beforeSend(SentryEvent event, {Hint? hint}) async {
   return hint is MyHint ? null : event;
 }
 
diff --git a/src/platform-includes/configuration/before-send/dart.mdx b/src/platform-includes/configuration/before-send/dart.mdx
@@ -1,7 +1,7 @@
 ```dart
 import 'package:sentry/sentry.dart';
 
-FutureOr<SentryEvent?> beforeSend(SentryEvent event, {dynamic hint}) async {
+FutureOr<SentryEvent?> beforeSend(SentryEvent event, {Hint? hint}) async {
   // Modify the event here:
   event = event.copyWith(serverName: null); // Don't send server names.
   return event;
diff --git a/src/platform-includes/enriching-events/breadcrumbs/before-breadcrumb/dart.mdx b/src/platform-includes/enriching-events/breadcrumbs/before-breadcrumb/dart.mdx
@@ -1,7 +1,7 @@
 ```dart
 import 'package:sentry/sentry.dart';
 
-Breadcrumb beforeBreadcrumb(Breadcrumb breadcrumb, {dynamic hint}) {
+Breadcrumb beforeBreadcrumb(Breadcrumb breadcrumb, {Hint? hint}) {
   return 'a.spammy.Logger' == breadcrumb.category ? null : breadcrumb;
 }
 
diff --git a/src/platform-includes/enriching-events/scopes/configure-scope/dart.mdx b/src/platform-includes/enriching-events/scopes/configure-scope/dart.mdx
@@ -3,5 +3,5 @@ import 'package:sentry/sentry.dart';
 
 Sentry.configureScope((scope) => scope
   ..setTag('my-tag', 'my value')
-  ..user = User(id: '42', email: 'john.doe@example.com'));
+  ..setUser(SentryUser(id: '42', email: 'john.doe@example.com'));
 ```
diff --git a/src/platform-includes/getting-started-primer/flutter.mdx b/src/platform-includes/getting-started-primer/flutter.mdx
@@ -37,4 +37,4 @@ Features:
 - [Screenshot attachments for errors](/platforms/flutter/enriching-events/screenshots/)
 - [View Hierarchy attachments for errors](/platforms/flutter/enriching-events/viewhierarchy/)
 - Limited support for Flutter Web, Windows, and Linux
-- Under the hood, the SDK relies on the [Dart SDK](/platforms/dart/); the minimum required version is `2.12.0` and Flutter SDK version is `2.0.0`.
+- Under the hood, the SDK relies on the [Dart SDK](/platforms/dart/), version `2.17.0` and up, and the Flutter SDK, version `3.0.0` and up.
diff --git a/src/platform-includes/performance/distributed-tracing/dart.mdx b/src/platform-includes/performance/distributed-tracing/dart.mdx
@@ -3,6 +3,8 @@ To obtain a trace header from the span, use `ISentrySpan#toSentryTrace()` method
 To create a span as a continuation of the trace retrieved from the upstream service, pass the `sentry-trace` header value to the transaction context:
 
 ```dart
+import 'package:sentry/sentry.dart';
+
 final header = request.headers['sentry-trace'];
 final sentryTraceHeader = SentryTraceHeader.fromTraceHeader(header);
 try {
@@ -14,6 +16,6 @@ try {
 
 <Note>
 
-The `SentryHttpClient` instrumentation handles trace continuations automatically when enabling the `networkTracing` feature.
+The `SentryHttpClient` instrumentation handles trace continuations automatically when enabling the [performance](/platforms/dart/performance/) feature.
 
 </Note>
diff --git a/src/platform-includes/set-fingerprint/basic/dart.mdx b/src/platform-includes/set-fingerprint/basic/dart.mdx
@@ -1,7 +1,7 @@
 ```dart
 import 'package:sentry/sentry.dart';
 
-FutureOr<SentryEvent?> beforeSend(SentryEvent event, {dynamic hint}) async {
+FutureOr<SentryEvent?> beforeSend(SentryEvent event, {Hint? hint}) async {
   if (event.throwable is DatabaseException) {
     event = event.copyWith(fingerprint: ['database-connection-error']);
   }
diff --git a/src/platform-includes/set-fingerprint/database-connection/dart.mdx b/src/platform-includes/set-fingerprint/database-connection/dart.mdx
@@ -1,7 +1,7 @@
 ```dart
 import 'package:sentry/sentry.dart';
 
-FutureOr<SentryEvent?> beforeSend(SentryEvent event, {dynamic hint}) async {
+FutureOr<SentryEvent?> beforeSend(SentryEvent event, {Hint? hint}) async {
   if (event.throwable is DatabaseException) {
     event = event.copyWith(fingerprint: ['database-connection-error']);
   }
diff --git a/src/platform-includes/set-fingerprint/rpc/dart.mdx b/src/platform-includes/set-fingerprint/rpc/dart.mdx
@@ -8,7 +8,7 @@ class MyRpcException implements Exception {
   MyRpcException(this.function, this.httpStatusCode);
 }
 
-FutureOr<SentryEvent?> beforeSend(SentryEvent event, {dynamic hint}) async {
+FutureOr<SentryEvent?> beforeSend(SentryEvent event, {Hint? hint}) async {
   if (event.throwable is MyRpcException) {
     final exception = event.throwable as MyRpcException;
     event = event.copyWith(fingerprint: [
diff --git a/src/platforms/android/common/performance/instrumentation/automatic-instrumentation.mdx b/src/platforms/android/common/performance/instrumentation/automatic-instrumentation.mdx
@@ -178,7 +178,7 @@ Note that by removing this transitive dependency, slow and frozen frames won't b
 
 ### OkHttp Library Instrumentation
 
-The OkHttp's instrumentation, once added the `SentryOkHttpInterceptor`, starts a span out of the active span bound to the scope for each HTTP Request. The SDK sets the span `operation` to `http.client` and `description` to request `$method and $URL`; for example, `GET https://sentry.io`.
+The OkHttp's instrumentation, once added the `SentryOkHttpInterceptor`, starts a span out of the active span bound to the scope for each HTTP Request. The SDK sets the span `operation` to `http.client` and `description` to request `$METHOD $url`; for example, `GET https://sentry.io`.
 
 The span finishes once the request has been executed. The span `status` depends on either the HTTP Response `code` or `SpanStatus.INTERNAL_ERROR` if the `code` does not match any of Sentry's `SpanStatus`.
 
diff --git a/src/platforms/common/configuration/options.mdx b/src/platforms/common/configuration/options.mdx
@@ -854,19 +854,29 @@ Set this boolean to `false` to disable the scope sync from Java to NDK on Androi
 Set this boolean to `true` to automatically attach all threads to all logged events on Android.
 </ConfigKey>
 
-<ConfigKey name="enableAutoPerformanceTracking" supported={["react-native", "flutter"]}>
+<ConfigKey name="enableAutoPerformanceTracking" supported={["react-native"]}>
 
 Set this boolean to `false` to disable auto [performance monitoring](/product/performance/) tracking.
 
 </ConfigKey>
 
-<ConfigKey name="enableOutOfMemoryTracking" supported={["react-native", "javascript.capacitor", "flutter"]}>
+<PlatformSection supported={["flutter"]}>
+
+<ConfigKey name="enableAutoPerformanceTracing" supported={["flutter"]}>
+
+Set this boolean to `false` to disable auto [performance monitoring](/product/performance/) tracking.
+
+</ConfigKey>
+
+</PlatformSection>
+
+<ConfigKey name="enableOutOfMemoryTracking" supported={["react-native", "javascript.capacitor"]}>
 
 Set this boolean to `false` to disable [out of memory](/platforms/apple/guides/ios/configuration/out-of-memory/) tracking on iOS.
 
 </ConfigKey>
 
-<ConfigKey name="enableWatchdogTerminationTracking" supported={["apple"]}>
+<ConfigKey name="enableWatchdogTerminationTracking" supported={["apple", "flutter"]}>
 
 <Note>
 Available since version 8.0.0 of Sentry Apple SDK. It was named `enableOutOfMemoryTracking` before the 8.0.0 release.
diff --git a/src/platforms/common/enriching-events/viewhierarchy.mdx b/src/platforms/common/enriching-events/viewhierarchy.mdx
@@ -15,6 +15,12 @@ notSupported:
   - dotnet.xamarin
 ---
 
+<PlatformSection supported={["flutter"]}>
+
+<Include name="beta-note.mdx" />
+
+</PlatformSection>
+
 Sentry makes it possible to render a JSON representation of the view hierarchy of an error and includes it as an <PlatformLink to="/enriching-events/attachments/">attachment</PlatformLink>.
 
 This feature only applies to SDKs with a user interface, such as the ones for mobile and desktop applications. In some environments like native iOS, rendering the view hierarchy requires the UI thread and in the event of a crash, that might not be available. Another example where the view hierarchy might not be available is when the event happens before the screen starts to load. So inherently, this feature is a best effort solution.
diff --git a/src/platforms/dart/common/performance/instrumentation/automatic-instrumentation.mdx b/src/platforms/dart/common/performance/instrumentation/automatic-instrumentation.mdx
@@ -14,7 +14,7 @@ Capturing transactions requires that you first <PlatformLink to="/performance/">
 
 ### http.Client Library Instrumentation
 
-The `http.Client` instrumentation, once added the `SentryHttpClient` and enabled the `networkTracing` feature, starts a span out of the active span bound to the scope for each HTTP Request. The SDK sets the span `operation` to `http.client` and `description` to request `$method and $URL`; for example, `GET https://sentry.io`.
+The `http.Client` instrumentation, once added the `SentryHttpClient` and enabled the [performance](/platforms/dart/performance/) feature, starts a span out of the active span bound to the scope for each HTTP Request. The SDK sets the span `operation` to `http.client` and `description` to request `$METHOD $url`; for example, `GET https://sentry.io`.
 
 The span finishes once the request has been executed. The span `status` depends on either the HTTP Response `code` or `SpanStatus.internalError()` if the `code` does not match any of Sentry's `SpanStatus`.
 
@@ -24,7 +24,7 @@ For more information see our [SentryHttpClient integration](/platforms/dart/conf
 
 ### Dio HTTP Library Instrumentation
 
-The Dio instrumentation starts a span out of the active span bound to the scope for each HTTP request. The SDK sets the span `operation` to `http.client` and the `description` to request `$method $URL`. For example, `GET https://sentry.io`.
+The Dio instrumentation starts a span out of the active span bound to the scope for each HTTP request. The SDK sets the span `operation` to `http.client` and the `description` to request `$METHOD $url`. For example, `GET https://sentry.io`.
 
 The span finishes once the request has been executed. The span `status` depends on either the HTTP response `code` or `SpanStatus.internalError()` if the `code` does not match any of Sentry's `SpanStatus` options.
 
diff --git a/src/platforms/dart/configuration/integrations/dio.mdx b/src/platforms/dart/configuration/integrations/dio.mdx
@@ -45,18 +45,33 @@ dio.addSentry(...);
 ## Reporting Bad HTTP Requests as Errors
 
 The `Interceptors` can also catch exceptions that may occur during requests — for example [DioError](https://pub.dev/documentation/dio/latest/dio/DioError-class.html).
-This is currently an opt-in feature. The following example shows how to enable it.
 
 ```dart
 import 'package:sentry_dio/sentry_dio.dart';
 
 final dio = Dio();
 
-dio.addSentry(captureFailedRequests: true);
+dio.addSentry();
 
 final response = await dio.get<String>('https://wrong-url.dev/');
 ```
 
+This is an opt-out feature. The following example shows how to disable it:
+
+```dart
+import 'package:sentry/sentry.dart';
+
+Future<void> main() async {
+  await Sentry.init(
+    (options) {
+      options.dsn = '___PUBLIC_DSN___';
+      options.captureFailedRequests = false;
+    },
+    appRunner: initApp, // Init your App.
+  );
+}
+```
+
 ## Performance Monitoring for HTTP Requests
 
 <Note>
@@ -66,12 +81,11 @@ Capturing transactions requires that you first <PlatformLink to="/performance/">
 </Note>
 
 The Dio integration starts a span out of the active span bound to the scope for each HTTP request.
-This is currently enabled by default. The following example shows how to disable it.
 
 ```dart
 import 'package:sentry_dio/sentry_dio.dart';
 
 final dio = Dio();
 
-dio.addSentry(networkTracing: false);
+dio.addSentry();
 ```
diff --git a/src/platforms/dart/configuration/integrations/file.mdx b/src/platforms/dart/configuration/integrations/file.mdx
@@ -4,8 +4,6 @@ sidebar_order: 5
 description: "Learn more about the Sentry file I/O integration for the Dart SDK."
 ---
 
-<Include name="beta-note.mdx" />
-
 The `sentry_file` library provides [File](https://api.dart.dev/stable/2.18.5/dart-io/File-class.html) support for Sentry wrapping the `File` class with a `SentryFile` wrapper. The `SentryFile` is able to run performance monitoring for `File` operations.
 
 The source can be found [on GitHub](https://github.com/getsentry/sentry-dart/tree/main/file/).
diff --git a/src/platforms/dart/configuration/integrations/http-integration.mdx b/src/platforms/dart/configuration/integrations/http-integration.mdx
@@ -9,12 +9,11 @@ description: "Learn more about the Sentry HTTP integration for the Dart SDK."
 ## Reporting Bad HTTP Requests as Errors
 
 The `SentryHttpClient` can also catch exceptions that may occur during requests — for example [`SocketException`](https://api.dart.dev/stable/2.13.4/dart-io/SocketException-class.html).
-This is currently an opt-in feature. The following example shows how to enable it.
 
 ```dart
 import 'package:sentry/sentry.dart';
 
-var client = SentryHttpClient(captureFailedRequests: true);
+var client = SentryHttpClient();
 try {
 var uriResponse = await client.post('https://example.com/whatsit/create',
      body: {'name': 'doodle', 'color': 'blue'});
@@ -24,6 +23,22 @@ var uriResponse = await client.post('https://example.com/whatsit/create',
 }
 ```
 
+This is an opt-out feature. The following example shows how to disable it:
+
+```dart
+import 'package:sentry/sentry.dart';
+
+Future<void> main() async {
+  await Sentry.init(
+    (options) {
+      options.dsn = '___PUBLIC_DSN___';
+      options.captureFailedRequests = false;
+    },
+    appRunner: initApp, // Init your App.
+  );
+}
+```
+
 Furthermore you can track HTTP requests that you consider bad. In the
 following example, exceptions are captured for each request
 with a status code within the range of 400 to 404, and also for 500.
@@ -49,8 +64,13 @@ var uriResponse = await client.post('https://example.com/whatsit/create',
 
 ## Performance Monitoring for HTTP Requests
 
+<Note>
+
+Capturing transactions requires that you first <PlatformLink to="/performance/">set up performance monitoring</PlatformLink> if you haven't already.
+
+</Note>
+
 The `SentryHttpClient` starts a span out of the active span bound to the scope for each HTTP Request.
-This is currently an opt-in feature. The following example shows how to enable it.
 
 ```dart
 import 'package:sentry/sentry.dart';
@@ -61,7 +81,7 @@ final transaction = Sentry.startTransaction(
   bindToScope: true,
 );
 
-var client = SentryHttpClient(networkTracing: true);
+var client = SentryHttpClient();
 try {
 var uriResponse = await client.post('https://example.com/whatsit/create',
      body: {'name': 'doodle', 'color': 'blue'});
diff --git a/src/platforms/dart/migration.mdx b/src/platforms/dart/migration.mdx
@@ -9,6 +9,7 @@ description: "Migrate between versions of Sentry's SDK for Dart."
 API changes:
 
 - Sentry's Dart SDK version 7.0.0 and above requires Dart `2.17.0`.
+- Sentry's `sentry_file` package version 7.0.0 and above requires Dart `2.19.0`.
 - Methods that used to take a `dynamic hint` optional parameter now take `Hint? hint` instead.
 - The following deprecated fields have been removed from the `SentryDevice` class and replaced:
   - `screenResolution` replaced with `screenHeightPixels` and `screenWidthPixels`.
diff --git a/src/platforms/flutter/common/configuration/integrations/user-interaction-instrumentation.mdx b/src/platforms/flutter/common/configuration/integrations/user-interaction-instrumentation.mdx
@@ -10,8 +10,6 @@ categories:
 
 _(New in version 6.17.0)_
 
-<Include name="beta-note.mdx" />
-
 The UI instrumentation, once enabled, captures transactions and adds breadcrumbs for a set of different user interactions, which include clicks, long clicks, taps, and so on. The SDK composes the transaction name from the `key` of the `Widget` that captured the user interaction (for example, `login_button`). The transaction operation is set to `ui.action.click`.
 
 If the view doesn't have the `key` assigned, the transaction and the breadcrumb won't be captured because it can't be uniquely identified otherwise.
@@ -24,15 +22,15 @@ Capturing transactions requires that you first <PlatformLink to="/performance/">
 
 </Note>
 
-The UI instrumentation tracing is disabled by default, but you can enable it by setting the `enableUserInteractionTracing` option to `true` and wrapping your app with the `SentryUserInteractionWidget` widget:
+The UI instrumentation tracing is an opt-out feature. The following example shows how to disable it:
 
 ```dart
 import 'package:flutter/widgets.dart';
 import 'package:sentry_flutter/sentry_flutter.dart';
 
 Future<void> main() async {
   await SentryFlutter.init(
-    (options) => options.enableUserInteractionTracing = true,
+    (options) => options.enableUserInteractionTracing = false,
     appRunner: () => runApp(SentryUserInteractionWidget(child: MyApp())),
   );
 }
diff --git a/src/platforms/flutter/common/performance/instrumentation/automatic-instrumentation.mdx b/src/platforms/flutter/common/performance/instrumentation/automatic-instrumentation.mdx
diff --git a/src/platforms/flutter/migration.mdx b/src/platforms/flutter/migration.mdx

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ import 'package:sentry_flutter/sentry_flutter.dart';`
`8`	`8`
`9`	`9`	`Future<void> main() async {`
`10`	`10`	`await SentryFlutter.init(`
`11`		`- (options) => options.autoSessionTrackingIntervalMillis = 60000`
	`11`	`+ (options) => options.autoSessionTrackingInterval = const Duration(milliseconds: 60000)`
`12`	`12`	`appRunner: () => runApp(MyApp()),`
`13`	`13`	`);`
`14`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	```dart
`2`	`2`	`import 'package:sentry/sentry.dart';`
`3`	`3`
`4`		`-Breadcrumb beforeBreadcrumb(Breadcrumb crumb, {dynamic hint}) {`
	`4`	`+Breadcrumb beforeBreadcrumb(Breadcrumb crumb, {Hint? hint}) {`
`5`	`5`	`return hint is MyHint ? null : crumb;`
`6`	`6`	`}`
`7`	`7`