13 Commits

11 changed files with 7408 additions and 4645 deletions

64
changelog.md Normal file
View File

@@ -0,0 +1,64 @@
# Changelog
## 2025-12-15 - 1.1.0 - feat(smartexit)
Add silent logging option, structured shutdown logs, and killAll return stats
- Introduce ISmartExitOptions with a silent flag to disable console logging
- Add internal log() helper and use a [smartexit] prefix for shutdown/error messages
- killAll() now returns Promise<{ processesKilled, cleanupFunctionsRan }> and tallies processes and cleanup functions run
- Constructor accepts options (backwards compatible) to configure behavior
- Documentation (readme.hints.md) updated with usage and example output
## 2025-12-15 - 1.0.24 - fix(deps)
bump dependencies, update tests and docs, adjust tsconfig and npm release config
- Upgrade devDependencies: @git.zone/tsbuild -> ^4.0.2, @git.zone/tsrun -> ^2.0.1, @git.zone/tstest -> ^3.1.3, @types/node -> ^24.0.3 (removed @push.rocks/tapbundle)
- Bump runtime deps: @push.rocks/lik -> ^6.2.2, @push.rocks/smartpromise -> ^4.2.3
- Switch test imports to @git.zone/tstest/tapbundle and export default tap.start()
- Revise README: expanded documentation, new install instructions (pnpm), issue reporting guidance, examples (Express, killTreeByPid), and wording/formatting improvements
- Remove experimentalDecorators and useDefineForClassFields from tsconfig compilerOptions
- Add @git.zone/cli release registry configuration to npmextra.json (verdaccio + npm registry)
## 2024-05-29 - 1.0.23 - docs
Update package description.
- Updated project/package description text.
## 2024-04-18 - 1.0.22 - fix(core)
Core fixes and maintenance.
- Miscellaneous core updates and bug fixes.
## 2024-04-18 - 1.0.21 - core/build
Maintenance and config updates for 1.0.21.
- Miscellaneous core fixes.
- Updated tsconfig.
- Updated npmextra.json (githost) across multiple commits.
## 2023-09-11 - 1.0.20 - maintenance
Organization and core adjustments.
- Switched to new organization scheme.
- Miscellaneous core fixes.
## 2021-08-17 - 1.0.19 - 1.0.2 - maintenance
Multiple minor core fixes and release/tag-only commits (grouped).
- Series of minor core fixes and maintenance updates across versions 1.0.2 through 1.0.19.
- Many commits are release tags or generic core updates without additional user-facing changes.
## 2019-05-23 - 1.0.8 - fix(core)
Improve process termination behavior.
- Now killing groups of processes with negative PIDs to ensure child process groups are handled correctly.
## 2019-05-22 - 1.0.7 - fix(core)
Stronger process kill handling.
- Added SIGKILL fallback with a 10-second delay to ensure processes are terminated when needed.
## 2019-05-16 - 1.0.1 - init
Initial core commit.
- Initial core implementation and setup (recorded as fix(core): initial).

View File

@@ -2,17 +2,45 @@
"gitzone": {
"projectType": "npm",
"module": {
"githost": "gitlab.com",
"githost": "code.foss.global",
"gitscope": "push.rocks",
"gitrepo": "smartexit",
"description": "do things before one exists a process",
"description": "A library for managing graceful shutdowns of Node.js processes by handling cleanup operations, including terminating child processes.",
"npmPackagename": "@push.rocks/smartexit",
"license": "MIT",
"projectDomain": "push.rocks"
"projectDomain": "push.rocks",
"keywords": [
"Node.js",
"TypeScript",
"process management",
"graceful shutdown",
"cleanup operations",
"child process termination",
"signal handling",
"library",
"npm package",
"async cleanup",
"module",
"SIGINT handling",
"uncaught exception management",
"process exit management"
]
}
},
"npmci": {
"npmGlobalTools": [],
"npmAccessLevel": "public"
},
"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"
},
"@git.zone/cli": {
"release": {
"registries": [
"https://verdaccio.lossleess.digital",
"https://registry.npmjs.org"
],
"accessLevel": "public"
}
}
}

