Provide a way to cause an example native crash from Flutter

CHANGELOG.md

@@ -4,6 +4,8 @@
 
 ### Features
 
+- Add `SentryFlutter.nativeCrash()` using MethodChannels for Android and iOS ([#2239](https:/getsentry/sentry-dart/pull/2239))
+ - This can be used to test if native crash reporting works 
 - Add `ignoreRoutes` parameter to `SentryNavigatorObserver`. ([#2218](https:/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.

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) {

flutter/example/lib/main.dart

@@ -758,6 +758,12 @@ class AndroidExample extends StatelessWidget {
  },
  child: const Text('Platform exception'),
  ),
+ ElevatedButton(
+ onPressed: () async {
+ SentryFlutter.nativeCrash();
+ },
+ child: const Text('Sentry.nativeCrash'),
+ ),
  ]);
  }
 }
@@ -870,6 +876,12 @@ class CocoaExample extends StatelessWidget {
  },
  child: const Text('Objective-C SEGFAULT'),
  ),
+ ElevatedButton(
+ onPressed: () async {
+ SentryFlutter.nativeCrash();
+ },
+ child: const Text('Sentry.nativeCrash'),
+ ),
  ],
  );
  }

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

flutter/lib/src/native/sentry_native_binding.dart

@@ -57,4 +57,6 @@ abstract class SentryNativeBinding {
  Future<void> pauseAppHangTracking();
 
  Future<void> resumeAppHangTracking();
+
+ Future<void> nativeCrash();
 }

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');
 }

flutter/lib/src/sentry_flutter.dart

@@ -249,11 +249,7 @@
  /// 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 @@
  /// 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 @@
  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.',
+ );
+ }
 }

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'));
+ });
  });
  }
 }