@lde/task-runner-native 0.0.5 → 0.2.0

package/README.md

@@ -1,11 +1,39 @@
-# task-runner-native
+# Task Runner Native
 
-This library was generated with [Nx](https://nx.dev).
+Run shell commands natively on the host system using Node.js `child_process`.
 
-## Building
+## Usage
 
-Run `nx build task-runner-native` to build the library.
+```typescript
+import { NativeTaskRunner } from '@lde/task-runner-native';
 
-## Running unit tests
+const runner = new NativeTaskRunner({
+  cwd: '/path/to/working/dir', // Optional working directory
+  gracefulShutdownTimeout: 5000, // Optional timeout before SIGKILL (default: 5000ms)
+});
 
-Run `nx test task-runner-native` to execute the unit tests via [Jest](https://jestjs.io).
+// Run a command
+const task = await runner.run('echo "Hello World"');
+
+// Wait for completion
+const output = await runner.wait(task);
+console.log(output); // "Hello World"
+
+// Or stop a long-running task
+const task2 = await runner.run('sleep 60');
+await runner.stop(task2); // Sends SIGTERM, then SIGKILL after timeout
+```
+
+## Options
+
+| Option                    | Type     | Default           | Description                                               |
+| ------------------------- | -------- | ----------------- | --------------------------------------------------------- |
+| `cwd`                     | `string` | Current directory | Working directory for spawned processes                   |
+| `gracefulShutdownTimeout` | `number` | `5000`            | Milliseconds to wait after SIGTERM before sending SIGKILL |
+
+## Features
+
+- Spawns commands in a detached process group
+- Graceful shutdown with SIGTERM → SIGKILL escalation
+- Handles already-exited processes in `stop()`
+- Captures stdout and stderr output

package/dist/index.d.ts

@@ -1,9 +1,25 @@
 import { TaskRunner } from '@lde/task-runner';
 import { ChildProcess } from 'node:child_process';
+export interface NativeTaskRunnerOptions {
+    /**
+     * Working directory for spawned processes.
+     * Defaults to the current working directory.
+     */
+    cwd?: string;
+    /**
+     * Timeout in milliseconds to wait for graceful shutdown (SIGTERM)
+     * before escalating to SIGKILL.
+     * @default 5000
+     */
+    gracefulShutdownTimeout?: number;
+}
 export declare class NativeTaskRunner implements TaskRunner<ChildProcess> {
     private stdout;
     private stderr;
     private shell;
+    private cwd?;
+    private gracefulShutdownTimeout;
+    constructor(options?: NativeTaskRunnerOptions);
     run(command: string): Promise<ChildProcess>;
     wait(task: ChildProcess): Promise<string>;
     stop(task: ChildProcess): Promise<string | null>;

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAS,MAAM,oBAAoB,CAAC;AAGzD,qBAAa,gBAAiB,YAAW,UAAU,CAAC,YAAY,CAAC;IAC/D,OAAO,CAAC,MAAM,CAAkC;IAChD,OAAO,CAAC,MAAM,CAAkC;IAChD,OAAO,CAAC,KAAK,CAAQ;IAEf,GAAG,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAsC3C,IAAI,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IAgBzC,IAAI,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAWtD,OAAO,CAAC,UAAU;CAQnB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAS,MAAM,oBAAoB,CAAC;AAGzD,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;CAClC;AAED,qBAAa,gBAAiB,YAAW,UAAU,CAAC,YAAY,CAAC;IAC/D,OAAO,CAAC,MAAM,CAAkC;IAChD,OAAO,CAAC,MAAM,CAAkC;IAChD,OAAO,CAAC,KAAK,CAAQ;IACrB,OAAO,CAAC,GAAG,CAAC,CAAS;IACrB,OAAO,CAAC,uBAAuB,CAAS;gBAE5B,OAAO,CAAC,EAAE,uBAAuB;IAKvC,GAAG,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAsC3C,IAAI,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IAgBzC,IAAI,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAwCtD,OAAO,CAAC,UAAU;CAQnB"}

package/dist/index.js

@@ -4,11 +4,17 @@ export class NativeTaskRunner {
     stdout = new Map();
     stderr = new Map();
     shell = true;
+    cwd;
+    gracefulShutdownTimeout;
+    constructor(options) {
+        this.cwd = options?.cwd;
+        this.gracefulShutdownTimeout = options?.gracefulShutdownTimeout ?? 5000;
+    }
     async run(command) {
         const task = spawn(command, {
             detached: true,
             shell: this.shell,
-            cwd: 'imports', // TODO: don't hard-code
+            cwd: this.cwd,
         });
         task.on('close', (code) => {
             /** code is null when the process was killed, which is expected when
@@ -49,12 +55,38 @@ export class NativeTaskRunner {
     }
     async stop(task) {
         return new Promise((resolve) => {
-            task.on('close', () => {
+            // Handle already-exited processes.
+            if (task.exitCode !== null || task.killed) {
                 resolve(this.taskOutput(task));
-            });
+                return;
+            }
+            const sigkillTimer = {};
+            const cleanup = () => {
+                if (sigkillTimer.current) {
+                    clearTimeout(sigkillTimer.current);
+                }
+                resolve(this.taskOutput(task));
+            };
+            task.on('close', cleanup);
             // Negative PID to kill whole process group: the {shell: true} argument
             // to spawn splits off a separate process.
-            process.kill(-task.pid, 'SIGTERM');
+            try {
+                process.kill(-task.pid, 'SIGTERM');
+            }
+            catch {
+                // Process may have already exited (ESRCH error).
+                cleanup();
+                return;
+            }
+            // Escalate to SIGKILL after timeout if process doesn't terminate.
+            sigkillTimer.current = setTimeout(() => {
+                try {
+                    process.kill(-task.pid, 'SIGKILL');
+                }
+                catch {
+                    // Process may have exited between SIGTERM and SIGKILL.
+                }
+            }, this.gracefulShutdownTimeout);
         });
     }
     taskOutput(task) {

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@lde/task-runner-native",
-  "version": "0.0.5",
+  "version": "0.2.0",
   "repository": {
-    "url": "https://github.com/ldengine/lde"
+    "url": "https://github.com/ldengine/lde",
+    "directory": "packages/task-runner-native"
   },
   "type": "module",
   "exports": {
@@ -22,7 +23,7 @@
     "!**/*.tsbuildinfo"
   ],
   "dependencies": {
-    "@lde/task-runner": "0.0.5",
+    "@lde/task-runner": "0.2.0",
     "tslib": "^2.3.0"
   }
 }