Skip to content

Make the command execution interruptable #487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
guizmaii wants to merge 2 commits into
base: series/2.x
Choose a base branch
from
Draft

Make the command execution interruptable #487

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cdfb75d
Make the command execution interruptable
guizmaii May 14, 2025
797b81f
WIP
guizmaii Dec 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 53 additions & 35 deletions zio-process/jvm/src/main/scala/zio/process/CommandPlatformSpecific.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,58 +15,76 @@
*/
package zio.process

import scala.annotation.nowarn
import FilePlatformSpecific._
import zio.NonEmptyChunk
import zio.process.FilePlatformSpecific._
import zio.stream.ZSink
import zio.{ Chunk, NonEmptyChunk, Promise, UIO, ZIO }

import java.io.OutputStream
import java.lang.ProcessBuilder.Redirect
import scala.annotation.nowarn
import scala.jdk.CollectionConverters._
import zio.ZIO
import java.io.OutputStream
import zio.stream.ZSink
import zio.Chunk

private[process] trait CommandPlatformSpecific {

type JProcess = java.lang.Process

@nowarn
protected def checkDirectory(dir: File): Boolean = true

private def adaptCommand(command: NonEmptyChunk[String]): NonEmptyChunk[String] = command

@nowarn
protected def build(c: Command.Standard, piping: Option[java.io.InputStream]): ZIO[Any, Throwable, Process] =
ZIO.attempt {
val builder = new ProcessBuilder(adaptCommand(c.command): _*)
builder.redirectErrorStream(c.redirectErrorStream)
c.workingDirectory.foreach { dir =>
if (!checkDirectory(dir)) throw CommandError.WorkingDirectoryMissing(dir)
builder.directory(dir)
}
ZIO.fiberIdWith { fiberId =>
ZIO.asyncInterruptUnsafe { implicit unsafe => cb =>
val processRef: Promise[Nothing, JProcess] = Promise.unsafe.make[Nothing, JProcess](fiberId)

if (c.env.nonEmpty) {
builder.environment().putAll(c.env.asJava)
}
def unsafeRunCmd: Process = {
val builder = new ProcessBuilder(adaptCommand(c.command): _*)
builder.redirectErrorStream(c.redirectErrorStream)
c.workingDirectory.foreach { dir =>
if (!checkDirectory(dir)) throw CommandError.WorkingDirectoryMissing(dir)
builder.directory(dir)
}

c.stdin match {
case ProcessInput.Inherit => builder.redirectInput(Redirect.INHERIT)
case ProcessInput.Pipe => builder.redirectInput(Redirect.PIPE)
case _ => ()
}
if (c.env.nonEmpty) {
builder.environment().putAll(c.env.asJava)
}

c.stdout match {
case ProcessOutput.FileRedirect(file) => builder.redirectOutput(Redirect.to(file))
case ProcessOutput.FileAppendRedirect(file) => builder.redirectOutput(Redirect.appendTo(file))
case ProcessOutput.Inherit => builder.redirectOutput(Redirect.INHERIT)
case ProcessOutput.Pipe => builder.redirectOutput(Redirect.PIPE)
}
c.stdin match {
case ProcessInput.Inherit => builder.redirectInput(Redirect.INHERIT)
case ProcessInput.Pipe => builder.redirectInput(Redirect.PIPE)
case _ => ()
}

c.stderr match {
case ProcessOutput.FileRedirect(file) => builder.redirectError(Redirect.to(file))
case ProcessOutput.FileAppendRedirect(file) => builder.redirectError(Redirect.appendTo(file))
case ProcessOutput.Inherit => builder.redirectError(Redirect.INHERIT)
case ProcessOutput.Pipe => builder.redirectError(Redirect.PIPE)
}
c.stdout match {
case ProcessOutput.FileRedirect(file) => builder.redirectOutput(Redirect.to(file))
case ProcessOutput.FileAppendRedirect(file) => builder.redirectOutput(Redirect.appendTo(file))
case ProcessOutput.Inherit => builder.redirectOutput(Redirect.INHERIT)
case ProcessOutput.Pipe => builder.redirectOutput(Redirect.PIPE)
}

c.stderr match {
case ProcessOutput.FileRedirect(file) => builder.redirectError(Redirect.to(file))
case ProcessOutput.FileAppendRedirect(file) => builder.redirectError(Redirect.appendTo(file))
case ProcessOutput.Inherit => builder.redirectError(Redirect.INHERIT)
case ProcessOutput.Pipe => builder.redirectError(Redirect.PIPE)
}

Process(builder.start())
val jProcess = builder.start()
processRef.unsafe.succeed(jProcess)
Process(jProcess)
}

val canceler: UIO[Unit] =
processRef.await.flatMap { process =>
ZIO.attempt(process.destroy()).ignoreLogged
}

cb(ZIO.attempt(unsafeRunCmd))

Left(canceler)
}
}

protected def connectStdin(process: Process, stdin: ProcessInput): ZIO[Any, CommandError, Unit] =
Expand Down