1.0.22

.gitignore

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

.gitlab-ci.yml

@@ -4,7 +4,7 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 cache:
   paths:
     - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
   - security
@@ -19,45 +19,71 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
-snyk:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
+    - npmci command npm install --production --ignore-scripts
-    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command snyk test
+    - npmci command npm audit --audit-level=high --only=prod --production
   tags:
     - docker
-  - notpriv
+
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=dev
+  tags:
+    - docker
+  allow_failure: true
 
 # ====================
 # test stage
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
     - npmci npm prepare
-  - npmci node install lts
+    - npmci node install stable
     - npmci npm install
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
     - docker
-  - notpriv
+
+testBuild:
+  stage: test
+  script:
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - docker
 
 release:
   stage: release
   script:
-  - npmci node install lts
+    - npmci node install stable
     - npmci npm publish
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -67,11 +93,15 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
     - npmci command npm install -g tslint typescript
+    - npmci npm prepare
     - npmci npm install
     - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
+    - lossless
     - docker
     - priv
 
@@ -82,18 +112,20 @@ trigger:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
+    - npmci node install lts
     - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
     - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:

.vscode/settings.json

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

npmextra.json

@@ -1,5 +1,6 @@
 {
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",

package.json

@@ -1,41 +1,46 @@
 {
   "name": "@pushrocks/smartdaemon",
-  "version": "1.0.6",
+  "version": "1.0.22",
   "private": false,
   "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",
   "license": "MIT",
   "scripts": {
-    "test": "(tstest test/)",
+    "test": "(tstest test/ --web)",
-    "build": "(tsbuild)",
+    "build": "(tsbuild --web)"
-    "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tstest": "^1.0.15",
+    "@gitzone/tstest": "^1.0.52",
-    "@pushrocks/tapbundle": "^3.0.13",
+    "@pushrocks/tapbundle": "^3.2.10",
-    "@types/node": "^10.11.7",
+    "@types/node": "^14.14.22",
-    "tslint": "^5.11.0",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
-    "@pushrocks/lik": "^3.0.11",
+    "@pushrocks/lik": "^4.0.20",
-    "@pushrocks/smartfile": "^7.0.4",
+    "@pushrocks/smartfile": "^8.0.8",
-    "@pushrocks/smartlog": "^2.0.19",
+    "@pushrocks/smartfm": "^2.0.4",
-    "@pushrocks/smartlog-destination-local": "^8.0.2",
+    "@pushrocks/smartlog": "^2.0.39",
-    "@pushrocks/smartshell": "^2.0.25",
+    "@pushrocks/smartlog-destination-local": "^8.0.8",
-    "@pushrocks/smartsystem": "^2.0.8"
+    "@pushrocks/smartshell": "^2.0.26",
+    "@pushrocks/smartsystem": "^2.0.9"
   },
   "files": [
-    "ts/*",
+    "ts/**/*",
-    "ts_web/*",
+    "ts_web/**/*",
-    "dist/*",
+    "dist/**/*",
-    "dist_web/*",
+    "dist_*/**/*",
-    "assets/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -8,19 +8,31 @@ start scripts as long running daemons and manage them
 * [docs (typedoc)](https://pushrocks.gitlab.io/smartdaemon/)
 
 ## Status for master
-[![build status](https://gitlab.com/pushrocks/smartdaemon/badges/master/build.svg)](https://gitlab.com/pushrocks/smartdaemon/commits/master)
+
-[![coverage report](https://gitlab.com/pushrocks/smartdaemon/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartdaemon/commits/master)
+Status Category | Status Badge
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartdaemon.svg)](https://www.npmjs.com/package/@pushrocks/smartdaemon)
+-- | --
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartdaemon/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartdaemon)
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartdaemon/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/pushrocks/smartdaemon/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/@pushrocks/smartdaemon)](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/pushrocks/smartdaemon)](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/@pushrocks/smartdaemon)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartdaemon)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartdaemon)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
 
 ## 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). :)
+
 For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+| 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)
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.ts

@@ -8,4 +8,14 @@ tap.test('should create an instance of smartdaemon', async () => {
   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: __dirname,
+  });
+});
+
 tap.start();

ts/smartdaemon.classes.service.ts

@@ -2,29 +2,37 @@ import * as plugins from './smartdaemon.plugins';
 import * as paths from './smartdaemon.paths';
 import { SmartDaemon } from './smartdaemon.classes.smartdaemon';
 
-export interface SmartDaemonServiceConstructorOptions {
+export interface ISmartDaemonServiceConstructorOptions {
   name: string;
+  description: string;
   command: string;
   workingDir: string;
+  version: string;
 }
 
 /**
  * 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);
     for (const key of Object.keys(optionsArg)) {
       service[key] = optionsArg[key];
     }
-
+    return service;
   }
 
-  public options: SmartDaemonServiceConstructorOptions;
+  public options: ISmartDaemonServiceConstructorOptions;
+  public alreadyExists = false;
 
   public name: string;
+  public version: string;
   public command: string;
   public workingDir: string;
+  public description: string;
 
   public smartdaemonRef: SmartDaemon;
 
@@ -36,18 +44,43 @@ export class SmartDaemonService implements SmartDaemonServiceConstructorOptions
    * enables the service
    */
   public async enable() {
-    this.smartdaemonRef
+    await this.smartdaemonRef.systemdManager.enableService(this);
   }
 
   /**
    * disables the service
    */
   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();
+  }
 }

