@geekbeer/minion 2.73.0 → 3.4.7

package/win/lib/process-manager.js

@@ -1,10 +1,9 @@
 /**
- * Windows Process Manager
+ * Windows Process Manager (NSSM-based)
  *
- * Detects process management mode and builds allowed commands.
- * Supports: NSSM (legacy), sc.exe (legacy), user-process (default).
- * User-process mode uses PID file + start-agent.ps1 for management
- * and does not require administrator privileges.
+ * Uses NSSM (Non-Sucking Service Manager) for Windows Service management.
+ * Requires administrator privileges for service control.
+ * NSSM binary is bundled at win/vendor/nssm.exe.
  */
 
 const { execSync } = require('child_process')
@@ -13,53 +12,41 @@ const path = require('path')
 const os = require('os')
 
 /**
- * Detect Windows process manager.
- * Prefers user-process mode (no admin). Falls back to NSSM/sc for legacy installs.
- * @returns {'user-process' | 'nssm' | 'sc'}
+ * Get the absolute path to nssm.exe.
+ * Checks bundled vendor location first, then PATH.
+ * @returns {string} Path to nssm.exe
  */
-function detectProcessManager() {
-  // Check for user-process mode (PID file or start-agent.ps1 exists)
-  const dataDir = path.join(os.homedir(), '.minion')
-  const startScript = path.join(dataDir, 'start-agent.ps1')
-  if (fs.existsSync(startScript)) {
-    return 'user-process'
-  }
+function getNssmPath() {
+  // 1. Bundled in npm package: win/vendor/nssm.exe
+  const vendorNssm = path.join(__dirname, '..', 'vendor', 'nssm.exe')
+  if (fs.existsSync(vendorNssm)) return vendorNssm
 
-  // Legacy: check NSSM
+  // 2. Installed to data dir (legacy or manual)
+  const dataDirNssm = path.join(os.homedir(), '.minion', 'nssm.exe')
+  if (fs.existsSync(dataDirNssm)) return dataDirNssm
+
+  // 3. On PATH
   try {
     execSync('nssm version', { stdio: 'ignore', timeout: 5000 })
     return 'nssm'
-  } catch { /* not installed */ }
+  } catch { /* not on PATH */ }
 
-  // Legacy: check sc.exe service
-  try {
-    execSync('sc query minion-agent', { stdio: 'ignore', timeout: 5000 })
-    return 'sc'
-  } catch { /* not available */ }
-
-  return 'user-process'
+  // Fallback: return vendor path (will fail with clear error if missing)
+  return vendorNssm
 }
 
 /**
- * Generate a temporary PowerShell script that:
- * 1. Stops the running agent process (releasing file locks)
- * 2. Runs npm install -g
- * 3. Restarts the agent
- *
- * This is necessary because node-pty's conpty.node DLL is locked by the
- * running process, causing EBUSY errors if npm tries to overwrite it in-place.
- *
- * @param {string} npmInstallCmd - The npm install command to run
- * @param {string} stopCmd - Command/script block to stop the agent
- * @param {string} startCmd - Command/script block to start the agent
- * @returns {string} - Path to the generated update script (.ps1)
+ * Detect Windows process manager. Always returns 'nssm'.
+ * @returns {'nssm'}
  */
