Refactor: move native breadcrumbs sync to FFI/JNI

CHANGELOG.md

@@ -9,6 +9,7 @@
 
 ### Enhancements
 
+- Refactor native breadcrumbs sync to use FFI/JNI ([#3293](https://github.com/getsentry/sentry-dart/pull/3293/))
 - Refactor app hang and crash apis to use FFI/JNI ([#3289](https://github.com/getsentry/sentry-dart/pull/3289/))
 - Refactor `AndroidReplayRecorder` to use the new worker isolate api ([#3296](https://github.com/getsentry/sentry-dart/pull/3296/))
 - Refactor fetching app start and display refresh rate to use FFI and JNI ([#3288](https://github.com/getsentry/sentry-dart/pull/3288/))

packages/dart/lib/src/scope_observer.dart

@@ -7,8 +7,8 @@ abstract class ScopeObserver {
   Future<void> setContexts(String key, dynamic value);
   Future<void> removeContexts(String key);
   Future<void> setUser(SentryUser? user);
-  Future<void> addBreadcrumb(Breadcrumb breadcrumb);
-  Future<void> clearBreadcrumbs();
+  FutureOr<void> addBreadcrumb(Breadcrumb breadcrumb);
+  FutureOr<void> clearBreadcrumbs();
   Future<void> setExtra(String key, dynamic value);
   Future<void> removeExtra(String key);
   Future<void> setTag(String key, String value);

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

@@ -64,8 +64,6 @@ class SentryFlutterPlugin :
       "setContexts" -> setContexts(call.argument("key"), call.argument("value"), result)
       "removeContexts" -> removeContexts(call.argument("key"), result)
       "setUser" -> setUser(call.argument("user"), result)
-      "addBreadcrumb" -> addBreadcrumb(call.argument("breadcrumb"), result)
-      "clearBreadcrumbs" -> clearBreadcrumbs(result)
       "setExtra" -> setExtra(call.argument("key"), call.argument("value"), result)
       "removeExtra" -> removeExtra(call.argument("key"), result)
       "setTag" -> setTag(call.argument("key"), call.argument("value"), result)
@@ -189,24 +187,6 @@ class SentryFlutterPlugin :
     result.success("")
   }
 
-  private fun addBreadcrumb(
-    breadcrumb: Map<String, Any?>?,
-    result: Result,
-  ) {
-    if (breadcrumb != null) {
-      val options = ScopesAdapter.getInstance().options
-      val breadcrumbInstance = Breadcrumb.fromMap(breadcrumb, options)
-      Sentry.addBreadcrumb(breadcrumbInstance)
-    }
-    result.success("")
-  }
-
-  private fun clearBreadcrumbs(result: Result) {
-    Sentry.clearBreadcrumbs()
-
-    result.success("")
-  }
-
   private fun setExtra(
     key: String?,
     value: String?,

packages/flutter/example/integration_test/integration_test.dart

@@ -564,6 +564,51 @@ void main() {
     }
   });
 
+  testWidgets('addBreadcrumb and clearBreadcrumbs sync to native',
+      (tester) async {
+    await restoreFlutterOnErrorAfter(() async {
+      await setupSentryAndApp(tester);
+    });
+
+    // 1. Add a breadcrumb via Dart
+    final testBreadcrumb = Breadcrumb(
+      message: 'test-breadcrumb-message',
+      category: 'test-category',
+      level: SentryLevel.info,
+    );
+    await Sentry.addBreadcrumb(testBreadcrumb);
+
+    // 2. Verify it appears in native via loadContexts
+    var contexts = await SentryFlutter.native?.loadContexts();
+    expect(contexts, isNotNull);
+
+    var breadcrumbs = contexts!['breadcrumbs'] as List<dynamic>?;
+    expect(breadcrumbs, isNotNull,
+        reason: 'Breadcrumbs should not be null after adding');
+    expect(breadcrumbs!.isNotEmpty, isTrue,
+        reason: 'Breadcrumbs should not be empty after adding');
+
+    // Find our test breadcrumb
+    final testCrumb = breadcrumbs.firstWhere(
+      (b) => b['message'] == 'test-breadcrumb-message',
+      orElse: () => null,
+    );
+    expect(testCrumb, isNotNull,
+        reason: 'Test breadcrumb should exist in native breadcrumbs');
+    expect(testCrumb['category'], equals('test-category'));
+
+    // 3. Clear breadcrumbs
+    await Sentry.configureScope((scope) async {
+      await scope.clearBreadcrumbs();
+    });
+
+    // 4. Verify they're cleared in native
+    contexts = await SentryFlutter.native?.loadContexts();
+    breadcrumbs = contexts!['breadcrumbs'] as List<dynamic>?;
+    expect(breadcrumbs == null || breadcrumbs.isEmpty, isTrue,
+        reason: 'Breadcrumbs should be null or empty after clearing');
+  });
+
   testWidgets('loads debug images through loadDebugImages', (tester) async {
     await restoreFlutterOnErrorAfter(() async {
       await setupSentryAndApp(tester);

packages/flutter/ffi-cocoa.yaml

@@ -6,6 +6,7 @@ headers:
   entry-points:
     - ./temp/Sentry.framework/PrivateHeaders/PrivateSentrySDKOnly.h
     - ./temp/Sentry.framework/Headers/Sentry-Swift.h
+    - ./temp/Sentry.framework/Headers/SentryScope.h
     - ./ios/sentry_flutter/Sources/sentry_flutter_objc/SentryFlutterPlugin.h
 compiler-opts:
   - -DSENTRY_TARGET_PROFILING_SUPPORTED=1
@@ -19,6 +20,7 @@ objc-interfaces:
     - PrivateSentrySDKOnly
     - SentryId
     - SentryFlutterPlugin
+    - SentryScope
     - SentrySDK
   module:
     'SentryId': 'Sentry'
@@ -29,6 +31,11 @@ objc-interfaces:
         - 'crash'
         - 'pauseAppHangTracking'
         - 'resumeAppHangTracking'
+        - 'configureScope:'
+        - 'addBreadcrumb:'
+    SentryScope:
+      include:
+        - 'clearBreadcrumbs'
 preamble: |
   // ignore_for_file: type=lint, unused_element
 

packages/flutter/ffi-jni.yaml

@@ -16,4 +16,7 @@ classes:
   - io.sentry.android.core.InternalSentrySdk
   - io.sentry.android.replay.ReplayIntegration
   - io.sentry.flutter.SentryFlutterPlugin
+  - io.sentry.Sentry
+  - io.sentry.Breadcrumb
+  - io.sentry.ScopesAdapter
   - android.graphics.Bitmap

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

@@ -92,14 +92,6 @@ public class SentryFlutterPlugin: NSObject, FlutterPlugin {
             let user = arguments?["user"] as? [String: Any]
             setUser(user: user, result: result)
 
-        case "addBreadcrumb":
-            let arguments = call.arguments as? [String: Any?]
-            let breadcrumb = arguments?["breadcrumb"] as? [String: Any]
-            addBreadcrumb(breadcrumb: breadcrumb, result: result)
-
-        case "clearBreadcrumbs":
-            clearBreadcrumbs(result: result)
-
         case "setExtra":
             let arguments = call.arguments as? [String: Any?]
             let key = arguments?["key"] as? String
@@ -322,22 +314,6 @@ public class SentryFlutterPlugin: NSObject, FlutterPlugin {
       result("")
     }
 
-    private func addBreadcrumb(breadcrumb: [String: Any]?, result: @escaping FlutterResult) {
-      if let breadcrumb = breadcrumb {
-        let breadcrumbInstance = PrivateSentrySDKOnly.breadcrumb(with: breadcrumb)
-        SentrySDK.addBreadcrumb(breadcrumbInstance)
-      }
-      result("")
-    }
-
-    private func clearBreadcrumbs(result: @escaping FlutterResult) {
-      SentrySDK.configureScope { scope in
-        scope.clearBreadcrumbs()
-
-        result("")
-      }
-    }
-
     private func setExtra(key: String?, value: Any?, result: @escaping FlutterResult) {
       guard let key = key else {
         result("")

packages/flutter/ios/sentry_flutter/Sources/sentry_flutter_objc/include/ns_number.h

@@ -0,0 +1,17 @@
+// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+// We need to add this file until we update the objective_c package due to a bug
+// See the issue: https://github.com/dart-lang/native/pull/2581
+
+#ifndef OBJECTIVE_C_SRC_NS_NUMBER_H_
+#define OBJECTIVE_C_SRC_NS_NUMBER_H_
+
+#import <Foundation/Foundation.h>
+
+@interface NSNumber (NSNumberIsFloat)
+@property (readonly) bool isFloat;
+@end
+
+#endif  // OBJECTIVE_C_SRC_NS_NUMBER_H_

packages/flutter/ios/sentry_flutter/Sources/sentry_flutter_objc/ns_number.m

@@ -0,0 +1,15 @@
+// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+// We need to add this file until we update the objective_c package due to a bug
+// See the issue: https://github.com/dart-lang/native/pull/2581
+
+#import "ns_number.h"
+
+@implementation NSNumber (NSNumberIsFloat)
+-(bool)isFloat {
+    const char *t = [self objCType];
+    return strcmp(t, @encode(float)) == 0 || strcmp(t, @encode(double)) == 0;
+}
+@end