Use FFI/JNI for captureEnvelope on iOS and Android (#3115)

* base impl for JNI

* base impl for cocoa -> maybe improve perf

* update

* update

* update

* update

* update

* Remove method channels for captureEnvelope

* Update

* Update

* Update

* Update

* Update

* Update

* Update

* Update

* Update

* Update sentry_native_channel_test.dart

* Update

* Update

* Update

* Update

* Update

* Update test

* Update test

* Update CHANGELOG

* Update CHANGELOG

* Update native bindings

* Test not verbose

* fix test

* Update

* Update

* Update

* Update tests

* Fix analyze

* Fix tests

* Fix tests

* Fix linux tests

* Fix imports

* Ignore coverage for ffi/jni captureEnvelope paths

* Fix potential memory leak

* Update

* Fix

* Fix

* Update

* Analyze

* Revert github workflow

* Update

* Update

Author: buenaflor

.github/actions/flutter-test/action.yml

@@ -21,7 +21,7 @@ runs:
         distribution: 'adopt'
 
     # Install required dependencies for Flutter on Linux on Ubuntu
-    - name: "Setup Linux"
+    - name: 'Setup Linux'
       if: matrix.target == 'linux'
       shell: bash
       run: |
@@ -44,11 +44,15 @@ runs:
         else
           testCmd="flutter test --test-randomize-ordering-seed=random"
         fi
-        
+
         if ${{ (matrix.target == 'linux' && matrix.sdk == 'stable' && 'true') || 'false' }} ; then
           $testCmd --coverage
           if [[ "$INPUT_DIRECTORY" == 'packages/flutter' ]]; then
+            # Remove native binding/bridge files from coverage.
+            # These FFI/JNI bindings are currently not unit tested due to limitations of FFI/JNI mocking.
             dart run remove_from_coverage -f coverage/lcov.info -r 'binding.dart'
+            dart run remove_from_coverage -f coverage/lcov.info -r 'lib/src/native/java/sentry_native_java.dart'
+            dart run remove_from_coverage -f coverage/lcov.info -r 'lib/src/native/cocoa/sentry_native_cocoa.dart'
           fi
         else
           $testCmd

CHANGELOG.md

@@ -16,6 +16,7 @@
 
 - Add `DioException` response data to error breadcrumb ([#3164](https://github.com/getsentry/sentry-dart/pull/3164))
   - Bumped `dio` min verion to `5.2.0`
+- Use FFI/JNI for `captureEnvelope` on iOS and Android ([#3115](https://github.com/getsentry/sentry-dart/pull/3115))
 - Log a warning when dropping envelope items ([#3165](https://github.com/getsentry/sentry-dart/pull/3165))
 - Call options.log for structured logs ([#3187](https://github.com/getsentry/sentry-dart/pull/3187))
 - Tag all spans during app start with start type info ([#3190](https://github.com/getsentry/sentry-dart/pull/3190))

packages/flutter/android/src/main/kotlin/io/sentry/flutter/SentryFlutterPlugin.kt

@@ -63,7 +63,6 @@ class SentryFlutterPlugin :
   ) {
     when (call.method) {
       "initNativeSdk" -> initNativeSdk(call, result)
-      "captureEnvelope" -> captureEnvelope(call, result)
       "loadImageList" -> loadImageList(call, result)
       "closeNativeSdk" -> closeNativeSdk(result)
       "fetchNativeAppStart" -> fetchNativeAppStart(result)
@@ -368,32 +367,6 @@ class SentryFlutterPlugin :
 
     result.success("")
   }
-
-  private fun captureEnvelope(
-    call: MethodCall,
-    result: Result,
-  ) {
-    if (!Sentry.isEnabled()) {
-      result.error("1", "The Sentry Android SDK is disabled", null)
-      return
-    }
-    val args = call.arguments() as List<Any>? ?: listOf()
-    if (args.isNotEmpty()) {
-      val event = args.first() as ByteArray?
-      val containsUnhandledException = args[1] as Boolean
-      if (event != null && event.isNotEmpty()) {
-        val id = InternalSentrySdk.captureEnvelope(event, containsUnhandledException)
-        if (id != null) {
-          result.success("")
-        } else {
-          result.error("2", "Failed to capture envelope", null)
-        }
-        return
-      }
-    }
-    result.error("3", "Envelope is null or empty", null)
-  }
-
   private fun loadImageList(
     call: MethodCall,
     result: Result,

packages/flutter/ffi-jni.yaml

@@ -13,6 +13,7 @@ output:
 log_level: all
 
 classes:
+  - io.sentry.android.core.InternalSentrySdk
   - io.sentry.android.replay.ReplayIntegration
   - io.sentry.flutter.SentryFlutterPlugin
   - android.graphics.Bitmap

packages/flutter/ios/sentry_flutter/Sources/sentry_flutter/SentryFlutterPlugin.swift

@@ -81,9 +81,6 @@ public class SentryFlutterPlugin: NSObject, FlutterPlugin {
         case "closeNativeSdk":
             closeNativeSdk(call, result: result)
 
-        case "captureEnvelope":
-            captureEnvelope(call, result: result)
-
         case "fetchNativeAppStart":
             fetchNativeAppStart(result: result)
 
@@ -412,24 +409,6 @@ public class SentryFlutterPlugin: NSObject, FlutterPlugin {
         return !name.isEmpty
     }
 
-    private func captureEnvelope(_ call: FlutterMethodCall, result: @escaping FlutterResult) {
-        guard let arguments = call.arguments as? [Any],
-              !arguments.isEmpty,
-              let data = (arguments.first as? FlutterStandardTypedData)?.data else {
-            print("Envelope is null or empty!")
-            result(FlutterError(code: "2", message: "Envelope is null or empty", details: nil))
-            return
-        }
-        guard let envelope = PrivateSentrySDKOnly.envelope(with: data) else {
-            print("Cannot parse the envelope data")
-            result(FlutterError(code: "3", message: "Cannot parse the envelope data", details: nil))
-            return
-        }
-        PrivateSentrySDKOnly.capture(envelope)
-        result("")
-        return
-    }
-
     struct TimeSpan {
         var startTimestampMsSinceEpoch: NSNumber
         var stopTimestampMsSinceEpoch: NSNumber

packages/flutter/lib/src/native/cocoa/sentry_native_cocoa.dart

@@ -1,4 +1,5 @@
 import 'dart:async';
+import 'dart:typed_data';
 import 'package:meta/meta.dart';
 import 'package:objective_c/objective_c.dart';
 
@@ -50,6 +51,30 @@ class SentryNativeCocoa extends SentryNativeChannel {
     return super.init(hub);
   }
 
+  // coverage: ignore-start
+  @override
+  FutureOr<void> captureEnvelope(
+      Uint8List envelopeData, bool containsUnhandledException) {
+    try {
+      final nsData = envelopeData.toNSData();
+      final envelope = cocoa.PrivateSentrySDKOnly.envelopeWithData(nsData);
+      if (envelope != null) {
+        cocoa.PrivateSentrySDKOnly.captureEnvelope(envelope);
+      } else {
+        options.log(
+            SentryLevel.error, 'Failed to capture envelope: envelope is null');
+      }
+    } catch (exception, stackTrace) {
+      options.log(SentryLevel.error, 'Failed to capture envelope',
+          exception: exception, stackTrace: stackTrace);
+
+      if (options.automatedTestMode) {
+        rethrow;
+      }
+    }
+  }
+  // coverage: ignore-end
+
   @override
   FutureOr<void> setReplayConfig(ReplayConfig config) {
     // Note: unused on iOS.