4 Commits

Author SHA1 Message Date
5c4836fd68 1.5.0
Some checks failed
Default (tags) / security (push) Successful in 39s
Default (tags) / test (push) Failing after 44s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2025-03-04 11:44:55 +00:00
2dc766fa6e feat(cli): Enhance CLI with new process management commands 2025-03-04 11:44:55 +00:00
0232741b89 1.4.0
Some checks failed
Default (tags) / security (push) Successful in 38s
Default (tags) / test (push) Failing after 1h14m52s
Default (tags) / release (push) Has been cancelled
Default (tags) / metadata (push) Has been cancelled
2025-03-03 05:21:52 +00:00
9c1327c9be feat(core): Introduced process management features using ProcessWrapper and enhanced configuration. 2025-03-03 05:21:52 +00:00
10 changed files with 986 additions and 50 deletions

View File

@ -1,5 +1,20 @@
# Changelog
## 2025-03-04 - 1.5.0 - feat(cli)
Enhance CLI with new process management commands
- Added comprehensive CLI commands for process management including start, stop, restart, list, describe and logs.
- Implemented memory string parsing for process memory limits.
- Enhanced CLI output with formatted table listings for active processes.
## 2025-03-03 - 1.4.0 - feat(core)
Introduced process management features using ProcessWrapper and enhanced configuration.
- Added ProcessWrapper for wrapping and managing child processes.
- Refactored process monitoring logic using ProcessWrapper.
- Introduced TspmConfig for configuration handling.
- Enhanced CLI to support new process management commands like 'startAsDaemon'.
## 2025-03-01 - 1.3.1 - fix(test)
Update test script to fix type references and remove private method call

View File

