Introduce deathSig option in Bun.spawn
#15210
Conversation
There was a problem hiding this comment.
in addition to review nitpicks, this feature, as is, will worsen the footgun because it only solves this problem on linux, and not on windows or macOS. someone will see this, briefly check the first paragaph, see it works on linux, and declare the problem solved. in reality, the problem persists on the other operating systems.
that being said, that shouldn't block this pr. the other platforms can be done in another pr.
alternate name suggestion: killOnParentExit: true | string (i think having an easy true aliasing for KILL would be helpful, it would also be the only possible way to emulate this on windows as it does not have kill signals)
| @@ -970,6 +970,11 @@ pub const PosixSpawnOptions = struct { | |||
| argv0: ?[*:0]const u8 = null, | |||
| stream: bool = true, | |||
|
|
|||
| /// Linux-only. | |||
| /// | |||
| /// Send a signal to the parent process when the child process exits. | |||
There was a problem hiding this comment.
this comment is reversed from the typescript documentation
| /// Linux-only. | ||
| /// | ||
| /// Send a signal to the parent process when the child process exits. | ||
| deathsig: bun.SignalCode = @enumFromInt(0), |
There was a problem hiding this comment.
bad practice doing hiding an invalid state in a valid enum. should zero be added to the enum as none?
| @@ -1226,6 +1234,10 @@ pub fn spawnProcessPosix( | |||
|
|
|||
| if (options.detached) { | |||
| flags |= bun.C.POSIX_SPAWN_SETSID; | |||
| } else if (Environment.isLinux) { | |||
| if (@intFromEnum(options.deathsig) > 0) { | |||
| @@ -299,6 +300,7 @@ pub const PosixSpawn = struct { | |||
| const BunSpawnRequest = extern struct { | |||
| chdir_buf: ?[*:0]u8 = null, | |||
| detached: bool = false, | |||
| deathsig: i32 = 0, | |||
| @@ -637,6 +637,7 @@ pub const BunxCommand = struct { | |||
| .stderr = .inherit, | |||
| .stdout = .inherit, | |||
| .stdin = .inherit, | |||
| .deathsig = .SIGTERM, | |||
There was a problem hiding this comment.
should our default be .SIGTERM?
What does this PR do?
Introduce
deathSigoption inBun.spawnThis is a Linux-only option that lets you automatically make spawned processes get killed when Bun exits (as long as they don't set detached: true, or call setsid()).
This enables this option in
bun run <package.json script>,bun installfor lifecycle scripts, and almost everywhere else we spawn processes.How did you verify your code works?
WIP.