@fordi-org/sdn 0.0.1

package/README.md

@@ -0,0 +1,58 @@
+# SDN
+
+## Systemd Demonizer for Node
+
+This package will allow you to spin up a systemd service from an npm project with zero fuss.
+
+# Usage
+
+First, configure your `package.json` appropriately.  The service name will be the `.name` of your project, with any `@org/` prefix stripped off.  The entrypoint will be your `.main` entry.  The service's description will be your project's description.
+
+You can add any items to the service file with a `.config.systemd` section.  The first level of depth is the `[Section]`, and the second is the `Property=`.  Passing an array for a `Property=` will result in the property being repeated. For example:
+
+```json
+{
+  "name": "my-service",
+  "main": "src/index.js",
+  "systemd": {
+    "Unit": {
+      "After": ["network.target", "mariadb.service"],
+    }
+  }
+}
+```
+
+You don't really need to get into the systemd weeds here.  If you have a `.name` and `.main`, you should be good to go to the next steps:
+
+```bash
+$ npx @fordi-org/sdn install
+```
+
+This will create the service for you.  While you're in your working directory, there are some convenience scripts:
+
+```bash
+$ npx @fordi-org/sdn control start # This is an alias for `systemctl --user start your-service`  
+$ npx @fordi-org/sdn control stop # Any other service-related verb works
+$ npx @fordi-org/sdn logs # Will run journalctl so you can see what your service is doing
+$ npx @fordi-org/sdn uninstall # Remove your service from systemd
+```
+
+You might want to consider adding `scripts` to your `package.json`:
+
+```json
+{
+  ...
+  "scripts": {
+    "install-service": "npx @fordi-org/sdn install",
+    "uninstall-service": "npx @fordi-org/sdn uninstall",
+    "control": "npx @fordi-org/sdn control",
+    "start": "npx @fordi-org/sdn control start",
+    "status": "npx @fordi-org/sdn control status",
+    "stop": "npx @fordi-org/sdn control stop",
+    "logs": "npx @fordi-org/sdn logs",
+    "restart": "npx @fordi-org/sdn control restart",
+    "reload": "npx @fordi-org/sdn control '' daemon-reload"
+  },
+  ...
+}
+```

package/index.js

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+import { fileURLToPath } from "node:url";
+
+let cmd = process.argv[2];
+if (!cmd) {
+  console.warn(`${process.argv[1]} {command} ...`);
+  process.exit(-1);
+}
+const script = fileURLToPath(new URL(`./service/${cmd}.js`, import.meta.url));
+process.argv.splice(1, 2, script);
+await import(script);

package/lib/config.js

