[ DartDev ] Ignore SIGINT in DartDev process

If a user program installs custom signal handling for SIGINT,
the DartDev instance may exit before its child, potentially causing
confusing behavior and 'zombie' children. By ignoring these signals in
DartDev, the DartDev instance will only exit once its child process
exits.

Fixes #42092

Change-Id: I04bf6d1f375b8bb3a4f7022f2c79ddde3bd5f414
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/149643
Commit-Queue: Ben Konyi <[email protected]>
Reviewed-by: Jaime Wren <[email protected]>

Author: bkonyi

pkg/dartdev/bin/dartdev.dart

@@ -2,9 +2,18 @@
 // 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.
 
+import 'dart:io';
+
 import 'package:dartdev/dartdev.dart';
+import 'package:pedantic/pedantic.dart' show unawaited;
 
 /// The entry point for dartdev.
 Future<void> main(List<String> args) async {
+  // Ignore SIGINT to ensure DartDev doesn't exit before any of its
+  // spawned children. Draining the stream returned by watch() effectively
+  // sends the signals to the void.
+  //
+  // See https://github.com/dart-lang/sdk/issues/42092 for context.
+  unawaited(ProcessSignal.sigint.watch().drain());
   await runDartdev(args);
 }

tests/standalone/regress_42092_script.dart

@@ -0,0 +1,21 @@
+// Copyright (c) 2020, 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.
+
+import 'dart:async';
+import 'dart:io';
+
+Future<void> main() async {
+  var count = 0;
+  ProcessSignal.sigint.watch().forEach((s) {
+    count++;
+    print('child: Got a SIGINT $count times, hit it 3 times to terminate');
+    if (count >= 3) {
+      exit(42);
+    }
+  });
+  print('Waiting...');
+  while (true) {
+    await Future.delayed(const Duration(seconds: 5));
+  }
+}

tests/standalone/regress_42092_test.dart

@@ -0,0 +1,51 @@
+// Copyright (c) 2020, 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.
+
+import 'dart:async';
+import 'dart:convert';
+import 'dart:io';
+
+import 'package:expect/expect.dart';
+
+late Process process;
+bool lastKill = false;
+
+Future<void> sigint(int iterations) async {
+  for (int i = 0; i < iterations; ++i) {
+    if (i + 1 == iterations) {
+      lastKill = true;
+    }
+    process.kill(ProcessSignal.sigint);
+    // Yield to the event loop to allow for the signal to be sent.
+    await Future.value(null);
+  }
+}
+
+Future<void> main() async {
+  process = await Process.start(
+    Platform.resolvedExecutable,
+    [
+      Platform.script.resolve('regress_42092_script.dart').toString(),
+    ],
+  );
+  final startCompleter = Completer<void>();
+  late StreamSubscription sub;
+  sub = process.stdout.transform(Utf8Decoder()).listen((event) {
+    if (event.contains('Waiting...')) {
+      startCompleter.complete();
+      sub.cancel();
+    }
+  });
+
+  // Wait for target script to setup its signal handling.
+  await startCompleter.future;
+
+  final exitCompleter = Completer<void>();
+  process.exitCode.then((code) {
+    Expect.isTrue(lastKill);
+    exitCompleter.complete();
+  });
+  await sigint(3);
+  await exitCompleter.future;
+}

tests/standalone_2/regress_42092_script.dart

@@ -0,0 +1,21 @@
+// Copyright (c) 2020, 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.
+
+import 'dart:async';
+import 'dart:io';
+
+Future<void> main() async {
+  var count = 0;
+  ProcessSignal.sigint.watch().forEach((s) {
+    count++;
+    print('child: Got a SIGINT $count times, hit it 3 times to terminate');
+    if (count >= 3) {
+      exit(42);
+    }
+  });
+  print('Waiting...');
+  while (true) {
+    await Future.delayed(const Duration(seconds: 5));
+  }
+}

tests/standalone_2/regress_42092_test.dart

@@ -0,0 +1,51 @@
+// Copyright (c) 2020, 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.
+
+import 'dart:async';
+import 'dart:convert';
+import 'dart:io';
+
+import 'package:expect/expect.dart';
+
+Process process;
+bool lastKill = false;
+
+Future<void> sigint(int iterations) async {
+  for (int i = 0; i < iterations; ++i) {
+    if (i + 1 == iterations) {
+      lastKill = true;
+    }
+    process.kill(ProcessSignal.sigint);
+    // Yield to the event loop to allow for the signal to be sent.
+    await Future.value(null);
+  }
+}
+
+Future<void> main() async {
+  process = await Process.start(
+    Platform.resolvedExecutable,
+    [
+      Platform.script.resolve('regress_42092_script.dart').toString(),
+    ],
+  );
+  final startCompleter = Completer<void>();
+  StreamSubscription sub;
+  sub = process.stdout.transform(Utf8Decoder()).listen((event) {
+    if (event.contains('Waiting...')) {
+      startCompleter.complete();
+      sub.cancel();
+    }
+  });
+
+  // Wait for target script to setup its signal handling.
+  await startCompleter.future;
+
+  final exitCompleter = Completer<void>();
+  process.exitCode.then((code) {
+    Expect.isTrue(lastKill);
+    exitCompleter.complete();
+  });
+  await sigint(3);
+  await exitCompleter.future;
+}