fix(flutter): Await Android scope worker sync

Return worker request futures for Android scope updates so awaited scope
observer calls complete after native scope synchronization finishes.

Co-Authored-By: GPT-5.5 <noreply@openai.com>
Co-authored-by: Cursor <cursoragent@cursor.com>

Author: 3 people

packages/flutter/lib/src/native/java/android_core_worker.dart

@@ -160,67 +160,95 @@ class AndroidCoreWorker {
     }
   }
 
-  void addBreadcrumb(Breadcrumb breadcrumb) {
-    if (_isClosed) return;
+  FutureOr<void> addBreadcrumb(Breadcrumb breadcrumb) {
+    if (_isClosed) return null;
 
     final client = _worker;
     if (client == null) {
       _addBreadcrumb(breadcrumb.toJson(),
           automatedTestMode: _config.automatedTestMode);
-      return;
+      return null;
     }
 
-    _addBreadcrumbFromWorker(client, breadcrumb);
+    return _addBreadcrumbFromWorker(client, breadcrumb);
   }
 
-  void _addBreadcrumbFromWorker(
+  Future<void> _addBreadcrumbFromWorker(
     Worker client,
     Breadcrumb breadcrumb,
-  ) {
-    client.send(_AddBreadcrumbRequest(_normalizeJsonMap(breadcrumb.toJson())));
-  }
+  ) =>
+      _sendScopeUpdateToWorker(
+        client,
+        _AddBreadcrumbRequest(_normalizeJsonMap(breadcrumb.toJson())),
+        'add breadcrumb',
+      );
 
-  void setUser(SentryUser? user) {
-    if (_isClosed) return;
+  FutureOr<void> setUser(SentryUser? user) {
+    if (_isClosed) return null;
 
     final client = _worker;
     if (client == null) {
       _setUser(user?.toJson(), automatedTestMode: _config.automatedTestMode);
-      return;
+      return null;
     }
 
-    _setUserFromWorker(client, user);
+    return _setUserFromWorker(client, user);
   }
 
-  void _setUserFromWorker(
+  Future<void> _setUserFromWorker(
     Worker client,
     SentryUser? user,
-  ) {
-    client.send(_SetUserRequest(
-      user == null ? null : _normalizeJsonMap(user.toJson()),
-    ));
-  }
+  ) =>
+      _sendScopeUpdateToWorker(
+        client,
+        _SetUserRequest(
+          user == null ? null : _normalizeJsonMap(user.toJson()),
+        ),
+        'set user',
+      );
 
-  void setContexts(String key, dynamic value) {
-    if (_isClosed) return;
+  FutureOr<void> setContexts(String key, dynamic value) {
+    if (_isClosed) return null;
 
     final normalizedValue = _normalizeJson(value);
     final client = _worker;
     if (client == null) {
       _setContexts(key, normalizedValue,
           automatedTestMode: _config.automatedTestMode);
-      return;
+      return null;
     }
 
-    _setContextsFromWorker(client, key, normalizedValue);
+    return _setContextsFromWorker(client, key, normalizedValue);
   }
 
-  void _setContextsFromWorker(
+  Future<void> _setContextsFromWorker(
     Worker client,
     String key,
     Object? value,
-  ) {
-    client.send(_SetContextsRequest(key, value));
+  ) =>
+      _sendScopeUpdateToWorker(
+        client,
+        _SetContextsRequest(key, value),
+        'set context',
+      );
+
+  Future<void> _sendScopeUpdateToWorker(
+    Worker client,
+    Object request,
+    String operation,
+  ) async {
+    try {
+      await client.request(request);
+    } catch (exception, stackTrace) {
+      internalLogger.error(
+        'Android core worker failed to $operation',
+        error: exception,
+        stackTrace: stackTrace,
+      );
+      if (_config.automatedTestMode) {
+        rethrow;
+      }
+    }
   }
 
   static void _entryPoint((SendPort, WorkerConfig) init) {
@@ -258,15 +286,29 @@ class _AndroidCoreWorkerHandler extends WorkerHandler {
 
   @override
   FutureOr<Object?> onRequest(Object? payload) => _enqueue<Object?>(() {
-        return switch (payload) {
-          _LoadDebugImagesRequest request => _loadDebugImageMaps(
+        switch (payload) {
+          case _LoadDebugImagesRequest request:
+            return _loadDebugImageMaps(
               request.instructionAddresses,
               automatedTestMode: _config.automatedTestMode,
-            ),
-          _LoadContextsRequest _ =>
-            _loadContexts(automatedTestMode: _config.automatedTestMode),
-          _ => _unexpectedPayload(payload),
-        };
+            );
+          case _LoadContextsRequest _:
+            return _loadContexts(automatedTestMode: _config.automatedTestMode);
+          case _AddBreadcrumbRequest request:
+            _addBreadcrumb(request.breadcrumb,
+                automatedTestMode: _config.automatedTestMode);
+            return null;
+          case _SetUserRequest request:
+            _setUser(request.user,
+                automatedTestMode: _config.automatedTestMode);
+            return null;
+          case _SetContextsRequest request:
+            _setContexts(request.key, request.value,
+                automatedTestMode: _config.automatedTestMode);
+            return null;
+          default:
+            return _unexpectedPayload(payload);
+        }
       });
 
   /// Serializes JNI work inside the worker isolate.

packages/flutter/lib/src/native/java/sentry_native_java.dart

@@ -121,24 +121,20 @@ class SentryNativeJava extends SentryNativeChannel {
   }
 
   @override
-  FutureOr<void> addBreadcrumb(Breadcrumb breadcrumb) {
-    _coreWorker?.addBreadcrumb(breadcrumb);
-  }
+  FutureOr<void> addBreadcrumb(Breadcrumb breadcrumb) =>
+      _coreWorker?.addBreadcrumb(breadcrumb);
 
   @override
   void clearBreadcrumbs() => tryCatchSync('clearBreadcrumbs', () {
         native.Sentry.clearBreadcrumbs();
       });
 
   @override
-  FutureOr<void> setUser(SentryUser? user) {
-    _coreWorker?.setUser(user);
-  }
+  FutureOr<void> setUser(SentryUser? user) => _coreWorker?.setUser(user);
 
   @override
-  FutureOr<void> setContexts(String key, value) {
-    _coreWorker?.setContexts(key, value);
-  }
+  FutureOr<void> setContexts(String key, value) =>
+      _coreWorker?.setContexts(key, value);
 
   @override
   void removeContexts(String key) => tryCatchSync('removeContexts', () {

packages/flutter/test/native/android_core_worker_test_real.dart

@@ -2,6 +2,7 @@
 // ignore_for_file: invalid_use_of_internal_member
 library;
 
+import 'dart:async';
 import 'dart:isolate';
 import 'dart:typed_data';
 
@@ -239,14 +240,15 @@ void main() {
       expect(await resultFuture, isNull);
     });
 
-    test('sends breadcrumb update without awaiting response', () async {
+    test('sends breadcrumb update and awaits response', () async {
       final fixture = _Fixture();
       final worker = fixture.getSut();
       await worker.start();
 
-      worker.addBreadcrumb(Breadcrumb(message: 'crumb'));
+      final payload = await fixture.expectPendingRequest(
+        worker.addBreadcrumb(Breadcrumb(message: 'crumb')),
+      );
 
-      final payload = await fixture.nextMessage;
       expect((payload as dynamic).breadcrumb['message'], 'crumb');
     });
 
@@ -255,25 +257,27 @@ void main() {
       final worker = fixture.getSut();
       await worker.start();
 
-      worker.addBreadcrumb(Breadcrumb(
-        message: 'crumb',
-        data: {'value': _UnserializableValue()},
-      ));
+      final payload = await fixture.expectPendingRequest(
+        worker.addBreadcrumb(Breadcrumb(
+          message: 'crumb',
+          data: {'value': _UnserializableValue()},
+        )),
+      );
 
-      final payload = await fixture.nextMessage;
       expect((payload as dynamic).breadcrumb['data'], {
         'value': 'normalized-value',
       });
     });
 
-    test('sends user update without awaiting response', () async {
+    test('sends user update and awaits response', () async {
       final fixture = _Fixture();
       final worker = fixture.getSut();
       await worker.start();
 
-      worker.setUser(SentryUser(id: 'fixture-user'));
+      final payload = await fixture.expectPendingRequest(
+        worker.setUser(SentryUser(id: 'fixture-user')),
+      );
 
-      final payload = await fixture.nextMessage;
       expect((payload as dynamic).user['id'], 'fixture-user');
     });
 
@@ -282,14 +286,15 @@ void main() {
       final worker = fixture.getSut();
       await worker.start();
 
-      worker.setUser(SentryUser(
-        id: 'fixture-user',
-        data: {'value': _UnserializableValue()},
-        // ignore: deprecated_member_use
-        extras: {'extra': _UnserializableValue()},
-      ));
+      final payload = await fixture.expectPendingRequest(
+        worker.setUser(SentryUser(
+          id: 'fixture-user',
+          data: {'value': _UnserializableValue()},
+          // ignore: deprecated_member_use
+          extras: {'extra': _UnserializableValue()},
+        )),
+      );
 
-      final payload = await fixture.nextMessage;
       final user = (payload as dynamic).user as Map;
       expect(user['data'], {
         'value': 'normalized-value',
@@ -299,16 +304,17 @@ void main() {
       });
     });
 
-    test('sends context update without awaiting response', () async {
+    test('sends context update and awaits response', () async {
       final fixture = _Fixture();
       final worker = fixture.getSut();
       await worker.start();
 
-      worker.setContexts('fixture-key', <dynamic, dynamic>{
-        'nested': <dynamic, dynamic>{'value': true}
-      });
+      final payload = await fixture.expectPendingRequest(
+        worker.setContexts('fixture-key', <dynamic, dynamic>{
+          'nested': <dynamic, dynamic>{'value': true}
+        }),
+      );
 
-      final payload = await fixture.nextMessage;
       expect((payload as dynamic).key, 'fixture-key');
       expect((payload as dynamic).value, {
         'nested': {'value': true}
@@ -332,8 +338,6 @@ class _Fixture {
     return request;
   }
 
-  Future<Object?> get nextMessage => inboxes.last.first;
-
   void respond(int id, Object? response) {
     responsePorts.last.send((id, response));
   }
@@ -342,6 +346,21 @@ class _Fixture {
     respond(id, RemoteError('worker failure', StackTrace.current.toString()));
   }
 
+  Future<Object?> expectPendingRequest(FutureOr<void> update) async {
+    final updateFuture = Future<void>.value(update);
+    var completed = false;
+    unawaited(updateFuture.then((_) => completed = true));
+
+    final (id, payload) = await nextRequest;
+    await pumpEventQueue();
+    expect(completed, isFalse);
+
+    respond(id, null);
+    await updateFuture;
+    expect(completed, isTrue);
+    return payload;
+  }
+
   Future<Worker> _fakeSpawn(WorkerConfig config, WorkerEntry entry) async {
     final inbox = ReceivePort();
     inboxes.add(inbox);