View File

@@ -1,8 +1,8 @@
{
"name": "@push.rocks/smartexit",
"version": "1.0.21",
"version": "1.1.0",
"private": false,
"description": "do things before one exists a process",
"description": "A library for managing graceful shutdowns of Node.js processes by handling cleanup operations, including terminating child processes.",
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"author": "Lossless GmbH",
@@ -13,15 +13,16 @@
"buildDocs": "tsdoc"
},
"devDependencies": {
"@git.zone/tsbuild": "^2.1.70",
"@git.zone/tstest": "^1.0.81",
"@gitzone/tsrun": "^1.2.44",
"@push.rocks/tapbundle": "^5.0.15",
"@types/node": "^20.6.0"
"@git.zone/tsbuild": "^4.0.2",
"@git.zone/tsrun": "^2.0.1",
"@git.zone/tstest": "^3.1.3",
"@types/node": "^24.0.3"
},
"dependencies": {
"@push.rocks/lik": "^6.0.5",
"@push.rocks/smartdelay": "^3.0.5"
"@push.rocks/lik": "^6.2.2",
"@push.rocks/smartdelay": "^3.0.5",
"@push.rocks/smartpromise": "^4.2.3",
"tree-kill": "^1.2.2"
},
"browserslist": [
"last 1 chrome versions"
@@ -38,5 +39,26 @@
"npmextra.json",
"readme.md"
],
"type": "module"
"type": "module",
"keywords": [
"Node.js",
"TypeScript",
"process management",
"graceful shutdown",
"cleanup operations",
"child process termination",
"signal handling",
"library",
"npm package",
"async cleanup",
"module",
"SIGINT handling",
"uncaught exception management",
"process exit management"
],
"homepage": "https://code.foss.global/push.rocks/smartexit",
"repository": {
"type": "git",
"url": "https://code.foss.global/push.rocks/smartexit.git"
}
}

11551
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

29
readme.hints.md Normal file
View File

@@ -0,0 +1,29 @@
# SmartExit - Development Hints
## Logging System
The module uses consolidated logging with a `[smartexit]` prefix:
- **Default behavior**: Logs a single summary line on shutdown
- **Silent mode**: Pass `{ silent: true }` to constructor to disable all logging
### Example output
```
[smartexit] Shutdown complete: killed 3 child processes, ran 2 cleanup functions
```
### Usage
```typescript
// Default - logs summary
const smartExit = new SmartExit();
// Silent - no logging
const smartExit = new SmartExit({ silent: true });
```
## killAll() Return Value
The `killAll()` method returns stats about the cleanup:
```typescript
const { processesKilled, cleanupFunctionsRan } = await smartExit.killAll();
```

162
readme.md
View File

