Merge branch 'main' into fix/flutter-multiview-support

martinhaintz · martinhaintz · commit e4499413ff83 · 2024-08-27T11:08:26.000+02:00
* main: release: 8.8.0 chore: fix cocoa bump changelog (#2248) chore(deps): update Cocoa SDK to v8.35.1 (#2247) Provide a way to cause an example native crash from Flutter (#2239)
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,9 +1,11 @@
 # Changelog
 
-## Unreleased
+## 8.8.0
 
 ### Features
 
+- Add `SentryFlutter.nativeCrash()` using MethodChannels for Android and iOS ([#2239](https://github.com/getsentry/sentry-dart/pull/2239))
+  - This can be used to test if native crash reporting works  
 - Add `ignoreRoutes` parameter to `SentryNavigatorObserver`. ([#2218](https://github.com/getsentry/sentry-dart/pull/2218))
     - This will ignore the Routes and prevent the Route from being pushed to the Sentry server.
     - Ignored routes will also create no TTID and TTFD spans.
@@ -17,6 +19,9 @@ SentryNavigatorObserver(ignoreRoutes: ["/ignoreThisRoute"]),
 
 ### Dependencies
 
+- Bump Cocoa SDK from v8.33.0 to v8.35.1 ([#2247](https://github.com/getsentry/sentry-dart/pull/2247))
+  - [changelog](https://github.com/getsentry/sentry-cocoa/blob/main/CHANGELOG.md#8351)
+  - [diff](https://github.com/getsentry/sentry-cocoa/compare/8.33.0...8.35.1)
 - Bump Android SDK from v7.13.0 to v7.14.0 ([#2228](https://github.com/getsentry/sentry-dart/pull/2228))
   - [changelog](https://github.com/getsentry/sentry-java/blob/main/CHANGELOG.md#7140)
   - [diff](https://github.com/getsentry/sentry-java/compare/7.13.0...7.14.0)
diff --git a/dart/lib/src/version.dart b/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.7.0';
+const String sdkVersion = '8.8.0';
 
 String sdkName(bool isWeb) => isWeb ? _browserSdkName : _ioSdkName;
 
diff --git a/dart/pubspec.yaml b/dart/pubspec.yaml
@@ -1,5 +1,5 @@
 name: sentry
-version: 8.7.0
+version: 8.8.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.
diff --git a/dio/lib/src/version.dart b/dio/lib/src/version.dart
@@ -1,5 +1,5 @@
 /// The SDK version reported to Sentry.io in the submitted events.
-const String sdkVersion = '8.7.0';
+const String sdkVersion = '8.8.0';
 
 /// The package name reported to Sentry.io in the submitted events.
 const String packageName = 'pub:sentry_dio';
diff --git a/dio/pubspec.yaml b/dio/pubspec.yaml
@@ -1,6 +1,6 @@
 name: sentry_dio
 description: An integration which adds support for performance tracing for the Dio package.
-version: 8.7.0
+version: 8.8.0
 homepage: https://docs.sentry.io/platforms/dart/
 repository: https://github.com/getsentry/sentry-dart
 issue_tracker: https://github.com/getsentry/sentry-dart/issues
@@ -19,7 +19,7 @@ platforms:
 
 dependencies:
   dio: ^5.0.0
-  sentry: 8.7.0
+  sentry: 8.8.0
 
 dev_dependencies:
   meta: ^1.3.0
diff --git a/drift/lib/src/version.dart b/drift/lib/src/version.dart
@@ -1,5 +1,5 @@
 /// The SDK version reported to Sentry.io in the submitted events.
-const String sdkVersion = '8.7.0';
+const String sdkVersion = '8.8.0';
 
 /// The package name reported to Sentry.io in the submitted events.
 const String packageName = 'pub:sentry_drift';
diff --git a/drift/pubspec.yaml b/drift/pubspec.yaml
@@ -1,6 +1,6 @@
 name: sentry_drift
 description: An integration which adds support for performance tracing for the drift package.
-version: 8.7.0
+version: 8.8.0
 homepage: https://docs.sentry.io/platforms/flutter/
 repository: https://github.com/getsentry/sentry-dart
 issue_tracker: https://github.com/getsentry/sentry-dart/issues
@@ -17,7 +17,7 @@ platforms:
   web:
 
 dependencies:
-  sentry: 8.7.0
+  sentry: 8.8.0
   meta: ^1.3.0
   drift: ^2.13.0
 
diff --git a/file/lib/src/version.dart b/file/lib/src/version.dart
@@ -1,5 +1,5 @@
 /// The SDK version reported to Sentry.io in the submitted events.
-const String sdkVersion = '8.7.0';
+const String sdkVersion = '8.8.0';
 
 /// The package name reported to Sentry.io in the submitted events.
 const String packageName = 'pub:sentry_file';
diff --git a/file/pubspec.yaml b/file/pubspec.yaml
@@ -1,6 +1,6 @@
 name: sentry_file
 description: An integration which adds support for performance tracing for dart.io.File.
-version: 8.7.0
+version: 8.8.0
 homepage: https://docs.sentry.io/platforms/dart/
 repository: https://github.com/getsentry/sentry-dart
 issue_tracker: https://github.com/getsentry/sentry-dart/issues
@@ -17,7 +17,7 @@ platforms:
   windows:
 
 dependencies:
-  sentry: 8.7.0
+  sentry: 8.8.0
   meta: ^1.3.0
 
 dev_dependencies:
diff --git a/flutter/android/src/main/kotlin/io/sentry/flutter/SentryFlutterPlugin.kt b/flutter/android/src/main/kotlin/io/sentry/flutter/SentryFlutterPlugin.kt
@@ -3,6 +3,7 @@ package io.sentry.flutter
 import android.app.Activity
 import android.content.Context
 import android.os.Build
+import android.os.Looper
 import android.util.Log
 import io.flutter.embedding.engine.plugins.FlutterPlugin
 import io.flutter.embedding.engine.plugins.activity.ActivityAware
@@ -49,8 +50,8 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
 
     sentryFlutter =
       SentryFlutter(
-        androidSdk = androidSdk,
-        nativeSdk = nativeSdk,
+        androidSdk = ANDROID_SDK,
+        nativeSdk = NATIVE_SDK,
       )
   }
 
@@ -74,6 +75,7 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
       "removeTag" -> removeTag(call.argument("key"), result)
       "loadContexts" -> loadContexts(result)
       "displayRefreshRate" -> displayRefreshRate(result)
+      "nativeCrash" -> crash()
       else -> result.notImplemented()
     }
   }
@@ -413,16 +415,17 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
   }
 
   companion object {
+    private const val FLUTTER_SDK = "sentry.dart.flutter"
+    private const val ANDROID_SDK = "sentry.java.android.flutter"
+    private const val NATIVE_SDK = "sentry.native.android.flutter"
+    private const val NATIVE_CRASH_WAIT_TIME = 500L
 
-    private const val flutterSdk = "sentry.dart.flutter"
-    private const val androidSdk = "sentry.java.android.flutter"
-    private const val nativeSdk = "sentry.native.android.flutter"
     private fun setEventOriginTag(event: SentryEvent) {
       event.sdk?.let {
         when (it.name) {
-          flutterSdk -> setEventEnvironmentTag(event, "flutter", "dart")
-          androidSdk -> setEventEnvironmentTag(event, environment = "java")
-          nativeSdk -> setEventEnvironmentTag(event, environment = "native")
+          FLUTTER_SDK -> setEventEnvironmentTag(event, "flutter", "dart")
+          ANDROID_SDK -> setEventEnvironmentTag(event, environment = "java")
+          NATIVE_SDK -> setEventEnvironmentTag(event, environment = "native")
           else -> return
         }
       }
@@ -439,7 +442,7 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
 
     private fun addPackages(event: SentryEvent, sdk: SdkVersion?) {
       event.sdk?.let {
-        if (it.name == flutterSdk) {
+        if (it.name == FLUTTER_SDK) {
           sdk?.packageSet?.forEach { sentryPackage ->
             it.addPackage(sentryPackage.name, sentryPackage.version)
           }
@@ -449,6 +452,13 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
         }
       }
     }
+
+    private fun crash() {
+      val exception = RuntimeException("FlutterSentry Native Integration: Sample RuntimeException")
+      val mainThread = Looper.getMainLooper().thread
+      mainThread.uncaughtExceptionHandler.uncaughtException(mainThread, exception)
+      mainThread.join(NATIVE_CRASH_WAIT_TIME)
+    }
   }
 
   private fun loadContexts(result: Result) {
diff --git a/flutter/example/lib/main.dart b/flutter/example/lib/main.dart
@@ -761,6 +761,12 @@ class AndroidExample extends StatelessWidget {
         },
         child: const Text('Platform exception'),
       ),
+      ElevatedButton(
+        onPressed: () async {
+          SentryFlutter.nativeCrash();
+        },
+        child: const Text('Sentry.nativeCrash'),
+      ),
     ]);
   }
 }
@@ -873,6 +879,12 @@ class CocoaExample extends StatelessWidget {
           },
           child: const Text('Objective-C SEGFAULT'),
         ),
+        ElevatedButton(
+          onPressed: () async {
+            SentryFlutter.nativeCrash();
+          },
+          child: const Text('Sentry.nativeCrash'),
+        ),
       ],
     );
   }
diff --git a/flutter/example/pubspec.yaml b/flutter/example/pubspec.yaml
@@ -1,6 +1,6 @@
 name: sentry_flutter_example
 description: Demonstrates how to use the sentry_flutter plugin.
-version: 8.7.0
+version: 8.8.0
 
 publish_to: 'none' # Remove this line if you wish to publish to pub.dev
 
diff --git a/flutter/ios/Classes/SentryFlutterPluginApple.swift b/flutter/ios/Classes/SentryFlutterPluginApple.swift
@@ -174,6 +174,9 @@ public class SentryFlutterPluginApple: NSObject, FlutterPlugin {
         case "resumeAppHangTracking":
             resumeAppHangTracking(result)
 
+        case "nativeCrash":
+            crash()
+
         default:
             result(FlutterMethodNotImplemented)
         }
@@ -729,6 +732,10 @@ public class SentryFlutterPluginApple: NSObject, FlutterPlugin {
         SentrySDK.resumeAppHangTracking()
         result("")
     }
+
+    private func crash() {
+        SentrySDK.crash()
+    }
 }
 
 // swiftlint:enable function_body_length
diff --git a/flutter/ios/sentry_flutter.podspec b/flutter/ios/sentry_flutter.podspec
@@ -16,7 +16,7 @@ Sentry SDK for Flutter with support to native through sentry-cocoa.
                          :tag => s.version.to_s }
   s.source_files     = 'Classes/**/*'
   s.public_header_files = 'Classes/**/*.h'
-  s.dependency 'Sentry/HybridSDK', '8.33.0'
+  s.dependency 'Sentry/HybridSDK', '8.35.1'
   s.ios.dependency 'Flutter'
   s.osx.dependency 'FlutterMacOS'
   s.ios.deployment_target = '12.0'
diff --git a/flutter/lib/src/native/sentry_native_binding.dart b/flutter/lib/src/native/sentry_native_binding.dart
@@ -57,4 +57,6 @@ abstract class SentryNativeBinding {
   Future<void> pauseAppHangTracking();
 
   Future<void> resumeAppHangTracking();
+
+  Future<void> nativeCrash();
 }
diff --git a/flutter/lib/src/native/sentry_native_channel.dart b/flutter/lib/src/native/sentry_native_channel.dart
@@ -194,4 +194,7 @@ class SentryNativeChannel
   @override
   Future<void> resumeAppHangTracking() =>
       _channel.invokeMethod('resumeAppHangTracking');
+
+  @override
+  Future<void> nativeCrash() => _channel.invokeMethod('nativeCrash');
 }
