15 Commits

Author SHA1 Message Date
c1de38b771 1.0.21 2023-09-11 10:29:02 +02:00
1588c695ce fix(core): update 2023-09-11 10:29:01 +02:00
8192cb7bf9 switch to new org scheme 2023-07-10 02:49:01 +02:00
2031a408bf 1.0.20 2021-08-17 18:12:29 +02:00
a2b3cede4e fix(core): update 2021-08-17 18:12:28 +02:00
ac51ece229 1.0.19 2021-07-27 15:08:45 +02:00
49c4681b87 fix(core): update 2021-07-27 15:08:44 +02:00
9cae8d4818 1.0.18 2021-07-27 14:56:02 +02:00
ecc8b1c73a fix(core): update 2021-07-27 14:56:02 +02:00
cbc4b7b285 1.0.17 2021-07-27 13:55:48 +02:00
6210358568 fix(core): update 2021-07-27 13:55:47 +02:00
fe1c2754da 1.0.16 2021-07-27 13:42:14 +02:00
4cb41aa1d6 fix(core): update 2021-07-27 13:42:13 +02:00
466a03e27b 1.0.15 2019-05-28 10:34:57 +02:00
fe5e220087 fix(core): update 2019-05-28 10:34:57 +02:00
18 changed files with 5937 additions and 1908 deletions

View 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

View 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
View File

@ -15,8 +15,6 @@ node_modules/
# builds # builds
dist/ dist/
dist_web/ dist_*/
dist_serve/
dist_ts_web/
# custom # custom

View File

@ -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
View 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
View 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"]
}
}
}
}
}
}
]
}

View File

