shell: remove sudoCallback

This commit is contained in:
Girish Ramakrishnan
2025-07-17 01:51:04 +02:00
parent 8bf8c278f0
commit 63053f46a8
2 changed files with 56 additions and 128 deletions
-72
View File
@@ -4,7 +4,6 @@ const assert = require('assert'),
BoxError = require('./boxerror.js'),
child_process = require('child_process'),
debug = require('debug')('box:shell'),
once = require('./once.js'),
path = require('path'),
_ = require('./underscore.js');
@@ -17,7 +16,6 @@ function shell(tag) {
bash: bash.bind(null, tag),
spawn: spawn.bind(null, tag),
sudo: sudo.bind(null, tag),
sudoCallback: sudoCallback.bind(null, tag)
};
}
@@ -134,73 +132,3 @@ async function sudo(tag, args, options) {
return await spawn(tag, SUDO, spawnArgs, options);
}
function sudoCallback(tag, args, options, callback) {
assert.strictEqual(typeof tag, 'string');
assert(Array.isArray(args));
assert.strictEqual(typeof options, 'object');
assert.strictEqual(typeof callback, 'function');
const sudoArgs = [ '-S' ]; // -S makes sudo read stdin for password
if (options.preserveEnv) sudoArgs.push('-E'); // -E preserves environment
callback = once(callback); // exit may or may not be called after an 'error'
const logFunc = options.logger || debug;
if (options.onMessage) { // enable ipc
sudoArgs.push('--close-from=4'); // keep the ipc open. requires closefrom_override in sudoers file
options.stdio = ['pipe', 'pipe', 'pipe', 'ipc'];
}
const spawnArgs = sudoArgs.concat(args);
debug(`${tag} ${SUDO} ${spawnArgs.join(' ').replace(/\n/g, '\\n')}`);
const cp = child_process.spawn(SUDO, spawnArgs, options);
let stdoutResult = '';
cp.stdout.on('data', (data) => {
if (options.captureStdout) stdoutResult += data.toString('utf8');
if (!options.quiet) logFunc(data.toString('utf8'));
});
cp.stderr.on('data', (data) => logFunc(data.toString('utf8')));
cp.on('exit', function (code, signal) {
if (code === 0) return callback(null, options.captureStdout ? stdoutResult : null);
const e = new BoxError(BoxError.SHELL_ERROR, `${tag} exited with code ${code} signal ${signal}`);
e.code = code;
e.signal = signal;
if (cp.terminated) {
debug(`${tag}: ${SUDO} ${spawnArgs.join(' ').replace(/\n/g, '\\n')} terminated`); // was killed by us
} else {
debug(`${tag}: ${SUDO} ${spawnArgs.join(' ').replace(/\n/g, '\\n')} errored`, e);
}
callback(e);
});
cp.on('error', function (error) {
debug(`${tag}: ${SUDO} ${spawnArgs.join(' ').replace(/\n/g, '\\n')} errored`, error);
const e = new BoxError(BoxError.SHELL_ERROR, `${tag} errored with code ${error.code} message ${error.message}`);
e.code = error.code;
e.signal = error.signal;
callback(e);
});
// sudo forks and execs the program. sudo also hangs around as the parent of the program waiting on the program and also forwarding signals.
// sudo does not forward signals when the originator comes from the same process group. recently, there has been a change where it will
// forward signals as long as sudo or the command is not the group leader (https://www.sudo.ws/repos/sudo/rev/d1bf60eac57f)
// for us, this means that calling kill from this node process doesn't work since it's in the same group (and ubuntu 22 doesn't have the above fix).
// the workaround is to invoke a kill from a different process group and this is done by starting detached . negative pid mean to group
// another idea is: use "ps --pid cp.pid -o pid=" to get the pid of the command and then send it signal directly
cp.terminate = function () {
cp.terminated = true; // hint for better debug message in 'exit'
child_process.spawn('kill', ['-SIGKILL', -cp.pid], { detached: true }, (error) => { if (error) debug(`${tag} could not terminate`, error); });
};
cp.stdin.end();
if (options.onMessage) cp.on('message', options.onMessage);
return cp;
}