ts/smartdaemon.classes.smartdaemon.ts

@@ -1,29 +1,41 @@
 import * as plugins from './smartdaemon.plugins';
 import { SmartDaemonTemplateManager } from './smartdaemon.classes.templatemanager';
-import { SmartDaemonService } from './smartdaemon.classes.service';
+import {
+  SmartDaemonService,
+  ISmartDaemonServiceConstructorOptions,
+} 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);
   }
 
-  public async addService(serviceName: string, workingDirectory): Promise<SmartDaemonService> {
+  /**
-    const existingService = this.serviceMap.find(serviceArg => {
+   * adds a service
-      return serviceArg
+   * @param nameArg
-    })
+   * @param commandArg
-  };
+   * @param workingDirectoryArg
-
+   */
-  public async init() {
+  public async addService(
-    await this.systemdManager.init();
+    optionsArg: ISmartDaemonServiceConstructorOptions
+  ): Promise<SmartDaemonService> {
+    let serviceToAdd: SmartDaemonService;
+    const existingServices = await this.systemdManager.getServices();
+    const existingService = existingServices.find((serviceArg) => {
+      return serviceArg.name === optionsArg.name;
+    });
+    if (!existingService) {
+      serviceToAdd = await SmartDaemonService.createFromOptions(this, optionsArg);
+    } else {
+      serviceToAdd = existingService;
+      Object.assign(serviceToAdd, optionsArg);
+    }
+    await serviceToAdd.save();
+    return serviceToAdd;
   }
 }

ts/smartdaemon.classes.systemdmanager.ts

@@ -1,9 +1,31 @@
 import * as plugins from './smartdaemon.plugins';
 import * as paths from './smartdaemon.paths';
 import { SmartDaemon } from './smartdaemon.classes.smartdaemon';
+import {
+  ISmartDaemonServiceConstructorOptions,
+  SmartDaemonService,
+} from './smartdaemon.classes.service';
 
 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 smartshellInstance: plugins.smartshell.Smartshell;
   public smartsystem: plugins.smartsystem.Smartsystem;
@@ -13,7 +35,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();
   }
@@ -22,22 +44,104 @@ export class SmartDaemonSystemdManager {
     if (await this.smartsystem.env.isLinuxAsync()) {
       this.shouldExecute = true;
     } 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;
     }
     return this.shouldExecute;
   }
 
   public async execute(commandArg: string) {
-    (await this.checkElegibility()) ? await this.smartshellInstance.exec(commandArg) : null;
+    if (await this.checkElegibility()) {
+      await this.smartshellInstance.exec(commandArg);
+    }
   }
 
+  /**
+   * gets all services that are already present
+   */
   public async getServices() {
-    const availableServices = plugins.smartfile.fs.listAllItems(paths.systemdDir, new RegExp(`${this.smartDaemonNamespace}`));
+    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`);
+    }
+  }
 }

ts/smartdaemon.classes.templatemanager.ts

@@ -1,5 +1,6 @@
 import * as plugins from './smartdaemon.plugins';
 import { SmartDaemon } from './smartdaemon.classes.smartdaemon';
+import { SmartDaemonService } from './smartdaemon.classes.service';
 
 export class SmartDaemonTemplateManager {
   public smartdaemonRef: SmartDaemon;
@@ -8,25 +9,24 @@ export class SmartDaemonTemplateManager {
     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]
-Description=${optionsArg.description}
+Description=${serviceArg.description}
 Requires=network.target
 After=network.target
 
 [Service]
 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
 LimitNOFILE=infinity
 LimitCORE=infinity
@@ -37,5 +37,5 @@ Restart=always
 [Install]
 WantedBy=multi-user.target
 `;
-  }
+  };
 }

ts/smartdaemon.plugins.ts

@@ -1,32 +1,17 @@
 // node native scope
 import * as path from 'path';
 
-
+export { path };
-export {
-  path
-};
 
 // @pushrocks scope
 import * as lik from '@pushrocks/lik';
 import * as smartfile from '@pushrocks/smartfile';
+import * as smartfm from '@pushrocks/smartfm';
 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 {
+export { lik, smartfile, smartfm, smartlog, smartlogDestinationLocal, smartshell, smartsystem };
-  lik,
-  smartfile,
-  smartlog,
-  smartlogDestinationLocal,
-  smartshell,
-  smartsystem
-};
 
 // third party
-
-import * as fs from 'fs-extra';
-
-export {
-  fs
-};

ts/smartdamon.logging.ts

@@ -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());