@ -1,6 +1,6 @@
{
"name": "@git.zone/tspm",
"version": "1.3.1",
"version": "1.5.0",
"private": false,
"description": "a no fuzz process manager",
"main": "dist_ts/index.js",
@ -26,8 +26,10 @@
"@types/node": "^22.13.8"
},
"dependencies": {
"@push.rocks/npmextra": "^5.1.2",
"@push.rocks/projectinfo": "^5.0.2",
"@push.rocks/smartcli": "^4.0.11",
"@push.rocks/smartdaemon": "^2.0.6",
"@push.rocks/smartpath": "^5.0.18",
"pidusage": "^4.0.0",
"ps-tree": "^1.2.0"

107
pnpm-lock.yaml generated
View File

@ -8,12 +8,18 @@ importers:
.:
dependencies:
'@push.rocks/npmextra':
specifier: ^5.1.2
version: 5.1.2
'@push.rocks/projectinfo':
specifier: ^5.0.2
version: 5.0.2
'@push.rocks/smartcli':
specifier: ^4.0.11
version: 4.0.11
'@push.rocks/smartdaemon':
specifier: ^2.0.6
version: 2.0.6
'@push.rocks/smartpath':
specifier: ^5.0.18
version: 5.0.18
@ -713,6 +719,9 @@ packages:
'@push.rocks/mongodump@1.0.8':
resolution: {integrity: sha512-oDufyjNBg8I50OaJvbHhc0RnRpJQ544dr9her0G6sA8JmI3hD2/amTdcPLVIX1kzYf5GsTUKeWuRaZgdNqz3ew==}
'@push.rocks/npmextra@5.1.2':
resolution: {integrity: sha512-0utZEsQSUDgFG6nGcm66Dh4DgPwqpUQcEAOtJKvubXIFRaOzQ3Yp6M8GKeL5VwxgFxWWtqp9xP8NxLEtHN9UcA==}
'@push.rocks/projectinfo@5.0.2':
resolution: {integrity: sha512-zzieCal6jwR++o+fDl8gMpWkNV2cGEsbT96vCNZu/H9kr0iqRmapOiA4DFadkhOnhlDqvRr6TPaXESu2YUbI8Q==}
@ -743,6 +752,9 @@ packages:
'@push.rocks/smartcrypto@2.0.4':
resolution: {integrity: sha512-1+/5bsjyataf5uUkUNnnVXGRAt+gHVk1KDzozjTqgqJxHvQk1d9fVDohL6CxUhUucTPtu5VR5xNBiV8YCDuGyw==}
'@push.rocks/smartdaemon@2.0.6':
resolution: {integrity: sha512-yFbZIT8Vb8fCdihM+kUnSluYmTzfARuZEs7Mbh+GjNJ9H+gbfyCt30BKocsPBUDkuliSAv/RlbYLILACNZlX8w==}
'@push.rocks/smartdata@5.2.12':
resolution: {integrity: sha512-vp0nz1P/SJcoFhyfZoewPbFSameWnuMuCkySvnb41TcCi1PFHA//KOYImdti/qURSOYwVoTKboDrnx1/ffHp7g==}
@ -770,6 +782,9 @@ packages:
'@push.rocks/smartfile@11.2.0':
resolution: {integrity: sha512-0Gw6DvCQ2D/BXNN6airSC7hoSBut0p/uNWf2+rqO+D6VLhIJ/QUBvF6xm/LnpPI/zcF8YlDn/GEriInB5DUtEw==}
'@push.rocks/smartfm@2.2.2':
resolution: {integrity: sha512-kLrBv/vWXJmB558LI5C79fWXLKOnno998vnp3opfB+uyznT2E6LkcpKsxdjwe1V/r+Z5GlhXPOWmGgHPCzUR6w==}
'@push.rocks/smartguard@3.1.0':
resolution: {integrity: sha512-J23q84f1O+TwFGmd4lrO9XLHUh2DaLXo9PN/9VmTWYzTkQDv5JehmifXVI0esophXcCIfbdIu6hbt7/aHlDF4A==}
@ -872,6 +887,9 @@ packages:
'@push.rocks/smartstring@4.0.15':
resolution: {integrity: sha512-NTNeOjWyg+aHtBTiQEyXamr7oTvYZ3wS1fudHo9ua7CLrykpK+i+RxFyJaLg1zB5x9xQF3NLEQecB14HPFX8Cg==}
'@push.rocks/smartsystem@3.0.1':
resolution: {integrity: sha512-+W9AiSJWcRAjthqDFT8rDli2+5k3bk8c9Psndy3uKN2YbaQkMZwWptZRI3WgpXMG9NhsjF8XrkyiH/xHv9AxzQ==}
'@push.rocks/smarttime@4.1.1':
resolution: {integrity: sha512-Ha/3J/G+zfTl4ahpZgF6oUOZnUjpLhrBja0OQ2cloFxF9sKT8I1COaSqIfBGDtoK2Nly4UD4aTJ3JcJNOg/kgA==}
@ -972,6 +990,10 @@ packages:
resolution: {integrity: sha512-FCRg5p5NFTyZnPsvy2sbheVGz67Zeno7VoZARrcP0O+hFtVPnQKnJ73ze11G+MKZ3dVCmYCh1Li+73R6Lx8XJA==}
deprecated: This package has been deprecated in favour of the new package at @push.rocks/smartmime
'@pushrocks/smartnetwork@3.0.2':
resolution: {integrity: sha512-XKVeTzf22IRgAvY9m8naFlsjh5yYVCU4/Dqi7XnxQUVfrnrcNIJVo+9JIYjQetLbHiUOHAnthlZVP5yXppOxyw==}
deprecated: This package has been deprecated in favour of the new package at @push.rocks/smartnetwork
'@pushrocks/smartpath@4.0.3':
resolution: {integrity: sha512-KWz4DWOrB0sPfk6L4i+CPOo+UK5HXNaLI7ZAaqJe1nEWoDrpyeds1dNDaqVAmSgX4riLGxVpslKH5MnABCPsPg==}
deprecated: This package has been deprecated in favour of the new package at @push.rocks/smartpath
@ -2246,6 +2268,10 @@ packages:
resolution: {integrity: sha512-28HqgMZAmih1Czt9ny7qr6ek2qddF4FclbMzwhCREB6OFfH+rXAnuNCwo1/wFvrtbgsQDb4kSbX9de9lFbrXnA==}
engines: {node: '>= 0.10.0'}
extend-shallow@2.0.1:
resolution: {integrity: sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=}
engines: {node: '>=0.10.0'}
extend@3.0.2:
resolution: {integrity: sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==}
@ -2472,6 +2498,10 @@ packages:
graceful-fs@4.2.11:
resolution: {integrity: sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==}
gray-matter@4.0.3:
resolution: {integrity: sha512-5v6yZd4JK3eMI3FqqCouswVqwugaA9r4dNZB1wwcmrD02QkV5H0y7XBQW8QwQqEaZY1pM9aqORSORhJRdNK44Q==}
engines: {node: '>=6.0'}
gunzip-maybe@1.4.2:
resolution: {integrity: sha512-4haO1M4mLO91PW57BMsDFf75UmwoRX0GkdD+Faw+Lr+r/OZrOCS0pIBwOL1xCKQqnQzbNFGgK2V2CpBUPeFNTw==}
hasBin: true
@ -2641,6 +2671,10 @@ packages:
engines: {node: '>=8'}
hasBin: true
is-extendable@0.1.1:
resolution: {integrity: sha1-YrEQ4omkcUGOPsNqYX1HLjAd/Ik=}
engines: {node: '>=0.10.0'}
is-extglob@2.1.1:
resolution: {integrity: sha1-qIwCU1eR8C7TfHahueqXc8gz+MI=}
engines: {node: '>=0.10.0'}
@ -3721,6 +3755,10 @@ packages:
sax@1.4.1:
resolution: {integrity: sha512-+aWOz7yVScEGoKNd4PA10LZ8sk0A/z5+nXQG5giUO5rprX9jgYsTdov9qCchZiPIZezbZH+jRut8nPodFAX4Jg==}
section-matter@1.0.0:
resolution: {integrity: sha512-vfD3pmTzGpufjScBh50YHKzEu2lxBWhVEHsNGoEXmCmn2hKGfeNLYMzCJpe8cD7gqX7TJluOVpBkAequ6dgMmA==}
engines: {node: '>=4'}
semver@6.3.1:
resolution: {integrity: sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==}
hasBin: true
@ -3897,6 +3935,10 @@ packages:
resolution: {integrity: sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==}
engines: {node: '>=12'}
strip-bom-string@1.0.0:
resolution: {integrity: sha1-5SEekiQ2n7uB1jOi8ABE3IztrZI=}
engines: {node: '>=0.10.0'}
strip-final-newline@2.0.0:
resolution: {integrity: sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA==}
engines: {node: '>=6'}
@ -5418,6 +5460,18 @@ snapshots:
transitivePeerDependencies:
- aws-crt
'@push.rocks/npmextra@5.1.2':
dependencies:
'@push.rocks/qenv': 6.1.0
'@push.rocks/smartfile': 11.2.0
'@push.rocks/smartjson': 5.0.20
'@push.rocks/smartlog': 3.0.7
'@push.rocks/smartpath': 5.0.18
'@push.rocks/smartpromise': 4.2.3
'@push.rocks/smartrx': 3.0.7
'@push.rocks/taskbuffer': 3.1.7
'@tsclass/tsclass': 4.4.0
'@push.rocks/projectinfo@5.0.2':
dependencies:
'@push.rocks/smartfile': 10.0.41
@ -5509,6 +5563,17 @@ snapshots:
'@types/node-forge': 1.3.11
node-forge: 1.3.1
'@push.rocks/smartdaemon@2.0.6':
dependencies:
'@push.rocks/lik': 6.1.0
'@push.rocks/smartfile': 11.2.0
'@push.rocks/smartfm': 2.2.2
'@push.rocks/smartlog': 3.0.7
'@push.rocks/smartlog-destination-local': 9.0.2
'@push.rocks/smartpath': 5.0.18
'@push.rocks/smartshell': 3.2.3
'@push.rocks/smartsystem': 3.0.1
'@push.rocks/smartdata@5.2.12(@aws-sdk/credential-providers@3.758.0)(socks@2.8.4)':
dependencies:
'@push.rocks/lik': 6.1.0
@ -5601,6 +5666,10 @@ snapshots:
glob: 11.0.1
js-yaml: 4.1.0
'@push.rocks/smartfm@2.2.2':
dependencies:
gray-matter: 4.0.3
'@push.rocks/smartguard@3.1.0':
dependencies:
'@push.rocks/smartpromise': 4.2.3
@ -5893,6 +5962,14 @@ snapshots:
strip-indent: 4.0.0
url: 0.11.4
'@push.rocks/smartsystem@3.0.1':
dependencies:
'@pushrocks/lik': 6.0.2
'@pushrocks/smartenv': 5.0.5
'@pushrocks/smartnetwork': 3.0.2
'@pushrocks/smartpromise': 3.1.10
systeminformation: 5.25.11
'@push.rocks/smarttime@4.1.1':
dependencies:
'@push.rocks/lik': 6.1.0
@ -6101,6 +6178,16 @@ snapshots:
'@types/mime-types': 2.1.4
mime-types: 2.1.35
'@pushrocks/smartnetwork@3.0.2':
dependencies:
'@pushrocks/smartping': 1.0.8
'@pushrocks/smartpromise': 3.1.10
'@pushrocks/smartstring': 4.0.7
'@types/default-gateway': 3.0.1
isopen: 1.3.0
public-ip: 6.0.2
systeminformation: 5.25.11
'@pushrocks/smartpath@4.0.3': {}
'@pushrocks/smartpath@5.0.5': {}
@ -7645,6 +7732,10 @@ snapshots:
transitivePeerDependencies:
- supports-color
extend-shallow@2.0.1:
dependencies:
is-extendable: 0.1.1
extend@3.0.2: {}
extract-zip@2.0.1:
@ -7917,6 +8008,13 @@ snapshots:
graceful-fs@4.2.11: {}
gray-matter@4.0.3:
dependencies:
js-yaml: 3.14.1
kind-of: 6.0.3
section-matter: 1.0.0
strip-bom-string: 1.0.0
gunzip-maybe@1.4.2:
dependencies:
browserify-zlib: 0.1.4
@ -8108,6 +8206,8 @@ snapshots:
is-docker@2.2.1: {}
is-extendable@0.1.1: {}
is-extglob@2.1.1: {}
is-fullwidth-code-point@3.0.0: {}
@ -9418,6 +9518,11 @@ snapshots:
sax@1.4.1: {}
section-matter@1.0.0:
dependencies:
extend-shallow: 2.0.1
kind-of: 6.0.3
semver@6.3.1: {}
semver@7.7.1: {}
@ -9653,6 +9758,8 @@ snapshots:
dependencies:
ansi-regex: 6.1.0
strip-bom-string@1.0.0: {}
strip-final-newline@2.0.0: {}
strip-indent@4.0.0:

View File

@ -3,6 +3,6 @@
*/
export const commitinfo = {
name: '@git.zone/tspm',
version: '1.3.1',
version: '1.5.0',
description: 'a no fuzz process manager'
}

20
ts/classes.config.ts Normal file
View File

@ -0,0 +1,20 @@
import * as plugins from './plugins.js';
export class TspmConfig {
public npmextraInstance = new plugins.npmextra.KeyValueStore({
identityArg: '@git.zone__tspm',
typeArg: 'userHomeDir',
})
public async readKey(keyArg: string): Promise<string> {
return await this.npmextraInstance.readKey(keyArg);
}
public async writeKey(keyArg: string, value: string): Promise<void> {
return await this.npmextraInstance.writeKey(keyArg, value);
}
public async deleteKey(keyArg: string): Promise<void> {
return await this.npmextraInstance.deleteKey(keyArg);
}
}

View File

@ -1,4 +1,5 @@
import * as plugins from './plugins.js';
import { ProcessWrapper, type IProcessLog } from './classes.processwrapper.js';
export interface IMonitorConfig {
name?: string; // Optional name to identify the instance
@ -7,13 +8,16 @@ export interface IMonitorConfig {
args?: string[]; // Optional: arguments for the command
memoryLimitBytes: number; // Maximum allowed memory (in bytes) for the process group
monitorIntervalMs?: number; // Interval (in ms) at which memory is checked (default: 5000)
env?: NodeJS.ProcessEnv; // Optional: custom environment variables
logBufferSize?: number; // Optional: number of log lines to keep (default: 100)
}
export class ProcessMonitor {
private child: plugins.childProcess.ChildProcess | null = null;
private processWrapper: ProcessWrapper | null = null;
private config: IMonitorConfig;
private intervalId: NodeJS.Timeout | null = null;
private stopped: boolean = true; // Initially stopped until start() is called
private restartCount: number = 0;
constructor(config: IMonitorConfig) {
this.config = config;
@ -23,59 +27,64 @@ export class ProcessMonitor {
// Reset the stopped flag so that new processes can spawn.
this.stopped = false;
this.log(`Starting process monitor.`);
this.spawnChild();
this.spawnProcess();
// Set the monitoring interval.
const interval = this.config.monitorIntervalMs || 5000;
this.intervalId = setInterval(() => {
if (this.child && this.child.pid) {
this.monitorProcessGroup(this.child.pid, this.config.memoryLimitBytes);
if (this.processWrapper && this.processWrapper.getPid()) {
this.monitorProcessGroup(this.processWrapper.getPid()!, this.config.memoryLimitBytes);
}
}, interval);
}
private spawnChild(): void {
private spawnProcess(): void {
// Don't spawn if the monitor has been stopped.
if (this.stopped) return;
if (this.config.args && this.config.args.length > 0) {
this.log(
`Spawning command "${this.config.command}" with args [${this.config.args.join(
', '
)}] in directory: ${this.config.projectDir}`
);
this.child = plugins.childProcess.spawn(this.config.command, this.config.args, {
cwd: this.config.projectDir,
detached: true,
stdio: 'inherit',
});
} else {
this.log(
`Spawning command "${this.config.command}" in directory: ${this.config.projectDir}`
);
// Use shell mode to allow a full command string.
this.child = plugins.childProcess.spawn(this.config.command, {
cwd: this.config.projectDir,
detached: true,
stdio: 'inherit',
shell: true,
});
}
// Create a new process wrapper
this.processWrapper = new ProcessWrapper({
name: this.config.name || 'unnamed-process',
command: this.config.command,
args: this.config.args,
cwd: this.config.projectDir,
env: this.config.env,
logBuffer: this.config.logBufferSize,
});
this.log(`Spawned process with PID ${this.child.pid}`);
// When the child process exits, restart it if the monitor isn't stopped.
this.child.on('exit', (code, signal) => {
this.log(`Child process exited with code ${code}, signal ${signal}.`);
if (!this.stopped) {
this.log('Restarting process...');
this.spawnChild();
// Set up event handlers
this.processWrapper.on('log', (log) => {
// Here we could add handlers to send logs somewhere
// For now, we just log system messages to the console
if (log.type === 'system') {
this.log(log.message);
}
});
this.processWrapper.on('exit', (code, signal) => {
this.log(`Process exited with code ${code}, signal ${signal}.`);
if (!this.stopped) {
this.log('Restarting process...');
this.restartCount++;
this.spawnProcess();
}
});
this.processWrapper.on('error', (error) => {
this.log(`Process error: ${error.message}`);
if (!this.stopped) {
this.log('Restarting process due to error...');
this.restartCount++;
this.spawnProcess();
}
});
// Start the process
this.processWrapper.start();
}
/**
* Monitor the process groups memory usage. If the total memory exceeds the limit,
* Monitor the process group's memory usage. If the total memory exceeds the limit,
* kill the process group so that the 'exit' handler can restart it.
*/
private async monitorProcessGroup(pid: number, memoryLimit: number): Promise<void> {
@ -92,8 +101,10 @@ export class ProcessMonitor {
memoryUsage
)} exceeds limit of ${this.humanReadableBytes(memoryLimit)}. Restarting process.`
);
// Kill the entire process group by sending a signal to -PID.
process.kill(-pid, 'SIGKILL');
// Stop the process wrapper, which will trigger the exit handler and restart
if (this.processWrapper) {
this.processWrapper.stop();
}
}
} catch (error) {
this.log('Error monitoring process group: ' + error);
@ -142,10 +153,48 @@ export class ProcessMonitor {
if (this.intervalId) {
clearInterval(this.intervalId);
}
if (this.child && this.child.pid) {
process.kill(-this.child.pid, 'SIGKILL');
if (this.processWrapper) {
this.processWrapper.stop();
}
}
/**
* Get the current logs from the process
*/
public getLogs(limit?: number): IProcessLog[] {
if (!this.processWrapper) {
return [];
}
return this.processWrapper.getLogs(limit);
}
/**
* Get the number of times the process has been restarted
*/
public getRestartCount(): number {
return this.restartCount;
}
/**
* Get the process ID if running
*/
public getPid(): number | null {
return this.processWrapper?.getPid() || null;
}
/**
* Get process uptime in milliseconds
*/
public getUptime(): number {
return this.processWrapper?.getUptime() || 0;
}
/**
* Check if the process is currently running
*/
public isRunning(): boolean {
return this.processWrapper?.isRunning() || false;
}
/**
* Helper method for logging messages with the instance name.
@ -154,4 +203,4 @@ export class ProcessMonitor {
const prefix = this.config.name ? `[${this.config.name}] ` : '';
console.log(prefix + message);
}
}
}

View File

@ -0,0 +1,207 @@
import * as plugins from './plugins.js';
import { EventEmitter } from 'events';
export interface IProcessWrapperOptions {
command: string;
args?: string[];
cwd: string;
env?: NodeJS.ProcessEnv;
name: string;
logBuffer?: number; // Number of log lines to keep in memory (default: 100)
}
export interface IProcessLog {
timestamp: Date;
type: 'stdout' | 'stderr' | 'system';
message: string;
}
export class ProcessWrapper extends EventEmitter {
private process: plugins.childProcess.ChildProcess | null = null;
private options: IProcessWrapperOptions;
private logs: IProcessLog[] = [];
private logBufferSize: number;
private startTime: Date | null = null;
constructor(options: IProcessWrapperOptions) {
super();
this.options = options;
this.logBufferSize = options.logBuffer || 100;
}
/**
* Start the wrapped process
*/
public start(): void {
this.addSystemLog('Starting process...');
try {
if (this.options.args && this.options.args.length > 0) {
this.process = plugins.childProcess.spawn(this.options.command, this.options.args, {
cwd: this.options.cwd,
env: this.options.env || process.env,
stdio: ['ignore', 'pipe', 'pipe'], // We need to pipe stdout and stderr
});
} else {
// Use shell mode to allow a full command string
this.process = plugins.childProcess.spawn(this.options.command, {
cwd: this.options.cwd,
env: this.options.env || process.env,
stdio: ['ignore', 'pipe', 'pipe'], // We need to pipe stdout and stderr
shell: true,
});
}
this.startTime = new Date();
// Handle process exit
this.process.on('exit', (code, signal) => {
this.addSystemLog(`Process exited with code ${code}, signal ${signal}`);
this.emit('exit', code, signal);
});
// Handle errors
this.process.on('error', (error) => {
this.addSystemLog(`Process error: ${error.message}`);
this.emit('error', error);
});
// Capture stdout
if (this.process.stdout) {
this.process.stdout.on('data', (data) => {
const lines = data.toString().split('\n');
for (const line of lines) {
if (line.trim()) {
this.addLog('stdout', line);
}
}
});
}
// Capture stderr
if (this.process.stderr) {
this.process.stderr.on('data', (data) => {
const lines = data.toString().split('\n');
for (const line of lines) {
if (line.trim()) {
this.addLog('stderr', line);
}
}
});
}
this.addSystemLog(`Process started with PID ${this.process.pid}`);
this.emit('start', this.process.pid);
} catch (error) {
this.addSystemLog(`Failed to start process: ${error.message}`);
this.emit('error', error);
throw error;
}
}
/**
* Stop the wrapped process
*/
public stop(): void {
if (!this.process) {
this.addSystemLog('No process running');
return;
}
this.addSystemLog('Stopping process...');
// First try SIGTERM for graceful shutdown
if (this.process.pid) {
try {
process.kill(this.process.pid, 'SIGTERM');
// Give it 5 seconds to shut down gracefully
setTimeout(() => {
if (this.process && this.process.pid) {
this.addSystemLog('Process did not exit gracefully, force killing...');
try {
process.kill(this.process.pid, 'SIGKILL');
} catch (error) {
// Process might have exited between checks
}
}
}, 5000);
} catch (error) {
this.addSystemLog(`Error stopping process: ${error.message}`);
}
}
}
/**
* Get the process ID if running
*/
public getPid(): number | null {
return this.process?.pid || null;
}
/**
* Get the current logs
*/
public getLogs(limit: number = this.logBufferSize): IProcessLog[] {
// Return the most recent logs up to the limit
return this.logs.slice(-limit);
}
/**
* Get uptime in milliseconds
*/
public getUptime(): number {
if (!this.startTime) return 0;
return Date.now() - this.startTime.getTime();
}
/**
* Check if the process is currently running
*/
public isRunning(): boolean {
return this.process !== null && typeof this.process.exitCode !== 'number';
}
/**
* Add a log entry from stdout or stderr
*/
private addLog(type: 'stdout' | 'stderr', message: string): void {
const log: IProcessLog = {
timestamp: new Date(),
type,
message,
};
this.logs.push(log);
// Trim logs if they exceed buffer size
if (this.logs.length > this.logBufferSize) {
this.logs = this.logs.slice(-this.logBufferSize);
}
// Emit log event for potential handlers
this.emit('log', log);
}
/**
* Add a system log entry (not from the process itself)
*/
private addSystemLog(message: string): void {
const log: IProcessLog = {
timestamp: new Date(),
type: 'system',
message,
};
this.logs.push(log);
// Trim logs if they exceed buffer size
if (this.logs.length > this.logBufferSize) {
this.logs = this.logs.slice(-this.logBufferSize);
}
// Emit log event for potential handlers
this.emit('log', log);
}
}

View File

@ -1,6 +1,259 @@
import * as plugins from './plugins.js';
import * as paths from './paths.js';
import { ProcessMonitor, type IMonitorConfig } from './classes.processmonitor.js';
import { TspmConfig } from './classes.config.js';
export interface IProcessConfig extends IMonitorConfig {
id: string; // Unique identifier for the process
autorestart: boolean; // Whether to restart the process automatically on crash
watch?: boolean; // Whether to watch for file changes and restart
watchPaths?: string[]; // Paths to watch for changes
}
export interface IProcessInfo {
id: string;
pid?: number;
status: 'online' | 'stopped' | 'errored';
memory: number;
cpu?: number;
uptime?: number;
restarts: number;
}
export interface IProcessLog {
timestamp: Date;
type: 'stdout' | 'stderr' | 'system';
message: string;
}
export class Tspm {
private processes: Map<string, ProcessMonitor> = new Map();
private processConfigs: Map<string, IProcessConfig> = new Map();
private processInfo: Map<string, IProcessInfo> = new Map();
private config: TspmConfig;
private configStorageKey = 'processes';
constructor() {
this.config = new TspmConfig();
this.loadProcessConfigs();
}
/**
* Start a new process with the given configuration
*/
public async start(config: IProcessConfig): Promise<void> {
// Check if process with this id already exists
if (this.processes.has(config.id)) {
throw new Error(`Process with id '${config.id}' already exists`);
}
// Create and store process config
this.processConfigs.set(config.id, config);
// Initialize process info
this.processInfo.set(config.id, {
id: config.id,
status: 'stopped',
memory: 0,
restarts: 0
});
// Create and start process monitor
const monitor = new ProcessMonitor({
name: config.name || config.id,
projectDir: config.projectDir,
command: config.command,
args: config.args,
memoryLimitBytes: config.memoryLimitBytes,
monitorIntervalMs: config.monitorIntervalMs
});
this.processes.set(config.id, monitor);
monitor.start();
// Update process info
this.updateProcessInfo(config.id, { status: 'online' });
// Save updated configs
await this.saveProcessConfigs();
}
/**
* Stop a process by id
*/
public async stop(id: string): Promise<void> {
const monitor = this.processes.get(id);
if (!monitor) {
throw new Error(`Process with id '${id}' not found`);
}
monitor.stop();
this.updateProcessInfo(id, { status: 'stopped' });
// Don't remove from the maps, just mark as stopped
// This allows it to be restarted later
}
/**
* Restart a process by id
*/
public async restart(id: string): Promise<void> {
const monitor = this.processes.get(id);
const config = this.processConfigs.get(id);
if (!monitor || !config) {
throw new Error(`Process with id '${id}' not found`);
}
// Stop and then start the process
monitor.stop();
// Create a new monitor instance
const newMonitor = new ProcessMonitor({
name: config.name || config.id,
projectDir: config.projectDir,
command: config.command,
args: config.args,
memoryLimitBytes: config.memoryLimitBytes,
monitorIntervalMs: config.monitorIntervalMs
});
this.processes.set(id, newMonitor);
newMonitor.start();
// Update restart count
const info = this.processInfo.get(id);
if (info) {
this.updateProcessInfo(id, {
status: 'online',
restarts: info.restarts + 1
});
}
}
/**
* Delete a process by id
*/
public async delete(id: string): Promise<void> {
// Stop the process if it's running
try {
await this.stop(id);
} catch (error) {
// Ignore errors if the process is not running
}
// Remove from all maps
this.processes.delete(id);
this.processConfigs.delete(id);
this.processInfo.delete(id);
// Save updated configs
await this.saveProcessConfigs();
}
/**
* Get a list of all process infos
*/
public list(): IProcessInfo[] {
return Array.from(this.processInfo.values());
}
/**
* Get detailed info for a specific process
*/
public describe(id: string): { config: IProcessConfig; info: IProcessInfo } | null {
const config = this.processConfigs.get(id);
const info = this.processInfo.get(id);
if (!config || !info) {
return null;
}
return { config, info };
}
/**
* Get process logs
*/
public getLogs(id: string, limit?: number): IProcessLog[] {
const monitor = this.processes.get(id);
if (!monitor) {
return [];
}
return monitor.getLogs(limit);
}
/**
* Start all saved processes
*/
public async startAll(): Promise<void> {
for (const [id, config] of this.processConfigs.entries()) {
if (!this.processes.has(id)) {
await this.start(config);
}
}
}
/**
* Stop all running processes
*/
public async stopAll(): Promise<void> {
for (const id of this.processes.keys()) {
await this.stop(id);
}
}
/**
* Restart all processes
*/
public async restartAll(): Promise<void> {
for (const id of this.processes.keys()) {
await this.restart(id);
}
}
/**
* Update the info for a process
*/
private updateProcessInfo(id: string, update: Partial<IProcessInfo>): void {
const info = this.processInfo.get(id);
if (info) {
this.processInfo.set(id, { ...info, ...update });
}
}
/**
* Save all process configurations to config storage
*/
private async saveProcessConfigs(): Promise<void> {
const configs = Array.from(this.processConfigs.values());
await this.config.writeKey(this.configStorageKey, JSON.stringify(configs));
}
/**
* Load process configurations from config storage
*/
private async loadProcessConfigs(): Promise<void> {
try {
const configsJson = await this.config.readKey(this.configStorageKey);
if (configsJson) {
const configs = JSON.parse(configsJson) as IProcessConfig[];
for (const config of configs) {
this.processConfigs.set(config.id, config);
// Initialize process info
this.processInfo.set(config.id, {
id: config.id,
status: 'stopped',
memory: 0,
restarts: 0
});
}
}
} catch (error) {
// If no configs found or error reading, just continue with empty configs
console.log('No saved process configurations found');
}
}
}

285
ts/cli.ts
View File

@ -1,21 +1,300 @@
import * as plugins from './plugins.js';
import * as paths from './paths.js';
import { Tspm, IProcessConfig } from './classes.tspm.js';
export const run = async () => {
const tspmProjectinfo = new plugins.projectinfo.ProjectInfo(paths.packageDir);
const tspm = new Tspm();
const smartcliInstance = new plugins.smartcli.Smartcli();
smartcliInstance.addVersion(tspmProjectinfo.npm.version);
// Default command - show help and list processes
smartcliInstance.standardCommand().subscribe({
next: (argvArg) => {
console.log(`Please specify a command.`)
next: async (argvArg) => {
console.log(`TSPM - TypeScript Process Manager v${tspmProjectinfo.npm.version}`);
console.log('Usage: tspm [command] [options]');
console.log('\nCommands:');
console.log(' start <script> Start a process');
console.log(' startAsDaemon <script> Start a process in daemon mode');
console.log(' list List all processes');
console.log(' stop <id> Stop a process');
console.log(' restart <id> Restart a process');
console.log(' delete <id> Delete a process');
console.log(' describe <id> Show details for a process');
console.log('\nUse tspm [command] --help for more information about a command.');
// Show current process list
console.log('\nProcess List:');
const processes = tspm.list();
if (processes.length === 0) {
console.log(' No processes running. Use "tspm start" to start a process.');
} else {
console.log('┌─────────┬─────────────┬───────────┬───────────┬──────────┐');
console.log('│ ID │ Name │ Status │ Memory │ Restarts │');
console.log('├─────────┼─────────────┼───────────┼───────────┼──────────┤');
for (const proc of processes) {
console.log(`${pad(proc.id, 8)}${pad(proc.id, 12)}${pad(proc.status, 10)}${pad(formatMemory(proc.memory), 10)}${pad(String(proc.restarts), 9)}`);
}
console.log('└─────────┴─────────────┴───────────┴───────────┴──────────┘');
}
},
});
// Start command - start a new process
smartcliInstance.addCommand('start').subscribe({
next: async (argvArg) => {
const script = argvArg._.length > 1 ? String(argvArg._[1]) : '';
if (!script) {
console.error('Error: Missing script argument. Usage: tspm start <script>');
return;
}
// Parse additional options
const name = argvArg.name || script;
const cwd = argvArg.cwd || process.cwd();
const memLimit = parseMemoryString(argvArg.memory || '500MB');
try {
const processConfig: IProcessConfig = {
id: argvArg.id || name.replace(/[^a-zA-Z0-9_-]/g, '_').toLowerCase(),
name: name,
projectDir: cwd,
command: script,
args: argvArg.args ? String(argvArg.args).split(' ') : undefined,
memoryLimitBytes: memLimit,
monitorIntervalMs: Number(argvArg.interval) || 5000,
autorestart: argvArg.autorestart !== 'false',
watch: Boolean(argvArg.watch)
};
await tspm.start(processConfig);
console.log(`Process ${processConfig.id} started successfully.`);
} catch (error) {
console.error(`Error starting process: ${error.message}`);
}
},
});
// Start as daemon command
smartcliInstance.addCommand('startAsDaemon').subscribe({
next: async (argvArg) => {
const script = argvArg._.length > 1 ? String(argvArg._[1]) : '';
if (!script) {
console.error('Error: Missing script argument. Usage: tspm startAsDaemon <script>');
return;
}
// For daemon mode, we'll detach from the console
const daemonProcess = plugins.childProcess.spawn(
process.execPath,
[
...process.execArgv,
process.argv[1], // The tspm script path
'start',
script,
...process.argv.slice(3) // Pass other arguments
],
{
detached: true,
stdio: 'ignore',
cwd: process.cwd()
}
);
// Unref to allow parent to exit
daemonProcess.unref();
console.log(`Started process ${script} as daemon.`);
}
});
// Stop command
smartcliInstance.addCommand('stop').subscribe({
next: async (argvArg) => {
const id = argvArg._.length > 1 ? String(argvArg._[1]) : '';
if (!id) {
console.error('Error: Missing process ID. Usage: tspm stop <id>');
return;
}
try {
await tspm.stop(id);
console.log(`Process ${id} stopped.`);
} catch (error) {
console.error(`Error stopping process: ${error.message}`);
}
}
});
// Restart command
smartcliInstance.addCommand('restart').subscribe({
next: async (argvArg) => {
const id = argvArg._.length > 1 ? String(argvArg._[1]) : '';
if (!id) {
console.error('Error: Missing process ID. Usage: tspm restart <id>');
return;
}
try {
await tspm.restart(id);
console.log(`Process ${id} restarted.`);
} catch (error) {
console.error(`Error restarting process: ${error.message}`);
}
}
});
})
// Delete command
smartcliInstance.addCommand('delete').subscribe({
next: async (argvArg) => {
const id = argvArg._.length > 1 ? String(argvArg._[1]) : '';
if (!id) {
console.error('Error: Missing process ID. Usage: tspm delete <id>');
return;
}
try {
await tspm.delete(id);
console.log(`Process ${id} deleted.`);
} catch (error) {
console.error(`Error deleting process: ${error.message}`);
}
}
});
// List command
smartcliInstance.addCommand('list').subscribe({
next: async (argvArg) => {
const processes = tspm.list();
if (processes.length === 0) {
console.log('No processes running.');
return;
}
console.log('┌─────────┬─────────────┬───────────┬───────────┬──────────┐');
console.log('│ ID │ Name │ Status │ Memory │ Restarts │');
console.log('├─────────┼─────────────┼───────────┼───────────┼──────────┤');
for (const proc of processes) {
console.log(`${pad(proc.id, 8)}${pad(proc.id, 12)}${pad(proc.status, 10)}${pad(formatMemory(proc.memory), 10)}${pad(String(proc.restarts), 9)}`);
}
console.log('└─────────┴─────────────┴───────────┴───────────┴──────────┘');
}
});
// Describe command
smartcliInstance.addCommand('describe').subscribe({
next: async (argvArg) => {
const id = argvArg._.length > 1 ? String(argvArg._[1]) : '';
if (!id) {
console.error('Error: Missing process ID. Usage: tspm describe <id>');
return;
}
const details = tspm.describe(id);
if (!details) {
console.error(`Process with ID '${id}' not found.`);
return;
}
console.log(`Details for process '${id}':`);
console.log(` Status: ${details.info.status}`);
console.log(` Memory: ${formatMemory(details.info.memory)}`);
console.log(` Restarts: ${details.info.restarts}`);
console.log(` Command: ${details.config.command}`);
console.log(` Directory: ${details.config.projectDir}`);
console.log(` Memory limit: ${formatMemory(details.config.memoryLimitBytes)}`);
if (details.config.args && details.config.args.length > 0) {
console.log(` Arguments: ${details.config.args.join(' ')}`);
}
}
});
// Logs command
smartcliInstance.addCommand('logs').subscribe({
next: async (argvArg) => {
const id = argvArg._.length > 1 ? String(argvArg._[1]) : '';
if (!id) {
console.error('Error: Missing process ID. Usage: tspm logs <id>');
return;
}
const lines = Number(argvArg.lines || argvArg.n) || 20;
const logs = tspm.getLogs(id, lines);
if (logs.length === 0) {
console.log(`No logs found for process '${id}'.`);
return;
}
// Display logs with colors for different log types
for (const log of logs) {
const timestamp = log.timestamp.toISOString();
const prefix = `[${timestamp}] `;
switch (log.type) {
case 'stdout':
console.log(`${prefix}${log.message}`);
break;
case 'stderr':
console.error(`${prefix}${log.message}`);
break;
case 'system':
console.log(`${prefix}[SYSTEM] ${log.message}`);
break;
}
}
}
});
// Start parsing
smartcliInstance.startParse();
};
// Helper function to format memory usage
function formatMemory(bytes: number): string {
if (bytes === 0) return '0 B';
const k = 1024;
const sizes = ['B', 'KB', 'MB', 'GB', 'TB'];
const i = Math.floor(Math.log(bytes) / Math.log(k));
return parseFloat((bytes / Math.pow(k, i)).toFixed(2)) + ' ' + sizes[i];
}
// Helper function to parse memory strings like "500MB"
function parseMemoryString(memString: string): number {
const units = {
'B': 1,
'KB': 1024,
'MB': 1024 * 1024,
'GB': 1024 * 1024 * 1024,
'TB': 1024 * 1024 * 1024 * 1024
};
const match = memString.match(/^(\d+(?:\.\d+)?)\s*([KMGT]?B)$/i);
if (!match) {
throw new Error(`Invalid memory format: ${memString}. Use format like 500MB`);
}
const value = parseFloat(match[1]);
const unit = match[2].toUpperCase();
return value * units[unit];
}
// Helper function to pad strings for table display
function pad(str: string, length: number): string {
return str.padEnd(length);
}

View File

@ -8,14 +8,18 @@ export {
}
// @push.rocks scope
import * as npmextra from '@push.rocks/npmextra';
import * as projectinfo from '@push.rocks/projectinfo';
import * as smartpath from '@push.rocks/smartpath';
import * as smartcli from '@push.rocks/smartcli';
import * as smartdaemon from '@push.rocks/smartdaemon';
import * as smartpath from '@push.rocks/smartpath';
export {
npmextra,
projectinfo,
smartpath,
smartcli,
smartdaemon,
smartpath,
}
// third-party scope