@naviyra/cloud-panel 0.0.3-beta2 → 0.0.3-beta3

package/scripts/windows-boot.mjs

@@ -1,259 +1,259 @@
-import { spawn } from "node:child_process";
-import { mkdir, readFile } from "node:fs/promises";
-import { fileURLToPath } from "node:url";
-import path from "node:path";
-import { setTimeout as delay } from "node:timers/promises";
-
-export const TASK_NAME = "Naviyra Cloud Panel";
-
-const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "..");
-
-export function psQuote(value) {
-  return `'${String(value).replaceAll("'", "''")}'`;
-}
-
-export function panelOrigin(envText) {
-  const match = String(envText).match(/^PANEL_PORT=(.*)$/m);
-  const port = Number((match?.[1] ?? "3000").trim());
-  if (!Number.isInteger(port) || port < 1 || port > 65535)
-    return "http://127.0.0.1:3000";
-  return `http://127.0.0.1:${port}`;
-}
-
-export function registrationScript({
-  taskName = TASK_NAME,
-  nodePath,
-  scriptPath,
-  workingDirectory,
-  userId,
-  mode,
-}) {
-  const triggers =
-    mode === "boot"
-      ? `$startup = New-ScheduledTaskTrigger -AtStartup
-$startup.Delay = 'PT30S'
-$logon = New-ScheduledTaskTrigger -AtLogOn -User $user
-$triggers = @($startup, $logon)
-$principal = New-ScheduledTaskPrincipal -UserId $user -LogonType S4U -RunLevel Limited`
-      : `$triggers = New-ScheduledTaskTrigger -AtLogOn -User $user
-$principal = New-ScheduledTaskPrincipal -UserId $user -LogonType Interactive -RunLevel Limited`;
-  return `$ErrorActionPreference = 'Stop'
-$node = ${psQuote(nodePath)}
-$script = ${psQuote(scriptPath)}
-$workdir = ${psQuote(workingDirectory)}
-$user = ${psQuote(userId)}
-$task = ${psQuote(taskName)}
-$action = New-ScheduledTaskAction -Execute $node -Argument ('"' + $script + '"') -WorkingDirectory $workdir
-$settings = New-ScheduledTaskSettingsSet -AllowStartIfOnBatteries -DontStopIfGoingOnBatteries -StartWhenAvailable -MultipleInstances IgnoreNew -RestartCount 999 -RestartInterval (New-TimeSpan -Minutes 1) -ExecutionTimeLimit (New-TimeSpan -Seconds 0)
-${triggers}
-Register-ScheduledTask -TaskName $task -Action $action -Trigger $triggers -Settings $settings -Principal $principal -Force | Out-Null
-Write-Output 'REGISTERED ${mode}'
-`;
-}
-
-function taskScript(command, taskName = TASK_NAME) {
-  const task = psQuote(taskName);
-  if (command === "start")
-    return `$ErrorActionPreference = 'Stop'
-try { Start-ScheduledTask -TaskName ${task} }
-catch {
-  if ($_.Exception.Message -match 'already running|currently running') { exit 0 }
-  throw
-}
-Write-Output 'STARTED'
-`;
-  if (command === "stop")
-    return `Stop-ScheduledTask -TaskName ${task} -ErrorAction SilentlyContinue
-Write-Output 'STOPPED'
-`;
-  return `Unregister-ScheduledTask -TaskName ${task} -Confirm:$false -ErrorAction SilentlyContinue
-Write-Output 'REMOVED'
-`;
-}
-
-export function runPowerShell(script) {
-  return new Promise((resolve) => {
-    const child = spawn(
-      "powershell.exe",
-      ["-NoProfile", "-ExecutionPolicy", "Bypass", "-Command", script],
-      { windowsHide: true, stdio: ["ignore", "pipe", "pipe"] },
-    );
-    let output = "";
-    child.stdout?.on("data", (chunk) => {
-      output += chunk;
-    });
-    child.stderr?.on("data", (chunk) => {
-      output += chunk;
-    });
-    child.once("error", (error) => resolve({ code: 1, output: error.message }));
-    child.once("exit", (code) => resolve({ code: code ?? 1, output }));
-  });
-}
-
-function windowsUser() {
-  return new Promise((resolve) => {
-    const child = spawn("whoami.exe", [], {
-      windowsHide: true,
-      stdio: ["ignore", "pipe", "pipe"],
-    });
-    let output = "";
-    child.stdout?.on("data", (chunk) => {
-      output += chunk;
-    });
-    child.once("error", () => resolve(""));
-    child.once("exit", (code) => resolve(code === 0 ? output.trim() : ""));
-  });
-}
-
-export async function installBootTask(options = {}) {
-  const installRoot = options.root ?? root;
-  const nodePath = options.nodePath ?? process.execPath;
-  const userId = options.userId ?? (await windowsUser());
-  const run = options.runPowerShell ?? runPowerShell;
-  if (!userId)
-    return { ok: false, message: "Could not determine the Windows account for the startup task." };
-  const scriptPath = path.join(installRoot, "scripts", "service-supervisor.mjs");
-  let last = "Task Scheduler did not accept the startup task.";
-  for (const mode of ["boot", "logon"]) {
-    const result = await run(
-      registrationScript({
-        nodePath,
-        scriptPath,
-        workingDirectory: installRoot,
-        userId,
-        mode,
-      }),
-    );
-    if (result.code === 0 && result.output.includes(`REGISTERED ${mode}`)) {
-      const message =
-        mode === "boot"
-          ? `Registered "${TASK_NAME}" to start at Windows boot as ${userId} and restart if it stops.`
-          : `Registered "${TASK_NAME}" to start when ${userId} signs in and restart if it stops.`;
-      return { ok: true, mode, message };
-    }
-    last = result.output.trim() || last;
-  }
-  return { ok: false, message: last };
-}
-
-export async function startBootTask(run = runPowerShell) {
-  const result = await run(taskScript("start"));
-  if (result.code === 0) return { ok: true };
-  return { ok: false, message: result.output.trim() };
-}
-
-async function servicePid(installRoot) {
-  try {
-    const pid = Number(
-      await readFile(path.join(installRoot, ".runtime", "service.pid"), "utf8"),
-    );
-    return Number.isInteger(pid) && pid > 0 ? pid : 0;
-  } catch {
-    return 0;
-  }
-}
-
-function taskkill(pid) {
-  return new Promise((resolve) => {
-    const child = spawn("taskkill.exe", ["/PID", String(pid), "/T", "/F"], {
-      windowsHide: true,
-      stdio: "ignore",
-    });
-    child.once("error", resolve);
-    child.once("exit", resolve);
-  });
-}
-
-export async function stopBootTask(options = {}) {
-  const run = options.runPowerShell ?? runPowerShell;
-  const installRoot = options.root ?? root;
-  const pid = await servicePid(installRoot);
-  if (pid && process.platform === "win32") await taskkill(pid);
-  const result = await run(taskScript("stop"));
-  return { ok: result.code === 0, message: result.output.trim() };
-}
-
-export async function removeBootTask(options = {}) {
-  const run = options.runPowerShell ?? runPowerShell;
-  await stopBootTask({ ...options, runPowerShell: run });
-  const result = await run(taskScript("remove"));
-  return {
-    ok: result.code === 0,
-    message:
-      result.code === 0
-        ? `Removed the "${TASK_NAME}" startup task.`
-        : result.output.trim(),
-  };
-}
-
-export async function openPanelWhenReady(installRoot = root) {
-  let envText = "";
-  try {
-    envText = await readFile(path.join(installRoot, ".env"), "utf8");
-  } catch {
-    envText = "";
-  }
-  const origin = panelOrigin(envText);
-  for (let attempt = 0; attempt < 300; attempt++) {
-    try {
-      const response = await fetch(`${origin}/api/me`, {
-        redirect: "manual",
-        signal: AbortSignal.timeout(2000),
-      });
-      const body = await response.json();
-      if (response.status === 401 && body.error === "Please sign in") {
-        const browser = spawn("explorer.exe", [origin], {
-          windowsHide: true,
-          stdio: "ignore",
-        });
-        browser.once("error", () => {});
-        browser.unref();
-        console.log(`Naviyra is ready: ${origin}`);
-        return;
-      }
-    } catch {
-      // The panel build can take several minutes on first start.
-    }
-    await delay(1000);
-  }
-  console.log(
-    `Naviyra is still starting. Open ${origin} when it is ready. Progress is in .runtime/service.log.`,
-  );
-}
-
-async function main() {
-  const command = process.argv[2] || "install";
-  if (!["install", "start", "stop", "remove"].includes(command))
-    throw Error("Usage: node scripts/windows-boot.mjs install|start|stop|remove");
-  if (process.platform !== "win32")
-    throw Error("The Naviyra startup task is only registered on Windows.");
-  await mkdir(path.join(root, ".runtime"), { recursive: true });
-  if (command === "install") {
-    const installed = await installBootTask({ root });
-    if (!installed.ok) throw Error(installed.message);
-    console.log(installed.message);
-    const started = await startBootTask();
-    if (!started.ok) throw Error(started.message || "Could not start the task.");
-    console.log("Naviyra is starting in the background.");
-    return;
-  }
-  if (command === "start") {
-    const started = await startBootTask();
-    if (!started.ok) throw Error(started.message || "Could not start the task.");
-    console.log("Naviyra startup task is running.");
-    return;
-  }
-  const result =
-    command === "stop"
-      ? await stopBootTask({ root })
-      : await removeBootTask({ root });
-  if (!result.ok) throw Error(result.message || `Could not ${command} the task.`);
-  console.log(result.message || `Naviyra startup task ${command} complete.`);
-}
-
-if (process.argv[1] && path.resolve(process.argv[1]) === fileURLToPath(import.meta.url)) {
-  main().catch((error) => {
-    console.error(error.message);
-    process.exitCode = 1;
-  });
-}
+import { spawn } from "node:child_process";
+import { mkdir, readFile } from "node:fs/promises";
+import { fileURLToPath } from "node:url";
+import path from "node:path";
+import { setTimeout as delay } from "node:timers/promises";
+
+export const TASK_NAME = "Naviyra Cloud Panel";
+
+const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "..");
+
+export function psQuote(value) {
+  return `'${String(value).replaceAll("'", "''")}'`;
+}
+
+export function panelOrigin(envText) {
+  const match = String(envText).match(/^PANEL_PORT=(.*)$/m);
+  const port = Number((match?.[1] ?? "3000").trim());
+  if (!Number.isInteger(port) || port < 1 || port > 65535)
+    return "http://127.0.0.1:3000";
+  return `http://127.0.0.1:${port}`;
+}
+
+export function registrationScript({
+  taskName = TASK_NAME,
+  nodePath,
+  scriptPath,
+  workingDirectory,
+  userId,
+  mode,
+}) {
+  const triggers =
+    mode === "boot"
+      ? `$startup = New-ScheduledTaskTrigger -AtStartup
+$startup.Delay = 'PT30S'
+$logon = New-ScheduledTaskTrigger -AtLogOn -User $user
+$triggers = @($startup, $logon)
+$principal = New-ScheduledTaskPrincipal -UserId $user -LogonType S4U -RunLevel Limited`
+      : `$triggers = New-ScheduledTaskTrigger -AtLogOn -User $user
+$principal = New-ScheduledTaskPrincipal -UserId $user -LogonType Interactive -RunLevel Limited`;
+  return `$ErrorActionPreference = 'Stop'
+$node = ${psQuote(nodePath)}
+$script = ${psQuote(scriptPath)}
+$workdir = ${psQuote(workingDirectory)}
+$user = ${psQuote(userId)}
+$task = ${psQuote(taskName)}
+$action = New-ScheduledTaskAction -Execute $node -Argument ('"' + $script + '"') -WorkingDirectory $workdir
+$settings = New-ScheduledTaskSettingsSet -AllowStartIfOnBatteries -DontStopIfGoingOnBatteries -StartWhenAvailable -MultipleInstances IgnoreNew -RestartCount 999 -RestartInterval (New-TimeSpan -Minutes 1) -ExecutionTimeLimit (New-TimeSpan -Seconds 0)
+${triggers}
+Register-ScheduledTask -TaskName $task -Action $action -Trigger $triggers -Settings $settings -Principal $principal -Force | Out-Null
+Write-Output 'REGISTERED ${mode}'
+`;
+}
+
+function taskScript(command, taskName = TASK_NAME) {
+  const task = psQuote(taskName);
+  if (command === "start")
+    return `$ErrorActionPreference = 'Stop'
+try { Start-ScheduledTask -TaskName ${task} }
+catch {
+  if ($_.Exception.Message -match 'already running|currently running') { exit 0 }
+  throw
+}
+Write-Output 'STARTED'
+`;
+  if (command === "stop")
+    return `Stop-ScheduledTask -TaskName ${task} -ErrorAction SilentlyContinue
+Write-Output 'STOPPED'
+`;
+  return `Unregister-ScheduledTask -TaskName ${task} -Confirm:$false -ErrorAction SilentlyContinue
+Write-Output 'REMOVED'
+`;
+}
+
+export function runPowerShell(script) {
+  return new Promise((resolve) => {
+    const child = spawn(
+      "powershell.exe",
+      ["-NoProfile", "-ExecutionPolicy", "Bypass", "-Command", script],
+      { windowsHide: true, stdio: ["ignore", "pipe", "pipe"] },
+    );
+    let output = "";
+    child.stdout?.on("data", (chunk) => {
+      output += chunk;
+    });
+    child.stderr?.on("data", (chunk) => {
+      output += chunk;
+    });
+    child.once("error", (error) => resolve({ code: 1, output: error.message }));
+    child.once("exit", (code) => resolve({ code: code ?? 1, output }));
+  });
+}
+
+function windowsUser() {
+  return new Promise((resolve) => {
+    const child = spawn("whoami.exe", [], {
+      windowsHide: true,
+      stdio: ["ignore", "pipe", "pipe"],
+    });
+    let output = "";
+    child.stdout?.on("data", (chunk) => {
+      output += chunk;
+    });
+    child.once("error", () => resolve(""));
+    child.once("exit", (code) => resolve(code === 0 ? output.trim() : ""));
+  });
+}
+
+export async function installBootTask(options = {}) {
+  const installRoot = options.root ?? root;
+  const nodePath = options.nodePath ?? process.execPath;
+  const userId = options.userId ?? (await windowsUser());
+  const run = options.runPowerShell ?? runPowerShell;
+  if (!userId)
+    return { ok: false, message: "Could not determine the Windows account for the startup task." };
+  const scriptPath = path.join(installRoot, "scripts", "service-supervisor.mjs");
+  let last = "Task Scheduler did not accept the startup task.";
+  for (const mode of ["boot", "logon"]) {
+    const result = await run(
+      registrationScript({
+        nodePath,
+        scriptPath,
+        workingDirectory: installRoot,
+        userId,
+        mode,
+      }),
+    );
+    if (result.code === 0 && result.output.includes(`REGISTERED ${mode}`)) {
+      const message =
+        mode === "boot"
+          ? `Registered "${TASK_NAME}" to start at Windows boot as ${userId} and restart if it stops.`
+          : `Registered "${TASK_NAME}" to start when ${userId} signs in and restart if it stops.`;
+      return { ok: true, mode, message };
+    }
+    last = result.output.trim() || last;
+  }
+  return { ok: false, message: last };
+}
+
+export async function startBootTask(run = runPowerShell) {
+  const result = await run(taskScript("start"));
+  if (result.code === 0) return { ok: true };
+  return { ok: false, message: result.output.trim() };
+}
+
+async function servicePid(installRoot) {
+  try {
+    const pid = Number(
+      await readFile(path.join(installRoot, ".runtime", "service.pid"), "utf8"),
+    );
+    return Number.isInteger(pid) && pid > 0 ? pid : 0;
+  } catch {
+    return 0;
+  }
+}
+
+function taskkill(pid) {
+  return new Promise((resolve) => {
+    const child = spawn("taskkill.exe", ["/PID", String(pid), "/T", "/F"], {
+      windowsHide: true,
+      stdio: "ignore",
+    });
+    child.once("error", resolve);
+    child.once("exit", resolve);
+  });
+}
+
+export async function stopBootTask(options = {}) {
+  const run = options.runPowerShell ?? runPowerShell;
+  const installRoot = options.root ?? root;
+  const pid = await servicePid(installRoot);
+  if (pid && process.platform === "win32") await taskkill(pid);
+  const result = await run(taskScript("stop"));
+  return { ok: result.code === 0, message: result.output.trim() };
+}
+
+export async function removeBootTask(options = {}) {
+  const run = options.runPowerShell ?? runPowerShell;
+  await stopBootTask({ ...options, runPowerShell: run });
+  const result = await run(taskScript("remove"));
+  return {
+    ok: result.code === 0,
+    message:
+      result.code === 0
+        ? `Removed the "${TASK_NAME}" startup task.`
+        : result.output.trim(),
+  };
+}
+
+export async function openPanelWhenReady(installRoot = root) {
+  let envText = "";
+  try {
+    envText = await readFile(path.join(installRoot, ".env"), "utf8");
+  } catch {
+    envText = "";
+  }
+  const origin = panelOrigin(envText);
+  for (let attempt = 0; attempt < 300; attempt++) {
+    try {
+      const response = await fetch(`${origin}/api/me`, {
+        redirect: "manual",
+        signal: AbortSignal.timeout(2000),
+      });
+      const body = await response.json();
+      if (response.status === 401 && body.error === "Please sign in") {
+        const browser = spawn("explorer.exe", [origin], {
+          windowsHide: true,
+          stdio: "ignore",
+        });
+        browser.once("error", () => {});
+        browser.unref();
+        console.log(`Naviyra is ready: ${origin}`);
+        return;
+      }
+    } catch {
+      // The panel build can take several minutes on first start.
+    }
+    await delay(1000);
+  }
+  console.log(
+    `Naviyra is still starting. Open ${origin} when it is ready. Progress is in .runtime/service.log.`,
+  );
+}
+
+async function main() {
+  const command = process.argv[2] || "install";
+  if (!["install", "start", "stop", "remove"].includes(command))
+    throw Error("Usage: node scripts/windows-boot.mjs install|start|stop|remove");
+  if (process.platform !== "win32")
+    throw Error("The Naviyra startup task is only registered on Windows.");
+  await mkdir(path.join(root, ".runtime"), { recursive: true });
+  if (command === "install") {
+    const installed = await installBootTask({ root });
+    if (!installed.ok) throw Error(installed.message);
+    console.log(installed.message);
+    const started = await startBootTask();
+    if (!started.ok) throw Error(started.message || "Could not start the task.");
+    console.log("Naviyra is starting in the background.");
+    return;
+  }
+  if (command === "start") {
+    const started = await startBootTask();
+    if (!started.ok) throw Error(started.message || "Could not start the task.");
+    console.log("Naviyra startup task is running.");
+    return;
+  }
+  const result =
+    command === "stop"
+      ? await stopBootTask({ root })
+      : await removeBootTask({ root });
+  if (!result.ok) throw Error(result.message || `Could not ${command} the task.`);
+  console.log(result.message || `Naviyra startup task ${command} complete.`);
+}
+
+if (process.argv[1] && path.resolve(process.argv[1]) === fileURLToPath(import.meta.url)) {
+  main().catch((error) => {
+    console.error(error.message);
+    process.exitCode = 1;
+  });
+}