Class CommandExecutor

Command executor for running external programs with resource constraints. Manages process lifecycle, timeout enforcement, memory limits, and cleanup. Supports cross-platform execution (Unix/Windows) with platform-specific tree-kill.

CommandExecutor

Example

import { executor } from './executor';

const result = await executor.execute('./solution', {
  timeout: 2000,
  memoryLimitMB: 256,
  silent: false
});

Index

Constructors

constructor

new CommandExecutor(): CommandExecutor
Returns CommandExecutor

Properties

`Private`tempFiles

tempFiles: string[] = []

`Private`activeProcesses

activeProcesses: Set<ExecaChildProcess<string>> = ...

Methods

execute

execute(command: string, options: ExecutionOptions): Promise<ExecutionResult>
Execute a shell command with timeout and memory limits. Automatically kills the process tree if it exceeds time or memory constraints.
Parameters
- command: string
  Shell command to execute
- options: ExecutionOptions
  Execution configuration
Returns Promise<ExecutionResult>
Execution result with stdout, stderr, and status

Throws
If command fails and no onError callback is provided

Throws
If timeout occurs and no onTimeout callback is provided

Throws
If memory limit exceeded and no onMemoryExceeded callback is provided
- Defined in executor.ts:94

`Private`applyMemoryLimit

applyMemoryLimit(command: string, memoryLimitMB?: number): string
Applies memory limit to a command using platform-specific methods. For Java programs, uses -Xmx flag. For Unix, wraps in a ulimit -v subshell. Windows memory limits are not enforced.
Parameters
- command: string
- OptionalmemoryLimitMB: number
Returns string
- Defined in executor.ts:196

`Private`normalizeCommandForPlatform

normalizeCommandForPlatform(command: string): string
Normalizes command syntax for the current platform. On Windows, converts ./foo to .\foo and forward slashes in the executable path to backslashes to avoid ERROR_PATH_NOT_FOUND (3) from cmd.exe. Leaves arguments and redirections intact.
Parameters
- command: string
Returns string
- Defined in executor.ts:220

`Private`finalizeTimeout

finalizeTimeout(
stdout: string,
options: ExecutionOptions,
): Promise<ExecutionResult>
Finalizes a timed-out execution: emits the warning, populates the result, and routes to the onTimeout callback or throws.
Parameters
- stdout: string
- options: ExecutionOptions
Returns Promise<ExecutionResult>
- Defined in executor.ts:246

`Private`isMemoryError

isMemoryError(
    code: number | null,
    signal: Signals | null,
    stderr: string,
): boolean
Detects if a process failed due to memory issues. Checks both exit codes (137, SIGABRT) and error messages in stderr.
Parameters
- code: number | null
- signal: Signals | null
- stderr: string
Returns boolean
- Defined in executor.ts:282

`Private`finalizeMemoryError

finalizeMemoryError(
    result: ExecutionResult,
    code: number,
    signal: Signals | null,
    options: ExecutionOptions,
): ExecutionResult
Finalizes a memory-limit-exceeded execution.
Parameters
- result: ExecutionResult
- code: number
- signal: Signals | null
- options: ExecutionOptions
Returns ExecutionResult
- Defined in executor.ts:302

`Private`finalizeSuccess

finalizeSuccess(
result: ExecutionResult,
options: ExecutionOptions,
): ExecutionResult
Finalizes a successful execution (exit code 0).
Parameters
- result: ExecutionResult
- options: ExecutionOptions
Returns ExecutionResult
- Defined in executor.ts:327

`Private`finalizeError

finalizeError(
result: ExecutionResult,
options: ExecutionOptions,
): ExecutionResult
Finalizes a failed execution (non-zero exit code).
Parameters
- result: ExecutionResult
- options: ExecutionOptions
Returns ExecutionResult
- Defined in executor.ts:346

`Private`finalizeSpawnError

finalizeSpawnError(err: Error, options: ExecutionOptions): ExecutionResult
Finalizes a spawn-time failure (ENOENT, EACCES, ...).
Parameters
- err: Error
- options: ExecutionOptions
Returns ExecutionResult
- Defined in executor.ts:368

`Private`killProcessTree

killProcessTree(pid: number): void
Kills a process and its entire child process tree. Uses taskkill /T /F on Windows, process-group SIGKILL on Unix. Falls back to single-process kill if the group call fails.
Parameters
- pid: number
Returns void
- Defined in executor.ts:397

executeWithRedirect

executeWithRedirect(
    command: string,
    options: ExecutionOptions,
    inputFile?: string,
    outputFile?: string,
): Promise<ExecutionResult>
Execute a command with input/output file redirection. Wraps the execute method with shell < / > redirections.
Parameters
- command: string
- options: ExecutionOptions
- OptionalinputFile: string
- OptionaloutputFile: string
Returns Promise<ExecutionResult>
- Defined in executor.ts:423

`Private`buildRedirectedCommand

buildRedirectedCommand(
    command: string,
    inputFile?: string,
    outputFile?: string,
): string
Builds a shell command with input/output redirection. Quotes paths to survive spaces and normalizes them for the current platform.
Parameters
- command: string
- OptionalinputFile: string
- OptionaloutputFile: string
Returns string
- Defined in executor.ts:441

registerTempFile

registerTempFile(filePath: string): void
Register a temporary file for tracking.
Parameters
- filePath: string
Returns void
- Defined in executor.ts:470

cleanup

cleanup(): Promise<void>
Clean up all active processes and clear temp file registry. On Windows, waits briefly for file handles to be released.

Returns Promise<void>
- Defined in executor.ts:478

`Private`killAllActiveProcesses

killAllActiveProcesses(): void
Returns void
- Defined in executor.ts:488

getTempFiles

getTempFiles(): string[]
Get a copy of the registered temporary files list.

Returns string[]
- Defined in executor.ts:504

Class CommandExecutor

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Returns CommandExecutor

Properties

PrivatetempFiles

PrivateactiveProcesses

Methods

execute

Parameters

Returns Promise<ExecutionResult>

Throws

Throws

Throws

PrivateapplyMemoryLimit

Parameters

Returns string

PrivatenormalizeCommandForPlatform

Parameters

Returns string

PrivatefinalizeTimeout

Parameters

Returns Promise<ExecutionResult>

PrivateisMemoryError

Parameters

Returns boolean

PrivatefinalizeMemoryError

Parameters

Returns ExecutionResult

PrivatefinalizeSuccess

Parameters

Returns ExecutionResult

PrivatefinalizeError

Parameters

Returns ExecutionResult

PrivatefinalizeSpawnError

Parameters

Returns ExecutionResult

PrivatekillProcessTree

Parameters

Returns void

executeWithRedirect

Parameters

Returns Promise<ExecutionResult>

PrivatebuildRedirectedCommand

Parameters

Returns string

registerTempFile

Parameters

Returns void

cleanup

Returns Promise<void>

PrivatekillAllActiveProcesses

Returns void

getTempFiles

Returns string[]

Settings

On This Page

`Private`tempFiles

`Private`activeProcesses

`Private`applyMemoryLimit

`Private`normalizeCommandForPlatform

`Private`finalizeTimeout

`Private`isMemoryError

`Private`finalizeMemoryError

`Private`finalizeSuccess

`Private`finalizeError

`Private`finalizeSpawnError

`Private`killProcessTree

`Private`buildRedirectedCommand

`Private`killAllActiveProcesses