Skip to content

Commit 668977b

Browse files
authored
[flutter_tools] Guard socket streams and done futures against socket reset errors (flutter#192941)
When remote peers abruptly terminate or reset network connections, POSIX event handlers (such as epoll) trigger low-level socket reset errors (`SocketException: Error event raised in event handler : error condition has been reset, port = 0`) via `_NativeSocket.multiplex`. If these socket error events occur on streams or sink `done` futures that lack error handlers, or when adding to/closing sinks in an error state, the unhandled exception escapes into the Zone and causes Flutter tool crashes. This change: - Introduces `FutureErrorHandling<T>` in `packages/flutter_tools/lib/src/base/common.dart` to provide a reusable `.handleError(...)` extension on `Future` for background futures without requiring empty `(_) {}` callbacks. - Guards `createVmServiceDelegate` channel streams, sink `done` futures, and sink operations against `SocketException`. - Guards `DaemonStreams.fromSocket`, `DaemonStreams.connect`, and daemon server `socket.done` and `socket.addStream` futures. - Adds `onError` handling to `ProxiedPortForwarder` forwarded socket streams. - Adds `onError` handling to `ResidentRunner` log streams. - Adds error handling to `AndroidConsole` socket `done` future on connect and destroy. - Adds unit tests for `FutureErrorHandling.handleError` (including `test` predicate filtering) and regression tests verifying that socket stream and done future errors do not crash the tool. Fixes flutter#192935 ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [x] All existing and new tests are passing.
1 parent 55b8f88 commit 668977b

12 files changed

Lines changed: 520 additions & 39 deletions

File tree

‎packages/flutter_tools/lib/src/android/android_console.dart‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,11 @@
22
// Use of this source code is governed by a BSD-style license that can be
33
// found in the LICENSE file.
44

5+
import 'dart:async';
6+
57
import 'package:async/async.dart';
68

9+
import '../base/common.dart';
710
import '../base/io.dart';
811
import '../convert.dart';
912

@@ -34,6 +37,12 @@ class AndroidConsole {
3437
assert(_socket != null);
3538
assert(_queue == null);
3639

40+
unawaited(
41+
_socket!.done.handleError((Object _, StackTrace _) {
42+
// Socket error, handled when reading or destroying.
43+
}),
44+
);
45+
3746
_queue = StreamQueue<String>(_socket!.asyncMap(ascii.decode));
3847

3948
// Discard any initial connection text.

‎packages/flutter_tools/lib/src/base/common.dart‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
// Use of this source code is governed by a BSD-style license that can be
33
// found in the LICENSE file.
44

5+
import 'dart:async';
6+
57
/// Throws a specialized exception to exit with an actionable [message].
68
///
79
/// A [ToolExit] is interpreted by the `flutter` tool to mean "exit the tool
@@ -46,3 +48,33 @@ final class ToolExit implements Exception {
4648
@override
4749
String toString() => 'Error: $message';
4850
}
51+
52+
/// Error handling extensions on [Future].
53+
extension FutureErrorHandling<T> on Future<T> {
54+
/// Handles errors on this future without requiring an empty `.then` callback.
55+
///
56+
/// Useful for guarding background sink/socket completion futures
57+
/// (e.g., `socket.done`, `sink.done`) against unhandled zone exceptions.
58+
///
59+
/// This uses `Future.then` with a statically typed `(Object, StackTrace)`
60+
/// `onError` callback rather than `Future.catchError` or `Future.onError`,
61+
/// which are banned across `flutter_tools` by `AvoidFutureCatchError`
62+
/// (`dev/bots/custom_rules/avoid_future_catcherror.dart`, added in
63+
/// https://github.com/flutter/flutter/pull/130662) because they are not
64+
/// statically type-safe (see https://github.com/dart-lang/sdk/issues/51248).
65+
Future<void> handleError(
66+
void Function(Object error, StackTrace stackTrace) onError, {
67+
bool Function(Object error)? test,
68+
}) {
69+
return then<void>(
70+
(_) {},
71+
onError: (Object error, StackTrace stackTrace) {
72+
if (test == null || test(error)) {
73+
onError(error, stackTrace);
74+
} else {
75+
Error.throwWithStackTrace(error, stackTrace);
76+
}
77+
},
78+
);
79+
}
80+
}

‎packages/flutter_tools/lib/src/commands/daemon.dart‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -229,13 +229,13 @@ class DaemonServer {
229229
// We have to listen to socket.done. Otherwise when the connection is
230230
// reset, we will receive an uncatchable exception.
231231
// https://github.com/dart-lang/sdk/issues/25518
232-
final Future<void> socketDone = socket.done.then<void>(
233-
(_) {},
234-
onError: (Object error, StackTrace stackTrace) {
235-
logger.printError('Socket error: $error');
236-
logger.printTrace('$stackTrace');
237-
},
238-
);
232+
final Future<void> socketDone = socket.done.handleError((
233+
Object error,
234+
StackTrace stackTrace,
235+
) {
236+
logger.printError('Socket error: $error');
237+
logger.printTrace('$stackTrace');
238+
});
239239
final daemon = Daemon(
240240
DaemonConnection(
241241
daemonStreams: DaemonStreams.fromSocket(socket, logger: logger),

‎packages/flutter_tools/lib/src/daemon.dart‎

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -181,8 +181,17 @@ class DaemonStreams {
181181
: this(stdio.stdin, stdio.stdout, logger: logger);
182182

183183
/// Creates a [DaemonStreams] that uses [Socket] as the underlying streams.
184-
DaemonStreams.fromSocket(Socket socket, {required Logger logger})
185-
: this(socket, socket, logger: logger);
184+
factory DaemonStreams.fromSocket(Socket socket, {required Logger logger}) {
185+
// We have to listen to socket.done. Otherwise when the connection is
186+
// reset, we will receive an uncatchable exception.
187+
// https://github.com/dart-lang/sdk/issues/25518
188+
unawaited(
189+
socket.done.handleError((Object error, StackTrace stackTrace) {
190+
logger.printTrace('Socket error: $error\n$stackTrace');
191+
}),
192+
);
193+
return DaemonStreams(socket, socket, logger: logger);
194+
}
186195

187196
/// Connects to a server and creates a [DaemonStreams] from the connection as the underlying streams.
188197
factory DaemonStreams.connect(String host, int port, {required Logger logger}) {
@@ -191,8 +200,30 @@ class DaemonStreams {
191200
final outputStreamController = StreamController<List<int>>();
192201
socketFuture.then<void>(
193202
(Socket socket) {
194-
inputStreamController.addStream(socket);
195-
socket.addStream(outputStreamController.stream);
203+
// We have to listen to socket.done. Otherwise when the connection is
204+
// reset, we will receive an uncatchable exception.
205+
// https://github.com/dart-lang/sdk/issues/25518
206+
unawaited(
207+
socket.done.handleError((Object error, StackTrace stackTrace) {
208+
logger.printTrace('Socket error: $error\n$stackTrace');
209+
}),
210+
);
211+
unawaited(
212+
inputStreamController.addStream(socket).handleError((
213+
Object error,
214+
StackTrace stackTrace,
215+
) {
216+
logger.printTrace('Error adding socket to input stream: $error\n$stackTrace');
217+
}),
218+
);
219+
unawaited(
220+
socket.addStream(outputStreamController.stream).handleError((
221+
Object error,
222+
StackTrace stackTrace,
223+
) {
224+
logger.printTrace('Error adding output stream to socket: $error\n$stackTrace');
225+
}),
226+
);
196227
},
197228
onError: (Object error, StackTrace stackTrace) {
198229
logger.printError('Socket error: $error');

‎packages/flutter_tools/lib/src/proxied_devices/devices.dart‎

Lines changed: 24 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -691,25 +691,30 @@ class ProxiedPortForwarder extends DevicePortForwarder {
691691
},
692692
),
693693
);
694-
debounceDataStream(socket).listen((Uint8List data) {
695-
unawaited(
696-
connection
697-
.sendRequest('proxy.write', <String, Object>{'id': id}, data)
698-
.then(
699-
(Object? obj) => obj,
700-
onError: (Object error, StackTrace stackTrace) {
701-
// Log the error, but proceed normally. Network failure should not
702-
// crash the tool. If this is critical, the place where the connection
703-
// is being used would crash.
704-
_logger.printWarning('Write to remote proxy error: $error');
705-
_logger.printTrace(
706-
'Write to remote proxy error: $error, stack trace: $stackTrace',
707-
);
708-
return null;
709-
},
710-
),
711-
);
712-
});
694+
debounceDataStream(socket).listen(
695+
(Uint8List data) {
696+
unawaited(
697+
connection
698+
.sendRequest('proxy.write', <String, Object>{'id': id}, data)
699+
.then(
700+
(Object? obj) => obj,
701+
onError: (Object error, StackTrace stackTrace) {
702+
// Log the error, but proceed normally. Network failure should not
703+
// crash the tool. If this is critical, the place where the connection
704+
// is being used would crash.
705+
_logger.printWarning('Write to remote proxy error: $error');
706+
_logger.printTrace(
707+
'Write to remote proxy error: $error, stack trace: $stackTrace',
708+
);
709+
return null;
710+
},
711+
),
712+
);
713+
},
714+
onError: (Object error, StackTrace stackTrace) {
715+
_logger.printTrace('Socket error: $error\n$stackTrace');
716+
},
717+
);
713718
_connectedSockets.add(socket);
714719

715720
unawaited(

‎packages/flutter_tools/lib/src/resident_runner.dart‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -335,11 +335,16 @@ class FlutterDevice {
335335
} else {
336336
logStream = (await device!.getLogReader(app: package)).logLines;
337337
}
338-
_loggingSubscription = logStream.listen((String line) {
339-
if (!line.contains(kVMServiceMessageRegExp)) {
340-
logger.printStatus(line, wrap: false);
341-
}
342-
});
338+
_loggingSubscription = logStream.listen(
339+
(String line) {
340+
if (!line.contains(kVMServiceMessageRegExp)) {
341+
logger.printStatus(line, wrap: false);
342+
}
343+
},
344+
onError: (Object error, StackTrace stackTrace) {
345+
logger.printTrace('Error on device log stream: $error\n$stackTrace');
346+
},
347+
);
343348
}
344349

345350
Future<void> stopEchoingDeviceLog() async {

‎packages/flutter_tools/lib/src/vmservice.dart‎

Lines changed: 46 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -377,11 +377,54 @@ Future<vm_service.VmService> createVmServiceDelegate(
377377
compression: compression,
378378
logger: logger,
379379
);
380+
// Guard against unhandled socket errors on the WebSocket's `done` future.
381+
// When a socket reset or low-level connection reset occurs, `channel.done`
382+
// can complete with an unhandled SocketException or WebSocketException.
383+
unawaited(
384+
channel.done.handleError((Object error, StackTrace stackTrace) {
385+
logger.printTrace('VM service WebSocket done error: $error\n$stackTrace');
386+
}),
387+
);
388+
// Guard the incoming stream from raising unhandled socket errors into the Zone.
389+
// vm_service.VmService's inStream.listen does not provide an onError callback,
390+
// so any stream errors (such as SocketException on connection reset) must be handled here.
391+
final Stream<Object?> inStream = channel.handleError((Object error, StackTrace stackTrace) {
392+
logger.printTrace('VM service WebSocket error: $error\n$stackTrace');
393+
});
394+
void handleWriteError(Object error, StackTrace stackTrace) {
395+
logger.printTrace('Failed to send VM service message: $error\n$stackTrace');
396+
try {
397+
unawaited(channel.close().handleError((Object _, StackTrace _) {}));
398+
} on Exception {
399+
// Ignore errors while closing a failed channel.
400+
} on StateError {
401+
// Ignore errors while closing a failed channel.
402+
}
403+
}
404+
380405
return vm_service.VmService(
381-
channel,
382-
channel.add,
406+
inStream,
407+
(String message) {
408+
try {
409+
channel.add(message);
410+
} on Exception catch (error, stackTrace) {
411+
handleWriteError(error, stackTrace);
412+
} on StateError catch (error, stackTrace) {
413+
handleWriteError(error, stackTrace);
414+
}
415+
},
383416
disposeHandler: () async {
384-
await channel.close();
417+
void logCloseError(Object error, StackTrace stackTrace) {
418+
logger.printTrace('Error closing VM service channel: $error\n$stackTrace');
419+
}
420+
421+
try {
422+
await channel.close();
423+
} on Exception catch (error, stackTrace) {
424+
logCloseError(error, stackTrace);
425+
} on StateError catch (error, stackTrace) {
426+
logCloseError(error, stackTrace);
427+
}
385428
},
386429
);
387430
}

‎packages/flutter_tools/test/general.shard/android/android_device_test.dart‎

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -338,6 +338,27 @@ flutter:
338338
expect(await device.emulatorId, isNull);
339339
});
340340

341+
testWithoutContext(
342+
'AndroidConsole handles socket.done completing with a SocketException',
343+
() async {
344+
final doneCompleter = Completer<void>();
345+
final socket = FakeWorkingAndroidConsoleSocket('dummyEmulatorId', done: doneCompleter.future);
346+
final console = AndroidConsole(socket);
347+
await console.connect();
348+
349+
doneCompleter.completeError(
350+
const SocketException(
351+
'Error event raised in event handler : error condition has been reset',
352+
port: 0,
353+
),
354+
);
355+
await pumpEventQueue();
356+
357+
expect(await console.getAvdName(), equals('dummyEmulatorId'));
358+
console.destroy();
359+
},
360+
);
361+
341362
testWithoutContext('AndroidDevice clearLogs does not crash', () async {
342363
final AndroidDevice device = setUpAndroidDevice(
343364
processManager: FakeProcessManager.list(<FakeCommand>[
@@ -801,7 +822,8 @@ const kAdbShellGetprop = '''
801822
/// A mock Android Console that presents a connection banner and responds to
802823
/// "avd name" requests with the supplied name.
803824
class FakeWorkingAndroidConsoleSocket extends Fake implements Socket {
804-
FakeWorkingAndroidConsoleSocket(this.avdName) {
825+
FakeWorkingAndroidConsoleSocket(this.avdName, {Future<void>? done})
826+
: done = done ?? Completer<void>().future {
805827
_controller.add('Android Console: Welcome!\n');
806828
// Include OK in the same packet here. In the response to "avd name"
807829
// it's sent alone to ensure both are handled.
@@ -811,6 +833,9 @@ class FakeWorkingAndroidConsoleSocket extends Fake implements Socket {
811833
final String avdName;
812834
final _controller = StreamController<String>();
813835

836+
@override
837+
final Future<void> done;
838+
814839
@override
815840
Stream<E> asyncMap<E>(FutureOr<E> Function(Uint8List event) convert) =>
816841
_controller.stream as Stream<E>;
@@ -836,6 +861,9 @@ class FakeWorkingAndroidConsoleSocket extends Fake implements Socket {
836861
class FakeUnresponsiveAndroidConsoleSocket extends Fake implements Socket {
837862
final _controller = StreamController<String>();
838863

864+
@override
865+
final Future<void> done = Completer<void>().future;
866+
839867
@override
840868
Stream<E> asyncMap<E>(FutureOr<E> Function(Uint8List event) convert) =>
841869
_controller.stream as Stream<E>;
@@ -858,6 +886,9 @@ class FakeDisconnectingAndroidConsoleSocket extends Fake implements Socket {
858886

859887
final _controller = StreamController<String>();
860888

889+
@override
890+
final Future<void> done = Completer<void>().future;
891+
861892
@override
862893
Stream<E> asyncMap<E>(FutureOr<E> Function(Uint8List event) convert) =>
863894
_controller.stream as Stream<E>;

0 commit comments

Comments
 (0)