@@ -1,40 +1,148 @@
# @push.rocks/smartexit
do things before one exists a process
## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartexit)
* [gitlab.com (source)](https://gitlab.com/push.rocks/smartexit)
* [github.com (source mirror)](https://github.com/push.rocks/smartexit)
* [docs (typedoc)](https://push.rocks.gitlab.io/smartexit/)
A library for managing graceful shutdowns of Node.js processes by handling cleanup operations, including terminating child processes.
## Status for master
## Issue Reporting and Security
Status Category | Status Badge
-- | --
GitLab Pipelines | [![pipeline status](https://gitlab.com/push.rocks/smartexit/badges/master/pipeline.svg)](https://lossless.cloud)
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/push.rocks/smartexit/badges/master/coverage.svg)](https://lossless.cloud)
npm | [![npm downloads per month](https://badgen.net/npm/dy/@push.rocks/smartexit)](https://lossless.cloud)
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/push.rocks/smartexit)](https://lossless.cloud)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@push.rocks/smartexit)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@push.rocks/smartexit)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/smartexit)](https://lossless.cloud)
For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
## Install
To install `@push.rocks/smartexit`, use pnpm:
```bash
pnpm install @push.rocks/smartexit
```
## Usage
## Contribution
`@push.rocks/smartexit` helps you gracefully shut down Node.js applications by running cleanup operations before the process exits. It handles signal interception (`SIGINT`, `SIGTERM`), uncaught exception management, and child process termination.
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
### Basic Setup
```typescript
import { SmartExit } from '@push.rocks/smartexit';
## Contribution
// Create an instance - this automatically hooks into process signals
const smartExit = new SmartExit();
```
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
### Registering Cleanup Functions
For further information read the linked docs at the top of this readme.
Define custom async cleanup functions that execute before the process exits:
## Legal
> MIT licensed | **&copy;** [Task Venture Capital GmbH](https://task.vc)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
```typescript
smartExit.addCleanupFunction(async () => {
console.log('Closing database connections...');
await database.close();
});
smartExit.addCleanupFunction(async () => {
console.log('Flushing logs...');
await logger.flush();
});
```
### Managing Child Processes
Track spawned child processes so they get properly terminated on exit:
```typescript
import { spawn } from 'child_process';
const childProcess = spawn('node', ['worker.js']);
smartExit.addProcess(childProcess);
// Remove from tracking if the process ends naturally
childProcess.on('exit', () => {
smartExit.removeProcess(childProcess);
});
```
### Kill Process Trees by PID
Terminate an entire process tree using the static `killTreeByPid` method:
```typescript
import { SmartExit, type TProcessSignal } from '@push.rocks/smartexit';
// Kill with default SIGKILL
await SmartExit.killTreeByPid(12345);
// Kill with a specific signal
await SmartExit.killTreeByPid(12345, 'SIGTERM');
```
### Triggering Cleanup Manually
While `SmartExit` automatically hooks into `SIGINT`, `SIGTERM`, and uncaught exceptions, you can manually trigger cleanup:
```typescript
await smartExit.killAll();
process.exit(0);
```
### Integrating with Express
Gracefully close an Express server on shutdown:
```typescript
import express from 'express';
import { SmartExit } from '@push.rocks/smartexit';
const app = express();
const smartExit = new SmartExit();
const server = app.listen(3000, () => {
console.log('Server running on port 3000');
});
smartExit.addCleanupFunction(async () => {
console.log('Closing Express server...');
await new Promise<void>((resolve) => server.close(() => resolve()));
});
```
### Available Process Signals
The `TProcessSignal` type provides all standard POSIX signals:
```typescript
import type { TProcessSignal } from '@push.rocks/smartexit';
// Examples: 'SIGINT', 'SIGTERM', 'SIGKILL', 'SIGHUP', 'SIGUSR1', 'SIGUSR2', etc.
```
### How It Works
When you create a `SmartExit` instance, it automatically:
1. **Hooks `SIGINT`** (Ctrl+C): Runs cleanup and exits with code 0
2. **Hooks process `exit`**: Runs cleanup when `process.exit(0)` is called
3. **Catches uncaught exceptions**: Logs the error, runs cleanup, and exits with code 1
On `killAll()`, it:
- Sends `SIGINT` to all tracked child processes
- Waits 10 seconds, then sends `SIGKILL` if processes are still alive
- Executes all registered cleanup functions
## License and Legal Information
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./LICENSE) file.
**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.
### Trademarks
This 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 or third parties, 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 or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
### Company Information
Task Venture Capital GmbH
Registered at District Court Bremen HRB 35230 HB, Germany
For any legal inquiries or further information, please contact us via email at hello@task.vc.
By 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.

View File

@@ -1,4 +1,4 @@
import { expect, tap } from '@push.rocks/tapbundle';
import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as smartexit from '../ts/index.js';
let testSmartexit: smartexit.SmartExit;
@@ -11,4 +11,4 @@ tap.test('should end processes upon SIGINT', async (tools) => {
await tools.delayFor(5000);
});
tap.start();
export default tap.start();

View File

@@ -1,8 +1,8 @@
/**
* autocreated commitinfo by @pushrocks/commitinfo
* autocreated commitinfo by @push.rocks/commitinfo
*/
export const commitinfo = {
name: '@push.rocks/smartexit',
version: '1.0.21',
description: 'do things before one exists a process'
version: '1.1.0',
description: 'A library for managing graceful shutdowns of Node.js processes by handling cleanup operations, including terminating child processes.'
}

View File

@@ -1,8 +1,78 @@
import * as plugins from './smartexit.plugins.js';
export interface ISmartExitOptions {
silent?: boolean; // Completely disable logging
}
export type TProcessSignal =
| 'SIGHUP' // Hangup detected on controlling terminal or death of controlling process
| 'SIGINT' // Interrupt from keyboard
| 'SIGQUIT' // Quit from keyboard
| 'SIGILL' // Illegal Instruction
| 'SIGTRAP' // Trace/breakpoint trap
| 'SIGABRT' // Abort signal from abort(3)
| 'SIGIOT' // IOT trap. A synonym for SIGABRT
| 'SIGBUS' // Bus error (bad memory access)
| 'SIGFPE' // Floating-point exception
| 'SIGKILL' // Kill signal
| 'SIGUSR1' // User-defined signal 1
| 'SIGSEGV' // Invalid memory reference
| 'SIGUSR2' // User-defined signal 2
| 'SIGPIPE' // Broken pipe: write to pipe with no readers
| 'SIGALRM' // Timer signal from alarm(2)
| 'SIGTERM' // Termination signal
| 'SIGCHLD' // Child stopped or terminated
| 'SIGCONT' // Continue if stopped
| 'SIGSTOP' // Stop process
| 'SIGTSTP' // Stop typed at terminal
| 'SIGTTIN' // Terminal input for background process
| 'SIGTTOU' // Terminal output for background process
| 'SIGURG' // Urgent condition on socket
| 'SIGXCPU' // CPU time limit exceeded
| 'SIGXFSZ' // File size limit exceeded
| 'SIGVTALRM' // Virtual alarm clock
| 'SIGPROF' // Profiling timer expired
| 'SIGWINCH' // Window resize signal
| 'SIGPOLL' // Pollable event (Sys V). Synonym for SIGIO
| 'SIGIO' // I/O now possible (4.2BSD)
| 'SIGPWR' // Power failure (System V)
| 'SIGINFO' // Information request (some systems)
| 'SIGLOST' // Resource lost (unused on most UNIX systems)
| 'SIGSYS' // Bad system call (unused on most UNIX systems)
| 'SIGUNUSED'; // Synonym for SIGSYS
export class SmartExit {
public static async killTreeByPid(pidArg: number, signalArg: TProcessSignal = 'SIGKILL') {
const done = plugins.smartpromise.defer();
plugins.treeKill.default(pidArg, signalArg, (err) => {
if (err) {
done.reject(err);
} else {
done.resolve();
}
});
await done.promise;
}
// Instance
public processesToEnd = new plugins.lik.ObjectMap<plugins.childProcess.ChildProcess>();
public cleanupFunctions = new plugins.lik.ObjectMap<() => Promise<any>>();
private options: ISmartExitOptions;
/**
* Internal logging helper that respects silent option
*/
private log(message: string, isError = false): void {
if (this.options.silent) {
return;
}
const prefix = '[smartexit]';
if (isError) {
console.error(`${prefix} ${message}`);
} else {
console.log(`${prefix} ${message}`);
}
}
/**
* adds a process to be exited
@@ -23,59 +93,66 @@ export class SmartExit {
this.processesToEnd.remove(childProcessArg);
}
public async killAll() {
console.log('Checking for remaining child processes before exit...');
if (this.processesToEnd.getArray().length > 0) {
console.log('found remaining child processes');
let counter = 1;
this.processesToEnd.forEach(async (childProcessArg) => {
const pid = childProcessArg.pid;
console.log(`killing process #${counter} with pid ${pid}`);
plugins.smartdelay.delayFor(10000).then(() => {
if (childProcessArg.killed) {
return;
}
process.kill(pid, 'SIGKILL');
});
process.kill(pid, 'SIGINT');
public async killAll(): Promise<{ processesKilled: number; cleanupFunctionsRan: number }> {
const processes = this.processesToEnd.getArray();
const cleanupFuncs = this.cleanupFunctions.getArray();
let processesKilled = 0;
let cleanupFunctionsRan = 0;
counter++;
});
} else {
console.log(`ChildProcesses look clean.`);
// Kill child processes
if (processes.length > 0) {
for (const childProcessArg of processes) {
const pid = childProcessArg.pid;
if (pid) {
plugins.smartdelay.delayFor(10000).then(() => {
if (childProcessArg.killed) {
return;
}
process.kill(pid, 'SIGKILL');
});
process.kill(pid, 'SIGINT');
processesKilled++;
}
}
}
if (this.cleanupFunctions.getArray.length > 0) {
this.cleanupFunctions.forEach(async (cleanupFunction) => {
// Run cleanup functions
if (cleanupFuncs.length > 0) {
for (const cleanupFunction of cleanupFuncs) {
await cleanupFunction();
});
cleanupFunctionsRan++;
}
}
console.log(`Ready to exit!`);
return { processesKilled, cleanupFunctionsRan };
}
constructor() {
constructor(optionsArg: ISmartExitOptions = {}) {
this.options = optionsArg;
// do app specific cleaning before exiting
process.on('exit', async (code) => {
if (code === 0) {
console.log('Process wants to exit');
await this.killAll();
console.log('Exited ok!');
const { processesKilled, cleanupFunctionsRan } = await this.killAll();
this.log(`Shutdown complete: killed ${processesKilled} child processes, ran ${cleanupFunctionsRan} cleanup functions`);
} else {
console.error('Exited NOT OK!');
const { processesKilled, cleanupFunctionsRan } = await this.killAll();
this.log(`Shutdown complete: killed ${processesKilled} child processes, ran ${cleanupFunctionsRan} cleanup functions (exit code: ${code})`, true);
}
});
// catch ctrl+c event and exit normally
process.on('SIGINT', async () => {
console.log('Ctrl-C... or SIGINT signal received!');
await this.killAll();
const { processesKilled, cleanupFunctionsRan } = await this.killAll();
this.log(`Shutdown complete: killed ${processesKilled} child processes, ran ${cleanupFunctionsRan} cleanup functions`);
process.exit(0);
});
//catch uncaught exceptions, trace, then exit normally
// catch uncaught exceptions, trace, then exit normally
process.on('uncaughtException', async (err) => {
console.log('SMARTEXIT: uncaught exception...');
console.log(err);
await this.killAll();
this.log(`Uncaught exception: ${err.message}`, true);
const { processesKilled, cleanupFunctionsRan } = await this.killAll();
this.log(`Shutdown complete: killed ${processesKilled} child processes, ran ${cleanupFunctionsRan} cleanup functions (exit code: 1)`, true);
process.exit(1);
});
}

View File

@@ -6,5 +6,13 @@ export { childProcess };
// pushrocks scope
import * as lik from '@push.rocks/lik';
import * as smartdelay from '@push.rocks/smartdelay';
import * as smartpromise from '@push.rocks/smartpromise';
export { lik, smartdelay };
export { lik, smartdelay, smartpromise };
// third party scope
import * as treeKill from 'tree-kill';
export {
treeKill
}

View File

@@ -1,10 +1,8 @@
{
"compilerOptions": {
"experimentalDecorators": true,
"useDefineForClassFields": false,
"target": "ES2022",
"module": "ES2022",
"moduleResolution": "nodenext",
"module": "NodeNext",
"moduleResolution": "NodeNext",
"esModuleInterop": true,
"verbatimModuleSyntax": true
},