@ -1,11 +1,12 @@
{ {
"gitzone": { "gitzone": {
"projectType": "npm",
"module": { "module": {
"githost": "gitlab.com", "githost": "gitlab.com",
"gitscope": "pushrocks", "gitscope": "push.rocks",
"gitrepo": "smartexit", "gitrepo": "smartexit",
"shortDescription": "do things before one exists a process", "description": "do things before one exists a process",
"npmPackagename": "@pushrocks/smartexit", "npmPackagename": "@push.rocks/smartexit",
"license": "MIT", "license": "MIT",
"projectDomain": "push.rocks" "projectDomain": "push.rocks"
} }

1702
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,28 +1,42 @@
{ {
"name": "@pushrocks/smartexit", "name": "@push.rocks/smartexit",
"version": "1.0.14", "version": "1.0.21",
"private": false, "private": false,
"description": "do things before one exists a process", "description": "do things before one exists a process",
"main": "dist/index.js", "main": "dist_ts/index.js",
"typings": "dist/index.d.ts", "typings": "dist_ts/index.d.ts",
"author": "Lossless GmbH", "author": "Lossless GmbH",
"license": "MIT", "license": "MIT",
"scripts": { "scripts": {
"test": "(tstest test/)", "test": "(tstest test/)",
"build": "(tsbuild)", "build": "(tsbuild --web)",
"format": "(gitzone format)" "buildDocs": "tsdoc"
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.0.22", "@git.zone/tsbuild": "^2.1.70",
"@gitzone/tstest": "^1.0.15", "@git.zone/tstest": "^1.0.81",
"@pushrocks/tapbundle": "^3.0.7", "@gitzone/tsrun": "^1.2.44",
"@types/node": "^12.0.2", "@push.rocks/tapbundle": "^5.0.15",
"tslint": "^5.11.0", "@types/node": "^20.6.0"
"tslint-config-prettier": "^1.15.0"
}, },
"dependencies": { "dependencies": {
"@pushrocks/lik": "^3.0.5", "@push.rocks/lik": "^6.0.5",
"@pushrocks/smartdelay": "^2.0.3", "@push.rocks/smartdelay": "^3.0.5"
"@pushrocks/smartlog-source-ora": "^1.0.7" },
} "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"
} }

5591
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

View File

@ -1,26 +1,40 @@
# @pushrocks/smartexit # @push.rocks/smartexit
do things before one exists a process do things before one exists a process
## Availabililty and Links ## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartexit) * [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartexit)
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartexit) * [gitlab.com (source)](https://gitlab.com/push.rocks/smartexit)
* [github.com (source mirror)](https://github.com/pushrocks/smartexit) * [github.com (source mirror)](https://github.com/push.rocks/smartexit)
* [docs (typedoc)](https://pushrocks.gitlab.io/smartexit/) * [docs (typedoc)](https://push.rocks.gitlab.io/smartexit/)
## Status for master ## Status for master
[![build status](https://gitlab.com/pushrocks/smartexit/badges/master/build.svg)](https://gitlab.com/pushrocks/smartexit/commits/master)
[![coverage report](https://gitlab.com/pushrocks/smartexit/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartexit/commits/master) Status Category | Status Badge
[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartexit.svg)](https://www.npmjs.com/package/@pushrocks/smartexit) -- | --
[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartexit/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartexit) GitLab Pipelines | [![pipeline status](https://gitlab.com/push.rocks/smartexit/badges/master/pipeline.svg)](https://lossless.cloud)
[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/) GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/push.rocks/smartexit/badges/master/coverage.svg)](https://lossless.cloud)
[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/) npm | [![npm downloads per month](https://badgen.net/npm/dy/@push.rocks/smartexit)](https://lossless.cloud)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/) 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)
## Usage ## Usage
## Contribution
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). :)
## Contribution
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). :)
For further information read the linked docs at the top of this readme. For further information read the linked docs at the top of this readme.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) ## Legal
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html) > MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)

View File

@ -1,5 +1,5 @@
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, tap } from '@push.rocks/tapbundle';
import * as smartexit from '../ts/index'; import * as smartexit from '../ts/index.js';
let testSmartexit: smartexit.SmartExit; let testSmartexit: smartexit.SmartExit;
@ -7,7 +7,7 @@ tap.test('first test', async () => {
testSmartexit = new smartexit.SmartExit(); 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); await tools.delayFor(5000);
}); });

8
ts/00_commitinfo_data.ts Normal file
View File

@ -0,0 +1,8 @@
/**
* autocreated commitinfo by @pushrocks/commitinfo
*/
export const commitinfo = {
name: '@push.rocks/smartexit',
version: '1.0.21',
description: 'do things before one exists a process'
}

View File

@ -1,9 +1,8 @@
import * as plugins from './smartexit.plugins'; import * as plugins from './smartexit.plugins.js';
import { ora } from './smartexit.logging';
export class SmartExit { export class SmartExit {
public processesToEnd = new plugins.lik.Objectmap<plugins.childProcess.ChildProcess>(); public processesToEnd = new plugins.lik.ObjectMap<plugins.childProcess.ChildProcess>();
public cleanupFunctions = new plugins.lik.ObjectMap<() => Promise<any>>();
/** /**
* adds a process to be exited * adds a process to be exited
@ -13,6 +12,10 @@ export class SmartExit {
this.processesToEnd.add(childProcessArg); this.processesToEnd.add(childProcessArg);
} }
public addCleanupFunction(cleanupFunctionArg: () => Promise<any>) {
this.cleanupFunctions.add(cleanupFunctionArg);
}
/** /**
* removes a process to be exited * removes a process to be exited
*/ */
@ -21,13 +24,13 @@ export class SmartExit {
} }
public async killAll() { 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) { if (this.processesToEnd.getArray().length > 0) {
ora.text('found remaining child processes'); console.log('found remaining child processes');
let counter = 1; let counter = 1;
this.processesToEnd.forEach(async childProcessArg => { this.processesToEnd.forEach(async (childProcessArg) => {
const pid = childProcessArg.pid; 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(() => { plugins.smartdelay.delayFor(10000).then(() => {
if (childProcessArg.killed) { if (childProcessArg.killed) {
return; return;
@ -39,31 +42,38 @@ export class SmartExit {
counter++; counter++;
}); });
} else { } 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() { constructor() {
// do app specific cleaning before exiting // do app specific cleaning before exiting
process.on('exit', async (code) => { process.on('exit', async (code) => {
if (code === 0) { if (code === 0) {
ora.text('Process wants to exit'); console.log('Process wants to exit');
await this.killAll(); await this.killAll();
ora.finishSuccess('Exited ok!'); console.log('Exited ok!');
} else { } else {
ora.finishFail('Exited NOT OK!'); console.error('Exited NOT OK!');
} }
}); });
// catch ctrl+c event and exit normally // catch ctrl+c event and exit normally
process.on('SIGINT', async () => { process.on('SIGINT', async () => {
ora.text('Ctrl-C... or SIGINT signal received!'); console.log('Ctrl-C... or SIGINT signal received!');
await this.killAll(); await this.killAll();
process.exit(0);
}); });
//catch uncaught exceptions, trace, then exit normally //catch uncaught exceptions, trace, then exit normally
process.on('uncaughtException', async err => { process.on('uncaughtException', async (err) => {
ora.text('SMARTEXIT: uncaught exception...'); console.log('SMARTEXIT: uncaught exception...');
console.log(err); console.log(err);
await this.killAll(); await this.killAll();
process.exit(1); process.exit(1);

View File

@ -1,3 +0,0 @@
import * as plugins from './smartexit.plugins';
export const ora = new plugins.smartlogSourceOra.SmartlogSourceOra();

View File

@ -4,8 +4,7 @@ import * as childProcess from 'child_process';
export { childProcess }; export { childProcess };
// pushrocks scope // pushrocks scope
import * as lik from '@pushrocks/lik'; import * as lik from '@push.rocks/lik';
import * as smartdelay from '@pushrocks/smartdelay'; import * as smartdelay from '@push.rocks/smartdelay';
import * as smartlogSourceOra from '@pushrocks/smartlog-source-ora';
export { lik, smartdelay, smartlogSourceOra}; export { lik, smartdelay };

14
tsconfig.json Normal file
View File

@ -0,0 +1,14 @@
{
"compilerOptions": {
"experimentalDecorators": true,
"useDefineForClassFields": false,
"target": "ES2022",
"module": "ES2022",
"moduleResolution": "nodenext",
"esModuleInterop": true,
"verbatimModuleSyntax": true
},
"exclude": [
"dist_*/**/*.d.ts"
]
}

View File

@ -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"
}