handle any error from flush

flutter · auto-submit · Jun 28, 2024 · Jun 12, 2024 · Jun 21, 2024 · Jun 21, 2024
commit 386cf4aa41ff1368620a1bf3e182bc9f3b7703ca
diff --git a/packages/flutter_tools/lib/src/base/process.dart b/packages/flutter_tools/lib/src/base/process.dart
@@ -286,6 +286,17 @@ abstract class ProcessUtils {
   }) async {
     final Completer<void> completer = Completer<void>();
 
+    // Future.onError specifically requires a return type of FutureOr<Null>, so
+    // we can't use void here.
+    // ignore: prefer_void_to_null
+    Null handleError(Object error, StackTrace stackTrace) {
+      try {
+        onError(error, stackTrace);
+      } on Exception catch (e) {
+        completer.completeError(e);
+      }
+    }
+
     void writeFlushAndComplete() {
       if (isLine) {
         stdin.writeln(content);
@@ -294,17 +305,13 @@ abstract class ProcessUtils {
       }
       stdin.flush().then((_) {
         completer.complete();
-      });
+      }).onError(handleError);
     }
 
     runZonedGuarded(
       writeFlushAndComplete,
       (Object error, StackTrace stackTrace) {
-        try {
-          onError(error, stackTrace);
-        } on Exception catch (e) {
-          completer.completeError(e);
-        }
+        handleError(error, stackTrace);
 
         // We may have already completed with an error in the above catch block.
         if (!completer.isCompleted) {

diff --git a/packages/flutter_tools/test/general.shard/base/process_test.dart b/packages/flutter_tools/test/general.shard/base/process_test.dart
@@ -2,6 +2,8 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
+import 'dart:async';
+
 import 'package:flutter_tools/src/base/io.dart';
 import 'package:flutter_tools/src/base/logger.dart';
 import 'package:flutter_tools/src/base/platform.dart';
@@ -444,4 +446,55 @@ void main() {
       );
     });
   });
+
+  group('writeToStdinGuarded', () {
+    testWithoutContext('handles any error thrown by stdin.flush', () async {
+      final _ThrowsOnFlushIOSink stdin = _ThrowsOnFlushIOSink();
+      final Completer<bool> fooCommandCompleter = Completer<bool>();
+      final Future<bool> >
+
+      void fooOnRun(List<String> command) {
+        ProcessUtils.writeToStdinGuarded(
+          stdin: stdin,
+          content: 'message to stdin',
+          onError: (Object error, StackTrace stackTrace) {
+            fooCommandCompleter.complete(true);
+          },
+        ).then((_) => fooCommandCompleter.complete(false))
+         .onError((_, __) {
+          // Fail the test.
+          throw Exception("writeToStdinGuarded shouldn't have thrown.");
+        });
+      }
+
+      final FakeProcessManager processManager = FakeProcessManager.list(
+        <FakeCommand>[
+          FakeCommand(
+            command: const <String>['foo'],
+            stdin: stdin,
+            onRun: fooOnRun,
+            completer: fooCommandCompleter,
+          ),
+        ],
+      );
+
+      await processManager.run(<String>['foo']);
+
+      expect(
+        await onErrorCalled,
+        isTrue,
+        reason: 'onError argument to writeToStdinGuarded should have been called',
+      );
+    });
+  });
+}
+
+class _ThrowsOnFlushIOSink extends MemoryIOSink {
+  @override
+  Future<Object?> flush() async {
+    throw const SocketException(
+      'Write failed',
+      osError: OSError('Broken pipe', 32),
+    );
+  }
 }