| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184 |
- import {
- execFileNoThrowWithCwd,
- execSyncWithDefaults_DEPRECATED,
- } from './execFileNoThrow.js'
- // This file contains platform-agnostic implementations of common `ps` type commands.
- // When adding new code to this file, make sure to handle:
- // - Win32, as `ps` within cygwin and WSL may not behave as expected, particularly when attempting to access processes on the host.
- // - Unix vs BSD-style `ps` have different options.
- /**
- * Check if a process with the given PID is running (signal 0 probe).
- *
- * PID ≤ 1 returns false (0 is current process group, 1 is init).
- *
- * Note: `process.kill(pid, 0)` throws EPERM when the process exists but is
- * owned by another user. This reports such processes as NOT running, which
- * is conservative for lock recovery (we won't steal a live lock).
- */
- export function isProcessRunning(pid: number): boolean {
- if (pid <= 1) return false
- try {
- process.kill(pid, 0)
- return true
- } catch {
- return false
- }
- }
- /**
- * Gets the ancestor process chain for a given process (up to maxDepth levels)
- * @param pid - The starting process ID
- * @param maxDepth - Maximum number of ancestors to fetch (default: 10)
- * @returns Array of ancestor PIDs from immediate parent to furthest ancestor
- */
- export async function getAncestorPidsAsync(
- pid: string | number,
- maxDepth = 10,
- ): Promise<number[]> {
- if (process.platform === 'win32') {
- // For Windows, use a PowerShell script that walks the process tree
- const script = `
- $pid = ${String(pid)}
- $ancestors = @()
- for ($i = 0; $i -lt ${maxDepth}; $i++) {
- $proc = Get-CimInstance Win32_Process -Filter "ProcessId=$pid" -ErrorAction SilentlyContinue
- if (-not $proc -or -not $proc.ParentProcessId -or $proc.ParentProcessId -eq 0) { break }
- $pid = $proc.ParentProcessId
- $ancestors += $pid
- }
- $ancestors -join ','
- `.trim()
- const result = await execFileNoThrowWithCwd(
- 'powershell.exe',
- ['-NoProfile', '-Command', script],
- { timeout: 3000 },
- )
- if (result.code !== 0 || !result.stdout?.trim()) {
- return []
- }
- return result.stdout
- .trim()
- .split(',')
- .filter(Boolean)
- .map(p => parseInt(p, 10))
- .filter(p => !isNaN(p))
- }
- // For Unix, use a shell command that walks up the process tree
- // This uses a single process invocation instead of multiple sequential calls
- const script = `pid=${String(pid)}; for i in $(seq 1 ${maxDepth}); do ppid=$(ps -o ppid= -p $pid 2>/dev/null | tr -d ' '); if [ -z "$ppid" ] || [ "$ppid" = "0" ] || [ "$ppid" = "1" ]; then break; fi; echo $ppid; pid=$ppid; done`
- const result = await execFileNoThrowWithCwd('sh', ['-c', script], {
- timeout: 3000,
- })
- if (result.code !== 0 || !result.stdout?.trim()) {
- return []
- }
- return result.stdout
- .trim()
- .split('\n')
- .filter(Boolean)
- .map(p => parseInt(p, 10))
- .filter(p => !isNaN(p))
- }
- /**
- * Gets the command line for a given process
- * @param pid - The process ID to get the command for
- * @returns The command line string, or null if not found
- * @deprecated Use getAncestorCommandsAsync instead
- */
- export function getProcessCommand(pid: string | number): string | null {
- try {
- const pidStr = String(pid)
- const command =
- process.platform === 'win32'
- ? `powershell.exe -NoProfile -Command "(Get-CimInstance Win32_Process -Filter \\"ProcessId=${pidStr}\\").CommandLine"`
- : `ps -o command= -p ${pidStr}`
- const result = execSyncWithDefaults_DEPRECATED(command, { timeout: 1000 })
- return result ? result.trim() : null
- } catch {
- return null
- }
- }
- /**
- * Gets the command lines for a process and its ancestors in a single call
- * @param pid - The starting process ID
- * @param maxDepth - Maximum depth to traverse (default: 10)
- * @returns Array of command strings for the process chain
- */
- export async function getAncestorCommandsAsync(
- pid: string | number,
- maxDepth = 10,
- ): Promise<string[]> {
- if (process.platform === 'win32') {
- // For Windows, use a PowerShell script that walks the process tree and collects commands
- const script = `
- $currentPid = ${String(pid)}
- $commands = @()
- for ($i = 0; $i -lt ${maxDepth}; $i++) {
- $proc = Get-CimInstance Win32_Process -Filter "ProcessId=$currentPid" -ErrorAction SilentlyContinue
- if (-not $proc) { break }
- if ($proc.CommandLine) { $commands += $proc.CommandLine }
- if (-not $proc.ParentProcessId -or $proc.ParentProcessId -eq 0) { break }
- $currentPid = $proc.ParentProcessId
- }
- $commands -join [char]0
- `.trim()
- const result = await execFileNoThrowWithCwd(
- 'powershell.exe',
- ['-NoProfile', '-Command', script],
- { timeout: 3000 },
- )
- if (result.code !== 0 || !result.stdout?.trim()) {
- return []
- }
- return result.stdout.split('\0').filter(Boolean)
- }
- // For Unix, use a shell command that walks up the process tree and collects commands
- // Using null byte as separator to handle commands with newlines
- const script = `currentpid=${String(pid)}; for i in $(seq 1 ${maxDepth}); do cmd=$(ps -o command= -p $currentpid 2>/dev/null); if [ -n "$cmd" ]; then printf '%s\\0' "$cmd"; fi; ppid=$(ps -o ppid= -p $currentpid 2>/dev/null | tr -d ' '); if [ -z "$ppid" ] || [ "$ppid" = "0" ] || [ "$ppid" = "1" ]; then break; fi; currentpid=$ppid; done`
- const result = await execFileNoThrowWithCwd('sh', ['-c', script], {
- timeout: 3000,
- })
- if (result.code !== 0 || !result.stdout?.trim()) {
- return []
- }
- return result.stdout.split('\0').filter(Boolean)
- }
- /**
- * Gets the child process IDs for a given process
- * @param pid - The parent process ID
- * @returns Array of child process IDs as numbers
- */
- export function getChildPids(pid: string | number): number[] {
- try {
- const pidStr = String(pid)
- const command =
- process.platform === 'win32'
- ? `powershell.exe -NoProfile -Command "(Get-CimInstance Win32_Process -Filter \\"ParentProcessId=${pidStr}\\").ProcessId"`
- : `pgrep -P ${pidStr}`
- const result = execSyncWithDefaults_DEPRECATED(command, { timeout: 1000 })
- if (!result) {
- return []
- }
- return result
- .trim()
- .split('\n')
- .filter(Boolean)
- .map(p => parseInt(p, 10))
- .filter(p => !isNaN(p))
- } catch {
- return []
- }
- }
|