@genroc/eval-node 0.0.0-edge.00cdd64d

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

@@ -0,0 +1,145 @@
+# @genroc/eval-node
+
+TypeScript script tasks for [genroc](https://genroc.org). The package provides two binaries:
+
+* **`genroc-import`**: the bundler. `genctl` runs it on every `apply` and `generate` to turn
+  `$import: ./script.ts` into one typechecked, self-contained module string.
+* **`genroc-eval-node`**: the worker. It claims script tasks from genroc's queue and runs each
+  one in a fresh worker thread.
+
+Requires **Node 24+**. Full guide:
+[TypeScript evaluation](https://genroc.org/guides/process-definition/typescript-evaluation/).
+
+## Quick start
+
+    genctl init --eval-node
+
+This scaffolds a project with everything set up: the package, a `.genroc` that registers the
+resolver, a `tsconfig.json`, a reusable `script-node` child process, and a `compose.yaml` that
+runs the worker.
+
+## Adding it to an existing project
+
+    npm i -D @genroc/eval-node
+
+Register the resolver in the `.genroc` beside your definitions:
+
+```yaml
+resolvers:
+  - name: import
+    phase: typed
+    ext: [.ts]
+    command: [npx, genroc-import]
+    types:
+      Input: task.action.input.input
+      Output: task.action.result
+```
+
+Then reference a script from a task. The simplest way is to spread the `script-node` child that
+`genctl init --eval-node` generates:
+
+```yaml
+- id: greet
+  action:
+    type: child
+    <<: "$process: ./script-node.genroc.yaml"
+    input:
+      code: "$import: ./greet.ts"
+      input: { who: "$: input.who" }
+    result_schema:
+      type: object
+      properties: { greeting: { type: string } }
+      required: [greeting]
+```
+
+## Writing a script
+
+A script is an ES module. Its default export receives `input`, and its return value becomes the
+task result. The function may be async.
+
+```ts
+import type { Input, Output } from "./greet.genroc";
+
+export default function (input: Input): Output {
+  return { greeting: `hello, ${input.who}` };
+}
+```
+
+* `genctl generate` writes `greet.genroc.d.ts` beside the script. `Input` and `Output` come from
+  the definition, so a mismatch fails the typecheck.
+* `genctl apply` typechecks and bundles. **A type error or a missing default export fails the
+  apply.**
+* Imported files and npm packages are inlined into the bundle, so a stored definition never
+  depends on what is installed later. Node builtins (`node:fs`, …) stay as imports and resolve
+  on the worker.
+* The generated config extends your nearest `tsconfig.json`. To use Node globals and
+  builtins, add `"types": ["node"]` to it.
+
+## Running the worker
+
+```sh
+docker run -e GENROC_SERVER=http://host:8448 ghcr.io/genroc/eval-node:latest
+# or
+GENROC_SERVER=http://localhost:8448 npx genroc-eval-node
+```
+
+The worker connects to genroc, not the other way round, so it only needs outbound access.
+
+| env | default | |
+|---|---|---|
+| `GENROC_SERVER` | `http://localhost:8448` | the genroc server |
+| `GENROC_TOKEN` / `GENROC_TOKEN_FILE` | *(none)* | token, or a file holding it, when the server uses `--auth token` |
+| `PROCESS` / `TASK` | `script-node` / `eval_node` | claim only this process / task id; the defaults are script-node's. Set `PROCESS` for a renamed copy, or `""` to drop a filter; **with both `""`, the worker claims every external task.** |
+| `CONCURRENCY` | `4` | scripts run at once |
+| `LEASE_MS` | `30000` | claim lease, renewed every third of it |
+| `POLL_MS` | `250` | idle poll interval |
+| `WORKER_ID` | `evaluator-<pid>` | the claim holder's name |
+
+With auth enabled, create a token that has only the `worker` permission:
+
+    genctl token create --perms worker --label evaluator -q
+
+If the token is rejected, the worker exits instead of retrying.
+
+## Errors
+
+When a script fails, the worker reports one of five error codes for your `on_error` rules to
+match. Retrying does not help with any of them, because the same code fails the same way:
+
+| code | when |
+|---|---|
+| `threw` | the script threw or rejected |
+| `timeout` | it ran past the task's `timeout` (5000 ms when the task has none) |
+| `compile_error` | the module does not parse, or has no default-export function |
+| `nonserializable` | the return value cannot be serialized to JSON (a cycle, a `BigInt`) |
+| `exited` | the script called `process.exit()` |
+
+`error.data` is `{name, stack?}`. `name` is the error's class name, so throwing your own
+`class LimitExceeded extends Error {}` tells your failures apart; setting `e.name` overrides it,
+and a thrown non-`Error` is `Thrown`. The stack is mapped back to your source lines.
+
+If the worker itself faults, it releases the task for another worker and reports no error.
+
+The task's `timeout` is the script's budget, waiting in the queue included. The worker stops
+the script just before it and answers `timeout`, so `external.timeout` means no worker answered
+at all. With `script-node`, set it through the `timeout_ms` input.
+
+## Limits
+
+* **Not a sandbox.** Scripts have the worker host's filesystem, network and environment.
+  Run only code you trust.
+* **Not deterministic.** On a retry the script runs again with the real clock and random
+  numbers. Pass any value that must stay stable through `input`.
+* **Memory is not isolated.** A script that runs out of memory takes down the whole worker.
+* **Run-once is opt-in.** If a worker dies mid-script, the task is claimed again and the script
+  runs again. Mark the task `only_once` if your script has side effects.
+* **Inline code needs escaping.** When you write `code` directly in YAML rather than
+  `$import`, write `${` as `$${`, because genroc reads `${` as interpolation. Scripts in `.ts`
+  files need no escaping.
+
+## Links
+
+* [TypeScript evaluation guide](https://genroc.org/guides/process-definition/typescript-evaluation/)
+* [External tasks and the queue](https://genroc.org/guides/process-definition/external-tasks/)
+* [Error handling](https://genroc.org/guides/process-definition/error-handling/)
+* [Source on GitHub](https://github.com/genroc/genroc/tree/main/eval-node)

package/dist/eval.js

@@ -0,0 +1,77 @@
+// Imports a script module in its own realm (a Worker per execution, realm.ts), calls its default
+// export, and classifies every outcome (README.md). Only a killable thread bounds a synchronous
+// busy loop, which is what makes the budget real. Knows nothing of genroc; worker.ts does.
+import { Worker } from "node:worker_threads";
+const DEFAULT_TIMEOUT_MS = 5_000;
+// Resolved from THIS file's own extension: run from a checkout it is `.ts`, and from the
+// published package `.js`, because Node will not strip types under node_modules.
+const REALM_URL = new URL(import.meta.url.endsWith(".ts") ? "./realm.ts" : "./realm.js", import.meta.url);
+/** Thrown, not returned: a realm that fails to start is the runner faulting, which worker.ts
+ *  answers by releasing the claim. */
+class RealmFault extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "RealmFault";
+    }
+}
+/** Thrown when `signal` aborts: the answer is no longer wanted, so worker.ts releases rather
+ *  than answers. Not a RealmFault: nothing is wrong. */
+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 `process.exit()`, which would otherwise look like a hang until the budget.
+            // Our own terminate() fires this too, after the promise has settled.
+            worker.once("exit", (code) => resolve(exited(code)));
+            worker.once("error", (err) => reject(new RealmFault(errorText(err))));
+            worker.postMessage({ code: req.code, input: req.input });
+        });
+    }
+    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();
+    }
+}
+function timedOut(ms) {
+    return {
+        ok: false,
+        failure: { kind: "timeout", name: "TimeoutError", message: `script exceeded its ${ms}ms budget` },
+    };
+}
+function exited(code) {
+    return {
+        ok: false,
+        failure: {
+            kind: "exited",
+            name: "RealmExited",
+            message: `the script ended its own realm with code ${code} instead of returning`,
+        },
+    };
+}
+function errorText(e) {
+    const message = e?.message;
+    return typeof message === "string" && message !== "" ? message : "the evaluation realm failed to start";
+}