Skip to content
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

Jump to bottom

fix: use spawn's shell option to follow npm and fix batch script shells #43

Closed
wants to merge 2 commits into from
Closed

fix: use spawn's shell option to follow npm and fix batch script shells #43

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb852a3
Revert "fix: spawn EINVAL on Windows with script-shell configured"
gluxon Apr 15, 2024
a283761
fix: use spawn's shell option to follow npm and fix batch script shells
gluxon Apr 15, 2024
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
34 changes: 16 additions & 18 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,28 +233,12 @@ function runCmd_ (cmd, pkg, env, wd, opts, stage, unsafe, uid, gid, cb_) {

const customShell = opts.scriptShell

if (customShell) {
sh = customShell
} else if (process.platform === 'win32') {
if (!customShell && process.platform === 'win32') {
sh = process.env.comspec || 'cmd'
shFlag = '/d /s /c'
conf.windowsVerbatimArguments = true
}

// Spawning .bat and .cmd files on Windows requires the "shell" option to
// spawn to be set. Otherwise spawn will throw with EINVAL.
//
// https://nodejs.org/api/child_process.html#spawning-bat-and-cmd-files-on-windows
// https://nodejs.org/en/blog/vulnerability/april-2024-security-releases-2
//
// The shell option is security sensitive. It should make sense for this
// usecase since scripts in package.json intentionally run on the shell.
// Avoiding setting the shell option in all cases to preserve existing
// behavior on non-Windows platforms.
if (process.platform === 'win32' && customShell && (customShell.endsWith('.bat') || customShell.endsWith('.cmd'))) {
conf.shell = true
}

opts.log.verbose('lifecycle', logid(pkg, stage), 'PATH:', env[PATH])
opts.log.verbose('lifecycle', logid(pkg, stage), 'CWD:', wd)
opts.log.silly('lifecycle', logid(pkg, stage), 'Args:', [shFlag, cmd])
Expand Down Expand Up @@ -287,7 +271,21 @@ function runCmd_ (cmd, pkg, env, wd, opts, stage, unsafe, uid, gid, cb_) {
return
}

const proc = spawn(sh, [shFlag, cmd], conf, opts.log)
// The @npm/run-script library uses spawn's shell option when the script-shell
// .npmrc option is set. Do the same to match the behavior of npm.
//
// Note that this is required if script-shell is set to a .bat or .cmd file.
// On Windows, this will throw "spawn EINVAL" if spawn's shell option is
// unset.
//
// https://nodejs.org/api/child_process.html#spawning-bat-and-cmd-files-on-windows
// https://nodejs.org/en/blog/vulnerability/april-2024-security-releases-2
//
// The shell option is security sensitive, but it should make sense for this
// usecase since scripts in package.json intentionally run on the shell.
const proc = customShell
? spawn(cmd, [], { ...conf, shell: customShell }, opts.log)
: spawn(sh, [shFlag, cmd], conf, opts.log)

proc.on('error', procError)
proc.on('close', (code, signal) => {
Expand Down
Loading