@kronos-integration/service-systemd 2.5.2

package/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2019-2021 by Kronos-Integration
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,107 @@
+[![npm](https://img.shields.io/npm/v/@kronos-integration/service-systemd.svg)](https://www.npmjs.com/package/@kronos-integration/service-systemd)
+[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
+[![minified size](https://badgen.net/bundlephobia/min/@kronos-integration/service-systemd)](https://bundlephobia.com/result?p=@kronos-integration/service-systemd)
+[![downloads](http://img.shields.io/npm/dm/@kronos-integration/service-systemd.svg?style=flat-square)](https://npmjs.org/package/@kronos-integration/service-systemd)
+[![GitHub Issues](https://img.shields.io/github/issues/Kronos-Integration/service-systemd.svg?style=flat-square)](https://github.com/Kronos-Integration/service-systemd/issues)
+[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2FKronos-Integration%2Fservice-systemd%2Fbadge\&style=flat)](https://actions-badge.atrox.dev/Kronos-Integration/service-systemd/goto)
+[![Styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
+[![Known Vulnerabilities](https://snyk.io/test/github/Kronos-Integration/service-systemd/badge.svg)](https://snyk.io/test/github/Kronos-Integration/service-systemd)
+[![Coverage Status](https://coveralls.io/repos/Kronos-Integration/service-systemd/badge.svg)](https://coveralls.io/github/Kronos-Integration/service-systemd)
+
+# @kronos-integration/service-systemd
+
+kronos systemd integration
+
+*   sync node state to systemd with notify (done)
+*   propagate config into kronos (done)
+*   propagate socket activations into kronos (partly)
+*   start / stop / restart / reload initiated from systemd (partly)
+*   log into journal (done)
+
+# usage
+
+# API
+
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+### Table of Contents
+
+*   [JournalLogger](#journallogger)
+*   [FileDescriptor](#filedescriptor)
+    *   [Properties](#properties)
+*   [SystemdConfig](#systemdconfig)
+    *   [Properties](#properties-1)
+    *   [listeningFileDescriptors](#listeningfiledescriptors)
+    *   [loadConfig](#loadconfig)
+*   [ServiceSystemd](#servicesystemd)
+    *   [endpoints](#endpoints)
+
+## JournalLogger
+
+**Extends ServiceLogger**
+
+Forward logs entries to the journal.
+
+## FileDescriptor
+
+Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
+
+### Properties
+
+*   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** 
+*   `fd` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** 
+
+## SystemdConfig
+
+**Extends ServiceConfig**
+
+Provides config from CONFIGURATION_DIRECTORY.
+Also injects listeningFileDescriptors into the config
+
+### Properties
+
+*   `configurationDirectory` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** taken from CONFIGURATION_DIRECTORY
+
+### listeningFileDescriptors
+
+listeningFileDescriptors as passed in LISTEN_FDS and LISTEN_FDNAMES.
+
+Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[FileDescriptor](#filedescriptor)>** 
+
+### loadConfig
+
+Load config from configuration dir.
+Additionally pass listeninfFileDescriptions into config.
+
+## ServiceSystemd
+
+**Extends ServiceProviderMixin(Service, JournalLogger, SystemdConfig)**
+
+Kronos bridge to systemd:
+
+*   sync node state to systemd with notify
+*   propagate config into kronos world
+*   propagate socket activations into kronos (partly)
+*   start / stop / restart / reload initiated from systemd
+*   log into journal
+
+### endpoints
+
+Definition of the predefined endpoints.
+
+*   info *in*
+
+Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** predefined endpoints
+
+# install
+
+With [npm](http://npmjs.org) do:
+
+```shell
+npm install @kronos-integration/service-systemd
+```
+
+# license
+
+BSD-2-Clause

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@kronos-integration/service-systemd",
+  "version": "2.5.2",
+  "publishConfig": {
+    "access": "public"
+  },
+  "sideEffects": false,
+  "exports": {
+    ".": "./src/service.mjs"
+  },
+  "description": "kronos systemd integration",
+  "keywords": [
+    "journal",
+    "kronos-service",
+    "notify",
+    "systemd"
+  ],
+  "contributors": [
+    {
+      "name": "Markus Felten",
+      "email": "markus.felten@gmx.de"
+    }
+  ],
+  "license": "BSD-2-Clause",
+  "scripts": {
+    "test": "npm run test:ava",
+    "test:ava": "ava --timeout 2m tests/*.mjs",
+    "cover": "c8 -x 'tests/**/*' --temp-directory build/tmp ava --timeout 2m tests/*.mjs && c8 report -r lcov -o build/coverage --temp-directory build/tmp",
+    "docs": "documentation readme --section=API ./src/**/*.mjs",
+    "lint": "npm run lint:docs",
+    "lint:docs": "documentation lint ./src/**/*.mjs",
+    "build": "cmake-js compile"
+  },
+  "dependencies": {
+    "@kronos-integration/service": "^10.4.7",
+    "config-expander": "^12.0.1"
+  },
+  "devDependencies": {
+    "ava": "^3.15.0",
+    "c8": "^7.9.0",
+    "cmake-js": "^6.2.1",
+    "documentation": "^13.2.5",
+    "execa": "^5.1.1",
+    "node-addon-api": "^4.0.0",
+    "semantic-release": "^18.0.0"
+  },
+  "engines": {
+    "node": ">=16.10.0"
+  },
+  "os": [
+    "linux"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Kronos-Integration/service-systemd.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Kronos-Integration/service-systemd/issues"
+  },
+  "homepage": "https://github.com/Kronos-Integration/service-systemd#readme",
+  "native": "${dirname}/${basename}-${os}-${arch}.node",
+  "template": {
+    "inheritFrom": [
+      "arlac77/template-arlac77-github",
+      "arlac77/template-cmake",
+      "arlac77/template-kronos-component"
+    ]
+  }
+}

package/src/service.mjs

@@ -0,0 +1,213 @@
+import { expand } from "config-expander";
+import {
+  ServiceProviderMixin,
+  Service,
+  ServiceLogger,
+  ServiceConfig
+} from "@kronos-integration/service";
+import { Module } from "module";
+import { arch, constants } from "os";
+
+const filename = new URL(`../systemd-linux-${arch()}.node`, import.meta.url)
+  .pathname;
+const m = new Module(filename);
+m.filename = filename;
+process.dlopen(m, filename, constants.dlopen.RTLD_NOW);
+const {
+  LISTEN_FDS_START,
+  notify_with_fds,
+  notify,
+  journal_print_object
+} = m.exports;
+
+export { notify, notify_with_fds, journal_print_object };
+
+/**
+ * Forward logs entries to the journal.
+ */
+class JournalLogger extends ServiceLogger {
+  static get name() {
+    return "systemd-logger";
+  }
+
+  static get description() {
+    return "Forward log entries into systemd journal";
+  }
+
+  logEntry(entry) {
+    journal_print_object(entry);
+  }
+}
+
+/**
+ * 
+ * @typedef {Object} FileDescriptor
+ * @property {string?} name
+ * @property {number} fd
+ */
+
+/**
+ * Provides config from CONFIGURATION_DIRECTORY.
+ * Also injects listeningFileDescriptors into the config
+ * @property {string} configurationDirectory taken from CONFIGURATION_DIRECTORY
+ */
+class SystemdConfig extends ServiceConfig {
+  static get name() {
+    return "systemd-config";
+  }
+
+  static get description() {
+    return "Synchronize configuration with systemd";
+  }
+ 
+  configurationDirectory = process.env.CONFIGURATION_DIRECTORY;
+
+  /**
+   * listeningFileDescriptors as passed in LISTEN_FDS and LISTEN_FDNAMES.
+   * @return {FileDescriptor[]}
+   */
+  get listeningFileDescriptors() {
+    const count = Number(process.env.LISTEN_FDS) || 0;
+    const fdNames = (process.env.LISTEN_FDNAMES || "").split(":");
+    const arr = new Array(count);
+    for (let i = 0; i < count; i++) {
+      arr[i] = {
+        fd: LISTEN_FDS_START + i
+      };
+      if (fdNames[i]) {
+        arr[i].name = fdNames[i];
+      }
+    }
+    this.trace(`listeningFileDescriptors ${JSON.stringify(arr)}`);
+    return arr;
+  }
+
+  /**
+   * Load config from configuration dir.
+   * Additionally pass listeninfFileDescriptions into config.
+   */
+  async loadConfig() {
+    notify("RELOADING=1");
+    if (this.configurationDirectory) {
+      this.trace(`load: ${this.configurationDirectory}/config.json`);
+      await this.configure(
+        await expand("${include('config.json')}", {
+          constants: {
+            basedir: this.configurationDirectory
+          },
+          default: {}
+        })
+      );
+    }
+
+    for (const listener of this.listeningFileDescriptors) {
+      if (listener.name === undefined) {
+        this.warn(`listener without name ${JSON.stringify(listener)}`);
+      } else {
+        await this.configureValue(listener.name, listener);
+      }
+    }
+  }
+
+  async _stop() {
+    const lfd = this.listeningFileDescriptors;
+    const state = "FDSTORE=1" + lfd.map(l => `\nFDNAME=${l.name}`).join("");
+    const rc = notify_with_fds(state, lfd.map(l => l.fd));
+    this.info(`${state} (${rc})`);
+
+    return super._stop();
+  }
+
+  async _start() {
+    await super._start();
+
+    process.on("SIGHUP", async () => {
+      await this.loadConfig();
+      notify("READY=1");
+    });
+
+    await this.loadConfig();
+  }
+}
+
+/**
+ * Kronos bridge to systemd:
+ * - sync node state to systemd with notify
+ * - propagate config into kronos world
+ * - propagate socket activations into kronos (partly)
+ * - start / stop / restart / reload initiated from systemd
+ * - log into journal
+ */
+export class ServiceSystemd extends ServiceProviderMixin(
+  Service,
+  JournalLogger,
+  SystemdConfig
+) {
+  static get name() {
+    return "systemd";
+  }
+
+  static get description() {
+    return "Bridge to systemd";
+  }
+
+  get autostart() {
+    return true;
+  }
+
+  /**
+   * Definition of the predefined endpoints.
+   * - info _in_
+   * @return {Object} predefined endpoints
+   */
+  static get endpoints() {
+    return {
+      ...super.endpoints,
+      info: {
+        in: true,
+        receive: "info"
+      }
+    };
+  }
+
+  async _start() {
+    process.on("warning", warning => this.warn(warning));
+    process.on("SIGINT", () => {
+      this.info("SIGINT");
+      this.stop();
+    });
+    process.on("SIGTERM", async () => {
+      await this.stop();
+      process.exit(0);
+    });
+    process.on("beforeExit", code => this.stop());
+    process.on("exit", code => this.stop());
+    return super._start();
+  }
+
+  stateChanged(oldState, newState) {
+    super.stateChanged(oldState, newState);
+    switch (newState) {
+      case "running":
+        notify("READY=1");
+        break;
+
+      case "stopping":
+        notify("STOPPING=1");
+        break;
+    }
+  }
+ 
+  info()
+  {
+    return this.toJSONWithOptions({
+      includeRuntimeInfo: true,
+      includeDefaults: true,
+      includeName: true,
+      includeConfig: false,
+      includePrivate: false
+    });
+  }
+}
+
+export default ServiceSystemd;