DebuggerProcess

class DebuggerProcess

Manages the network debugger process.

Constructors

DebuggerProcess()

DebuggerProcess({
  required String binaryPath,
  required int port,
  bool autoOpenBrowser = true,
  Map<String, String>? environment,
})

Implementation

dart

DebuggerProcess({
  required this.binaryPath,
  required this.port,
  this.autoOpenBrowser = true,
  Map<String, String>? environment,
}) : environment = environment ?? {};

Properties

autoOpenBrowser final

final bool autoOpenBrowser

Implementation

dart

final bool autoOpenBrowser;

binaryPath final

final String binaryPath

Implementation

dart

final String binaryPath;

environment final

final Map<String, String> environment

Implementation

dart

final Map<String, String> environment;

hashCode no setter inherited

int get hashCode

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.

Inherited from Object.

Implementation

dart

external int get hashCode;

isRunning no setter

bool get isRunning

Whether the process is currently running.

Implementation

dart

bool get isRunning => _process != null && !_hasExited;

pid no setter

int? get pid

Gets the process ID if running.

Implementation

dart

int? get pid => _process?.pid;

port final

final int port

Implementation

dart

final int port;

runtimeType no setter inherited

Type get runtimeType

A representation of the runtime type of the object.

Inherited from Object.

Implementation

dart

external Type get runtimeType;

stderr no setter

Stream<String> get stderr

Stream of stderr output from the process.

Implementation

dart

Stream<String> get stderr => _errorController.stream;

stdout no setter

Stream<String> get stdout

Stream of stdout output from the process.

Implementation

dart

Stream<String> get stdout => _outputController.stream;

url no setter

String get url

The URL where the debugger web UI is accessible.

Implementation

dart

String get url => 'http:&#47;&#47;localhost:$port';

Methods

noSuchMethod() inherited

dynamic noSuchMethod(Invocation invocation)

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dart

dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

dart

class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Object.

Implementation

dart

@pragma("vm:entry-point")
@pragma("wasm:entry-point")
external dynamic noSuchMethod(Invocation invocation);

start()

Future<void> start({
  (void Function(String line))? onStdoutLine,
  (void Function(String line))? onStderrLine,
})

Starts the debugger process.

Implementation

dart

Future<void> start({
  void Function(String line)? onStdoutLine,
  void Function(String line)? onStderrLine,
}) async {
  if (_process != null) {
    throw ProcessException(
      'Process is already running',
    );
  }

  final binary = io.File(binaryPath);
  if (!await binary.exists()) {
    throw ProcessException(
      'Binary not found at: $binaryPath',
    );
  }

  &#47;&#47; Prepare environment
  final env = <String, String>{
    ...io.Platform.environment,
    'ADDR': ':$port',
    &#47;&#47; DEV_MODE=1 prevents the binary from automatically opening the browser
    &#47;&#47; This allows us to control browser opening from the Dart launcher instead
    if (!autoOpenBrowser) 'DEV_MODE': '1',
    if (!autoOpenBrowser) 'NO_BROWSER': '1',
  };

  &#47;&#47; По умолчанию делаем логи Go-бинарника читаемыми в интерактивном терминале.
  &#47;&#47; У процесса stdout&#47;stderr будет пайп, поэтому переключатель прокидываем через ENV.
  if (!env.containsKey('NETWORK_DEBUGGER_LOG_FORMAT') &&
      !env.containsKey('LOG_FORMAT')) {
    final hasTerminal = io.stdout.hasTerminal || io.stderr.hasTerminal;
    if (hasTerminal) {
      env['NETWORK_DEBUGGER_LOG_FORMAT'] = 'console';
      &#47;&#47; Для совместимости со старыми бинарниками (они знают только LOG_FORMAT).
      env['LOG_FORMAT'] = 'console';
    }
  }

  env.addAll(environment);

  try {
    _process = await io.Process.start(
      binaryPath,
      [],
      environment: env,
      mode: io.ProcessStartMode.normal,
    );

    _hasExited = false;
    unawaited(
      _process!.exitCode.then((_) {
        _hasExited = true;
      }),
    );

    &#47;&#47; Pipe output streams
    _stdoutSub = _process!.stdout
        .transform(const io.SystemEncoding().decoder)
        .transform(const LineSplitter())
        .listen(
      (line) {
        _outputController.add(line);
        onStdoutLine?.call(line);
      },
      onError: (error) {
        _errorController.addError(error);
      },
    );

    _stderrSub = _process!.stderr
        .transform(const io.SystemEncoding().decoder)
        .transform(const LineSplitter())
        .listen(
      (line) {
        _errorController.add(line);
        onStderrLine?.call(line);
      },
      onError: (error) {
        _errorController.addError(error);
      },
    );

    &#47;&#47; Wait a bit for the process to start
    await Future.delayed(const Duration(milliseconds: 500));

    &#47;&#47; Check if process is still running
    var exitedImmediately = !isRunning;
    if (!exitedImmediately) {
      try {
        await _process!.exitCode.timeout(Duration.zero);
        exitedImmediately = true;
      } on TimeoutException {
        &#47;&#47; ok, still running
      }
    }

    if (exitedImmediately) {
      throw ProcessException(
        'Process exited immediately after start',
      );
    }
  } catch (e) {
    _process = null;
    _hasExited = false;
    throw ProcessException(
      'Failed to start process: $e',
    );
  }
}

