Compare commits
No commits in common. "master" and "v1.0.7" have entirely different histories.
@ -1,66 +0,0 @@
|
||||
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
|
||||
@ -1,124 +0,0 @@
|
||||
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,6 +15,8 @@ node_modules/
|
||||
|
||||
# builds
|
||||
dist/
|
||||
dist_*/
|
||||
dist_web/
|
||||
dist_serve/
|
||||
dist_ts_web/
|
||||
|
||||
# custom
|
||||
105
.gitlab-ci.yml
Normal file
105
.gitlab-ci.yml
Normal file
@ -0,0 +1,105 @@
|
||||
# gitzone ci_default
|
||||
image: registry.gitlab.com/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
|
||||
|
||||
release:
|
||||
stage: release
|
||||
script:
|
||||
- npmci node install lts
|
||||
- npmci npm publish
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
# ====================
|
||||
# metadata stage
|
||||
# ====================
|
||||
codequality:
|
||||
stage: metadata
|
||||
allow_failure: true
|
||||
script:
|
||||
- npmci command npm install -g tslint typescript
|
||||
- npmci npm install
|
||||
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
||||
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
|
||||
24
.vscode/launch.json
vendored
24
.vscode/launch.json
vendored
@ -2,10 +2,28 @@
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"command": "npm test",
|
||||
"name": "Run npm test",
|
||||
"name": "current file",
|
||||
"type": "node",
|
||||
"request": "launch",
|
||||
"type": "node-terminal"
|
||||
"args": [
|
||||
"${relativeFile}"
|
||||
],
|
||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||
"cwd": "${workspaceRoot}",
|
||||
"protocol": "inspector",
|
||||
"internalConsoleOptions": "openOnSessionStart"
|
||||
},
|
||||
{
|
||||
"name": "test.ts",
|
||||
"type": "node",
|
||||
"request": "launch",
|
||||
"args": [
|
||||
"test/test.ts"
|
||||
],
|
||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||
"cwd": "${workspaceRoot}",
|
||||
"protocol": "inspector",
|
||||
"internalConsoleOptions": "openOnSessionStart"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
26
.vscode/settings.json
vendored
26
.vscode/settings.json
vendored
@ -1,26 +0,0 @@
|
||||
{
|
||||
"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"]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
31
changelog.md
31
changelog.md
@ -1,31 +0,0 @@
|
||||
# Changelog
|
||||
|
||||
## 2025-03-03 - 2.0.8 - fix(core)
|
||||
Update project dependencies and resolve minor issues in file paths
|
||||
|
||||
- Updated devDependencies and dependencies to latest versions
|
||||
- Resolved minor issues in file paths within systemd manager
|
||||
|
||||
## 2025-03-03 - 2.0.7 - fix(core)
|
||||
Update @types/node to fix compatibility issues.
|
||||
|
||||
- Updated @types/node from version 20.12.7 to 22.13.8 to ensure compatibility with the latest Node.js features.
|
||||
- Improved type definitions which might resolve minor type errors in development.
|
||||
|
||||
## 2024-05-29 - 2.0.6 - Documentation
|
||||
updated project description
|
||||
|
||||
## 2024-04-19 - 2.0.5 to 2.0.4 - Core Updates
|
||||
Improved core functionality across multiple versions.
|
||||
|
||||
- Updated tsconfig for better build performance.
|
||||
- Revised npmextra.json to update githost configuration.
|
||||
|
||||
## 2023-07-25 - 2.0.3 - Organizational Changes
|
||||
implemented a new organizational scheme
|
||||
|
||||
## 2022-10-19 - 2.0.0 - Core Updates and Breaking Changes
|
||||
Major overhaul with breaking changes and core updates.
|
||||
|
||||
- **Breaking Change:** Transitioned the project architecture from CommonJS to ECMAScript modules (ESM) to enhance compatibility and future-proofing.
|
||||
|
||||
@ -1,30 +1,17 @@
|
||||
{
|
||||
"gitzone": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "push.rocks",
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "pushrocks",
|
||||
"gitrepo": "smartdaemon",
|
||||
"description": "Start scripts as long running daemons and manage them.",
|
||||
"npmPackagename": "@push.rocks/smartdaemon",
|
||||
"shortDescription": "start scripts as long running daemons and manage them",
|
||||
"npmPackagename": "@pushrocks/smartdaemon",
|
||||
"license": "MIT",
|
||||
"projectDomain": "push.rocks",
|
||||
"keywords": [
|
||||
"daemon",
|
||||
"service management",
|
||||
"Linux systemd",
|
||||
"process management",
|
||||
"Node.js",
|
||||
"system administration",
|
||||
"background services"
|
||||
]
|
||||
"projectDomain": "push.rocks"
|
||||
}
|
||||
},
|
||||
"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"
|
||||
}
|
||||
}
|
||||
1653
package-lock.json
generated
Normal file
1653
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
73
package.json
73
package.json
@ -1,62 +1,41 @@
|
||||
{
|
||||
"name": "@push.rocks/smartdaemon",
|
||||
"version": "2.0.8",
|
||||
"name": "@pushrocks/smartdaemon",
|
||||
"version": "1.0.7",
|
||||
"private": false,
|
||||
"description": "Start scripts as long running daemons and manage them.",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"description": "start scripts as long running daemons and manage them",
|
||||
"main": "dist/index.js",
|
||||
"typings": "dist/index.d.ts",
|
||||
"author": "Lossless GmbH",
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
"test": "(tstest test/ --web)",
|
||||
"build": "(tsbuild --web --allowimplicitany)",
|
||||
"buildDocs": "tsdoc"
|
||||
"test": "(tstest test/)",
|
||||
"build": "(tsbuild)",
|
||||
"format": "(gitzone format)"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@git.zone/tsbuild": "^2.1.66",
|
||||
"@git.zone/tsrun": "^1.2.44",
|
||||
"@git.zone/tstest": "^1.0.77",
|
||||
"@push.rocks/tapbundle": "^5.0.23",
|
||||
"@types/node": "^22.13.8"
|
||||
"@gitzone/tsbuild": "^2.1.17",
|
||||
"@gitzone/tstest": "^1.0.15",
|
||||
"@pushrocks/tapbundle": "^3.0.13",
|
||||
"@types/node": "^10.11.7",
|
||||
"tslint": "^5.11.0",
|
||||
"tslint-config-prettier": "^1.15.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"@push.rocks/lik": "^6.0.15",
|
||||
"@push.rocks/smartfile": "^11.0.14",
|
||||
"@push.rocks/smartfm": "^2.0.4",
|
||||
"@push.rocks/smartlog": "^3.0.3",
|
||||
"@push.rocks/smartlog-destination-local": "^9.0.1",
|
||||
"@push.rocks/smartpath": "^5.0.14",
|
||||
"@push.rocks/smartshell": "^3.0.5",
|
||||
"@push.rocks/smartsystem": "^3.0.1"
|
||||
"@pushrocks/lik": "^3.0.11",
|
||||
"@pushrocks/smartfile": "^7.0.4",
|
||||
"@pushrocks/smartlog": "^2.0.19",
|
||||
"@pushrocks/smartlog-destination-local": "^8.0.2",
|
||||
"@pushrocks/smartshell": "^2.0.25",
|
||||
"@pushrocks/smartsystem": "^2.0.8"
|
||||
},
|
||||
"files": [
|
||||
"ts/**/*",
|
||||
"ts_web/**/*",
|
||||
"dist/**/*",
|
||||
"dist_*/**/*",
|
||||
"dist_ts/**/*",
|
||||
"dist_ts_web/**/*",
|
||||
"assets/**/*",
|
||||
"ts/*",
|
||||
"ts_web/*",
|
||||
"dist/*",
|
||||
"dist_web/*",
|
||||
"assets/*",
|
||||
"cli.js",
|
||||
"npmextra.json",
|
||||
"readme.md"
|
||||
],
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
],
|
||||
"type": "module",
|
||||
"keywords": [
|
||||
"daemon",
|
||||
"service management",
|
||||
"Linux systemd",
|
||||
"process management",
|
||||
"Node.js",
|
||||
"system administration",
|
||||
"background services"
|
||||
],
|
||||
"homepage": "https://code.foss.global/push.rocks/smartdaemon",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://code.foss.global/push.rocks/smartdaemon.git"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
9999
pnpm-lock.yaml
generated
9999
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@ -1 +0,0 @@
|
||||
|
||||
122
readme.md
122
readme.md
@ -1,112 +1,26 @@
|
||||
# @push.rocks/smartdaemon
|
||||
# @pushrocks/smartdaemon
|
||||
start scripts as long running daemons and manage them
|
||||
|
||||
## Install
|
||||
To install `@push.rocks/smartdaemon`, run the following command in your terminal:
|
||||
## Availabililty and Links
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartdaemon)
|
||||
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartdaemon)
|
||||
* [github.com (source mirror)](https://github.com/pushrocks/smartdaemon)
|
||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartdaemon/)
|
||||
|
||||
```bash
|
||||
npm install @push.rocks/smartdaemon --save
|
||||
```
|
||||
This will add `@push.rocks/smartdaemon` to your project's dependencies.
|
||||
## Status for master
|
||||
[](https://gitlab.com/pushrocks/smartdaemon/commits/master)
|
||||
[](https://gitlab.com/pushrocks/smartdaemon/commits/master)
|
||||
[](https://www.npmjs.com/package/@pushrocks/smartdaemon)
|
||||
[](https://snyk.io/test/npm/@pushrocks/smartdaemon)
|
||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
[](https://prettier.io/)
|
||||
|
||||
## Usage
|
||||
|
||||
`@push.rocks/smartdaemon` is a powerful module designed to help you manage long-running daemons for your applications. Whether you're running background services, scheduled tasks, or any other continuous or long-term operations in a Node.js environment, `smartdaemon` provides an intuitive and flexible API to control these processes.
|
||||
For further information read the linked docs at the top of this readme.
|
||||
|
||||
### Getting Started
|
||||
First, ensure you import `SmartDaemon` from the package in your TypeScript files:
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
||||
|
||||
```typescript
|
||||
import { SmartDaemon } from '@push.rocks/smartdaemon';
|
||||
```
|
||||
|
||||
### Initialize SmartDaemon
|
||||
Create an instance of `SmartDaemon`. This instance will be the central point for managing your services.
|
||||
|
||||
```typescript
|
||||
const myDaemon = new SmartDaemon();
|
||||
```
|
||||
|
||||
### Adding a Service
|
||||
To manage a daemon, you first need to define it as a service. A service in `smartdaemon` is essentially a description of the daemon process you want to manage — including how it should be started, where it should run, and other operational metadata.
|
||||
|
||||
Here's an example of adding a simple service that executes a shell command:
|
||||
|
||||
```typescript
|
||||
async function addSampleService() {
|
||||
const myService = await myDaemon.addService({
|
||||
name: 'mySampleService',
|
||||
description: 'A sample service running a long-lived process',
|
||||
command: 'node path/to/your/script.js',
|
||||
workingDir: '/absolute/path/to/working/directory',
|
||||
version: '1.0.0'
|
||||
});
|
||||
|
||||
await myService.enable();
|
||||
}
|
||||
addSampleService();
|
||||
```
|
||||
|
||||
In this example:
|
||||
- `name`: Unique identifier for the service.
|
||||
- `description`: A brief explanation of the service.
|
||||
- `command`: The command that starts your daemon (e.g., node application, shell script).
|
||||
- `workingDir`: The working directory from which the command will be executed.
|
||||
- `version`: The version of your service. This can be used for your own versioning and tracking.
|
||||
|
||||
### Starting and Stopping Services
|
||||
After adding and enabling a service, you can control it using the start and stop methods.
|
||||
|
||||
```typescript
|
||||
async function controlService() {
|
||||
const myServiceName = 'mySampleService'; // The name of the service you added before
|
||||
const myService = await myDaemon.getService(myServiceName);
|
||||
|
||||
// To start the service
|
||||
await myService.start();
|
||||
|
||||
// To stop the service
|
||||
await myService.stop();
|
||||
}
|
||||
controlService();
|
||||
```
|
||||
|
||||
### Advanced Management
|
||||
`smartdaemon` also provides advanced functionalities to manage your daemons effectively, including:
|
||||
- Checking the status of your services
|
||||
- Automatically restarting services on failure
|
||||
- Configuring environment variables or execution parameters
|
||||
|
||||
### Working with Systemd
|
||||
If you're operating on a Linux environment, `smartdaemon` can generate and control services using `systemd`. This integration allows for robust management capabilities, utilizing system-level features for daemon management.
|
||||
|
||||
```typescript
|
||||
// Example: Creating a systemd service
|
||||
await myDaemon.systemdManager.saveService(myService);
|
||||
```
|
||||
|
||||
### Conclusion
|
||||
`@push.rocks/smartdaemon` streamlines the management of long-running daemons and background services in Node.js applications. By leveraging its comprehensive API, developers can efficiently control the lifecycle of their services, ensuring their applications run smoothly and reliably.
|
||||
|
||||
This module opens up possibilities for more structured and system-integrated application architectures, especially in environments where long-running tasks are essential.
|
||||
|
||||
**Note**: Ensure to check permissions and system compatibility, especially when integrating with system-level service managers like `systemd`.
|
||||
|
||||
## 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.
|
||||
[](https://maintainedby.lossless.com)
|
||||
|
||||
@ -1,3 +0,0 @@
|
||||
import * as smartpath from '@push.rocks/smartpath';
|
||||
|
||||
export { smartpath };
|
||||
21
test/test.ts
21
test/test.ts
@ -1,24 +1,11 @@
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
|
||||
import * as plugins from './plugins.js';
|
||||
|
||||
import * as smartdaemon from '../ts/index.js';
|
||||
import { expect, tap } from '@pushrocks/tapbundle';
|
||||
import * as smartdaemon from '../ts/index';
|
||||
|
||||
let testSmartdaemon: smartdaemon.SmartDaemon;
|
||||
|
||||
tap.test('should create an instance of smartdaemon', async () => {
|
||||
testSmartdaemon = new smartdaemon.SmartDaemon();
|
||||
expect(testSmartdaemon).toBeInstanceOf(smartdaemon.SmartDaemon);
|
||||
expect(testSmartdaemon).to.be.instanceOf(smartdaemon.SmartDaemon);
|
||||
});
|
||||
|
||||
tap.test('should create a service', async () => {
|
||||
testSmartdaemon.addService({
|
||||
name: 'npmversion',
|
||||
version: 'x.x.x',
|
||||
command: 'npm -v',
|
||||
description: 'displays the npm version',
|
||||
workingDir: plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url),
|
||||
});
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
tap.start();
|
||||
|
||||
@ -1,8 +0,0 @@
|
||||
/**
|
||||
* autocreated commitinfo by @push.rocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/smartdaemon',
|
||||
version: '2.0.8',
|
||||
description: 'Start scripts as long running daemons and manage them.'
|
||||
}
|
||||
@ -1 +1 @@
|
||||
export * from './smartdaemon.classes.smartdaemon.js';
|
||||
export * from './smartdaemon.classes.smartdaemon';
|
||||
|
||||
@ -1,38 +1,30 @@
|
||||
import * as plugins from './smartdaemon.plugins.js';
|
||||
import * as paths from './smartdaemon.paths.js';
|
||||
import { SmartDaemon } from './smartdaemon.classes.smartdaemon.js';
|
||||
import * as plugins from './smartdaemon.plugins';
|
||||
import * as paths from './smartdaemon.paths';
|
||||
import { SmartDaemon } from './smartdaemon.classes.smartdaemon';
|
||||
|
||||
export interface ISmartDaemonServiceConstructorOptions {
|
||||
export interface SmartDaemonServiceConstructorOptions {
|
||||
name: string;
|
||||
description: string;
|
||||
command: string;
|
||||
workingDir: string;
|
||||
version: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* represents a service that is being spawned by SmartDaemon
|
||||
*/
|
||||
export class SmartDaemonService implements ISmartDaemonServiceConstructorOptions {
|
||||
public static async createFromOptions(
|
||||
smartdaemonRef: SmartDaemon,
|
||||
optionsArg: ISmartDaemonServiceConstructorOptions
|
||||
) {
|
||||
export class SmartDaemonService implements SmartDaemonServiceConstructorOptions {
|
||||
public static async createFromOptions(smartdaemonRef: SmartDaemon, optionsArg: SmartDaemonServiceConstructorOptions) {
|
||||
const service = new SmartDaemonService(smartdaemonRef);
|
||||
for (const key of Object.keys(optionsArg)) {
|
||||
service[key] = optionsArg[key];
|
||||
}
|
||||
return service;
|
||||
|
||||
}
|
||||
|
||||
public options: ISmartDaemonServiceConstructorOptions;
|
||||
public alreadyExists = false;
|
||||
public options: SmartDaemonServiceConstructorOptions;
|
||||
|
||||
public name: string;
|
||||
public version: string;
|
||||
public command: string;
|
||||
public workingDir: string;
|
||||
public description: string;
|
||||
|
||||
public smartdaemonRef: SmartDaemon;
|
||||
|
||||
@ -44,43 +36,18 @@ export class SmartDaemonService implements ISmartDaemonServiceConstructorOptions
|
||||
* enables the service
|
||||
*/
|
||||
public async enable() {
|
||||
await this.smartdaemonRef.systemdManager.enableService(this);
|
||||
this.smartdaemonRef
|
||||
}
|
||||
|
||||
/**
|
||||
* disables the service
|
||||
*/
|
||||
public async disable() {
|
||||
await this.smartdaemonRef.systemdManager.disableService(this);
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* starts a service
|
||||
* pauses the service
|
||||
*/
|
||||
public async start() {
|
||||
await this.smartdaemonRef.systemdManager.startService(this);
|
||||
}
|
||||
|
||||
/**
|
||||
* stops a service
|
||||
*/
|
||||
public async stop() {
|
||||
await this.smartdaemonRef.systemdManager.stopService(this);
|
||||
}
|
||||
|
||||
// Save and Delete
|
||||
public async save() {
|
||||
await this.smartdaemonRef.systemdManager.saveService(this);
|
||||
}
|
||||
|
||||
/**
|
||||
* deletes the service
|
||||
*/
|
||||
public async delete() {
|
||||
await this.smartdaemonRef.systemdManager.deleteService(this);
|
||||
}
|
||||
|
||||
public async reload() {
|
||||
await this.smartdaemonRef.systemdManager.reload();
|
||||
}
|
||||
public pause() {};
|
||||
}
|
||||
|
||||
@ -1,41 +1,36 @@
|
||||
import * as plugins from './smartdaemon.plugins.js';
|
||||
import { SmartDaemonTemplateManager } from './smartdaemon.classes.templatemanager.js';
|
||||
import {
|
||||
type ISmartDaemonServiceConstructorOptions,
|
||||
SmartDaemonService,
|
||||
} from './smartdaemon.classes.service.js';
|
||||
import { SmartDaemonSystemdManager } from './smartdaemon.classes.systemdmanager.js';
|
||||
import * as plugins from './smartdaemon.plugins';
|
||||
import { SmartDaemonTemplateManager } from './smartdaemon.classes.templatemanager';
|
||||
import { SmartDaemonService } from './smartdaemon.classes.service';
|
||||
import { SmartDaemonSystemdManager } from './smartdaemon.classes.systemdmanager';
|
||||
|
||||
|
||||
|
||||
export class SmartDaemon {
|
||||
|
||||
public serviceMap: plugins.lik.Objectmap<SmartDaemonService>;
|
||||
public templateManager: SmartDaemonTemplateManager;
|
||||
public systemdManager: SmartDaemonSystemdManager;
|
||||
|
||||
constructor() {
|
||||
this.serviceMap = new plugins.lik.Objectmap<SmartDaemonService>();
|
||||
this.templateManager = new SmartDaemonTemplateManager(this);
|
||||
this.systemdManager = new SmartDaemonSystemdManager(this);
|
||||
}
|
||||
|
||||
/**
|
||||
* adds a service
|
||||
* @param nameArg
|
||||
* @param commandArg
|
||||
* @param workingDirectoryArg
|
||||
*/
|
||||
public async addService(
|
||||
optionsArg: ISmartDaemonServiceConstructorOptions
|
||||
): Promise<SmartDaemonService> {
|
||||
public async addService(serviceNameArg: string, commandArg: string, workingDirectory?: string): Promise<SmartDaemonService> {
|
||||
let serviceToAdd: SmartDaemonService;
|
||||
const existingServices = await this.systemdManager.getServices();
|
||||
const existingService = existingServices.find((serviceArg) => {
|
||||
return serviceArg.name === optionsArg.name;
|
||||
const existingService = this.serviceMap.find(serviceArg => {
|
||||
return serviceArg.name === serviceNameArg;
|
||||
});
|
||||
if (!existingService) {
|
||||
serviceToAdd = await SmartDaemonService.createFromOptions(this, optionsArg);
|
||||
|
||||
} else {
|
||||
serviceToAdd = existingService;
|
||||
Object.assign(serviceToAdd, optionsArg);
|
||||
|
||||
}
|
||||
await serviceToAdd.save();
|
||||
return serviceToAdd;
|
||||
};
|
||||
|
||||
public async init() {
|
||||
await this.systemdManager.init();
|
||||
}
|
||||
}
|
||||
|
||||
@ -1,31 +1,9 @@
|
||||
import * as plugins from './smartdaemon.plugins.js';
|
||||
import * as paths from './smartdaemon.paths.js';
|
||||
import { SmartDaemon } from './smartdaemon.classes.smartdaemon.js';
|
||||
import {
|
||||
type ISmartDaemonServiceConstructorOptions,
|
||||
SmartDaemonService,
|
||||
} from './smartdaemon.classes.service.js';
|
||||
import * as plugins from './smartdaemon.plugins';
|
||||
import * as paths from './smartdaemon.paths';
|
||||
import { SmartDaemon } from './smartdaemon.classes.smartdaemon';
|
||||
|
||||
export class SmartDaemonSystemdManager {
|
||||
// STATIC
|
||||
private static smartDaemonNamespace = 'smartdaemon';
|
||||
|
||||
public static createServiceNameFromServiceName(serviceNameArg: string) {
|
||||
return `${SmartDaemonSystemdManager.smartDaemonNamespace}_${serviceNameArg}`;
|
||||
}
|
||||
|
||||
public static createFileNameFromServiceName(serviceNameArg: string) {
|
||||
return `${SmartDaemonSystemdManager.createServiceNameFromServiceName(serviceNameArg)}.service`;
|
||||
}
|
||||
|
||||
public static createFilePathFromServiceName(serviceNameArg: string) {
|
||||
return plugins.path.join(
|
||||
paths.systemdDir,
|
||||
SmartDaemonSystemdManager.createFileNameFromServiceName(serviceNameArg)
|
||||
);
|
||||
}
|
||||
|
||||
// INSTANCE
|
||||
private smartDaemonNamespace = 'smartdaemon_';
|
||||
public smartdaemonRef: SmartDaemon;
|
||||
public smartshellInstance: plugins.smartshell.Smartshell;
|
||||
public smartsystem: plugins.smartsystem.Smartsystem;
|
||||
@ -35,7 +13,7 @@ export class SmartDaemonSystemdManager {
|
||||
constructor(smartdaemonRefArg: SmartDaemon) {
|
||||
this.smartdaemonRef = smartdaemonRefArg;
|
||||
this.smartshellInstance = new plugins.smartshell.Smartshell({
|
||||
executor: 'bash',
|
||||
executor: 'bash'
|
||||
});
|
||||
this.smartsystem = new plugins.smartsystem.Smartsystem();
|
||||
}
|
||||
@ -44,104 +22,22 @@ export class SmartDaemonSystemdManager {
|
||||
if (await this.smartsystem.env.isLinuxAsync()) {
|
||||
this.shouldExecute = true;
|
||||
} else {
|
||||
console.log('Smartdaemon can only be used on Linux systems! Refusing to set up a service.');
|
||||
console.log('Smartdaemon can only be used on Linuc systems! Refusing to set up a service.');
|
||||
this.shouldExecute = false;
|
||||
}
|
||||
return this.shouldExecute;
|
||||
}
|
||||
|
||||
public async execute(commandArg: string) {
|
||||
if (await this.checkElegibility()) {
|
||||
await this.smartshellInstance.exec(commandArg);
|
||||
}
|
||||
(await this.checkElegibility()) ? await this.smartshellInstance.exec(commandArg) : null;
|
||||
}
|
||||
|
||||
/**
|
||||
* gets all services that are already present
|
||||
*/
|
||||
public async getServices () {
|
||||
const existingServices: SmartDaemonService[] = [];
|
||||
if (await this.checkElegibility()) {
|
||||
const smartfmInstance = new plugins.smartfm.Smartfm({
|
||||
fmType: 'yaml',
|
||||
});
|
||||
const availableServices = await plugins.smartfile.fs.fileTreeToObject(
|
||||
paths.systemdDir,
|
||||
'smartdaemon_*.service'
|
||||
);
|
||||
for (const serviceFile of availableServices) {
|
||||
const data = smartfmInstance.parseFromComments('# ', serviceFile.contentBuffer.toString())
|
||||
.data as ISmartDaemonServiceConstructorOptions;
|
||||
const service = await SmartDaemonService.createFromOptions(this.smartdaemonRef, data);
|
||||
service.alreadyExists = true;
|
||||
existingServices.push(service);
|
||||
}
|
||||
}
|
||||
return existingServices;
|
||||
const availableServices = plugins.smartfile.fs.listAllItems(paths.systemdDir, new RegExp(`${this.smartDaemonNamespace}`));
|
||||
}
|
||||
|
||||
public async startService(serviceArg: SmartDaemonService) {
|
||||
if (await this.checkElegibility()) {
|
||||
await this.execute(
|
||||
`systemctl start ${SmartDaemonSystemdManager.createServiceNameFromServiceName(
|
||||
serviceArg.name
|
||||
)}`
|
||||
);
|
||||
}
|
||||
}
|
||||
public async stopService(serviceArg: SmartDaemonService) {
|
||||
if (await this.checkElegibility()) {
|
||||
await this.execute(
|
||||
`systemctl stop ${SmartDaemonSystemdManager.createServiceNameFromServiceName(
|
||||
serviceArg.name
|
||||
)}`
|
||||
);
|
||||
}
|
||||
}
|
||||
public async init() {
|
||||
|
||||
public async saveService(serviceArg: SmartDaemonService) {
|
||||
if (await this.checkElegibility()) {
|
||||
await plugins.smartfile.memory.toFs(
|
||||
this.smartdaemonRef.templateManager.generateUnitFileForService(serviceArg),
|
||||
SmartDaemonSystemdManager.createFilePathFromServiceName(serviceArg.name)
|
||||
);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
public async deleteService(serviceArg: SmartDaemonService) {
|
||||
if (await this.checkElegibility()) {
|
||||
await plugins.smartfile.fs.remove(
|
||||
SmartDaemonSystemdManager.createServiceNameFromServiceName(serviceArg.name)
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
public async enableService(serviceArg: SmartDaemonService) {
|
||||
if (await this.checkElegibility()) {
|
||||
await this.saveService(serviceArg);
|
||||
if (serviceArg.alreadyExists) {
|
||||
await this.execute(`systemctl daemon-reload`);
|
||||
}
|
||||
await this.execute(
|
||||
`systemctl enable ${SmartDaemonSystemdManager.createServiceNameFromServiceName(
|
||||
serviceArg.name
|
||||
)}`
|
||||
);
|
||||
}
|
||||
}
|
||||
public async disableService(serviceArg: SmartDaemonService) {
|
||||
if (await this.checkElegibility()) {
|
||||
await this.execute(
|
||||
`systemctl disable ${SmartDaemonSystemdManager.createServiceNameFromServiceName(
|
||||
serviceArg.name
|
||||
)}`
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
public async reload() {
|
||||
if (await this.checkElegibility()) {
|
||||
await this.execute(`systemctl daemon-reload`);
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -1,6 +1,5 @@
|
||||
import * as plugins from './smartdaemon.plugins.js';
|
||||
import { SmartDaemon } from './smartdaemon.classes.smartdaemon.js';
|
||||
import { SmartDaemonService } from './smartdaemon.classes.service.js';
|
||||
import * as plugins from './smartdaemon.plugins';
|
||||
import { SmartDaemon } from './smartdaemon.classes.smartdaemon';
|
||||
|
||||
export class SmartDaemonTemplateManager {
|
||||
public smartdaemonRef: SmartDaemon;
|
||||
@ -9,24 +8,25 @@ export class SmartDaemonTemplateManager {
|
||||
this.smartdaemonRef = smartdaemonRefArg;
|
||||
}
|
||||
|
||||
public generateUnitFileForService = (serviceArg: SmartDaemonService) => {
|
||||
return `# ---
|
||||
# name: ${serviceArg.name}
|
||||
# version: ${serviceArg.version}
|
||||
# description: ${serviceArg.description}
|
||||
# command: ${serviceArg.command}
|
||||
# workingDir: ${serviceArg.workingDir}
|
||||
# ---
|
||||
public generateServiceTemplate = (optionsArg: {
|
||||
serviceName: string;
|
||||
description: string;
|
||||
serviceVersion: string;
|
||||
command: string;
|
||||
pathWorkkingDir;
|
||||
pathJsFileToRun;
|
||||
}) => {
|
||||
return `
|
||||
# servicVersion: ${optionsArg.serviceVersion}
|
||||
[Unit]
|
||||
Description=${serviceArg.description}
|
||||
Description=${optionsArg.description}
|
||||
Requires=network.target
|
||||
After=network.target
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
Environment=NODE_OPTIONS="--max_old_space_size=100"
|
||||
ExecStart=/bin/bash -c "cd ${serviceArg.workingDir} && ${serviceArg.command}"
|
||||
WorkingDirectory=${serviceArg.workingDir}
|
||||
ExecStart=/bin/bash -c "cd ${optionsArg.pathWorkkingDir} && ${optionsArg.command}"
|
||||
WorkingDirectory=${optionsArg.pathWorkkingDir}
|
||||
Restart=on-failure
|
||||
LimitNOFILE=infinity
|
||||
LimitCORE=infinity
|
||||
@ -37,5 +37,5 @@ Restart=always
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
`;
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
@ -1,7 +1,4 @@
|
||||
import * as plugins from './smartdaemon.plugins.js';
|
||||
import * as plugins from './smartdaemon.plugins';
|
||||
|
||||
export const packageDir = plugins.path.join(
|
||||
plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url),
|
||||
'../'
|
||||
);
|
||||
export const packageDir = plugins.path.join(__dirname, '../');
|
||||
export const systemdDir = plugins.path.join('/lib/systemd/system/');
|
||||
|
||||
@ -1,27 +1,26 @@
|
||||
// node native scope
|
||||
import * as path from 'path';
|
||||
|
||||
export { path };
|
||||
|
||||
export {
|
||||
path
|
||||
};
|
||||
|
||||
// @pushrocks scope
|
||||
import * as lik from '@push.rocks/lik';
|
||||
import * as smartfile from '@push.rocks/smartfile';
|
||||
import * as smartfm from '@push.rocks/smartfm';
|
||||
import * as smartlog from '@push.rocks/smartlog';
|
||||
import * as smartlogDestinationLocal from '@push.rocks/smartlog-destination-local';
|
||||
import * as smartpath from '@push.rocks/smartpath';
|
||||
import * as smartshell from '@push.rocks/smartshell';
|
||||
import * as smartsystem from '@push.rocks/smartsystem';
|
||||
import * as lik from '@pushrocks/lik';
|
||||
import * as smartfile from '@pushrocks/smartfile';
|
||||
import * as smartlog from '@pushrocks/smartlog';
|
||||
import * as smartlogDestinationLocal from '@pushrocks/smartlog-destination-local';
|
||||
import * as smartshell from '@pushrocks/smartshell';
|
||||
import * as smartsystem from '@pushrocks/smartsystem';
|
||||
|
||||
export {
|
||||
lik,
|
||||
smartfile,
|
||||
smartfm,
|
||||
smartlog,
|
||||
smartlogDestinationLocal,
|
||||
smartpath,
|
||||
smartshell,
|
||||
smartsystem,
|
||||
smartsystem
|
||||
};
|
||||
|
||||
// third party
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import * as plugins from './smartdaemon.plugins.js';
|
||||
import * as plugins from './smartdaemon.plugins';
|
||||
|
||||
export const logger = new plugins.smartlog.Smartlog({
|
||||
logContext: {
|
||||
@ -7,9 +7,9 @@ export const logger = new plugins.smartlog.Smartlog({
|
||||
containerName: 'Some Containername',
|
||||
environment: 'local',
|
||||
runtime: 'node',
|
||||
zone: 'gitzone',
|
||||
zone: 'gitzone'
|
||||
},
|
||||
minimumLogLevel: 'silly',
|
||||
minimumLogLevel: 'silly'
|
||||
});
|
||||
|
||||
logger.addLogDestination(new plugins.smartlogDestinationLocal.DestinationLocal());
|
||||
|
||||
@ -1,14 +0,0 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"esModuleInterop": true,
|
||||
"verbatimModuleSyntax": true
|
||||
},
|
||||
"exclude": [
|
||||
"dist_*/**/*.d.ts"
|
||||
]
|
||||
}
|
||||
17
tslint.json
Normal file
17
tslint.json
Normal file
@ -0,0 +1,17 @@
|
||||
{
|
||||
"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