Compare commits
12 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| cd5194c365 | |||
| 71cc64b6d9 | |||
| f254a9e078 | |||
| 3d6a33f8d2 | |||
| d37071dae0 | |||
| 181d352e21 | |||
| 8a0a18f4da | |||
| bdc09afedd | |||
| 68060e8565 | |||
| f2552cda79 | |||
| b898382305 | |||
| 5f8f38c2e6 |
29
changelog.md
29
changelog.md
@@ -1,5 +1,34 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## 2026-03-05 - 3.3.7 - fix(smartshell)
|
||||||
|
avoid triple shell nesting, improve WSL path filtering, and use chunked log buffer to reduce memory usage
|
||||||
|
|
||||||
|
- Spawn uses the executor shell binary directly (e.g. /bin/bash) and removes extra bash -c wrapping to avoid triple shell nesting
|
||||||
|
- Only filter out /mnt/c/ and other WSL-specific PATH entries when running under WSL (adds _isWSL detection)
|
||||||
|
- Replace single concatenated Buffer with chunked buffering in ShellLog (lazy concatenation, logLength property) and update checks to use logLength
|
||||||
|
- Remove unused dependency "tree-kill" from package.json
|
||||||
|
|
||||||
|
## 2026-03-04 - 3.3.6 - fix(smartshell)
|
||||||
|
use 'close' event on child processes to ensure exit handling and update dependency versions
|
||||||
|
|
||||||
|
- Replace child_process 'exit' listeners with 'close' in ts/classes.smartshell.ts (two occurrences) to ensure handlers run after stdio streams are closed.
|
||||||
|
- Bump devDependencies: @git.zone/tsbuild ^2.7.3 -> ^4.1.2, @git.zone/tsrun ^1.6.2 -> ^2.0.1, @git.zone/tstest ^2.8.3 -> ^3.2.0, @types/node ^22.19.13 -> ^25.3.3.
|
||||||
|
- Bump dependencies: @push.rocks/smartexit ^2.0.1 -> ^2.0.3, which ^5.0.0 -> ^6.0.1.
|
||||||
|
|
||||||
|
## 2026-03-03 - 3.3.2 - fix(release)
|
||||||
|
add @git.zone/cli release configuration with registries and public access
|
||||||
|
|
||||||
|
- Updated file: npmextra.json
|
||||||
|
- Added @git.zone/cli.release.registries: https://verdaccio.lossleess.digital, https://registry.npmjs.org
|
||||||
|
- Set @git.zone/cli.release.accessLevel to "public"
|
||||||
|
|
||||||
|
## 2026-03-03 - 3.3.1 - fix(deps)
|
||||||
|
bump @push.rocks/smartexit dependency to ^1.1.1
|
||||||
|
|
||||||
|
- Updated @push.rocks/smartexit from ^1.0.23 to ^1.1.1
|
||||||
|
- Only package.json was modified
|
||||||
|
- Project current version is 3.3.0; recommend a patch release to 3.3.1
|
||||||
|
|
||||||
## 2025-08-17 - 3.3.0 - feat(smartshell)
|
## 2025-08-17 - 3.3.0 - feat(smartshell)
|
||||||
Add secure spawn APIs, PTY support, interactive/streaming control, timeouts and buffer limits; update README and tests
|
Add secure spawn APIs, PTY support, interactive/streaming control, timeouts and buffer limits; update README and tests
|
||||||
|
|
||||||
|
|||||||
@@ -28,5 +28,14 @@
|
|||||||
},
|
},
|
||||||
"tsdoc": {
|
"tsdoc": {
|
||||||
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
||||||
|
},
|
||||||
|
"@git.zone/cli": {
|
||||||
|
"release": {
|
||||||
|
"registries": [
|
||||||
|
"https://verdaccio.lossleess.digital",
|
||||||
|
"https://registry.npmjs.org"
|
||||||
|
],
|
||||||
|
"accessLevel": "public"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
17
package.json
17
package.json
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "@push.rocks/smartshell",
|
"name": "@push.rocks/smartshell",
|
||||||
"private": false,
|
"private": false,
|
||||||
"version": "3.3.0",
|
"version": "3.3.7",
|
||||||
"description": "A library for executing shell commands using promises.",
|
"description": "A library for executing shell commands using promises.",
|
||||||
"main": "dist_ts/index.js",
|
"main": "dist_ts/index.js",
|
||||||
"typings": "dist_ts/index.d.ts",
|
"typings": "dist_ts/index.d.ts",
|
||||||
@@ -33,18 +33,17 @@
|
|||||||
},
|
},
|
||||||
"homepage": "https://code.foss.global/push.rocks/smartshell",
|
"homepage": "https://code.foss.global/push.rocks/smartshell",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@git.zone/tsbuild": "^2.6.4",
|
"@git.zone/tsbuild": "^4.1.2",
|
||||||
"@git.zone/tsrun": "^1.3.3",
|
"@git.zone/tsrun": "^2.0.1",
|
||||||
"@git.zone/tstest": "^2.3.2",
|
"@git.zone/tstest": "^3.2.0",
|
||||||
"@types/node": "^22.10.2"
|
"@types/node": "^25.3.3"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@push.rocks/smartdelay": "^3.0.1",
|
"@push.rocks/smartdelay": "^3.0.5",
|
||||||
"@push.rocks/smartexit": "^1.0.23",
|
"@push.rocks/smartexit": "^2.0.3",
|
||||||
"@push.rocks/smartpromise": "^4.2.3",
|
"@push.rocks/smartpromise": "^4.2.3",
|
||||||
"@types/which": "^3.0.4",
|
"@types/which": "^3.0.4",
|
||||||
"tree-kill": "^1.2.2",
|
"which": "^6.0.1"
|
||||||
"which": "^5.0.0"
|
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
"ts/**/*",
|
"ts/**/*",
|
||||||
|
|||||||
8286
pnpm-lock.yaml
generated
8286
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@@ -3,6 +3,6 @@
|
|||||||
*/
|
*/
|
||||||
export const commitinfo = {
|
export const commitinfo = {
|
||||||
name: '@push.rocks/smartshell',
|
name: '@push.rocks/smartshell',
|
||||||
version: '3.3.0',
|
version: '3.3.7',
|
||||||
description: 'A library for executing shell commands using promises.'
|
description: 'A library for executing shell commands using promises.'
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -28,6 +28,17 @@ export class ShellEnv {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Detect if running under Windows Subsystem for Linux
|
||||||
|
*/
|
||||||
|
private static _isWSL(): boolean {
|
||||||
|
return !!(
|
||||||
|
process.env.WSL_DISTRO_NAME ||
|
||||||
|
process.env.WSLENV ||
|
||||||
|
(process.platform === 'linux' && process.env.PATH?.includes('/mnt/c/'))
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* imports path into the shell from env if available and returns it with
|
* imports path into the shell from env if available and returns it with
|
||||||
*/
|
*/
|
||||||
@@ -39,18 +50,16 @@ export class ShellEnv {
|
|||||||
commandPaths = commandPaths.concat(process.env.SMARTSHELL_PATH.split(':'));
|
commandPaths = commandPaths.concat(process.env.SMARTSHELL_PATH.split(':'));
|
||||||
}
|
}
|
||||||
|
|
||||||
// lets filter for unwanted paths
|
// Only filter out WSL-specific paths when actually running under WSL
|
||||||
// Windows WSL
|
if (ShellEnv._isWSL()) {
|
||||||
commandPaths = commandPaths.filter((commandPathArg) => {
|
commandPaths = commandPaths.filter((commandPathArg) => {
|
||||||
const filterResult =
|
return (
|
||||||
!commandPathArg.startsWith('/mnt/c/') &&
|
!commandPathArg.startsWith('/mnt/c/') &&
|
||||||
!commandPathArg.startsWith('Files/1E') &&
|
!commandPathArg.startsWith('Files/1E') &&
|
||||||
!commandPathArg.includes(' ');
|
!commandPathArg.includes(' ')
|
||||||
if (!filterResult) {
|
);
|
||||||
// console.log(`${commandPathArg} will be filtered!`);
|
|
||||||
}
|
|
||||||
return filterResult;
|
|
||||||
});
|
});
|
||||||
|
}
|
||||||
|
|
||||||
commandResult = `PATH=${commandPaths.join(':')} && ${commandStringArg}`;
|
commandResult = `PATH=${commandPaths.join(':')} && ${commandStringArg}`;
|
||||||
return commandResult;
|
return commandResult;
|
||||||
@@ -89,14 +98,12 @@ export class ShellEnv {
|
|||||||
}
|
}
|
||||||
pathString += ` && `;
|
pathString += ` && `;
|
||||||
|
|
||||||
switch (this.executor) {
|
// For both bash and sh executors, build the command string directly.
|
||||||
case 'bash':
|
// The shell nesting is handled by spawn() using the appropriate shell binary.
|
||||||
commandResult = `bash -c '${pathString}${sourceString}${commandArg}'`;
|
// Previously bash executor wrapped in `bash -c '...'` which caused triple
|
||||||
break;
|
// shell nesting (Node spawn sh -> bash -c -> command). Now spawn() uses
|
||||||
case 'sh':
|
// shell: '/bin/bash' directly, so we don't need the extra wrapping.
|
||||||
commandResult = `${pathString}${sourceString}${commandArg}`;
|
commandResult = `${pathString}${sourceString}${commandArg}`;
|
||||||
break;
|
|
||||||
}
|
|
||||||
commandResult = this._setPath(commandResult);
|
commandResult = this._setPath(commandResult);
|
||||||
return commandResult;
|
return commandResult;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,7 +5,41 @@ import * as plugins from './plugins.js';
|
|||||||
* making sure the process doesn't run out of memory
|
* making sure the process doesn't run out of memory
|
||||||
*/
|
*/
|
||||||
export class ShellLog {
|
export class ShellLog {
|
||||||
public logStore = Buffer.from('');
|
private chunks: Buffer[] = [];
|
||||||
|
private totalLength = 0;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the accumulated log as a single Buffer.
|
||||||
|
* Concatenation happens lazily only when accessed.
|
||||||
|
*/
|
||||||
|
public get logStore(): Buffer {
|
||||||
|
if (this.chunks.length === 0) {
|
||||||
|
return Buffer.alloc(0);
|
||||||
|
}
|
||||||
|
if (this.chunks.length === 1) {
|
||||||
|
return this.chunks[0];
|
||||||
|
}
|
||||||
|
// Flatten chunks into a single buffer
|
||||||
|
const combined = Buffer.concat(this.chunks, this.totalLength);
|
||||||
|
// Replace chunks array with the single combined buffer for future access
|
||||||
|
this.chunks = [combined];
|
||||||
|
return combined;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set the log store directly (used for truncation).
|
||||||
|
*/
|
||||||
|
public set logStore(value: Buffer) {
|
||||||
|
this.chunks = [value];
|
||||||
|
this.totalLength = value.length;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the current total length of buffered data without concatenating.
|
||||||
|
*/
|
||||||
|
public get logLength(): number {
|
||||||
|
return this.totalLength;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* log data to console
|
* log data to console
|
||||||
@@ -22,13 +56,9 @@ export class ShellLog {
|
|||||||
*/
|
*/
|
||||||
public addToBuffer(dataArg: string | Buffer): void {
|
public addToBuffer(dataArg: string | Buffer): void {
|
||||||
// make sure we have the data as Buffer
|
// make sure we have the data as Buffer
|
||||||
const dataBuffer: Buffer = (() => {
|
const dataBuffer: Buffer = Buffer.isBuffer(dataArg) ? dataArg : Buffer.from(dataArg);
|
||||||
if (!Buffer.isBuffer(dataArg)) {
|
this.chunks.push(dataBuffer);
|
||||||
return Buffer.from(dataArg);
|
this.totalLength += dataBuffer.length;
|
||||||
}
|
|
||||||
return dataArg;
|
|
||||||
})();
|
|
||||||
this.logStore = Buffer.concat([this.logStore, dataBuffer]);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
public logAndAdd(dataArg: string | Buffer): void {
|
public logAndAdd(dataArg: string | Buffer): void {
|
||||||
|
|||||||
@@ -119,7 +119,7 @@ export class Smartshell {
|
|||||||
shell: false, // SECURITY: Never use shell with untrusted input
|
shell: false, // SECURITY: Never use shell with untrusted input
|
||||||
cwd: process.cwd(),
|
cwd: process.cwd(),
|
||||||
env: options.env || process.env,
|
env: options.env || process.env,
|
||||||
detached: false,
|
detached: true, // Own process group — immune to terminal SIGINT, managed by smartexit
|
||||||
signal: options.signal,
|
signal: options.signal,
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -182,7 +182,7 @@ export class Smartshell {
|
|||||||
|
|
||||||
if (!bufferExceeded) {
|
if (!bufferExceeded) {
|
||||||
shellLogInstance.addToBuffer(data);
|
shellLogInstance.addToBuffer(data);
|
||||||
if (shellLogInstance.logStore.length > maxBuffer) {
|
if (shellLogInstance.logLength > maxBuffer) {
|
||||||
bufferExceeded = true;
|
bufferExceeded = true;
|
||||||
shellLogInstance.logStore = Buffer.from('[Output truncated - exceeded maxBuffer]');
|
shellLogInstance.logStore = Buffer.from('[Output truncated - exceeded maxBuffer]');
|
||||||
}
|
}
|
||||||
@@ -203,7 +203,7 @@ export class Smartshell {
|
|||||||
|
|
||||||
if (!bufferExceeded) {
|
if (!bufferExceeded) {
|
||||||
shellLogInstance.addToBuffer(data);
|
shellLogInstance.addToBuffer(data);
|
||||||
if (shellLogInstance.logStore.length > maxBuffer) {
|
if (shellLogInstance.logLength > maxBuffer) {
|
||||||
bufferExceeded = true;
|
bufferExceeded = true;
|
||||||
shellLogInstance.logStore = Buffer.from('[Output truncated - exceeded maxBuffer]');
|
shellLogInstance.logStore = Buffer.from('[Output truncated - exceeded maxBuffer]');
|
||||||
}
|
}
|
||||||
@@ -249,7 +249,7 @@ export class Smartshell {
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
execChildProcess.once('exit', handleExit);
|
execChildProcess.once('close', handleExit);
|
||||||
execChildProcess.once('error', (error) => {
|
execChildProcess.once('error', (error) => {
|
||||||
if (timeoutHandle) {
|
if (timeoutHandle) {
|
||||||
clearTimeout(timeoutHandle);
|
clearTimeout(timeoutHandle);
|
||||||
@@ -338,11 +338,15 @@ export class Smartshell {
|
|||||||
return await this._execCommandPty(options, commandToExecute, shellLogInstance);
|
return await this._execCommandPty(options, commandToExecute, shellLogInstance);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Use the executor's shell binary directly to avoid triple shell nesting.
|
||||||
|
// Previously: Node spawn(shell:true) → /bin/sh → bash -c → command (3 layers)
|
||||||
|
// Now: Node spawn(shell:bash) → command (1 layer)
|
||||||
|
const shellBinary = this.shellEnv.executor === 'bash' ? '/bin/bash' : true;
|
||||||
const execChildProcess = cp.spawn(commandToExecute, [], {
|
const execChildProcess = cp.spawn(commandToExecute, [], {
|
||||||
shell: true,
|
shell: shellBinary,
|
||||||
cwd: process.cwd(),
|
cwd: process.cwd(),
|
||||||
env: options.env || process.env,
|
env: options.env || process.env,
|
||||||
detached: false,
|
detached: true, // Own process group — immune to terminal SIGINT, managed by smartexit
|
||||||
signal: options.signal,
|
signal: options.signal,
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -405,7 +409,7 @@ export class Smartshell {
|
|||||||
|
|
||||||
if (!bufferExceeded) {
|
if (!bufferExceeded) {
|
||||||
shellLogInstance.addToBuffer(data);
|
shellLogInstance.addToBuffer(data);
|
||||||
if (shellLogInstance.logStore.length > maxBuffer) {
|
if (shellLogInstance.logLength > maxBuffer) {
|
||||||
bufferExceeded = true;
|
bufferExceeded = true;
|
||||||
shellLogInstance.logStore = Buffer.from('[Output truncated - exceeded maxBuffer]');
|
shellLogInstance.logStore = Buffer.from('[Output truncated - exceeded maxBuffer]');
|
||||||
}
|
}
|
||||||
@@ -426,7 +430,7 @@ export class Smartshell {
|
|||||||
|
|
||||||
if (!bufferExceeded) {
|
if (!bufferExceeded) {
|
||||||
shellLogInstance.addToBuffer(data);
|
shellLogInstance.addToBuffer(data);
|
||||||
if (shellLogInstance.logStore.length > maxBuffer) {
|
if (shellLogInstance.logLength > maxBuffer) {
|
||||||
bufferExceeded = true;
|
bufferExceeded = true;
|
||||||
shellLogInstance.logStore = Buffer.from('[Output truncated - exceeded maxBuffer]');
|
shellLogInstance.logStore = Buffer.from('[Output truncated - exceeded maxBuffer]');
|
||||||
}
|
}
|
||||||
@@ -472,7 +476,7 @@ export class Smartshell {
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
execChildProcess.once('exit', handleExit);
|
execChildProcess.once('close', handleExit);
|
||||||
execChildProcess.once('error', (error) => {
|
execChildProcess.once('error', (error) => {
|
||||||
if (timeoutHandle) {
|
if (timeoutHandle) {
|
||||||
clearTimeout(timeoutHandle);
|
clearTimeout(timeoutHandle);
|
||||||
|
|||||||
Reference in New Issue
Block a user