@genroc/eval-node 0.0.0-edge.bac4287 → 0.0.0-edge.bcaf34e

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -26,7 +26,7 @@ resolver's exit code, so a stored definition cannot hold code that failed to typ
 
 ## Building
 
-    npm run build       # tsc -p tsconfig.build.json -> dist/
+    pnpm run build      # tsc -p tsconfig.build.json -> dist/
 
 The published package is JavaScript, not TypeScript. **Node refuses to strip types for files
 under `node_modules`**, so shipping `.ts` works from a checkout and fails for every consumer —
@@ -90,6 +90,23 @@ queue worker rather than the HTTP sidecar it used to be:
   that genroc had to be able to reach. A worker only needs outbound access, so it can live
   anywhere — behind NAT, in another trust zone.
 
+The cost of that inversion is that genroc cannot reach a running worker, so anything it needs
+to say has to ride the renewal the worker already makes. **Renewing is therefore mandatory,
+not an optimisation** — a worker that stops renewing is indistinguishable from one that died.
+The response answers per token:
+
+| list | what it means | what this worker does |
+|---|---|---|
+| `renewed` | still yours | carry on |
+| `lost` | already someone else's | stop; do **not** release — that would bump the new holder's claim |
+| `cancelled` | still yours, nobody wants it | abort the script and release the claim |
+
+`cancelled` is how an operator's `genctl cancel` reaches work already running: the evaluation
+is aborted through an `AbortSignal`, its realm is terminated, and no outcome is submitted —
+the process is stopping, so there is nothing left to answer. `renew_before_ms` on the claim
+says how long the worker may wait before renewing again, so the interval is a value it reads
+rather than one it guesses.
+
 ## The task input
 
 The `input` of the external task IS the evaluation request:

package/dist/eval.js

@@ -20,13 +20,31 @@ class RealmFault extends Error {
         this.name = "RealmFault";
     }
 }
