omkit 0.0.2 → 0.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/actions/command.d.ts +34 -10
- package/dist/actions/command.js +71 -19
- package/dist/actions/tail-log.js +7 -1
- package/dist/core/action.d.ts +10 -6
- package/dist/core/action.js +7 -7
- package/dist/core/folder-cache.d.ts +23 -20
- package/dist/core/folder-cache.js +54 -35
- package/dist/core/process.d.ts +13 -0
- package/dist/core/process.js +35 -7
- package/dist/index.js +3 -2
- package/package.json +1 -1
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { type AnyActionInstance } from "../core/action.ts";
|
|
1
2
|
/** Tunes an action built with {@link command}. */
|
|
2
3
|
export interface CommandOptions {
|
|
3
4
|
/**
|
|
@@ -7,20 +8,43 @@ export interface CommandOptions {
|
|
|
7
8
|
cwd?: string;
|
|
8
9
|
/** Label the child's output is logged under. Defaults to the action's name. */
|
|
9
10
|
label?: string;
|
|
11
|
+
/**
|
|
12
|
+
* Environment for the child. Pass the full set you want (e.g.
|
|
13
|
+
* `{ ...process.env, NODE_ENV: "development" }`) — it's handed to the child
|
|
14
|
+
* as-is, not merged. Omit to inherit the parent's `process.env`.
|
|
15
|
+
*/
|
|
16
|
+
env?: NodeJS.ProcessEnv;
|
|
10
17
|
}
|
|
11
18
|
/**
|
|
12
|
-
* Runs a fixed
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
19
|
+
* Runs a fixed command as an action **instance** — built in a single call, the
|
|
20
|
+
* same shape as every other bundled action (`healthcheck`, `prompt`, …), rather
|
|
21
|
+
* than a factory you instantiate separately. `name` identifies it across the run
|
|
22
|
+
* (the `launch <name>` line and the child's log source).
|
|
23
|
+
*
|
|
24
|
+
* Two forms:
|
|
25
|
+
*
|
|
26
|
+
* - **Shell form** — `command(name, cmd, opts)`. The string runs verbatim
|
|
27
|
+
* through a shell (PowerShell on Windows), so pipes, globs, and `&&` work:
|
|
28
|
+
*
|
|
29
|
+
* command("TSKB:dev", "npm run dev:explorer", { cwd: pkg })
|
|
30
|
+
*
|
|
31
|
+
* The direct child is the *shell*, and the real program is a grandchild. On
|
|
32
|
+
* Windows teardown reaps the tree only while that shell is alive — so a GUI
|
|
33
|
+
* app that ignores console Ctrl-C (Electron) can be **orphaned and survive**.
|
|
34
|
+
*
|
|
35
|
+
* - **Direct form** — `command(name, file, args, opts)`. Spawns `file` with
|
|
36
|
+
* `args` **without a shell**, so the action's direct child *is* the program.
|
|
37
|
+
* On teardown it's force-reaped by its own PID (`taskkill /F /T`), so it dies
|
|
38
|
+
* even when a shell would have orphaned it. Use this for long-lived apps you
|
|
39
|
+
* launch and must be able to kill on Ctrl-C:
|
|
40
|
+
*
|
|
41
|
+
* command("platform", electronExe, [".", "--inspect"], { cwd: app })
|
|
17
42
|
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
* command("TSKB:test", "npm test", { cwd: repo }),
|
|
21
|
-
* );
|
|
43
|
+
* `file` must be a real executable (an actual `electron.exe`), not a `.cmd`
|
|
44
|
+
* shim — shims need a shell to run.
|
|
22
45
|
*
|
|
23
46
|
* For anything beyond a static command — interpolated args, emitted events, a
|
|
24
47
|
* daemon loop — drop down to `action(...).run(...)` directly.
|
|
25
48
|
*/
|
|
26
|
-
export declare
|
|
49
|
+
export declare function command(name: string, cmd: string, options?: CommandOptions): AnyActionInstance;
|
|
50
|
+
export declare function command(name: string, file: string, args: string[], options?: CommandOptions): AnyActionInstance;
|
package/dist/actions/command.js
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
|
+
import { spawn } from "node:child_process";
|
|
1
2
|
import path from "node:path";
|
|
2
3
|
import { action } from "../core/action.js";
|
|
4
|
+
import { killTree } from "../core/process.js";
|
|
5
|
+
import { captureSnapshot } from "../core/output.js";
|
|
3
6
|
/**
|
|
4
7
|
* Build the literal part of a zx tagged template from a command string, so it
|
|
5
8
|
* runs verbatim. zx only quotes interpolated args, not the template's `pieces` —
|
|
@@ -8,25 +11,74 @@ import { action } from "../core/action.js";
|
|
|
8
11
|
* verbatim is exactly what we want.
|
|
9
12
|
*/
|
|
10
13
|
const verbatim = (cmd) => Object.assign([cmd], { raw: [cmd] });
|
|
14
|
+
export function command(name, cmdOrFile, argsOrOptions, maybeOptions) {
|
|
15
|
+
const direct = Array.isArray(argsOrOptions);
|
|
16
|
+
const options = (direct ? maybeOptions : argsOrOptions) ?? {};
|
|
17
|
+
if (direct) {
|
|
18
|
+
return action(name).run((ctx) => spawnDirect(ctx.logs, ctx.signal, name, cmdOrFile, argsOrOptions, options))();
|
|
19
|
+
}
|
|
20
|
+
return action(name).run(({ proc }) => {
|
|
21
|
+
// path.resolve keeps an absolute cwd as-is and resolves a relative one
|
|
22
|
+
// against process.cwd() — exactly the "absolute from where node runs" rule.
|
|
23
|
+
const cwd = path.resolve(options.cwd ?? ".");
|
|
24
|
+
// proc sources the LogsCollector from async context and streams output into it.
|
|
25
|
+
return proc(options.label ?? name, { cwd, ...(options.env ? { env: options.env } : {}) })(verbatim(cmdOrFile));
|
|
26
|
+
})(); // construct the instance here, so callers get one in a single call
|
|
27
|
+
}
|
|
11
28
|
/**
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
* run(
|
|
19
|
-
* command("TSKB:dev", "npm run dev:explorer", { cwd: pkg }),
|
|
20
|
-
* command("TSKB:test", "npm test", { cwd: repo }),
|
|
21
|
-
* );
|
|
22
|
-
*
|
|
23
|
-
* For anything beyond a static command — interpolated args, emitted events, a
|
|
24
|
-
* daemon loop — drop down to `action(...).run(...)` directly.
|
|
29
|
+
* The direct (shell-less) launcher behind {@link command}'s four-arg form.
|
|
30
|
+
* Spawns `file`/`args` with no shell — so the returned child *is* the program,
|
|
31
|
+
* killable by its own PID on teardown — streams its stdout/stderr into the run's
|
|
32
|
+
* log, and resolves when it exits (0 = ok; a non-zero exit is a genuine failure,
|
|
33
|
+
* unless the run is tearing down, where the abort-kill is the reason).
|
|
25
34
|
*/
|
|
26
|
-
|
|
27
|
-
// path.resolve keeps an absolute cwd as-is and resolves a relative one
|
|
28
|
-
// against process.cwd() — exactly the "absolute from where node runs" rule.
|
|
35
|
+
const spawnDirect = (logs, signal, name, file, args, options) => {
|
|
29
36
|
const cwd = path.resolve(options.cwd ?? ".");
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
37
|
+
const source = options.label ?? name;
|
|
38
|
+
// windowsHide keeps a stray console window from flashing for the child.
|
|
39
|
+
// env omitted -> spawn inherits the parent's process.env (Node's default).
|
|
40
|
+
const child = spawn(file, args, { cwd, windowsHide: true, env: options.env });
|
|
41
|
+
// Mirror proc's launch line: a filterable milestone on the timeline, with the
|
|
42
|
+
// structured args snapshotted and linked (see process.ts for the rationale).
|
|
43
|
+
const snap = captureSnapshot(`proc-${name}-start`, { cmd: file, args, cwd });
|
|
44
|
+
logs.append({
|
|
45
|
+
source: name,
|
|
46
|
+
level: "event",
|
|
47
|
+
message: `${name} · start · ${file} ${args.join(" ")} · in ${cwd} · → ${snap.rel}`,
|
|
48
|
+
});
|
|
49
|
+
if (child.stdout)
|
|
50
|
+
logs.attach(child.stdout, source, "info");
|
|
51
|
+
if (child.stderr)
|
|
52
|
+
logs.attach(child.stderr, source, "error");
|
|
53
|
+
// Force-reap the child's tree on teardown, by its own PID. Guarded so a child
|
|
54
|
+
// that has already exited isn't re-killed (its PID may have been reused).
|
|
55
|
+
let finished = false;
|
|
56
|
+
const onAbort = () => {
|
|
57
|
+
if (finished || child.pid == null)
|
|
58
|
+
return;
|
|
59
|
+
killTree(child.pid);
|
|
60
|
+
};
|
|
61
|
+
const done = () => {
|
|
62
|
+
finished = true;
|
|
63
|
+
signal.removeEventListener("abort", onAbort);
|
|
64
|
+
};
|
|
65
|
+
if (signal.aborted)
|
|
66
|
+
killTree(child.pid ?? -1);
|
|
67
|
+
else
|
|
68
|
+
signal.addEventListener("abort", onAbort, { once: true });
|
|
69
|
+
return new Promise((resolve, reject) => {
|
|
70
|
+
child.on("error", (error) => {
|
|
71
|
+
done();
|
|
72
|
+
reject(error);
|
|
73
|
+
});
|
|
74
|
+
child.on("exit", (code, sig) => {
|
|
75
|
+
done();
|
|
76
|
+
// During teardown the abort-kill is why it exited — a clean shutdown, not a
|
|
77
|
+
// fault; let it settle successfully so it isn't recorded as a failure.
|
|
78
|
+
if (signal.aborted || code === 0)
|
|
79
|
+
resolve();
|
|
80
|
+
else
|
|
81
|
+
reject(new Error(`${name} exited with ${code ?? sig}`));
|
|
82
|
+
});
|
|
83
|
+
});
|
|
84
|
+
};
|
package/dist/actions/tail-log.js
CHANGED
|
@@ -25,7 +25,13 @@ export const tailLog = action("Tail Log").run(async ({ logs, signal }, target, o
|
|
|
25
25
|
let pending = ""; // partial trailing line, buffered until its newline
|
|
26
26
|
// Append every complete line in `text`, keeping any remainder for next time.
|
|
27
27
|
const feed = (text) => {
|
|
28
|
-
|
|
28
|
+
// Strip NUL bytes first. Log rotators (log4js/streamroller) can pre-allocate
|
|
29
|
+
// or leave a rotated file padded with \0, and a NUL run contains no newline —
|
|
30
|
+
// so without this the whole padded region buffers and flushes as one huge
|
|
31
|
+
// bogus line (the tell-tale "line of blanks/spaces"). NUL is never valid in
|
|
32
|
+
// a text log, so dropping it is safe; a NUL-only stretch collapses to "" and
|
|
33
|
+
// is skipped by the empty-line guard below.
|
|
34
|
+
pending += text.replace(/\0/g, "");
|
|
29
35
|
let newline;
|
|
30
36
|
while ((newline = pending.indexOf("\n")) !== -1) {
|
|
31
37
|
const line = pending.slice(0, newline).replace(/\r$/, "");
|
package/dist/core/action.d.ts
CHANGED
|
@@ -63,18 +63,22 @@ export interface ActionInstance<Result = unknown, Events extends object = NoEven
|
|
|
63
63
|
*/
|
|
64
64
|
once<K extends keyof InstanceEvents<Events, Result>>(key: K): Promise<InstanceEvents<Events, Result>[K]>;
|
|
65
65
|
/**
|
|
66
|
-
* Gate this action on
|
|
67
|
-
*
|
|
68
|
-
*
|
|
66
|
+
* Gate this action on its **inputs** — the files/folders it *reads* (its
|
|
67
|
+
* sources), **not** what it produces. `paths` (each a file or a folder) are
|
|
68
|
+
* fingerprinted by mtime+size; the returned instance skips running when those
|
|
69
|
+
* inputs are unchanged since the last successful run, and otherwise runs this
|
|
70
|
+
* action and records the fingerprint. Pass inputs, not build outputs: caching
|
|
71
|
+
* on an output would skip the very run that produces it.
|
|
72
|
+
*
|
|
69
73
|
* Every path must be **absolute** (throws otherwise). A cache hit resolves
|
|
70
74
|
* immediately as success (result `undefined`) and logs a `cached, skipping`
|
|
71
75
|
* line; a failure of the inner action records nothing, so it re-runs next time.
|
|
72
76
|
*
|
|
73
77
|
* Because `nod`/`run` launch an instance the moment they receive it, chain
|
|
74
|
-
* `.withCache` *before* handing the instance in:
|
|
75
|
-
* `nod(command("build", "
|
|
78
|
+
* `.withCache` *before* handing the instance in — passing the source dir:
|
|
79
|
+
* `nod(command("build", "npm run build").withCache(srcAbs))`.
|
|
76
80
|
*/
|
|
77
|
-
withCache(...
|
|
81
|
+
withCache(...paths: string[]): AnyActionInstance;
|
|
78
82
|
}
|
|
79
83
|
/**
|
|
80
84
|
* Any constructed instance, whatever its result, events, or handle. The launch
|
package/dist/core/action.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { events } from "./events.js";
|
|
2
2
|
import { createProc } from "./process.js";
|
|
3
|
-
import { fingerprint, read, write,
|
|
3
|
+
import { fingerprint, read, write, resolvePaths } from "./folder-cache.js";
|
|
4
4
|
/** A promise paired with its settlers, for the set-once handle. */
|
|
5
5
|
const deferred = () => {
|
|
6
6
|
let resolve;
|
|
@@ -105,23 +105,23 @@ const build = (name, exec) => {
|
|
|
105
105
|
return awaitEvent(emitter, name, key);
|
|
106
106
|
},
|
|
107
107
|
// Wrap this instance in a fresh one (reusing the engine for its own
|
|
108
|
-
// emitter/ref/on/once) that fingerprints `
|
|
108
|
+
// emitter/ref/on/once) that fingerprints `paths` and either skips or
|
|
109
109
|
// runs+records. The wrapper keeps this action's `name`, so log lines and
|
|
110
110
|
// the `launch <name>` line are unchanged. It forwards its injected
|
|
111
111
|
// logs/signal straight into the inner action's `start`.
|
|
112
|
-
withCache(...
|
|
112
|
+
withCache(...paths) {
|
|
113
113
|
// Validate + canonicalize eagerly here (at the call site), not lazily
|
|
114
114
|
// inside the run — a relative path fails fast where it's written, and
|
|
115
115
|
// the resolved paths give a stable cache key regardless of spelling.
|
|
116
|
-
const
|
|
116
|
+
const targets = resolvePaths(paths);
|
|
117
117
|
return action(name).run(async (ctx) => {
|
|
118
|
-
const fp = await fingerprint(
|
|
119
|
-
if ((await read(
|
|
118
|
+
const fp = await fingerprint(targets);
|
|
119
|
+
if ((await read(targets)) === fp) {
|
|
120
120
|
ctx.logs.append({ source: name, level: "info", message: "cached, skipping" });
|
|
121
121
|
return undefined;
|
|
122
122
|
}
|
|
123
123
|
const result = await instance.start({ logs: ctx.logs, signal: ctx.signal });
|
|
124
|
-
await write(
|
|
124
|
+
await write(targets, fp); // only on success — a throw above skips this
|
|
125
125
|
return result;
|
|
126
126
|
})();
|
|
127
127
|
},
|
|
@@ -1,36 +1,39 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
* method on action instances.
|
|
2
|
+
* An input-fingerprint cache: hash the mtime+size of one or more **input**
|
|
3
|
+
* targets (the files/folders an action reads — *not* what it produces), so an
|
|
4
|
+
* expensive action can be skipped when its inputs are unchanged since its last
|
|
5
|
+
* successful run. Backs the `.withCache(...)` method on action instances.
|
|
6
6
|
*
|
|
7
7
|
* Entries live under `node_modules/.cache/omkit/` (conventional, gitignored) —
|
|
8
|
-
* one JSON file per set of
|
|
8
|
+
* one JSON file per set of inputs, named by a hash of their absolute paths.
|
|
9
9
|
*/
|
|
10
10
|
/** Where cache entries are written — `node_modules/.cache/omkit/` under the cwd. */
|
|
11
11
|
export declare const cacheDir: string;
|
|
12
12
|
/**
|
|
13
|
-
* Require every path to be **absolute** (a relative
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
13
|
+
* Require every path to be **absolute** (a relative path is a developer error —
|
|
14
|
+
* throws, naming it) and return them canonicalized with `resolve`, so different
|
|
15
|
+
* spellings of the same target (`.`/`..`/trailing slash) collapse to one stable
|
|
16
|
+
* fingerprint prefix and cache key. `resolve` on an already-absolute path only
|
|
17
|
+
* normalizes — it never falls back to the cwd. Each target may be a file or a
|
|
18
|
+
* folder (see {@link fingerprint}).
|
|
18
19
|
*/
|
|
19
|
-
export declare const
|
|
20
|
+
export declare const resolvePaths: (paths: string[]) => string[];
|
|
20
21
|
/**
|
|
21
|
-
* Fingerprints one or more
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
22
|
+
* Fingerprints one or more **input** targets by mtime+size. Each target may be
|
|
23
|
+
* a **file** (fingerprinted directly) or a **folder** (walked recursively, its
|
|
24
|
+
* files fingerprinted). Every path must be absolute (throws otherwise). A
|
|
25
|
+
* missing target contributes nothing — so an input that doesn't exist yet is
|
|
26
|
+
* naturally a miss, not an error. The entry list is sorted for determinism
|
|
27
|
+
* before hashing.
|
|
25
28
|
*/
|
|
26
|
-
export declare const fingerprint: (
|
|
29
|
+
export declare const fingerprint: (paths: string[]) => Promise<string>;
|
|
27
30
|
/**
|
|
28
|
-
* Reads the fingerprint stored for these
|
|
31
|
+
* Reads the fingerprint stored for these targets, or `undefined` when there's
|
|
29
32
|
* no cache (absent, unreadable, or malformed — all treated as a miss).
|
|
30
33
|
*/
|
|
31
|
-
export declare const read: (
|
|
34
|
+
export declare const read: (paths: string[]) => Promise<string | undefined>;
|
|
32
35
|
/**
|
|
33
|
-
* Records the fingerprint for these
|
|
36
|
+
* Records the fingerprint for these targets after a successful run. Writes
|
|
34
37
|
* atomically (temp file + rename) so a concurrent read never sees a half-file.
|
|
35
38
|
*/
|
|
36
|
-
export declare const write: (
|
|
39
|
+
export declare const write: (paths: string[], fp: string) => Promise<void>;
|
|
@@ -2,52 +2,71 @@ import { createHash } from "node:crypto";
|
|
|
2
2
|
import { mkdir, readdir, readFile, rename, stat, writeFile } from "node:fs/promises";
|
|
3
3
|
import { isAbsolute, join, resolve } from "node:path";
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
* method on action instances.
|
|
5
|
+
* An input-fingerprint cache: hash the mtime+size of one or more **input**
|
|
6
|
+
* targets (the files/folders an action reads — *not* what it produces), so an
|
|
7
|
+
* expensive action can be skipped when its inputs are unchanged since its last
|
|
8
|
+
* successful run. Backs the `.withCache(...)` method on action instances.
|
|
9
9
|
*
|
|
10
10
|
* Entries live under `node_modules/.cache/omkit/` (conventional, gitignored) —
|
|
11
|
-
* one JSON file per set of
|
|
11
|
+
* one JSON file per set of inputs, named by a hash of their absolute paths.
|
|
12
12
|
*/
|
|
13
13
|
/** Where cache entries are written — `node_modules/.cache/omkit/` under the cwd. */
|
|
14
14
|
export const cacheDir = join(process.cwd(), "node_modules", ".cache", "omkit");
|
|
15
15
|
/**
|
|
16
|
-
* Require every path to be **absolute** (a relative
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
16
|
+
* Require every path to be **absolute** (a relative path is a developer error —
|
|
17
|
+
* throws, naming it) and return them canonicalized with `resolve`, so different
|
|
18
|
+
* spellings of the same target (`.`/`..`/trailing slash) collapse to one stable
|
|
19
|
+
* fingerprint prefix and cache key. `resolve` on an already-absolute path only
|
|
20
|
+
* normalizes — it never falls back to the cwd. Each target may be a file or a
|
|
21
|
+
* folder (see {@link fingerprint}).
|
|
21
22
|
*/
|
|
22
|
-
export const
|
|
23
|
-
if (!isAbsolute(
|
|
24
|
-
throw new Error(`withCache:
|
|
23
|
+
export const resolvePaths = (paths) => paths.map((p) => {
|
|
24
|
+
if (!isAbsolute(p)) {
|
|
25
|
+
throw new Error(`withCache: path must be absolute, got "${p}"`);
|
|
25
26
|
}
|
|
26
|
-
return resolve(
|
|
27
|
+
return resolve(p);
|
|
27
28
|
});
|
|
28
29
|
/**
|
|
29
|
-
* Fingerprints one or more
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
30
|
+
* Fingerprints one or more **input** targets by mtime+size. Each target may be
|
|
31
|
+
* a **file** (fingerprinted directly) or a **folder** (walked recursively, its
|
|
32
|
+
* files fingerprinted). Every path must be absolute (throws otherwise). A
|
|
33
|
+
* missing target contributes nothing — so an input that doesn't exist yet is
|
|
34
|
+
* naturally a miss, not an error. The entry list is sorted for determinism
|
|
35
|
+
* before hashing.
|
|
33
36
|
*/
|
|
34
|
-
export const fingerprint = async (
|
|
35
|
-
const
|
|
37
|
+
export const fingerprint = async (paths) => {
|
|
38
|
+
const targets = resolvePaths(paths);
|
|
36
39
|
const entries = [];
|
|
37
|
-
|
|
40
|
+
const record = (target, rel, mtimeMs, size) => {
|
|
41
|
+
entries.push(`${target}\0${rel}\0${mtimeMs}\0${size}`);
|
|
42
|
+
};
|
|
43
|
+
for (const target of targets) {
|
|
44
|
+
let root;
|
|
45
|
+
try {
|
|
46
|
+
root = await stat(target);
|
|
47
|
+
}
|
|
48
|
+
catch {
|
|
49
|
+
continue; // missing/unreadable — contributes no entries
|
|
50
|
+
}
|
|
51
|
+
// A file target fingerprints itself (empty rel — there's no walk).
|
|
52
|
+
if (root.isFile()) {
|
|
53
|
+
record(target, "", root.mtimeMs, root.size);
|
|
54
|
+
continue;
|
|
55
|
+
}
|
|
56
|
+
// A folder target: walk it and fingerprint every file inside.
|
|
38
57
|
let rels;
|
|
39
58
|
try {
|
|
40
|
-
rels = await readdir(
|
|
59
|
+
rels = await readdir(target, { recursive: true });
|
|
41
60
|
}
|
|
42
61
|
catch {
|
|
43
|
-
continue;
|
|
62
|
+
continue;
|
|
44
63
|
}
|
|
45
64
|
for (const rel of rels) {
|
|
46
|
-
const abs = join(
|
|
65
|
+
const abs = join(target, rel);
|
|
47
66
|
try {
|
|
48
67
|
const stats = await stat(abs);
|
|
49
68
|
if (stats.isFile())
|
|
50
|
-
|
|
69
|
+
record(target, rel, stats.mtimeMs, stats.size);
|
|
51
70
|
}
|
|
52
71
|
catch {
|
|
53
72
|
// entry vanished between readdir and stat — skip
|
|
@@ -57,18 +76,18 @@ export const fingerprint = async (folders) => {
|
|
|
57
76
|
entries.sort();
|
|
58
77
|
return createHash("sha1").update(entries.join("\n")).digest("hex");
|
|
59
78
|
};
|
|
60
|
-
/** The on-disk filename for a set of
|
|
61
|
-
const entryPath = (
|
|
62
|
-
const key = createHash("sha1").update(
|
|
79
|
+
/** The on-disk filename for a set of targets — a hash of their absolute paths. */
|
|
80
|
+
const entryPath = (paths) => {
|
|
81
|
+
const key = createHash("sha1").update(resolvePaths(paths).sort().join("\0")).digest("hex");
|
|
63
82
|
return join(cacheDir, `${key}.json`);
|
|
64
83
|
};
|
|
65
84
|
/**
|
|
66
|
-
* Reads the fingerprint stored for these
|
|
85
|
+
* Reads the fingerprint stored for these targets, or `undefined` when there's
|
|
67
86
|
* no cache (absent, unreadable, or malformed — all treated as a miss).
|
|
68
87
|
*/
|
|
69
|
-
export const read = async (
|
|
88
|
+
export const read = async (paths) => {
|
|
70
89
|
try {
|
|
71
|
-
const raw = await readFile(entryPath(
|
|
90
|
+
const raw = await readFile(entryPath(paths), "utf8");
|
|
72
91
|
const entry = JSON.parse(raw);
|
|
73
92
|
return typeof entry.fingerprint === "string" ? entry.fingerprint : undefined;
|
|
74
93
|
}
|
|
@@ -77,13 +96,13 @@ export const read = async (folders) => {
|
|
|
77
96
|
}
|
|
78
97
|
};
|
|
79
98
|
/**
|
|
80
|
-
* Records the fingerprint for these
|
|
99
|
+
* Records the fingerprint for these targets after a successful run. Writes
|
|
81
100
|
* atomically (temp file + rename) so a concurrent read never sees a half-file.
|
|
82
101
|
*/
|
|
83
|
-
export const write = async (
|
|
102
|
+
export const write = async (paths, fp) => {
|
|
84
103
|
await mkdir(cacheDir, { recursive: true });
|
|
85
|
-
const target = entryPath(
|
|
86
|
-
const entry = { folders, fingerprint: fp, ts: Date.now() };
|
|
104
|
+
const target = entryPath(paths);
|
|
105
|
+
const entry = { folders: paths, fingerprint: fp, ts: Date.now() };
|
|
87
106
|
const tmp = `${target}.${process.pid}.tmp`;
|
|
88
107
|
await writeFile(tmp, JSON.stringify(entry, null, 2));
|
|
89
108
|
await rename(tmp, target);
|
package/dist/core/process.d.ts
CHANGED
|
@@ -1,5 +1,18 @@
|
|
|
1
1
|
import { type Options, type ProcessPromise } from "zx";
|
|
2
2
|
import type { Logger } from "./log-collector/LogsCollector.ts";
|
|
3
|
+
/**
|
|
4
|
+
* Force-kill a process **and its whole tree, synchronously**.
|
|
5
|
+
*
|
|
6
|
+
* Windows has no process groups: a child outlives its parent, and a Ctrl-C sent
|
|
7
|
+
* to the console group can make an intermediate shell exit and *orphan* the real
|
|
8
|
+
* app (e.g. electron.exe), which then survives teardown. So the tree must be
|
|
9
|
+
* reaped explicitly by PID — `taskkill /F /T` does it, and running it
|
|
10
|
+
* **synchronously** guarantees it completes before the run's own process exits
|
|
11
|
+
* (a fire-and-forget kill can lose that race). On POSIX, zx's `kill` already
|
|
12
|
+
* does a process-group tree kill. Best-effort: an already-dead/missing PID is
|
|
13
|
+
* ignored.
|
|
14
|
+
*/
|
|
15
|
+
export declare const killTree: (pid: number) => void;
|
|
3
16
|
/**
|
|
4
17
|
* Spawns a command (tagged-template, exactly like zx's `$`) and streams the
|
|
5
18
|
* child's stdout/stderr into a log (stdout as `info`, stderr as `error`) under
|
package/dist/core/process.js
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { execFileSync } from "node:child_process";
|
|
1
2
|
import os from "node:os";
|
|
2
3
|
import { $, kill, usePowerShell } from "zx";
|
|
3
4
|
import { captureSnapshot } from "./output.js";
|
|
@@ -5,6 +6,31 @@ import { captureSnapshot } from "./output.js";
|
|
|
5
6
|
// Use Windows PowerShell there so zx spawns and quotes for the right shell.
|
|
6
7
|
if (os.platform() === "win32")
|
|
7
8
|
usePowerShell();
|
|
9
|
+
/**
|
|
10
|
+
* Force-kill a process **and its whole tree, synchronously**.
|
|
11
|
+
*
|
|
12
|
+
* Windows has no process groups: a child outlives its parent, and a Ctrl-C sent
|
|
13
|
+
* to the console group can make an intermediate shell exit and *orphan* the real
|
|
14
|
+
* app (e.g. electron.exe), which then survives teardown. So the tree must be
|
|
15
|
+
* reaped explicitly by PID — `taskkill /F /T` does it, and running it
|
|
16
|
+
* **synchronously** guarantees it completes before the run's own process exits
|
|
17
|
+
* (a fire-and-forget kill can lose that race). On POSIX, zx's `kill` already
|
|
18
|
+
* does a process-group tree kill. Best-effort: an already-dead/missing PID is
|
|
19
|
+
* ignored.
|
|
20
|
+
*/
|
|
21
|
+
export const killTree = (pid) => {
|
|
22
|
+
if (process.platform === "win32") {
|
|
23
|
+
try {
|
|
24
|
+
execFileSync("taskkill", ["/F", "/T", "/PID", String(pid)], { stdio: "ignore" });
|
|
25
|
+
}
|
|
26
|
+
catch {
|
|
27
|
+
// already gone, access denied, or taskkill missing — nothing more to do
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
else {
|
|
31
|
+
void kill(pid).catch(() => { });
|
|
32
|
+
}
|
|
33
|
+
};
|
|
8
34
|
/**
|
|
9
35
|
* Builds a {@link Proc} bound to a specific log sink and abort signal. The action
|
|
10
36
|
* pipeline injects one per action as `ctx.proc`, wired to that action's logger
|
|
@@ -46,19 +72,21 @@ export const createProc = (logs, signal) => (name, opts) => {
|
|
|
46
72
|
});
|
|
47
73
|
logs.attach(child.stdout, name, "info");
|
|
48
74
|
logs.attach(child.stderr, name, "error");
|
|
49
|
-
// Kill the child's entire process tree on teardown
|
|
50
|
-
//
|
|
51
|
-
//
|
|
52
|
-
//
|
|
53
|
-
//
|
|
54
|
-
//
|
|
75
|
+
// Kill the child's entire process tree on teardown via {@link killTree} —
|
|
76
|
+
// a synchronous, force tree kill by PID (taskkill /F /T on Windows,
|
|
77
|
+
// process-group kill on Unix). Synchronous so it finishes before the run's
|
|
78
|
+
// process exits. NOTE: with zx the direct child is a *shell wrapper*
|
|
79
|
+
// (PowerShell on Windows), so this only reaps grandchildren while that
|
|
80
|
+
// wrapper is still alive; a GUI app that must survive its shell being
|
|
81
|
+
// Ctrl-C'd should be launched shell-less via `command(name, file, args)`,
|
|
82
|
+
// whose direct child is the app itself.
|
|
55
83
|
let finished = false;
|
|
56
84
|
const onAbort = () => {
|
|
57
85
|
if (finished)
|
|
58
86
|
return;
|
|
59
87
|
const pid = child.pid;
|
|
60
88
|
if (pid != null)
|
|
61
|
-
|
|
89
|
+
killTree(pid);
|
|
62
90
|
};
|
|
63
91
|
const markFinished = () => {
|
|
64
92
|
finished = true;
|
package/dist/index.js
CHANGED
|
@@ -24,6 +24,7 @@ export { log } from "./core/log-collector/global.js";
|
|
|
24
24
|
// ── Snapshots ──────────────────────────────────────────────────────────────
|
|
25
25
|
export { snapshot, captureSnapshot } from "./core/output.js";
|
|
26
26
|
// ── Folder cache ─────────────────────────────────────────────────────────────
|
|
27
|
-
// Backs the `.withCache(...
|
|
28
|
-
//
|
|
27
|
+
// Backs the `.withCache(...inputs)` method on instances (fingerprints an
|
|
28
|
+
// action's input files/folders, not its outputs); exported for scripts that
|
|
29
|
+
// want to inspect or manually invalidate the cache.
|
|
29
30
|
export { fingerprint, cacheDir } from "./core/folder-cache.js";
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "omkit",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.5",
|
|
4
4
|
"description": "A tiny runtime for developer workflows: typed actions that pass runtime capabilities and emit typed events, under one run and one shared log. The operational/runtime layer to tskb's knowledge layer.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|