From c2b16c0d6f8ec08c81360ad85ab0308ff14c4aa2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20Ueko=CC=88tter?= Date: Mon, 22 Mar 2021 11:10:22 +0100 Subject: [PATCH 01/11] Sentry Dart and Flutter Migration guide --- src/platforms/dart/migration.mdx | 21 +++++++++++++++++++++ src/platforms/flutter/migration.mdx | 15 +++++++++++++++ 2 files changed, 36 insertions(+) create mode 100644 src/platforms/dart/migration.mdx create mode 100644 src/platforms/flutter/migration.mdx diff --git a/src/platforms/dart/migration.mdx b/src/platforms/dart/migration.mdx new file mode 100644 index 0000000000000..c54da53c25872 --- /dev/null +++ b/src/platforms/dart/migration.mdx @@ -0,0 +1,21 @@ +--- +title: Migration Guide +sidebar_order: 1000 +redirect_from: + - /platforms/dart/migrate/ +--- + +## Migrating from `sentry_dart` `4.0.x` to `sentry_dart` `5.0.0` + +* Fix: Prefix classes with Sentry + * A couple of classes were often conflicting with user's code. + Thus this change renames the following classes: + * `App` -> `SentryApp` + * `Browser` -> `SentryBrowser` + * `Device` -> `SentryDevice` + * `Gpu` -> `SentryGpu` + * `Integration` -> `SentryIntegration` + * `Message` -> `SentryMessage` + * `OperatingSystem` -> `SentryOperatingSystem` + * `Request` -> `SentryRequest` + * `User` -> `SentryUser` \ No newline at end of file diff --git a/src/platforms/flutter/migration.mdx b/src/platforms/flutter/migration.mdx new file mode 100644 index 0000000000000..0b520a5b9c6db --- /dev/null +++ b/src/platforms/flutter/migration.mdx @@ -0,0 +1,15 @@ +--- +title: Migration Guide +sidebar_order: 1000 +redirect_from: + - /platforms/flutter/migrate/ +--- + +## Migrating from `sentry_dart` `4.0.x` to `sentry_dart` `5.0.0` + +In addition to the changes of [sentry_dart](/platforms/dart/migrate/) +there are the following changes: + +- `SentryFlutterOptions.enableLifecycleBreadcrumbs` was removed. Use `SentryFlutterOptions.enableAppLifecycleBreadcrumbs` instead. +- The Web Plugin Registrant import changed from 'package:sentry_flutter/src/sentry_flutter_web.dart'; to 'package:sentry_flutter/sentry_flutter_web.dart'; + - This could lead to breaking changes. Typically it shouldn't because the referencing file is auto-generated. From 8e49c6e97994b6995e41dd7d4934762413ecd5d6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20Ueko=CC=88tter?= Date: Tue, 23 Mar 2021 07:29:18 +0100 Subject: [PATCH 02/11] Imporve migration guide with PR feedback --- src/platforms/dart/migration.mdx | 7 +++---- src/platforms/flutter/migration.mdx | 13 +++++-------- 2 files changed, 8 insertions(+), 12 deletions(-) diff --git a/src/platforms/dart/migration.mdx b/src/platforms/dart/migration.mdx index c54da53c25872..23fea68b68ed2 100644 --- a/src/platforms/dart/migration.mdx +++ b/src/platforms/dart/migration.mdx @@ -1,15 +1,13 @@ --- title: Migration Guide sidebar_order: 1000 -redirect_from: - - /platforms/dart/migrate/ --- -## Migrating from `sentry_dart` `4.0.x` to `sentry_dart` `5.0.0` +## Migrating from `sentry` `4.0.x` to `sentry` `5.0.0` * Fix: Prefix classes with Sentry * A couple of classes were often conflicting with user's code. - Thus this change renames the following classes: + As a result, this change renames the following classes: * `App` -> `SentryApp` * `Browser` -> `SentryBrowser` * `Device` -> `SentryDevice` @@ -17,5 +15,6 @@ redirect_from: * `Integration` -> `SentryIntegration` * `Message` -> `SentryMessage` * `OperatingSystem` -> `SentryOperatingSystem` + * `Orientation` -> `SentryOrientation` * `Request` -> `SentryRequest` * `User` -> `SentryUser` \ No newline at end of file diff --git a/src/platforms/flutter/migration.mdx b/src/platforms/flutter/migration.mdx index 0b520a5b9c6db..bd3f07e52c386 100644 --- a/src/platforms/flutter/migration.mdx +++ b/src/platforms/flutter/migration.mdx @@ -1,15 +1,12 @@ --- title: Migration Guide sidebar_order: 1000 -redirect_from: - - /platforms/flutter/migrate/ --- -## Migrating from `sentry_dart` `4.0.x` to `sentry_dart` `5.0.0` +## Migrating from `sentry_flutter` `4.0.x` to `sentry_flutter` `5.0.0` -In addition to the changes of [sentry_dart](/platforms/dart/migrate/) -there are the following changes: +In addition to the changes introduced in [sentry](/platforms/dart/migration/): -- `SentryFlutterOptions.enableLifecycleBreadcrumbs` was removed. Use `SentryFlutterOptions.enableAppLifecycleBreadcrumbs` instead. -- The Web Plugin Registrant import changed from 'package:sentry_flutter/src/sentry_flutter_web.dart'; to 'package:sentry_flutter/sentry_flutter_web.dart'; - - This could lead to breaking changes. Typically it shouldn't because the referencing file is auto-generated. +- `SentryFlutterOptions.enableLifecycleBreadcrumbs` was replaced with `SentryFlutterOptions.enableAppLifecycleBreadcrumbs`. +- The Web Plugin Registrant import changed from `import 'package:sentry_flutter/src/sentry_flutter_web.dart';` to `import 'package:sentry_flutter/sentry_flutter_web.dart';` + - This change may lead to breaking changes. In most cases, however, this change won't lead to breaking changed because the referencing file is auto-generated. From 5cd325ab52fff3fc05afacfecc547269fbf20f70 Mon Sep 17 00:00:00 2001 From: Manoel Aranda Neto <5731772+marandaneto@users.noreply.github.com> Date: Wed, 24 Mar 2021 08:46:28 +0100 Subject: [PATCH 03/11] Update src/platforms/dart/migration.mdx --- src/platforms/dart/migration.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/platforms/dart/migration.mdx b/src/platforms/dart/migration.mdx index 23fea68b68ed2..d195351ee9d28 100644 --- a/src/platforms/dart/migration.mdx +++ b/src/platforms/dart/migration.mdx @@ -17,4 +17,5 @@ sidebar_order: 1000 * `OperatingSystem` -> `SentryOperatingSystem` * `Orientation` -> `SentryOrientation` * `Request` -> `SentryRequest` - * `User` -> `SentryUser` \ No newline at end of file + * `User` -> `SentryUser` + * `Orientation` -> `SentryOrientation` From 92ac66b6a9b13fdd0dc9c48f6f1071cf2cb4ec42 Mon Sep 17 00:00:00 2001 From: Manoel Aranda Neto <5731772+marandaneto@users.noreply.github.com> Date: Wed, 24 Mar 2021 08:49:35 +0100 Subject: [PATCH 04/11] Update src/platforms/flutter/migration.mdx --- src/platforms/flutter/migration.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/platforms/flutter/migration.mdx b/src/platforms/flutter/migration.mdx index bd3f07e52c386..7bdf94a9c2d0a 100644 --- a/src/platforms/flutter/migration.mdx +++ b/src/platforms/flutter/migration.mdx @@ -9,4 +9,4 @@ In addition to the changes introduced in [sentry](/platforms/dart/migration/): - `SentryFlutterOptions.enableLifecycleBreadcrumbs` was replaced with `SentryFlutterOptions.enableAppLifecycleBreadcrumbs`. - The Web Plugin Registrant import changed from `import 'package:sentry_flutter/src/sentry_flutter_web.dart';` to `import 'package:sentry_flutter/sentry_flutter_web.dart';` - - This change may lead to breaking changes. In most cases, however, this change won't lead to breaking changed because the referencing file is auto-generated. +- This change may lead to breaking changes. In most cases, however, this change won't lead to breaking changes since the referencing file is auto-generated. From 7c4500b5945437a235e880c58d122504b0d79669 Mon Sep 17 00:00:00 2001 From: Manoel Aranda Neto <5731772+marandaneto@users.noreply.github.com> Date: Wed, 24 Mar 2021 13:16:04 +0100 Subject: [PATCH 05/11] Update src/platforms/dart/migration.mdx --- src/platforms/dart/migration.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/src/platforms/dart/migration.mdx b/src/platforms/dart/migration.mdx index d195351ee9d28..64e908dd3067e 100644 --- a/src/platforms/dart/migration.mdx +++ b/src/platforms/dart/migration.mdx @@ -18,4 +18,3 @@ sidebar_order: 1000 * `Orientation` -> `SentryOrientation` * `Request` -> `SentryRequest` * `User` -> `SentryUser` - * `Orientation` -> `SentryOrientation` From 83a4cfed5ec822d80d2993998d18c7fcc6867d29 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20Ueko=CC=88tter?= Date: Thu, 25 Mar 2021 15:32:24 +0100 Subject: [PATCH 06/11] Add notes about Dart version --- src/platforms/dart/migration.mdx | 1 + src/platforms/dart/usage/advanced-usage.mdx | 2 +- src/platforms/flutter/usage/advanced-usage.mdx | 3 +++ 3 files changed, 5 insertions(+), 1 deletion(-) diff --git a/src/platforms/dart/migration.mdx b/src/platforms/dart/migration.mdx index 64e908dd3067e..f8e9cb20bdf64 100644 --- a/src/platforms/dart/migration.mdx +++ b/src/platforms/dart/migration.mdx @@ -5,6 +5,7 @@ sidebar_order: 1000 ## Migrating from `sentry` `4.0.x` to `sentry` `5.0.0` +* Sentry's Dart/Flutter SDK version 5.0.0 and above requires Dart 1.12.0 * Fix: Prefix classes with Sentry * A couple of classes were often conflicting with user's code. As a result, this change renames the following classes: diff --git a/src/platforms/dart/usage/advanced-usage.mdx b/src/platforms/dart/usage/advanced-usage.mdx index 36fac33d5724e..d9752fe84aeb1 100644 --- a/src/platforms/dart/usage/advanced-usage.mdx +++ b/src/platforms/dart/usage/advanced-usage.mdx @@ -5,7 +5,7 @@ sidebar_order: 2 ## Requirements -- For the usage of the Dart SDK, the minimal required Dart SDK version is `2.8.0` and Flutter SDK version is `1.17.0` +- For the usage of the Dart SDK, the minimal required Dart SDK version is `2.12.0` and Flutter SDK version is `1.17.0` ## Automatic Breadcrumbs diff --git a/src/platforms/flutter/usage/advanced-usage.mdx b/src/platforms/flutter/usage/advanced-usage.mdx index 372854d45cf21..c749afd925da4 100644 --- a/src/platforms/flutter/usage/advanced-usage.mdx +++ b/src/platforms/flutter/usage/advanced-usage.mdx @@ -4,6 +4,9 @@ sidebar_order: 2 description: "Learn about advanced uses of the Flutter SDK, including uploading debug symbols, known limitations, and bundling." --- +## Requirements + +- For the usage of the Flutter SDK, the minimal required Dart SDK version is `2.12.0` and Flutter SDK version is `1.17.0` ## Uploading Debug Symbols (Android and iOS) From 3b903cc5c844f30611b16362a9023897baed53fd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20Uek=C3=B6tter?= Date: Thu, 25 Mar 2021 16:32:05 +0100 Subject: [PATCH 07/11] Update src/platforms/dart/usage/advanced-usage.mdx Co-authored-by: Manoel Aranda Neto <5731772+marandaneto@users.noreply.github.com> --- src/platforms/dart/usage/advanced-usage.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/platforms/dart/usage/advanced-usage.mdx b/src/platforms/dart/usage/advanced-usage.mdx index d9752fe84aeb1..ac14a79b01480 100644 --- a/src/platforms/dart/usage/advanced-usage.mdx +++ b/src/platforms/dart/usage/advanced-usage.mdx @@ -5,7 +5,7 @@ sidebar_order: 2 ## Requirements -- For the usage of the Dart SDK, the minimal required Dart SDK version is `2.12.0` and Flutter SDK version is `1.17.0` +- For the usage of the Dart SDK, the minimal required Dart SDK version is `2.12.0`. ## Automatic Breadcrumbs From 2fa53389a20f525d0fa5b59f8e5377d6a043d6b6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20Uek=C3=B6tter?= Date: Thu, 25 Mar 2021 18:10:30 +0100 Subject: [PATCH 08/11] Update src/platforms/dart/migration.mdx Co-authored-by: Manoel Aranda Neto <5731772+marandaneto@users.noreply.github.com> --- src/platforms/dart/migration.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/platforms/dart/migration.mdx b/src/platforms/dart/migration.mdx index f8e9cb20bdf64..b7b7552ba907b 100644 --- a/src/platforms/dart/migration.mdx +++ b/src/platforms/dart/migration.mdx @@ -5,7 +5,7 @@ sidebar_order: 1000 ## Migrating from `sentry` `4.0.x` to `sentry` `5.0.0` -* Sentry's Dart/Flutter SDK version 5.0.0 and above requires Dart 1.12.0 +* Sentry's Dart SDK version 5.0.0 and above requires Dart 1.12.0 * Fix: Prefix classes with Sentry * A couple of classes were often conflicting with user's code. As a result, this change renames the following classes: From d6cd5cb8cc9f306a889ed2e04d212fbd6eeeebb9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20Ueko=CC=88tter?= Date: Sun, 28 Mar 2021 11:11:40 +0200 Subject: [PATCH 09/11] increase required Dart SDK version --- src/includes/getting-started-primer/flutter.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/includes/getting-started-primer/flutter.mdx b/src/includes/getting-started-primer/flutter.mdx index d3651a9ea1467..a9ff4bcdaab13 100644 --- a/src/includes/getting-started-primer/flutter.mdx +++ b/src/includes/getting-started-primer/flutter.mdx @@ -17,4 +17,4 @@ Features: - as well as `http` with the [Dart SDK](/platforms/dart/) - [Release Health](/product/releases/health/) tracks crash free users and sessions - Limited support for Flutter Web -- Under the hood the SDK relies on the [Dart SDK](/platforms/dart/); the minimum required version is `2.8.0` and Flutter SDK version is `1.17.0`. +- 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 `1.17.0`. From 73fe81d2b030edc8b63ad6e822dd6d0b4847eb87 Mon Sep 17 00:00:00 2001 From: Manoel Aranda Neto <5731772+marandaneto@users.noreply.github.com> Date: Wed, 31 Mar 2021 10:58:10 +0200 Subject: [PATCH 10/11] Update src/platforms/dart/migration.mdx --- src/platforms/dart/migration.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/src/platforms/dart/migration.mdx b/src/platforms/dart/migration.mdx index b7b7552ba907b..d212c7771f54b 100644 --- a/src/platforms/dart/migration.mdx +++ b/src/platforms/dart/migration.mdx @@ -19,3 +19,4 @@ sidebar_order: 1000 * `Orientation` -> `SentryOrientation` * `Request` -> `SentryRequest` * `User` -> `SentryUser` +* Return type of `Sentry.close()` changed from `void` to `Future` and `Integration.close()` changed from `void` to `FutureOr` From 407e9202d54982f6eb1cae99d09fcb63b8341f2b Mon Sep 17 00:00:00 2001 From: Manoel Aranda Neto <5731772+marandaneto@users.noreply.github.com> Date: Wed, 31 Mar 2021 11:19:07 +0200 Subject: [PATCH 11/11] Update src/platforms/flutter/migration.mdx --- src/platforms/flutter/migration.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/platforms/flutter/migration.mdx b/src/platforms/flutter/migration.mdx index 7bdf94a9c2d0a..5e3b7ce4777da 100644 --- a/src/platforms/flutter/migration.mdx +++ b/src/platforms/flutter/migration.mdx @@ -7,6 +7,6 @@ sidebar_order: 1000 In addition to the changes introduced in [sentry](/platforms/dart/migration/): -- `SentryFlutterOptions.enableLifecycleBreadcrumbs` was replaced with `SentryFlutterOptions.enableAppLifecycleBreadcrumbs`. -- The Web Plugin Registrant import changed from `import 'package:sentry_flutter/src/sentry_flutter_web.dart';` to `import 'package:sentry_flutter/sentry_flutter_web.dart';` -- This change may lead to breaking changes. In most cases, however, this change won't lead to breaking changes since the referencing file is auto-generated. +* `SentryFlutterOptions.enableLifecycleBreadcrumbs` was replaced with `SentryFlutterOptions.enableAppLifecycleBreadcrumbs`. +* The Web Plugin Registrant import changed from `import 'package:sentry_flutter/src/sentry_flutter_web.dart';` to `import 'package:sentry_flutter/sentry_flutter_web.dart';` + * This change may lead to breaking changes. In most cases, however, this change won't lead to breaking changes since the referencing file is auto-generated.