fix(deps): bump dependencies, update tests and docs, adjust tsconfig and npm release config
This commit is contained in:
55
changelog.md
Normal file
55
changelog.md
Normal file
@@ -0,0 +1,55 @@
|
||||
# Changelog
|
||||
|
||||
## 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).
|
||||
@@ -33,5 +33,14 @@
|
||||
},
|
||||
"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"
|
||||
}
|
||||
}
|
||||
}
|
||||
13
package.json
13
package.json
@@ -13,16 +13,15 @@
|
||||
"buildDocs": "tsdoc"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@git.zone/tsbuild": "^2.1.72",
|
||||
"@git.zone/tstest": "^1.0.88",
|
||||
"@gitzone/tsrun": "^1.2.44",
|
||||
"@push.rocks/tapbundle": "^5.0.23",
|
||||
"@types/node": "^20.12.7"
|
||||
"@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.14",
|
||||
"@push.rocks/lik": "^6.2.2",
|
||||
"@push.rocks/smartdelay": "^3.0.5",
|
||||
"@push.rocks/smartpromise": "^4.0.3",
|
||||
"@push.rocks/smartpromise": "^4.2.3",
|
||||
"tree-kill": "^1.2.2"
|
||||
},
|
||||
"browserslist": [
|
||||
|
||||
10866
pnpm-lock.yaml
generated
10866
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
126
readme.md
126
readme.md
@@ -1,126 +1,148 @@
|
||||
# @push.rocks/smartexit
|
||||
|
||||
A library for performing cleanup operations before exiting a Node.js process, ensuring graceful shutdowns.
|
||||
A library for managing graceful shutdowns of Node.js processes by handling cleanup operations, including terminating child processes.
|
||||
|
||||
## Issue Reporting and Security
|
||||
|
||||
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 npm or Yarn as follows:
|
||||
To install `@push.rocks/smartexit`, use pnpm:
|
||||
|
||||
```bash
|
||||
npm install @push.rocks/smartexit --save
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```bash
|
||||
yarn add @push.rocks/smartexit
|
||||
pnpm install @push.rocks/smartexit
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
This library is designed to facilitate graceful shutdowns in Node.js applications by allowing developers to easily perform cleanup operations (like closing database connections or stopping child processes) before the process exits. Below is a guide on integrating `@push.rocks/smartexit` using TypeScript.
|
||||
`@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.
|
||||
|
||||
### Basic Setup
|
||||
|
||||
First, import `SmartExit` from the package:
|
||||
|
||||
```typescript
|
||||
import { SmartExit } from '@push.rocks/smartexit';
|
||||
```
|
||||
|
||||
Create an instance of `SmartExit`:
|
||||
|
||||
```typescript
|
||||
// Create an instance - this automatically hooks into process signals
|
||||
const smartExit = new SmartExit();
|
||||
```
|
||||
|
||||
### Registering Cleanup Functions
|
||||
|
||||
`SmartExit` enables you to define custom cleanup functions that are executed before the process exits. These functions should return a promise to ensure all asynchronous cleanup operations complete successfully.
|
||||
Define custom async cleanup functions that execute before the process exits:
|
||||
|
||||
```typescript
|
||||
smartExit.addCleanupFunction(async () => {
|
||||
console.log("Performing custom cleanup...");
|
||||
// Your cleanup operations here
|
||||
console.log('Closing database connections...');
|
||||
await database.close();
|
||||
});
|
||||
|
||||
smartExit.addCleanupFunction(async () => {
|
||||
console.log('Flushing logs...');
|
||||
await logger.flush();
|
||||
});
|
||||
```
|
||||
|
||||
### Managing Child Processes
|
||||
|
||||
It's common for a Node.js application to spawn child processes. `SmartExit` can also manage these, ensuring all child processes cleanly exit before the parent process exits.
|
||||
|
||||
To add a child process to the management list:
|
||||
Track spawned child processes so they get properly terminated on exit:
|
||||
|
||||
```typescript
|
||||
import { spawn } from 'child_process';
|
||||
|
||||
const childProcess = spawn('your_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);
|
||||
});
|
||||
```
|
||||
|
||||
If necessary, you can remove a previously added child process:
|
||||
### Kill Process Trees by PID
|
||||
|
||||
Terminate an entire process tree using the static `killTreeByPid` method:
|
||||
|
||||
```typescript
|
||||
smartExit.removeProcess(childProcess);
|
||||
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
|
||||
### Triggering Cleanup Manually
|
||||
|
||||
`SmartExit` automatically hooks into several process signal events (like `SIGTERM` and `SIGINT`) to start the cleanup procedure. However, you can manually trigger the cleanup and exit processes:
|
||||
While `SmartExit` automatically hooks into `SIGINT`, `SIGTERM`, and uncaught exceptions, you can manually trigger cleanup:
|
||||
|
||||
```typescript
|
||||
await smartExit.killAll();
|
||||
process.exit(0); // or process.exit(1) to indicate an error state if needed
|
||||
process.exit(0);
|
||||
```
|
||||
|
||||
### Advanced Usage
|
||||
### Integrating with Express
|
||||
|
||||
In more complex scenarios, you might need to conditionally add or remove cleanup functions and child processes, or integrate `SmartExit` with other libraries and frameworks for more comprehensive process management and shutdown procedures. Here you can leverage the full flexibility of JavaScript and TypeScript to tailor the shutdown behavior to your application's specific needs.
|
||||
|
||||
#### Example: Shutdown on Uncaught Exceptions
|
||||
Gracefully close an Express server on shutdown:
|
||||
|
||||
```typescript
|
||||
process.on('uncaughtException', async (error) => {
|
||||
console.error("Uncaught Exception:", error);
|
||||
await smartExit.killAll(); // Ensures all cleanup functions and child processes are managed
|
||||
process.exit(1); // Exits with error
|
||||
});
|
||||
```
|
||||
import express from 'express';
|
||||
import { SmartExit } from '@push.rocks/smartexit';
|
||||
|
||||
#### Integrating with Express
|
||||
const app = express();
|
||||
const smartExit = new SmartExit();
|
||||
|
||||
If your application uses Express, you might want to close the server gracefully:
|
||||
|
||||
```typescript
|
||||
const server = app.listen(port, () => {
|
||||
console.log(`Server started on port ${port}`);
|
||||
const server = app.listen(3000, () => {
|
||||
console.log('Server running on port 3000');
|
||||
});
|
||||
|
||||
smartExit.addCleanupFunction(async () => {
|
||||
console.log("Closing Express server...");
|
||||
await new Promise((resolve) => server.close(resolve));
|
||||
console.log('Closing Express server...');
|
||||
await new Promise<void>((resolve) => server.close(() => resolve()));
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
### Available Process Signals
|
||||
|
||||
This documentation provides a foundational understanding of how to utilize `@push.rocks/smartexit` for managing graceful shutdowns in Node.js applications with TypeScript. Remember to adjust the code examples as necessary to fit your specific project requirements.
|
||||
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 that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
||||
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 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.
|
||||
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
|
||||
Registered at District Court Bremen HRB 35230 HB, Germany
|
||||
|
||||
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
|
||||
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.
|
||||
|
||||
@@ -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();
|
||||
|
||||
@@ -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.23',
|
||||
version: '1.0.24',
|
||||
description: 'A library for managing graceful shutdowns of Node.js processes by handling cleanup operations, including terminating child processes.'
|
||||
}
|
||||
|
||||
@@ -1,7 +1,5 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
|
||||
Reference in New Issue
Block a user