+function detectProcessManager() {
+  return 'nssm'
+}
+
 /**
  * Generate a PowerShell snippet that requests graceful shutdown via the agent's
- * HTTP API, then falls back to force-kill. This mirrors Linux's SIGTERM behavior:
- * the agent runs shutdown() → sends offline heartbeat → exits cleanly.
- *
- * Windows has no SIGTERM for console processes, so we use HTTP instead.
+ * HTTP API, then falls back to NSSM stop. This ensures the agent sends an
+ * offline heartbeat to HQ before stopping.
  *
  * @param {number} agentPort - The agent's HTTP port (default 8080)
  * @param {string} apiToken - The agent's API token for authentication
@@ -73,60 +60,55 @@ function buildGracefulStopBlock(agentPort, apiToken) {
     `    Log 'Graceful shutdown requested, waiting for offline heartbeat...'`,
     `    Start-Sleep -Seconds 4`,
     `  } catch {`,
-    `    Log "Graceful shutdown API failed: $_ (will force kill)"`,
+    `    Log "Graceful shutdown API failed: $_ (will use nssm stop)"`,
     `  }`,
   ].join('\n')
 }
 
 /**
- * Apply self-PID exclusion to a stopCmd so that the detached script
- * does not kill itself when enumerating child processes.
- */
-function makeSafeStopCmd(stopCmd) {
-  return stopCmd.replace(
-    /ForEach-Object\s*\{\s*Stop-Process/,
-    'Where-Object { $_.ProcessId -ne $PID } | ForEach-Object { Stop-Process'
-  )
-}
-
-/**
- * Generate a temporary PowerShell restart script that:
- * 1. Requests graceful shutdown via HTTP API (sends offline heartbeat)
- * 2. Force-kills remaining processes (fallback)
- * 3. Restarts the agent
+ * Generate a temporary PowerShell script for updating the agent:
+ * 1. Graceful shutdown via HTTP API (offline heartbeat)
+ * 2. Stop service via NSSM
+ * 3. Run npm install -g
+ * 4. Start service via NSSM
  *
- * @param {string} stopCmd - Command/script block to force-stop the agent
- * @param {string} startCmd - Command/script block to start the agent
+ * @param {string} npmInstallCmd - The npm install command to run
+ * @param {string} nssmPath - Absolute path to nssm.exe
+ * @param {string} scriptName - Base name for the .ps1 and .log files
  * @param {number} agentPort - The agent's HTTP port
  * @param {string} apiToken - The agent's API token
- * @returns {string} - Path to the generated restart script (.ps1)
+ * @returns {string} - Path to the generated update script (.ps1)
  */
-function buildRestartScript(stopCmd, startCmd, agentPort, apiToken) {
+function buildUpdateScript(npmInstallCmd, nssmPath, scriptName = 'update-agent', agentPort = 8080, apiToken = '') {
   const dataDir = path.join(os.homedir(), '.minion')
-  const scriptPath = path.join(dataDir, 'restart-agent.ps1')
-  const logPath = path.join(dataDir, 'restart-agent.log')
+  const scriptPath = path.join(dataDir, `${scriptName}.ps1`)
+  const logPath = path.join(dataDir, `${scriptName}.log`)
+  const nssm = nssmPath.replace(/\\/g, '\\\\')
 
-  const safeStopCmd = makeSafeStopCmd(stopCmd)
   const gracefulStop = buildGracefulStopBlock(agentPort, apiToken)
 
   const ps1 = [
     `$ErrorActionPreference = 'Stop'`,
     `$logFile = '${logPath.replace(/\\/g, '\\\\')}'`,
     `function Log($msg) { "$(Get-Date -Format o) $msg" | Out-File -Append $logFile }`,
-    `Log 'Restart started'`,
+    `Log 'Update started'`,
     `try {`,
     `  Log 'Requesting graceful shutdown...'`,
     gracefulStop,
-    `  Log 'Force stopping remaining processes...'`,
-    `  ${safeStopCmd}`,
-    `  Start-Sleep -Seconds 2`,
-    `  Log 'Starting agent...'`,
-    `  ${startCmd}`,
-    `  Log 'Restart completed successfully'`,
+    `  Log 'Stopping service via NSSM...'`,
+    `  & '${nssm}' stop minion-agent`,
+    `  Start-Sleep -Seconds 3`,
+    `  Log 'Installing package...'`,
+    `  $out = & cmd /c "${npmInstallCmd} 2>&1"`,
+    `  Log "npm output: $out"`,
+    `  if ($LASTEXITCODE -ne 0) { throw "npm install failed (exit code $LASTEXITCODE)" }`,
+    `  Log 'Starting service...'`,
+    `  & '${nssm}' start minion-agent`,
+    `  Log 'Update completed successfully'`,
     `} catch {`,
-    `  Log "Restart failed: $_"`,
-    `  Log 'Attempting to start agent anyway...'`,
-    `  ${startCmd}`,
+    `  Log "Update failed: $_"`,
+    `  Log 'Attempting to start service anyway...'`,
+    `  & '${nssm}' start minion-agent`,
     `}`,
   ].join('\n')
 
@@ -137,187 +119,99 @@ function buildRestartScript(stopCmd, startCmd, agentPort, apiToken) {
 }
 
 /**
- * Generate a temporary PowerShell script that:
- * 1. Requests graceful shutdown via HTTP API (sends offline heartbeat)
- * 2. Force-kills remaining processes (releases DLL file locks)
- * 3. Runs npm install -g
- * 4. Restarts the agent
- *
- * The force-kill after graceful shutdown is necessary because node-pty's
- * conpty.node DLL is locked by the running process, causing EBUSY errors
- * if npm tries to overwrite it in-place.
+ * Generate a temporary PowerShell restart script:
+ * 1. Graceful shutdown via HTTP API (offline heartbeat)
+ * 2. Restart service via NSSM
  *
- * @param {string} npmInstallCmd - The npm install command to run
- * @param {string} stopCmd - Command/script block to stop the agent
- * @param {string} startCmd - Command/script block to start the agent
- * @param {string} scriptName - Base name for the .ps1 and .log files
+ * @param {string} nssmPath - Absolute path to nssm.exe
  * @param {number} agentPort - The agent's HTTP port
  * @param {string} apiToken - The agent's API token
- * @returns {string} - Path to the generated update script (.ps1)
+ * @returns {string} - Path to the generated restart script (.ps1)
  */
-function buildUpdateScript(npmInstallCmd, stopCmd, startCmd, scriptName = 'update-agent', agentPort = 8080, apiToken = '') {
+function buildRestartScript(nssmPath, agentPort, apiToken) {
   const dataDir = path.join(os.homedir(), '.minion')
-  const scriptPath = path.join(dataDir, `${scriptName}.ps1`)
-  const logPath = path.join(dataDir, `${scriptName}.log`)
+  const scriptPath = path.join(dataDir, 'restart-agent.ps1')
+  const logPath = path.join(dataDir, 'restart-agent.log')
+  const nssm = nssmPath.replace(/\\/g, '\\\\')
 
-  const safeStopCmd = makeSafeStopCmd(stopCmd)
   const gracefulStop = buildGracefulStopBlock(agentPort, apiToken)
 
   const ps1 = [
     `$ErrorActionPreference = 'Stop'`,
     `$logFile = '${logPath.replace(/\\/g, '\\\\')}'`,
     `function Log($msg) { "$(Get-Date -Format o) $msg" | Out-File -Append $logFile }`,
-    `Log 'Update started'`,
+    `Log 'Restart started'`,
     `try {`,
     `  Log 'Requesting graceful shutdown...'`,
     gracefulStop,
-    `  Log 'Force stopping remaining processes...'`,
-    `  ${safeStopCmd}`,
-    `  Start-Sleep -Seconds 3`,
-    `  Log 'Installing package...'`,
-    `  $out = & cmd /c "${npmInstallCmd} 2>&1"`,
-    `  Log "npm output: $out"`,
-    `  if ($LASTEXITCODE -ne 0) { throw "npm install failed (exit code $LASTEXITCODE)" }`,
-    `  Log 'Starting agent...'`,
-    `  ${startCmd}`,
-    `  Log 'Update completed successfully'`,
+    `  Log 'Restarting service via NSSM...'`,
+    `  & '${nssm}' restart minion-agent`,
+    `  Log 'Restart completed successfully'`,
     `} catch {`,
-    `  Log "Update failed: $_"`,
-    `  Log 'Attempting to restart agent anyway...'`,
-    `  ${startCmd}`,
+    `  Log "Restart failed: $_"`,
+    `  Log 'Attempting to start service...'`,
+    `  & '${nssm}' start minion-agent`,
     `}`,
   ].join('\n')
 
-  // Write the script to disk
   try { fs.mkdirSync(dataDir, { recursive: true }) } catch { /* exists */ }
   fs.writeFileSync(scriptPath, ps1, 'utf-8')
 
-  // Return script path — caller uses spawn() with detached:true to launch it,
-  // avoiding cmd.exe quoting issues and -WindowStyle Hidden hangs in non-interactive sessions.
   return scriptPath
 }
 
 /**
- * Build allowed commands for the detected process manager.
- * @param {string} procMgr - Process manager type
- * @param {{ AGENT_PORT?: number, API_TOKEN?: string }} [agentConfig] - Agent config for graceful shutdown
- * @returns {Record<string, { description: string; command: string; deferred?: boolean }>}
+ * Build allowed commands for NSSM-based service management.
+ * @param {string} _procMgr - Ignored (always 'nssm')
+ * @param {{ AGENT_PORT?: number, API_TOKEN?: string }} [agentConfig] - Agent config
+ * @returns {Record<string, { description: string; command?: string; spawnArgs?: [string, string[]]; deferred?: boolean }>}
  */
-function buildAllowedCommands(procMgr, agentConfig = {}) {
+function buildAllowedCommands(_procMgr, agentConfig = {}) {
   const commands = {}
   const agentPort = agentConfig.AGENT_PORT || 8080
   const apiToken = agentConfig.API_TOKEN || ''
+  const nssmPath = getNssmPath()
 
-  if (procMgr === 'user-process') {
-    const dataDir = path.join(os.homedir(), '.minion')
-    const pidFile = path.join(dataDir, 'minion-agent.pid')
-    const startScript = path.join(dataDir, 'start-agent.ps1')
-
-    const stopBlock = `$agentPid = Get-Content '${pidFile}' -ErrorAction SilentlyContinue; if ($agentPid) { Get-CimInstance Win32_Process -Filter ('ParentProcessId = ' + $agentPid) -ErrorAction SilentlyContinue | ForEach-Object { Stop-Process -Id $_.ProcessId -Force -ErrorAction SilentlyContinue }; Stop-Process -Id $agentPid -Force -ErrorAction SilentlyContinue }`
-    const startBlock = `Start-Process powershell -ArgumentList ('-ExecutionPolicy Bypass -WindowStyle Hidden -File \"' + '${startScript}' + '\"') -WindowStyle Hidden`
+  commands['restart-agent'] = {
+    description: 'Restart the minion agent service',
+    spawnArgs: ['powershell', ['-NoProfile', '-ExecutionPolicy', 'Bypass', '-Command',
+      `& '${buildRestartScript(nssmPath, agentPort, apiToken)}'`]],
+    deferred: true,
+  }
 
-    commands['restart-agent'] = {
-      description: 'Restart the minion agent process',
-      spawnArgs: ['powershell', ['-NoProfile', '-ExecutionPolicy', 'Bypass', '-Command',
-        `& '${buildRestartScript(stopBlock, startBlock, agentPort, apiToken)}'`]],
-      deferred: true,
-    }
-    commands['update-agent'] = {
-      description: 'Update @geekbeer/minion to latest version and restart',
-      spawnArgs: ['powershell', ['-NoProfile', '-ExecutionPolicy', 'Bypass', '-Command',
-        `& '${buildUpdateScript(
-          'npm install -g @geekbeer/minion@latest',
-          stopBlock, startBlock, 'update-agent', agentPort, apiToken,
-        )}'`]],
-      deferred: true,
-    }
-    commands['update-agent-dev'] = {
-      description: 'Update @geekbeer/minion from Verdaccio (dev) and restart',
-      spawnArgs: ['powershell', ['-NoProfile', '-ExecutionPolicy', 'Bypass', '-Command',
-        `& '${buildUpdateScript(
-          'npm install -g @geekbeer/minion@latest --registry http://verdaccio:4873',
-          stopBlock, startBlock, 'update-agent-dev', agentPort, apiToken,
-        )}'`]],
-      deferred: true,
-    }
-    commands['status-services'] = {
-      description: 'Show agent process info',
-      command: `powershell -Command "$pidFile = '${pidFile}'; if (Test-Path $pidFile) { $agentPid = (Get-Content $pidFile -Raw).Trim(); $proc = Get-Process -Id $agentPid -ErrorAction SilentlyContinue; if ($proc) { Write-Host 'minion-agent: running (PID:' $agentPid ')' } else { Write-Host 'minion-agent: not running (stale PID)' } } else { Write-Host 'minion-agent: not running' }"`,
-    }
-  } else if (procMgr === 'nssm') {
-    // NSSM handles graceful stop via its own service control, so no HTTP API needed
-    commands['restart-agent'] = {
-      description: 'Restart the minion agent service',
-      command: 'nssm restart minion-agent',
-      deferred: true,
-    }
-    commands['update-agent'] = {
-      description: 'Update @geekbeer/minion to latest version and restart',
-      spawnArgs: ['powershell', ['-NoProfile', '-ExecutionPolicy', 'Bypass', '-File', buildUpdateScript(
-        'npm install -g @geekbeer/minion@latest',
-        'nssm stop minion-agent',
-        'nssm start minion-agent',
-        'update-agent',
-        agentPort,
-        apiToken,
-      )]],
-      deferred: true,
-    }
-    commands['update-agent-dev'] = {
-      description: 'Update @geekbeer/minion from Verdaccio (dev) and restart',
-      spawnArgs: ['powershell', ['-NoProfile', '-ExecutionPolicy', 'Bypass', '-File', buildUpdateScript(
-        'npm install -g @geekbeer/minion@latest --registry http://verdaccio:4873',
-        'nssm stop minion-agent',
-        'nssm start minion-agent',
-        'update-agent-dev',
-        agentPort,
-        apiToken,
-      )]],
-      deferred: true,
-    }
-    commands['restart-display'] = {
-      description: 'Restart TightVNC and websockify services',
-      command: 'nssm restart minion-websockify',
-    }
-    commands['status-services'] = {
-      description: 'Check status of all services',
-      command: 'nssm status minion-agent & nssm status minion-websockify',
-    }
-  } else if (procMgr === 'sc') {
-    // sc.exe handles graceful stop via service control, so no HTTP API needed
-    commands['restart-agent'] = {
-      description: 'Restart the minion agent service',
-      command: 'net stop minion-agent & net start minion-agent',
-      deferred: true,
-    }
-    commands['update-agent'] = {
-      description: 'Update @geekbeer/minion to latest version and restart',
-      spawnArgs: ['powershell', ['-NoProfile', '-ExecutionPolicy', 'Bypass', '-File', buildUpdateScript(
+  commands['update-agent'] = {
+    description: 'Update @geekbeer/minion to latest version and restart',
+    spawnArgs: ['powershell', ['-NoProfile', '-ExecutionPolicy', 'Bypass', '-Command',
+      `& '${buildUpdateScript(
         'npm install -g @geekbeer/minion@latest',
-        'net stop minion-agent',
-        'net start minion-agent',
-        'update-agent',
-        agentPort,
-        apiToken,
-      )]],
-      deferred: true,
-    }
-    commands['update-agent-dev'] = {
-      description: 'Update @geekbeer/minion from Verdaccio (dev) and restart',
-      spawnArgs: ['powershell', ['-NoProfile', '-ExecutionPolicy', 'Bypass', '-File', buildUpdateScript(
+        nssmPath, 'update-agent', agentPort, apiToken,
+      )}'`]],
+    deferred: true,
+  }
+
+  commands['update-agent-dev'] = {
+    description: 'Update @geekbeer/minion from Verdaccio (dev) and restart',
+    spawnArgs: ['powershell', ['-NoProfile', '-ExecutionPolicy', 'Bypass', '-Command',
+      `& '${buildUpdateScript(
         'npm install -g @geekbeer/minion@latest --registry http://verdaccio:4873',
-        'net stop minion-agent',
-        'net start minion-agent',
-        'update-agent-dev',
-        agentPort,
-        apiToken,
-      )]],
-      deferred: true,
-    }
-    commands['status-services'] = {
-      description: 'Check status of minion agent service',
-      command: 'sc query minion-agent',
-    }
+        nssmPath, 'update-agent-dev', agentPort, apiToken,
+      )}'`]],
+    deferred: true,
+  }
+
+  commands['restart-display'] = {
+    description: 'Restart VNC and websockify services',
+    command: `"${nssmPath}" restart minion-vnc & "${nssmPath}" restart minion-websockify`,
+  }
+
+  commands['restart-tunnel'] = {
+    description: 'Restart Cloudflare tunnel service',
+    command: `"${nssmPath}" restart minion-cloudflared`,
+  }
+
+  commands['status-services'] = {
+    description: 'Check status of all minion services',
+    command: `"${nssmPath}" status minion-agent & "${nssmPath}" status minion-vnc & "${nssmPath}" status minion-websockify & "${nssmPath}" status minion-cloudflared`,
   }
 
   return commands
@@ -326,4 +220,5 @@ function buildAllowedCommands(procMgr, agentConfig = {}) {
 module.exports = {
   detectProcessManager,
   buildAllowedCommands,
+  getNssmPath,
 }