stop()

Future<void> stop({Duration timeout = const Duration(seconds: 5)})

Stops the debugger process gracefully.

Implementation

dart

Future<void> stop({Duration timeout = const Duration(seconds: 5)}) async {
  if (_process == null) {
    return;
  }

  &#47;&#47; Try graceful shutdown first
  _process!.kill(io.ProcessSignal.sigterm);

  &#47;&#47; Wait for process to exit
  final completer = Completer<void>();
  Timer? timeoutTimer;

  _process!.exitCode.then((code) {
    timeoutTimer?.cancel();
    completer.complete();
  });

  timeoutTimer = Timer(timeout, () {
    if (!completer.isCompleted) {
      &#47;&#47; Force kill if timeout
      _process?.kill(io.ProcessSignal.sigkill);
      completer.complete();
    }
  });

  await completer.future;
  _process = null;
  _hasExited = true;

  &#47;&#47; Close streams
  await _stdoutSub?.cancel();
  await _stderrSub?.cancel();
  await _outputController.close();
  await _errorController.close();
}

toString() inherited

String toString()

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from Object.

Implementation

dart

external String toString();

waitUntilReady()

Future<bool> waitUntilReady({
  Duration timeout = const Duration(seconds: 10),
  Duration checkInterval = const Duration(milliseconds: 100),
})

Waits for the process to become ready by checking if the port is listening.

Implementation

dart

Future<bool> waitUntilReady({
  Duration timeout = const Duration(seconds: 10),
  Duration checkInterval = const Duration(milliseconds: 100),
}) async {
  final endTime = DateTime.now().add(timeout);

  while (DateTime.now().isBefore(endTime)) {
    if (!isRunning) {
      return false;
    }

    &#47;&#47; Try to connect to the port
    try {
      final socket = await io.Socket.connect(
        'localhost',
        port,
        timeout: const Duration(milliseconds: 500),
      );
      await socket.close();
      return true;
    } catch (_) {
      &#47;&#47; Port not ready yet
    }

    await Future.delayed(checkInterval);
  }

  return false;
}

Operators

operator ==() inherited

bool operator ==(Object other)

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

Total: It must return a boolean for all arguments. It should never throw.
Reflexive: For all objects o, o == o must be true.
Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.
Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Object.

Implementation

dart

external bool operator ==(Object other);

DebuggerProcess ​

Constructors ​