diff --git a/flutter/lib/src/sentry_flutter.dart b/flutter/lib/src/sentry_flutter.dart
@@ -249,11 +249,7 @@ mixin SentryFlutter {
   /// Only for iOS and macOS.
   static Future<void> pauseAppHangTracking() {
     if (_native == null) {
-      // ignore: invalid_use_of_internal_member
-      Sentry.currentHub.options.logger(
-        SentryLevel.debug,
-        'Native integration is not available. Make sure SentryFlutter is initialized before accessing the pauseAppHangTracking API.',
-      );
+      _logNativeIntegrationNotAvailable("pauseAppHangTracking");
       return Future<void>.value();
     }
     return _native!.pauseAppHangTracking();
@@ -263,11 +259,7 @@ mixin SentryFlutter {
   /// Only for iOS and macOS
   static Future<void> resumeAppHangTracking() {
     if (_native == null) {
-      // ignore: invalid_use_of_internal_member
-      Sentry.currentHub.options.logger(
-        SentryLevel.debug,
-        'Native integration is not available. Make sure SentryFlutter is initialized before accessing the resumeAppHangTracking API.',
-      );
+      _logNativeIntegrationNotAvailable("resumeAppHangTracking");
       return Future<void>.value();
     }
     return _native!.resumeAppHangTracking();
@@ -280,4 +272,23 @@ mixin SentryFlutter {
   static set native(SentryNativeBinding? value) => _native = value;
 
   static SentryNativeBinding? _native;
+
+  /// Use `nativeCrash()` to crash the native implementation and test/debug the crash reporting for native code.
+  /// This should not be used in production code.
+  /// Only for Android, iOS and macOS
+  static Future<void> nativeCrash() {
+    if (_native == null) {
+      _logNativeIntegrationNotAvailable("nativeCrash");
+      return Future<void>.value();
+    }
+    return _native!.nativeCrash();
+  }
+
+  static void _logNativeIntegrationNotAvailable(String methodName) {
+    // ignore: invalid_use_of_internal_member
+    Sentry.currentHub.options.logger(
+      SentryLevel.debug,
+      'Native integration is not available. Make sure SentryFlutter is initialized before accessing the $methodName API.',
+    );
+  }
 }
diff --git a/flutter/lib/src/version.dart b/flutter/lib/src/version.dart
@@ -1,5 +1,5 @@
 /// The SDK version reported to Sentry.io in the submitted events.
-const String sdkVersion = '8.7.0';
+const String sdkVersion = '8.8.0';
 
 /// The default SDK name reported to Sentry.io in the submitted events.
 const String sdkName = 'sentry.dart.flutter';
diff --git a/flutter/pubspec.yaml b/flutter/pubspec.yaml
@@ -1,5 +1,5 @@
 name: sentry_flutter
-version: 8.7.0
+version: 8.8.0
 description: Sentry SDK for Flutter. This package aims to support different Flutter targets by relying on the many platforms supported by Sentry with native SDKs.
 homepage: https://docs.sentry.io/platforms/flutter/
 repository: https://github.com/getsentry/sentry-dart
@@ -23,7 +23,7 @@ dependencies:
     sdk: flutter
   flutter_web_plugins:
     sdk: flutter
-  sentry: 8.7.0
+  sentry: 8.8.0
   package_info_plus: '>=1.0.0'
   meta: ^1.3.0
   ffi: ^2.0.0
diff --git a/flutter/test/sentry_native_channel_test.dart b/flutter/test/sentry_native_channel_test.dart
@@ -302,6 +302,15 @@ void main() {
 
         verify(channel.invokeMethod('resumeAppHangTracking'));
       });
+
+      test('nativeCrash', () async {
+        when(channel.invokeMethod('nativeCrash'))
+            .thenAnswer((_) => Future.value());
+
+        await sut.nativeCrash();
+
+        verify(channel.invokeMethod('nativeCrash'));
+      });
     });
   }
 }