@@ -0,0 +1,48 @@
+import { existsSync, readFileSync } from "node:fs";
+import { dirname, resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+
+function getConfig(root) {
+  while (!existsSync(resolve(root, 'package.json')) && root !== '/') {
+    root = dirname(root);
+  }
+  if (root === '/') {
+    throw new Error("Not in an npm project");
+  }
+  
+  const readJson = (rootRelPath) => JSON.parse(readFileSync(resolve(root, rootRelPath)), 'utf8')
+  const { config = {}, ...PACKAGE } = readJson("package.json");
+
+  if (config.from) {
+    try {
+      Object.assign(config, readJson(config.from));
+    } catch (e) {
+      console.info(`No ${config.from}, though one is configured from package.json`);
+      config.from = 'package.json';
+    }
+  } else {
+    config.from = "package.json";
+  }
+
+  [config.name, config.org = undefined] = PACKAGE.name.replace(/^@/, '').split('/').reverse();
+  config.description = PACKAGE.description;
+  config.root = root;
+  config.main = PACKAGE.main;
+  config.package = Object.freeze(PACKAGE);
+
+  Object.freeze(config);
+
+  class ConfigError extends Error {
+    constructor(message, needed) {
+      super(needed ? `${message}; Please add the following to ${config.from}:\n  ${
+        Object.entries(needed).map(([name, desc]) => `${JSON.stringify(name)}: ${desc}`).join('\n  ')
+      }\n` : `${message}; please check ${config.from}`);
+    }
+  }
+
+  return { config, PACKAGE, ConfigError };
+}
+
+const { config, PACKAGE, ConfigError } = getConfig(fileURLToPath(new URL("./..", import.meta.url)).replace(/\/$/, ''));
+
+export { config, PACKAGE, ConfigError, getConfig };

package/lib/index.js

@@ -0,0 +1,3 @@
+export { getConfig } from "./config.js";
+export * from "./shellQuote.js";
+export * from "./jsonCmd.js";

package/lib/jsonCmd.js

@@ -0,0 +1,58 @@
+import child_process from "node:child_process";
+
+export async function* jsonCmd(cmd, args, options) {
+  const h = child_process.spawn(cmd, args, { ...options });
+  const d = new TextDecoder();
+  let buf = new Uint8Array(0);
+  let currentPromise = Promise.withResolvers();
+  let queue = [];
+
+  const tryParse = (buffer) => {
+    const json = d.decode(buffer);
+    try {
+      return JSON.parse(json);
+    } catch (e) {
+      return { parseError: e, input: json };
+    }
+  };
+  const cutToFirstNewline = (...buffers) => {
+    const nextBuf = Buffer.concat(buffers);
+    const newline = nextBuf.indexOf(10);
+    if (newline === -1) {
+      return [undefined, nextBuf];
+    }
+    const nextStart = newline + 1;
+    const nextLen = nextBuf.byteLength - nextStart;
+    const line = new Uint8Array(nextStart);
+    nextBuf.copy(line, 0, 0, nextStart);
+    const buf = new Uint8Array(nextLen);
+    nextBuf.copy(buf, 0, nextStart, nextBuf.byteLength);
+    return [line, buf];
+  }
+  const queueChunk = (chunk) => {
+    let line;
+    [line, buf] = cutToFirstNewline(buf, chunk);
+    do {
+      if (line) {
+        queue.push(tryParse(line));
+        currentPromise.resolve();
+        currentPromise = Promise.withResolvers();
+      }
+      [line, buf] = cutToFirstNewline(buf);
+    } while (line !== undefined);
+  };
+  h.stdout.on('data', queueChunk);
+  h.stderr.on('data', queueChunk);
+  h.once('close', (status, signal) => {
+    currentPromise.resolve();
+  });
+  do {
+    await currentPromise.promise;
+    while (queue.length) {
+      yield queue.shift();
+    }
+  } while (h.exitCode === null)
+  if (buf.byteLength) {
+    yield tryParse(buf);
+  }
+}

package/lib/shellQuote.js

@@ -0,0 +1,11 @@
+export function shellQuote(s, ...rest) {
+  if (Array.isArray(s)) {
+    return s.map((item) => shellQuote(item)).join(' ');
+  }
+  if (rest.length) {
+    return [s, ...rest].map((item) => shellQuote(item)).join(' ');
+  }
+  if (s === '') return `''`;
+  if (!/[^%+,-.\/:=@_0-9A-Za-z]/.test(s)) return s;
+  return `'` + s.replace(/'/g, `'\''`) + `'`;
+}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@fordi-org/sdn",
+  "version": "0.0.1",
+  "description": "Make an npm project run as a systemd service",
+  "type": "module",
+  "main": "lib/index.js",
+  "dependencies": {
+    "nodemon": "^3.1.11"
+  },
+  "bin": "index.js",
+  "config": {
+    "systemd": {
+      "Unit": {
+        "After": [
+          "network.target"
+        ]
+      },
+      "Service": {
+        "Type": "simple"
+      },
+      "Install": {
+        "WantedBy": [
+          "multi-user.target"
+        ]
+      }
+    }
+  }
+}

package/service/control.js

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+import { spawnSync } from "node:child_process";
+import { resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+
+import { getConfig } from "../lib/config.js";
+import { shellQuote } from "../lib/shellQuote.js";
+
+const { config: project } = getConfig(process.cwd());
+
+export function systemctl([cmd, ...args]) {
+  const argv = ['systemctl', '--user', ...(cmd ? [cmd, project.name] : []), ...args];
+  console.info(`> ${shellQuote(argv)}`);
+  return spawnSync(argv[0], argv.slice(1), { stdio: "inherit" });
+}
+
+if (fileURLToPath(import.meta.url) === resolve(process.argv[1])) {
+  systemctl(process.argv.slice(2));
+}

package/service/index.js

@@ -0,0 +1,28 @@
+#!/usr/bin/env node
+import { resolve } from "node:path";
+import nodemon from "nodemon";
+import { getConfig } from "../lib/config.js";
+
+const { config: project } = getConfig(process.argv[2] ?? process.cwd());
+
+process.title = project.name;
+
+nodemon({
+  script: resolve(project.root, project.main),
+  args: process.argv.slice(3),
+});
+
+nodemon.on("start", () => {
+  console.log(`Service ${project.name} is running.`);
+}).on("quit", () => {
+  console.log(`Service ${project.name} has quit.`);
+  process.exit();
+}).on("restart", () => {
+  console.log(`Service ${project.name} will restart.`);
+}).on("exit", () => {
+  console.log(`Service ${project.name} exited cleanly.`);
+}).on("crash", () => {
+  console.log(`Service ${project.name} crashed.`);
+}).on("config:update", () => {
+  console.log(`Service ${project.name} nodemon config has changed.`);
+});

package/service/install.js

@@ -0,0 +1,59 @@
+#!/usr/bin/env node
+import { spawnSync } from "node:child_process";
+import { existsSync, rmSync, writeFileSync } from "node:fs";
+import { basename, resolve } from "node:path";
+
+import { config, getConfig } from "../lib/config.js";
+import { shellQuote } from "../lib/shellQuote.js";
+
+const { config: project } = getConfig(process.cwd());
+const ownName = basename(import.meta.url, '.js');
+const systemd = {
+  ...project.systemd,
+  Unit: {
+    Description: project.description,
+    After: ["network.target"],
+    ...project.systemd?.Unit
+  },
+  Service: {
+    Type: "simple",
+    ...project.systemd?.Service,
+    WorkingDirectory: project.root,
+    ExecStart: shellQuote(
+      resolve(config.root, "service/node"),
+      resolve(config.root, "service/index.js"),
+      resolve(project.root)
+    ),
+  },
+  Install: {
+    WantedBy: ["multi-user.target"],
+    ...project.systemd?.Install,
+  },
+};
+
+const serviceContent = Object.entries(systemd).map(
+  ([heading, values]) => [
+    `[${heading}]`,
+    ...Object.entries(values).map(([name, value]) =>
+      Array.isArray(value)
+        ? value.map((v) => `${name}=${v}`).join('\n')
+        : `${name}=${value}`
+    )
+  ].join('\n')
+).join('\n\n');
+
+const serviceFile = resolve(project.root, `${project.name}.service`);
+const systemdFile = resolve(process.env.HOME, '.config', 'systemd', 'user', `${project.name}.service`);
+
+writeFileSync(serviceFile, serviceContent, "utf8");
+
+if (existsSync(systemdFile)) {
+  if (!process.argv.includes('--force')) {
+    console.warn(`${systemdFile} already exists; use "npx ${config.name} ${ownName} --force" to overwrite`);
+    process.exit();
+  } else {
+    rmSync(systemdFile);
+    spawnSync('systemctl', ['--user', 'daemon-reload'], { stdio: "inherit" });
+  }
+}
+spawnSync('systemctl', ['--user', 'link', serviceFile], { stdio: "inherit" });

package/service/logs.js

@@ -0,0 +1,38 @@
+#!/usr/bin/env node
+import { resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+
+import { config, getConfig } from "../lib/config.js";
+import { shellQuote } from "../lib/shellQuote.js";
+import { jsonCmd } from "../lib/jsonCmd.js";
+
+const { config: project } = getConfig(process.cwd());
+
+const pad = (n, l = 2) => String(n).padStart(l, '0');
+
+const formatDateTime = (date) => {
+  const d = `${pad(date.getFullYear())}-${pad(date.getMonth() + 1)}-${pad(date.getDate())}`;
+  const g = date.getHours();
+  const h = g % 12 || 12;
+  const a = g < 12 ? 'a' : 'p';
+  const t = `${pad(h)}:${pad(date.getMinutes())}:${pad(date.getSeconds())}${a}`;
+  return `${d} ${t}`;
+}
+
+export const formatJournal = (line) => {
+  const time = parseInt(line.__REALTIME_TIMESTAMP.slice(0, -3));
+  const sym = line._TRANSPORT === 'stdout' ? ' > ' : '‼> ';
+  return `${formatDateTime(new Date(time))}${sym}${line.MESSAGE}`;
+}
+
+export function journalctl() {
+  const argv = ['journalctl', '--user-unit', project.name, '-o', 'json', '-e', '-f'];
+  console.info(`> ${shellQuote(argv)}`);
+  return jsonCmd(argv[0], argv.slice(1));
+}
+console.log(process.argv);
+if (fileURLToPath(import.meta.url) === resolve(process.argv[1])) {
+  for await (const line of journalctl(process.argv.slice(2))) {
+    console.log(formatJournal(line));
+  }
+}

package/service/node

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+if [[ -d "${HOME}/.nvm" ]]; then
+  export NVM_DIR="${HOME}/.nvm"
+  source "${NVM_DIR}/nvm.sh"
+  if [[ -f .nvmrc ]]; then
+    nvm install
+  else
+    nvm use default
+  fi
+fi
+NODE="$(command -v node)"
+if [[ -z "$NODE" ]]; then
+  echo "No node found.  Please install one.  User-level nvm is fine." >&2
+  exit -1
+fi 
+node $*

package/service/uninstall.js

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+import { spawnSync } from "node:child_process";
+import { existsSync, rmSync } from "node:fs";
+import { resolve } from "node:path";
+
+import { getConfig } from "../lib/config.js";
+
+const { config: project } = getConfig(process.cwd());
+
+const systemdFile = resolve(process.env.HOME, '.config', 'systemd', 'user', `${project.name}.service`);
+
+if (existsSync(systemdFile)) {
+    rmSync(systemdFile);
+    spawnSync('systemctl', ['--user', 'daemon-reload'], { stdio: "inherit" });
+    console.log(`Removed ${systemdFile}`);
+} else {
+  console.warn(`No service file at ${systemdFile}`);
+}