Compare commits

...

55 Commits

Author SHA1 Message Date
ea35307c68 2.0.8 2025-03-03 13:19:12 +00:00
6af0b5d0d8 fix(core): Update project dependencies and resolve minor issues in file paths 2025-03-03 13:19:12 +00:00
db20fb6bce 2.0.7 2025-03-03 06:32:05 +00:00
3c2d5996d2 fix(core): Update @types/node to fix compatibility issues. 2025-03-03 06:32:05 +00:00
1b78b79bd8 update description 2024-05-29 14:12:23 +02:00
229929f7f1 2.0.6 2024-04-19 13:54:29 +02:00
923b423536 fix(core): update 2024-04-19 13:54:28 +02:00
b464b351fb 2.0.5 2024-04-19 13:54:21 +02:00
31ddd3ec23 fix(core): update 2024-04-19 13:54:20 +02:00
af90530000 update tsconfig 2024-04-14 17:27:46 +02:00
f27fb675e5 update npmextra.json: githost 2024-04-01 21:34:24 +02:00
fbfc1dd65e update npmextra.json: githost 2024-04-01 19:57:56 +02:00
d034cd3725 update npmextra.json: githost 2024-03-30 21:46:54 +01:00
3a2d174c19 2.0.4 2023-07-25 18:57:39 +02:00
323648a3f7 fix(core): update 2023-07-25 18:57:38 +02:00
0a48d9a12d switch to new org scheme 2023-07-11 00:29:11 +02:00
7bf11122f8 switch to new org scheme 2023-07-10 02:42:56 +02:00
1466725b54 2.0.3 2022-10-19 19:42:07 +02:00
9fdc686671 fix(core): update 2022-10-19 19:42:07 +02:00
4cca23cffa 2.0.2 2022-10-19 19:39:33 +02:00
f683fc1fa7 fix(core): update 2022-10-19 19:39:33 +02:00
d25665519a 2.0.1 2022-10-19 19:35:06 +02:00
e54e0b4ee3 fix(core): update 2022-10-19 19:35:06 +02:00
6cfa9aba87 2.0.0 2022-10-19 19:27:43 +02:00
451daec7b4 BREAKING CHANGE(core): switch to esm 2022-10-19 19:27:42 +02:00
7067826a4e 1.0.22 2021-01-30 00:45:48 +00:00
16abdc6f12 fix(core): update 2021-01-30 00:45:47 +00:00
09b598f7bf 1.0.21 2021-01-30 00:41:41 +00:00
060f635989 fix(core): update 2021-01-30 00:41:40 +00:00
769d7d6419 1.0.20 2019-09-19 19:37:35 +02:00
49dd65af05 fix(core): update 2019-09-19 19:37:34 +02:00
d550318331 1.0.19 2019-09-19 15:58:44 +02:00
9fc71fcfee fix(core): update 2019-09-19 15:58:43 +02:00
119f20915e 1.0.18 2019-09-06 17:33:02 +02:00
ce1fa6640b fix(core): update 2019-09-06 17:33:01 +02:00
8957e03445 1.0.17 2019-09-05 16:19:18 +02:00
3df86bee10 fix(core): update 2019-09-05 16:19:18 +02:00
65326710ab 1.0.16 2019-09-05 16:14:05 +02:00
2e174c9f55 fix(core): update 2019-09-05 16:14:05 +02:00
9e42910456 1.0.15 2019-09-05 16:04:38 +02:00
ff85cee528 fix(core): update 2019-09-05 16:04:38 +02:00
2a9fff0185 1.0.14 2019-09-05 15:48:00 +02:00
67689d79bd fix(core): update 2019-09-05 15:48:00 +02:00
f8c851de97 1.0.13 2019-09-05 13:50:11 +02:00
09e9d8c190 fix(core): update 2019-09-05 13:50:11 +02:00
80f5df3317 1.0.12 2019-09-05 11:15:17 +02:00
6cf3ff6e83 fix(core): update 2019-09-05 11:15:17 +02:00
ceb30c7ac2 1.0.11 2019-09-04 16:51:58 +02:00
0df90eec5d fix(core): update 2019-09-04 16:51:58 +02:00
261031a49c 1.0.10 2019-09-03 22:09:31 +02:00
615cc6aa7c fix(core): update 2019-09-03 22:09:30 +02:00
c9aa7fed48 1.0.9 2019-09-03 19:58:08 +02:00
44d30fc4d6 fix(core): update 2019-09-03 19:58:08 +02:00
dd5e1a978d 1.0.8 2019-09-03 16:50:25 +02:00
692602b463 fix(core): update 2019-09-03 16:50:24 +02:00
26 changed files with 10683 additions and 1927 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,105 +0,0 @@
# 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
View File