diff --git a/hive/lib/src/version.dart b/hive/lib/src/version.dart
@@ -1,5 +1,5 @@
 /// The SDK version reported to Sentry.io in the submitted events.
-const String sdkVersion = '8.7.0';
+const String sdkVersion = '8.8.0';
 
 /// The package name reported to Sentry.io in the submitted events.
 const String packageName = 'pub:sentry_hive';
diff --git a/hive/pubspec.yaml b/hive/pubspec.yaml
@@ -1,6 +1,6 @@
 name: sentry_hive
 description: An integration which adds support for performance tracing for the hive package.
-version: 8.7.0
+version: 8.8.0
 homepage: https://docs.sentry.io/platforms/flutter/
 repository: https://github.com/getsentry/sentry-dart
 issue_tracker: https://github.com/getsentry/sentry-dart/issues
@@ -17,7 +17,7 @@ platforms:
   web:
 
 dependencies:
-  sentry: 8.7.0
+  sentry: 8.8.0
   hive: ^2.2.3
   meta: ^1.3.0
 
diff --git a/isar/lib/src/version.dart b/isar/lib/src/version.dart
@@ -1,5 +1,5 @@
 /// The SDK version reported to Sentry.io in the submitted events.
-const String sdkVersion = '8.7.0';
+const String sdkVersion = '8.8.0';
 
 /// The package name reported to Sentry.io in the submitted events.
 const String packageName = 'pub:sentry_isar';
