Feat/only send debug images referenced in the stacktrace for events

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Enhancements
 
+- Only send debug images referenced in the stacktrace for events ([#2329](https://github.com/getsentry/sentry-dart/pull/2329))
 - Remove `sentry` frames if SDK falls back to current stack trace ([#2351](https://github.com/getsentry/sentry-dart/pull/2351))  
   - Flutter doesn't always provide stack traces for unhandled errors - this is normal Flutter behavior
   - When no stack trace is provided (in Flutter errors, `captureException`, or `captureMessage`):

flutter/ios/Classes/SentryFlutterPlugin.h

@@ -4,5 +4,7 @@
     #import <FlutterMacOS/FlutterMacOS.h>
 #endif
 
+#import <Sentry/SentryDebugImageProvider.h>
+
 @interface SentryFlutterPlugin : NSObject<FlutterPlugin>
 @end

flutter/ios/Classes/SentryFlutterPluginApple.swift

@@ -96,7 +96,7 @@ public class SentryFlutterPluginApple: NSObject, FlutterPlugin {
             loadContexts(result: result)
 
         case "loadImageList":
-            loadImageList(result: result)
+            loadImageList(call, result: result)
 
         case "initNativeSdk":
             initNativeSdk(call, result: result)
@@ -277,9 +277,32 @@ public class SentryFlutterPluginApple: NSObject, FlutterPlugin {
         }
     }
 
-    private func loadImageList(result: @escaping FlutterResult) {
-      let debugImages = PrivateSentrySDKOnly.getDebugImages() as [DebugMeta]
-      result(debugImages.map { $0.serialize() })
+    private func loadImageList(_ call: FlutterMethodCall, result: @escaping FlutterResult) {
+        var debugImages: [DebugMeta] = []
+
+        if let arguments = call.arguments as? [String], !arguments.isEmpty {
+            var imagesAddresses: Set<String> = []
+
+            for argument in arguments {
+                let hexDigits = argument.replacingOccurrences(of: "0x", with: "")
+                if let instructionAddress = UInt64(hexDigits, radix: 16) {
+                    let image = SentryDependencyContainer.sharedInstance().binaryImageCache.image(
+                        byAddress: instructionAddress)
+                    if let image = image {
+                        let imageAddress = sentry_formatHexAddressUInt64(image.address)!
+                        imagesAddresses.insert(imageAddress)
+                    }
+                }
+            }
+            debugImages =
+              SentryDependencyContainer.sharedInstance().debugImageProvider
+              .getDebugImagesForImageAddressesFromCache(imageAddresses: imagesAddresses) as [DebugMeta]
+        }
+        if debugImages.isEmpty {
+            debugImages = PrivateSentrySDKOnly.getDebugImages() as [DebugMeta]
+        }
+
+        result(debugImages.map { $0.serialize() })
     }
 
     private func initNativeSdk(_ call: FlutterMethodCall, result: @escaping FlutterResult) {

flutter/lib/src/native/sentry_native_channel.dart

@@ -186,8 +186,15 @@
   @override
   Future<List<DebugImage>?> loadDebugImages(SentryStackTrace stackTrace) =>
       tryCatchAsync('loadDebugImages', () async {
-        final images = await channel
-            .invokeListMethod<Map<dynamic, dynamic>>('loadImageList');
+        Set<String> instructionAddresses = {};
+        for (var frame in stackTrace.frames) {
+          if (frame.instructionAddr != null) {
+            instructionAddresses.add(frame.instructionAddr!);
+          }
+        }
+
+        final images = await channel.invokeListMethod<Map<dynamic, dynamic>>(
+            'loadImageList', instructionAddresses.toList());
         return images
             ?.map((e) => e.cast<String, dynamic>())
             .map(DebugImage.fromJson)

flutter/test/sentry_native_channel_test.dart

@@ -291,7 +291,7 @@ void main() {
           }
         ];
 
-        when(channel.invokeMethod('loadImageList'))
+        when(channel.invokeMethod('loadImageList', any))
             .thenAnswer((invocation) async => json);
 
         final data = await sut.loadDebugImages(SentryStackTrace(frames: []));