Refactor loadContexts and loadDebugImages to use JNI and FFI (#3224)

* First draft

* Pin Android SDK to 8.18.0

* Update

* Update

* Add assert

* Update

* Update

* Remove method channels

* Update sentry-native to 0.10.0 and regenerate bindings

* Update

* Update

* Update

* Update

* Update impl

* Update

* Update

* Update

* Update

* Update

* Update

* Update

* Update

* Update

* Update

* Update

* Update

* Update

* Update

* Make functions nullable

* Enable integration tests on iOS

* Lint

* Update CHANGELOG

* Lint

* Lint

* Try to fix headers

* Fix tests

* Update

* Add macos links

* Use non-nulls

* Update

* Update

* Update

* Update

* Update

* Update

* Update

* Add test for utf8 decoding

* Update

* Update SentryFlutterFFI to SentryFlutterPlugin

* Update macOS file links

* Fix swiftlint

* Update ffi-cocoa.yaml

* Set applicationContext to null in onDetachedFromEngine

* Build ios example without code sign

* Update macOS file links

* Update

* Update ffi-cocoa.yaml

---------

Co-authored-by: markushi <[email protected]>

Author: buenaflor

.github/workflows/flutter_test.yml

@@ -20,7 +20,7 @@ env:
   SENTRY_AUTH_TOKEN_E2E: ${{ secrets.SENTRY_AUTH_TOKEN_E2E }}
 
 jobs:
-  test-android:
+  android:
     runs-on: ubuntu-latest
     timeout-minutes: 30
     defaults:
@@ -146,22 +146,29 @@ jobs:
           echo "name=${device}" >> "$GITHUB_OUTPUT"
 
       - name: run integration test
-        # Disable flutter integration tests for iOS for now (https://github.com/getsentry/sentry-dart/issues/1605#issuecomment-1695809346)
-        if: ${{ matrix.target != 'ios' }}
         run: |
           flutter test -d "${{ steps.device.outputs.name }}" integration_test/all.dart --dart-define SENTRY_AUTH_TOKEN_E2E=$SENTRY_AUTH_TOKEN_E2E --verbose
+
+      # We can only run this in macos. iOS simulator doesn't support profile mode.
+      - name: run integration test in profile mode
+        if: ${{ matrix.target == 'macos' }}
+        run: |
           flutter drive --driver=integration_test/test_driver/driver.dart --target=integration_test/sentry_widgets_flutter_binding_test.dart --profile -d "${{ steps.device.outputs.name }}"
 
       - name: run native test
         # We only have the native unit test package in the iOS xcodeproj at the moment.
         # Should be OK because it will likely be removed after switching to FFI (see https://github.com/getsentry/sentry-dart/issues/1444).
         if: ${{ matrix.target != 'macos' }}
         working-directory: packages/flutter/example/${{ matrix.target }}
-        run: xcodebuild test -workspace Runner.xcworkspace -scheme Runner -configuration Debug -destination "platform=$DEVICE_PLATFORM" -allowProvisioningUpdates CODE_SIGNING_ALLOWED=NO
+        # For some reason running native unit tests directly after Flutter integration tests fails
+        # running flutter build ios before works: https://stackoverflow.com/a/77487525/22813624
+        run: |
+          flutter build ios --no-codesign
+          xcodebuild test -workspace Runner.xcworkspace -scheme Runner -configuration Debug -destination "platform=$DEVICE_PLATFORM" -allowProvisioningUpdates CODE_SIGNING_ALLOWED=NO
         env:
           DEVICE_PLATFORM: ${{ steps.device.outputs.platform }}
 
-  test-web:
+  web:
     runs-on: ubuntu-latest
     timeout-minutes: 30
     defaults:

CHANGELOG.md

@@ -18,14 +18,12 @@
 
 - Add `DioException` response data to error breadcrumb ([#3164](https://github.com/getsentry/sentry-dart/pull/3164))
   - Bumped `dio` min verion to `5.2.0`
-- Support additional request data types in `dio` package ([#3170](https://github.com/getsentry/sentry-dart/pull/3170))
-  - Add support for `json`, `UInt8List`, `num`, `bool`, `FormData`, `Multipart` request data.
 - 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))
 - Remove async usage from `FlutterErrorIntegration` ([#3202](https://github.com/getsentry/sentry-dart/pull/3202))
 - Tag all spans during app start with start type info ([#3190](https://github.com/getsentry/sentry-dart/pull/3190))
-- Improve `SentryLogBatcher` flush logic ([#3211](https://github.com/getsentry/sentry-dart/pull/3187))
+- Refactor `loadContexts` and `loadDebugImages` to use JNI and FFI ([#3224](https://github.com/getsentry/sentry-dart/pull/3224))
 
 ### Dependencies
 

packages/dart/lib/src/protocol/sentry_device.dart

@@ -214,7 +214,9 @@ class SentryDevice {
           : null,
       processorCount: json['processor_count'],
       cpuDescription: json['cpu_description'],
-      processorFrequency: json['processor_frequency'],
+      processorFrequency: (json['processor_frequency'] is num)
+          ? (json['processor_frequency'] as num).toDouble()
+          : null,
       deviceType: json['device_type'],
       batteryStatus: json['battery_status'],
       deviceUniqueIdentifier: json['device_unique_identifier'],

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

@@ -29,6 +29,8 @@ import io.sentry.protocol.DebugImage
 import io.sentry.protocol.SentryId
 import io.sentry.protocol.User
 import io.sentry.transport.CurrentDateProvider
+import org.json.JSONObject
+import org.json.JSONArray
 import java.lang.ref.WeakReference
 import kotlin.math.roundToInt
 
@@ -50,6 +52,7 @@ class SentryFlutterPlugin :
     pluginRegistrationTime = System.currentTimeMillis()
 
     context = flutterPluginBinding.applicationContext
+    applicationContext = context
     channel = MethodChannel(flutterPluginBinding.binaryMessenger, "sentry_flutter")
     channel.setMethodCallHandler(this)
 
@@ -63,7 +66,6 @@ class SentryFlutterPlugin :
   ) {
     when (call.method) {
       "initNativeSdk" -> initNativeSdk(call, result)
-      "loadImageList" -> loadImageList(call, result)
       "closeNativeSdk" -> closeNativeSdk(result)
       "fetchNativeAppStart" -> fetchNativeAppStart(result)
       "setContexts" -> setContexts(call.argument("key"), call.argument("value"), result)
@@ -75,7 +77,6 @@ class SentryFlutterPlugin :
       "removeExtra" -> removeExtra(call.argument("key"), result)
       "setTag" -> setTag(call.argument("key"), call.argument("value"), result)
       "removeTag" -> removeTag(call.argument("key"), result)
-      "loadContexts" -> loadContexts(result)
       "displayRefreshRate" -> displayRefreshRate(result)
       "nativeCrash" -> crash()
       "setReplayConfig" -> setReplayConfig(call, result)
@@ -90,6 +91,7 @@ class SentryFlutterPlugin :
     }
 
     channel.setMethodCallHandler(null)
+    applicationContext = null
   }
 
   override fun onAttachedToActivity(binding: ActivityPluginBinding) {
@@ -367,42 +369,6 @@ class SentryFlutterPlugin :
 
     result.success("")
   }
-  private fun loadImageList(
-    call: MethodCall,
-    result: Result,
-  ) {
-    val options = HubAdapter.getInstance().options as SentryAndroidOptions
-
-    val addresses = call.arguments() as List<String>? ?: listOf()
-    val debugImages =
-      if (addresses.isEmpty()) {
-        options.debugImagesLoader
-          .loadDebugImages()
-          ?.toList()
-          .serialize()
-      } else {
-        options.debugImagesLoader
-          .loadDebugImagesForAddresses(addresses.toSet())
-          ?.ifEmpty { options.debugImagesLoader.loadDebugImages() }
-          ?.toList()
-          .serialize()
-      }
-
-    result.success(debugImages)
-  }
-
-  private fun List<DebugImage>?.serialize() = this?.map { it.serialize() }
-
-  private fun DebugImage.serialize() =
-    mapOf(
-      "image_addr" to imageAddr,
-      "image_size" to imageSize,
-      "code_file" to codeFile,
-      "type" to type,
-      "debug_id" to debugId,
-      "code_id" to codeId,
-      "debug_file" to debugFile,
-    )
 
   private fun closeNativeSdk(result: Result) {
     HubAdapter.getInstance().close()
@@ -414,11 +380,70 @@ class SentryFlutterPlugin :
     @SuppressLint("StaticFieldLeak")
     private var replay: ReplayIntegration? = null
 
+    @SuppressLint("StaticFieldLeak")
+    private var applicationContext: Context? = null
+
     private const val NATIVE_CRASH_WAIT_TIME = 500L
 
     @JvmStatic
     fun privateSentryGetReplayIntegration(): ReplayIntegration? = replay
 
+    @JvmStatic
+    fun getApplicationContext(): Context? = applicationContext
+
+    @JvmStatic
+    fun loadContextsAsBytes(): ByteArray? {
+      val options = HubAdapter.getInstance().options
+      val context = getApplicationContext()
+      if (options !is SentryAndroidOptions || context == null) {
+        return null
+      }
+      val currentScope = InternalSentrySdk.getCurrentScope()
+      val serializedScope =
+        InternalSentrySdk.serializeScope(
+          context,
+          options,
+          currentScope,
+        )
+      val json = JSONObject(serializedScope).toString()
+      return json.toByteArray(Charsets.UTF_8)
+    }
+
+    @JvmStatic
+    fun loadDebugImagesAsBytes(addresses: Set<String>): ByteArray? {
+      val options = HubAdapter.getInstance().options as SentryAndroidOptions
+
+      val debugImages =
+        if (addresses.isEmpty()) {
+          options.debugImagesLoader
+            .loadDebugImages()
+            ?.toList()
+            .serialize()
+        } else {
+          options.debugImagesLoader
+            .loadDebugImagesForAddresses(addresses)
+            ?.ifEmpty { options.debugImagesLoader.loadDebugImages() }
+            ?.toList()
+            .serialize()
+        }
+
+      val json = JSONArray(debugImages).toString()
+      return json.toByteArray(Charsets.UTF_8)
+    }
+
+    private fun List<DebugImage>?.serialize() = this?.map { it.serialize() }
+
+    private fun DebugImage.serialize() =
+      mapOf(
+        "image_addr" to imageAddr,
+        "image_size" to imageSize,
+        "code_file" to codeFile,
+        "type" to type,
+        "debug_id" to debugId,
+        "code_id" to codeId,
+        "debug_file" to debugFile,
+      )
+
     private fun crash() {
       val exception = RuntimeException("FlutterSentry Native Integration: Sample RuntimeException")
       val mainThread = Looper.getMainLooper().thread
@@ -436,22 +461,6 @@ class SentryFlutterPlugin :
     }
   }
 
-  private fun loadContexts(result: Result) {
-    val options = HubAdapter.getInstance().options
-    if (options !is SentryAndroidOptions) {
-      result.success(null)
-      return
-    }
-    val currentScope = InternalSentrySdk.getCurrentScope()
-    val serializedScope =
-      InternalSentrySdk.serializeScope(
-        context,
-        options,
-        currentScope,
-      )
-    result.success(serializedScope)
-  }
-
   private fun setReplayConfig(
     call: MethodCall,
     result: Result,