pkg/testing/lib/src/zone_helper.dart

// Copyright (c) 2016, 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.

/// Helper functions for running code in a Zone.
library;

import 'dart:async'
    show Completer, Future, PrintHandler, ZoneSpecification, runZonedGuarded;

import 'dart:io' show exit, stderr;

import 'dart:isolate' show Capability, Isolate, ReceivePort;

import 'log.dart' show StdoutLogger;

Future runGuarded(
  Future Function() f, {
  void Function(String)? printLineOnStdout,
  void Function(dynamic, StackTrace)? handleLateError,
}) {
  PrintHandler? printWrapper;
  if (printLineOnStdout != null) {
    printWrapper = (_, _, _, String line) {
      printLineOnStdout(line);
    };
  }

  Completer completer = Completer();

  void handleUncaughtError(error, StackTrace stackTrace) {
    StdoutLogger().logUncaughtError(error, stackTrace);
    if (!completer.isCompleted) {
      completer.completeError(error, stackTrace);
    } else if (handleLateError != null) {
      handleLateError(error, stackTrace);
    } else {
      String errorString = "error.toString() failed.";
      try {
        errorString = "$error";
      } catch (_) {
        // Ignored.
      }
      stderr.write("$errorString\n$stackTrace");
      stderr.flush();
      exit(255);
    }
  }

  ZoneSpecification specification = ZoneSpecification(print: printWrapper);

  ReceivePort errorPort = ReceivePort();
  Future errorFuture = errorPort.listen((errors) {
    Isolate.current.setErrorsFatal(true);
    Isolate.current.removeErrorListener(errorPort.sendPort);
    errorPort.close();
    var error = (errors as List)[0];
    var stackTrace = (errors)[1];
    if (stackTrace != null) {
      stackTrace = StackTrace.fromString(stackTrace);
    }
    handleUncaughtError(error, stackTrace);
  }).asFuture();

  Isolate.current.setErrorsFatal(false);
  Isolate.current.addErrorListener(errorPort.sendPort);
  return acknowledgeControlMessages(Isolate.current).then((_) {
    runZonedGuarded(
      () => Future(f).then(completer.complete),
      handleUncaughtError,
      zoneSpecification: specification,
    );

    return completer.future.whenComplete(() {
      errorPort.close();
      Isolate.current.setErrorsFatal(true);
      Isolate.current.removeErrorListener(errorPort.sendPort);
      return acknowledgeControlMessages(Isolate.current)
          .then((_) => errorFuture);
    });
  });
}

/// Ping [isolate] to ensure control messages have been delivered.  Control
/// messages are things like [Isolate.addErrorListener] and
/// [Isolate.addOnExitListener].
Future acknowledgeControlMessages(Isolate isolate, {Capability? resume}) {
  ReceivePort ping = ReceivePort();
  Isolate.current.ping(ping.sendPort);
  if (resume == null) {
    return ping.first;
  } else {
    return ping.first.then((_) => isolate.resume(resume));
  }
}