@ -2,28 +2,10 @@
"version": "0.2.0", "version": "0.2.0",
"configurations": [ "configurations": [
{ {
"name": "current file", "command": "npm test",
"type": "node", "name": "Run npm test",
"request": "launch", "request": "launch",
"args": [ "type": "node-terminal"
"${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 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"]
}
}
}
}
}
}
]
}

31
changelog.md Normal file
View File

@ -0,0 +1,31 @@
# 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.

View File

@ -1,17 +1,30 @@
{ {
"gitzone": { "gitzone": {
"projectType": "npm",
"module": { "module": {
"githost": "gitlab.com", "githost": "code.foss.global",
"gitscope": "pushrocks", "gitscope": "push.rocks",
"gitrepo": "smartdaemon", "gitrepo": "smartdaemon",
"shortDescription": "start scripts as long running daemons and manage them", "description": "Start scripts as long running daemons and manage them.",
"npmPackagename": "@pushrocks/smartdaemon", "npmPackagename": "@push.rocks/smartdaemon",
"license": "MIT", "license": "MIT",
"projectDomain": "push.rocks" "projectDomain": "push.rocks",
"keywords": [
"daemon",
"service management",
"Linux systemd",
"process management",
"Node.js",
"system administration",
"background services"
]
} }
}, },
"npmci": { "npmci": {
"npmGlobalTools": [], "npmGlobalTools": [],
"npmAccessLevel": "public" "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

File diff suppressed because it is too large Load Diff

View File

@ -1,41 +1,62 @@
{ {
"name": "@pushrocks/smartdaemon", "name": "@push.rocks/smartdaemon",
"version": "1.0.7", "version": "2.0.8",
"private": false, "private": false,
"description": "start scripts as long running daemons and manage them", "description": "Start scripts as long running daemons and manage them.",
"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/ --web)",
"build": "(tsbuild)", "build": "(tsbuild --web --allowimplicitany)",
"format": "(gitzone format)" "buildDocs": "tsdoc"
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.1.17", "@git.zone/tsbuild": "^2.1.66",
"@gitzone/tstest": "^1.0.15", "@git.zone/tsrun": "^1.2.44",
"@pushrocks/tapbundle": "^3.0.13", "@git.zone/tstest": "^1.0.77",
"@types/node": "^10.11.7", "@push.rocks/tapbundle": "^5.0.23",
"tslint": "^5.11.0", "@types/node": "^22.13.8"
"tslint-config-prettier": "^1.15.0"
}, },
"dependencies": { "dependencies": {
"@pushrocks/lik": "^3.0.11", "@push.rocks/lik": "^6.0.15",
"@pushrocks/smartfile": "^7.0.4", "@push.rocks/smartfile": "^11.0.14",
"@pushrocks/smartlog": "^2.0.19", "@push.rocks/smartfm": "^2.0.4",
"@pushrocks/smartlog-destination-local": "^8.0.2", "@push.rocks/smartlog": "^3.0.3",
"@pushrocks/smartshell": "^2.0.25", "@push.rocks/smartlog-destination-local": "^9.0.1",
"@pushrocks/smartsystem": "^2.0.8" "@push.rocks/smartpath": "^5.0.14",
"@push.rocks/smartshell": "^3.0.5",
"@push.rocks/smartsystem": "^3.0.1"
}, },
"files": [ "files": [
"ts/*", "ts/**/*",
"ts_web/*", "ts_web/**/*",
"dist/*", "dist/**/*",
"dist_web/*", "dist_*/**/*",
"assets/*", "dist_ts/**/*",
"dist_ts_web/**/*",
"assets/**/*",
"cli.js", "cli.js",
"npmextra.json", "npmextra.json",
"readme.md" "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 Normal file

File diff suppressed because it is too large Load Diff

1
readme.hints.md Normal file
View File

@ -0,0 +1 @@

122
readme.md
View File

@ -1,26 +1,112 @@
# @pushrocks/smartdaemon # @push.rocks/smartdaemon
start scripts as long running daemons and manage them start scripts as long running daemons and manage them
## Availabililty and Links ## Install
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartdaemon) To install `@push.rocks/smartdaemon`, run the following command in your terminal:
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartdaemon)
* [github.com (source mirror)](https://github.com/pushrocks/smartdaemon)
* [docs (typedoc)](https://pushrocks.gitlab.io/smartdaemon/)
## Status for master ```bash
[![build status](https://gitlab.com/pushrocks/smartdaemon/badges/master/build.svg)](https://gitlab.com/pushrocks/smartdaemon/commits/master) npm install @push.rocks/smartdaemon --save
[![coverage report](https://gitlab.com/pushrocks/smartdaemon/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartdaemon/commits/master) ```
[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartdaemon.svg)](https://www.npmjs.com/package/@pushrocks/smartdaemon) This will add `@push.rocks/smartdaemon` to your project's dependencies.
[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartdaemon/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartdaemon)
[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
## Usage ## Usage
For further information read the linked docs at the top of this readme. `@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.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) ### Getting Started
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html) First, ensure you import `SmartDaemon` from the package in your TypeScript files:
[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com) ```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.

3
test/plugins.ts Normal file
View File

@ -0,0 +1,3 @@
import * as smartpath from '@push.rocks/smartpath';
export { smartpath };

View File

@ -1,11 +1,24 @@
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, tap } from '@push.rocks/tapbundle';
import * as smartdaemon from '../ts/index';
import * as plugins from './plugins.js';
import * as smartdaemon from '../ts/index.js';
let testSmartdaemon: smartdaemon.SmartDaemon; let testSmartdaemon: smartdaemon.SmartDaemon;
tap.test('should create an instance of smartdaemon', async () => { tap.test('should create an instance of smartdaemon', async () => {
testSmartdaemon = new smartdaemon.SmartDaemon(); testSmartdaemon = new smartdaemon.SmartDaemon();
expect(testSmartdaemon).to.be.instanceOf(smartdaemon.SmartDaemon); expect(testSmartdaemon).toBeInstanceOf(smartdaemon.SmartDaemon);
}); });
tap.start(); 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();

8
ts/00_commitinfo_data.ts Normal file
View File

@ -0,0 +1,8 @@
/**
* 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.'
}

View File

@ -1 +1 @@
export * from './smartdaemon.classes.smartdaemon'; export * from './smartdaemon.classes.smartdaemon.js';

View File

@ -1,30 +1,38 @@
import * as plugins from './smartdaemon.plugins'; import * as plugins from './smartdaemon.plugins.js';
import * as paths from './smartdaemon.paths'; import * as paths from './smartdaemon.paths.js';
import { SmartDaemon } from './smartdaemon.classes.smartdaemon'; import { SmartDaemon } from './smartdaemon.classes.smartdaemon.js';
export interface SmartDaemonServiceConstructorOptions { export interface ISmartDaemonServiceConstructorOptions {
name: string; name: string;
description: string;
command: string; command: string;
workingDir: string; workingDir: string;
version: string;
} }
/** /**
* represents a service that is being spawned by SmartDaemon * represents a service that is being spawned by SmartDaemon
*/ */
export class SmartDaemonService implements SmartDaemonServiceConstructorOptions { export class SmartDaemonService implements ISmartDaemonServiceConstructorOptions {
public static async createFromOptions(smartdaemonRef: SmartDaemon, optionsArg: SmartDaemonServiceConstructorOptions) { public static async createFromOptions(
smartdaemonRef: SmartDaemon,
optionsArg: ISmartDaemonServiceConstructorOptions
) {
const service = new SmartDaemonService(smartdaemonRef); const service = new SmartDaemonService(smartdaemonRef);
for (const key of Object.keys(optionsArg)) { for (const key of Object.keys(optionsArg)) {
service[key] = optionsArg[key]; service[key] = optionsArg[key];
} }
return service;
} }
public options: SmartDaemonServiceConstructorOptions; public options: ISmartDaemonServiceConstructorOptions;
public alreadyExists = false;
public name: string; public name: string;
public version: string;
public command: string; public command: string;
public workingDir: string; public workingDir: string;
public description: string;
public smartdaemonRef: SmartDaemon; public smartdaemonRef: SmartDaemon;
@ -36,18 +44,43 @@ export class SmartDaemonService implements SmartDaemonServiceConstructorOptions
* enables the service * enables the service
*/ */
public async enable() { public async enable() {
this.smartdaemonRef await this.smartdaemonRef.systemdManager.enableService(this);
} }
/** /**
* disables the service * disables the service
*/ */
public async disable() { public async disable() {
await this.smartdaemonRef.systemdManager.disableService(this);
} }
/** /**
* pauses the service * starts a service
*/ */
public pause() {}; 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();
}
} }

View File

@ -1,36 +1,41 @@
import * as plugins from './smartdaemon.plugins'; import * as plugins from './smartdaemon.plugins.js';
import { SmartDaemonTemplateManager } from './smartdaemon.classes.templatemanager'; import { SmartDaemonTemplateManager } from './smartdaemon.classes.templatemanager.js';
import { SmartDaemonService } from './smartdaemon.classes.service'; import {
import { SmartDaemonSystemdManager } from './smartdaemon.classes.systemdmanager'; type ISmartDaemonServiceConstructorOptions,
SmartDaemonService,
} from './smartdaemon.classes.service.js';
import { SmartDaemonSystemdManager } from './smartdaemon.classes.systemdmanager.js';
export class SmartDaemon { export class SmartDaemon {
public serviceMap: plugins.lik.Objectmap<SmartDaemonService>;
public templateManager: SmartDaemonTemplateManager; public templateManager: SmartDaemonTemplateManager;
public systemdManager: SmartDaemonSystemdManager; public systemdManager: SmartDaemonSystemdManager;
constructor() { constructor() {
this.serviceMap = new plugins.lik.Objectmap<SmartDaemonService>();
this.templateManager = new SmartDaemonTemplateManager(this); this.templateManager = new SmartDaemonTemplateManager(this);
this.systemdManager = new SmartDaemonSystemdManager(this); this.systemdManager = new SmartDaemonSystemdManager(this);
} }
public async addService(serviceNameArg: string, commandArg: string, workingDirectory?: string): Promise<SmartDaemonService> { /**
* adds a service
* @param nameArg
* @param commandArg
* @param workingDirectoryArg
*/
public async addService(
optionsArg: ISmartDaemonServiceConstructorOptions
): Promise<SmartDaemonService> {
let serviceToAdd: SmartDaemonService; let serviceToAdd: SmartDaemonService;
const existingService = this.serviceMap.find(serviceArg => { const existingServices = await this.systemdManager.getServices();
return serviceArg.name === serviceNameArg; const existingService = existingServices.find((serviceArg) => {
return serviceArg.name === optionsArg.name;
}); });
if (!existingService) { if (!existingService) {
serviceToAdd = await SmartDaemonService.createFromOptions(this, optionsArg);
} else { } else {
serviceToAdd = existingService;
Object.assign(serviceToAdd, optionsArg);
} }
await serviceToAdd.save();
return serviceToAdd; return serviceToAdd;
};
public async init() {
await this.systemdManager.init();
} }
} }

View File

@ -1,9 +1,31 @@
import * as plugins from './smartdaemon.plugins'; import * as plugins from './smartdaemon.plugins.js';
import * as paths from './smartdaemon.paths'; import * as paths from './smartdaemon.paths.js';
import { SmartDaemon } from './smartdaemon.classes.smartdaemon'; import { SmartDaemon } from './smartdaemon.classes.smartdaemon.js';
import {
type ISmartDaemonServiceConstructorOptions,
SmartDaemonService,
} from './smartdaemon.classes.service.js';
export class SmartDaemonSystemdManager { export class SmartDaemonSystemdManager {
private smartDaemonNamespace = 'smartdaemon_'; // 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
public smartdaemonRef: SmartDaemon; public smartdaemonRef: SmartDaemon;
public smartshellInstance: plugins.smartshell.Smartshell; public smartshellInstance: plugins.smartshell.Smartshell;
public smartsystem: plugins.smartsystem.Smartsystem; public smartsystem: plugins.smartsystem.Smartsystem;
@ -13,7 +35,7 @@ export class SmartDaemonSystemdManager {
constructor(smartdaemonRefArg: SmartDaemon) { constructor(smartdaemonRefArg: SmartDaemon) {
this.smartdaemonRef = smartdaemonRefArg; this.smartdaemonRef = smartdaemonRefArg;
this.smartshellInstance = new plugins.smartshell.Smartshell({ this.smartshellInstance = new plugins.smartshell.Smartshell({
executor: 'bash' executor: 'bash',
}); });
this.smartsystem = new plugins.smartsystem.Smartsystem(); this.smartsystem = new plugins.smartsystem.Smartsystem();
} }
@ -22,22 +44,104 @@ export class SmartDaemonSystemdManager {
if (await this.smartsystem.env.isLinuxAsync()) { if (await this.smartsystem.env.isLinuxAsync()) {
this.shouldExecute = true; this.shouldExecute = true;
} else { } else {
console.log('Smartdaemon can only be used on Linuc systems! Refusing to set up a service.'); console.log('Smartdaemon can only be used on Linux systems! Refusing to set up a service.');
this.shouldExecute = false; this.shouldExecute = false;
} }
return this.shouldExecute; return this.shouldExecute;
} }
public async execute(commandArg: string) { public async execute(commandArg: string) {
(await this.checkElegibility()) ? await this.smartshellInstance.exec(commandArg) : null; if (await this.checkElegibility()) {
await this.smartshellInstance.exec(commandArg);
}
} }
public async getServices () { /**
const availableServices = plugins.smartfile.fs.listAllItems(paths.systemdDir, new RegExp(`${this.smartDaemonNamespace}`)); * 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;
} }
public async init() { 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 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`);
}
}
}

View File

@ -1,5 +1,6 @@
import * as plugins from './smartdaemon.plugins'; import * as plugins from './smartdaemon.plugins.js';
import { SmartDaemon } from './smartdaemon.classes.smartdaemon'; import { SmartDaemon } from './smartdaemon.classes.smartdaemon.js';
import { SmartDaemonService } from './smartdaemon.classes.service.js';
export class SmartDaemonTemplateManager { export class SmartDaemonTemplateManager {
public smartdaemonRef: SmartDaemon; public smartdaemonRef: SmartDaemon;
@ -8,25 +9,24 @@ export class SmartDaemonTemplateManager {
this.smartdaemonRef = smartdaemonRefArg; this.smartdaemonRef = smartdaemonRefArg;
} }
public generateServiceTemplate = (optionsArg: { public generateUnitFileForService = (serviceArg: SmartDaemonService) => {
serviceName: string; return `# ---
description: string; # name: ${serviceArg.name}
serviceVersion: string; # version: ${serviceArg.version}
command: string; # description: ${serviceArg.description}
pathWorkkingDir; # command: ${serviceArg.command}
pathJsFileToRun; # workingDir: ${serviceArg.workingDir}
}) => { # ---
return `
# servicVersion: ${optionsArg.serviceVersion}
[Unit] [Unit]
Description=${optionsArg.description} Description=${serviceArg.description}
Requires=network.target Requires=network.target
After=network.target After=network.target
[Service] [Service]
Type=simple Type=simple
ExecStart=/bin/bash -c "cd ${optionsArg.pathWorkkingDir} && ${optionsArg.command}" Environment=NODE_OPTIONS="--max_old_space_size=100"
WorkingDirectory=${optionsArg.pathWorkkingDir} ExecStart=/bin/bash -c "cd ${serviceArg.workingDir} && ${serviceArg.command}"
WorkingDirectory=${serviceArg.workingDir}
Restart=on-failure Restart=on-failure
LimitNOFILE=infinity LimitNOFILE=infinity
LimitCORE=infinity LimitCORE=infinity
@ -37,5 +37,5 @@ Restart=always
[Install] [Install]
WantedBy=multi-user.target WantedBy=multi-user.target
`; `;
} };
} }

View File

@ -1,4 +1,7 @@
import * as plugins from './smartdaemon.plugins'; import * as plugins from './smartdaemon.plugins.js';
export const packageDir = plugins.path.join(__dirname, '../'); export const packageDir = plugins.path.join(
plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url),
'../'
);
export const systemdDir = plugins.path.join('/lib/systemd/system/'); export const systemdDir = plugins.path.join('/lib/systemd/system/');

View File

@ -1,26 +1,27 @@
// node native scope // node native scope
import * as path from 'path'; import * as path from 'path';
export { path };
export {
path
};
// @pushrocks scope // @pushrocks scope
import * as lik from '@pushrocks/lik'; import * as lik from '@push.rocks/lik';
import * as smartfile from '@pushrocks/smartfile'; import * as smartfile from '@push.rocks/smartfile';
import * as smartlog from '@pushrocks/smartlog'; import * as smartfm from '@push.rocks/smartfm';
import * as smartlogDestinationLocal from '@pushrocks/smartlog-destination-local'; import * as smartlog from '@push.rocks/smartlog';
import * as smartshell from '@pushrocks/smartshell'; import * as smartlogDestinationLocal from '@push.rocks/smartlog-destination-local';
import * as smartsystem from '@pushrocks/smartsystem'; import * as smartpath from '@push.rocks/smartpath';
import * as smartshell from '@push.rocks/smartshell';
import * as smartsystem from '@push.rocks/smartsystem';
export { export {
lik, lik,
smartfile, smartfile,
smartfm,
smartlog, smartlog,
smartlogDestinationLocal, smartlogDestinationLocal,
smartpath,
smartshell, smartshell,
smartsystem smartsystem,
}; };
// third party // third party

View File

@ -1,4 +1,4 @@
import * as plugins from './smartdaemon.plugins'; import * as plugins from './smartdaemon.plugins.js';
export const logger = new plugins.smartlog.Smartlog({ export const logger = new plugins.smartlog.Smartlog({
logContext: { logContext: {
@ -7,9 +7,9 @@ export const logger = new plugins.smartlog.Smartlog({
containerName: 'Some Containername', containerName: 'Some Containername',
environment: 'local', environment: 'local',
runtime: 'node', runtime: 'node',
zone: 'gitzone' zone: 'gitzone',
}, },
minimumLogLevel: 'silly' minimumLogLevel: 'silly',
}); });
logger.addLogDestination(new plugins.smartlogDestinationLocal.DestinationLocal()); logger.addLogDestination(new plugins.smartlogDestinationLocal.DestinationLocal());

14
tsconfig.json Normal file
View File

@ -0,0 +1,14 @@
{
"compilerOptions": {
"experimentalDecorators": true,
"useDefineForClassFields": false,
"target": "ES2022",
"module": "NodeNext",
"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"
}