@nordbyte/nordrelay 0.8.1 → 0.8.3

package/plugins/nordrelay/scripts/service-installer.mjs

@@ -0,0 +1,183 @@
+import os from "node:os";
+import path from "node:path";
+import process from "node:process";
+import { fileURLToPath } from "node:url";
+
+const DEFAULT_SCRIPT_PATH = fileURLToPath(new URL("./nordrelay.mjs", import.meta.url));
+
+function requireValue(argv, index, flag) {
+  const value = argv[index];
+  if (!value || value.startsWith("-")) {
+    throw new Error(`${flag} requires a value`);
+  }
+  return value;
+}
+
+function parseServiceFlags(argv) {
+  const copy = [...argv];
+  const subcommand = copy[0] && !copy[0].startsWith("-") ? copy.shift() : "status";
+  const flags = {
+    subcommand,
+    start: true,
+    name: process.platform === "win32" ? "NordRelay" : "nordrelay",
+    label: "io.nordbyte.nordrelay",
+    dryRun: false,
+    platform: process.platform,
+  };
+  for (let i = 0; i < copy.length; i += 1) {
+    const arg = copy[i];
+    if (arg === "--no-start") flags.start = false;
+    else if (arg === "--dry-run") flags.dryRun = true;
+    else if (arg === "--platform") flags.platform = requireValue(copy, ++i, arg);
+    else if (arg === "--name") flags.name = requireValue(copy, ++i, arg);
+    else if (arg === "--label") flags.label = requireValue(copy, ++i, arg);
+  }
+  return flags;
+}
+
+function serviceRunArgs(options) {
+  const args = ["service-run", "--home", options.home];
+  if (options.host) args.push("--host", options.host);
+  if (options.port) args.push("--port", String(options.port));
+  return args;
+}
+
+function buildSystemdUserServiceSpec(options, flags) {
+  const scriptPath = options.scriptPath || DEFAULT_SCRIPT_PATH;
+  const unitPath = path.join(os.homedir(), ".config", "systemd", "user", `${flags.name}.service`);
+  const execStart = [process.execPath, scriptPath, ...serviceRunArgs(options)].map(systemdQuote).join(" ");
+  const content = [
+    "[Unit]",
+    "Description=NordRelay connector and WebUI",
+    "After=network-online.target",
+    "",
+    "[Service]",
+    "Type=simple",
+    `ExecStart=${execStart}`,
+    "Restart=on-failure",
+    "RestartSec=5",
+    `Environment=NORDRELAY_HOME=${systemdQuote(options.home)}`,
+    "",
+    "[Install]",
+    "WantedBy=default.target",
+    "",
+  ].join("\n");
+  const action = flags.start ? "enable --now" : "enable";
+  return {
+    platform: "linux",
+    path: unitPath,
+    content,
+    commands: [
+      { command: "systemctl", args: ["--user", "daemon-reload"], label: "Reload systemd user units" },
+      { command: "systemctl", args: ["--user", "enable", flags.start ? "--now" : "", `${flags.name}.service`].filter(Boolean), label: `systemctl --user ${action} ${flags.name}.service` },
+    ],
+  };
+}
+
+function buildLaunchdServiceSpec(options, flags) {
+  const scriptPath = options.scriptPath || DEFAULT_SCRIPT_PATH;
+  const plistPath = path.join(os.homedir(), "Library", "LaunchAgents", `${flags.label}.plist`);
+  const domain = launchdDomain();
+  const commands = [
+    { command: "launchctl", args: ["bootout", domain, plistPath], label: `Unload existing ${flags.label}`, settings: { allowFailure: true } },
+  ];
+  if (flags.start) {
+    commands.push(
+      { command: "launchctl", args: ["bootstrap", domain, plistPath], label: `Load ${flags.label}` },
+      { command: "launchctl", args: ["enable", `${domain}/${flags.label}`], label: `Enable ${flags.label}`, settings: { allowFailure: true } },
+      { command: "launchctl", args: ["kickstart", "-k", `${domain}/${flags.label}`], label: `Start ${flags.label}`, settings: { allowFailure: true } },
+    );
+  }
+  return {
+    platform: "darwin",
+    path: plistPath,
+    content: launchdPlist(flags.label, process.execPath, [scriptPath, ...serviceRunArgs(options)], options.home),
+    commands,
+  };
+}
+
+function buildWindowsTaskServiceSpec(options, flags) {
+  const scriptPath = options.scriptPath || DEFAULT_SCRIPT_PATH;
+  const taskCommand = windowsTaskCommand(process.execPath, [scriptPath, ...serviceRunArgs(options)]);
+  const commands = [
+    { command: "schtasks", args: ["/Create", "/F", "/SC", "ONLOGON", "/TN", flags.name, "/TR", taskCommand], label: `Create Windows task ${flags.name}` },
+  ];
+  if (flags.start) {
+    commands.push({ command: "schtasks", args: ["/Run", "/TN", flags.name], label: `Start Windows task ${flags.name}`, settings: { allowFailure: true } });
+  }
+  return {
+    platform: "win32",
+    path: flags.name,
+    content: "",
+    commands,
+  };
+}
+
+function serviceInstallSpec(options, flags) {
+  if (flags.platform === "darwin") return buildLaunchdServiceSpec(options, flags);
+  if (flags.platform === "win32") return buildWindowsTaskServiceSpec(options, flags);
+  return buildSystemdUserServiceSpec(options, flags);
+}
+
+function systemdQuote(value) {
+  return `"${String(value).replace(/\\/g, "\\\\").replace(/"/g, '\\"')}"`;
+}
+
+function launchdDomain() {
+  return `gui/${process.getuid?.() ?? ""}`;
+}
+
+function launchdPlist(label, command, args, home) {
+  const programArguments = [command, ...args]
+    .map((value) => `    <string>${xmlEscape(value)}</string>`)
+    .join("\n");
+  return [
+    "<?xml version=\"1.0\" encoding=\"UTF-8\"?>",
+    "<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">",
+    "<plist version=\"1.0\">",
+    "<dict>",
+    "  <key>Label</key>",
+    `  <string>${xmlEscape(label)}</string>`,
+    "  <key>ProgramArguments</key>",
+    "  <array>",
+    programArguments,
+    "  </array>",
+    "  <key>EnvironmentVariables</key>",
+    "  <dict>",
+    "    <key>NORDRELAY_HOME</key>",
+    `    <string>${xmlEscape(home)}</string>`,
+    "  </dict>",
+    "  <key>RunAtLoad</key>",
+    "  <true/>",
+    "  <key>KeepAlive</key>",
+    "  <true/>",
+    "  <key>StandardOutPath</key>",
+    `  <string>${xmlEscape(path.join(home, "service.log"))}</string>`,
+    "  <key>StandardErrorPath</key>",
+    `  <string>${xmlEscape(path.join(home, "service.log"))}</string>`,
+    "</dict>",
+    "</plist>",
+    "",
+  ].join("\n");
+}
+
+function windowsTaskCommand(command, args) {
+  return [command, ...args].map((part) => `"${String(part).replace(/"/g, '""')}"`).join(" ");
+}
+
+function xmlEscape(value) {
+  return String(value)
+    .replace(/&/g, "&amp;")
+    .replace(/</g, "&lt;")
+    .replace(/>/g, "&gt;")
+    .replace(/"/g, "&quot;")
+    .replace(/'/g, "&apos;");
+}
+
+export {
+  buildLaunchdServiceSpec,
+  buildSystemdUserServiceSpec,
+  buildWindowsTaskServiceSpec,
+  parseServiceFlags,
+  serviceInstallSpec,
+};

package/{launchd/start.sh → scripts/launchd-start.sh}

@@ -5,4 +5,4 @@ export PATH="${PATH:-/opt/homebrew/bin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/s
 : "${HOME:?Set HOME before starting nordrelay}"
 
 cd "${NORDRELAY_SOURCE_ROOT:-$HOME/projects/nordrelay}"
-exec node dist/index.js
+exec node plugins/nordrelay/scripts/nordrelay.mjs foreground

package/scripts/postinstall.mjs

@@ -0,0 +1,122 @@
+#!/usr/bin/env node
+import { execFileSync } from "node:child_process";
+import path from "node:path";
+
+const commandName = process.platform === "win32" ? "nordrelay.cmd" : "nordrelay";
+
+function isGlobalInstall() {
+  return process.env.NORDRELAY_POSTINSTALL_CHECK === "1"
+    || process.env.npm_config_global === "true"
+    || process.env.npm_config_location === "global";
+}
+
+function npmPrefix() {
+  const configured = process.env.npm_config_prefix;
+  if (configured) {
+    return configured;
+  }
+  const npmExec = process.env.npm_execpath || "npm";
+  try {
+    return execFileSync(npmExec, ["prefix", "-g"], {
+      encoding: "utf8",
+      shell: process.platform === "win32",
+      stdio: ["ignore", "pipe", "ignore"],
+    }).trim();
+  } catch {
+    return "";
+  }
+}
+
+function globalBinDir(prefix, platform = process.platform) {
+  if (!prefix) {
+    return "";
+  }
+  return platform === "win32" ? prefix : path.join(prefix, "bin");
+}
+
+function normalizePathEntry(entry, platform = process.platform) {
+  const resolved = path.resolve(entry);
+  return platform === "win32" || platform === "darwin" ? resolved.toLowerCase() : resolved;
+}
+
+function pathContains(dir, envPath = process.env.PATH || "", platform = process.platform) {
+  if (!dir) {
+    return false;
+  }
+  const wanted = normalizePathEntry(dir, platform);
+  return envPath
+    .split(path.delimiter)
+    .filter(Boolean)
+    .map((entry) => normalizePathEntry(entry, platform))
+    .includes(wanted);
+}
+
+function shellProfile(platform = process.platform, shell = process.env.SHELL || "") {
+  if (platform === "win32") {
+    return "";
+  }
+  if (platform === "darwin") {
+    return shell.endsWith("/bash") ? "~/.bash_profile" : "~/.zshrc";
+  }
+  return shell.endsWith("/zsh") ? "~/.zshrc" : "~/.bashrc";
+}
+
+function quote(value) {
+  return `"${String(value).replaceAll('"', '\\"')}"`;
+}
+
+function warning(prefix, binDir, platform = process.env.NORDRELAY_POSTINSTALL_PLATFORM || process.platform) {
+  const commandPath = path.join(binDir, commandName);
+  if (platform === "win32") {
+    return [
+      "",
+      "NordRelay installed, but the npm global bin directory is not in your PATH.",
+      'The `nordrelay` command may fail with "command not found".',
+      "",
+      `npm global bin: ${binDir}`,
+      "",
+      "Add it to your user PATH, then open a new terminal:",
+      `  [Environment]::SetEnvironmentVariable("Path", $env:Path + ";${binDir}", "User")`,
+      "",
+      "Or run NordRelay directly:",
+      `  & ${quote(commandPath)} init`,
+      "",
+    ].join("\n");
+  }
+
+  const profile = shellProfile(platform);
+  return [
+    "",
+    "NordRelay installed, but the npm global bin directory is not in your PATH.",
+    'The `nordrelay` command may fail with "command not found".',
+    "",
+    `npm global bin: ${binDir}`,
+    "",
+    `Add this to ${profile}:`,
+    `  export PATH=${quote(binDir + ":$PATH")}`,
+    "",
+    "Then reload your shell and initialize NordRelay:",
+    `  source ${profile}`,
+    "  nordrelay init",
+    "",
+    "Or run NordRelay directly:",
+    `  ${quote(commandPath)} init`,
+    "",
+    prefix ? "" : "If the npm prefix could not be detected, run `npm prefix -g` and add its bin directory to PATH.",
+  ].filter(Boolean).join("\n");
+}
+
+function main() {
+  if (!isGlobalInstall()) {
+    return;
+  }
+  const prefix = npmPrefix();
+  const platform = process.env.NORDRELAY_POSTINSTALL_PLATFORM || process.platform;
+  const binDir = globalBinDir(prefix, platform);
+  if (!binDir || pathContains(binDir, process.env.PATH || "", platform)) {
+    return;
+  }
+  console.warn(warning(prefix, binDir, platform));
+}
+
+main();