-export async function evaluate(req) {
+/** Thrown when `signal` aborts: the work was cancelled server-side, so there is no outcome to
+ *  report and worker.ts must release rather than answer. Distinct from RealmFault because the
+ *  runner did not fault -- nothing is wrong, the answer is simply no longer wanted. */
+export class Cancelled extends Error {
+    constructor() {
+        super("cancelled");
+        this.name = "Cancelled";
+    }
+}
+export async function evaluate(req, signal) {
     const budget = typeof req.timeout_ms === "number" ? req.timeout_ms : DEFAULT_TIMEOUT_MS;
     const worker = new Worker(REALM_URL);
     let timer;
+    let onAbort;
     try {
         return await new Promise((resolve, reject) => {
             timer = setTimeout(() => resolve(timedOut(budget)), budget);
+            // The abort is wired to the same promise as the budget, so both settle through the one
+            // finally below -- which is what guarantees the thread is gone before either returns.
+            if (signal) {
+                if (signal.aborted)
+                    reject(new Cancelled());
+                onAbort = () => reject(new Cancelled());
+                signal.addEventListener("abort", onAbort, { once: true });
+            }
             worker.once("message", (reply) => resolve(reply));
             // A script may end its own realm (`process.exit()`), which is not a throw and would
             // otherwise present as a hang until the budget expired. Our own terminate() raises
@@ -38,6 +56,8 @@ export async function evaluate(req) {
     }
     finally {
         clearTimeout(timer);
+        if (signal && onAbort)
+            signal.removeEventListener("abort", onAbort);
         // Awaited, and the whole point: on the timeout path a thread is still burning a core, and
         // resolving before it is gone would report an evaluation the machine is still running.
         await worker.terminate();

package/dist/worker.js

@@ -5,7 +5,7 @@
 //
 // See README.md for the contract, and specs/external-task-queue.md for the queue itself.
 import { readFileSync } from "node:fs";
-import { evaluate } from "./eval.js";
+import { Cancelled, evaluate } from "./eval.js";
 const SERVER = (process.env.GENROC_SERVER ?? "http://localhost:8448").replace(/\/$/, "");
 const WORKER_ID = process.env.WORKER_ID ?? `evaluator-${process.pid}`;
 // The credential, when the server runs with --auth token. A worker needs exactly the `worker`
@@ -185,7 +185,7 @@ async function answer(token, outcome) {
     console.error(`genroc refused the outcome for ${token}: ${JSON.stringify(data)}`);
     await release(token);
 }
-async function run(job) {
+async function run(job, signal) {
     let resolved;
     try {
         resolved = await resolveObjects(job);
@@ -206,9 +206,17 @@ async function run(job) {
     }
     let result;
     try {
-        result = await evaluate(req);
+        result = await evaluate(req, signal);
     }
     catch (err) {
+        // Cancelled is not a fault: the process was stopped while this ran. The claim still goes
+        // back — the row is terminal, so nothing re-claims it, and the release is what stops it
+        // waiting out a lease nobody is serving.
+        if (err instanceof Cancelled) {
+            console.log(`cancelled: ${job.token}`);
+            await release(job.token);
+            return;
+        }
         // The RUNNER faulted, not the script — the one class where a retry can help. There is no
         // error code for it on purpose: releasing the claim is how a queue spells "retryable", and
         // it puts the task in front of a different worker instead of burning the definition's
@@ -245,11 +253,22 @@ async function renewLoop() {
             tokens,
             lease_ms: LEASE_MS,
         });
-        // A short count means a claim lapsed and was taken over. Nothing to do about it — the work
-        // continues and its answer will be refused — but say so, because it is the signal that
-        // LEASE_MS is too short for what these scripts actually take.
-        if (ok && data?.renewed < tokens.length) {
-            console.error(`renewed ${data.renewed}/${tokens.length} claims; a lease lapsed under load`);
+        if (!ok)
+            continue;
+        // Cancelled: the process was stopped, so the evaluation is abandoned and the claim handed
+        // back. Aborting first is the point of the list — waiting for the script to finish would
+        // keep burning a core on work an operator has already stopped. The release rides run()'s
+        // own catch, so nothing is released twice.
+        for (const token of (data?.cancelled ?? [])) {
+            inFlight.get(token)?.abort.abort();
+        }
+        // Lost: someone else holds this claim now. The work continues and its answer will be
+        // refused — that is not fixable here — but say so, because it is the signal that LEASE_MS
+        // is too short for what these scripts actually take. Deliberately NOT released: the claim
+        // is the new holder's, and releasing would bump the epoch out from under it.
+        const lost = (data?.lost ?? []);
+        if (lost.length) {
+            console.error(`lost ${lost.length}/${tokens.length} claims; a lease lapsed under load`);
         }
     }
 }
@@ -258,8 +277,9 @@ async function pollLoop() {
         const free = CONCURRENCY - inFlight.size;
         const jobs = free > 0 ? await claim(free) : [];
         for (const job of jobs) {
-            inFlight.set(job.token, job);
-            void run(job).finally(() => inFlight.delete(job.token));
+            const abort = new AbortController();
+            inFlight.set(job.token, { job, abort });
+            void run(job, abort.signal).finally(() => inFlight.delete(job.token));
         }
         // Only idle when there was nothing to take: a full queue should be drained at the speed the
         // realms allow, not at the poll interval.

package/eval.ts

@@ -57,14 +57,32 @@ class RealmFault extends Error {
   }
 }
 
-export async function evaluate(req: EvalRequest): Promise<EvalResult> {
+/** Thrown when `signal` aborts: the work was cancelled server-side, so there is no outcome to
+ *  report and worker.ts must release rather than answer. Distinct from RealmFault because the
+ *  runner did not fault -- nothing is wrong, the answer is simply no longer wanted. */
+export class Cancelled extends Error {
+  constructor() {
+    super("cancelled");
+    this.name = "Cancelled";
+  }
+}
+
+export async function evaluate(req: EvalRequest, signal?: AbortSignal): Promise<EvalResult> {
   const budget = typeof req.timeout_ms === "number" ? req.timeout_ms : DEFAULT_TIMEOUT_MS;
 
   const worker = new Worker(REALM_URL);
   let timer: ReturnType<typeof setTimeout> | undefined;
+  let onAbort: (() => void) | undefined;
   try {
     return await new Promise<EvalResult>((resolve, reject) => {
       timer = setTimeout(() => resolve(timedOut(budget)), budget);
+      // The abort is wired to the same promise as the budget, so both settle through the one
+      // finally below -- which is what guarantees the thread is gone before either returns.
+      if (signal) {
+        if (signal.aborted) reject(new Cancelled());
+        onAbort = () => reject(new Cancelled());
+        signal.addEventListener("abort", onAbort, { once: true });
+      }
       worker.once("message", (reply: WorkerReply) => resolve(reply));
       // A script may end its own realm (`process.exit()`), which is not a throw and would
       // otherwise present as a hang until the budget expired. Our own terminate() raises
@@ -75,6 +93,7 @@ export async function evaluate(req: EvalRequest): Promise<EvalResult> {
     });
   } finally {
     clearTimeout(timer);
+    if (signal && onAbort) signal.removeEventListener("abort", onAbort);
     // Awaited, and the whole point: on the timeout path a thread is still burning a core, and
     // resolving before it is gone would report an evaluation the machine is still running.
     await worker.terminate();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@genroc/eval-node",
-  "version": "0.0.0-edge.bac4287",
+  "version": "0.0.0-edge.bcaf34e",
   "type": "module",
   "engines": {
     "node": ">=24"

package/worker.ts

@@ -6,7 +6,7 @@
 // See README.md for the contract, and specs/external-task-queue.md for the queue itself.
 
 import { readFileSync } from "node:fs";
-import { evaluate, type EvalRequest, type FailureKind } from "./eval.ts";
+import { Cancelled, evaluate, type EvalRequest, type FailureKind } from "./eval.ts";
 
 const SERVER = (process.env.GENROC_SERVER ?? "http://localhost:8448").replace(/\/$/, "");
 const WORKER_ID = process.env.WORKER_ID ?? `evaluator-${process.pid}`;
@@ -135,7 +135,12 @@ function asEvalRequest(input: unknown): EvalRequest | string {
   };
 }
 
-const inFlight = new Map<string, QueueTask>();
+/** A claim this worker is currently serving. The controller is how the renewal loop reaches
+ *  the evaluation: genroc cannot call us, so a cancellation arrives as an answer to our own
+ *  heartbeat and has to be delivered inward from there. */
+type Running = { job: QueueTask; abort: AbortController };
+
+const inFlight = new Map<string, Running>();
 let running = true;
 
 // Whether the last claim reached genroc. A worker polls several times a second, so an
@@ -203,7 +208,7 @@ async function answer(token: string, outcome: Record<string, unknown>): Promise<
   await release(token);
 }
 
-async function run(job: QueueTask): Promise<void> {
+async function run(job: QueueTask, signal: AbortSignal): Promise<void> {
   let resolved: unknown;
   try {
     resolved = await resolveObjects(job);
@@ -224,8 +229,16 @@ async function run(job: QueueTask): Promise<void> {
 
   let result;
   try {
-    result = await evaluate(req);
+    result = await evaluate(req, signal);
   } catch (err) {
+    // Cancelled is not a fault: the process was stopped while this ran. The claim still goes
+    // back — the row is terminal, so nothing re-claims it, and the release is what stops it
+    // waiting out a lease nobody is serving.
+    if (err instanceof Cancelled) {
+      console.log(`cancelled: ${job.token}`);
+      await release(job.token);
+      return;
+    }
     // The RUNNER faulted, not the script — the one class where a retry can help. There is no
     // error code for it on purpose: releasing the claim is how a queue spells "retryable", and
     // it puts the task in front of a different worker instead of burning the definition's
@@ -263,11 +276,22 @@ async function renewLoop(): Promise<void> {
       tokens,
       lease_ms: LEASE_MS,
     });
-    // A short count means a claim lapsed and was taken over. Nothing to do about it — the work
-    // continues and its answer will be refused — but say so, because it is the signal that
-    // LEASE_MS is too short for what these scripts actually take.
-    if (ok && data?.renewed < tokens.length) {
-      console.error(`renewed ${data.renewed}/${tokens.length} claims; a lease lapsed under load`);
+    if (!ok) continue;
+
+    // Cancelled: the process was stopped, so the evaluation is abandoned and the claim handed
+    // back. Aborting first is the point of the list — waiting for the script to finish would
+    // keep burning a core on work an operator has already stopped. The release rides run()'s
+    // own catch, so nothing is released twice.
+    for (const token of (data?.cancelled ?? []) as string[]) {
+      inFlight.get(token)?.abort.abort();
+    }
+    // Lost: someone else holds this claim now. The work continues and its answer will be
+    // refused — that is not fixable here — but say so, because it is the signal that LEASE_MS
+    // is too short for what these scripts actually take. Deliberately NOT released: the claim
+    // is the new holder's, and releasing would bump the epoch out from under it.
+    const lost = (data?.lost ?? []) as string[];
+    if (lost.length) {
+      console.error(`lost ${lost.length}/${tokens.length} claims; a lease lapsed under load`);
     }
   }
 }
@@ -277,8 +301,9 @@ async function pollLoop(): Promise<void> {
     const free = CONCURRENCY - inFlight.size;
     const jobs = free > 0 ? await claim(free) : [];
     for (const job of jobs) {
-      inFlight.set(job.token, job);
-      void run(job).finally(() => inFlight.delete(job.token));
+      const abort = new AbortController();
+      inFlight.set(job.token, { job, abort });
+      void run(job, abort.signal).finally(() => inFlight.delete(job.token));
     }
     // Only idle when there was nothing to take: a full queue should be drained at the speed the
     // realms allow, not at the poll interval.