@genroc/eval-node 0.0.0-edge.51cbf37 → 0.0.0-edge.51f2744b

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

@@ -1,313 +1,145 @@
 # @genroc/eval-node
 
-Script tasks for Node. Two halves with different jobs:
+TypeScript script tasks for [genroc](https://genroc.org). The package provides two binaries:
 
-* **the bundler** (`genroc-import`) — an author-time resolver genctl runs on every apply and
-  every edit, turning `$import: ./x.ts` into a bundled, typechecked string
-* **the worker** (`genroc-eval-node`) — claims parked `external` script tasks off genroc's queue
-  and evaluates each in its own realm
+* **`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.
 
-## Setting up a project
+Requires **Node 24+**. Full guide:
+[TypeScript evaluation](https://genroc.org/guides/process-definition/typescript-evaluation/).
 
-    npm i -D @genroc/eval-node
-
-Then register the resolver in a `.genroc` beside your definitions — a dotfile, so it does not
-read as another process definition. Discovery walks up from the source file, so nothing depends
-on the cwd:
-
-    resolvers:
-      import:
-        phase: code
-        ext: .ts
-        command: [npx, genroc-import]
-
-`genctl apply` and `genctl types` now resolve `$import` directives. Typechecking is the
-resolver's exit code, so a stored definition cannot hold code that failed to typecheck.
-
-## Building
-
-    npm 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 —
-which is why `prepublishOnly` builds and CI installs the packed tarball rather than only running
-from source. The source keeps its `.ts` import extensions; `rewriteRelativeImportExtensions`
-turns them into `.js` on the way out.
-
-## Running the worker
-
-    docker run -e GENROC_SERVER=http://host:8448 ghcr.io/genroc/eval-node:preview
-
-or locally, if you already have Node:
-
-    GENROC_SERVER=http://localhost:8448 npx genroc-eval-node
-
-Add `GENROC_TOKEN` once the server has auth on; `worker` is the only permission it needs.
+## Quick start
 
-**The bundler cannot be the image.** It runs per edit and must resolve your project's own
-`node_modules`, so a container start per invocation would break the editor loop.
+    genctl init --eval-node
 
-Design record: [specs/external-task-queue.md](../specs/external-task-queue.md) for the queue,
-[specs/script-tasks.md](../specs/script-tasks.md) for the runtime.
+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.
 
-    GENROC_SERVER=http://localhost:8448 node eval-node/worker.ts
+## Adding it to an existing project
 
-Against a server started with `--auth token`, mint a scoped credential first:
-
-    TOKEN=$(genctl token create --perms worker --label evaluator -q)
-    GENROC_SERVER=http://localhost:8448 GENROC_TOKEN=$TOKEN node eval-node/worker.ts
-
-`worker` reaches the four queue verbs and `GET /api/objects/{ref}` — enough to claim, fetch an
-externalized input and answer, and nothing else. This is the credential most likely to end up on
-a machine you trust least, so it is worth scoping rather than reusing an admin token: a leaked
-one cannot read a definition, list an instance, or mint another token.
-
-A credential problem **exits the worker** rather than being retried. Polling through a 401 looks
-like a healthy worker that never picks anything up, which is the worst shape to debug.
+    npm i -D @genroc/eval-node
 
-It needs **Node 24 or newer**: the sources are TypeScript and are run as-is, by Node's own
-type stripping.
+Register the resolver in the `.genroc` beside your definitions:
 
-| env | default | |
-|---|---|---|
-| `GENROC_SERVER` | `http://localhost:8448` | where to claim from |
-| `GENROC_TOKEN` | *(none)* | credential, when the server runs with `--auth token`. Needs the **`worker`** permission and nothing more |
-| `WORKER_ID` | `evaluator-<pid>` | the claim holder; renewals are scoped to it |
-| `CONCURRENCY` | `4` | how many scripts run at once — **this worker's** decision |
-| `LEASE_MS` | `30000` | visibility timeout; renewed at a third of it while working |
-| `POLL_MS` | `250` | idle poll interval; a non-empty claim polls again immediately |
-| `PROCESS` / `TASK` | unset | claim only this process / task id |
-
-**The worker calls genroc, not the other way round.** That is the whole reason this is a
-queue worker rather than the HTTP sidecar it used to be:
-
-- **Concurrency is the worker's to set.** Under the old `fetch` shape genroc decided how many
-  scripts ran at once (`--max-concurrent`, default 200) and the evaluator accepted every one.
-  A backlog is now a queue, not 200 threads fighting over a core.
-- **No engine worker is held.** A `fetch` occupies one of genroc's advance slots for its whole
-  duration, so a slow evaluator starved unrelated tasks. An `external` task parks.
-- **The connection direction inverts.** `/eval` was unauthenticated arbitrary code execution
-  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 task input
-
-The `input` of the external task IS the evaluation request:
-
-```jsonc
-{
-  "code": "return { fee: input.amount * 0.1 };",  // required — an async function body
-  "input": { "amount": 250 },                     // optional — bound as `input`
-  "timeout_ms": 5000                              // optional — default 5000
-}
+```yaml
+resolvers:
+  - name: import
+    phase: typed
+    ext: [.ts]
+    command: [npx, genroc-import]
+    types:
+      Input: task.action.input.input
+      Output: task.action.result
 ```
 
-`code` is the **body of an async function**, so `await` works and the value reaches genroc
-through `return`. It is compiled with `input` and `require` as parameters, under
-`"use strict"` — `require` is what a bundled `import` of a node builtin lands on.
-
-## The answer — the failure kind IS the error code
-
-genroc's `on_error` matches error codes, and an external task's `raises` declares the closed
-set a worker may send. So the classification lives in the **code**, where a rule can match it,
-rather than in a body a `switch` has to read.
-
-| outcome | the worker submits | |
-|---|---|---|
-| the script returned | `result: <the return value>` | `return;` sends nothing, which genroc reads as `null` |
-| the script faulted | `error: {code, message, data}` | `code` is the kind, below |
-| the **evaluator** faulted | *nothing* — it releases the claim | the task returns to the queue for another worker |
-
-The five kinds, every one of them **permanent** — a retry re-runs the same code on the same
-input and fails identically:
-
-`compile_error` · `threw` · `timeout` · `nonserializable` · `exited`
-
-`data` carries `{name, stack?}`: `name` is what a script sets to tell one refusal from another
-(`e.name = 'LimitExceeded'`), and `stack` is renumbered to the lines the author wrote and
-trimmed to 2 KiB.
-
-**The retryable class has no code on purpose.** A runner that faults releases its claim, which
-is how a queue spells "try this somewhere else" — it puts the task in front of a different
-worker instead of spending the definition's `on_error` budget on this one's bad day. There is
-no retry policy to write.
-
-## The genroc side
+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: price
+- id: greet
   action:
-    type: external
+    type: child
+    <<: "$process: ./script-node.genroc.yaml"
     input:
-      code: |
-        if (input.amount > 100) {
-          const e = new Error('amount over the limit');
-          e.name = 'LimitExceeded';
-          throw e;
-        }
-        return { fee: input.amount * 0.1 };
-      input: "$: input"
-    result_schema: { type: object, properties: { fee: { type: number } }, required: [fee] }
-    raises:
-      threw:           { $ref: "#/$defs/script_error" }
-      timeout:         { $ref: "#/$defs/script_error" }
-      compile_error:   { $ref: "#/$defs/script_error" }
-      nonserializable: { $ref: "#/$defs/script_error" }
-      exited:          { $ref: "#/$defs/script_error" }
-  timeout: 30s
-  on_error:
-    - code: [threw]
-      goto: $script_failed
-    - code: [compile_error, nonserializable, exited]
-      panic: { code: script_broken, message: "the script did not run: ${error.code}" }
-  switch: [{ goto: end }]
-
-- id: script_failed
-  switch:
-    - case: 'error.data.name == "LimitExceeded"'
-      raise: { code: limit_exceeded, message: "the script rejected the amount" }
-    - raise: { code: script_failed, message: "the script failed" }
-```
-
-**A script cannot name a genroc error code.** `raise`/`panic` codes are literals, never
-expressions, so the mapping from a thrown error to an authored code is this `switch` — one
-task the definition owns, reading `error.data`. That is the whole error protocol: the worker
-classifies into a code, the definition names the outcome.
-
-Set the task `timeout` **above** `timeout_ms`. If the task's deadline fires first the code is
-`external.timeout`, which is in `errcode.Unknowable()` — permanently unretryable on an
-`only_once` task, and indistinguishable from no evaluator running at all.
-
-`only_once` is worth considering if your scripts have side effects: without it a worker that
-dies mid-script has its task re-claimed and the script runs again. With it the task is never
-handed out twice, and the instance gets a catchable `external.lost` instead.
-
-## `${` must be escaped as `$${` — when the code is inline
-
-An external task's `input` is a Shape, so `${…}` is genroc's interpolation marker and a JS
-template literal inside `code` is read by genroc rather than passed through. Write `` `<$${x}>` ``.
-A leading `$:` on the code string needs `$$:` for the same reason. See
-[specs/typed-values.md](../specs/typed-values.md). Moving the code into a `.ts` file
-removes this entirely — see the next section.
-
-## `import.ts` — the author-time half
-
-`import.ts` is the **code-phase resolver** genctl runs before a definition is applied. It
-never touches the queue and the worker never runs it; the two halves share this package only
-because they share a calling convention, which is exactly the coupling that breaks silently
-if they version apart.
-
-Register it in the project's `.genroc`:
-
-```yaml
-resolvers:
-  import: { phase: code, ext: .ts, command: [node, ../eval-node/import.ts] }
+      code: "$import: ./greet.ts"
+      input: { who: "$: input.who" }
+    result_schema:
+      type: object
+      properties: { greeting: { type: string } }
+      required: [greeting]
 ```
 
-then write the script as a module and name it from the definition:
+## Writing a script
 
-```yaml
-body:
-  code: "$import: ./fee.ts"
-  input: "$: input"
-```
+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 "./fee.genroc";
+import type { Input, Output } from "./greet.genroc";
 
-export default async function (input: Input): Promise<Output> {
-  return { fee: input.amount * 0.1 };
+export default function (input: Input): Output {
+  return { greeting: `hello, ${input.who}` };
 }
 ```
 
-`genctl types -f process.yaml` writes `fee.genroc.d.ts` beside the script — named for the
-**script's path**, not the task, so renaming a task cannot break the import line. `Input` is
-the inferred type of what the definition passes; `Output` is what it declares
-(`responses.200`, or `result_schema` on a child). `genctl apply` regenerates them, runs
-`tsc --noEmit`, and bundles — so **a type error is a failed apply**, and a stored definition
-cannot hold code that failed to typecheck.
-
-The bundle is emitted as CJS and wrapped as a function body, so the evaluator needs to know
-nothing about modules. Imports resolve through TypeScript under the same config the check
-ran with, so a `paths` alias that typechecks also bundles. They are inlined at build time, so the string a
-definition version stores is self-contained forever — with one exception: **node builtins
-stay as `require` calls**, which the realm satisfies. A package is frozen into the
-definition; `node:fs` is resolved by whatever runner executes it.
+* `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.
 
-### Your tsconfig, your types
+## Running the worker
 
-The generated project config `extends` **the nearest `tsconfig.json` above the script** —
-the one your editor already reads, so the two cannot disagree. Two scripts under two
-different configs are two `tsc` runs.
+```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
+```
 
-Of that config, three keys are the toolchain's and the rest are yours:
+The worker connects to genroc, not the other way round, so it only needs outbound access.
 
-| key | owner | why |
+| env | default | |
 |---|---|---|
-| `lib` | the toolchain | Describes the realm. A worker thread has no `document`, whatever a config claims. |
-| `include` | the toolchain | Forced to `[]`. A base `include` survives beside our `files` and would drag your whole tree in to be checked as scripts. |
-| `types` | **you** | How a script opts into the node globals. The realm has them, so refusing the declarations would only lie. With no tsconfig at all the default is `[]`. |
-
-```jsonc
-// tsconfig.json beside your scripts
-{ "compilerOptions": { "types": ["node"] } }  // now `import { appendFile } from "node:fs/promises"` typechecks
-```
-
-**This is what removes the `$${` escaping above** — a template literal in a `.ts` file is
-never read by genroc, because genctl doubles every `$` on splice.
-
-## The realm — one Worker per execution
-
-`evaluate()` starts a Worker (`realm.ts`), posts the code into it, and races the reply against the budget;
-`terminate()` runs on every path. That thread is what the contract rests on, and it buys
-exactly three things the previous in-process evaluator could not:
-
-- **The budget is enforced, not merely reported.** A synchronous `while(true){}` never
-  yields, so no in-process timer can interrupt it — the old evaluator hung forever on that
-  input, and said so in this file. Killing the thread is the only bound. Measured on Node
-  24: `terminate()` stops a spinning worker, and the CPU it was burning goes with it.
-- **A fresh global object per execution.** One script cannot configure the next. It is also
-  why there is no compile cache any more: a cache inside a discarded realm can never be hit.
-- **The script's mistakes stay the script's.** An uncaught throw, and `process.exit()`, end
-  the realm and come back as a `422` — neither reaches the runner.
-
-It costs about **50ms per execution** end to end for a trivial script (Node 24, M-series
-laptop), a 200 KiB body about 63ms. Roughly 19ms of that is Node re-stripping `worker.ts`'s
-types on every realm — precompiling it to JavaScript would buy that back, and is deliberately
-not done: a build artefact that goes stale against its source fails silently, and this file
-is the one where a wrong line number is invisible.
-
-That also changes an old trade-off. A subprocess per execution measures ~48ms here — within
-noise of the thread — where on the previous runtime it was ten times the thread's cost. The
-thread no longer wins on price, and a subprocess contains the two things a thread cannot
-(below), so it is the live upgrade path rather than a theoretical one.
-
-## What this is not
-
-- **Not deterministic.** A script reads the real clock and the real RNG, and a retry
-  re-executes — so attempt two can differ from attempt one. An earlier version injected a
-  pinned `Date` and a seeded `Math`; nothing could supply a stable `now` (the expression
-  environment has no clock), so the pin was the wall clock under another name, and the `ctx`
-  it needed was surface with nothing behind it. A value that must survive a retry belongs in
-  the definition, passed through `input`.
-- **Not a sandbox.** The realm isolates *execution*, not *authority*: a script gets the
-  worker's filesystem, network and environment, and `require` of any node builtin. That is
-  deliberate — a script task is meant to do real work — but the trust boundary stays the
-  same-trust-domain one (your genroc, your worker host). It is not the multi-tenant story, and
-  nothing here should be mistaken for one. Pulling does move the boundary in one useful way:
-  the worker needs no inbound reachability, so nothing but the worker can ask it to run code.
-- **A thread does not contain memory or a native crash.** A worker shares the process
-  address space, so a script that exhausts memory takes the runner with it — and so does a
-  fault in the runtime itself, which is not hypothetical: the previous one segfaulted on
-  resume from laptop sleep, taking the in-flight evaluation with it. Containing that is what
-  the subprocess strategy is for — `eval.ts` keeps HTTP out precisely so it can be swapped
-  underneath.
-- **Concurrency is capped by this worker, not by genroc.** Each evaluation is a thread, and
-  `CONCURRENCY` is how many it will claim at once. Raising it past what the host can run turns
-  a queue back into threads fighting over a core.
-- **Not where imports and type checking happen.** The evaluator still takes one
-  self-contained function body and knows nothing about TypeScript; `import.ts` is what turns
-  a module into that body, at author time. See above.
-- **`eval.ts` and `realm.ts` know nothing about genroc.** `worker.ts` is the entire
-  queue-facing half, which is what keeps the containment strategy swappable — and what lets
-  the realm's own properties be tested by calling `evaluate()` directly.
+| `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` |
+| `PROCESS` / `TASK` | `script-node` / `eval_node` | the process and task id this worker claims; the defaults are script-node's. Set `PROCESS` for a renamed copy. Neither may be empty. |
+| `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)