@genroc/eval-node 0.0.0-edge.f77553c → 0.0.0-edge.f8a2edb
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/README.md +57 -33
- package/dist/eval.js +25 -4
- package/dist/import.js +104 -59
- package/dist/realm.js +66 -75
- package/dist/worker.js +30 -10
- package/eval.ts +25 -4
- package/import.ts +189 -80
- package/package.json +1 -1
- package/realm.ts +61 -77
- package/worker.ts +36 -11
package/dist/realm.js
CHANGED
|
@@ -2,80 +2,46 @@
|
|
|
2
2
|
// thread the host can kill mid-loop — the only thing that bounds a synchronous busy loop.
|
|
3
3
|
// eval.ts owns the budget and does the killing; nothing here knows about time.
|
|
4
4
|
//
|
|
5
|
-
// Everything that touches the script's VALUE lives on this side of the boundary —
|
|
5
|
+
// Everything that touches the script's VALUE lives on this side of the boundary — loading,
|
|
6
6
|
// classifying, serialising — because this is the only realm the value exists in.
|
|
7
|
-
|
|
7
|
+
var __rewriteRelativeImportExtension = (this && this.__rewriteRelativeImportExtension) || function (path, preserveJsx) {
|
|
8
|
+
if (typeof path === "string" && /^\.\.?\//.test(path)) {
|
|
9
|
+
return path.replace(/\.(tsx)$|((?:\.d)?)((?:\.[^./]+?)?)\.([cm]?)ts$/i, function (m, tsx, d, ext, cm) {
|
|
10
|
+
return tsx ? preserveJsx ? ".jsx" : ".js" : d && (!ext || !cm) ? m : (d + ext + "." + cm.toLowerCase() + "js");
|
|
11
|
+
});
|
|
12
|
+
}
|
|
13
|
+
return path;
|
|
14
|
+
};
|
|
15
|
+
import { registerHooks } from "node:module";
|
|
8
16
|
import { parentPort } from "node:worker_threads";
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
//
|
|
12
|
-
|
|
13
|
-
// `require` in scope. Passing one in is what makes an import of a builtin work at runtime rather than at
|
|
14
|
-
// typecheck only. Resolution is anchored here, which is right: only builtins reach it.
|
|
15
|
-
const scriptRequire = createRequire(import.meta.url);
|
|
17
|
+
// The script is IMPORTED as a module under a URL of our own, not compiled from a string: its
|
|
18
|
+
// frames then carry the author's own line numbers, and an `import` of a node builtin resolves
|
|
19
|
+
// the way it does everywhere else.
|
|
20
|
+
const SCRIPT_URL = "script:main";
|
|
16
21
|
const STACK_BYTES = 2_048;
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
return 0;
|
|
28
|
-
}
|
|
29
|
-
catch (err) {
|
|
30
|
-
return reportedLine(err) - 1;
|
|
31
|
-
}
|
|
32
|
-
})();
|
|
33
|
-
// V8 marks a frame compiled by the AsyncFunction constructor with the site that CALLED the
|
|
34
|
-
// constructor, then the script's OWN position:
|
|
35
|
-
// at inner (eval at run (file:///…/worker.ts:107:10), <anonymous>:6:9)
|
|
36
|
-
// `eval at` is therefore what separates script frames from runner plumbing — matched without
|
|
37
|
-
// the function name, which is whatever encloses the `new AsyncFunction` below. The LAST such
|
|
38
|
-
// frame is the body's top level: frames interleave, since a script can throw inside a native
|
|
39
|
-
// callback.
|
|
40
|
-
const SCRIPT_FRAME = /\(eval at /;
|
|
41
|
-
// The trailing `<anonymous>:LINE:COL` — the script's position, after the host file's own.
|
|
42
|
-
const POSITION = /<anonymous>:(\d+):(\d+)\)?\s*$/;
|
|
43
|
-
// ` at name (` — absent on the top-level frame, which V8 names `eval`.
|
|
44
|
-
const FRAME_NAME = /^\s*at\s+(?:async\s+)?([^\s(]+)\s*\(/;
|
|
45
|
-
/** Line number of the throw as the engine reported it, or 1 if the stack is unreadable. */
|
|
46
|
-
function reportedLine(err) {
|
|
47
|
-
const stack = err instanceof Error && typeof err.stack === "string" ? err.stack : "";
|
|
48
|
-
const frame = stack.split("\n").find((l) => SCRIPT_FRAME.test(l)) ?? "";
|
|
49
|
-
const m = frame.match(POSITION);
|
|
50
|
-
return m ? Number(m[1]) : 1;
|
|
51
|
-
}
|
|
52
|
-
/** Renumbers each script frame to the line the AUTHOR wrote and drops the runner's own.
|
|
53
|
-
* Rewriting the whole location is also what keeps the runner's path out of a script's
|
|
54
|
-
* stack — V8 puts it inside every compiled frame. */
|
|
55
|
-
function scriptStack(err, offset) {
|
|
22
|
+
// The only channel a load hook has to the source. Written per request and read once — a realm
|
|
23
|
+
// evaluates one script and is then discarded, so no second execution can observe it.
|
|
24
|
+
let source = "";
|
|
25
|
+
registerHooks({
|
|
26
|
+
resolve: (specifier, context, next) => specifier === SCRIPT_URL ? { url: SCRIPT_URL, shortCircuit: true } : next(specifier, context),
|
|
27
|
+
load: (url, context, next) => url === SCRIPT_URL ? { format: "module", source, shortCircuit: true } : next(url, context),
|
|
28
|
+
});
|
|
29
|
+
/** Keeps the frames that are the script's own. Everything below the last of them is runner
|
|
30
|
+
* plumbing the author cannot act on, and V8 puts this file's path in it. */
|
|
31
|
+
function scriptStack(err) {
|
|
56
32
|
if (!(err instanceof Error) || typeof err.stack !== "string")
|
|
57
33
|
return undefined;
|
|
58
34
|
const lines = err.stack.split("\n");
|
|
59
|
-
let
|
|
35
|
+
let last = 0;
|
|
60
36
|
for (let i = 0; i < lines.length; i++)
|
|
61
|
-
if (
|
|
62
|
-
|
|
63
|
-
const
|
|
64
|
-
|
|
65
|
-
const pos = line.match(POSITION);
|
|
66
|
-
if (!pos)
|
|
67
|
-
return line; // the `Error: message` header and native frames, kept as-is
|
|
68
|
-
const name = line.match(FRAME_NAME)?.[1];
|
|
69
|
-
const at = name && name !== "eval" && name !== "anonymous" ? `at ${name} ` : "at ";
|
|
70
|
-
const indent = line.match(/^\s*/)[0];
|
|
71
|
-
return `${indent}${at}(script:${Math.max(1, Number(pos[1]) - offset)}:${pos[2]})`;
|
|
72
|
-
})
|
|
73
|
-
.join("\n");
|
|
74
|
-
return frames.length > STACK_BYTES ? frames.slice(0, STACK_BYTES) : frames;
|
|
37
|
+
if (lines[i].includes(SCRIPT_URL))
|
|
38
|
+
last = i;
|
|
39
|
+
const stack = lines.slice(0, last + 1).join("\n");
|
|
40
|
+
return stack.length > STACK_BYTES ? stack.slice(0, STACK_BYTES) : stack;
|
|
75
41
|
}
|
|
76
|
-
function describe(err, kind
|
|
42
|
+
function describe(err, kind) {
|
|
77
43
|
if (err instanceof Error) {
|
|
78
|
-
return { kind, name: err.name, message: err.message, stack: scriptStack(err
|
|
44
|
+
return { kind, name: err.name, message: err.message, stack: scriptStack(err) };
|
|
79
45
|
}
|
|
80
46
|
// A script may throw a non-Error (`throw {code: "x"}`), so name/message must not assume one.
|
|
81
47
|
return { kind, name: "Thrown", message: safeText(err) };
|
|
@@ -88,23 +54,39 @@ function safeText(v) {
|
|
|
88
54
|
return String(v);
|
|
89
55
|
}
|
|
90
56
|
}
|
|
57
|
+
/** A module that will not parse, or names an import nothing resolves, is broken code — only
|
|
58
|
+
* editing it helps. Anything else thrown by the import is the module's top level running,
|
|
59
|
+
* which is the script throwing. */
|
|
60
|
+
function unloadable(err) {
|
|
61
|
+
const code = err?.code;
|
|
62
|
+
return err instanceof SyntaxError || (typeof code === "string" && code.startsWith("ERR_MODULE"));
|
|
63
|
+
}
|
|
91
64
|
async function run(req) {
|
|
92
|
-
|
|
93
|
-
let
|
|
65
|
+
source = req.code;
|
|
66
|
+
let main;
|
|
94
67
|
try {
|
|
95
|
-
|
|
96
|
-
// never be hit. Repeated compilation is the price of the fresh global object.
|
|
97
|
-
fn = new AsyncFunction("input", "require", STRICT + req.code);
|
|
68
|
+
main = (await import(__rewriteRelativeImportExtension(SCRIPT_URL))).default;
|
|
98
69
|
}
|
|
99
70
|
catch (err) {
|
|
100
|
-
return { ok: false, failure: describe(err, "compile_error"
|
|
71
|
+
return { ok: false, failure: describe(err, unloadable(err) ? "compile_error" : "threw") };
|
|
72
|
+
}
|
|
73
|
+
if (typeof main !== "function") {
|
|
74
|
+
const got = main === undefined ? "no default export" : `a ${typeof main}`;
|
|
75
|
+
return {
|
|
76
|
+
ok: false,
|
|
77
|
+
failure: {
|
|
78
|
+
kind: "compile_error",
|
|
79
|
+
name: "NoDefaultExport",
|
|
80
|
+
message: `a script must export default a function; this one has ${got}`,
|
|
81
|
+
},
|
|
82
|
+
};
|
|
101
83
|
}
|
|
102
84
|
let value;
|
|
103
85
|
try {
|
|
104
|
-
value = await
|
|
86
|
+
value = await main(req.input);
|
|
105
87
|
}
|
|
106
88
|
catch (err) {
|
|
107
|
-
return { ok: false, failure: describe(err, "threw"
|
|
89
|
+
return { ok: false, failure: describe(err, "threw") };
|
|
108
90
|
}
|
|
109
91
|
try {
|
|
110
92
|
// undefined stringifies to undefined, not "undefined"; an empty body is how genroc
|
|
@@ -112,11 +94,20 @@ async function run(req) {
|
|
|
112
94
|
return { ok: true, body: value === undefined ? "" : JSON.stringify(value) ?? "" };
|
|
113
95
|
}
|
|
114
96
|
catch (err) {
|
|
115
|
-
return { ok: false, failure: describe(err, "nonserializable"
|
|
97
|
+
return { ok: false, failure: describe(err, "nonserializable") };
|
|
116
98
|
}
|
|
117
99
|
}
|
|
100
|
+
// The realm's stdio is a pipe to the host thread, and eval.ts terminates this thread the moment
|
|
101
|
+
// the reply lands — so whatever a script wrote last is still in the pipe when it dies. An empty
|
|
102
|
+
// write's callback fires once the queue ahead of it has drained, which makes the reply a barrier
|
|
103
|
+
// for `console` and a direct process.stdout.write alike: both are this stream.
|
|
104
|
+
function flush(stream) {
|
|
105
|
+
return new Promise((resolve) => stream.write("", () => resolve()));
|
|
106
|
+
}
|
|
118
107
|
// Non-null because this module only ever runs as a worker entry point; a null port here
|
|
119
108
|
// would mean eval.ts loaded it as a plain module, which nothing does.
|
|
120
109
|
parentPort.on("message", async (req) => {
|
|
121
|
-
|
|
110
|
+
const reply = await run(req);
|
|
111
|
+
await Promise.all([flush(process.stdout), flush(process.stderr)]);
|
|
112
|
+
parentPort.postMessage(reply);
|
|
122
113
|
});
|
package/dist/worker.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
//
|
|
6
6
|
// See README.md for the contract, and specs/external-task-queue.md for the queue itself.
|
|
7
7
|
import { readFileSync } from "node:fs";
|
|
8
|
-
import { evaluate } from "./eval.js";
|
|
8
|
+
import { Cancelled, evaluate } from "./eval.js";
|
|
9
9
|
const SERVER = (process.env.GENROC_SERVER ?? "http://localhost:8448").replace(/\/$/, "");
|
|
10
10
|
const WORKER_ID = process.env.WORKER_ID ?? `evaluator-${process.pid}`;
|
|
11
11
|
// The credential, when the server runs with --auth token. A worker needs exactly the `worker`
|
|
@@ -185,7 +185,7 @@ async function answer(token, outcome) {
|
|
|
185
185
|
console.error(`genroc refused the outcome for ${token}: ${JSON.stringify(data)}`);
|
|
186
186
|
await release(token);
|
|
187
187
|
}
|
|
188
|
-
async function run(job) {
|
|
188
|
+
async function run(job, signal) {
|
|
189
189
|
let resolved;
|
|
190
190
|
try {
|
|
191
191
|
resolved = await resolveObjects(job);
|
|
@@ -206,9 +206,17 @@ async function run(job) {
|
|
|
206
206
|
}
|
|
207
207
|
let result;
|
|
208
208
|
try {
|
|
209
|
-
result = await evaluate(req);
|
|
209
|
+
result = await evaluate(req, signal);
|
|
210
210
|
}
|
|
211
211
|
catch (err) {
|
|
212
|
+
// Cancelled is not a fault: the process was stopped while this ran. The claim still goes
|
|
213
|
+
// back — the row is terminal, so nothing re-claims it, and the release is what stops it
|
|
214
|
+
// waiting out a lease nobody is serving.
|
|
215
|
+
if (err instanceof Cancelled) {
|
|
216
|
+
console.log(`cancelled: ${job.token}`);
|
|
217
|
+
await release(job.token);
|
|
218
|
+
return;
|
|
219
|
+
}
|
|
212
220
|
// The RUNNER faulted, not the script — the one class where a retry can help. There is no
|
|
213
221
|
// error code for it on purpose: releasing the claim is how a queue spells "retryable", and
|
|
214
222
|
// it puts the task in front of a different worker instead of burning the definition's
|
|
@@ -245,11 +253,22 @@ async function renewLoop() {
|
|
|
245
253
|
tokens,
|
|
246
254
|
lease_ms: LEASE_MS,
|
|
247
255
|
});
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
//
|
|
251
|
-
|
|
252
|
-
|
|
256
|
+
if (!ok)
|
|
257
|
+
continue;
|
|
258
|
+
// Cancelled: the process was stopped, so the evaluation is abandoned and the claim handed
|
|
259
|
+
// back. Aborting first is the point of the list — waiting for the script to finish would
|
|
260
|
+
// keep burning a core on work an operator has already stopped. The release rides run()'s
|
|
261
|
+
// own catch, so nothing is released twice.
|
|
262
|
+
for (const token of (data?.cancelled ?? [])) {
|
|
263
|
+
inFlight.get(token)?.abort.abort();
|
|
264
|
+
}
|
|
265
|
+
// Lost: someone else holds this claim now. The work continues and its answer will be
|
|
266
|
+
// refused — that is not fixable here — but say so, because it is the signal that LEASE_MS
|
|
267
|
+
// is too short for what these scripts actually take. Deliberately NOT released: the claim
|
|
268
|
+
// is the new holder's, and releasing would bump the epoch out from under it.
|
|
269
|
+
const lost = (data?.lost ?? []);
|
|
270
|
+
if (lost.length) {
|
|
271
|
+
console.error(`lost ${lost.length}/${tokens.length} claims; a lease lapsed under load`);
|
|
253
272
|
}
|
|
254
273
|
}
|
|
255
274
|
}
|
|
@@ -258,8 +277,9 @@ async function pollLoop() {
|
|
|
258
277
|
const free = CONCURRENCY - inFlight.size;
|
|
259
278
|
const jobs = free > 0 ? await claim(free) : [];
|
|
260
279
|
for (const job of jobs) {
|
|
261
|
-
|
|
262
|
-
|
|
280
|
+
const abort = new AbortController();
|
|
281
|
+
inFlight.set(job.token, { job, abort });
|
|
282
|
+
void run(job, abort.signal).finally(() => inFlight.delete(job.token));
|
|
263
283
|
}
|
|
264
284
|
// Only idle when there was nothing to take: a full queue should be drained at the speed the
|
|
265
285
|
// realms allow, not at the poll interval.
|
package/eval.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
// Evaluation core:
|
|
2
|
-
// the failure kinds in README.md. Nothing here knows about
|
|
3
|
-
// thing that talks to the queue — so this stays testable and
|
|
1
|
+
// Evaluation core: import a script module in its OWN realm, call its default export, and
|
|
2
|
+
// classify every outcome into one of the failure kinds in README.md. Nothing here knows about
|
|
3
|
+
// genroc — worker.ts is the only thing that talks to the queue — so this stays testable and
|
|
4
|
+
// the containment stays swappable.
|
|
4
5
|
//
|
|
5
6
|
// The containment is a Worker per execution (realm.ts). It is what makes the budget real:
|
|
6
7
|
// a synchronous busy loop never yields, so no in-process timer can interrupt it, and only a
|
|
@@ -9,6 +10,7 @@
|
|
|
9
10
|
import { Worker } from "node:worker_threads";
|
|
10
11
|
|
|
11
12
|
export type EvalRequest = {
|
|
13
|
+
/** An ES module whose default export is the function to run; `input` is its argument. */
|
|
12
14
|
code: string;
|
|
13
15
|
input?: unknown;
|
|
14
16
|
timeout_ms?: number;
|
|
@@ -55,14 +57,32 @@ class RealmFault extends Error {
|
|
|
55
57
|
}
|
|
56
58
|
}
|
|
57
59
|
|
|
58
|
-
|
|
60
|
+
/** Thrown when `signal` aborts: the work was cancelled server-side, so there is no outcome to
|
|
61
|
+
* report and worker.ts must release rather than answer. Distinct from RealmFault because the
|
|
62
|
+
* runner did not fault -- nothing is wrong, the answer is simply no longer wanted. */
|
|
63
|
+
export class Cancelled extends Error {
|
|
64
|
+
constructor() {
|
|
65
|
+
super("cancelled");
|
|
66
|
+
this.name = "Cancelled";
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
export async function evaluate(req: EvalRequest, signal?: AbortSignal): Promise<EvalResult> {
|
|
59
71
|
const budget = typeof req.timeout_ms === "number" ? req.timeout_ms : DEFAULT_TIMEOUT_MS;
|
|
60
72
|
|
|
61
73
|
const worker = new Worker(REALM_URL);
|
|
62
74
|
let timer: ReturnType<typeof setTimeout> | undefined;
|
|
75
|
+
let onAbort: (() => void) | undefined;
|
|
63
76
|
try {
|
|
64
77
|
return await new Promise<EvalResult>((resolve, reject) => {
|
|
65
78
|
timer = setTimeout(() => resolve(timedOut(budget)), budget);
|
|
79
|
+
// The abort is wired to the same promise as the budget, so both settle through the one
|
|
80
|
+
// finally below -- which is what guarantees the thread is gone before either returns.
|
|
81
|
+
if (signal) {
|
|
82
|
+
if (signal.aborted) reject(new Cancelled());
|
|
83
|
+
onAbort = () => reject(new Cancelled());
|
|
84
|
+
signal.addEventListener("abort", onAbort, { once: true });
|
|
85
|
+
}
|
|
66
86
|
worker.once("message", (reply: WorkerReply) => resolve(reply));
|
|
67
87
|
// A script may end its own realm (`process.exit()`), which is not a throw and would
|
|
68
88
|
// otherwise present as a hang until the budget expired. Our own terminate() raises
|
|
@@ -73,6 +93,7 @@ export async function evaluate(req: EvalRequest): Promise<EvalResult> {
|
|
|
73
93
|
});
|
|
74
94
|
} finally {
|
|
75
95
|
clearTimeout(timer);
|
|
96
|
+
if (signal && onAbort) signal.removeEventListener("abort", onAbort);
|
|
76
97
|
// Awaited, and the whole point: on the timeout path a thread is still burning a core, and
|
|
77
98
|
// resolving before it is gone would report an evaluation the machine is still running.
|
|
78
99
|
await worker.terminate();
|