diff --git a/isar/pubspec.yaml b/isar/pubspec.yaml
diff --git a/logging/lib/src/version.dart b/logging/lib/src/version.dart
diff --git a/logging/pubspec.yaml b/logging/pubspec.yaml
diff --git a/sqflite/lib/src/version.dart b/sqflite/lib/src/version.dart
diff --git a/sqflite/pubspec.yaml b/sqflite/pubspec.yaml

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@ package io.sentry.flutter`
`3`	`3`	`import android.app.Activity`
`4`	`4`	`import android.content.Context`
`5`	`5`	`import android.os.Build`
	`6`	`+import android.os.Looper`
`6`	`7`	`import android.util.Log`
`7`	`8`	`import io.flutter.embedding.engine.plugins.FlutterPlugin`
`8`	`9`	`import io.flutter.embedding.engine.plugins.activity.ActivityAware`
`@@ -49,8 +50,8 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {`
`49`	`50`
`50`	`51`	`sentryFlutter =`
`51`	`52`	`SentryFlutter(`
`52`		`- androidSdk = androidSdk,`
`53`		`- nativeSdk = nativeSdk,`
	`53`	`+ androidSdk = ANDROID_SDK,`
	`54`	`+ nativeSdk = NATIVE_SDK,`
`54`	`55`	`)`
`55`	`56`	`}`
`56`	`57`
`@@ -74,6 +75,7 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {`
`74`	`75`	`"removeTag" -> removeTag(call.argument("key"), result)`
`75`	`76`	`"loadContexts" -> loadContexts(result)`
`76`	`77`	`"displayRefreshRate" -> displayRefreshRate(result)`
	`78`	`+ "nativeCrash" -> crash()`
`77`	`79`	`else -> result.notImplemented()`
`78`	`80`	`}`
`79`	`81`	`}`
`@@ -413,16 +415,17 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {`
`413`	`415`	`}`
`414`	`416`
`415`	`417`	`companion object {`
	`418`	`+ private const val FLUTTER_SDK = "sentry.dart.flutter"`
	`419`	`+ private const val ANDROID_SDK = "sentry.java.android.flutter"`
	`420`	`+ private const val NATIVE_SDK = "sentry.native.android.flutter"`
	`421`	`+ private const val NATIVE_CRASH_WAIT_TIME = 500L`
`416`	`422`
`417`		`- private const val flutterSdk = "sentry.dart.flutter"`
`418`		`- private const val androidSdk = "sentry.java.android.flutter"`
`419`		`- private const val nativeSdk = "sentry.native.android.flutter"`
`420`	`423`	`private fun setEventOriginTag(event: SentryEvent) {`
`421`	`424`	`event.sdk?.let {`
`422`	`425`	`when (it.name) {`
`423`		`- flutterSdk -> setEventEnvironmentTag(event, "flutter", "dart")`
`424`		`- androidSdk -> setEventEnvironmentTag(event, environment = "java")`
`425`		`- nativeSdk -> setEventEnvironmentTag(event, environment = "native")`
	`426`	`+ FLUTTER_SDK -> setEventEnvironmentTag(event, "flutter", "dart")`
	`427`	`+ ANDROID_SDK -> setEventEnvironmentTag(event, environment = "java")`
	`428`	`+ NATIVE_SDK -> setEventEnvironmentTag(event, environment = "native")`
`426`	`429`	`else -> return`
`427`	`430`	`}`
`428`	`431`	`}`
`@@ -439,7 +442,7 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {`
`439`	`442`
`440`	`443`	`private fun addPackages(event: SentryEvent, sdk: SdkVersion?) {`
`441`	`444`	`event.sdk?.let {`
`442`		`- if (it.name == flutterSdk) {`
	`445`	`+ if (it.name == FLUTTER_SDK) {`
`443`	`446`	`sdk?.packageSet?.forEach { sentryPackage ->`
`444`	`447`	`it.addPackage(sentryPackage.name, sentryPackage.version)`
`445`	`448`	`}`
`@@ -449,6 +452,13 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {`
`449`	`452`	`}`
`450`	`453`	`}`
`451`	`454`	`}`
	`455`	`+`
	`456`	`+ private fun crash() {`
	`457`	`+ val exception = RuntimeException("FlutterSentry Native Integration: Sample RuntimeException")`
	`458`	`+ val mainThread = Looper.getMainLooper().thread`
	`459`	`+ mainThread.uncaughtExceptionHandler.uncaughtException(mainThread, exception)`
	`460`	`+ mainThread.join(NATIVE_CRASH_WAIT_TIME)`
	`461`	`+ }`
`452`	`462`	`}`
`453`	`463`
`454`	`464`	`private fun loadContexts(result: Result) {`