Compare commits
22 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| fc4238f0fc | |||
| 1dbb6f6a7c | |||
| 13f556abe5 | |||
| d3fe10d282 | |||
| fd6eb7eecf | |||
| 3d1ad808a5 | |||
| 7ef3a8da22 | |||
| 35871b6f23 | |||
| ce3eda10e8 | |||
| c1de38b771 | |||
| 1588c695ce | |||
| 8192cb7bf9 | |||
| 2031a408bf | |||
| a2b3cede4e | |||
| ac51ece229 | |||
| 49c4681b87 | |||
| 9cae8d4818 | |||
| ecc8b1c73a | |||
| cbc4b7b285 | |||
| 6210358568 | |||
| fe1c2754da | |||
| 4cb41aa1d6 |
66
.gitea/workflows/default_nottags.yaml
Normal file
66
.gitea/workflows/default_nottags.yaml
Normal file
@ -0,0 +1,66 @@
|
||||
name: Default (not tags)
|
||||
|
||||
on:
|
||||
push:
|
||||
tags-ignore:
|
||||
- '**'
|
||||
|
||||
env:
|
||||
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
||||
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
||||
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
||||
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
||||
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
|
||||
|
||||
jobs:
|
||||
security:
|
||||
runs-on: ubuntu-latest
|
||||
continue-on-error: true
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Install pnpm and npmci
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @shipzone/npmci
|
||||
|
||||
- name: Run npm prepare
|
||||
run: npmci npm prepare
|
||||
|
||||
- name: Audit production dependencies
|
||||
run: |
|
||||
npmci command npm config set registry https://registry.npmjs.org
|
||||
npmci command pnpm audit --audit-level=high --prod
|
||||
continue-on-error: true
|
||||
|
||||
- name: Audit development dependencies
|
||||
run: |
|
||||
npmci command npm config set registry https://registry.npmjs.org
|
||||
npmci command pnpm audit --audit-level=high --dev
|
||||
continue-on-error: true
|
||||
|
||||
test:
|
||||
if: ${{ always() }}
|
||||
needs: security
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Test stable
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
npmci npm test
|
||||
|
||||
- name: Test build
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
npmci npm build
|
||||
124
.gitea/workflows/default_tags.yaml
Normal file
124
.gitea/workflows/default_tags.yaml
Normal file
@ -0,0 +1,124 @@
|
||||
name: Default (tags)
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- '*'
|
||||
|
||||
env:
|
||||
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
||||
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
||||
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
||||
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
||||
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
|
||||
|
||||
jobs:
|
||||
security:
|
||||
runs-on: ubuntu-latest
|
||||
continue-on-error: true
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Prepare
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @shipzone/npmci
|
||||
npmci npm prepare
|
||||
|
||||
- name: Audit production dependencies
|
||||
run: |
|
||||
npmci command npm config set registry https://registry.npmjs.org
|
||||
npmci command pnpm audit --audit-level=high --prod
|
||||
continue-on-error: true
|
||||
|
||||
- name: Audit development dependencies
|
||||
run: |
|
||||
npmci command npm config set registry https://registry.npmjs.org
|
||||
npmci command pnpm audit --audit-level=high --dev
|
||||
continue-on-error: true
|
||||
|
||||
test:
|
||||
if: ${{ always() }}
|
||||
needs: security
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Prepare
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @shipzone/npmci
|
||||
npmci npm prepare
|
||||
|
||||
- name: Test stable
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
npmci npm test
|
||||
|
||||
- name: Test build
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
npmci npm build
|
||||
|
||||
release:
|
||||
needs: test
|
||||
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Prepare
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @shipzone/npmci
|
||||
npmci npm prepare
|
||||
|
||||
- name: Release
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm publish
|
||||
|
||||
metadata:
|
||||
needs: test
|
||||
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
continue-on-error: true
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Prepare
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @shipzone/npmci
|
||||
npmci npm prepare
|
||||
|
||||
- name: Code quality
|
||||
run: |
|
||||
npmci command npm install -g typescript
|
||||
npmci npm install
|
||||
|
||||
- name: Trigger
|
||||
run: npmci trigger
|
||||
|
||||
- name: Build docs and upload artifacts
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
pnpm install -g @git.zone/tsdoc
|
||||
npmci command tsdoc
|
||||
continue-on-error: true
|
||||
4
.gitignore
vendored
4
.gitignore
vendored
@ -15,8 +15,6 @@ node_modules/
|
||||
|
||||
# builds
|
||||
dist/
|
||||
dist_web/
|
||||
dist_serve/
|
||||
dist_ts_web/
|
||||
dist_*/
|
||||
|
||||
# custom
|
||||
125
.gitlab-ci.yml
125
.gitlab-ci.yml
@ -1,125 +0,0 @@
|
||||
# gitzone standard
|
||||
image: hosttoday/ht-docker-node:npmci
|
||||
|
||||
cache:
|
||||
paths:
|
||||
- .npmci_cache/
|
||||
key: "$CI_BUILD_STAGE"
|
||||
|
||||
stages:
|
||||
- security
|
||||
- test
|
||||
- release
|
||||
- metadata
|
||||
|
||||
# ====================
|
||||
# security stage
|
||||
# ====================
|
||||
mirror:
|
||||
stage: security
|
||||
script:
|
||||
- npmci git mirror
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
snyk:
|
||||
stage: security
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci command npm install -g snyk
|
||||
- npmci command npm install --ignore-scripts
|
||||
- npmci command snyk test
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
# ====================
|
||||
# test stage
|
||||
# ====================
|
||||
|
||||
testLTS:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install lts
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
testSTABLE:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
release:
|
||||
stage: release
|
||||
script:
|
||||
- npmci node install stable
|
||||
- npmci npm publish
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
# ====================
|
||||
# metadata stage
|
||||
# ====================
|
||||
codequality:
|
||||
stage: metadata
|
||||
image: docker:stable
|
||||
allow_failure: true
|
||||
services:
|
||||
- docker:stable-dind
|
||||
script:
|
||||
- export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
|
||||
- docker run
|
||||
--env SOURCE_CODE="$PWD"
|
||||
--volume "$PWD":/code
|
||||
--volume /var/run/docker.sock:/var/run/docker.sock
|
||||
"registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
|
||||
artifacts:
|
||||
paths: [codeclimate.json]
|
||||
tags:
|
||||
- docker
|
||||
- priv
|
||||
|
||||
trigger:
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci trigger
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
pages:
|
||||
image: hosttoday/ht-docker-node:npmci
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci command npm install -g @gitzone/tsdoc
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
- npmci command tsdoc
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
only:
|
||||
- tags
|
||||
artifacts:
|
||||
expire_in: 1 week
|
||||
paths:
|
||||
- public
|
||||
allow_failure: true
|
||||
11
.vscode/launch.json
vendored
Normal file
11
.vscode/launch.json
vendored
Normal file
@ -0,0 +1,11 @@
|
||||
{
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"command": "npm test",
|
||||
"name": "Run npm test",
|
||||
"request": "launch",
|
||||
"type": "node-terminal"
|
||||
}
|
||||
]
|
||||
}
|
||||
26
.vscode/settings.json
vendored
Normal file
26
.vscode/settings.json
vendored
Normal file
@ -0,0 +1,26 @@
|
||||
{
|
||||
"json.schemas": [
|
||||
{
|
||||
"fileMatch": ["/npmextra.json"],
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"npmci": {
|
||||
"type": "object",
|
||||
"description": "settings for npmci"
|
||||
},
|
||||
"gitzone": {
|
||||
"type": "object",
|
||||
"description": "settings for gitzone",
|
||||
"properties": {
|
||||
"projectType": {
|
||||
"type": "string",
|
||||
"enum": ["website", "element", "service", "npm", "wcc"]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
@ -1,17 +1,37 @@
|
||||
{
|
||||
"gitzone": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "pushrocks",
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "smartexit",
|
||||
"shortDescription": "do things before one exists a process",
|
||||
"npmPackagename": "@pushrocks/smartexit",
|
||||
"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"
|
||||
}
|
||||
}
|
||||
1702
package-lock.json
generated
1702
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
71
package.json
71
package.json
@ -1,28 +1,65 @@
|
||||
{
|
||||
"name": "@pushrocks/smartexit",
|
||||
"version": "1.0.15",
|
||||
"name": "@push.rocks/smartexit",
|
||||
"version": "1.0.23",
|
||||
"private": false,
|
||||
"description": "do things before one exists a process",
|
||||
"main": "dist/index.js",
|
||||
"typings": "dist/index.d.ts",
|
||||
"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",
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
"test": "(tstest test/)",
|
||||
"build": "(tsbuild)",
|
||||
"format": "(gitzone format)"
|
||||
"build": "(tsbuild --web)",
|
||||
"buildDocs": "tsdoc"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@gitzone/tsbuild": "^2.0.22",
|
||||
"@gitzone/tstest": "^1.0.15",
|
||||
"@pushrocks/tapbundle": "^3.0.7",
|
||||
"@types/node": "^12.0.2",
|
||||
"tslint": "^5.11.0",
|
||||
"tslint-config-prettier": "^1.15.0"
|
||||
"@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"
|
||||
},
|
||||
"dependencies": {
|
||||
"@pushrocks/lik": "^3.0.5",
|
||||
"@pushrocks/smartdelay": "^2.0.3",
|
||||
"@pushrocks/smartlog-source-ora": "^1.0.7"
|
||||
"@push.rocks/lik": "^6.0.14",
|
||||
"@push.rocks/smartdelay": "^3.0.5",
|
||||
"@push.rocks/smartpromise": "^4.0.3",
|
||||
"tree-kill": "^1.2.2"
|
||||
},
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
],
|
||||
"files": [
|
||||
"ts/**/*",
|
||||
"ts_web/**/*",
|
||||
"dist/**/*",
|
||||
"dist_*/**/*",
|
||||
"dist_ts/**/*",
|
||||
"dist_ts_web/**/*",
|
||||
"assets/**/*",
|
||||
"cli.js",
|
||||
"npmextra.json",
|
||||
"readme.md"
|
||||
],
|
||||
"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"
|
||||
}
|
||||
}
|
||||
}
|
||||
5122
pnpm-lock.yaml
generated
Normal file
5122
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
1
readme.hints.md
Normal file
1
readme.hints.md
Normal file
@ -0,0 +1 @@
|
||||
|
||||
138
readme.md
138
readme.md
@ -1,26 +1,126 @@
|
||||
# @pushrocks/smartexit
|
||||
do things before one exists a process
|
||||
# @push.rocks/smartexit
|
||||
|
||||
## Availabililty and Links
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartexit)
|
||||
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartexit)
|
||||
* [github.com (source mirror)](https://github.com/pushrocks/smartexit)
|
||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartexit/)
|
||||
A library for performing cleanup operations before exiting a Node.js process, ensuring graceful shutdowns.
|
||||
|
||||
## Status for master
|
||||
[](https://gitlab.com/pushrocks/smartexit/commits/master)
|
||||
[](https://gitlab.com/pushrocks/smartexit/commits/master)
|
||||
[](https://www.npmjs.com/package/@pushrocks/smartexit)
|
||||
[](https://snyk.io/test/npm/@pushrocks/smartexit)
|
||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
[](https://prettier.io/)
|
||||
## Install
|
||||
|
||||
To install `@push.rocks/smartexit`, use npm or Yarn as follows:
|
||||
|
||||
```bash
|
||||
npm install @push.rocks/smartexit --save
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```bash
|
||||
yarn add @push.rocks/smartexit
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
For further information read the linked docs at the top of this readme.
|
||||
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.
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
||||
### Basic Setup
|
||||
|
||||
[](https://maintainedby.lossless.com)
|
||||
First, import `SmartExit` from the package:
|
||||
|
||||
```typescript
|
||||
import { SmartExit } from '@push.rocks/smartexit';
|
||||
```
|
||||
|
||||
Create an instance of `SmartExit`:
|
||||
|
||||
```typescript
|
||||
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.
|
||||
|
||||
```typescript
|
||||
smartExit.addCleanupFunction(async () => {
|
||||
console.log("Performing custom cleanup...");
|
||||
// Your cleanup operations here
|
||||
});
|
||||
```
|
||||
|
||||
### 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:
|
||||
|
||||
```typescript
|
||||
import { spawn } from 'child_process';
|
||||
|
||||
const childProcess = spawn('your_child_process');
|
||||
smartExit.addProcess(childProcess);
|
||||
```
|
||||
|
||||
If necessary, you can remove a previously added child process:
|
||||
|
||||
```typescript
|
||||
smartExit.removeProcess(childProcess);
|
||||
```
|
||||
|
||||
### Triggering Cleanup
|
||||
|
||||
`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:
|
||||
|
||||
```typescript
|
||||
await smartExit.killAll();
|
||||
process.exit(0); // or process.exit(1) to indicate an error state if needed
|
||||
```
|
||||
|
||||
### Advanced Usage
|
||||
|
||||
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
|
||||
|
||||
```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
|
||||
});
|
||||
```
|
||||
|
||||
#### Integrating with Express
|
||||
|
||||
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}`);
|
||||
});
|
||||
|
||||
smartExit.addCleanupFunction(async () => {
|
||||
console.log("Closing Express server...");
|
||||
await new Promise((resolve) => server.close(resolve));
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
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.
|
||||
|
||||
## 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.
|
||||
|
||||
**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.
|
||||
|
||||
### Company Information
|
||||
|
||||
Task Venture Capital GmbH
|
||||
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.
|
||||
|
||||
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,5 +1,5 @@
|
||||
import { expect, tap } from '@pushrocks/tapbundle';
|
||||
import * as smartexit from '../ts/index';
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
import * as smartexit from '../ts/index.js';
|
||||
|
||||
let testSmartexit: smartexit.SmartExit;
|
||||
|
||||
@ -7,7 +7,7 @@ tap.test('first test', async () => {
|
||||
testSmartexit = new smartexit.SmartExit();
|
||||
});
|
||||
|
||||
tap.test('should end processes upon SIGINT', async tools => {
|
||||
tap.test('should end processes upon SIGINT', async (tools) => {
|
||||
await tools.delayFor(5000);
|
||||
});
|
||||
|
||||
|
||||
8
ts/00_commitinfo_data.ts
Normal file
8
ts/00_commitinfo_data.ts
Normal file
@ -0,0 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @pushrocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/smartexit',
|
||||
version: '1.0.23',
|
||||
description: 'A library for managing graceful shutdowns of Node.js processes by handling cleanup operations, including terminating child processes.'
|
||||
}
|
||||
89
ts/index.ts
89
ts/index.ts
@ -1,9 +1,58 @@
|
||||
import * as plugins from './smartexit.plugins';
|
||||
import * as plugins from './smartexit.plugins.js';
|
||||
|
||||
import { ora } from './smartexit.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 processesToEnd = new plugins.lik.Objectmap<plugins.childProcess.ChildProcess>();
|
||||
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>>();
|
||||
|
||||
/**
|
||||
* adds a process to be exited
|
||||
@ -13,6 +62,10 @@ export class SmartExit {
|
||||
this.processesToEnd.add(childProcessArg);
|
||||
}
|
||||
|
||||
public addCleanupFunction(cleanupFunctionArg: () => Promise<any>) {
|
||||
this.cleanupFunctions.add(cleanupFunctionArg);
|
||||
}
|
||||
|
||||
/**
|
||||
* removes a process to be exited
|
||||
*/
|
||||
@ -21,13 +74,13 @@ export class SmartExit {
|
||||
}
|
||||
|
||||
public async killAll() {
|
||||
ora.text('Checking for remaining child processes before exit...');
|
||||
console.log('Checking for remaining child processes before exit...');
|
||||
if (this.processesToEnd.getArray().length > 0) {
|
||||
ora.text('found remaining child processes');
|
||||
console.log('found remaining child processes');
|
||||
let counter = 1;
|
||||
this.processesToEnd.forEach(async childProcessArg => {
|
||||
this.processesToEnd.forEach(async (childProcessArg) => {
|
||||
const pid = childProcessArg.pid;
|
||||
ora.text(`killing process #${counter} with pid ${pid}`);
|
||||
console.log(`killing process #${counter} with pid ${pid}`);
|
||||
plugins.smartdelay.delayFor(10000).then(() => {
|
||||
if (childProcessArg.killed) {
|
||||
return;
|
||||
@ -35,36 +88,42 @@ export class SmartExit {
|
||||
process.kill(pid, 'SIGKILL');
|
||||
});
|
||||
process.kill(pid, 'SIGINT');
|
||||
|
||||
|
||||
counter++;
|
||||
});
|
||||
} else {
|
||||
ora.text(`Everything looks clean. Ready to exit!`);
|
||||
console.log(`ChildProcesses look clean.`);
|
||||
}
|
||||
if (this.cleanupFunctions.getArray.length > 0) {
|
||||
this.cleanupFunctions.forEach(async (cleanupFunction) => {
|
||||
await cleanupFunction();
|
||||
});
|
||||
}
|
||||
console.log(`Ready to exit!`);
|
||||
}
|
||||
|
||||
constructor() {
|
||||
// do app specific cleaning before exiting
|
||||
process.on('exit', async (code) => {
|
||||
if (code === 0) {
|
||||
ora.text('Process wants to exit');
|
||||
console.log('Process wants to exit');
|
||||
await this.killAll();
|
||||
ora.finishSuccess('Exited ok!');
|
||||
console.log('Exited ok!');
|
||||
} else {
|
||||
ora.finishFail('Exited NOT OK!');
|
||||
console.error('Exited NOT OK!');
|
||||
}
|
||||
});
|
||||
|
||||
// catch ctrl+c event and exit normally
|
||||
process.on('SIGINT', async () => {
|
||||
ora.text('Ctrl-C... or SIGINT signal received!');
|
||||
console.log('Ctrl-C... or SIGINT signal received!');
|
||||
await this.killAll();
|
||||
process.exit(0);
|
||||
});
|
||||
|
||||
//catch uncaught exceptions, trace, then exit normally
|
||||
process.on('uncaughtException', async err => {
|
||||
ora.text('SMARTEXIT: uncaught exception...');
|
||||
process.on('uncaughtException', async (err) => {
|
||||
console.log('SMARTEXIT: uncaught exception...');
|
||||
console.log(err);
|
||||
await this.killAll();
|
||||
process.exit(1);
|
||||
|
||||
@ -1,3 +0,0 @@
|
||||
import * as plugins from './smartexit.plugins';
|
||||
|
||||
export const ora = new plugins.smartlogSourceOra.SmartlogSourceOra();
|
||||
@ -4,8 +4,15 @@ import * as childProcess from 'child_process';
|
||||
export { childProcess };
|
||||
|
||||
// pushrocks scope
|
||||
import * as lik from '@pushrocks/lik';
|
||||
import * as smartdelay from '@pushrocks/smartdelay';
|
||||
import * as smartlogSourceOra from '@pushrocks/smartlog-source-ora';
|
||||
import * as lik from '@push.rocks/lik';
|
||||
import * as smartdelay from '@push.rocks/smartdelay';
|
||||
import * as smartpromise from '@push.rocks/smartpromise';
|
||||
|
||||
export { lik, smartdelay, smartlogSourceOra};
|
||||
export { lik, smartdelay, smartpromise };
|
||||
|
||||
// third party scope
|
||||
import * as treeKill from 'tree-kill';
|
||||
|
||||
export {
|
||||
treeKill
|
||||
}
|
||||
|
||||
14
tsconfig.json
Normal file
14
tsconfig.json
Normal file
@ -0,0 +1,14 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"esModuleInterop": true,
|
||||
"verbatimModuleSyntax": true
|
||||
},
|
||||
"exclude": [
|
||||
"dist_*/**/*.d.ts"
|
||||
]
|
||||
}
|
||||
17
tslint.json
17
tslint.json
@ -1,17 +0,0 @@
|
||||
{
|
||||
"extends": ["tslint:latest", "tslint-config-prettier"],
|
||||
"rules": {
|
||||
"semicolon": [true, "always"],
|
||||
"no-console": false,
|
||||
"ordered-imports": false,
|
||||
"object-literal-sort-keys": false,
|
||||
"member-ordering": {
|
||||
"options":{
|
||||
"order": [
|
||||
"static-method"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"defaultSeverity": "warning"
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user