startShellJob method

@override Future<Result<ShellJob, ExecutionError>> startShellJob(String command, { required String id, required String logPath, ShellExecOptions? options, })

Starts command detached: stdout/stderr append to logPath and the returned ShellJob keeps running until it exits or is stopped. ShellExecOptions.timeout and ShellExecOptions.cancelToken still apply (both stop the job).

Implementation

@override
Future<Result<ShellJob, ExecutionError>> startShellJob(
  String command, {
  required String id,
  required String logPath,
  ShellExecOptions? options,
}) async {
  final token = options?.cancelToken;
  if (token?.isCancelled ?? false) {
    return const Err(ExecutionError(ExecutionErrorCode.aborted, 'aborted'));
  }
  final started = await _start(command, options);
  if (started.isErr) return Err(started.errorOrNull!);
  final process = started.valueOrNull!;
  final IOSink logSink;
  try {
    logSink = File(logPath).openWrite(mode: FileMode.append);
  } on Object catch (error) {
    process.kill();
    return Err(
      ExecutionError(
        ExecutionErrorCode.spawnError,
        'cannot open job log file $logPath: $error',
        cause: error,
      ),
    );
  }
  return Ok(
    _LocalShellJob(
      id: id,
      command: command,
      logPath: logPath,
      process: process,
      logSink: logSink,
      timeout: options?.timeout,
      token: token,
    ),
  );
}