diff --git a/.github/actions/node/action.yml b/.github/actions/node/action.yml index 706dbe19..ac9c6105 100644 --- a/.github/actions/node/action.yml +++ b/.github/actions/node/action.yml @@ -52,6 +52,13 @@ runs: - name: Run Node.js TCK Conformance if: always() && inputs.run-tck == 'true' + # This is the dedicated (master-only) TCK lane. The corpus is staged once + # by the shared TCK staging step earlier in the job (see main.yml). Set the + # require-corpus flag so a missing/empty staged corpus fails this job loudly + # instead of skipping silently (review #10 #7); local dev without the flag + # still skips. + env: + DATAWEAVE_TCK_REQUIRE_CORPUS: '1' run: | cd native-lib/node && npm run test:tck shell: bash diff --git a/.gitignore b/.gitignore index d80e42e8..5b69bc8e 100644 --- a/.gitignore +++ b/.gitignore @@ -32,3 +32,8 @@ grimoires/ # Superpowers implementation plans are local scratch artifacts, never commit them. /docs/superpowers/plans/ /docs/superpowers/plans/**/*.md + +# PR follow-up code-review notes are local scratch, keep them untracked. +/docs/pr-*-follow-up-*code-review*.md +# GA cleanup backlog is a local working note, keep it untracked. +/docs/ga-cleanup-backlog.md diff --git a/docs/superpowers/specs/ 2026-08-04-nodejs-external-modules-design.md b/docs/superpowers/specs/2026-08-04-nodejs-external-modules-design.md similarity index 100% rename from docs/superpowers/specs/ 2026-08-04-nodejs-external-modules-design.md rename to docs/superpowers/specs/2026-08-04-nodejs-external-modules-design.md diff --git a/docs/superpowers/specs/2026-08-07-native-lib-multi-engine-design.md b/docs/superpowers/specs/2026-08-07-native-lib-multi-engine-design.md new file mode 100644 index 00000000..5141ea56 --- /dev/null +++ b/docs/superpowers/specs/2026-08-07-native-lib-multi-engine-design.md @@ -0,0 +1,734 @@ +# Design: Multiple Isolated DataWeave Engines per Process (native-lib — Node & Python) + +**Date:** 2026-08-07 (consolidated 2026-08-25; unified Node + Python 2026-08-26) +**Status:** Approved and implemented on `w-23692110-multi-engine-design` (PR #157) +**Tracks:** GUS [W-23692110](https://gus.my.salesforce.com/lightning/r/ADM_Work__c/a07EE00002gS7SOYA0/view) — "Native-lib: support multiple DataWeave engine instances with independent module resolvers" +**Related:** [docs/superpowers/specs/2026-08-04-nodejs-external-modules-design.md](./2026-08-04-nodejs-external-modules-design.md) (the design during which this limitation was discovered) + +> **About this document.** This is the single, consolidated design for the multi-engine +> `native-lib` feature across **both** consumer bindings — Node and Python. It describes the +> **final state** as shipped on PR #157. The core feature (object-level engines behind opaque +> handles, one shared GraalVM isolate) is common to both bindings and is driven through the +> identical `*_engine` C ABI. Two substantial bodies of work are folded in here rather than kept +> as separate documents: the Node **concurrency & lifecycle model** (§6), hardened across a long +> series of code reviews, and the **Python unification** (§7) that removed the `ScriptRuntime` +> singleton and moved Python off its former isolate-per-instance model onto the shared model. +> A provenance map for git archaeology lives in the [Appendix](#appendix-hardening-provenance). +> The product-facing `DataWeave` classes are pre-GA, so several internal contracts (async Node +> `cleanup()`, the removed `*_with_resolver` and legacy-singleton C ABI) changed during this work +> without a compatibility ceremony. + +## 1. Goal + +Let multiple `DataWeave` instances coexist in one process — in **either** binding — each with its +own module resolver and script cache, so that different resolvers never collide. Before this +change the second `new DataWeave({ resolveModule })` in a Node process silently kept the first +instance's resolver, and Python achieved isolation only by paying for a whole GraalVM isolate per +instance. The isolation must hold with instances created, run, and torn down concurrently +(including across Node Worker threads and Python worker threads), without leaking native resources +or wedging the shared GraalVM isolate. A secondary goal, realized by the 2026-08-26 unification, is +that both bindings drive **one** shared Java engine layer through the **same** C ABI, so there is a +single mental model and a single source of truth to maintain. + +## 2. Background + +`native-lib`'s `ScriptRuntime` (`native-lib/src/main/java/org/mule/weave/lib/ScriptRuntime.java`) +was a `static final` singleton holding one `engine` and a **write-once** `static volatile resolver`. +`setResolver` refused to run a second time per process (logged a warning and returned). Every +`@CEntryPoint` in `NativeLib.java` routed through `ScriptRuntime.getInstance()`. So two +`DataWeave` instances in one process could not have independent module sets — whichever called a +resolver-backed `run()` first won. + +**This is not a GraalVM constraint.** `native-cli`'s `NativeRuntime` +(`native-cli/src/main/scala/org/mule/weave/dwnative/NativeRuntime.scala:50-60`) already builds one +independent `DataWeaveScriptingEngine` + `CompositeWeaveResourceResolver` per instance — there is +no shared static state there. GraalVM Java statics are scoped per-isolate, which is also why the +Python binding — which **originally** used one GraalVM isolate per `DataWeave()` instance — got +resolver isolation "for free." The limitation was specific to `native-lib`'s deliberate Java static +singleton plus the Node C addon's global resolver bridge. + +**Why unification followed.** The Node change (this PR's original scope) fixed Node but, for +backward compatibility, kept the `ScriptRuntime` singleton (`getInstance()`/`defaultInstance`) and +three legacy singleton C entrypoints (`run_script`, `run_script_callback`, +`run_script_input_output_callback`) because the Python binding still used them. A later rebase +exposed a collision: master had shipped a Python module-resolver feature calling a +`run_script_with_resolver` entrypoint that this branch's ABI redesign removed. Rather than maintain +two isolation models (Python isolate-per-instance vs. Node shared-isolate + handles) and a +compatibility shim, the maintainer chose to **unify**: remove the singleton entirely and put both +bindings on the shared-isolate + handle-addressed-engine model through the identical `*_engine` +ABI (§7). + +## 3. Scope + +**In scope:** +- `native-lib` Java layer: turn `ScriptRuntime` from a static singleton into a handle-addressable + registry of instances, each with its own engine + resolver; **remove** `getInstance()` / + `defaultInstance` so `ScriptRuntime` is purely handle-addressed. +- Node C addon (`native-lib/node/src/addon.c`): per-handle resolver bridge state instead of one + process-global bridge, plus the concurrency & lifecycle machinery in §6. +- Node TypeScript layer (`ffi.ts`, `dataweave.ts`, `stream.ts`, `reader.ts`): each `DataWeave` + instance owns an engine handle for its whole lifecycle. +- Python layer (`native-lib/python/src/dataweave/{native,runtime,models}.py`): move off + isolate-per-instance and off the legacy singleton onto a module-level reference-counted shared + isolate with one engine handle per `DataWeave` instance (§7). The public Python API is unchanged. + +**Out of scope:** +- Separate GraalVM isolates per engine — rejected as the isolation mechanism (see §5). +- Solving streaming/transform + **custom-module** resolution across the background-thread + boundary. Streaming against a resolver-backed engine still fails closed (returns "not found") + for custom modules reached from a background worker thread, in **both** bindings; built-in + modules continue to resolve normally in all cases. This is a pre-existing, documented hazard, + deliberately kept identical across bindings, not introduced here. + +## 4. Definitions + +- **Isolate** — the single process-wide GraalVM isolate. All engines share it. In Node its lifetime + is governed by `g_ref_count` (§6.1); in Python by `_isolate_ref_count` (§7). +- **Engine** — a `ScriptRuntime` Java object (own resolver + compiled-script cache) addressed by + an opaque `long long` handle. Many engines per isolate. +- **Init reference / isolate ref** — the reference-count unit a binding acquires per engine on + `initialize()` and releases on `cleanup()` (or on owner death). Distinct from an engine handle. +- **Op** — one in-flight `run()`/`runStreaming()`/`runTransform()` native call. +- **Owner env / owner thread** — the `napi_env` (and its JS thread) that created a given Node engine + or init reference. `napi_env`/`napi_ref`/`napi_deferred`/`napi_threadsafe_function` are + thread-affine; env-affine calls only ever happen on the owner thread. (Python has no `napi_env`; + its thread model is §7.) + +## 5. Alternatives Considered (isolation mechanism) + +**Separate GraalVM isolates per engine (rejected).** The most complete isolation (own heap, own +JIT, own Java statics), and what Python originally did per-instance. Rejected as the unifying model +for two reasons: + +- **Node cannot cheaply move to isolate-per-engine.** `addon.c` assumed exactly one isolate as + global state; supporting N isolates means restructuring all of that into per-handle structs, and + isolate teardown is fragile — `graal_tear_down_isolate` blocks until every attached thread + reaches a safepoint, and Node's streaming workers deliver chunks via a `napi_threadsafe_function` + that needs the libuv event loop to keep running. Multiplying that per-isolate is strictly worse + and discards the hardening work in §6. +- It is unnecessarily heavy for the actual need: independent module resolution and script caching, + not full JVM-level sandboxing. + +**Chosen: object-level engines in one shared isolate (for both bindings).** Multiple `ScriptRuntime` +Java objects, each with its own resolver and compiled-script cache, all in the single existing +GraalVM isolate, addressed by an opaque handle. Mirrors what `native-cli` already does and requires +no change to isolate lifecycle management for the *feature*. Node requires the careful +reference-and-teardown coordination in §6 because the isolate is shared by independently created and +destroyed engines across threads. **Python can adopt the same model trivially**: its ctypes calls +are synchronous and it owns its stream-worker threads directly, so it needs none of Node's +`PENDING_WAIT`/adoption/retry machinery — just a reference count and a synchronous +drain-before-teardown (§7). + +**Accepted trade-off (Python).** Python instances in one process now share one isolate's heap +instead of having separate heaps. This is weaker memory isolation, relevant only if +mutually-untrusted scripts run in one process expecting heap-level separation. The maintainer +accepted this in exchange for a single maintained model. + +## 6. Node Concurrency & Lifecycle Model + +This section governs how the shared isolate, per-engine registry entries, and in-flight ops +coordinate in the **Node** binding so that no thread ever attaches to, executes on, or resolves a +module against a torn-down isolate or a freed engine record, and no native resource leaks — under +concurrent creation, execution, abandonment (env death without `cleanup()`), and teardown across +Worker threads. (Python's simpler model is §7.) + +All shared C state is read and written **only under `g_mutex`**, with two documented exceptions: +the cheap top-of-function `!g_initialized` fast-path read (a benign optimization; the +authoritative check is under the lock), and the lock-free `g_isolate` NULL-check that narrows a +window before a guarded re-check. + +### 6.1 The reference-ownership invariant + +The isolate lives while any env holds an init reference. The governing invariant is: + +> **`g_ref_count` == Σ `init_refs` over all live per-env records.** + +`g_ref_count` is a derived total, not a bare global that any code path may drive to zero. +Reference accounting is **per `napi_env`**, tracked in a `g_mutex`-guarded linked list of +`env_init_rec_t { napi_env env; int init_refs; next; }`: + +- **`initialize()`** acquires one init reference *on the calling env's record* (find-or-create the + record, `init_refs++`, `g_ref_count++`, both under the same lock). The record registers exactly + one env-death hook (`env_init_cleanup`) on first creation. +- **`cleanup()`** releases one reference **only if the calling env owns one** (`init_refs > 0`). + A `cleanup()` with no matching `initialize()` on that env, or a double-`cleanup()`, is a no-op + that resolves immediately — it must never steal another env's reference and tear the isolate + down under a live user. +- **Env death** (`env_init_cleanup`, an env-cleanup hook) releases *all* of that env's remaining + references at once, from a single env-scoped decision point. This is what reclaims an abandoned + Worker that exited without calling `cleanup()`. +- **`destroyEngine` never releases an init reference** — engines and init references have distinct + lifetimes (Java registry entry vs. isolate). The product `doCleanup()` calls `destroyEngine` + then `ffi.cleanup()`; the latter is the sole release. + +Because every release is keyed on a specific env's balance, an abandoned env-A can only reach +`g_ref_count == 0` when no other env holds a reference — so it can never tear down the isolate +under a live env-B. This closes both the cross-env abandonment UAF and the symmetric +over-`cleanup()` UAF. + +The three `g_ref_count` mutators after this design are: the three `initialize()` acquire sites +(adoption / already-initialized fast path / create path), `release_isolate_ref_locked` (the +`cleanup()` path), and `env_init_cleanup` (env death, via the bounded multi-release helper +`isolate_ref_release_n_locked(n)`, which makes the reached-zero teardown decision *at most once* +regardless of how many references it drops). + +### 6.2 The teardown state machine + +When a release drops `g_ref_count` to 0, the isolate must be torn down — but only after every +in-flight op has drained, because `graal_tear_down_isolate` blocks until every GraalVM-attached +worker thread detaches, and those workers deliver chunks via a `napi_threadsafe_function` that +needs the JS event loop to run. A naïve synchronous join-on-teardown from the JS thread +therefore **deadlocks**: JS thread waits for teardown → teardown waits for the worker to detach → +the worker waits for the JS thread to run its chunk callback. + +The resolution is a `g_active_ops` counter (all in-flight ops, every engine, every thread) plus a +tri-state machine, all under `g_mutex`: + +``` +TEARDOWN_NONE no teardown queued or running. +TEARDOWN_PENDING_WAIT a reached-zero release queued a teardown; a detached waiter thread is + blocked on `while (g_active_ops > 0 && !g_teardown_cancelled)`. The + isolate is STILL LIVE here — a fresh initialize() may ADOPT it. +TEARDOWN_TEARING_DOWN the waiter passed the point of no return and is in + graal_tear_down_isolate(). Adoption is unsafe; initialize() blocks + (deadlock-free, because g_active_ops is already 0 — nothing depends on + the JS loop). +``` + +- **Reached-zero release, `g_active_ops == 0`:** synchronous fast path — spawn+join + `cleanup_thread_fn` inline (it attaches its own Graal thread, tears down, and reports + success only when `graal_tear_down_isolate` returns 0), then clear + `g_thread`/`g_isolate`/`g_initialized`/`g_ref_count`. +- **Reached-zero release, `g_active_ops > 0`:** set `TEARDOWN_PENDING_WAIT`, spawn the detached + waiter thread, return a pending promise. Each op's completion sentinel decrements `g_active_ops` + and broadcasts `g_teardown_cond`; when it reaches 0 the waiter publishes `TEARDOWN_TEARING_DOWN` + (under the lock, the point of no return) and tears down. +- **Adoption (the deadlock fix):** an `initialize()` arriving in `TEARDOWN_PENDING_WAIT` sets + `g_teardown_cancelled = true`, takes a fresh init reference, broadcasts, and returns — the + waiter re-checks the flag, tears down nothing, and resolves every queued `cleanup()` promise + anyway (from each caller's perspective the reference it dropped is gone, whether the isolate was + physically destroyed or adopted by a newcomer is immaterial). +- **Multiple concurrent `cleanup()` calls** waiting on the same teardown each append a node + `{env, deferred, tsfn}` to `g_teardown_waiters` — a *list*, because a second/third `cleanup()` + can arrive from a different Worker env, and each thread-affine deferred must be resolved via its + own env's tsfn on its own thread. + +**Teardown-failure retry signal.** If a reached-zero teardown cannot be carried out — waiter +alloc/spawn fails, `fn_attach_thread` fails, or `graal_tear_down_isolate` returns nonzero — the +isolate is left live with `g_ref_count == 0` and no owner. Rather than fabricate a phantom +reference (which would violate the §6.1 invariant and the resolved `cleanup()` promise's +contract), a `g_mutex`-guarded `g_teardown_needed` **retry signal** is armed. It is *not* a +reference (never added to any count). It is cleared when the isolate is actually torn down or +adopted. Retry runs at two natural, already-locked points: each op-completion drain (once +`g_active_ops` reaches 0), and the top of the next `napi_initialize` (before adoption, so a +pending teardown is honored rather than silently discarded). On a nonzero-return teardown the +helper threads also **detach** their local IsolateThread before exiting (the isolate is still +live; exiting attached would leave a phantom thread that blocks later retries). The documented, +accepted residual: if teardown fails *and* no later `initialize()` or op ever occurs, the isolate +lingers until process exit — benign (one process-lifetime isolate, no invariant violation), the +deliberate tradeoff for not adding event-loop-affine async retry infrastructure to this code. + +### 6.3 Per-engine records, admission pinning, and deferred destroy + +Every engine — resolver-backed **and** resolver-less — gets a per-engine record +(`engine_bridge_t`) at creation, linked into `g_bridges`, carrying `handle`, `in_flight`, +`destroy_pending`, `deferred_registry_remove`, and (for resolver-backed engines only) +`resolver_js`/`env`/`owner`/`results`. Resolver-less records leave those resolver fields +zero/NULL. `in_flight` (per-handle registry drain) and `g_active_ops` (global isolate teardown) +are **distinct counters**, never merged. + +**Admission pins the engine atomically.** Each of the three run paths reserves `g_active_ops` +*and* pins the engine (`in_flight++` via `bridge_begin_op_locked`) in the **same** critical +section as the lifecycle check, before any window a concurrent `destroyEngine` could use: + +```c +uv_mutex_lock(&g_mutex); +if (!g_initialized || (g_teardown_state != TEARDOWN_NONE && !g_teardown_cancelled)) { + uv_mutex_unlock(&g_mutex); + /* free partials */ napi_throw_error(env, NULL, "Not initialized. Call initialize() first."); + return NULL; +} +g_active_ops++; +w->bridge = bridge_begin_op_locked(handle); // NULL for unknown handle -> worker surfaces the envelope +uv_mutex_unlock(&g_mutex); +``` + +- **Streaming / transform** reserve *early* (arg extraction is cheap relative to the async op) and + release via the completion sentinel on the worker thread. Every early-return between admission + and worker spawn (conversion error, OOM, tsfn/promise-create failure, spawn failure) unwinds + **both** `g_active_ops` and the engine pin. +- **Synchronous `run()`** reserves *late* — immediately before `fn_attach_thread`, so the + reservation spans exactly the isolate-touching window (attach→detach) with only two unwind + sites (attach-failure and normal completion); the string mallocs and arg extraction don't touch + the isolate. +- **`createEngine` / `createEngineWithResolver`** likewise do their lifecycle check + a transient + `g_active_ops` reservation in one critical section, and additionally require that the **calling + env owns an init reference** (`init_refs > 0`) — an env that never initialized must not create + engines on the shared isolate. + +With the pin taken under the admission lock, a concurrent `destroyEngine` either runs entirely +before admission (the handle is already gone → worker surfaces `Unknown engine handle`, no freed +access) or entirely after (`in_flight > 0` → destroy defers). There is no interleaving where an +admitted op observes a freed bridge. + +**Deferred destroy.** `napi_destroy_engine`, under `g_mutex`: if `in_flight > 0`, set +`destroy_pending` and defer the Java-registry removal (`fn_destroy_engine`); the last op to drain +performs it on completion. If `in_flight == 0`, remove now. `fn_destroy_engine` is called +**exactly once** per handle (immediate xor deferred, never both), and it attaches its own fresh +Graal thread so it is safe to call from the completion sentinel or directly. + +**The registry-removal step is itself teardown-guarded.** Removing the Java registry entry +touches the isolate (`fn_attach_thread(g_isolate, …)`), so it is split into +`bridge_finalize_registry` — which takes its **own** transient `g_active_ops` reservation, gated +on `g_teardown_state != TEARDOWN_TEARING_DOWN && g_isolate != NULL` in the *same* critical section +as the increment — and `bridge_finalize_free` (napi_ref deletion, still resolver-gated and on the +owner thread; result-buffer free; `free`). This closes the race where a deferred finalize could +attach to an isolate the waiter is destroying, without re-opening the completion-path +coordination: the op's own `g_active_ops--` stays on the worker thread; the finalize takes a fresh +short-lived reservation only around the attach, makes no env-affine or JS-loop-dependent call, and +never holds it across a JS callback (so it cannot re-introduce the §6.2 deadlock). + +**Conditional bridge free (round 10, Task 6/svacas P1 confirmation).** When `bridge_finalize_registry` +reports the destroy was *skipped* while the isolate is still live (a transient `fn_attach_thread` +failure, not `TEARING_DOWN`/isolate-gone), `bridge_finalize` must not free the bridge — the Java +registry still holds it as a `CallbackWeaveResourceResolver` ctx, and freeing it would be a +use-after-free the next time that ctx is dereferenced. The bridge is instead moved onto +`g_stranded_bridges` (`bridge_retain_stranded`, list guarded by `g_mutex`) and retried by +`drain_stranded_bridges` at the next natural drain point (`napi_initialize`, op completion, +`cleanup`), which frees it only once the registry removal actually succeeds or the whole isolate has +since gone away. This is strictly better than the pre-fix behavior (an unconditional free on the +skipped-destroy path). One caveat, documented at the call sites in `addon.c`: a stranded bridge is +**not** `in_flight`-pinned the way a normally-admitted bridge is (§6.3's admission pinning above) — +it doesn't need to be under the supported single-owner-thread contract, because by the time a bridge +reaches this path its `in_flight` count has already drained to zero. The only way a drained-then-freed +stranded bridge could still be dereferenced is unsupported cross-Worker handle sharing or other API +misuse that starts a new operation against a handle that has already been unlinked from `g_bridges` +— not a case the supported API surface can reach. + +**Env cleanup hooks reclaim abandoned engines.** Every engine registers a +`napi_add_env_cleanup_hook` at creation (checked for failure — creation is all-or-nothing; on +hook-registration failure the record is unlinked, its registry entry removed, its init reference +released, and the create throws with no usable handle escaping). When the owner env dies without +`destroyEngine`, the hook removes the Java registry entry and frees the record. Because every +engine now carries an env-affine hook, the **owner-thread `destroyEngine` guard fires for any +record** (not only resolver-backed ones): `napi_remove_env_cleanup_hook` is valid only on the +owner env, so an engine is destroyable only from its creating thread. Node runs env-cleanup hooks +LIFO, and the per-env init-record hook is registered on the *first* `initialize()` (before any +engine) — so at env death every per-engine `bridge_env_cleanup` runs (isolate still alive) before +`env_init_cleanup` releases the isolate reference(s). Ordering preserved. + +### 6.4 JS instance lifecycle + +`DataWeave` models three states — `"uninitialized" | "ready" | "cleaning-up"` — not a boolean, +because a boolean cannot represent the window during which `cleanup()` has started but +`ffi.cleanup()` has not settled: + +- **`initialize()`** — `ready` → no-op; `cleaning-up` → **throws** `DataWeaveError("Cannot + initialize while cleanup is in progress; await cleanup() first.")`; `uninitialized` → does the + load/create-engine work, `state = "ready"` on success. On engine-creation failure *after* + `ffi.initialize()` succeeded, the rollback release is modeled as pending state: `state` goes + `cleaning-up` and `cleanupPromise` is assigned the `ffi.cleanup()` rollback (with a + `.catch(() => {})` so an un-awaited rollback never becomes an unhandledRejection), so a + concurrent `initialize()` is deterministically rejected instead of racing a fresh isolate + against the in-flight release. `initialize()` and `run()` stay **synchronous** (an async + signature would be an API break). +- **`run()` / `runStreaming()` / `runTransform()`** — gated by `ensureReady()`: throw + `DataWeaveError` unless `state === "ready"`, so the internal `engineHandle === null` cleanup + window is unreachable by any public method (defense-in-depth behind the C admission check). + `runTransform` additionally re-checks `ensureReady()` **after** `await createChunkReader(input)` + (async input pre-buffering can span arbitrary time; the instance may be cleaned up during it) so + a misused instance gets a synchronous `DataWeaveError` rather than a resolved `Unknown engine + handle` envelope. +- **`cleanup()` / `doCleanup()`** — set `state = "cleaning-up"` synchronously *before* + `ffi.destroyEngine` / `ffi.cleanup` (the key ordering). It always runs `await ffi.cleanup()` + even if `destroyEngine()` throws (a real path — wrong-thread destruction throws synchronously), + so a throwing destroy cannot strand this env's init reference; the destroy error is re-thrown + after the release. `engineHandle` is cleared regardless so a retry cannot double-destroy. + Overlapping calls coalesce on `this.cleanupPromise` (one native teardown). `cleanup()` returns + `Promise`. + +**Module-level convenience API** (`run`/`cleanup`) drives a lazily-created singleton: +- `getGlobalInstance()` initializes a **local candidate** and publishes `globalInstance` only after + `initialize()` succeeds — a failed first init leaves the singleton null so the next call retries + cleanly, instead of poisoning it into permanent "not initialized". +- Process exit hooks (`beforeExit` async-drains, `exit` best-effort sync) are registered **once + per process** (module-scoped `exitHooksRegistered`, never reset), not per singleton, so + init→cleanup→reinit cycles don't accumulate listeners. `exit` is documented as best-effort: + Node does not emit it for termination signals (SIGTERM/SIGKILL) or all fatal modes; callers + needing guaranteed graceful shutdown register and await their own signal handlers. +- Module-level `cleanup()` coalesces overlapping calls via a module-scoped `cleanupPromise` (it + nulls `globalInstance` synchronously so new work builds a fresh instance, but overlapping + `cleanup()`s await the same drain and resolve only when native teardown finishes). + +### 6.5 Robustness of native allocation and streaming + +- **OOM safety.** Every allocation in the streaming/transform setup, worker, and callback paths + (`calloc`/`malloc`/`strdup`/`memcpy`, and every `napi_create_string_utf8`/ + `napi_create_threadsafe_function`/`napi_create_promise`) is NULL/status-checked before use. + Setup-phase failures throw a synchronous `napi_throw_error(env, NULL, "OOM")` (matching + `napi_run_script_engine`) and unwind `g_active_ops` + the engine pin with no double-free + (`calloc`-zeroed `w` makes the free-set `free(NULL)`-safe). Worker-thread OOM produces a + **terminal error JSON result** (a static `{"success":false,"error":"Out of memory"}` string when + the copy itself failed, flagged so it is never `free()`d), never a hung promise. **The streaming + and transform completion sentinel (`struct chunk_data`, the `len == -1` terminal record) is now + pre-allocated in the synchronous setup path** (`w->sentinel`, allocated right before + `napi_create_promise`), not `malloc`'d on the worker's terminal path (round 10, Task 7). Before + this fix, a `malloc` failure on the worker's terminal path freed the work struct and returned + without ever enqueuing completion — the env was alive, so the JS promise never settled and the + tsfn was never released: a permanent hang, not a clean error. With the sentinel pre-allocated, + the worker's terminal completion path performs no allocation between the `g_active_ops--` + decrement and the unconditional tsfn enqueue, so that hang is now structurally impossible; a + setup-time sentinel-allocation failure instead unwinds cleanly and throws synchronous `"OOM"`, + identical to every other setup-phase allocation failure. +- **Argument validation.** Every FFI-facing entrypoint checks the status of every + `napi_get_value_*` conversion (handle `int64`, string size-probes and fills, `napi_typeof` for + nullable args) and throws before using the converted value, so a raw addon caller cannot turn a + malformed argument into an uninitialized native input. `inputCharset` is nullable + (`string | null | undefined`); any other type is rejected rather than silently coerced. The raw + `napi_initialize(libPath)` entrypoint now applies the same discipline to its own argument: it + checks `napi_get_cb_info`'s status, rejects a non-string `libPath` via `napi_typeof` before + touching it, and checks `napi_get_value_string_utf8`'s status — previously the argument was read + without any of these checks (round 10, Task 8). +- **Stream error propagation.** `streamFromNative` handles **both** settlement branches of the + native `start()` promise: on rejection it records the error, marks completion, and wakes every + parked `next()` consumer (otherwise the generator hangs forever and the rejection is unhandled), + then re-throws after draining any chunks that arrived first. Rejection is tracked by a dedicated + `startRejected` boolean, not a value sentinel, so `Promise.reject(undefined)` propagates + correctly. + +## 7. Python Lifecycle & Teardown Model + +Python drives the **same** shared Java engine layer and the **same** `*_engine` C ABI as Node, but +its isolate/thread glue (`native-lib/python/src/dataweave/native.py`) is much simpler than §6: +ctypes calls are synchronous and Python owns its stream-worker threads directly, so it needs none +of Node's `PENDING_WAIT`/adoption/retry machinery — just a reference count and a synchronous +drain-before-teardown. The **public Python API is unchanged** by the unification. + +### 7.1 Shared state and the reference-count invariant + +Module-level state in `native.py`, all mutations under one module lock (`_isolate_lock`): +`_lib`, `_lib_path`, `_isolate` (the single process-wide isolate, or None), `_isolate_ref_count`. + +> **Invariant:** `_isolate_ref_count` == number of live engines across all `DataWeave` instances, +> and the isolate exists iff the count > 0. + +Each `DataWeave` instance owns exactly one engine handle and contributes exactly one to the +refcount. The module lock guards only isolate refcount/create/teardown; it is **not** held during +script execution, so one engine's long-running script never blocks another engine's +`initialize()`/`run()`. Different instances can run concurrently, each on its own attached thread in +the shared isolate. + +### 7.2 No persistent isolate-thread attachment (attach-on-demand) + +`graal_tear_down_isolate` blocks forever waiting for every *other* GraalVM-attached thread to reach +a safepoint. If the isolate's creating ("bootstrap") thread stayed attached for the isolate's life, +a last-release teardown running on a *different* OS thread — e.g. an `atexit`/interpreter-shutdown +cleanup on the main thread after the first `run()` happened on a worker, or two instances torn down +from different threads — would block forever. The binding therefore holds **no persistent +attachment**, mirroring the Node and Go bindings: + +- **`_acquire_isolate`** (first ref): `graal_create_isolate`, then **immediately + `graal_detach_thread` on the bootstrap thread** (a nonzero return is surfaced as a + `DataWeaveError`). No IsolateThread is retained. +- **Every synchronous native call** (`run`, `run_callback`, `run_input_output_callback`, + `create_engine[_with_resolver]`, `destroy_engine`) attaches a **fresh** thread on demand, uses it + for the whole call, and detaches it when done (`_current_thread_attachment`). A stream-worker + thread that has already attached its own IsolateThread passes it through unchanged. +- **`_release_isolate`** (last ref): attaches a fresh thread solely to call + `graal_tear_down_isolate`. On success it clears the globals; on failure (attach failure, or + `graal_tear_down_isolate` itself failing) it now **retains the live isolate and arms + `_teardown_needed`** rather than nulling the globals — nulling on a failed teardown would let the + next `_acquire_isolate` build a second, racing isolate over the first one, which is still alive + (round 10, Task 2/3). `_acquire_isolate` checks `_teardown_needed` first and retries the pending + teardown before deciding whether to create a new isolate; a repeated failure re-arms the flag and + raises rather than proceeding. This mirrors Node's `g_teardown_needed` retryable-teardown model + (§6.2) — the two bindings now share one failure-recovery contract instead of Python's previous + unconditional-null behavior. + +Because nothing stays attached between calls, teardown never blocks on a phantom attachment +regardless of which OS thread performs the last release. + +### 7.3 Instance lifecycle + +- **`initialize()`** — under the lock, `_acquire_isolate` (create-on-first-ref + bootstrap detach, + `_isolate_ref_count += 1`); then `create_engine()` or `create_engine_with_resolver(ctx, trampoline)`, + storing the returned `handle` on the instance. If `create_engine` fails after the isolate ref was + taken, the instance releases the ref (tearing down if it was the only one) and — when a resolver + was installed before `initialize()` — unregisters its resolver token, so a failed init leaks + nothing (neither an isolate ref nor a `_resolver_registry` entry). +- **`run` / `run_streaming` / `run_callback` / `run_transform`** — route through the `*_engine` + entrypoints with the instance's `handle`, per §7.2's attachment rules. Per-instance execution is + serialized (`_serialized_native_operation`); different instances run concurrently. +- **`cleanup()`** — drain *this instance's* stream workers (signal cancel + **join** the threads; + synchronous, Python owns them, so no event loop and no deadlock); `destroy_engine(handle)`; remove + the resolver-map entry; clear the instance handle; then release the isolate ref (`-= 1`), tearing + the isolate down on the last release. `cleanup()` on an uninitialized/already-cleaned instance is a + no-op; double-`cleanup()` releases the ref only once (guarded by the instance handle being + cleared). If `destroy_engine` throws, the isolate ref is still released so a throwing destroy + cannot strand the isolate; the error is re-raised after the release. + +**Why this stays simple:** teardown happens only on the *last* release, by which point every +instance has already joined its own workers, so the isolate has no attached worker threads when +`graal_tear_down_isolate` runs. + +### 7.4 Resolver dispatch and the streaming/resolver hazard + +- `create_engine_with_resolver` passes an opaque `ctx` (a Python-allocated monotonic token + registered in `_resolver_registry[token] = self` *before* the create call, so no resolve callback + can fire for a handle before its map entry exists). Python registers **one** C trampoline + (`RESOLVE_MODULE_CALLBACK`); GraalVM calls it with `(thread, ctx, module_path)`, and it dispatches + to the engine's Python resolver via the registered token, returning the source-buffer pointer. + This is the Python analog of Node's per-handle bridge — same `ctx` concept, identical Java/ABI + side. +- **Streaming / transform + custom modules — parity with Node (out of scope):** the trampoline + resolves custom modules only when invoked on the engine's owner thread and **fails closed** + ("not found") on a background stream-worker thread. Built-in modules resolve normally everywhere; + synchronous `run()` with a resolver resolves custom modules fully. This is a conservative parity + choice (identical behavior across bindings), not a hard Python limitation. This scope is now + stated for end users directly (round 10, Task 13): both README's "Custom module resolution scope" + section (`native-lib/node/README.md`, `native-lib/python/README.md`) states the three-part rule — + a configured resolver applies to `run()`; built-ins resolve everywhere; custom modules fail closed + in streaming/transform/callback APIs — and the existing fail-closed behavior is covered by + `native-lib/node/tests/integration/dataweave-resolver.test.ts` (`runStreaming fails cleanly for a + custom module...`) and `native-lib/python/tests/integration/test_module_resolver.py` + (`test_resolver_is_inactive_for_resolver_less_apis_after_synchronous_install`, which additionally + covers `run_transform`, `run_callback`, and `run_input_output_callback`). + +## 8. Architecture (layer map) + +### Layer 1 — Java (`native-lib/src/main/java/org/mule/weave/lib/`) — shared by both bindings + +- **`ScriptRuntime.java`** — from static singleton to per-instance + a + `ConcurrentHashMap` registry with `register`/`get`/`destroy` and an + `AtomicLong` handle allocator. The resolver is bound once at construction (immutable for the + instance's lifetime); the `static setResolver` write-once mutation is removed. + `compositeResolver()` / `createModuleComponentsFactory()` become instance methods. + `getInstance()` / `defaultInstance` are **removed** — `ScriptRuntime` is purely handle-addressed. +- **`CallbackWeaveResourceResolver.java`** — stores a `PointerBase ctx` alongside the callback, + forwarded on every `callback.invoke(...)`; constructor `(ResolveModuleCallback, PointerBase ctx)`. +- **`NativeCallbacks.java`** — `ResolveModuleCallback` is the 3-arg ctx form + (`invoke(IsolateThread, PointerBase ctx, CCharPointer modulePath)`), mirroring the existing + `WriteCallback`/`ReadCallback` ctx idiom. This is what lets one shared native callback dispatch + to the correct per-handle resolver on the C/Python side. The old 2-arg form is gone. +- **`NativeLib.java`** — exposes only the handle-based lifecycle + execution entrypoints + (`create_engine`, `create_engine_with_resolver`, `destroy_engine`, `run_script_engine`, + `run_script_callback_engine`, `run_script_input_output_callback_engine`) resolving via + `ScriptRuntime.get(handle)`. The three legacy singleton entrypoints (`run_script`, + `run_script_callback`, `run_script_input_output_callback`) and the old `*_with_resolver` + entrypoints are **removed** (see §10). + +### Layer 2 — Node C addon (`native-lib/node/src/addon.c`) + +- Per-handle resolver bridge state in `g_bridges` (§6.3) instead of a process-global bridge. +- **Resolver dispatch:** `createEngineWithResolver` passes the bridge record's address as the + `ctx`; when Java invokes `resolve_module_callback(thread, ctx, path)`, C casts `ctx` back to the + bridge and calls its JS resolver **synchronously on the JS thread** (no + `napi_threadsafe_function` — the create call runs synchronously on the calling JS thread, so the + original deadlock rationale still holds). A per-handle `owner`-thread guard fails closed to "not + found" if `resolve_module_callback` is reached from a non-owner thread (e.g. a streaming worker). +- All of §6's machinery: `g_active_ops`, the `TEARDOWN_*` state machine, `g_teardown_cancelled`, + `g_teardown_needed`, the per-env `g_env_recs` list, the `g_bridges` list, admission pinning, and + the split finalize. The legacy `dw_napi_run_script` path and its `run_script` dlsym are removed. +- N-API methods: `createEngine`, `createEngineWithResolver`, `destroyEngine`, and handle-taking + `runScriptEngine`, `runScriptStreamingEngine`, `runScriptTransformEngine`. + +### Layer 3 — Node TypeScript (`native-lib/node/src/`) + +- **`ffi.ts`** — `createEngine`, `createEngineWithResolver`, `destroyEngine`, and handle-taking + `runScriptEngine`, `runScriptStreamingEngine`, `runScriptTransformEngine`. `runScript` / + `runWithResolver` removed. +- **`dataweave.ts`** — `DataWeave` owns a `private engineHandle`, the three-state lifecycle + machine, and the module-level singleton/exit-hook/coalescing logic (§6.4). `initialize()` calls + `ffi.createEngineWithResolver(this.resolveModule)` or `ffi.createEngine()`; run methods route + through the handle-based FFI (one code path per method, parameterized by handle); + `cleanup()` calls `ffi.destroyEngine` then `ffi.cleanup`. +- **`stream.ts`** — `streamFromNative` error propagation (§6.5). **`reader.ts`** — + `createChunkReader` pre-buffers async inputs (the native read callback is synchronous and cannot + await), which is why `runTransform` re-checks readiness after it. + +### Layer 4 — Python (`native-lib/python/src/dataweave/`) + +- **`native.py` (`NativeRuntime`)** — the shared-model glue (§7): module-level refcounted isolate, + attach-on-demand thread handling, the 3-arg ctx resolver trampoline + `_resolver_registry`, and + the `*_engine` + `create_engine[_with_resolver]` + `destroy_engine` symbol bindings. +- **`runtime.py` (`DataWeave`)** — `initialize()` acquires an isolate ref + creates one engine and + stores its `handle`; run methods route through the `*_engine` entrypoints with that handle; + `cleanup()` drains this instance's stream workers, `destroy_engine(handle)`, releases the ref. + The public API surface is unchanged. +- **`models.py`** — `RESOLVE_MODULE_CALLBACK` ctypes signature carries the `ctx` argument. + +## 9. Data Flow + +**Node:** +``` +new DataWeave({ resolveModule: A }).initialize() + → ffi.initialize() // env init record for this env: init_refs 0→1, g_ref_count++ + → ffi.createEngineWithResolver(A) + → addon.c: allocate bridge_A { env, ref to A, owner=thisThread, in_flight:0 }; register env hook + → Java: new CallbackWeaveResourceResolver(callback, ctx=&bridge_A); + new ScriptRuntime(resolver) → handle_A = register(rt) + → handle_A stored as this.engineHandle + +dwA.run(script importing "custom/lib.dwl") + → ffi.runScriptEngine(handle_A, script, inputs) + → addon.c: admission (g_active_ops++, in_flight++ on bridge_A) → attach → fn_run_script_engine + → Java: ScriptRuntime.get(handle_A).run(...) + composite resolver: ClassLoader miss → callback.invoke(thread, ctx=&bridge_A, "custom/lib.dwl") + → C: resolve_module_callback casts ctx→bridge_A; thread==owner? yes → call resolver A synchronously + → result flows back, script compiles; on completion: in_flight--, g_active_ops-- + +new DataWeave({ resolveModule: B }).initialize() → handle_B, bridge_B (independent resolver + owner) +dwB.run(...) → resolves via resolver B only; A's cache untouched; no cross-talk +``` + +**Python:** +``` +dwA = DataWeave(resolve_module=A); dwA.initialize() + → lock: _isolate None → graal_create_isolate() + detach bootstrap thread; ref 0→1 + → create_engine_with_resolver(ctx=tokenA, trampoline); registry[tokenA]=dwA; dwA._handle = handleA + +dwB = DataWeave(resolve_module=B); dwB.initialize() + → lock: _isolate exists → reuse; ref 1→2 + → create_engine_with_resolver(ctx=tokenB, trampoline); registry[tokenB]=dwB + +dwA.run("... import custom/lib ...") + → attach a fresh thread on demand → run_script_engine(handleA, script, inputs) → detach + → Java engine A: ClassLoader miss → callback(thread, ctx=tokenA, "custom/lib") + → trampoline: registry[tokenA] → resolver A → source; A's cache used, B untouched + +dwA.cleanup() → join dwA workers; destroy_engine(handleA); ref 2→1 (isolate stays) +dwB.cleanup() → join workers; destroy_engine(handleB); ref 1→0 → attach fresh thread + graal_tear_down_isolate(); _isolate=None +``` + +## 10. Error Handling & Backward Compatibility + +- **Module not found / resolver throws:** resolver returns `null`/non-str → composite resolver + falls through → standard DataWeave "unable to resolve module" error (unchanged, scoped + per-handle). +- **Wrong-thread resolver invocation:** per-handle/per-token `owner` check fails closed to "not + found" rather than touching the host callback cross-thread — identical in both bindings. +- **Invalid/unknown/destroyed handle:** `ScriptRuntime.get(handle)` returns null → the entrypoint + returns `{"success":false,"error":"Unknown engine handle"}` (resolved for async ops, returned as + the JSON string for sync `run()`), never an NPE/crash. +- **Node admission / argument / allocation failures:** synchronous `napi_throw_error` (generic + Error); worker-thread OOM → terminal error JSON. Never `napi_reject_deferred` (absent from + `addon.c`). +- **Python init failures:** isolate-create failure → `DataWeaveError`, refcount not incremented, + `_isolate` stays None; `create_engine` failure after isolate create → release the ref (tearing + down if this call created it) and unregister any resolver token, then raise. `run`/stream after + `cleanup()` → instance guard raises `DataWeaveError` (handle already cleared). +- **Teardown failure (Python `graal_tear_down_isolate` returns nonzero):** surface a warning and + re-raise `DataWeaveError`, and clear the isolate globals (`_lib`/`_lib_path`/`_isolate` → None, + count already 0) so the next `initialize()` builds a fresh isolate rather than reusing one whose + teardown just failed. +- **Intended breaking changes (pre-GA, no shims):** the dwlib C ABI drops the exported + `run_script` / `run_script_callback` / `run_script_input_output_callback` legacy singleton + entrypoints **and** the `run_script[...]_with_resolver` entrypoints, keeping only the `*_engine` + + `create_engine[_with_resolver]` + `destroy_engine` set; `ResolveModuleCallback` is 3-arg only; + Java `getInstance()`/`defaultInstance` are removed. dwlib is consumed by this repo's own Python + and Node bindings in lockstep. Node `DataWeave.cleanup()` changed from `void` to `Promise`. + The **Python public API is unchanged** — only `native.py`'s internal ABI changed. + +## 11. Testing Strategy + +- **Java unit** (`native-lib:test`): two `ScriptRuntime` instances with different in-memory + resolvers each resolve only their own module; `destroy()` removes an instance; `getInstance()` + tests removed. (The `@CEntryPoint` methods can't be driven from a hosted JVM — GraalVM word types + don't box — so handle-based entrypoint coverage lives at the binding integration layers.) +- **Node integration** (`native-lib:nodeTest`, real addon, `vi.mock` of `ffi` forbidden): the core + W-23692110 regression (two independent resolvers in one process); unknown/destroyed-handle + envelopes for all three run paths; the deadlock regression (active stream + `cleanup()` + + concurrent `run()` resolves within a bounded timeout); same-instance lifecycle; ref-count-proxy + teardown assertions; and `worker_threads` Worker lifecycle including **normal Worker exit without + `cleanup()`** (the abandonment / init-reference-release proof), `Worker.terminate()` mid-life, + and explicit in-Worker `cleanup()`. +- **Node unit** (`ffi` mocked, no dwlib): `DataWeave.initialize()` ref-count/rollback safety; + module singleton poisoning recovery; module + instance `cleanup()` coalescing; `stream.ts` + rejection propagation; `runTransform` post-pre-buffer re-check; `doCleanup()` releasing the init + reference even when `destroyEngine` throws. +- **Python unit** (fake/mocked lib, no dwlib): refcount create/reuse/last-release-teardown; + attach-on-demand thread accounting (bootstrap detached after create; every op attaches+detaches + its own thread; teardown attaches a fresh thread); ctx→resolver trampoline dispatch (two handles → + two resolvers); `cleanup()` idempotency + double-cleanup; `create_engine`-failure rollback + releasing the ref; failed resolver-backed init unregistering the token. +- **Python integration** (real dwlib): the core W-23692110 regression (two instances, different + resolvers, no cross-talk); multi-instance refcount teardown; synchronous `run()` resolving custom + modules; streaming/transform still stream; streaming custom-module resolution fails closed + (parity); a **foreign-thread last-release no-hang** regression (init on a worker thread, last + release/cleanup on a different thread, bounded timeout); TCK conformance stays green. +- **Documented posture on non-forceable paths (Node).** Allocator/N-API fault injection and exact + cross-thread teardown interleavings are **not deterministically forceable** from JS/vitest (no + addon-boundary fault-injection hook — deliberately not added, YAGNI/test-only surface). Their + correctness rests on the C-level invariants in §6, verified by code reasoning and adversarial + review; the Worker tests are best-effort probabilistic guards. This is a standing, documented + decision. +- **Native image build** (`native-lib:nativeCompile`) stays green with the legacy entrypoints + removed (confirms no SPI/reflection config referenced them). + +## 12. Engine lifecycle contract (shared by both bindings) + +These invariants are the shared artifact both `native-lib/node/src/addon.c` and +`native-lib/python/src/dataweave/native.py` implement. Any binding on the `*_engine` C ABI must +uphold all six: + +1. One process-wide isolate; engines are handle-addressed objects in the Java registry. +2. The isolate is reference-counted; the refcount equals the number of live engines; the isolate + exists iff the refcount > 0. +3. Create-on-first-ref, tear-down-on-last-release; the binding calls + `graal_create_isolate` / `graal_tear_down_isolate` from *outside* the isolate, and holds no + thread persistently attached across calls (so teardown never blocks on a phantom attachment). +4. Each engine handle is created by `create_engine` / `create_engine_with_resolver` and destroyed + by `destroy_engine`. +5. Resolver dispatch is per-engine via the opaque `ctx` echoed to the 3-arg `ResolveModuleCallback`; + custom-module resolution fails closed off the engine's owner thread. +6. A failed engine-create rolls back the isolate ref; a throwing `destroy_engine` still releases + the ref. + +## 13. Follow-Up Work + +- **Streaming/transform + custom-module resolution** across the background-thread boundary remains + a separate, not-yet-scoped effort in both bindings (unrelated to the singleton fix). Because + Python callbacks hold the GIL, Python *could* later support this as a Python-specific enhancement; + kept out of scope here to preserve one unified behavior. + +## References + +| Item | Location | +|------|----------| +| GUS ticket | W-23692110 | +| Singleton root cause | `native-lib/src/main/java/org/mule/weave/lib/ScriptRuntime.java` | +| CLI's per-instance pattern (proof it's not a GraalVM constraint) | `native-cli/src/main/scala/org/mule/weave/dwnative/NativeRuntime.scala:50-60` | +| WriteCallback/ReadCallback ctx idiom | `native-lib/src/main/java/org/mule/weave/lib/NativeCallbacks.java` | +| Java engine registry / entrypoints | `native-lib/src/main/java/org/mule/weave/lib/{ScriptRuntime,NativeLib,NativeCallbacks}.java` | +| Node concurrency & lifecycle machinery | `native-lib/node/src/addon.c` | +| Node JS lifecycle / singleton / exit hooks | `native-lib/node/src/dataweave.ts` | +| Node stream error propagation | `native-lib/node/src/stream.ts` | +| Python isolate/engine glue | `native-lib/python/src/dataweave/{native,runtime,models}.py` | +| Node binding API + lifecycle docs | `native-lib/node/README.md`, `native-lib/node/docs/external-modules.md` | +| Original external-modules design | `docs/superpowers/specs/2026-08-04-nodejs-external-modules-design.md` | + +## Appendix: Hardening provenance + +The Node concurrency & lifecycle model (§6) converged over a series of code-review rounds, and the +Python unification (§7) was implemented and reviewed task-by-task; each round's decisions are folded +into the sections above. This map exists only for git archaeology — the per-round and Python +unification design documents were consolidated into this file. + +| Round(s) | Area folded into | Decision | +|----------|------------------|----------| +| Feature (08-07) | §1–§5, §8–§10 | Object-level engines behind opaque handles; per-handle resolver bridge; ABI redesign. | +| 5 (08-11) | §6.2 | `cleanup()`-during-active-stream deadlock → async teardown + waiter thread + `TEARDOWN_*` adoption. | +| 6 (08-14) | §6.3, §6.4 | JS three-state lifecycle; atomic streaming/transform admission under `g_mutex`; handle-read validation. | +| 7 (08-18 ffi-sweep) | §6.3, §6.5, §10 | Atomic admission for sync `run()`; uniform `napi_get_value_*` status checks; docs await `cleanup()`. | +| 8 (08-18 oom-setup) | §6.5 | OOM-safe streaming/transform setup allocations. | +| 9 (08-18 engine/worker-oom) | §6.3, §6.5 | Deferred registry removal for all engines; worker/callback OOM → terminal result; N-API-create checks. | +| 10 (08-19 dangling-ctx) | §6.3, §6.4 | Env-cleanup removes the Java registry entry (`deferred_registry_remove`); shutdown-doc accuracy. | +| 11 (08-19 engine-pin) | §6.1, §6.3, §6.4 | Env hook + owner-guard for every engine; admission-time engine pin in all 3 paths; register-once exit hooks. | +| 12 (08-19 worker-ref-leak) | §6.1, §6.3, §6.4 | Init-reference release on abandoned env; teardown-guarded split finalize; module `cleanup()` coalescing; `runTransform` re-check; all-or-nothing engine creation. | +| 13 (08-20 per-env init) | §6.1 | Per-`napi_env` init-reference ownership; `g_ref_count == Σ init_refs`. | +| 14 (08-21 review5) | §6.2, §6.3 | Engine-creation admission requires an owned init reference; `g_teardown_needed` retry flag; `doCleanup()` releases the ref even when destroy throws. | +| 15 (08-21 review6) | §6.2, §6.4, §6.5 | Singleton-poisoning fix; stream rejection propagation; teardown return-code checks; init-driven stranded-teardown retry. | +| 16 (08-24 review7) | §6.2, §6.4, §6.5, §10 | Detach on failed teardown; init-hook-failure retry arming; observable init rollback; `Promise.reject(undefined)` fix; lifecycle-doc accuracy. | +| Python unification (08-26) | §2, §5, §7, §8 (Layer 1/4), §10–§12 | Remove `ScriptRuntime` singleton + 3 legacy C entrypoints; Python onto shared refcounted isolate + handle engines via `*_engine` ABI; 3-arg ctx resolver trampoline. | +| PR157 review 10 (08-27) | §6.3, §6.5, §7.2, §7.4 | Python `_release_isolate`/`_acquire_isolate` retryable-teardown model brought to parity with Node's `g_teardown_needed` (retains the live isolate on failed teardown instead of nulling globals); Node streaming/transform completion sentinel pre-allocated in synchronous setup (worker terminal path now allocation-free, closing a stranded-hang window); stranded-bridge free confirmed conditional on registry removal, with the non-`in_flight`-pinned residual window documented as reachable only via unsupported cross-Worker handle sharing / API misuse; raw `napi_initialize` validates its library-path argument synchronously; user-facing custom-module resolution scope (`run()`-only) documented in both READMEs, cross-referencing the existing streaming-resolver-guard tests. | +| Python final review (08-26) | §7.2, §10 | Detach isolate bootstrap thread at create + attach-on-demand so cross-thread last-release teardown cannot hang; unregister resolver token on failed init. | diff --git a/native-lib/README.md b/native-lib/README.md index 1498898f..c053d88c 100644 --- a/native-lib/README.md +++ b/native-lib/README.md @@ -22,14 +22,29 @@ The main purpose is to allow non-JVM consumers (most notably the Python package │ ┌────────────────────────────────────────┐ │ │ │ Native Shared Library (dwlib) │ │ │ │ ┌──────────────────────────────────┐ │ │ -│ │ │ GraalVM Isolate │ │ │ -│ │ │ - NativeLib.run_script() │ │ │ +│ │ │ GraalVM Isolate (process-wide) │ │ │ +│ │ │ - create_engine / │ │ │ +│ │ │ create_engine_with_resolver │ │ │ +│ │ │ - run_script_engine / │ │ │ +│ │ │ run_script_callback_engine / │ │ │ +│ │ │ run_script_input_output_ │ │ │ +│ │ │ callback_engine │ │ │ +│ │ │ - destroy_engine │ │ │ │ │ │ - DataWeave script execution │ │ │ │ │ └──────────────────────────────────┘ │ │ │ └────────────────────────────────────────┘ │ └─────────────────────────────────────────────┘ ``` +Each engine is a handle-addressed object created with `create_engine` (or +`create_engine_with_resolver`, which additionally registers a module-resolve +callback) and run via `run_script_engine`, `run_script_callback_engine`, or +`run_script_input_output_callback_engine`, then released with +`destroy_engine`. The underlying GraalVM isolate is a single process-wide +isolate, created and attached via `graal_create_isolate` / `graal_attach_thread` +on first use and torn down via `graal_tear_down_isolate` once the last engine +across the process has been destroyed. + ## Building with Gradle ### Prerequisites @@ -450,14 +465,21 @@ import { DataWeave } from "@dataweave/native"; const dw = new DataWeave(); dw.initialize(); - -const r1 = dw.run("2 + 2"); -const r2 = dw.run("x + y", { x: 10, y: 32 }); - -console.log(r1.getString()); // "4" -console.log(r2.getString()); // "42" - -dw.cleanup(); +try { + const r1 = dw.run("2 + 2"); + const r2 = dw.run("x + y", { x: 10, y: 32 }); + + console.log(r1.getString()); // "4" + console.log(r2.getString()); // "42" +} finally { + // cleanup() returns a Promise; await it. When this releases the FINAL shared + // native reference in the process, it drains any in-flight streaming/transform + // op and completes isolate teardown before resolving (so a subsequent + // initialize() does not race a still-tearing-down isolate). When other + // initialized instances remain, it resolves as soon as this instance is + // released, leaving the shared isolate live for them. + await dw.cleanup(); +} ``` ### 5) Error handling @@ -635,11 +657,20 @@ for await (const chunk of gen) { ### 9) Cleanup -The module registers a `process.on('exit')` handler to clean up automatically. For explicit control: +The module registers two process hooks to clean up automatically: `beforeExit` +(async — it awaits cleanup so an in-flight streaming/transform op drains before +the process exits normally) and `exit` (a synchronous best-effort fallback for +`process.exit()` and uncaught exceptions, which cannot await the drain). Neither +hook fires on `SIGTERM`/`SIGINT`/`SIGKILL`, so install your own signal handler +that awaits `cleanup()` if you need a graceful drain on termination. For explicit +control: ```typescript import { cleanup } from "@dataweave/native"; -// When done with all DataWeave operations -cleanup(); +// When done with all DataWeave operations. cleanup() returns a Promise; await it. +// Draining in-flight streaming/transform work and tearing down the isolate happen +// only when this releases the final shared native reference; if other initialized +// instances remain, it resolves as soon as this instance is released. +await cleanup(); ``` diff --git a/native-lib/node/README.md b/native-lib/node/README.md index 3f135c41..f4a2b467 100644 --- a/native-lib/node/README.md +++ b/native-lib/node/README.md @@ -128,13 +128,17 @@ const generator = runStreaming( '%dw 2.0\noutput application/json\n---\n[1, 2, 3, 4, 5]' ); -for await (const chunk of generator) { - console.log('Chunk:', chunk.toString()); +// Iterate manually with next() to capture the terminal return value. A +// `for await` loop consumes the generator's return value internally, so a later +// generator.return() would yield { value: undefined } -- drive next() yourself +// and read the metadata off the terminal { done: true, value: StreamingResult }. +let meta; +while (true) { + const { value, done } = await generator.next(); + if (done) { meta = value; break; } + console.log('Chunk:', value.toString()); } - -// Generator return value contains metadata: -const meta = await generator.return(); -console.log('MIME type:', meta.value.mimeType); +console.log('MIME type:', meta.mimeType); ``` **Parameters:** @@ -156,12 +160,21 @@ Execute a DataWeave script with streaming input and output (bidirectional stream ```javascript import { runTransform } from '@dataweave/native'; -import { createReadStream } from 'fs'; +import { readFileSync } from 'fs'; + +// The native read callback is synchronous, so an ASYNC input iterable (e.g. +// fs.createReadStream) is fully pre-buffered into memory before the transform +// starts. A SYNCHRONOUS iterable is instead consumed on demand -- one chunk at a +// time -- so the transform makes no extra full copy of the input (it does NOT by +// itself bound total memory: a source like readFileSync still holds the whole +// input). (See "Sync vs async input and memory" below.) +function* chunked(buf, size = 65536) { + for (let i = 0; i < buf.length; i += size) yield buf.subarray(i, i + size); +} -// Transform a large CSV file to JSON without loading it all into memory const generator = runTransform( '%dw 2.0\noutput application/json\n---\npayload', - createReadStream('large-file.csv'), + chunked(readFileSync('large-file.csv')), { inputName: 'payload', mimeType: 'application/csv', @@ -175,28 +188,39 @@ for await (const chunk of generator) { } ``` +> **Sync vs async input and memory.** The native read callback runs synchronously +> on the JS thread. **Synchronous** iterables (arrays, generators) are consumed +> on demand — the transform holds only one chunk at a time and makes no extra +> full copy of the input. This bounds the transform's *added* memory, not total +> memory: if the source itself already holds the whole input (e.g. `readFileSync`), +> that memory is still resident. **Async** iterables (e.g. `fs.createReadStream()`) +> are **fully pre-buffered** into memory before the transform starts, because their +> `.next()` returns a Promise that cannot be awaited inside the synchronous +> callback. For large inputs, prefer a synchronous generator so the transform adds +> no second copy. + **Parameters:** - `script` (string): DataWeave script - `input` (AsyncIterable | Iterable): Streaming input data - `opts` (object, optional): Options - `inputName` (string): Name of input variable (default: "payload") - `mimeType` (string): Input MIME type (default: "application/json") - - `charset` (string | null): Input character encoding + - `charset` (string, optional): Input character encoding - `inputs` (object): Additional input variables **Yields:** `Buffer` chunks as they're produced **Returns:** `StreamingResult` -#### `cleanup(): void` +#### `cleanup(): Promise` -Clean up the global DataWeave runtime instance. Called automatically on process exit. +Clean up the global DataWeave runtime instance. Called automatically on process shutdown via two hooks: `beforeExit` awaits it, so a streaming/transform operation still in flight drains gracefully before the process exits normally; `exit` is a synchronous last-ditch fallback for `process.exit()` and uncaught exceptions — cases where `beforeExit` never fires — and cannot await the drain. Neither hook fires on `SIGTERM`, `SIGINT`, or `SIGKILL` (Node does not emit `exit` for signals), so install your own signal handler that calls `cleanup()` if you need a graceful drain on termination. Called manually, it releases this instance's reference to the native runtime; the shared native isolate is torn down only when the **last** initialized instance in the process is released. When this call releases that final reference, it resolves once native teardown has actually finished, waiting for any still-in-flight streaming/transform operation to drain first; otherwise (other instances remain initialized) it resolves as soon as this instance is released, without draining process-wide work. ```javascript import { cleanup } from '@dataweave/native'; // Manual cleanup (usually not needed) -cleanup(); +await cleanup(); ``` ### Class-Based API @@ -213,13 +237,13 @@ try { const result = dw.run('2 + 2'); console.log(result.getString()); } finally { - dw.cleanup(); + await dw.cleanup(); } ``` **Methods:** - `initialize()`: Initialize the native library -- `cleanup()`: Release native resources +- `cleanup(): Promise`: Release this instance's native resources. When it releases the last initialized instance in the process, it resolves once the shared isolate has finished tearing down (draining any in-flight streaming/transform op first); otherwise it resolves as soon as this instance is released, leaving the isolate live for other instances. - `run(script, inputs?, opts?)`: Same as module-level `run()` - `runStreaming(script, inputs?)`: Same as module-level `runStreaming()` - `runTransform(script, input, opts?)`: Same as module-level `runTransform()` @@ -231,6 +255,7 @@ DataWeave scripts can import external modules using the `resolveModule` option. ```typescript import { DataWeave, composeResolvers, modulesFromDirectory, modulesFromJars } from '@dataweave/native'; +// Inside an async function (uses `await` for modulesFromJars and cleanup()). const dw = new DataWeave({ resolveModule: composeResolvers( modulesFromDirectory('./my-modules'), @@ -238,22 +263,34 @@ const dw = new DataWeave({ ) }); dw.initialize(); - -const result = dw.run(` - %dw 2.0 - import org::company::utils - output application/json - --- - utils::doSomething() -`); - -if (result.success) { - console.log(result.getString()); +try { + const result = dw.run(` + %dw 2.0 + import org::company::utils + output application/json + --- + utils::doSomething() + `); + + if (result.success) { + console.log(result.getString()); + } +} finally { + // Release the engine and resolver closure when done. + await dw.cleanup(); } ``` See [docs/external-modules.md](docs/external-modules.md) for complete documentation, resolver factories, error handling, and dependency management. Note: a resolver runs with full process permissions (no sandboxing) — see the "Security / Trust Model" section there before pointing one at untrusted sources. +### Custom module resolution scope + +- A `resolveModule` you configure applies to `run()`. +- Built-in modules (e.g. `dw::core::*`) resolve everywhere — `run()`, `runStreaming()`, and `runTransform()`. +- Custom modules do **not** resolve inside `runStreaming()`/`runTransform()`: those execute on a background thread that must not call back into your resolver, so a streamed/transformed script that imports a custom module fails closed (reports the module as not found) rather than making an unsafe cross-thread call. If you need a custom module in a streamed/transform script, resolve it via `run()` instead, or inline the module into the script. + +See [docs/external-modules.md](docs/external-modules.md#multiple-independent-engines) for the full explanation, including the Worker-thread ownership rules. + ### Input Formats Inputs can be provided in multiple formats: @@ -366,7 +403,7 @@ console.log(result.getString()); // "300" ```javascript import { runTransform } from '@dataweave/native'; -import { createReadStream, createWriteStream } from 'fs'; +import { readFileSync, createWriteStream } from 'fs'; const script = ` %dw 2.0 @@ -375,9 +412,18 @@ output application/json payload filter $.amount > 1000 `; +// A synchronous generator is consumed on demand: the transform does not make a +// second full copy of the input. Note readFileSync still holds the whole file in +// memory, so this bounds the transform's *added* memory, not total memory -- the +// native read callback is synchronous, so there is no fully-streaming-from-disk +// path (an async createReadStream would instead be pre-buffered in full first). +function* chunked(buf, size = 65536) { + for (let i = 0; i < buf.length; i += size) yield buf.subarray(i, i + size); +} + const generator = runTransform( script, - createReadStream('large-transactions.csv'), + chunked(readFileSync('large-transactions.csv')), { mimeType: 'application/csv' } ); @@ -422,12 +468,17 @@ try { ```javascript try { const generator = runStreaming('invalid syntax'); - for await (const chunk of generator) { - // Process chunks + // Drive next() manually so the terminal { done: true, value: StreamingResult } + // is captured; a `for await` loop would consume it and a later + // generator.return() would give { value: undefined }. + let meta; + while (true) { + const { value, done } = await generator.next(); + if (done) { meta = value; break; } + // Process chunk `value` } - const meta = await generator.return(); - if (!meta.value.success) { - console.error('Streaming error:', meta.value.error); + if (!meta.success) { + console.error('Streaming error:', meta.error); } } catch (err) { console.error('Native error:', err); @@ -440,20 +491,20 @@ The Node.js binding uses **N-API** (Node-API) for C addon integration: - **Thread-safe**: N-API calls are serialized on the Node.js event loop - **Async operations**: Streaming operations yield control to the event loop between chunks -- **No blocking**: Long-running scripts execute on the native side without blocking the event loop +- **No event-loop blocking for streaming**: `runStreaming`/`runTransform` execute on a background worker and yield to the event loop between chunks. Note the **synchronous** `run()` runs native work directly on the calling JS thread and *does* block it until the script completes — use the streaming methods for long-running work you cannot block on. **Important:** Do not share a single `DataWeave` instance across Worker threads. Use the module-level functions (which use a global singleton) or create separate instances per thread. -**Custom module resolvers and Worker threads:** the native layer installs at -most one resolver callback for the whole process lifetime, and it is bound to -the Worker (main thread or a `worker_threads` Worker) that registered it -first — see [External Modules: Multiple Resolvers](docs/external-modules.md#multiple-resolvers-in-one-process). +**Custom module resolvers and Worker threads:** each resolver-backed +`DataWeave` instance's native engine is bound to the thread that created it +(main thread or a `worker_threads` Worker) — see +[External Modules: Multiple Independent Engines](docs/external-modules.md#multiple-independent-engines). Custom-module resolution attempted from any *other* thread is not routed to -that thread's own `resolveModule` callback; it silently falls back to -built-in modules only (custom module paths resolve as "not found" rather than -crashing or hanging). If you need per-Worker custom modules, resolve them on -the thread that first constructs a resolver-backed `DataWeave` instance, or -avoid resolver-backed instances in worker pools altogether. +that engine's `resolveModule` callback; it silently falls back to built-in +modules only (custom module paths resolve as "not found" rather than +crashing or hanging). If you need custom modules on multiple Workers, +construct and use a separate resolver-backed `DataWeave` instance on each +Worker, created on that Worker itself. ## Platform Support @@ -541,12 +592,12 @@ Tests use **Vitest** and cover: - **Buffered execution** (`run`): Best for small scripts with sub-MB outputs - **Streaming execution** (`runStreaming`): Best for large outputs (MB+), reduces memory footprint -- **Bidirectional streaming** (`runTransform`): Best for large inputs and outputs, constant memory usage +- **Bidirectional streaming** (`runTransform`): Best for large outputs; input memory is bounded only with a **synchronous** input iterable (async streams are pre-buffered — see the `runTransform` memory note above) Benchmark (1MB JSON transformation): - `run()`: ~50ms, 2MB peak memory - `runStreaming()`: ~55ms, 500KB peak memory -- `runTransform()`: ~60ms, 256KB peak memory (streaming input) +- `runTransform()`: ~60ms, 256KB peak memory (synchronous input iterable; an async stream is pre-buffered, so peak memory scales with input size) ## See Also diff --git a/native-lib/node/docs/external-modules.md b/native-lib/node/docs/external-modules.md index 6b67ae91..45014a63 100644 --- a/native-lib/node/docs/external-modules.md +++ b/native-lib/node/docs/external-modules.md @@ -7,26 +7,32 @@ DataWeave scripts can import external modules using the `resolveModule` option. ```typescript import { DataWeave, modulesFromMap } from '@dataweave/native'; +// Inside an async function so `await dw.cleanup()` is available. const dw = new DataWeave({ resolveModule: modulesFromMap({ 'org/company/lib.dwl': '%dw 2.0\nfun greet(n) = "Hello " ++ n', }), }); dw.initialize(); - -const result = dw.run(` - %dw 2.0 - import org::company::lib - output application/json - --- - lib::greet("World") -`); -console.log(result.getString()); // "Hello World" +try { + const result = dw.run(` + %dw 2.0 + import org::company::lib + output application/json + --- + lib::greet("World") + `); + console.log(result.getString()); // "Hello World" +} finally { + // Release the engine and the resolver closure; an uncleaned instance retains + // both (see the lifecycle notes below). + await dw.cleanup(); +} ``` **Important:** The module-level convenience functions (`run()`, `runStreaming()`, `runTransform()` exported directly from `@dataweave/native`) operate on a lazily-initialized singleton that takes no constructor options and therefore cannot be configured with `resolveModule` — you **must** construct your own `DataWeave` instance to use external modules, as shown above. -Additionally, external module resolution is currently supported only through `.run()` (the synchronous API). `.runStreaming()` and `.runTransform()` do not yet support external modules and will only have access to built-in modules. +Additionally, external module resolution is currently supported only through `.run()` (the synchronous API). For a resolver-backed engine, `.runStreaming()` and `.runTransform()` execute on a background thread and cannot invoke that engine's `resolveModule` callback — they always resolve only built-in modules, and any custom-module import fails closed (module "not found") rather than crashing or hanging. ## Resolver Factories @@ -37,13 +43,18 @@ In-memory map of module paths to source code: ```typescript import { DataWeave, modulesFromMap } from '@dataweave/native'; +// Inside an async function so `await dw.cleanup()` is available. const dw = new DataWeave({ resolveModule: modulesFromMap({ 'org/test/lib.dwl': '%dw 2.0\nfun foo() = 42', }), }); dw.initialize(); -const result = dw.run('import org::test::lib\n%dw 2.0\n---\nlib::foo()'); +try { + const result = dw.run('%dw 2.0\nimport org::test::lib\n---\nlib::foo()'); +} finally { + await dw.cleanup(); +} ``` Best for: Small, in-memory module sets; testing and development. @@ -55,13 +66,18 @@ Read modules from a directory tree on disk: ```typescript import { DataWeave, modulesFromDirectory } from '@dataweave/native'; +// Inside an async function so `await dw.cleanup()` is available. const dw = new DataWeave({ resolveModule: modulesFromDirectory('./my-modules'), }); dw.initialize(); -// Resolves "org/test/lib.dwl" → reads "./my-modules/org/test/lib.dwl" -const result = dw.run('import org::test::lib\n%dw 2.0\n---\nlib::foo()'); +try { + // Resolves "org/test/lib.dwl" → reads "./my-modules/org/test/lib.dwl" + const result = dw.run('%dw 2.0\nimport org::test::lib\n---\nlib::foo()'); +} finally { + await dw.cleanup(); +} ``` Best for: Development and file-based module repositories. @@ -83,7 +99,11 @@ const dw = new DataWeave({ resolveModule: resolver, }); dw.initialize(); -const result = dw.run('import org::mule::weave::core::Strings\n%dw 2.0\n---\nStrings::capitalize("hello")'); +try { + const result = dw.run('%dw 2.0\nimport org::mule::weave::core::Strings\n---\nStrings::capitalize("hello")'); +} finally { + await dw.cleanup(); +} ``` **Note:** `modulesFromJars()` returns a `Promise` because JAR extraction must complete first. The returned resolver itself is synchronous and can be used repeatedly. @@ -94,6 +114,8 @@ Best for: Packaged dependencies and distributed libraries. Combine multiple resolvers with fallback chain (tries each in order, returns first match): +*Abbreviated fragment — see the first example for the required `try/finally { await dw.cleanup() }` lifecycle.* + ```typescript import { DataWeave, composeResolvers, modulesFromMap, modulesFromDirectory, modulesFromJars } from '@dataweave/native'; @@ -113,7 +135,7 @@ Best for: Layered resolution with fallbacks (overrides, shared libraries, vendor ## How It Works -- **One resolver per process**: The native engine maintains a single resolver per process lifetime. Only the first resolver registered is used; subsequent `DataWeave` instances with different resolvers will silently reuse the first one. +- **Independent engines**: each `DataWeave` instance owns its own native engine, resolver, and script cache; instances with different resolvers coexist with no cross-talk. - **Resolution at compile time**: The resolver is invoked during script compilation, not per execution. - **Synchronous resolution**: The resolver callback must be synchronous (no `async`/`await`, no Promise return). - **Built-in modules**: Built-in modules (CompositeResolver) are always available and work alongside custom resolvers. @@ -125,6 +147,7 @@ Best for: Layered resolution with fallbacks (overrides, shared libraries, vendor When a module cannot be resolved: ```typescript +// Inside an async function so `await dw.cleanup()` is available. const dw = new DataWeave({ resolveModule: modulesFromMap({ // Only 'org/test/lib.dwl' is available @@ -132,15 +155,19 @@ const dw = new DataWeave({ }); dw.initialize(); -const result = dw.run(` - %dw 2.0 - import org::missing::module // Not found - --- - missing::something() -`); +try { + const result = dw.run(` + %dw 2.0 + import org::missing::module // Not found + --- + missing::something() + `); -if (!result.success) { - console.error(result.error); // "Unable to resolve module with identifier ..." + if (!result.success) { + console.error(result.error); // "Unable to resolve module with identifier ..." + } +} finally { + await dw.cleanup(); } ``` @@ -151,92 +178,89 @@ The resolver returns `null`, and the engine reports a compile-time error. When the resolver encounters file system errors (unreadable files, permission denied, etc.), the resolver throws an error. This error is caught internally by the native layer and the callback returns `null` — indistinguishable from "module not found" to the DataWeave compiler: ```typescript +// Inside an async function so `await dw.cleanup()` is available. const dw = new DataWeave({ resolveModule: modulesFromDirectory('./my-modules'), }); dw.initialize(); -const result = dw.run(` - %dw 2.0 - import org::test::lib - --- - lib::foo() -`); - -if (!result.success) { - // result.error is the same generic message as "module not found": - console.error(result.error); // "Unable to resolve module with identifier ..." - // The actual error details (permissions, encoding, etc.) are not available - // in the result object; see "Debugging" below for how to surface them. +try { + const result = dw.run(` + %dw 2.0 + import org::test::lib + --- + lib::foo() + `); + + if (!result.success) { + // result.error is the same generic message as "module not found": + console.error(result.error); // "Unable to resolve module with identifier ..." + // The actual error details (permissions, encoding, etc.) are not available + // in the result object; see "Debugging" below for how to surface them. + } +} finally { + await dw.cleanup(); } ``` **Debugging:** By default, a resolver failure logs only a fixed, content-free diagnostic line to stderr — the actual exception message and stack are suppressed, since they can carry resolver-controlled data (module source, credentials, filesystem paths). To see the detailed message and stack for diagnosing a failing resolver (e.g., directory does not exist, file unreadable due to permissions), set `DATAWEAVE_RESOLVER_DEBUG=1` in the process environment before running. Only enable this in a trusted debugging context, since the detailed output may expose sensitive resolver-controlled data. -### Multiple Resolvers in One Process +### Multiple Independent Engines -If you construct multiple `DataWeave` instances with different resolvers in the same process: +Each `DataWeave` instance owns its own native engine, resolver, and script +cache. You can construct as many resolver-backed instances as you want in the +same process — each one only ever resolves its own modules, with no +cross-talk between instances: ```typescript -const dw1 = new DataWeave({ - resolveModule: modulesFromMap({ 'a.dwl': '...' }), -}); -dw1.initialize(); - -const dw2 = new DataWeave({ - resolveModule: modulesFromMap({ 'b.dwl': '...' }), -}); -dw2.initialize(); // Only loads/ref-counts the native library — does NOT register a resolver - -dw1.run('...'); // First resolver-backed run() in the process: installs dw1's resolver -dw2.run('...'); // Logs warning, silently reuses dw1's resolver instead of dw2's +async function example() { + const dw1 = new DataWeave({ + resolveModule: modulesFromMap({ 'a.dwl': '...' }), + }); + dw1.initialize(); -// Both dw1 and dw2 use dw1's resolver (only 'a.dwl' is available) -``` + const dw2 = new DataWeave({ + resolveModule: modulesFromMap({ 'b.dwl': '...' }), + }); + dw2.initialize(); -**The rule is "first resolver-backed `run()` wins," not "first `initialize()` wins."** -`initialize()` only loads and ref-counts the native library; the resolver -itself is registered lazily, on whichever instance's `run()` executes first -with a resolver configured. If `dw2.run()` happens to execute before -`dw1.run()` — even though `dw1.initialize()` ran first — `dw2`'s resolver -wins instead. - -**Workaround:** Use `composeResolvers()` to combine all modules into a single resolver: - -```typescript -const resolver = composeResolvers( - modulesFromMap({ 'a.dwl': '...' }), - modulesFromMap({ 'b.dwl': '...' }) -); - -const dw1 = new DataWeave({ resolveModule: resolver }); -dw1.initialize(); - -const dw2 = new DataWeave({ resolveModule: resolver }); -dw2.initialize(); // Both use the same resolver + try { + dw1.run('...'); // Only 'a.dwl' is available to dw1 + dw2.run('...'); // Only 'b.dwl' is available to dw2 — dw1's modules are not visible here + } finally { + await dw1.cleanup(); + await dw2.cleanup(); + } +} ``` -**Worker threads:** the same one-resolver-per-process rule applies across -`worker_threads` Workers, not just across instances on one thread. The -resolver callback is additionally bound to the specific thread that first -registered it. A resolver-backed `DataWeave` constructed and initialized on a -Worker other than the one that registered the process's resolver will not -have its `resolveModule` invoked at all — custom module paths resolve as "not -found" (falling back to built-ins only) rather than crashing. There is -currently no supported way to run distinct custom-module resolvers on -different Workers in the same process; either resolve modules on the thread -that owns the process's resolver, or avoid resolver-backed instances in -worker pools. - -**Concurrent resolver-backed runs across Workers are unsupported and -memory-unsafe.** Beyond the "not found" fallback described above, calling a -resolver-backed `run()` concurrently from more than one Worker is not just -unsupported behavior — it is a memory-safety hazard. The native layer tracks -in-flight resolver results in unsynchronized, process-global state, and one -Worker's cleanup can free memory another Worker's concurrent call is still -using. Restrict resolver-backed execution to a single thread (or fully -serialize resolver-backed calls across Workers) until a future release -isolates per-instance engine state. +**`cleanup()` is required for every instance.** Each `DataWeave` instance's +engine is tracked in a native registry keyed by handle. `cleanup()` destroys +the engine and removes its registry entry; an instance that is never +`cleanup()`'d keeps its engine (and the JS `resolveModule` closure it holds a +reference to) alive for the lifetime of the process, even if the `DataWeave` +object itself is garbage-collected on the JS side. Always `cleanup()` in a +`finally` block, as shown throughout this document. + +`composeResolvers()` is not a workaround for any resolver-sharing limitation +— each engine already has its own resolver. It's simply a layering tool for +building one resolver out of several fallback sources (overrides, then a +shared directory, then vendor JARs); see [composeResolvers](#composeresolvers) +above. + +**Worker threads and thread ownership:** each resolver-backed engine is bound +to the thread that created it (the thread that called `new DataWeave(...)` +and `initialize()` with a `resolveModule` configured). Only that thread's +synchronous `run()` calls can invoke the engine's `resolveModule` callback. +`runStreaming()` and `runTransform()` execute on a background thread even +when called from the owner thread, so they can never invoke that engine's +resolver — nor can `run()` calls made from any other `worker_threads` Worker. +In all of these cases the engine fails closed: custom module paths resolve as +"not found" (falling back to built-ins only) rather than crashing or hanging. +There is no supported way to invoke one engine's resolver from a thread other +than the one that created it; if you need custom modules on multiple +Workers, construct and use a separate resolver-backed `DataWeave` instance +on each Worker. ## Security / Trust Model @@ -268,6 +292,8 @@ Future releases may add `npm run dw-deps` for automatic resolution. Check your p Then pass JAR paths to `modulesFromJars()`: +*Abbreviated fragment — see the first example for the required `try/finally { await dw.cleanup() }` lifecycle.* + ```typescript const resolver = await modulesFromJars([ './libs/dw-lib-1.0.jar', @@ -319,7 +345,7 @@ async function main() { console.error('Error:', result.error); } } finally { - dw.cleanup(); + await dw.cleanup(); } } diff --git a/native-lib/node/src/addon.c b/native-lib/node/src/addon.c index 5aa31535..12e950a3 100644 --- a/native-lib/node/src/addon.c +++ b/native-lib/node/src/addon.c @@ -3,31 +3,27 @@ #include #include #include +#include // GraalVM function pointer types typedef int (*graal_create_isolate_fn)(void*, void**, void**); typedef int (*graal_attach_thread_fn)(void*, void**); typedef int (*graal_detach_thread_fn)(void*); typedef int (*graal_tear_down_isolate_fn)(void*); -typedef void* (*run_script_fn)(void*, const char*, const char*); typedef void (*free_cstring_fn)(void*, void*); typedef int (*write_callback_t)(void* ctx, const char* buf, int len); typedef int (*read_callback_t)(void* ctx, char* buf, int buf_size); -typedef char* (*resolve_module_callback_t)(void* thread, const char* module_path); -typedef void* (*run_script_callback_fn)(void*, const char*, const char*, write_callback_t, void*); -typedef void* (*run_script_input_output_callback_fn)(void*, const char*, const char*, const char*, const char*, const char*, read_callback_t, write_callback_t, void*); - -// Resolver-aware entrypoint types -// NOTE: run_script_with_resolver has no mimeType parameter on the native side -// (NativeLib.runScriptWithResolver(thread, script, inputsJson, resolverCallback) -// delegates to ScriptRuntime.run(script, inputsJson), which infers/hardcodes -// output mime type internally). The JS-facing mimeType argument is accepted -// for API symmetry with other entrypoints but is NOT forwarded across the FFI -// boundary — passing it here would misalign the native call's argument -// registers and corrupt the callback function pointer. -typedef char* (*run_script_with_resolver_fn)(void*, const char*, const char*, resolve_module_callback_t); -typedef void* (*run_script_callback_with_resolver_fn)(void*, const char*, const char*, const char*, write_callback_t, void*, resolve_module_callback_t); -typedef void* (*run_script_input_output_callback_with_resolver_fn)(void*, const char*, const char*, const char*, const char*, const char*, read_callback_t, write_callback_t, void*, resolve_module_callback_t); +typedef char* (*resolve_module_callback_t)(void* thread, void* ctx, const char* module_path); + +// Per-engine entrypoint types. Handles are Java long values and MUST be C +// long long everywhere (plain long is 32-bit on Windows LLP64 and would +// truncate a 64-bit handle). +typedef long long (*create_engine_fn)(void*); +typedef long long (*create_engine_with_resolver_fn)(void*, resolve_module_callback_t, void*); +typedef void (*destroy_engine_fn)(void*, long long); +typedef void* (*run_script_engine_fn)(void*, long long, const char*, const char*); +typedef void* (*run_script_callback_engine_fn)(void*, long long, const char*, const char*, write_callback_t, void*); +typedef void* (*run_script_input_output_callback_engine_fn)(void*, long long, const char*, const char*, const char*, const char*, const char*, read_callback_t, write_callback_t, void*); // Global state static uv_lib_t g_lib; @@ -49,19 +45,30 @@ static graal_create_isolate_fn fn_create_isolate = NULL; static graal_attach_thread_fn fn_attach_thread = NULL; static graal_detach_thread_fn fn_detach_thread = NULL; static graal_tear_down_isolate_fn fn_tear_down_isolate = NULL; -static run_script_fn fn_run_script = NULL; static free_cstring_fn fn_free_cstring = NULL; -static run_script_callback_fn fn_run_script_callback = NULL; -static run_script_input_output_callback_fn fn_run_script_input_output_callback = NULL; -// Resolver-aware entrypoints -static run_script_with_resolver_fn fn_run_script_with_resolver = NULL; -static run_script_callback_with_resolver_fn fn_run_script_callback_with_resolver = NULL; -static run_script_input_output_callback_with_resolver_fn fn_run_script_input_output_callback_with_resolver = NULL; +// Per-engine entrypoints +static create_engine_fn fn_create_engine = NULL; +static create_engine_with_resolver_fn fn_create_engine_with_resolver = NULL; +static destroy_engine_fn fn_destroy_engine = NULL; +static run_script_engine_fn fn_run_script_engine = NULL; +static run_script_callback_engine_fn fn_run_script_callback_engine = NULL; +static run_script_input_output_callback_engine_fn fn_run_script_input_output_callback_engine = NULL; + +// A single run may trigger resolve_module_callback multiple times (one script +// can import several modules). Native copies each returned buffer immediately, +// but the copy is made *after* our callback returns — we don't get a per-call +// "done freeing" signal, only "the whole run finished". So track every buffer +// allocated during one run and free them all once the native call returns. +typedef struct resolver_result_node { + char* buf; + struct resolver_result_node* next; +} resolver_result_node_t; -// Resolver bridge state (one resolver per process). +// Per-engine resolver bridge: one node per resolver-backed engine, passed to +// Java as the callback ctx word and forwarded back to resolve_module_callback. // -// Unlike the streaming/transform entrypoints, runWithResolver's native call +// Unlike the streaming/transform entrypoints, runScriptEngine's native call // executes synchronously on the very thread that invoked it from JS — no // background uv_thread is spawned. So when native code calls back into // resolve_module_callback(), we are already on the correct (JS) thread and @@ -70,51 +77,578 @@ static run_script_input_output_callback_with_resolver_fn fn_run_script_input_out // caller on a condition variable until it's serviced — but if the caller // *is* the JS thread, it can never service its own queued item, causing a // deadlock (a real bug fixed in this codebase — see Task 11 report). -static napi_env g_resolver_env = NULL; -static napi_ref g_resolver_ref = NULL; - -// The OS thread that first installed the resolver (see napi_run_with_resolver -// below). ScriptRuntime's engine is a process-wide singleton, so once a -// resolver is installed, resolve_module_callback() can be reached from ANY -// entrypoint that later compiles a script against that shared engine — -// including runScriptStreaming/runScriptTransform, whose native calls run on -// a background uv_thread (see streaming_thread_fn/transform_thread_fn), not -// the JS thread. napi_env/napi_ref are thread-affine; calling into them from -// a thread other than the one that created them is undefined behavior. We -// record the owning thread here so resolve_module_callback can detect the -// mismatch and fail closed (return "not found") instead of crashing. -static uv_thread_t g_resolver_thread; - -// A single runWithResolver call may trigger resolve_module_callback multiple -// times (one script can import several modules). Native copies each -// returned buffer immediately, but the copy is made *after* our callback -// returns — we don't get a per-call "done freeing" signal, only "the whole -// run finished". So track every buffer allocated during one call and free -// them all once fn_run_script_with_resolver returns. -typedef struct resolver_result_node { - char* buf; - struct resolver_result_node* next; -} resolver_result_node_t; -static resolver_result_node_t* g_resolver_results = NULL; - -static void resolver_results_track(char* buf) { - if (buf == NULL) return; +// +// napi_env/napi_ref are thread-affine; each bridge records the JS thread that +// created it (owner) so resolve_module_callback can detect a mismatch — e.g. a +// streamed/transform custom-module lookup arriving on the background uv_thread +// — and fail closed (return "not found") instead of crashing. +typedef struct engine_bridge { + long long handle; + napi_env env; + napi_ref resolver_js; // NULL => resolver-less engine (no bridge created) + uv_thread_t owner; // JS thread that created and must run this engine + resolver_result_node_t* results; // buffers to free after each run on this engine + // Lifecycle accounting, mutated only under g_mutex. A streaming/transform op + // runs the native call on a background uv_thread that can still call back into + // resolve_module_callback with this bridge as ctx, so the bridge must outlive + // every in-flight op. in_flight counts ops that can still dereference this + // bridge; destroy_pending marks that destroyEngine ran while in_flight > 0 and + // freeing was deferred to the last op draining on the owner thread. + int in_flight; + bool destroy_pending; + // True when a destroy (via destroyEngine OR the env cleanup hook) was + // deferred because in_flight > 0; gates the deferred fn_destroy_engine + // registry removal in bridge_end_op. round-9 (#1) introduced this for the + // destroyEngine path; round-10 (#1) extended it to bridge_env_cleanup, which + // must ALSO remove the Java registry entry when its free is deferred -- + // otherwise a resolver-backed engine's ScriptRuntime is left registered with + // a CallbackWeaveResourceResolver whose ctx points at the freed bridge (UAF). + bool deferred_registry_remove; + // True while THIS bridge's napi_add_env_cleanup_hook(bridge_env_cleanup) is + // registered. The env cleanup hook is the only owner-thread finalizer that may + // delete resolver_js, so a strand taken on the owner thread (env alive) keeps + // the hook instead of enqueuing on g_stranded_bridges (whose off-thread drain + // skips napi_delete_reference and would leak the ref). Mutated only on the + // owner thread (creation, destroyEngine, bridge_env_cleanup) under the usual + // owner-thread-serialization contract. + bool hook_registered; + struct engine_bridge* next; +} engine_bridge_t; +static engine_bridge_t* g_bridges = NULL; // linked list, guarded by g_mutex + +// Round-15 (svacas P1): bridges whose engine destroy was SKIPPED because +// fn_attach_thread failed while the isolate was STILL LIVE. Such a bridge must +// NOT be freed: the Java-side CallbackWeaveResourceResolver still holds it as +// its ctx word, so freeing it would leave a dangling ctx that a later +// run_script_engine -> resolve_module_callback dereferences (UAF). Retain the +// bridge here (linked via its own `next`, which is free once the bridge is +// unlinked from g_bridges -- every bridge_finalize call site unlinks first) so +// its ctx stays valid, and retry the destroy + free at the next drain point +// (top of napi_initialize, or an op-completion path) once the isolate is +// confirmed live and attachable -- or, if the isolate went away, free it then +// (the Java registry died with the isolate). All access under g_mutex. +static engine_bridge_t* g_stranded_bridges = NULL; // linked list, guarded by g_mutex + +// --- Test-only fault injection & introspection (review #12 #3 / #13) --- +// +// These are INERT in production: the __test_* N-API functions are registered +// only when the process sets DATAWEAVE_TEST_HOOKS to a non-empty value (checked +// once in Init on the main JS thread, before any engine exists). g_test_hooks +// gates the two extra branches in the finalize path so a production build never +// takes an extra lock or check. g_test_force_strand_once starts false and can +// only be armed via __test_forceStrandOnce(). +// +// The Node strand regression test uses these to deterministically force a SINGLE +// live-isolate strand (an fn_attach_thread failure while the isolate is live) +// inside bridge_finalize_registry and observe the outcome: pre-fix the bridge is +// enqueued on g_stranded_bridges (resolver_js ref leaked / drained undeleted); +// post-fix it is kept by its owner-env cleanup hook and the ref is deleted on the +// owner thread at env teardown (g_test_resolver_ref_deletes counts those deletes). +// g_test_hooks is written once in Init before any reader runs; g_test_force_strand_once +// and g_test_resolver_ref_deletes are accessed only under g_mutex. +static bool g_test_hooks = false; +static bool g_test_force_strand_once = false; +static long long g_test_resolver_ref_deletes = 0; + +// One record per napi_env that has ever taken an init reference (via +// initialize()). init_refs is that env's net initialize()-minus-cleanup() +// balance. Created lazily on the env's first initialize(); registers exactly +// one env-death hook (env_init_cleanup) at creation; freed by that hook when +// its env dies (after releasing every reference the env still holds). All +// fields mutated ONLY under g_mutex. +// +// INVARIANT: g_ref_count == sum of init_refs over all records in g_env_recs. +// This is the round-13 (#5) fix: the isolate's reference count is owned per +// env, so an abandoned env (or a raw multi-engine-per-initialize() consumer) +// can only release the references IT holds -- it can never drive g_ref_count +// to zero and tear the isolate down while ANOTHER env's engines are live. +typedef struct env_init_rec { + napi_env env; + int init_refs; + struct env_init_rec* next; +} env_init_rec_t; +static env_init_rec_t* g_env_recs = NULL; // linked list, guarded by g_mutex + +// --- Teardown-vs-active-ops coordination (deadlock fix) --- +// +// napi_cleanup's last-release path used to synchronously join a thread that +// calls graal_tear_down_isolate(), which blocks until every GraalVM-attached +// thread detaches. A runStreaming()/runTransform() background worker stays +// attached and can be mid-delivery in napi_call_threadsafe_function(..., +// napi_tsfn_blocking), which needs the JS thread to run its callback -- but +// the JS thread is the one blocked in the join. g_active_ops tracks every +// in-flight streaming/transform op (resolver-backed or not, since teardown +// blocks on ANY attached worker) so napi_cleanup can wait for them to drain +// on a dedicated thread instead of blocking the calling JS thread. +static int g_active_ops = 0; +// Teardown lifecycle, all transitions under g_mutex: +// NONE -> no teardown queued or in progress. +// PENDING_WAIT -> napi_cleanup Case 5 queued a teardown; the waiter thread is +// blocked waiting for g_active_ops to drain. The isolate is +// STILL LIVE and un-torn-down here, so a fresh initialize() +// may ADOPT it (cancel the teardown) instead of blocking the +// JS thread -- this is the round-5 deadlock fix. +// TEARING_DOWN -> the waiter has passed the point of no return and is calling +// graal_tear_down_isolate(). Adoption is unsafe; initialize() +// must block here, which is deadlock-free because g_active_ops +// is already 0 (nothing depends on the JS event loop). +typedef enum { + TEARDOWN_NONE = 0, + TEARDOWN_PENDING_WAIT, + TEARDOWN_TEARING_DOWN, +} teardown_state_t; +static teardown_state_t g_teardown_state = TEARDOWN_NONE; +// Set by an adopting initialize() to tell the waiter thread to abort its +// queued teardown and leave the live isolate intact. Read/reset by the waiter. +static bool g_teardown_cancelled = false; +// Round-14 (#2/#3): set under g_mutex when a reached-zero teardown could NOT be +// carried out (teardown-waiter alloc/spawn failed, or cleanup_thread_fn attach +// failed) and the isolate was therefore left LIVE with g_ref_count == 0 and no +// pending teardown. This is a RETRY SIGNAL, not an ownership reference: +// g_ref_count stays 0, so the invariant g_ref_count == sum(init_refs) is +// unaffected. It is cleared when the isolate is (a) actually torn down by a +// retry, or (b) adopted by a later initialize() (a new owner wants it kept). +// While set with g_active_ops > 0, the op-completion drain point retries the +// teardown once ops reach 0 (retry_stranded_teardown_locked). +static bool g_teardown_needed = false; +static uv_cond_t g_teardown_cond; + +// One node per cleanup() call that arrived while a teardown was already +// pending. napi_env/napi_deferred/napi_threadsafe_function are thread-affine, +// so a second cleanup() call from a different Worker's env cannot have its +// promise resolved via another env's tsfn -- each waiting caller gets its own +// node, created on its own env, resolved by the waiter thread on completion. +typedef struct teardown_waiter { + napi_env env; + napi_deferred deferred; + napi_threadsafe_function tsfn; + struct teardown_waiter* next; +} teardown_waiter_t; +static teardown_waiter_t* g_teardown_waiters = NULL; // linked list, guarded by g_mutex + +// Returns true if the buffer is now tracked (or there was nothing to track). +// Returns false only when a buffer was supplied but the tracking node could +// not be allocated — in that case the caller owns `buf` again and MUST free +// it itself, since it will never be reachable from b->results. +static bool resolver_results_track(engine_bridge_t* b, char* buf) { + if (b == NULL || buf == NULL) return true; resolver_result_node_t* node = (resolver_result_node_t*)malloc(sizeof(resolver_result_node_t)); - if (node == NULL) return; // Leak the buffer rather than crash; best-effort tracking. + if (node == NULL) return false; // OOM: caller must free buf to avoid leaking it untracked. node->buf = buf; - node->next = g_resolver_results; - g_resolver_results = node; + node->next = b->results; + b->results = node; + return true; } -static void resolver_results_free_all(void) { - resolver_result_node_t* node = g_resolver_results; +static void resolver_results_free_all(engine_bridge_t* b) { + if (b == NULL) return; + resolver_result_node_t* node = b->results; while (node != NULL) { resolver_result_node_t* next = node->next; free(node->buf); free(node); node = next; } - g_resolver_results = NULL; + b->results = NULL; +} + +// Call under g_mutex. +static engine_bridge_t* bridge_find(long long handle) { + for (engine_bridge_t* b = g_bridges; b != NULL; b = b->next) { + if (b->handle == handle) return b; + } + return NULL; +} + +// Round-15 (svacas P1): retain a bridge whose engine destroy was skipped while +// the isolate was still live (see g_stranded_bridges). The ctx word Java holds +// stays valid until a later drain retries the destroy and frees it. Takes +// g_mutex; the caller MUST have already unlinked `b` from g_bridges (its `next` +// is reused for the stranded list) and MUST NOT hold g_mutex. +// +// Round-10 review note (parked from Task 6): unlike the normal admitted-op path +// in §6.3/above, a stranded bridge is NOT `in_flight`-pinned while it sits on +// g_stranded_bridges. That is safe under the supported single-owner-thread +// contract: a bridge only reaches here via bridge_finalize (destroyEngine, the +// owner-thread-only call, or the env cleanup hook on the owner env's death), and +// both of those already require in_flight == 0 to have run at all (see the +// deferred-destroy comment above bridge_finalize_registry) -- so in_flight is +// already drained to zero by construction before a bridge is ever stranded, and +// bridge_find() can no longer look it up by handle (it's unlinked from +// g_bridges), so no new op can be admitted against it. The only way a +// drained-then-freed stranded bridge could still be dereferenced is unsupported +// cross-Worker handle sharing or other API misuse that starts a background +// operation against a handle after it has already been unlinked here -- +// outside the documented single-owner-thread usage this addon supports. Even in +// that unsupported scenario this is strictly better than the pre-fix behavior +// (an unconditional free on every skipped-destroy path). +static void bridge_retain_stranded(engine_bridge_t* b) { + if (b == NULL) return; + uv_mutex_lock(&g_mutex); + b->next = g_stranded_bridges; + g_stranded_bridges = b; + uv_mutex_unlock(&g_mutex); +} + +// Find this env's init record, or NULL. Caller MUST hold g_mutex. +static env_init_rec_t* env_init_rec_find_locked(napi_env env) { + for (env_init_rec_t* r = g_env_recs; r != NULL; r = r->next) { + if (r->env == env) return r; + } + return NULL; +} + +// Find-or-create this env's init record and increment its init_refs. Sets +// *is_new = true iff a record was just allocated (the caller must then register +// the env-death hook on its own thread). Returns the record, or NULL only on +// calloc failure (caller must NOT bump g_ref_count in that case). Caller MUST +// hold g_mutex. +static env_init_rec_t* env_init_rec_acquire_locked(napi_env env, bool* is_new) { + *is_new = false; + env_init_rec_t* r = env_init_rec_find_locked(env); + if (r == NULL) { + r = (env_init_rec_t*)calloc(1, sizeof(env_init_rec_t)); + if (r == NULL) return NULL; + r->env = env; + r->init_refs = 0; + r->next = g_env_recs; + g_env_recs = r; + *is_new = true; + } + r->init_refs++; + return r; +} + +// Sum of live per-env init references. Caller holds g_mutex. Establishes the +// value g_ref_count must equal (invariant g_ref_count == sum of init_refs); used +// to restore g_ref_count coherently when a deferred teardown cannot be spawned. +static int env_init_refs_total_locked(void) { + int total = 0; + for (env_init_rec_t* r = g_env_recs; r != NULL; r = r->next) total += r->init_refs; + return total; +} + +// Fully dispose of a bridge: delete its napi_ref (if the owning env is still +// alive), free tracked result buffers, free the struct. napi_ref/napi_env are +// thread-affine, so napi_delete_reference MUST run on the bridge's owner +// thread (the JS/Worker thread that created it) while that env is still +// alive -- `env_still_alive` must be false whenever the caller knows the +// owning env is tearing down/dead (e.g. the env == NULL sentinel path in +// call_js_write/call_js_transform_write), even though b->env itself is never +// cleared and stays non-NULL. When env_still_alive is false the napi_ref is +// simply skipped -- Node auto-reclaims refs when their env is destroyed, so +// nothing leaks. The bridge must already be unlinked from g_bridges. Do NOT +// hold g_mutex across this call — it invokes N-API. Callers that freed a +// bridge *early* (destroyEngine / streaming completion) must first drop the +// env cleanup hook via napi_remove_env_cleanup_hook so Node never invokes it +// on freed memory; the hook path itself (bridge_env_cleanup) must not remove +// itself and calls this directly. +// `do_registry_remove` is true when the caller must remove the Java registry +// entry (fn_destroy_engine) for this handle before freeing the record: the +// immediate destroyEngine path, or the deferred drain of either destroyEngine +// (round-9 #1) or the env cleanup hook (round-10 #1). fn_destroy_engine is +// called at most once per handle because destroyEngine and bridge_env_cleanup +// are mutually exclusive (destroyEngine removes the hook). It runs on whichever +// thread finalizes (the owner JS thread from the completion sentinel, +// destroyEngine's thread, or the env-cleanup hook thread); fn_destroy_engine +// attaches its own isolate thread, so it is not JS-thread-affine. Must be +// called WITHOUT g_mutex held (it enters GraalVM and, for env_still_alive, +// calls N-API). +// #3 (round 12): the isolate-touching registry removal. Takes a TRANSIENT +// g_active_ops reservation so graal_tear_down_isolate() cannot run across the +// attach. The teardown-state check and the g_active_ops++ are ONE critical +// section: no teardown path can interleave between "isolate is live" and +// "reservation taken". Callable from any thread NOT holding g_mutex. +// +// Returns TRUE when the caller may safely free the bridge: the engine was +// actually destroyed (registry entry removed), OR the whole isolate is going +// away (TEARING_DOWN / g_isolate == NULL) so the Java registry -- and the +// CallbackWeaveResourceResolver holding this bridge as its ctx -- dies with it. +// Returns FALSE only when the destroy was SKIPPED while the isolate is still +// live (fn_attach_thread failed): the Java registry still holds this bridge as a +// resolver ctx, so freeing it now would be a UAF. The caller must instead retain +// the bridge (bridge_retain_stranded) and retry later (round-15, svacas P1). +static bool bridge_finalize_registry(engine_bridge_t* b) { + if (b == NULL || fn_destroy_engine == NULL) return true; + // Test-only: force ONE live-isolate strand (simulate fn_attach_thread failing + // while the isolate is live -> destroy SKIPPED). Inert unless a test both + // enabled the hooks (DATAWEAVE_TEST_HOOKS) and armed it via + // __test_forceStrandOnce(); one-shot, so exactly one finalize is diverted. + if (g_test_hooks) { + uv_mutex_lock(&g_mutex); + if (g_test_force_strand_once) { + g_test_force_strand_once = false; + uv_mutex_unlock(&g_mutex); + return false; // caller must retain/keep the bridge (ctx still live in Java) + } + uv_mutex_unlock(&g_mutex); + } + uv_mutex_lock(&g_mutex); + // If the waiter already committed to physical teardown (TEARING_DOWN) or the + // isolate is already gone, the Java registry died/dies with it -- nothing to + // remove, and attaching would race graal_tear_down_isolate. Skip, but report + // "safe to free": the registry entry is (being) reclaimed with the isolate, + // so the resolver ctx can no longer be dereferenced. Because the waiter + // publishes TEARING_DOWN (and Case 4 holds g_mutex across its g_active_ops==0 + // check + teardown) under this same lock, this check plus the increment below + // cannot be split by a teardown. + if (g_teardown_state == TEARDOWN_TEARING_DOWN || g_isolate == NULL) { + uv_mutex_unlock(&g_mutex); + return true; + } + g_active_ops++; // pins the live isolate against teardown for this attach + uv_mutex_unlock(&g_mutex); + + void* thread = NULL; + bool destroyed = false; + if (fn_attach_thread(g_isolate, &thread) == 0 && thread != NULL) { + fn_destroy_engine(thread, b->handle); + fn_detach_thread(thread); + destroyed = true; // registry entry removed -> resolver ctx is now dead + } + // else: attach failed while the isolate is STILL LIVE -- destroy was skipped, + // the Java registry still holds this bridge as a resolver ctx. Report FALSE so + // the caller retains (does NOT free) the bridge. + + // Verbatim g_active_ops release pattern. + uv_mutex_lock(&g_mutex); + g_active_ops--; + uv_cond_broadcast(&g_teardown_cond); + uv_mutex_unlock(&g_mutex); + + return destroyed; +} + +// Forward declaration: the env cleanup hook. bridge_finalize re-registers/keeps +// it on an owner-thread live-isolate strand (may_rehook) and removes it on the +// owner-thread free path; the definition is below (after drain_stranded_bridges). +static void bridge_env_cleanup(void* arg); + +// The non-isolate finalize phase: delete the resolver napi_ref (owner JS thread +// only, and only while its env is alive -- resolver-gated), free tracked result +// buffers, free the record. Touches no GraalVM isolate state, so it is safe to +// run after the g_active_ops reservation above is released. +static void bridge_finalize_free(engine_bridge_t* b, bool env_still_alive) { + if (b == NULL) return; + if (env_still_alive && b->resolver_js != NULL && b->env != NULL) { + napi_delete_reference(b->env, b->resolver_js); + // Test-only: count owner-thread resolver-ref deletions so the strand + // regression test can prove the ref was finalized (not leaked / not + // drained undeleted). Inert unless DATAWEAVE_TEST_HOOKS is set. + if (g_test_hooks) { + uv_mutex_lock(&g_mutex); + g_test_resolver_ref_deletes++; + uv_mutex_unlock(&g_mutex); + } + } + resolver_results_free_all(b); + free(b); +} + +// Thin wrapper preserving the original signature and every call site. Registry +// removal (if requested) runs first under its transient reservation, then the +// record is freed -- but round-15 (svacas P1) makes the free CONDITIONAL on the +// registry removal succeeding. If do_registry_remove is requested and the +// destroy was SKIPPED while the isolate is still live, bridge_finalize_registry +// returns false: the Java registry still holds this bridge as a resolver ctx, so +// we must NOT free it. Retain it (bridge_retain_stranded) so the ctx stays valid +// and a later drain retries the destroy and frees it. When do_registry_remove is +// false there is nothing registered (handle <= 0 construction failures), so the +// free is unconditional as before. +// `may_rehook` is true only when the caller is on the bridge's OWNER thread with +// the env alive and continuing (destroyEngine's immediate path, bridge_end_op on +// the owner env). On a live-isolate strand there, ownership of resolver_js's +// deletion stays with the env cleanup hook: keep (or re-register) the hook and +// return WITHOUT enqueuing on g_stranded_bridges, so the OWNER thread deletes the +// ref and frees the record at env teardown -- never the off-thread drain (which +// skips napi_delete_reference and would leak the ref). When may_rehook is false +// (env tearing down, or a creation abort) there is no live owner hook to keep, so +// a strand falls back to bridge_retain_stranded and the drain frees it later. +static void bridge_finalize(engine_bridge_t* b, bool env_still_alive, + bool do_registry_remove, bool may_rehook) { + if (b == NULL) return; + if (do_registry_remove && !bridge_finalize_registry(b)) { + // Strand: isolate live, attach failed, registry entry NOT removed. + if (may_rehook && env_still_alive && b->env != NULL) { + // On the owner thread with the env alive & continuing. Give the bridge + // to its env cleanup hook (still registered here, since the strand + // paths no longer pre-remove it) so the OWNER thread deletes + // resolver_js and frees at env teardown -- never the off-thread drain. + if (!b->hook_registered + && napi_add_env_cleanup_hook(b->env, bridge_env_cleanup, b) == napi_ok) { + b->hook_registered = true; + } + if (b->hook_registered) { + return; // single owner = the hook; NOT on g_stranded_bridges + } + // hook unavailable: fall through to drain (best effort). + } + bridge_retain_stranded(b); // env dead / hook gone: drain frees (ref auto-reclaimed or none) + return; + } + // Free path: remove the hook first (owner thread only) so Node never invokes + // it on freed memory, then delete the ref (env alive) + free. + if (env_still_alive && b->hook_registered && b->env != NULL) { + napi_remove_env_cleanup_hook(b->env, bridge_env_cleanup, b); + b->hook_registered = false; + } + bridge_finalize_free(b, env_still_alive); +} + +// Round-15 (svacas P1): retry destroy for every bridge stranded because its +// engine destroy was skipped on a transient fn_attach_thread failure while the +// isolate was live (see g_stranded_bridges). Detach the whole list under g_mutex, +// then for each bridge retry the isolate registry removal via +// bridge_finalize_registry: on success (or the isolate having since gone away) +// free the record; on repeated failure re-retain it for the next drain. Does +// ONLY GraalVM calls (attach/destroy/detach, inside bridge_finalize_registry) + +// list manipulation + free -- NO napi env-affine calls. In particular the free +// passes env_still_alive=false: this drain may run on a thread that is NOT the +// bridge's owner (e.g. another env's napi_initialize, or a background worker), +// so it must not touch the thread-affine napi_ref; Node reclaims that ref when +// the owner env is destroyed. Safe to call from any thread NOT holding g_mutex. +static void drain_stranded_bridges(void) { + uv_mutex_lock(&g_mutex); + engine_bridge_t* list = g_stranded_bridges; + g_stranded_bridges = NULL; + uv_mutex_unlock(&g_mutex); + + while (list != NULL) { + engine_bridge_t* b = list; + list = list->next; // snapshot the link before b is freed or re-retained + b->next = NULL; + if (bridge_finalize_registry(b)) { + // Registry entry removed (or isolate gone): the resolver ctx is dead, + // so freeing is safe. Skip the napi_ref delete (env_still_alive=false) + // -- we may not be on the owner thread. + bridge_finalize_free(b, /*env_still_alive=*/false); + } else { + // Still could not attach (isolate live, transient failure): keep the + // ctx valid and retry at the next drain. + bridge_retain_stranded(b); + } + } +} + +// Env cleanup hook (F2): registered per resolver-backed bridge at creation via +// napi_add_env_cleanup_hook, so each Worker/main env disposes its OWN bridges on +// its OWN thread when that env tears down — instead of napi_cleanup deleting +// refs from whichever thread happens to release the last DataWeave instance, +// which is undefined behavior for thread-affine napi_env/napi_ref. Runs on the +// owner thread with the env still alive, which is exactly where napi_ref deletion +// is legal. +static void bridge_env_cleanup(void* arg) { + engine_bridge_t* b = (engine_bridge_t*)arg; + if (b == NULL) return; + + // Node auto-removes this hook as it fires it, so it is no longer registered. + // Clear the flag first so bridge_finalize (may_rehook=false below, but also + // the deferred bridge_end_op path) never tries to remove an already-gone hook. + b->hook_registered = false; + + uv_mutex_lock(&g_mutex); + // Unlink from g_bridges if still present (destroyEngine may have already + // unlinked it while deferring a free — see below). + engine_bridge_t** pp = &g_bridges; + while (*pp != NULL) { + if (*pp == b) { *pp = b->next; break; } + pp = &(*pp)->next; + } + // An in-flight streaming/transform op holds a live threadsafe function that + // keeps this env's event loop alive, so the env should never tear down while + // in_flight > 0. Guard defensively anyway: mark destroy_pending and let the + // op's completion path drain and finalize it (do NOT finalize here, the op's + // background thread could still dereference this bridge). + if (b->in_flight > 0) { + b->destroy_pending = true; + // round-10 (#1): the draining op must ALSO remove the Java registry + // entry (like destroyEngine's deferred path), or the resolver engine's + // ScriptRuntime is left registered with a resolver ctx pointing at the + // freed bridge. Set the deferred-registry-removal flag here. + b->deferred_registry_remove = true; + uv_mutex_unlock(&g_mutex); + return; + } + // in_flight == 0: finalize now. The abandoned engine's init reference is + // NOT released here (round-13 #5) -- it is released by the env-death hook + // (env_init_cleanup) when this env dies, which owns the whole per-env + // balance. There is nothing left to do under the lock before unlocking in + // this branch. bridge_finalize_registry inside finalize checks teardown + // state under g_mutex, so a torn-down/TEARING_DOWN isolate makes the + // registry removal a correct no-op (the Java registry died with the + // isolate). + uv_mutex_unlock(&g_mutex); + + // We are inside Node's invocation of this hook, so we must not (and need not) + // call napi_remove_env_cleanup_hook for ourselves here. The env is still + // alive here -- that is the whole point of this hook's design (see above) -- + // so the napi_ref deletion in bridge_finalize is legal. + // round-10 (#1): remove the Java registry entry too (do_registry_remove=true). + // This hook only ever fires for a resolver-backed engine that was never + // passed to destroyEngine (destroyEngine removes this hook), so its + // initialize() ref was never released either -> the isolate is still live + // and fn_destroy_engine's fresh-thread attach is legal (bridge_finalize + // guards on g_isolate for the main-env-after-isolate-teardown corner). Not + // removing it would leave a CallbackWeaveResourceResolver whose ctx is the + // freed bridge -> UAF on a later invocation of this handle. + // may_rehook=false: the env is tearing down, so do NOT re-register the hook on + // a strand -- a strand here falls back to g_stranded_bridges (Node reclaims the + // ref at env teardown; the off-thread drain frees the record later). + bridge_finalize(b, /*env_still_alive=*/true, /*do_registry_remove=*/true, /*may_rehook=*/false); +} + +// Increment this engine's in_flight while g_mutex is ALREADY held. Used by the +// run/streaming/transform admission paths so the per-engine pin is taken in the +// SAME critical section as the g_active_ops reservation and the lifecycle check +// -- closing the round-11 window where a concurrent destroyEngine could observe +// in_flight == 0 and free the bridge under an already-admitted op. Returns the +// record, or NULL for an unknown handle (nothing to pin; the worker/native call +// surfaces "Unknown engine handle"). Caller MUST hold g_mutex. +static engine_bridge_t* bridge_begin_op_locked(long long handle) { + engine_bridge_t* b = bridge_find(handle); + if (b != NULL) b->in_flight++; + return b; +} + +// A streaming/transform/run op marks one op in flight on the engine's record so +// the record (and, for resolver-backed engines, its napi_ref) cannot be freed +// while the background uv_thread runs -- and, since round-9 (#1), so that +// destroyEngine defers the Java registry removal until this op drains. Every +// engine (resolver-backed or resolver-less) now has a record, so +// bridge_begin_op_locked returns a non-NULL pointer for any known handle; the +// completion sentinel MUST call bridge_end_op on it to balance in_flight and +// run any deferred destroy. Returns NULL only for an unknown handle (nothing to +// protect, no bridge_end_op needed). The returned pointer is stable for the +// op's lifetime because in_flight > 0 blocks both destroyEngine and the env +// cleanup hook from freeing the record. Since round-11 (#2), every call site +// takes the pin atomically with its g_mutex-guarded admission check via +// bridge_begin_op_locked directly (no self-locking wrapper) -- see +// napi_run_script_streaming_engine / napi_run_script_transform_engine. + +// End a streaming/transform op. Runs on the owner (JS) thread from the completion +// sentinel. If destroyEngine (or the env cleanup hook) ran while this op was in +// flight, it deferred the free — already unlinked from g_bridges — so the last op +// to drain finalizes the bridge here, on the legal (owner) thread. `env_still_alive` +// must be false when the caller is running the env == NULL sentinel path (the +// owning env is tearing down/dead), so a finalize triggered from here does not +// call napi_delete_reference on a dead env. +static void bridge_end_op(engine_bridge_t* b, bool env_still_alive) { + if (b == NULL) return; + uv_mutex_lock(&g_mutex); + b->in_flight--; + bool finalize = (b->destroy_pending && b->in_flight == 0); + bool remove_registry = finalize && b->deferred_registry_remove; + uv_mutex_unlock(&g_mutex); + // remove_registry is true when either destroyEngine (round-9 #1) or the env + // cleanup hook (round-10 #1) deferred the registry removal while this op was + // in flight; the draining op performs it exactly once here. bridge_finalize + // guards the call on g_isolate, so a teardown that raced ahead is a no-op. + // env_still_alive here means we are draining on the owner thread with the env + // alive, so a live-isolate strand may keep the env cleanup hook (may_rehook). + // When env_still_alive is false (env == NULL sentinel path) a strand falls back + // to the drain, which is correct: the owner env is gone. + if (finalize) bridge_finalize(b, env_still_alive, /*do_registry_remove=*/remove_registry, + /*may_rehook=*/env_still_alive); } // --- Initialization --- @@ -140,27 +674,39 @@ static void init_thread_fn(void* arg) { uv_dlsym(&g_lib, "graal_attach_thread", (void**)&fn_attach_thread); uv_dlsym(&g_lib, "graal_detach_thread", (void**)&fn_detach_thread); uv_dlsym(&g_lib, "graal_tear_down_isolate", (void**)&fn_tear_down_isolate); - uv_dlsym(&g_lib, "run_script", (void**)&fn_run_script); uv_dlsym(&g_lib, "free_cstring", (void**)&fn_free_cstring); - uv_dlsym(&g_lib, "run_script_callback", (void**)&fn_run_script_callback); - uv_dlsym(&g_lib, "run_script_input_output_callback", (void**)&fn_run_script_input_output_callback); - - // Load resolver-aware entrypoints (optional - newer symbols) - uv_dlsym(&g_lib, "run_script_with_resolver", (void**)&fn_run_script_with_resolver); - // fn_run_script_callback_with_resolver / fn_run_script_input_output_callback_with_resolver - // are resolved here but intentionally never called from this file. Wiring them into - // runScriptStreaming/runScriptTransform would put the resolver callback on a background - // uv_thread, which is unsafe for the same reason resolve_module_callback() above guards - // against cross-thread napi calls — do not wire these up without solving that hazard first. - uv_dlsym(&g_lib, "run_script_callback_with_resolver", (void**)&fn_run_script_callback_with_resolver); - uv_dlsym(&g_lib, "run_script_input_output_callback_with_resolver", (void**)&fn_run_script_input_output_callback_with_resolver); - - if (!fn_create_isolate || !fn_run_script || !fn_free_cstring) { + + // Load per-engine entrypoints. Every initialize() call creates an engine via + // create_engine/create_engine_with_resolver (see dataweave.ts), so these are + // load-time required, not optional. + uv_dlsym(&g_lib, "create_engine", (void**)&fn_create_engine); + uv_dlsym(&g_lib, "create_engine_with_resolver", (void**)&fn_create_engine_with_resolver); + uv_dlsym(&g_lib, "destroy_engine", (void**)&fn_destroy_engine); + uv_dlsym(&g_lib, "run_script_engine", (void**)&fn_run_script_engine); + uv_dlsym(&g_lib, "run_script_callback_engine", (void**)&fn_run_script_callback_engine); + uv_dlsym(&g_lib, "run_script_input_output_callback_engine", (void**)&fn_run_script_input_output_callback_engine); + + if (!fn_create_isolate || !fn_free_cstring) { snprintf(args->error, sizeof(args->error), "Missing required symbols in library"); args->result = -2; return; } + // Fail fast, with a clear message, if the loaded dwlib predates the + // per-engine ABI (W-23692110). Without this check, the library would load + // "successfully" here and every initialize() call would still fail later + // deep inside createEngine()/createEngineWithResolver() with a confusing + // "not available in native library" error instead of this one. + if (!fn_create_engine || !fn_create_engine_with_resolver || !fn_destroy_engine || + !fn_run_script_engine || !fn_run_script_callback_engine || + !fn_run_script_input_output_callback_engine) { + snprintf(args->error, sizeof(args->error), + "dwlib is missing required per-engine symbols (expected in dwlib " + "built with W-23692110 or later) - rebuild/upgrade the native library"); + args->result = -2; + return; + } + void* boot_thread = NULL; rc = fn_create_isolate(NULL, &g_isolate, &boot_thread); if (rc != 0) { @@ -184,23 +730,163 @@ static void init_thread_fn(void* arg) { args->result = 0; } +// Forward declaration: the env-death hook that reclaims an abandoned env's +// init references. Defined below (round-13 #5); registered here (in +// env_init_acquire_and_hook) because napi_add_env_cleanup_hook is only legal +// while the env is alive on its own JS thread, which napi_initialize is. +static void env_init_cleanup(void* arg); // defined below (round-13 #5) + +// Acquire one init reference for `env` under g_mutex, registering the env-death +// hook on first use. Returns true on success (caller then does g_ref_count++); +// on failure the caller must NOT bump g_ref_count -- it unlocks and throws. +// Caller MUST hold g_mutex; this function keeps it held on success and on the +// calloc-failure return. On hook-registration failure it rolls back the +// just-acquired init_refs (freeing the record if it drops to 0) so no orphan +// record without a death hook survives. +static bool env_init_acquire_and_hook(napi_env env) { + bool is_new = false; + env_init_rec_t* rec = env_init_rec_acquire_locked(env, &is_new); + if (rec == NULL) return false; // calloc failed + if (is_new) { + napi_status hs = napi_add_env_cleanup_hook(env, env_init_cleanup, rec); + if (hs != napi_ok) { + // Roll back: this record has no death hook, so its references would + // never be reclaimed. Drop the one we just took; free if now empty. + rec->init_refs--; + if (rec->init_refs == 0) { + env_init_rec_t** pp = &g_env_recs; + while (*pp != NULL) { if (*pp == rec) { *pp = rec->next; break; } pp = &(*pp)->next; } + free(rec); + } + return false; + } + } + return true; +} + +// Forward declaration: tears down g_isolate on a dedicated attached thread. +// Defined below; used here (napi_initialize's create-path acquire-failure +// recovery) and further down by isolate_ref_release_n_locked. +static void cleanup_thread_fn(void* arg); + +// Forward declaration: retries a stranded teardown (round-14 #2/#3). Defined +// further below; used by the streaming/transform op-completion drain points, +// which run earlier in this file than the definition. +static void retry_stranded_teardown_locked(void); + static napi_value napi_initialize(napi_env env, napi_callback_info info) { size_t argc = 1; napi_value argv[1]; - napi_get_cb_info(env, info, &argc, argv, NULL, NULL); - - if (argc < 1) { + // Review #10 #5 (svacas P2): check napi_get_cb_info's status too, not just + // argc -- mirrors every other validated entrypoint in this file (e.g. + // napi_run_script_engine), which never assumes an N-API call succeeded. + if (napi_get_cb_info(env, info, &argc, argv, NULL, NULL) != napi_ok || argc < 1) { napi_throw_error(env, NULL, "initialize requires a library path argument"); return NULL; } + // Reject a non-string argv[0] before touching the stack lib_path buffer + // below. Without this, a non-string argument left napi_get_value_string_utf8's + // status ignored and lib_path uninitialized/partially-written before + // uv_dlopen read it (garbage path, occasionally UB). + napi_valuetype vt; + if (napi_typeof(env, argv[0], &vt) != napi_ok || vt != napi_string) { + napi_throw_error(env, NULL, "initialize: library path must be a string"); + return NULL; + } + char lib_path[4096]; size_t len; - napi_get_value_string_utf8(env, argv[0], lib_path, sizeof(lib_path), &len); + if (napi_get_value_string_utf8(env, argv[0], lib_path, sizeof(lib_path), &len) != napi_ok) { + napi_throw_error(env, NULL, "initialize: failed to read library path"); + return NULL; + } + + // Round-15 (svacas P1): retry any bridge whose engine destroy was skipped on a + // transient attach failure (g_stranded_bridges). Drain before taking g_mutex + // (drain_stranded_bridges locks internally). If a live isolate survives from a + // prior init the retry destroys + frees it now; if the isolate is gone the + // stranded bridges are freed (their Java registry died with it). Cheap no-op + // when nothing is stranded. + drain_stranded_bridges(); uv_mutex_lock(&g_mutex); + + // A prior last-release could not tear the isolate down and armed the retry + // signal (review #6 #3/#4). Because retries otherwise fire only at op + // completion (the streaming/transform drains), a zero-op stranded isolate + // would never be reclaimed and the adoption/fast paths below would silently + // discard the pending teardown (review #6 #5). Drive the pending teardown to + // completion here first: on success g_isolate/g_initialized are cleared and we + // build a fresh isolate below; on repeated failure the live isolate is adopted + // by the fast path (safe -- the teardown was resource reclamation, not a + // malfunction). No-ops cheaply when nothing is stranded (flag clear -> return). + retry_stranded_teardown_locked(); + + // After the retry above, a PERSISTENTLY failing teardown leaves the isolate + // live but unusable: g_isolate != NULL, g_initialized == 0, and + // g_teardown_state == TEARDOWN_NONE (no teardown thread exists). The wait loop + // below would treat `g_isolate != NULL && !g_initialized` as "a teardown is in + // flight" and block on uv_cond_wait -- but nothing remains to broadcast + // g_teardown_cond, so it would hang forever holding g_mutex and freeze every + // future initialize()/cleanup() (review #8 #1). This state is not recoverable + // by waiting; fail deterministically instead. g_teardown_needed stays armed so + // a later op-completion drain can still reclaim the isolate; we neither clear + // it nor touch g_ref_count (still 0 == sum(init_refs), invariant intact). + if (g_isolate != NULL && !g_initialized && g_teardown_state == TEARDOWN_NONE) { + uv_mutex_unlock(&g_mutex); + napi_throw_error(env, NULL, + "DataWeave native runtime is stranded: a prior isolate " + "teardown failed and could not be reclaimed"); + return NULL; + } + + // If a teardown from a prior cleanup() is still draining (the isolate is + // being torn down on the waiter thread from Task 2), do not race a fresh + // graal_create_isolate against it -- wait until the isolate is fully gone + // before proceeding. This is a narrow, rare path (re-initializing mid-drain), + // not a fast path, so a blocking wait here is acceptable and matches this + // function's existing fully-synchronous contract -- except in + // TEARDOWN_PENDING_WAIT (see below), where blocking would deadlock. + while (g_teardown_state != TEARDOWN_NONE || (g_isolate != NULL && !g_initialized)) { + if (g_teardown_state == TEARDOWN_PENDING_WAIT) { + // A teardown is queued but the waiter has NOT begun physical teardown + // (that transition to TEARING_DOWN happens under this same g_mutex), so + // g_isolate/g_initialized are still valid. Blocking here would freeze the + // JS event loop that an active streaming/transform worker needs in order + // to drain g_active_ops -- the waiter would then wait forever and this + // wait would never end (the P1 deadlock). Instead, ADOPT the live isolate: + // cancel the queued teardown, take a fresh ref, and wake the waiter so it + // aborts without tearing down. g_initialized is already 1, so fall through + // to the ref-count path below is unnecessary -- return directly. + if (!env_init_acquire_and_hook(env)) { + uv_mutex_unlock(&g_mutex); + napi_throw_error(env, NULL, "Failed to allocate/register env init record"); + return NULL; + } + g_teardown_cancelled = true; + g_ref_count++; + g_teardown_needed = false; // round-14: a new owner wants the isolate kept + uv_cond_broadcast(&g_teardown_cond); + uv_mutex_unlock(&g_mutex); + return NULL; + } + // TEARDOWN_TEARING_DOWN (or a transient g_isolate!=NULL && !g_initialized): + // g_active_ops has already reached 0, so nothing depends on the JS event + // loop -- this blocking wait is deadlock-free and preserves the original + // "don't race graal_create_isolate against graal_tear_down_isolate" + // guarantee that round 3's Task 3 added. + uv_cond_wait(&g_teardown_cond, &g_mutex); + } + if (g_initialized) { + if (!env_init_acquire_and_hook(env)) { + uv_mutex_unlock(&g_mutex); + napi_throw_error(env, NULL, "Failed to allocate/register env init record"); + return NULL; + } g_ref_count++; + g_teardown_needed = false; // round-14: a new owner wants the isolate kept uv_mutex_unlock(&g_mutex); return NULL; } @@ -214,7 +900,12 @@ static napi_value napi_initialize(napi_env env, napi_callback_info info) { uv_thread_options_t opts; opts.flags = UV_THREAD_HAS_STACK_SIZE; opts.stack_size = 16 * 1024 * 1024; - uv_thread_create_ex(&tid, &opts, init_thread_fn, &args); + int spawn_rc = uv_thread_create_ex(&tid, &opts, init_thread_fn, &args); + if (spawn_rc != 0) { + uv_mutex_unlock(&g_mutex); + napi_throw_error(env, NULL, "Failed to spawn initialization thread"); + return NULL; + } uv_thread_join(&tid); if (args.result != 0) { @@ -223,94 +914,87 @@ static napi_value napi_initialize(napi_env env, napi_callback_info info) { return NULL; } + if (!env_init_acquire_and_hook(env)) { + // init_thread_fn already built the isolate (g_isolate != NULL) but we have + // not yet set g_initialized = 1. If we just unlock and throw here, we leave + // g_isolate != NULL && g_initialized == 0 -- the exact condition the wait + // loop above (`g_isolate != NULL && !g_initialized`) treats as "a teardown + // is in flight". With g_teardown_state == TEARDOWN_NONE that loop cannot + // take the TEARDOWN_PENDING_WAIT adoption branch, so it falls into + // uv_cond_wait(&g_teardown_cond, ...) with nothing left to ever broadcast -- + // every subsequent initialize() on any env hangs forever. Every sibling + // error path (args.result != 0 above, and the spawn-failure path before it) + // leaves g_isolate == NULL instead, which is the recoverable state. Tear + // the just-built isolate back down before throwing so we restore that same + // recoverable g_isolate == NULL state. + // + // g_ref_count is still 0 here (we never got past this check to bump it), + // and env_init_acquire_and_hook leaves no orphan record behind on failure + // (calloc failure never created one; hook-registration failure rolls its + // own record back) -- so the invariant g_ref_count == sum(init_refs) holds + // with both sides at 0 both before and after this block. + uv_thread_t cleanup_tid; + uv_thread_options_t cleanup_opts; + cleanup_opts.flags = UV_THREAD_HAS_STACK_SIZE; + cleanup_opts.stack_size = 2 * 1024 * 1024; + int torn_down = 0; + int cleanup_spawn_rc = uv_thread_create_ex(&cleanup_tid, &cleanup_opts, cleanup_thread_fn, &torn_down); + if (cleanup_spawn_rc == 0) { + uv_thread_join(&cleanup_tid); + } + if (torn_down) { + // Teardown ran (or there was nothing to tear down) -- clear the globals + // so the next initialize() sees a clean slate. g_ref_count is already 0. + g_thread = NULL; + g_isolate = NULL; + g_initialized = 0; + } else { + // Spawn failed, or cleanup_thread_fn's attach/teardown to the isolate + // failed. The isolate is genuinely still alive with g_initialized == 0. + // Without a retry signal the next initialize() would reach the wait loop's + // `g_isolate != NULL && !g_initialized` condition with TEARDOWN_NONE (so no + // adoption branch) and block on uv_cond_wait forever -- nothing left to + // broadcast (review #7 #2). Arm the stranded-teardown retry so the + // retry_stranded_teardown_locked() at the top of the next napi_initialize + // reclaims the isolate (teardown succeeds -> fresh build). This path leaves + // g_initialized == 0, so -- unlike the release-path twin in + // isolate_ref_release_n_locked, which leaves g_initialized == 1 and is + // adopted by the g_initialized-gated fast path -- recovery here relies on + // the retry actually tearing down: it recovers the realistic TRANSIENT + // failure, but a truly PERSISTENT graal_tear_down_isolate failure would + // re-arm and retry each time and ultimately leave the isolate stranded + // until process exit (best-effort degradation, not a wedge of new work). + // g_ref_count is still 0 here, so g_teardown_needed (a retry SIGNAL, not a + // reference) keeps the invariant g_ref_count == sum(init_refs) intact. + // Mirrors the twin arm in teardown_waiter_thread_fn. + g_teardown_needed = true; + } + uv_mutex_unlock(&g_mutex); + napi_throw_error(env, NULL, "Failed to allocate/register env init record"); + return NULL; + } g_initialized = 1; g_ref_count++; + // Round-14: defensive clear. A brand-new isolate can never carry a stale + // stranded-teardown signal for itself (a new graal_create_isolate only runs + // when g_isolate == NULL, so this path cannot reuse a surviving stranded + // isolate) -- but clear it here anyway at the single create-path success + // point so no later drain retries a teardown against the isolate this + // initialize() just created and now owns. + g_teardown_needed = false; uv_mutex_unlock(&g_mutex); return NULL; } -// --- Helper: run any GraalVM call on a dedicated thread --- - -struct script_call_args { - const char* script; - const char* inputs_json; - char* result; -}; - -static void run_script_thread_fn(void* arg) { - struct script_call_args* a = (struct script_call_args*)arg; - - void* thread = NULL; - int rc = fn_attach_thread(g_isolate, &thread); - if (rc != 0) { - a->result = strdup("{\"success\":false,\"error\":\"Failed to attach GraalVM thread\"}"); - return; - } - - void* ptr = fn_run_script(thread, a->script, a->inputs_json); - if (ptr) { - a->result = strdup((const char*)ptr); - fn_free_cstring(thread, ptr); - } else { - a->result = strdup(""); - } - - fn_detach_thread(thread); -} - -// --- runScript (synchronous from JS, but runs GraalVM on a thread) --- - -static napi_value dw_napi_run_script(napi_env env, napi_callback_info info) { - if (!g_initialized) { - napi_throw_error(env, NULL, "Not initialized. Call initialize() first."); - return NULL; - } - - size_t argc = 2; - napi_value argv[2]; - napi_get_cb_info(env, info, &argc, argv, NULL, NULL); - - if (argc < 2) { - napi_throw_error(env, NULL, "runScript requires (script, inputsJson)"); - return NULL; - } - - size_t script_len, inputs_len; - napi_get_value_string_utf8(env, argv[0], NULL, 0, &script_len); - napi_get_value_string_utf8(env, argv[1], NULL, 0, &inputs_len); - - char* script = malloc(script_len + 1); - char* inputs = malloc(inputs_len + 1); - napi_get_value_string_utf8(env, argv[0], script, script_len + 1, NULL); - napi_get_value_string_utf8(env, argv[1], inputs, inputs_len + 1, NULL); - - struct script_call_args call_args; - call_args.script = script; - call_args.inputs_json = inputs; - call_args.result = NULL; - - uv_thread_t tid; - uv_thread_options_t opts; - opts.flags = UV_THREAD_HAS_STACK_SIZE; - opts.stack_size = 2 * 1024 * 1024; - uv_thread_create_ex(&tid, &opts, run_script_thread_fn, &call_args); - uv_thread_join(&tid); - - free(script); - free(inputs); - - napi_value result; - if (call_args.result) { - napi_create_string_utf8(env, call_args.result, strlen(call_args.result), &result); - free(call_args.result); - } else { - napi_create_string_utf8(env, "", 0, &result); - } - return result; -} - // --- Streaming output --- +// Round-9 (#2): static terminal-error JSON used when a worker thread cannot +// even strdup its result string (OOM). It is a file-scope constant, never +// heap-allocated, so any code path that would free a sentinel/chunk buffer +// must first check `buf != OOM_JSON` -- freeing a static pointer is UB. The +// wording matches the existing terse worker error style ("Empty response"). +static const char OOM_JSON[] = "{\"success\":false,\"error\":\"Out of memory\"}"; + // chunk_data with len == -1 is a sentinel indicating completion (buf holds meta JSON) struct chunk_data { char* buf; @@ -321,31 +1005,70 @@ struct streaming_work { uv_thread_t tid; napi_threadsafe_function tsfn; napi_deferred deferred; + long long handle; char* script; char* inputs_json; + // The engine's record whose in_flight count this op holds. Since round-9 (#1) + // every engine has a record, so this is non-NULL for any known handle (NULL only + // for an unknown handle). The completion sentinel calls bridge_end_op on it to + // balance in_flight and run any deferred destroy (F1). + engine_bridge_t* bridge; + // review #10 (svacas P2): the completion sentinel, pre-allocated in the + // synchronous setup path (napi_run_script_streaming_engine) so the worker's + // terminal path is allocation-free and can ALWAYS enqueue completion. If it + // were malloc'd on the worker instead, a NULL return there forced a return + // WITHOUT enqueuing -- but the env is alive on OOM, so the promise would + // never settle and the tsfn would never be released: a permanent hang. + struct chunk_data* sentinel; }; static void call_js_write(napi_env env, napi_value js_callback, void* context, void* data) { - if (env == NULL || data == NULL) return; + // data == NULL: nothing was queued, nothing to free or finalize. + if (data == NULL) return; struct chunk_data* chunk = (struct chunk_data*)data; struct streaming_work* w = (struct streaming_work*)context; if (chunk->len == -1) { - napi_value result; - napi_create_string_utf8(env, chunk->buf, strlen(chunk->buf), &result); - napi_resolve_deferred(env, w->deferred, result); + // Completion sentinel. env == NULL means the environment is tearing down + // (e.g. a Worker terminating mid-op): we must not call any napi value or + // JS-calling API (napi_create_string_utf8/napi_resolve_deferred need a + // live env), but we must still perform every bit of native finalization + // -- join the worker, release the tsfn, drop the bridge in-flight hold, + // and free every heap field -- exactly once. Skipping this on env == NULL + // would leak `w` and could strand a bridge marked for deferred destruction + // indefinitely. + if (env != NULL) { + napi_value result; + napi_create_string_utf8(env, chunk->buf, strlen(chunk->buf), &result); + napi_resolve_deferred(env, w->deferred, result); + } - free(chunk->buf); + if (chunk->buf != OOM_JSON) free(chunk->buf); free(chunk); free(w->script); free(w->inputs_json); uv_thread_join(&w->tid); napi_release_threadsafe_function(w->tsfn, napi_tsfn_release); + // Drop the in-flight hold last, on this owner thread: if destroyEngine ran + // during the op it deferred the free to here (F1). After this the bridge may + // be freed, so touch nothing on it afterward. env == NULL means this env is + // dead/tearing down -- tell bridge_end_op (and any bridge_finalize it + // triggers) not to touch the napi_ref, since b->env is this same dead env. + bridge_end_op(w->bridge, /*env_still_alive=*/env != NULL); free(w); return; } + // Non-sentinel data chunk. If env == NULL the environment is gone and we + // cannot deliver it to JS; free it and return without touching `w` (its + // finalization happens only on the sentinel, above). + if (env == NULL) { + free(chunk->buf); + free(chunk); + return; + } + napi_value buffer; void* buf_data; napi_create_buffer_copy(env, chunk->len, chunk->buf, &buf_data, &buffer); @@ -360,8 +1083,14 @@ static void call_js_write(napi_env env, napi_value js_callback, void* context, v static int streaming_write_cb(void* ctx, const char* buf, int len) { napi_threadsafe_function tsfn = (napi_threadsafe_function)ctx; + // Round-9 (#2): OOM here must not deref NULL / memcpy into NULL. Returning -1 + // aborts the native run cleanly (write-callback contract: non-zero stops the + // DataWeave run); the worker then still produces a terminal meta_result and + // sentinel, so the op resolves. struct chunk_data* chunk = malloc(sizeof(struct chunk_data)); + if (chunk == NULL) return -1; chunk->buf = malloc(len); + if (chunk->buf == NULL) { free(chunk); return -1; } memcpy(chunk->buf, buf, len); chunk->len = len; @@ -380,70 +1109,292 @@ static void streaming_thread_fn(void* arg) { void* worker_thread = NULL; int rc = fn_attach_thread(g_isolate, &worker_thread); + // Round-9 (#2): strdup can fail under OOM. meta_result must still be a valid + // C string so the sentinel path below can deliver a terminal result -- fall + // back to the OOM_JSON static (which must never be freed; see the guarded + // frees below and in call_js_write). char* meta_result = NULL; if (rc != 0) { char err[256]; snprintf(err, sizeof(err), "{\"success\":false,\"error\":\"Failed to attach thread (code %d)\"}", rc); meta_result = strdup(err); + if (meta_result == NULL) meta_result = (char*)OOM_JSON; } else { - void* result_ptr = fn_run_script_callback( - worker_thread, w->script, w->inputs_json, streaming_write_cb, (void*)w->tsfn + void* result_ptr = fn_run_script_callback_engine( + worker_thread, w->handle, w->script, w->inputs_json, streaming_write_cb, (void*)w->tsfn ); if (result_ptr) { meta_result = strdup((const char*)result_ptr); + if (meta_result == NULL) meta_result = (char*)OOM_JSON; fn_free_cstring(worker_thread, result_ptr); } else { meta_result = strdup("{\"success\":false,\"error\":\"Empty response\"}"); + if (meta_result == NULL) meta_result = (char*)OOM_JSON; } fn_detach_thread(worker_thread); } - struct chunk_data* sentinel = malloc(sizeof(struct chunk_data)); + // Decrement here, once this thread has fully detached from the isolate -- + // not in call_js_write's completion branch. call_js_write only runs when + // the JS thread's event loop turns, and napi_initialize's pending-teardown + // wait (Task 3) can block that same event loop indefinitely; decrementing + // from the JS-thread callback made the two waits circular. Decrementing + // here ties g_active_ops to the actual invariant isolate teardown needs + // (no GraalVM-attached thread remains), independent of the event loop. + uv_mutex_lock(&g_mutex); + g_active_ops--; + uv_cond_broadcast(&g_teardown_cond); + // Round-14 (#2/#3): if a prior last-release could not tear the isolate down + // and left it stranded (g_teardown_needed), retry now that this op has drained. + retry_stranded_teardown_locked(); + uv_mutex_unlock(&g_mutex); + + // Round-15 (svacas P1): op-completion drain point -- retry destroy for any + // bridge stranded on a transient attach failure. Graal-only + free, no napi + // env call, so it is safe on this background worker thread. + drain_stranded_bridges(); + + // review #10 (svacas P2): the completion sentinel was pre-allocated in the + // synchronous setup path (napi_run_script_streaming_engine) and carried on + // w->sentinel, so this terminal path is ALLOCATION-FREE and the completion + // enqueue + tsfn release always run. The old code malloc'd the sentinel HERE + // and, on NULL, freed w and returned WITHOUT enqueuing -- but the env is + // alive on OOM (not the napi_closing case), so the promise never settled and + // the tsfn was never released: a permanent hang. Pre-allocating removes that + // failure mode entirely. (meta_result above uses the OOM_JSON static fallback + // on strdup failure, so it is always a valid C string and never gates the + // enqueue either.) + struct chunk_data* sentinel = w->sentinel; sentinel->buf = meta_result; sentinel->len = -1; - napi_call_threadsafe_function(w->tsfn, sentinel, napi_tsfn_blocking); + napi_status enq = napi_call_threadsafe_function(w->tsfn, sentinel, napi_tsfn_blocking); + if (enq != napi_ok) { + // The env is tearing down (napi_closing): the sentinel was dropped and + // call_js_write will never run, so finalize here instead -- the exact same + // native cleanup as call_js_write's sentinel branch, minus the things + // that are illegal, impossible, or already done on this worker thread: + // - no napi value / deferred call (env is dead; those are env-affine) + // - no uv_thread_join(&w->tid): we ARE w->tid; a thread cannot join + // itself. The handle goes unreaped -- an unavoidable, negligible leak + // during a Worker teardown that is already discarding this env. + // - no napi_release_threadsafe_function(w->tsfn, ...): this tsfn was + // created with initial_thread_count = 1 and this worker is its sole + // producer, so Node's internal thread_count for it is exactly 1 on + // entry to this Push call. Node's ThreadSafeFunction::Push (the + // implementation behind napi_call_threadsafe_function) decrements + // thread_count for the calling thread BEFORE returning napi_closing, + // and -- if that decrement brings thread_count to 0 while the + // internal state is already kClosed -- Push runs `delete this` on + // the tsfn right there. So receiving napi_closing here already IS + // this thread's discharge of the tsfn (matches the doc's "destroyed + // when every thread ... has called napi_release_threadsafe_function() + // or has received a return status of napi_closing"); calling release + // again afterward would be a double-discharge and, whenever Push + // already deleted the object, a use-after-free. Omit it. + // End the bridge op with env_still_alive=false so bridge_finalize skips + // the thread-affine napi_delete_reference (Node auto-reclaims the ref + // when the dead env is destroyed). + if (sentinel->buf != OOM_JSON) free(sentinel->buf); + free(sentinel); + free(w->script); + free(w->inputs_json); + bridge_end_op(w->bridge, /*env_still_alive=*/false); + free(w); + } } -static napi_value napi_run_script_streaming(napi_env env, napi_callback_info info) { +static napi_value napi_run_script_streaming_engine(napi_env env, napi_callback_info info) { if (!g_initialized) { napi_throw_error(env, NULL, "Not initialized. Call initialize() first."); return NULL; } - if (!fn_run_script_callback) { - napi_throw_error(env, NULL, "run_script_callback not available in native library"); + if (!fn_run_script_callback_engine) { + napi_throw_error(env, NULL, "run_script_callback_engine not available in native library"); return NULL; } - size_t argc = 3; - napi_value argv[3]; + size_t argc = 4; + napi_value argv[4]; napi_get_cb_info(env, info, &argc, argv, NULL, NULL); - if (argc < 3) { - napi_throw_error(env, NULL, "runScriptStreaming requires (script, inputsJson, chunkCallback)"); + if (argc < 4) { + napi_throw_error(env, NULL, "runScriptStreamingEngine requires (handle, script, inputsJson, chunkCallback)"); return NULL; } + // Validate the handle before admission (round-6 #1, defense-in-depth): a + // non-integer handle must be rejected before g_active_ops is ever reserved, + // so there is nothing to unwind here -- simpler than reserving first and + // unwinding on failure. + int64_t handle64; + if (napi_get_value_int64(env, argv[0], &handle64) != napi_ok) { + napi_throw_error(env, NULL, "runScriptStreamingEngine: handle must be an integer"); + return NULL; + } + + // Atomic admission: check lifecycle state and reserve the op in ONE critical + // section, before allocating any work/tsfn/promise/bridge. Reading + // g_initialized outside the lock and reserving g_active_ops later (the old + // shape) let a second Worker's napi_cleanup Case-4 tear the isolate down in + // the gap, so a freshly spawned worker attached to a dead isolate (round-6 + // #2). Rejecting on g_teardown_state != TEARDOWN_NONE also refuses new ops + // once a teardown is queued/underway. Admit an ADOPTED isolate: + // napi_initialize's adoption branch sets g_teardown_cancelled = true on a + // still-live PENDING_WAIT isolate but does not reset g_teardown_state (only + // the async waiter does), so a merely-cancelled teardown must not reject + // here -- otherwise a valid post-adoption op throws "Not initialized". A + // genuine (non-cancelled) PENDING_WAIT or a committed TEARING_DOWN still + // rejects. + uv_mutex_lock(&g_mutex); + if (!g_initialized || (g_teardown_state != TEARDOWN_NONE && !g_teardown_cancelled)) { + uv_mutex_unlock(&g_mutex); + napi_throw_error(env, NULL, "Not initialized. Call initialize() first."); + return NULL; + } + g_active_ops++; + // Round-11 (#2): pin the engine in the SAME critical section as the + // g_active_ops reservation, before any window a concurrent destroyEngine + // could use. NULL for an unknown handle (the worker surfaces "Unknown engine + // handle"). Stashed on w->bridge once w is allocated; every early-return + // below releases it via bridge_end_op alongside g_active_ops. + engine_bridge_t* pinned = bridge_begin_op_locked((long long)handle64); + uv_mutex_unlock(&g_mutex); + + // Conversions run after the admission reservation above, so any throw here + // must release g_active_ops before returning (round-7 #2). size_t script_len, inputs_len; - napi_get_value_string_utf8(env, argv[0], NULL, 0, &script_len); - napi_get_value_string_utf8(env, argv[1], NULL, 0, &inputs_len); + if (napi_get_value_string_utf8(env, argv[1], NULL, 0, &script_len) != napi_ok) { + bridge_end_op(pinned, /*env_still_alive=*/true); + uv_mutex_lock(&g_mutex); g_active_ops--; uv_cond_broadcast(&g_teardown_cond); uv_mutex_unlock(&g_mutex); + napi_throw_error(env, NULL, "runScriptStreamingEngine: script must be a string"); + return NULL; + } + if (napi_get_value_string_utf8(env, argv[2], NULL, 0, &inputs_len) != napi_ok) { + bridge_end_op(pinned, /*env_still_alive=*/true); + uv_mutex_lock(&g_mutex); g_active_ops--; uv_cond_broadcast(&g_teardown_cond); uv_mutex_unlock(&g_mutex); + napi_throw_error(env, NULL, "runScriptStreamingEngine: inputsJson must be a string"); + return NULL; + } + // OOM safety (round-8): every allocation is NULL-checked before it is + // dereferenced, and every failure path releases the g_active_ops reservation + // taken above (mirroring napi_run_script_engine's "OOM" throw). Without this + // an allocation failure segfaults the host process AND strands g_active_ops. struct streaming_work* w = calloc(1, sizeof(struct streaming_work)); + if (w == NULL) { + // w is NULL -- do not touch w->script/w->inputs_json here. + bridge_end_op(pinned, /*env_still_alive=*/true); + uv_mutex_lock(&g_mutex); g_active_ops--; uv_cond_broadcast(&g_teardown_cond); uv_mutex_unlock(&g_mutex); + napi_throw_error(env, NULL, "OOM"); + return NULL; + } + w->handle = (long long)handle64; w->script = malloc(script_len + 1); w->inputs_json = malloc(inputs_len + 1); - napi_get_value_string_utf8(env, argv[0], w->script, script_len + 1, NULL); - napi_get_value_string_utf8(env, argv[1], w->inputs_json, inputs_len + 1, NULL); + if (w->script == NULL || w->inputs_json == NULL) { + free(w->script); free(w->inputs_json); free(w); + bridge_end_op(pinned, /*env_still_alive=*/true); + uv_mutex_lock(&g_mutex); g_active_ops--; uv_cond_broadcast(&g_teardown_cond); uv_mutex_unlock(&g_mutex); + napi_throw_error(env, NULL, "OOM"); + return NULL; + } + if (napi_get_value_string_utf8(env, argv[1], w->script, script_len + 1, NULL) != napi_ok || + napi_get_value_string_utf8(env, argv[2], w->inputs_json, inputs_len + 1, NULL) != napi_ok) { + free(w->script); free(w->inputs_json); free(w); + bridge_end_op(pinned, /*env_still_alive=*/true); + uv_mutex_lock(&g_mutex); g_active_ops--; uv_cond_broadcast(&g_teardown_cond); uv_mutex_unlock(&g_mutex); + napi_throw_error(env, NULL, "runScriptStreamingEngine: failed to read script/inputsJson"); + return NULL; + } + // Round-9 (#3, updated round-11 #2): the resource creations below run AFTER + // g_active_ops was reserved (and after w + its buffers were allocated), and + // the engine pin (`pinned`) was already taken at admission. A failed create + // must release both the pin (bridge_end_op) and g_active_ops (verbatim + // pattern), free any tsfn already created, free w + buffers, and throw -- + // otherwise the worker sees a zeroed w->tsfn/w->deferred (crash), the pin is + // stranded (blocks destroyEngine forever), or g_active_ops is stranded + // (teardown wedge). napi_value resource_name; - napi_create_string_utf8(env, "dwStreaming", NAPI_AUTO_LENGTH, &resource_name); - napi_create_threadsafe_function(env, argv[2], NULL, resource_name, 0, 1, NULL, NULL, w, call_js_write, &w->tsfn); + if (napi_create_string_utf8(env, "dwStreaming", NAPI_AUTO_LENGTH, &resource_name) != napi_ok) { + free(w->script); free(w->inputs_json); free(w); + bridge_end_op(pinned, /*env_still_alive=*/true); + uv_mutex_lock(&g_mutex); g_active_ops--; uv_cond_broadcast(&g_teardown_cond); uv_mutex_unlock(&g_mutex); + napi_throw_error(env, NULL, "runScriptStreamingEngine: failed to create resource name"); + return NULL; + } + if (napi_create_threadsafe_function(env, argv[3], NULL, resource_name, 0, 1, NULL, NULL, w, call_js_write, &w->tsfn) != napi_ok) { + free(w->script); free(w->inputs_json); free(w); + bridge_end_op(pinned, /*env_still_alive=*/true); + uv_mutex_lock(&g_mutex); g_active_ops--; uv_cond_broadcast(&g_teardown_cond); uv_mutex_unlock(&g_mutex); + napi_throw_error(env, NULL, "runScriptStreamingEngine: failed to create threadsafe function"); + return NULL; + } + + // review #10 (svacas P2): pre-allocate the completion sentinel HERE, in the + // synchronous setup path on the owner JS thread, before the worker is + // spawned -- so the worker's terminal completion path is allocation-free and + // can ALWAYS enqueue completion + release the tsfn. On NULL, unwind exactly + // like the promise-creation path below (release the tsfn, which holds w as + // its context; free w + buffers; release the pin and g_active_ops) and throw + // synchronously. This mirrors napi_run_script_engine's "OOM" throw. + w->sentinel = malloc(sizeof(struct chunk_data)); + if (w->sentinel == NULL) { + napi_release_threadsafe_function(w->tsfn, napi_tsfn_release); + free(w->script); free(w->inputs_json); free(w); + bridge_end_op(pinned, /*env_still_alive=*/true); + uv_mutex_lock(&g_mutex); g_active_ops--; uv_cond_broadcast(&g_teardown_cond); uv_mutex_unlock(&g_mutex); + napi_throw_error(env, NULL, "OOM"); + return NULL; + } napi_value promise; - napi_create_promise(env, &w->deferred, &promise); + if (napi_create_promise(env, &w->deferred, &promise) != napi_ok) { + // The tsfn was created above; release it before freeing w (it holds w as + // its context). No worker exists yet, so this release is the sole discharge. + napi_release_threadsafe_function(w->tsfn, napi_tsfn_release); + free(w->sentinel); free(w->script); free(w->inputs_json); free(w); + bridge_end_op(pinned, /*env_still_alive=*/true); + uv_mutex_lock(&g_mutex); g_active_ops--; uv_cond_broadcast(&g_teardown_cond); uv_mutex_unlock(&g_mutex); + napi_throw_error(env, NULL, "runScriptStreamingEngine: failed to create promise"); + return NULL; + } + + // Round-11 (#2): the pin was taken at admission (bridge_begin_op_locked) in + // the same critical section as g_active_ops, so a concurrent destroyEngine + // could never free this bridge under the admitted op. Just record it on w; + // the completion sentinel releases it via bridge_end_op. NULL for a + // resolver-less/unknown engine, handled everywhere as a no-op. + w->bridge = pinned; uv_thread_options_t opts; opts.flags = UV_THREAD_HAS_STACK_SIZE; opts.stack_size = 2 * 1024 * 1024; - uv_thread_create_ex(&w->tid, &opts, streaming_thread_fn, w); + int spawn_rc = uv_thread_create_ex(&w->tid, &opts, streaming_thread_fn, w); + + if (spawn_rc != 0) { + // The worker never ran, so nothing will ever decrement g_active_ops, + // release the bridge hold, or resolve the promise -- unwind everything + // committed above ourselves, in reverse order, mirroring call_js_write's + // completion branch (minus uv_thread_join: there is no thread to join). + uv_mutex_lock(&g_mutex); + g_active_ops--; + uv_cond_broadcast(&g_teardown_cond); + uv_mutex_unlock(&g_mutex); + + // Synchronous call on the JS thread -- env is live here. + bridge_end_op(w->bridge, /*env_still_alive=*/true); + napi_release_threadsafe_function(w->tsfn, napi_tsfn_release); + + napi_value result; + napi_create_string_utf8(env, "{\"success\":false,\"error\":\"Failed to spawn streaming worker thread\"}", NAPI_AUTO_LENGTH, &result); + napi_resolve_deferred(env, w->deferred, result); + + free(w->sentinel); + free(w->script); + free(w->inputs_json); + free(w); + } return promise; } @@ -455,11 +1406,22 @@ struct transform_work { napi_threadsafe_function read_tsfn; napi_threadsafe_function write_tsfn; napi_deferred deferred; + long long handle; char* script; char* inputs_json; char* input_name; char* input_mime_type; char* input_charset; + // The engine's record whose in_flight count this op holds. Since round-9 (#1) + // every engine has a record, so this is non-NULL for any known handle (NULL only + // for an unknown handle). The completion sentinel calls bridge_end_op on it to + // balance in_flight and run any deferred destroy (F1). + engine_bridge_t* bridge; + // review #10 (svacas P2): the completion sentinel, pre-allocated in the + // synchronous setup path (napi_run_script_transform_engine) so the worker's + // terminal path is allocation-free and can ALWAYS enqueue completion. See + // the same field on struct streaming_work for the hang this prevents. + struct chunk_data* sentinel; }; struct read_request { @@ -472,66 +1434,78 @@ struct read_request { }; static void call_js_read(napi_env env, napi_value js_callback, void* context, void* data) { - if (env == NULL || data == NULL) return; + if (data == NULL) return; // nothing to signal struct read_request* req = (struct read_request*)data; - napi_value buf_size_val; - napi_create_int32(env, req->buffer_size, &buf_size_val); + if (env == NULL) { + // N-API can invoke a threadsafe-function callback with env == NULL when + // the environment is tearing down with items still queued (e.g. a Worker + // terminating mid-transform). transform_read_cb is synchronously blocked + // on req->cond waiting for this callback to signal it -- unlike + // call_js_write/call_js_transform_write, there is no sentinel-driven path + // that would otherwise unblock it. Treat this as a terminal read error so + // the blocked thread wakes up, detects the failure via bytes_read == -1, + // and the worker can detach from the isolate instead of hanging forever. + req->bytes_read = -1; + } else { + napi_value buf_size_val; + napi_create_int32(env, req->buffer_size, &buf_size_val); - napi_value global; - napi_get_global(env, &global); + napi_value global; + napi_get_global(env, &global); - napi_value result; - napi_status status = napi_call_function(env, global, js_callback, 1, &buf_size_val, &result); - - if (status == napi_ok && result != NULL) { - bool is_buffer; - napi_is_buffer(env, result, &is_buffer); - if (is_buffer) { - void* buf_data; - size_t buf_len; - napi_get_buffer_info(env, result, &buf_data, &buf_len); - int n = (int)buf_len < req->buffer_size ? (int)buf_len : req->buffer_size; - if (n > 0) memcpy(req->buffer, buf_data, n); - req->bytes_read = n; - } else { - req->bytes_read = 0; - } - } else { - // Clear pending exception to prevent propagation - if (status == napi_pending_exception) { - napi_value exception; - napi_get_and_clear_last_exception(env, &exception); - - // Extract and log exception details before discarding - napi_value message_prop, stack_prop; - char message_buf[512] = {0}; - char stack_buf[2048] = {0}; - size_t message_len = 0, stack_len = 0; - - // Try to get the message property - if (napi_get_named_property(env, exception, "message", &message_prop) == napi_ok) { - napi_get_value_string_utf8(env, message_prop, message_buf, sizeof(message_buf), &message_len); + napi_value result; + napi_status status = napi_call_function(env, global, js_callback, 1, &buf_size_val, &result); + + if (status == napi_ok && result != NULL) { + bool is_buffer; + napi_is_buffer(env, result, &is_buffer); + if (is_buffer) { + void* buf_data; + size_t buf_len; + napi_get_buffer_info(env, result, &buf_data, &buf_len); + int n = (int)buf_len < req->buffer_size ? (int)buf_len : req->buffer_size; + if (n > 0) memcpy(req->buffer, buf_data, n); + req->bytes_read = n; + } else { + req->bytes_read = 0; } + } else { + // Clear pending exception to prevent propagation + if (status == napi_pending_exception) { + napi_value exception; + napi_get_and_clear_last_exception(env, &exception); + + // Extract and log exception details before discarding + napi_value message_prop, stack_prop; + char message_buf[512] = {0}; + char stack_buf[2048] = {0}; + size_t message_len = 0, stack_len = 0; + + // Try to get the message property + if (napi_get_named_property(env, exception, "message", &message_prop) == napi_ok) { + napi_get_value_string_utf8(env, message_prop, message_buf, sizeof(message_buf), &message_len); + } - // Try to get the stack property - if (napi_get_named_property(env, exception, "stack", &stack_prop) == napi_ok) { - napi_get_value_string_utf8(env, stack_prop, stack_buf, sizeof(stack_buf), &stack_len); - } + // Try to get the stack property + if (napi_get_named_property(env, exception, "stack", &stack_prop) == napi_ok) { + napi_get_value_string_utf8(env, stack_prop, stack_buf, sizeof(stack_buf), &stack_len); + } - // Log the exception to stderr for diagnostics - fprintf(stderr, "[DataWeave Node addon] Read callback threw exception:\n"); - if (message_len > 0) { - fprintf(stderr, " Message: %s\n", message_buf); - } - if (stack_len > 0) { - fprintf(stderr, " Stack:\n%s\n", stack_buf); - } - if (message_len == 0 && stack_len == 0) { - fprintf(stderr, " (Unable to extract exception details)\n"); + // Log the exception to stderr for diagnostics + fprintf(stderr, "[DataWeave Node addon] Read callback threw exception:\n"); + if (message_len > 0) { + fprintf(stderr, " Message: %s\n", message_buf); + } + if (stack_len > 0) { + fprintf(stderr, " Stack:\n%s\n", stack_buf); + } + if (message_len == 0 && stack_len == 0) { + fprintf(stderr, " (Unable to extract exception details)\n"); + } } + req->bytes_read = -1; // Signal error } - req->bytes_read = -1; // Signal error } uv_mutex_lock(&req->mutex); @@ -572,8 +1546,12 @@ static int transform_read_cb(void* ctx, char* buf, int buf_size) { static int transform_write_cb(void* ctx, const char* buf, int len) { struct transform_work* w = (struct transform_work*)ctx; + // Round-9 (#2): OOM-safe, mirrors streaming_write_cb. Return -1 to abort the + // native run cleanly; the worker still delivers a terminal sentinel. struct chunk_data* chunk = malloc(sizeof(struct chunk_data)); + if (chunk == NULL) return -1; chunk->buf = malloc(len); + if (chunk->buf == NULL) { free(chunk); return -1; } memcpy(chunk->buf, buf, len); chunk->len = len; @@ -587,16 +1565,27 @@ static int transform_write_cb(void* ctx, const char* buf, int len) { } static void call_js_transform_write(napi_env env, napi_value js_callback, void* context, void* data) { - if (env == NULL || data == NULL) return; + // data == NULL: nothing was queued, nothing to free or finalize. + if (data == NULL) return; struct chunk_data* chunk = (struct chunk_data*)data; struct transform_work* w = (struct transform_work*)context; if (chunk->len == -1) { - napi_value result; - napi_create_string_utf8(env, chunk->buf, strlen(chunk->buf), &result); - napi_resolve_deferred(env, w->deferred, result); + // Completion sentinel. env == NULL means the environment is tearing down + // (e.g. a Worker terminating mid-op): we must not call any napi value or + // JS-calling API (napi_create_string_utf8/napi_resolve_deferred need a + // live env), but we must still perform every bit of native finalization + // -- join the worker, release both tsfns, drop the bridge in-flight hold, + // and free every heap field -- exactly once. Skipping this on env == NULL + // would leak `w` and could strand a bridge marked for deferred destruction + // indefinitely. + if (env != NULL) { + napi_value result; + napi_create_string_utf8(env, chunk->buf, strlen(chunk->buf), &result); + napi_resolve_deferred(env, w->deferred, result); + } - free(chunk->buf); + if (chunk->buf != OOM_JSON) free(chunk->buf); free(chunk); free(w->script); free(w->inputs_json); @@ -607,10 +1596,25 @@ static void call_js_transform_write(napi_env env, napi_value js_callback, void* uv_thread_join(&w->tid); napi_release_threadsafe_function(w->read_tsfn, napi_tsfn_release); napi_release_threadsafe_function(w->write_tsfn, napi_tsfn_release); + // Drop the in-flight hold last, on this owner thread: if destroyEngine ran + // during the op it deferred the free to here (F1). After this the bridge may + // be freed, so touch nothing on it afterward. env == NULL means this env is + // dead/tearing down -- tell bridge_end_op (and any bridge_finalize it + // triggers) not to touch the napi_ref, since b->env is this same dead env. + bridge_end_op(w->bridge, /*env_still_alive=*/env != NULL); free(w); return; } + // Non-sentinel data chunk. If env == NULL the environment is gone and we + // cannot deliver it to JS; free it and return without touching `w` (its + // finalization happens only on the sentinel, above). + if (env == NULL) { + free(chunk->buf); + free(chunk); + return; + } + napi_value buffer; void* buf_data; napi_create_buffer_copy(env, chunk->len, chunk->buf, &buf_data, &buffer); @@ -629,94 +1633,321 @@ static void transform_thread_fn(void* arg) { void* worker_thread = NULL; int rc = fn_attach_thread(g_isolate, &worker_thread); + // Round-9 (#2): strdup can fail under OOM; fall back to the OOM_JSON static + // so the sentinel below still delivers a terminal result. Mirrors + // streaming_thread_fn. char* meta_result = NULL; if (rc != 0) { char err[256]; snprintf(err, sizeof(err), "{\"success\":false,\"error\":\"Failed to attach thread (code %d)\"}", rc); meta_result = strdup(err); + if (meta_result == NULL) meta_result = (char*)OOM_JSON; } else { - void* result_ptr = fn_run_script_input_output_callback( - worker_thread, w->script, w->inputs_json, + void* result_ptr = fn_run_script_input_output_callback_engine( + worker_thread, w->handle, w->script, w->inputs_json, w->input_name, w->input_mime_type, w->input_charset, transform_read_cb, transform_write_cb, (void*)w ); if (result_ptr) { meta_result = strdup((const char*)result_ptr); + if (meta_result == NULL) meta_result = (char*)OOM_JSON; fn_free_cstring(worker_thread, result_ptr); } else { meta_result = strdup("{\"success\":false,\"error\":\"Empty response\"}"); + if (meta_result == NULL) meta_result = (char*)OOM_JSON; } fn_detach_thread(worker_thread); } - struct chunk_data* sentinel = malloc(sizeof(struct chunk_data)); + // See streaming_thread_fn's comment: decrement here (after detach), not in + // call_js_transform_write's completion branch, to avoid the same + // circular-wait deadlock against napi_initialize's pending-teardown wait. + uv_mutex_lock(&g_mutex); + g_active_ops--; + uv_cond_broadcast(&g_teardown_cond); + // Round-14 (#2/#3): retry a stranded teardown now that this op has drained. + retry_stranded_teardown_locked(); + uv_mutex_unlock(&g_mutex); + + // Round-15 (svacas P1): op-completion drain point -- retry destroy for any + // bridge stranded on a transient attach failure. Graal-only + free, no napi + // env call, so it is safe on this background worker thread. + drain_stranded_bridges(); + + // review #10 (svacas P2): the completion sentinel was pre-allocated in the + // synchronous setup path (napi_run_script_transform_engine) and carried on + // w->sentinel, so this terminal path is ALLOCATION-FREE and the completion + // enqueue + tsfn release always run. The old code malloc'd the sentinel HERE + // and, on NULL, freed w and returned WITHOUT enqueuing -- but the env is + // alive on OOM (not the napi_closing case), so the promise never settled and + // the tsfn was never released: a permanent hang. Removing the allocation + // (rather than releasing the tsfn here, which the enq-failure branch below + // documents as unsafe) is what makes the enqueue unconditional. (meta_result + // above uses the OOM_JSON static fallback on strdup failure, so it is always + // a valid C string and never gates the enqueue either.) + struct chunk_data* sentinel = w->sentinel; sentinel->buf = meta_result; sentinel->len = -1; - napi_call_threadsafe_function(w->write_tsfn, sentinel, napi_tsfn_blocking); + napi_status enq = napi_call_threadsafe_function(w->write_tsfn, sentinel, napi_tsfn_blocking); + if (enq != napi_ok) { + // See streaming_thread_fn: env tearing down, sentinel dropped, finalize + // here. No self-join, no env-affine napi call. + // + // Do NOT release write_tsfn: this worker is its sole producer + // (initial_thread_count = 1), so receiving napi_closing from this same + // Push call already decremented Node's internal thread_count for it to 0 + // and, if the tsfn's internal state was already kClosed, already ran + // `delete this` on it inside Push -- see streaming_thread_fn's comment + // for the full citation. Releasing it again here would be a + // double-discharge and potentially a use-after-free. + // + // Do NOT release read_tsfn either, even though this same worker is also + // its sole producer: whether *it* has already received napi_closing (and + // so already discharged/deleted itself the same way) depends on whether + // the script issued reads during teardown, which this code path has no + // way to know. We cannot prove read_tsfn's discharge state here, so -- + // consistent with the env == NULL dead-env handling elsewhere in this + // file -- we accept the small leak of an already-tearing-down tsfn + // rather than risk a use-after-free on an object whose state is unknown. + // + // End the bridge op with env_still_alive=false so bridge_finalize skips + // the thread-affine napi_delete_reference (Node auto-reclaims the ref + // when the dead env is destroyed). + if (sentinel->buf != OOM_JSON) free(sentinel->buf); + free(sentinel); + free(w->script); + free(w->inputs_json); + free(w->input_name); + free(w->input_mime_type); + free(w->input_charset); + bridge_end_op(w->bridge, /*env_still_alive=*/false); + free(w); + } } -static napi_value napi_run_script_transform(napi_env env, napi_callback_info info) { +static napi_value napi_run_script_transform_engine(napi_env env, napi_callback_info info) { if (!g_initialized) { napi_throw_error(env, NULL, "Not initialized. Call initialize() first."); return NULL; } - if (!fn_run_script_input_output_callback) { - napi_throw_error(env, NULL, "run_script_input_output_callback not available in native library"); + if (!fn_run_script_input_output_callback_engine) { + napi_throw_error(env, NULL, "run_script_input_output_callback_engine not available in native library"); return NULL; } - size_t argc = 7; - napi_value argv[7]; + size_t argc = 8; + napi_value argv[8]; napi_get_cb_info(env, info, &argc, argv, NULL, NULL); - if (argc < 7) { - napi_throw_error(env, NULL, "runScriptTransform requires 7 arguments"); + if (argc < 8) { + napi_throw_error(env, NULL, "runScriptTransformEngine requires 8 arguments"); + return NULL; + } + + // Validate the handle before admission (round-6 #1, defense-in-depth): a + // non-integer handle must be rejected before g_active_ops is ever reserved, + // so there is nothing to unwind here -- simpler than reserving first and + // unwinding on failure. Keep this consistent with + // napi_run_script_streaming_engine's ordering. + int64_t handle64; + if (napi_get_value_int64(env, argv[0], &handle64) != napi_ok) { + napi_throw_error(env, NULL, "runScriptTransformEngine: handle must be an integer"); + return NULL; + } + + // Atomic admission (see napi_run_script_streaming_engine for the full + // rationale, round-6 #2): check lifecycle + reserve g_active_ops in one + // critical section, before any work/tsfn/promise/bridge is committed. + // Admit an ADOPTED isolate: napi_initialize's adoption branch sets + // g_teardown_cancelled = true on a still-live PENDING_WAIT isolate but does + // not reset g_teardown_state (only the async waiter does), so a + // merely-cancelled teardown must not reject here -- otherwise a valid + // post-adoption op throws "Not initialized". A genuine (non-cancelled) + // PENDING_WAIT or a committed TEARING_DOWN still rejects. + uv_mutex_lock(&g_mutex); + if (!g_initialized || (g_teardown_state != TEARDOWN_NONE && !g_teardown_cancelled)) { + uv_mutex_unlock(&g_mutex); + napi_throw_error(env, NULL, "Not initialized. Call initialize() first."); return NULL; } + g_active_ops++; + // Round-11 (#2): pin the engine in the SAME critical section as the + // g_active_ops reservation, before any window a concurrent destroyEngine + // could use. NULL for an unknown handle (the worker surfaces "Unknown engine + // handle"). Stashed on w->bridge once w is allocated; every early-return + // below releases it via bridge_end_op alongside g_active_ops. + engine_bridge_t* pinned = bridge_begin_op_locked((long long)handle64); + uv_mutex_unlock(&g_mutex); + // Conversions run after the admission reservation above, so any throw here + // must free the partially-populated work struct AND release g_active_ops + // before returning (round-7 #2). calloc zeroed w, so free() on an unset + // field pointer is a safe free(NULL). TRANSFORM_FAIL centralizes the + // unwind. + // OOM safety (round-8): NULL-check the work struct before dereferencing it, + // releasing the g_active_ops reservation taken above. The per-field malloc + // checks below reuse TRANSFORM_FAIL (which frees all fields + w and unwinds); + // this standalone branch cannot use it (the macro dereferences w). struct transform_work* w = calloc(1, sizeof(struct transform_work)); + if (w == NULL) { + bridge_end_op(pinned, /*env_still_alive=*/true); + uv_mutex_lock(&g_mutex); g_active_ops--; uv_cond_broadcast(&g_teardown_cond); uv_mutex_unlock(&g_mutex); + napi_throw_error(env, NULL, "OOM"); + return NULL; + } size_t len; - - napi_get_value_string_utf8(env, argv[0], NULL, 0, &len); + w->handle = (long long)handle64; + + #define TRANSFORM_FAIL(msg) do { \ + bridge_end_op(pinned, /*env_still_alive=*/true); \ + free(w->script); free(w->inputs_json); free(w->input_name); \ + free(w->input_mime_type); free(w->input_charset); free(w); \ + uv_mutex_lock(&g_mutex); g_active_ops--; uv_cond_broadcast(&g_teardown_cond); uv_mutex_unlock(&g_mutex); \ + napi_throw_error(env, NULL, (msg)); \ + return NULL; \ + } while (0) + + if (napi_get_value_string_utf8(env, argv[1], NULL, 0, &len) != napi_ok) TRANSFORM_FAIL("runScriptTransformEngine: script must be a string"); w->script = malloc(len + 1); - napi_get_value_string_utf8(env, argv[0], w->script, len + 1, NULL); + if (w->script == NULL) TRANSFORM_FAIL("OOM"); + if (napi_get_value_string_utf8(env, argv[1], w->script, len + 1, NULL) != napi_ok) TRANSFORM_FAIL("runScriptTransformEngine: failed to read script"); - napi_get_value_string_utf8(env, argv[1], NULL, 0, &len); + if (napi_get_value_string_utf8(env, argv[2], NULL, 0, &len) != napi_ok) TRANSFORM_FAIL("runScriptTransformEngine: inputsJson must be a string"); w->inputs_json = malloc(len + 1); - napi_get_value_string_utf8(env, argv[1], w->inputs_json, len + 1, NULL); + if (w->inputs_json == NULL) TRANSFORM_FAIL("OOM"); + if (napi_get_value_string_utf8(env, argv[2], w->inputs_json, len + 1, NULL) != napi_ok) TRANSFORM_FAIL("runScriptTransformEngine: failed to read inputsJson"); - napi_get_value_string_utf8(env, argv[2], NULL, 0, &len); + if (napi_get_value_string_utf8(env, argv[3], NULL, 0, &len) != napi_ok) TRANSFORM_FAIL("runScriptTransformEngine: inputName must be a string"); w->input_name = malloc(len + 1); - napi_get_value_string_utf8(env, argv[2], w->input_name, len + 1, NULL); + if (w->input_name == NULL) TRANSFORM_FAIL("OOM"); + if (napi_get_value_string_utf8(env, argv[3], w->input_name, len + 1, NULL) != napi_ok) TRANSFORM_FAIL("runScriptTransformEngine: failed to read inputName"); - napi_get_value_string_utf8(env, argv[3], NULL, 0, &len); + if (napi_get_value_string_utf8(env, argv[4], NULL, 0, &len) != napi_ok) TRANSFORM_FAIL("runScriptTransformEngine: inputMimeType must be a string"); w->input_mime_type = malloc(len + 1); - napi_get_value_string_utf8(env, argv[3], w->input_mime_type, len + 1, NULL); + if (w->input_mime_type == NULL) TRANSFORM_FAIL("OOM"); + if (napi_get_value_string_utf8(env, argv[4], w->input_mime_type, len + 1, NULL) != napi_ok) TRANSFORM_FAIL("runScriptTransformEngine: failed to read inputMimeType"); napi_valuetype type; - napi_typeof(env, argv[4], &type); + if (napi_typeof(env, argv[5], &type) != napi_ok) TRANSFORM_FAIL("runScriptTransformEngine: invalid inputCharset argument"); if (type == napi_string) { - napi_get_value_string_utf8(env, argv[4], NULL, 0, &len); + if (napi_get_value_string_utf8(env, argv[5], NULL, 0, &len) != napi_ok) TRANSFORM_FAIL("runScriptTransformEngine: inputCharset must be a string"); w->input_charset = malloc(len + 1); - napi_get_value_string_utf8(env, argv[4], w->input_charset, len + 1, NULL); - } else { + if (w->input_charset == NULL) TRANSFORM_FAIL("OOM"); + if (napi_get_value_string_utf8(env, argv[5], w->input_charset, len + 1, NULL) != napi_ok) TRANSFORM_FAIL("runScriptTransformEngine: failed to read inputCharset"); + } else if (type == napi_null || type == napi_undefined) { + // inputCharset is nullable: null/undefined mean "no charset". This is the + // only non-string form the JS binding ever sends (dataweave.ts normalizes + // opts?.charset ?? null). w->input_charset = NULL; + } else { + // Any other type (object, number, boolean, ...) is a caller error, not + // "no charset". Fail closed like the four non-nullable string args above + // rather than silently coercing to NULL (review #9 #6). + TRANSFORM_FAIL("runScriptTransformEngine: inputCharset must be a string, null, or undefined"); } - + #undef TRANSFORM_FAIL + + // Round-9 (#3, updated round-11 #2): check each resource creation; on + // failure release the engine pin (`pinned`, taken at admission) via + // bridge_end_op, release g_active_ops (verbatim), release any tsfn already + // created, free w + all five string buffers, and throw. read_tsfn has no + // context (NULL); write_tsfn holds w as context, so release write_tsfn + // before freeing w if it was created. napi_value resource_name; - napi_create_string_utf8(env, "dwTransform", NAPI_AUTO_LENGTH, &resource_name); + if (napi_create_string_utf8(env, "dwTransform", NAPI_AUTO_LENGTH, &resource_name) != napi_ok) { + free(w->script); free(w->inputs_json); free(w->input_name); free(w->input_mime_type); free(w->input_charset); free(w); + bridge_end_op(pinned, /*env_still_alive=*/true); + uv_mutex_lock(&g_mutex); g_active_ops--; uv_cond_broadcast(&g_teardown_cond); uv_mutex_unlock(&g_mutex); + napi_throw_error(env, NULL, "runScriptTransformEngine: failed to create resource name"); + return NULL; + } - napi_create_threadsafe_function(env, argv[5], NULL, resource_name, 0, 1, NULL, NULL, NULL, call_js_read, &w->read_tsfn); - napi_create_threadsafe_function(env, argv[6], NULL, resource_name, 0, 1, NULL, NULL, w, call_js_transform_write, &w->write_tsfn); + if (napi_create_threadsafe_function(env, argv[6], NULL, resource_name, 0, 1, NULL, NULL, NULL, call_js_read, &w->read_tsfn) != napi_ok) { + free(w->script); free(w->inputs_json); free(w->input_name); free(w->input_mime_type); free(w->input_charset); free(w); + bridge_end_op(pinned, /*env_still_alive=*/true); + uv_mutex_lock(&g_mutex); g_active_ops--; uv_cond_broadcast(&g_teardown_cond); uv_mutex_unlock(&g_mutex); + napi_throw_error(env, NULL, "runScriptTransformEngine: failed to create read threadsafe function"); + return NULL; + } + if (napi_create_threadsafe_function(env, argv[7], NULL, resource_name, 0, 1, NULL, NULL, w, call_js_transform_write, &w->write_tsfn) != napi_ok) { + napi_release_threadsafe_function(w->read_tsfn, napi_tsfn_release); + free(w->script); free(w->inputs_json); free(w->input_name); free(w->input_mime_type); free(w->input_charset); free(w); + bridge_end_op(pinned, /*env_still_alive=*/true); + uv_mutex_lock(&g_mutex); g_active_ops--; uv_cond_broadcast(&g_teardown_cond); uv_mutex_unlock(&g_mutex); + napi_throw_error(env, NULL, "runScriptTransformEngine: failed to create write threadsafe function"); + return NULL; + } + + // review #10 (svacas P2): pre-allocate the completion sentinel HERE, in the + // synchronous setup path on the owner JS thread, before the worker is + // spawned -- so the worker's terminal completion path is allocation-free and + // can ALWAYS enqueue completion + release the tsfn. On NULL, unwind exactly + // like the promise-creation path below (release both tsfns; free w + all five + // string buffers; release the pin and g_active_ops) and throw synchronously. + // This mirrors napi_run_script_engine's "OOM" throw. + w->sentinel = malloc(sizeof(struct chunk_data)); + if (w->sentinel == NULL) { + napi_release_threadsafe_function(w->read_tsfn, napi_tsfn_release); + napi_release_threadsafe_function(w->write_tsfn, napi_tsfn_release); + free(w->script); free(w->inputs_json); free(w->input_name); free(w->input_mime_type); free(w->input_charset); free(w); + bridge_end_op(pinned, /*env_still_alive=*/true); + uv_mutex_lock(&g_mutex); g_active_ops--; uv_cond_broadcast(&g_teardown_cond); uv_mutex_unlock(&g_mutex); + napi_throw_error(env, NULL, "OOM"); + return NULL; + } napi_value promise; - napi_create_promise(env, &w->deferred, &promise); + if (napi_create_promise(env, &w->deferred, &promise) != napi_ok) { + napi_release_threadsafe_function(w->read_tsfn, napi_tsfn_release); + napi_release_threadsafe_function(w->write_tsfn, napi_tsfn_release); + free(w->sentinel); free(w->script); free(w->inputs_json); free(w->input_name); free(w->input_mime_type); free(w->input_charset); free(w); + bridge_end_op(pinned, /*env_still_alive=*/true); + uv_mutex_lock(&g_mutex); g_active_ops--; uv_cond_broadcast(&g_teardown_cond); uv_mutex_unlock(&g_mutex); + napi_throw_error(env, NULL, "runScriptTransformEngine: failed to create promise"); + return NULL; + } + + // Round-11 (#2): the pin was taken at admission (bridge_begin_op_locked) in + // the same critical section as g_active_ops, so a concurrent destroyEngine + // could never free this bridge under the admitted op. Just record it on w; + // the completion sentinel releases it via bridge_end_op. NULL for a + // resolver-less/unknown engine, handled everywhere as a no-op. + w->bridge = pinned; uv_thread_options_t opts; opts.flags = UV_THREAD_HAS_STACK_SIZE; opts.stack_size = 2 * 1024 * 1024; - uv_thread_create_ex(&w->tid, &opts, transform_thread_fn, w); + int spawn_rc = uv_thread_create_ex(&w->tid, &opts, transform_thread_fn, w); + + if (spawn_rc != 0) { + // The worker never ran, so nothing will ever decrement g_active_ops, + // release the bridge hold, or resolve the promise -- unwind everything + // committed above ourselves, in reverse order, mirroring + // call_js_transform_write's completion branch (minus uv_thread_join: + // there is no thread to join). + uv_mutex_lock(&g_mutex); + g_active_ops--; + uv_cond_broadcast(&g_teardown_cond); + uv_mutex_unlock(&g_mutex); + + // Synchronous call on the JS thread -- env is live here. + bridge_end_op(w->bridge, /*env_still_alive=*/true); + napi_release_threadsafe_function(w->read_tsfn, napi_tsfn_release); + napi_release_threadsafe_function(w->write_tsfn, napi_tsfn_release); + + napi_value result; + napi_create_string_utf8(env, "{\"success\":false,\"error\":\"Failed to spawn transform worker thread\"}", NAPI_AUTO_LENGTH, &result); + napi_resolve_deferred(env, w->deferred, result); + + free(w->sentinel); + free(w->script); + free(w->inputs_json); + free(w->input_name); + free(w->input_mime_type); + free(w->input_charset); + free(w); + } return promise; } @@ -724,35 +1955,36 @@ static napi_value napi_run_script_transform(napi_env env, napi_callback_info inf // --- Resolver callback bridge --- // Called by native code, synchronously, on the same JS thread that invoked -// runWithResolver (see the comment on g_resolver_env above for why this must -// NOT hop through napi_threadsafe_function). Calls the JS resolver directly -// and returns its result copied onto the heap; the caller (napi_run_with_resolver) -// frees it via g_resolver_last_result after the native side has copied it. -static char* resolve_module_callback(void* thread, const char* module_path) { +// runScriptEngine for a resolver-backed engine (see the comment on +// engine_bridge_t above for why this must NOT hop through +// napi_threadsafe_function). The ctx word is the engine's own engine_bridge_t*, +// passed to Java in create_engine_with_resolver and forwarded back here. Calls +// the JS resolver directly and returns its result copied onto the heap; the +// caller frees the tracked buffers after the native side has copied them. +static char* resolve_module_callback(void* thread, void* ctx, const char* module_path) { (void)thread; - if (g_resolver_env == NULL || g_resolver_ref == NULL) { - return NULL; // No resolver set + engine_bridge_t* bridge = (engine_bridge_t*)ctx; + if (bridge == NULL || bridge->env == NULL || bridge->resolver_js == NULL) { + return NULL; // No resolver for this engine } - // Guard against cross-thread napi calls. The engine that triggers this - // callback is a process-wide singleton shared by run()/runStreaming()/ - // runTransform(); streaming and transform execute their native call on a - // background uv_thread (streaming_thread_fn/transform_thread_fn), not the - // JS thread that registered g_resolver_env/g_resolver_ref. If we're not - // on the thread that owns this napi_env, calling napi_get_reference_value + // Guard against cross-thread napi calls. Streaming and transform execute + // their native call on a background uv_thread (streaming_thread_fn/ + // transform_thread_fn), not the JS thread that created this bridge. If we're + // not on the thread that owns this napi_env, calling napi_get_reference_value // or napi_call_function here is undefined behavior (typically a crash). // Fail closed instead: report "not found", which matches the documented // built-ins-only fallback for streaming/transform. uv_thread_t current = uv_thread_self(); - if (!uv_thread_equal(¤t, &g_resolver_thread)) { + if (!uv_thread_equal(¤t, &bridge->owner)) { return NULL; } - napi_env env = g_resolver_env; + napi_env env = bridge->env; napi_value js_callback; - if (napi_get_reference_value(env, g_resolver_ref, &js_callback) != napi_ok) { + if (napi_get_reference_value(env, bridge->resolver_js, &js_callback) != napi_ok) { return NULL; } @@ -849,136 +2081,533 @@ static char* resolve_module_callback(void* thread, const char* module_path) { } // null/undefined/other → not found (result_source stays NULL) - resolver_results_track(result_source); + if (!resolver_results_track(bridge, result_source)) { + // Tracking-node allocation failed (OOM): result_source would otherwise + // be an untracked buffer that nothing ever frees. Free it here and + // report "unresolved" instead of leaking it. + free(result_source); + return NULL; + } return result_source; // Native copies this immediately; we free the original after the call. } -// N-API method: runWithResolver -static napi_value napi_run_with_resolver(napi_env env, napi_callback_info info) { - if (!g_initialized) { +// --- Per-engine N-API methods --- + +// createEngine() -> number +static napi_value napi_create_engine(napi_env env, napi_callback_info info) { + (void)info; + if (!fn_create_engine) { napi_throw_error(env, NULL, "create_engine not available in native library"); return NULL; } + + // Round-14 (#1): admission in ONE g_mutex critical section (mirrors + // bridge_finalize_registry). Require (a) a live isolate not past the point + // of no return, (b) that THIS env owns an init reference (round-13 ownership + // model: an env with no reference must not create engines on the shared + // isolate -- it could otherwise attach to an isolate another env is tearing + // down), and (c) pin the isolate with a g_active_ops reservation so + // graal_tear_down_isolate() cannot run across the attach/create below. The + // check and the g_active_ops++ cannot be split by a teardown because every + // teardown transition and the g_active_ops==0 fast path also hold g_mutex. + uv_mutex_lock(&g_mutex); + env_init_rec_t* self = env_init_rec_find_locked(env); + if (!g_initialized || g_isolate == NULL || + g_teardown_state == TEARDOWN_TEARING_DOWN || + self == NULL || self->init_refs == 0) { + uv_mutex_unlock(&g_mutex); napi_throw_error(env, NULL, "Not initialized. Call initialize() first."); return NULL; } - if (!fn_run_script_with_resolver) { - napi_throw_error(env, NULL, "run_script_with_resolver not available in native library"); + g_active_ops++; // pins the live isolate against teardown across the attach + uv_mutex_unlock(&g_mutex); + + void* thread = NULL; + if (fn_attach_thread(g_isolate, &thread) != 0) { + uv_mutex_lock(&g_mutex); g_active_ops--; uv_cond_broadcast(&g_teardown_cond); uv_mutex_unlock(&g_mutex); + napi_throw_error(env, NULL, "Failed to attach thread"); return NULL; + } + long long handle = fn_create_engine(thread); + fn_detach_thread(thread); + // A GraalVM @CEntryPoint that throws on the Java side returns the return + // type's default value instead of propagating the exception — 0 for a + // long long. The real handle registry only ever hands out handles >= 1, so + // any handle <= 0 means construction failed; never hand that back to JS as + // if it were usable. + if (handle <= 0) { + uv_mutex_lock(&g_mutex); g_active_ops--; uv_cond_broadcast(&g_teardown_cond); uv_mutex_unlock(&g_mutex); + napi_throw_error(env, NULL, "create_engine returned an invalid handle"); return NULL; + } + + // Round-9 (#1): every engine -- resolver-backed or not -- gets a per-engine + // record so destroyEngine can defer the registry removal (fn_destroy_engine) + // until this engine's in-flight streaming/transform ops drain. A resolver-less + // record leaves resolver_js/results NULL. Round-11 (#1): it now ALSO registers + // an env cleanup hook (mirroring napi_create_engine_with_resolver), because + // without one a Worker that creates a resolver-less engine and exits without + // destroyEngine() would strand this record, the Java registry entry, and the + // native-lib reference. Round-12 (#2) closed the record/registry gap via + // bridge_finalize; round-13 (#5) moved ownership of the native-lib + // initialize() reference to the env itself (env_init_rec), released by the + // env-death hook env_init_cleanup, not per-engine. + // owner is recorded for symmetry but is NOT used to restrict destruction based + // on resolver state (see the owner guard in napi_destroy_engine, which now + // fires for any record). + engine_bridge_t* rec = (engine_bridge_t*)calloc(1, sizeof(engine_bridge_t)); + if (rec == NULL) { + // Roll back the engine we just created so we don't leak a registered but + // unrecorded handle. fn_destroy_engine attaches its own thread. + if (fn_destroy_engine) { + void* t2 = NULL; + if (fn_attach_thread(g_isolate, &t2) == 0) { fn_destroy_engine(t2, handle); fn_detach_thread(t2); } + } + uv_mutex_lock(&g_mutex); g_active_ops--; uv_cond_broadcast(&g_teardown_cond); uv_mutex_unlock(&g_mutex); + napi_throw_error(env, NULL, "Failed to allocate engine record"); + return NULL; + } + rec->handle = handle; + rec->owner = uv_thread_self(); + rec->env = env; + uv_mutex_lock(&g_mutex); rec->next = g_bridges; g_bridges = rec; uv_mutex_unlock(&g_mutex); + // Round-11 (#1): register an env cleanup hook for EVERY engine, not just + // resolver-backed ones. Without it, a Worker that creates a resolver-less + // engine and exits without destroyEngine() would strand this record, the Java + // ScriptRuntime registry entry, and the native-lib reference -- leaking + // engines and blocking isolate teardown across Worker churn. bridge_env_cleanup + // + bridge_finalize already handle a resolver-less record (resolver_js == NULL): + // skip the napi_ref delete, still unlink, remove the registry entry (round-10 + // do_registry_remove=true), and free. Round-13 (#5) moved ownership of the + // native-lib initialize() reference to the env itself (env_init_rec): this + // per-engine hook no longer touches g_ref_count -- the reference is released + // by the env-death hook env_init_cleanup (or by cleanup()), so an abandoned + // env releases exactly one reference regardless of how many engines it made. + // destroyEngine removes this hook before an early free so Node never invokes + // it on freed memory. + napi_status hook_st = napi_add_env_cleanup_hook(env, bridge_env_cleanup, rec); + if (hook_st == napi_ok) { + rec->hook_registered = true; + } else { + // Creation must be all-or-nothing (round-12 #6): without a cleanup hook a + // Worker that abandons this engine would strand the record and the Java + // registry entry. Unlink, remove the registry entry, free, and throw -- + // no usable handle escapes. The record was just linked on this thread + // with in_flight==0 and its handle was never returned to JS, so no op + // can be in flight against it. + // Do NOT release the init reference here (fix round 1): this throw + // propagates to initialize()'s TS catch (dataweave.ts), which sees + // libRefAcquired==true and calls ffi.cleanup() -- that is the ONE + // release for this creation's ref, matching every sibling + // creation-failure path (invalid-handle guard, alloc failure) that also + // leaves the release to the TS catch. Releasing natively here too would + // double-decrement g_ref_count -- masked in a single-instance process + // (the guard no-ops a second release at 0) but a live UAF hazard with a + // second engine instance still holding a reference. + uv_mutex_lock(&g_mutex); + engine_bridge_t** pp = &g_bridges; + while (*pp != NULL) { if (*pp == rec) { *pp = rec->next; break; } pp = &(*pp)->next; } + uv_mutex_unlock(&g_mutex); + // round-15 (svacas P1): go through bridge_finalize (do_registry_remove=true) + // so a destroy skipped on a transient attach failure retains the record for + // retry instead of freeing it while the Java registry still references it. + // may_rehook=false: this hook never registered (hook_registered stayed + // false), and creation is aborting all-or-nothing -- do not (re-)hook. + bridge_finalize(rec, /*env_still_alive=*/true, /*do_registry_remove=*/true, /*may_rehook=*/false); + uv_mutex_lock(&g_mutex); g_active_ops--; uv_cond_broadcast(&g_teardown_cond); uv_mutex_unlock(&g_mutex); + napi_throw_error(env, NULL, "Failed to register engine cleanup hook"); return NULL; } - size_t argc = 5; - napi_value args[5]; - napi_get_cb_info(env, info, &argc, args, NULL, NULL); + napi_value out; napi_create_int64(env, (int64_t)handle, &out); + uv_mutex_lock(&g_mutex); g_active_ops--; uv_cond_broadcast(&g_teardown_cond); uv_mutex_unlock(&g_mutex); + return out; +} - if (argc < 5) { - napi_throw_error(env, NULL, "Expected 5 arguments: script, inputs, mimeType, resolverCallback, isolate"); - return NULL; +// createEngineWithResolver(resolver) -> number +static napi_value napi_create_engine_with_resolver(napi_env env, napi_callback_info info) { + if (!fn_create_engine_with_resolver) { napi_throw_error(env, NULL, "create_engine_with_resolver not available in native library"); return NULL; } + size_t argc = 1; napi_value argv[1]; + napi_get_cb_info(env, info, &argc, argv, NULL, NULL); + if (argc < 1) { napi_throw_error(env, NULL, "createEngineWithResolver requires (resolverCallback)"); return NULL; } + + engine_bridge_t* bridge = (engine_bridge_t*)calloc(1, sizeof(engine_bridge_t)); + if (bridge == NULL) { napi_throw_error(env, NULL, "Failed to allocate engine bridge"); return NULL; } + if (napi_create_reference(env, argv[0], 1, &bridge->resolver_js) != napi_ok) { + free(bridge); napi_throw_error(env, NULL, "Failed to reference resolver callback"); return NULL; } + bridge->env = env; bridge->owner = uv_thread_self(); bridge->results = NULL; - // Extract script, inputs, mimeType - size_t script_len, inputs_len, mime_len; - napi_get_value_string_utf8(env, args[0], NULL, 0, &script_len); - napi_get_value_string_utf8(env, args[1], NULL, 0, &inputs_len); - napi_get_value_string_utf8(env, args[2], NULL, 0, &mime_len); + // Round-14 (#1): same admission block as napi_create_engine. Taken AFTER the + // bridge/resolver-ref allocation (those failures touch no isolate state and + // must not decrement a reservation not yet held) and BEFORE fn_attach_thread. + uv_mutex_lock(&g_mutex); + env_init_rec_t* self = env_init_rec_find_locked(env); + if (!g_initialized || g_isolate == NULL || + g_teardown_state == TEARDOWN_TEARING_DOWN || + self == NULL || self->init_refs == 0) { + uv_mutex_unlock(&g_mutex); + napi_delete_reference(env, bridge->resolver_js); free(bridge); + napi_throw_error(env, NULL, "Not initialized. Call initialize() first."); + return NULL; + } + g_active_ops++; // pins the live isolate against teardown across the attach + uv_mutex_unlock(&g_mutex); - char* script = (char*)malloc(script_len + 1); - char* inputs = (char*)malloc(inputs_len + 1); - char* mime_type = (char*)malloc(mime_len + 1); + void* thread = NULL; + if (fn_attach_thread(g_isolate, &thread) != 0) { + uv_mutex_lock(&g_mutex); g_active_ops--; uv_cond_broadcast(&g_teardown_cond); uv_mutex_unlock(&g_mutex); + napi_delete_reference(env, bridge->resolver_js); free(bridge); + napi_throw_error(env, NULL, "Failed to attach thread"); return NULL; + } + long long handle = fn_create_engine_with_resolver(thread, resolve_module_callback, (void*)bridge); + fn_detach_thread(thread); - if (script == NULL || inputs == NULL || mime_type == NULL) { - free(script); - free(inputs); - free(mime_type); - napi_throw_error(env, NULL, "Failed to allocate memory for arguments"); + // Same invalid-handle guard as napi_create_engine: a Java-side construction + // failure surfaces here as handle == 0 (GraalVM @CEntryPoint default-value + // semantics), and any handle <= 0 is never valid. Reject before this bridge + // is linked into g_bridges or a cleanup hook is registered for it — at this + // point neither has happened, so there's nothing to unlink/unhook. Still use + // bridge_finalize (not a manual napi_delete_reference+free) because the failed + // construction may have called resolve_module_callback (e.g. during eager + // module setup) before ultimately failing, which can have already populated + // bridge->results via resolver_results_track; bridge_finalize frees those + // tracked buffers too, so nothing is dropped on the floor. + if (handle <= 0) { + uv_mutex_lock(&g_mutex); g_active_ops--; uv_cond_broadcast(&g_teardown_cond); uv_mutex_unlock(&g_mutex); + // Synchronous call on the JS thread -- env is live here. may_rehook=false: + // no hook was ever registered for this bridge and creation is aborting; with + // do_registry_remove=false there is nothing registered to strand on anyway. + bridge_finalize(bridge, /*env_still_alive=*/true, /*do_registry_remove=*/false, /*may_rehook=*/false); + napi_throw_error(env, NULL, "create_engine_with_resolver returned an invalid handle"); return NULL; } - napi_get_value_string_utf8(env, args[0], script, script_len + 1, NULL); - napi_get_value_string_utf8(env, args[1], inputs, inputs_len + 1, NULL); - napi_get_value_string_utf8(env, args[2], mime_type, mime_len + 1, NULL); + bridge->handle = handle; + uv_mutex_lock(&g_mutex); bridge->next = g_bridges; g_bridges = bridge; uv_mutex_unlock(&g_mutex); + // Register a per-env cleanup hook so THIS Worker/main thread disposes this + // bridge's napi_ref on its own thread when its env tears down (F2). napi_cleanup + // no longer touches bridge refs. destroyEngine removes this hook before an + // early free so Node never calls it on freed memory. + napi_status hook_st = napi_add_env_cleanup_hook(env, bridge_env_cleanup, bridge); + if (hook_st == napi_ok) { + bridge->hook_registered = true; + } else { + // Creation must be all-or-nothing (round-12 #6): without a cleanup hook a + // Worker that abandons this engine would strand the record and the Java + // registry entry. Unlink, remove the registry entry, free, and throw -- + // no usable handle escapes. The record was just linked on this thread + // with in_flight==0 and its handle was never returned to JS, so no op + // can be in flight against it. + // Do NOT release the init reference here (fix round 1): this throw + // propagates to initialize()'s TS catch (dataweave.ts), which sees + // libRefAcquired==true and calls ffi.cleanup() -- that is the ONE + // release for this creation's ref, matching every sibling + // creation-failure path (resolver invalid-handle guard uses + // bridge_finalize with do_registry_remove=false and also does NOT + // release) that also leaves the release to the TS catch. Releasing + // natively here too would double-decrement g_ref_count -- masked in a + // single-instance process (the guard no-ops a second release at 0) but + // a live UAF hazard with a second engine instance still holding a + // reference. + uv_mutex_lock(&g_mutex); + engine_bridge_t** pp = &g_bridges; + while (*pp != NULL) { if (*pp == bridge) { *pp = bridge->next; break; } pp = &(*pp)->next; } + uv_mutex_unlock(&g_mutex); + // round-15 (svacas P1): go through bridge_finalize (do_registry_remove=true) + // so a destroy skipped on a transient attach failure retains the bridge for + // retry instead of freeing it while the Java registry still references it. + // may_rehook=false: this hook never registered (hook_registered stayed + // false), and creation is aborting all-or-nothing -- do not (re-)hook. + bridge_finalize(bridge, /*env_still_alive=*/true, /*do_registry_remove=*/true, /*may_rehook=*/false); + uv_mutex_lock(&g_mutex); g_active_ops--; uv_cond_broadcast(&g_teardown_cond); uv_mutex_unlock(&g_mutex); + napi_throw_error(env, NULL, "Failed to register engine cleanup hook"); + return NULL; + } + napi_value out; napi_create_int64(env, (int64_t)handle, &out); + uv_mutex_lock(&g_mutex); g_active_ops--; uv_cond_broadcast(&g_teardown_cond); uv_mutex_unlock(&g_mutex); + return out; +} - // Resolver is installed once per process lifetime. Subsequent calls with - // different resolver callbacks will reuse the first resolver, as enforced by - // ScriptRuntime.setResolver() on the native side (one resolver per engine). - // - // No thread-hop machinery is needed: fn_run_script_with_resolver() below - // runs on this very thread, so resolve_module_callback() (invoked from - // inside that call) can call directly back into JS via the stored - // napi_ref. See the comment on g_resolver_env for why napi_threadsafe_function - // must NOT be used here. +// destroyEngine(handle) -> void +static napi_value napi_destroy_engine(napi_env env, napi_callback_info info) { + if (!g_initialized) return NULL; + size_t argc = 1; napi_value argv[1]; + napi_get_cb_info(env, info, &argc, argv, NULL, NULL); + if (argc < 1) { napi_throw_error(env, NULL, "destroyEngine requires (handle)"); return NULL; } + int64_t handle64; + if (napi_get_value_int64(env, argv[0], &handle64) != napi_ok) { + napi_throw_error(env, NULL, "destroyEngine: handle must be an integer"); + return NULL; + } + long long handle = (long long)handle64; + + // F2: a resolver-backed engine's bridge owns thread-affine N-API state -- + // a napi_ref and an env cleanup hook, both created on the engine's owning + // JS thread. Deleting that ref (bridge_finalize) or removing that hook + // (napi_remove_env_cleanup_hook) from another Worker's thread is undefined + // behavior. Reject cross-thread destruction, mirroring the fail-closed + // owner check in resolve_module_callback; the owner env's cleanup hook + // disposes the bridge when that Worker tears down. We are on the owner + // thread past this point, so the env cannot be concurrently tearing down + // and the bridge stays stable between this check and the unlink below. + // Owner-thread guard: round-11 (#1) registers an env cleanup hook for EVERY + // engine (resolver-backed or not), so every record now carries env-affine + // N-API state -- napi_remove_env_cleanup_hook (called below before an early + // free) can only be invoked legally on the owner thread. The guard + // therefore fires for any record (owned != NULL), not just resolver-backed + // ones. bridge_finalize's napi_ref deletion stays resolver-gated + // (resolver_js != NULL && env != NULL) -- that part is unchanged. uv_mutex_lock(&g_mutex); - if (g_resolver_ref == NULL) { - napi_status status = napi_create_reference(env, args[3], 1, &g_resolver_ref); - if (status != napi_ok) { + engine_bridge_t* owned = bridge_find(handle); + if (owned != NULL) { + uv_thread_t self = uv_thread_self(); + if (!uv_thread_equal(&self, &owned->owner)) { uv_mutex_unlock(&g_mutex); - free(script); - free(inputs); - free(mime_type); - napi_throw_error(env, NULL, "Failed to reference resolver callback"); + napi_throw_error(env, NULL, + "destroyEngine must be called from the thread that created the engine"); return NULL; } - g_resolver_env = env; - g_resolver_thread = uv_thread_self(); } - // Note: subsequent calls reuse the first resolver for this process lifetime. + + // Round-9 (#1): unlink the record and decide, under the lock, whether the + // registry removal (fn_destroy_engine) and the record free must be DEFERRED. + // If an op is in flight, its worker may not yet have called + // ScriptRuntime.get(handle) (the first statement of the Java entrypoint) -- + // removing the registry entry now would make that lookup fail with + // "Unknown engine handle". So defer BOTH the registry removal and the free + // to the last op draining (bridge_end_op -> bridge_finalize with + // do_registry_remove=true), which runs on this same owner thread. When no op + // is in flight, remove the registry entry and finalize immediately, as + // before. Every engine now has a record, so `found` is non-NULL for both + // resolver-backed and resolver-less engines. + engine_bridge_t** pp = &g_bridges; engine_bridge_t* found = NULL; + while (*pp != NULL) { if ((*pp)->handle == handle) { found = *pp; *pp = found->next; break; } pp = &(*pp)->next; } + bool defer = false; + // deferred_registry_remove gates the deferred registry removal in + // bridge_end_op; set it together with destroy_pending here. + if (found != NULL && found->in_flight > 0) { found->destroy_pending = true; found->deferred_registry_remove = true; defer = true; } uv_mutex_unlock(&g_mutex); - // Need to attach thread for this call - void* thread = NULL; - int rc = fn_attach_thread(g_isolate, &thread); - if (rc != 0) { - free(script); - free(inputs); - free(mime_type); - napi_throw_error(env, NULL, "Failed to attach thread"); - return NULL; + if (found != NULL) { + if (!defer) { + // Not in flight: remove the registry entry AND finalize now, on this + // owner thread (env live). do_registry_remove=true folds the + // fn_destroy_engine call into bridge_finalize so it happens exactly + // once regardless of path. may_rehook=true: we are on the owner thread + // with the env alive, so a live-isolate strand keeps the hook (owner + // env finalizes resolver_js later) rather than enqueuing on the drain. + // Do NOT pre-remove the hook here (review #12 #3, #13): bridge_finalize + // owns it -- its FREE path removes it before freeing (so Node never + // invokes it on freed memory), and its STRAND path KEEPS it so the owner + // env deletes resolver_js at teardown instead of the off-thread drain + // (which skips napi_delete_reference and would leak the ref). + bridge_finalize(found, /*env_still_alive=*/true, /*do_registry_remove=*/true, /*may_rehook=*/true); + } else { + // In flight -> DEFER the finalize to the draining op's bridge_end_op. + // Remove the env cleanup hook NOW (round-1 fix to reviews #12 #3/#13): + // this is legal here (owner thread, env alive) and makes bridge_end_op + // the SOLE finalizer after this destroy. Leaving the hook registered + // reopens a double-owner window: destroy_pending only keeps + // bridge_env_cleanup and bridge_end_op mutually exclusive for ABANDONED + // (never-destroyed) engines, because bridge_env_cleanup's in_flight==0 + // branch finalizes WITHOUT checking destroy_pending. So if the env is + // torn down while this op is still in flight (e.g. worker.terminate()), + // the op's bridge_end_op(env_still_alive=false) frees the bridge on its + // FREE path (which skips the hook-remove -- gated on env_still_alive), + // and the later env-cleanup-hook fire would run bridge_env_cleanup on + // freed memory -> UAF / double-free / double fn_destroy_engine. + // bridge_end_op re-registers the hook (may_rehook=env_still_alive) only + // if its later finalize STRANDS on the owner thread with the env alive, + // keeping resolver_js deletion on the owner thread -> the leak fix holds. + napi_remove_env_cleanup_hook(env, bridge_env_cleanup, found); + found->hook_registered = false; + } + } else { + // No record found (should not happen now that every engine has one, but + // stay robust to a double-destroy or an unknown handle): fall back to + // removing the Java registry entry directly. That removal requires + // attaching to the live isolate, so guard the attach EXACTLY like + // bridge_finalize_registry (review #10 #5): read g_isolate/g_teardown_state + // under g_mutex and, if the isolate is live, pin it with a TRANSIENT + // g_active_ops reservation so graal_tear_down_isolate() cannot run across + // the attach (the state check + the g_active_ops++ are one critical + // section). If the isolate is already gone (g_isolate == NULL) or the + // waiter has committed to physical teardown (TEARDOWN_TEARING_DOWN), the + // Java registry died/dies with the isolate -- there is nothing to remove + // and attaching would race the teardown, so return early / no-op safely. + // Without this guard an unknown-handle (or double-)destroyEngine racing a + // concurrent cleanup() teardown could call fn_attach_thread on a NULL or + // being-torn-down isolate. The unlocked g_initialized check at the top of + // this function is a stale read under concurrency and does NOT close this + // window; only the g_mutex-guarded read here does. + if (fn_destroy_engine && fn_attach_thread) { + uv_mutex_lock(&g_mutex); + if (g_teardown_state == TEARDOWN_TEARING_DOWN || g_isolate == NULL) { + uv_mutex_unlock(&g_mutex); // isolate gone/tearing down -> nothing to remove + } else { + g_active_ops++; // pins the live isolate against teardown for this attach + uv_mutex_unlock(&g_mutex); + void* thread = NULL; + if (fn_attach_thread(g_isolate, &thread) == 0 && thread != NULL) { + fn_destroy_engine(thread, handle); + fn_detach_thread(thread); + } + // Verbatim g_active_ops release pattern. + uv_mutex_lock(&g_mutex); + g_active_ops--; + uv_cond_broadcast(&g_teardown_cond); + uv_mutex_unlock(&g_mutex); + } + } } + return NULL; +} - // Call native with resolver callback. mime_type is accepted from JS for API - // symmetry but is not part of the native run_script_with_resolver signature - // (see run_script_with_resolver_fn typedef comment) — do not forward it. - char* result = fn_run_script_with_resolver( - thread, - script, - inputs, - resolve_module_callback - ); - - // Native has copied every resolver result returned during this call; free - // our copies now that it's done. - resolver_results_free_all(); - - // result (if non-NULL) is a GraalVM UnmanagedMemory.malloc'd buffer, like - // every other native result pointer in this file; it must be released via - // fn_free_cstring(), not libc free(), and while the isolate thread is - // still attached. Copy it to a libc-owned buffer first so we can build - // the JS string after detaching, matching the strdup + fn_free_cstring - // pattern used by run_script_thread_fn/streaming_thread_fn/transform_thread_fn. - char* result_copy = result ? strdup(result) : NULL; - if (result != NULL) { - fn_free_cstring(thread, result); +// runScriptEngine(handle, script, inputsJson) -> string +static napi_value napi_run_script_engine(napi_env env, napi_callback_info info) { + if (!g_initialized) { napi_throw_error(env, NULL, "Not initialized. Call initialize() first."); return NULL; } + if (!fn_run_script_engine) { napi_throw_error(env, NULL, "run_script_engine not available in native library"); return NULL; } + size_t argc = 3; napi_value argv[3]; + napi_get_cb_info(env, info, &argc, argv, NULL, NULL); + if (argc < 3) { napi_throw_error(env, NULL, "runScriptEngine requires (handle, script, inputsJson)"); return NULL; } + int64_t handle64; + if (napi_get_value_int64(env, argv[0], &handle64) != napi_ok) { + napi_throw_error(env, NULL, "runScriptEngine: handle must be an integer"); + return NULL; } + long long handle = (long long)handle64; - fn_detach_thread(thread); + size_t script_len, inputs_len; + if (napi_get_value_string_utf8(env, argv[1], NULL, 0, &script_len) != napi_ok) { + napi_throw_error(env, NULL, "runScriptEngine: script must be a string"); + return NULL; + } + if (napi_get_value_string_utf8(env, argv[2], NULL, 0, &inputs_len) != napi_ok) { + napi_throw_error(env, NULL, "runScriptEngine: inputsJson must be a string"); + return NULL; + } + char* script = (char*)malloc(script_len + 1); + char* inputs = (char*)malloc(inputs_len + 1); + if (script == NULL || inputs == NULL) { free(script); free(inputs); napi_throw_error(env, NULL, "OOM"); return NULL; } + if (napi_get_value_string_utf8(env, argv[1], script, script_len + 1, NULL) != napi_ok || + napi_get_value_string_utf8(env, argv[2], inputs, inputs_len + 1, NULL) != napi_ok) { + free(script); free(inputs); + napi_throw_error(env, NULL, "runScriptEngine: failed to read script/inputsJson"); + return NULL; + } - free(script); - free(inputs); - free(mime_type); + // Round-7 #1: reserve an active op across the isolate-touching window + // (attach -> run -> detach) so a concurrent Worker's last cleanup() + // (napi_cleanup Case 4) cannot observe g_active_ops == 0 and tear down + // g_isolate while this synchronous op is attaching to or executing in it. + // Reserve LATE (here, not at the top): the malloc/arg-extraction above do + // not touch the isolate, so the reservation only needs to span attach.. + // detach -- giving exactly two unwind sites (attach-failure and normal + // completion) instead of also unwinding the OOM path. Rejecting on + // g_teardown_state != TEARDOWN_NONE also refuses to start once a teardown + // is queued/underway. run() is fully synchronous on the JS thread, so the + // reserve and release both happen inline (no worker thread). Admit an + // ADOPTED isolate: napi_initialize's adoption branch sets + // g_teardown_cancelled = true on a still-live PENDING_WAIT isolate but + // does not reset g_teardown_state (only the async waiter does), so a + // merely-cancelled teardown must not reject here -- otherwise a valid + // post-adoption op throws "Not initialized". A genuine (non-cancelled) + // PENDING_WAIT or a committed TEARING_DOWN still rejects. + uv_mutex_lock(&g_mutex); + if (!g_initialized || (g_teardown_state != TEARDOWN_NONE && !g_teardown_cancelled)) { + uv_mutex_unlock(&g_mutex); + free(script); free(inputs); + napi_throw_error(env, NULL, "Not initialized. Call initialize() first."); + return NULL; + } + g_active_ops++; + // Round-11 (#3): pin the engine in the same critical section as the + // g_active_ops reservation so a concurrent destroyEngine cannot free the + // resolver bridge (still held by Java as the resolver ctx) while this + // synchronous op attaches to Graal or runs. NULL for a resolver-less/unknown + // handle -- bridge_end_op no-ops on NULL. Released in the attach-failure and + // completion paths below, alongside g_active_ops. + engine_bridge_t* bridge = bridge_begin_op_locked(handle); + uv_mutex_unlock(&g_mutex); - if (result_copy == NULL) { - napi_throw_error(env, NULL, "Script execution failed"); - return NULL; + void* thread = NULL; + if (fn_attach_thread(g_isolate, &thread) != 0) { + bridge_end_op(bridge, /*env_still_alive=*/true); + uv_mutex_lock(&g_mutex); g_active_ops--; uv_cond_broadcast(&g_teardown_cond); uv_mutex_unlock(&g_mutex); + free(script); free(inputs); + napi_throw_error(env, NULL, "Failed to attach thread"); + return NULL; } - napi_value result_str; - napi_create_string_utf8(env, result_copy, NAPI_AUTO_LENGTH, &result_str); - free(result_copy); + char* result = (char*)fn_run_script_engine(thread, handle, script, inputs); - return result_str; + // The pin taken at admission kept this record alive across the run, so no + // second lookup is needed. resolver_results_free_all is a no-op for a + // resolver-less/unknown engine (bridge == NULL). + if (bridge != NULL) resolver_results_free_all(bridge); + + char* result_copy = result ? strdup(result) : NULL; + if (result != NULL) fn_free_cstring(thread, result); + fn_detach_thread(thread); + free(script); free(inputs); + + // Round-11 (#3): release the per-engine pin (may finalize a destroy that a + // concurrent Worker deferred while this op held in_flight > 0), then release + // the global op reservation. env is live on this JS thread, so env_still_alive + // is true. Order: bridge_end_op before the g_active_ops release, mirroring + // streaming/transform completion. + bridge_end_op(bridge, /*env_still_alive=*/true); + uv_mutex_lock(&g_mutex); g_active_ops--; uv_cond_broadcast(&g_teardown_cond); uv_mutex_unlock(&g_mutex); + + // Round-15 (svacas P1): op-completion drain point -- retry destroy for any + // bridge stranded on a transient attach failure (Graal-only + free, no napi + // env call). This is the synchronous raw-FFI path whose resolve_module_callback + // is the UAF the retain fix protects. + drain_stranded_bridges(); + + napi_value out; + if (result_copy) { napi_create_string_utf8(env, result_copy, NAPI_AUTO_LENGTH, &out); free(result_copy); } + else { napi_create_string_utf8(env, "", 0, &out); } + return out; } // --- Cleanup (must run on a separate thread to avoid V8 signal handler conflict) --- +// Called on each waiter's own env/thread (via its own napi_threadsafe_function) +// once the waiter thread has finished isolate teardown. Resolves that specific +// caller's promise, then releases its tsfn and frees the node. `data` is +// unused (NULL) -- there is nothing to report beyond "done". +// +// napi_call_threadsafe_function(..., napi_tsfn_blocking) only ENQUEUES this +// callback for the target env's event loop to run later; it does not wait for +// it to actually execute. So the waiter node and its tsfn must stay alive +// until this callback runs and must be released/freed HERE, not by the +// thread that enqueued the call (teardown_waiter_thread_fn) -- freeing there +// right after the enqueueing call would be a use-after-free once this +// callback later dereferences `context`. Same ownership pattern as +// call_js_write/call_js_transform_write freeing their own work struct from +// inside their own completion branch. +static void call_js_teardown_done(napi_env env, napi_value js_callback, void* context, void* data) { + (void)js_callback; + (void)data; + teardown_waiter_t* waiter = (teardown_waiter_t*)context; + if (waiter == NULL) return; + + if (env != NULL) { + napi_value undefined; + napi_get_undefined(env, &undefined); + napi_resolve_deferred(env, waiter->deferred, undefined); + } + + napi_release_threadsafe_function(waiter->tsfn, napi_tsfn_release); + free(waiter); +} + +// `arg` is an int* out-param: the caller (napi_cleanup's case 4) must set it +// to 0 before spawning this thread and read it after uv_thread_join returns. +// Mirrors teardown_waiter_thread_fn's `torn_down` local exactly, so the +// caller can tell "isolate torn down / nothing to tear down" (safe to clear +// g_thread/g_isolate/g_initialized/g_ref_count) apart from "attach failed, +// isolate still alive" (must leave those globals set, or the isolate becomes +// unreachable and can never be torn down). static void cleanup_thread_fn(void* arg) { - (void)arg; + int* out_torn_down = (int*)arg; // graal_tear_down_isolate() must be passed the IsolateThread belonging to the // *calling* OS thread. g_thread was created by graal_create_isolate() on the // (now-exited, already-joined) init thread, so it is invalid here — passing it @@ -986,49 +2615,594 @@ static void cleanup_thread_fn(void* arg) { // StackOverflowError during teardown. Attach this cleanup thread to the isolate // to obtain a valid local IsolateThread, then tear down with that. if (!fn_tear_down_isolate || !fn_attach_thread || !g_isolate) { + // Nothing to tear down (no isolate / FFI unavailable) -- safe to clear. + *out_torn_down = 1; return; } void* local_thread = NULL; if (fn_attach_thread(g_isolate, &local_thread) != 0 || local_thread == NULL) { + // Attach failed -- the isolate is still alive. Leave *out_torn_down at 0 + // (its caller-initialized value) so the caller does NOT clear g_isolate, + // or it becomes unreachable and can never be torn down. return; } - fn_tear_down_isolate(local_thread); + // Check the teardown return code (0 == success). On nonzero the isolate is + // still live: leave *out_torn_down at 0 so the caller retains + // g_isolate/g_initialized/g_ref_count and (per its own logic) arms the retry, + // rather than orphaning a live isolate (review #6 #3). On that failure the + // isolate was NOT destroyed, so this thread is still attached to it -- detach + // before the helper thread exits, or the live isolate keeps a phantom + // attached thread that can make a later retry teardown block or fail (review + // #7 #1). On success the isolate is gone: do NOT detach (would be a UAF). + if (fn_tear_down_isolate(local_thread) == 0) { + *out_torn_down = 1; + } else { + fn_detach_thread(local_thread); + *out_torn_down = 0; + } } -static napi_value napi_cleanup(napi_env env, napi_callback_info info) { +// Spawned only when napi_cleanup finds g_active_ops > 0 on the last release +// (case 5 in the design doc). Blocks until every active streaming/transform +// op has drained, performs isolate teardown exactly like cleanup_thread_fn +// does on the unchanged fast path, then resolves every caller who is waiting +// on this same teardown (there may be more than one -- see g_teardown_waiters). +static void teardown_waiter_thread_fn(void* arg) { + (void)arg; + uv_mutex_lock(&g_mutex); - if (g_initialized) { - g_ref_count--; - if (g_ref_count <= 0) { - // Clean up resolver reference - if (g_resolver_ref != NULL && g_resolver_env != NULL) { - napi_delete_reference(g_resolver_env, g_resolver_ref); + while (g_active_ops > 0 && !g_teardown_cancelled) { + uv_cond_wait(&g_teardown_cond, &g_mutex); + } + bool cancelled = g_teardown_cancelled; + if (!cancelled) { + // Point of no return: from here an adopting initialize() must NOT reuse the + // isolate, so publish TEARING_DOWN under the lock before we drop it to call + // graal_tear_down_isolate(). + g_teardown_state = TEARDOWN_TEARING_DOWN; + } + uv_mutex_unlock(&g_mutex); + + // Perform teardown exactly as the unchanged fast path does: attach a local + // thread to the isolate (g_thread from graal_create_isolate's bootstrap + // thread is invalid here -- see cleanup_thread_fn's comment), then tear + // down. Honor the return code (0 == success); a nonzero teardown leaves the + // isolate live (review #6 #3). Skipped entirely + // when an initialize() call adopted the live isolate instead (see + // napi_initialize's TEARDOWN_PENDING_WAIT branch). + bool torn_down = false; + if (!cancelled && fn_tear_down_isolate && fn_attach_thread && g_isolate) { + void* local_thread = NULL; + if (fn_attach_thread(g_isolate, &local_thread) == 0 && local_thread != NULL) { + // Check the teardown return code (0 == success). On nonzero the isolate is + // still live -- leave torn_down false so the post-teardown block below + // retains the isolate globals and arms the retry (review #6 #3). On that + // failure the isolate was NOT destroyed, so this thread is still attached + // to it -- detach before exiting or the live isolate keeps a phantom + // attached thread that can block/fail a later retry teardown (review #7 + // #1). On success the isolate is gone: do NOT detach (would be a UAF). + if (fn_tear_down_isolate(local_thread) == 0) { + torn_down = true; + } else { + fn_detach_thread(local_thread); + torn_down = false; } - g_resolver_ref = NULL; - g_resolver_env = NULL; - resolver_results_free_all(); - - uv_thread_t tid; - uv_thread_options_t opts; - opts.flags = UV_THREAD_HAS_STACK_SIZE; - opts.stack_size = 2 * 1024 * 1024; - uv_thread_create_ex(&tid, &opts, cleanup_thread_fn, NULL); + } + // else: attach failed -- the isolate is still alive. Do NOT clear g_isolate, + // or it becomes unreachable and can never be torn down. + } else if (!cancelled) { + // Nothing to tear down (no isolate / FFI unavailable) -- safe to clear. + torn_down = true; + } + // if (cancelled): leave torn_down = false -- the isolate stays live for the + // adopter; we tear nothing down. + + uv_mutex_lock(&g_mutex); + if (!cancelled && torn_down) { + g_thread = NULL; + g_isolate = NULL; + g_initialized = 0; + g_ref_count = 0; + } else if (!cancelled && g_isolate != NULL && g_ref_count == 0) { + // Teardown did not happen (attach failed, or graal_tear_down_isolate + // returned nonzero -- review #6 #3) and this async-waiter path IS the last + // release: g_ref_count is already 0 with no owner and no pending waiter. + // Arm the retry signal so a later op-completion drain or a fresh + // initialize() retries teardown -- otherwise the live isolate is stranded + // with nothing to reclaim it (review #6 #4). Mirrors the twin arm in + // isolate_ref_release_n_locked's waiter-spawn-failure path. + g_teardown_needed = true; + // Observable failure (review #10 #5): the deferred cleanup() promise is still + // RESOLVED below (via call_js_teardown_done -- deliberate, exactly as the + // synchronous Case 4 path resolves on failure), so emit a diagnostic or a + // failed async teardown would be silent. Parity with Python's _release_isolate + // stderr notice (native.py). + fprintf(stderr, + "[DataWeave Node addon] GraalVM isolate teardown failed on deferred " + "cleanup(); the isolate is retained and teardown will be retried on the " + "next initialize() or op completion.\n"); + } + // If cancelled: g_isolate/g_initialized/g_ref_count are left exactly as the + // adopting initialize() set them (it already did g_ref_count++ on the live + // isolate). + g_teardown_state = TEARDOWN_NONE; + g_teardown_cancelled = false; + // Release any initialize() call blocked waiting for teardown to finish + // (see Task 3). + uv_cond_broadcast(&g_teardown_cond); + teardown_waiter_t* waiters = g_teardown_waiters; + g_teardown_waiters = NULL; + uv_mutex_unlock(&g_mutex); + + // Resolve every waiting caller's promise on its own env/thread via its own + // tsfn -- napi_deferred/napi_env are thread-affine, so this cannot be done + // from this waiter thread directly. napi_call_threadsafe_function only + // ENQUEUES the call for the target thread to run later; it does not wait + // for call_js_teardown_done to execute. So do NOT free/release here -- + // call_js_teardown_done owns and releases each node after it actually runs + // (freeing it here instead would be a use-after-free the moment the + // enqueued callback later dereferences it). + while (waiters != NULL) { + teardown_waiter_t* next = waiters->next; + napi_status enq = napi_call_threadsafe_function(waiters->tsfn, waiters, napi_tsfn_blocking); + if (enq != napi_ok) { + // The waiter's env is tearing down (napi_closing): call_js_teardown_done + // will never run, so it can neither resolve waiter->deferred nor release + // the tsfn nor free the node. Free the node here instead of leaking it + // (one leak per Worker that terminated while this teardown was pending). + // Do NOT napi_release_threadsafe_function(waiters->tsfn, ...): a + // napi_closing return already discharges this tsfn's registration (Node + // may have destroyed the tsfn object), so a release would be a + // double-discharge/UAF -- same reasoning as the sentinel-enqueue-failure + // paths in streaming_thread_fn/transform_thread_fn. The unresolved + // deferred is env-affine and reclaimed when the dead env is destroyed. + free(waiters); + } + waiters = next; + } +} + +// Creates a promise, a threadsafe function bound to call_js_teardown_done for +// THIS call's env, and a teardown_waiter_t node carrying both. The node is +// NOT linked into g_teardown_waiters here -- the caller does that under +// g_mutex, since callers append at two different points in napi_cleanup +// (case 3: joining an existing pending teardown; case 5: starting a new one). +// Returns NULL (and throws) if node allocation fails. +static teardown_waiter_t* teardown_waiter_create(napi_env env, napi_value* out_promise) { + teardown_waiter_t* waiter = (teardown_waiter_t*)calloc(1, sizeof(teardown_waiter_t)); + if (waiter == NULL) { + napi_throw_error(env, NULL, "Failed to allocate teardown waiter"); + return NULL; + } + waiter->env = env; + + if (napi_create_promise(env, &waiter->deferred, out_promise) != napi_ok) { + free(waiter); + napi_throw_error(env, NULL, "Failed to create teardown promise"); + return NULL; + } + + napi_value resource_name; + if (napi_create_string_utf8(env, "dwTeardown", NAPI_AUTO_LENGTH, &resource_name) != napi_ok) { + free(waiter); + napi_throw_error(env, NULL, "Failed to create teardown resource name"); + return NULL; + } + + if (napi_create_threadsafe_function( + env, NULL, NULL, resource_name, 0, 1, NULL, NULL, waiter, call_js_teardown_done, &waiter->tsfn + ) != napi_ok) { + free(waiter); + napi_throw_error(env, NULL, "Failed to create teardown threadsafe function"); + return NULL; + } + + return waiter; +} + +// Creates an already-resolved promise -- used by napi_cleanup's two +// "nothing to wait for" branches (not-the-last-release, and last-release +// with no active ops) so the function's return type is uniformly "a +// promise" regardless of which branch runs. +static napi_value already_resolved_promise(napi_env env) { + napi_deferred deferred; + napi_value promise; + napi_create_promise(env, &deferred, &promise); + napi_value undefined; + napi_get_undefined(env, &undefined); + napi_resolve_deferred(env, deferred, undefined); + return promise; +} + +// Release n (>=0) initialization references at once, then make the teardown +// decision AT MOST ONCE. Caller holds g_mutex and this KEEPS it held. n==0 is a +// no-op. Equivalent to n serial single-releases for the COUNT, but guarantees +// the reached-zero teardown/waiter logic runs exactly once (a serial loop would +// re-enter the decision on an already-zero count). Used by env_init_cleanup +// (round-13 #5) to release all of a dead env's references from one decision +// point. (Previously also used by a single-release wrapper, +// isolate_ref_release_core_locked, retired in round-13 #5 once the per-engine +// finalize path stopped releasing init references directly.) +// Round-14 (#2/#3): retry a teardown that a prior last-release could not carry +// out. Caller holds g_mutex and this KEEPS it held. No-op unless a stranded +// live isolate is waiting (g_teardown_needed) with no owners and no teardown in +// progress and ops drained. Makes the reached-zero teardown decision at most +// once per call (same synchronous cleanup_thread_fn path as Case 4); on repeated +// failure it leaves g_teardown_needed set to retry on the next drain. Spawns+joins +// cleanup_thread_fn while holding g_mutex, exactly as the Case-4 / +// isolate_ref_release_n_locked g_active_ops==0 branch does; cleanup_thread_fn +// takes no lock and makes no napi call, so this is deadlock-free and thread-safe +// from any drain site. +static void retry_stranded_teardown_locked(void) { + if (!g_teardown_needed) return; + if (g_ref_count > 0) { g_teardown_needed = false; return; } // adopted -> keep + if (g_teardown_state != TEARDOWN_NONE) return; // a teardown drives + if (g_active_ops > 0) return; // wait for drain + if (g_isolate == NULL) { g_teardown_needed = false; return; } // nothing to do + uv_thread_t tid; + uv_thread_options_t opts; + opts.flags = UV_THREAD_HAS_STACK_SIZE; + opts.stack_size = 2 * 1024 * 1024; + int torn_down = 0; + int spawn_rc = uv_thread_create_ex(&tid, &opts, cleanup_thread_fn, &torn_down); + if (spawn_rc == 0) uv_thread_join(&tid); + if (torn_down) { + g_thread = NULL; + g_isolate = NULL; + g_initialized = 0; + g_ref_count = 0; + g_teardown_needed = false; + } + // else: spawn/attach failed again -- leave g_teardown_needed set so the next + // drain (or a later initialize() adoption) retries. +} + +static void isolate_ref_release_n_locked(int n) { + if (n <= 0) return; + if (g_ref_count >= n) g_ref_count -= n; else g_ref_count = 0; + if (g_ref_count > 0) return; // other envs still hold references + if (g_teardown_state != TEARDOWN_NONE) return; // a teardown already drives + + if (g_active_ops == 0) { + uv_thread_t tid; + uv_thread_options_t opts; + opts.flags = UV_THREAD_HAS_STACK_SIZE; + opts.stack_size = 2 * 1024 * 1024; + int torn_down = 0; + int spawn_rc = uv_thread_create_ex(&tid, &opts, cleanup_thread_fn, &torn_down); + if (spawn_rc == 0) { uv_thread_join(&tid); + } + if (torn_down) { + g_thread = NULL; + g_isolate = NULL; + g_initialized = 0; + g_ref_count = 0; + } else if (g_isolate != NULL && g_ref_count == 0) { + // Sync teardown failed (spawn or cleanup_thread_fn attach) with the isolate + // still live and no owners: arm the retry signal (round-14 #3). g_active_ops + // is already 0 here, but a later op could still re-pin; the flag is cleared + // on adoption and retried on drain or by the next initialize() (review #6 + // #5). Documented residual: if NO later op or initialize() ever occurs, the + // isolate lingers until process exit, where the OS reclaims it -- benign + // (single process-lifetime isolate, no ref-count violation). + g_teardown_needed = true; + } + return; + } + + // g_active_ops > 0: defer to the waiter thread, no promises attached. + g_teardown_state = TEARDOWN_PENDING_WAIT; + g_teardown_cancelled = false; + g_teardown_waiters = NULL; // no JS caller waiting + uv_thread_t waiter_tid; + uv_thread_options_t waiter_opts; + waiter_opts.flags = UV_THREAD_HAS_STACK_SIZE; + waiter_opts.stack_size = 2 * 1024 * 1024; + int spawn_rc = uv_thread_create_ex(&waiter_tid, &waiter_opts, teardown_waiter_thread_fn, NULL); + if (spawn_rc != 0) { + // Best-effort degradation: the waiter thread never started, so nothing will + // drain the isolate. Restore g_ref_count to the true remaining ownership + // (Σ init_refs, = 0 here) to keep the invariant, and ARM the retry signal so + // the next op-completion drain retries teardown -- otherwise this live + // isolate has zero owners and nothing would ever tear it down (round-14 #3). + g_teardown_state = TEARDOWN_NONE; + g_ref_count = env_init_refs_total_locked(); + if (g_isolate != NULL && g_ref_count == 0) g_teardown_needed = true; + } +} + +// Env-death hook for a per-env init record (round-13 #5). Registered once per +// env by initialize()'s first acquire (env_init_acquire_and_hook). Node runs +// env-cleanup hooks LIFO. In the normal initialize()-then-createEngine() order +// this hook is registered BEFORE any engine's bridge_env_cleanup for the same +// env, so it runs AFTER every engine bridge has finalized on a live isolate. +// The pathological raw-ffi order (createEngine() on this env -- succeeding +// because another env already initialized -- THEN initialize() here) can +// register this hook after an engine hook, so it may run first; that is still +// safe, because bridge_finalize_registry re-checks teardown state under g_mutex +// (registry removal no-ops on a torn-down isolate) and the napi_ref delete runs +// with env_still_alive=true on this env's own live thread. Releases exactly the +// references this env still holds (n), from a single env-scoped decision point: +// because g_ref_count == sum of init_refs, releasing this env's n reaches zero +// ONLY if no other env holds a reference, so an abandoned env can never tear the +// isolate down under a live env. Runs on the dying env's own thread with the +// env alive; does only g_mutex-guarded integer/list work + free (no env-affine +// napi calls). +// Round-14 (#1): the create path now enforces per-env ownership (an env with +// init_refs == 0 is rejected), so the pathological order below -- createEngine() +// on this env BEFORE its own initialize() -- is now rejected at the create call +// rather than relying on the finalize-time teardown-state re-check. +static void env_init_cleanup(void* arg) { + env_init_rec_t* rec = (env_init_rec_t*)arg; + if (rec == NULL) return; + uv_mutex_lock(&g_mutex); + // Unlink from g_env_recs if still present. + env_init_rec_t** pp = &g_env_recs; + while (*pp != NULL) { + if (*pp == rec) { *pp = rec->next; break; } + pp = &(*pp)->next; + } + int n = rec->init_refs; + rec->init_refs = 0; + free(rec); + // Release all n references and make the teardown decision at most once. + isolate_ref_release_n_locked(n); + uv_mutex_unlock(&g_mutex); +} +// Promise-less core of an isolate-reference release. Caller holds g_mutex and +// this function KEEPS it held (does not unlock). Decrements g_ref_count and, on +// the last release, drives teardown WITHOUT binding any napi promise/waiter: +// - g_active_ops == 0 -> synchronous cleanup_thread_fn (same as Case 4). +// - g_active_ops > 0 -> spawn the waiter thread with an EMPTY waiter list +// (TEARDOWN_PENDING_WAIT); it tears down (or is adopted) +// with no promises to resolve. +// - a teardown already pending (TEARDOWN_NONE != state) -> nothing to do; the +// existing waiter will tear down; this release just +// drops the count. +// Used by env_init_cleanup (round-13 #5), the env-death hook, which has no +// live JS caller to hand a promise to. +// +// Deliberately does NOT call (or get called by) release_isolate_ref_locked +// below: that promise-bearing sibling needs per-caller promise plumbing this +// core omits on purpose (binding a waiter/promise to a tearing-down env is a +// thread-affinity hazard). They share the last-release *policy* only; see +// release_isolate_ref_locked's header comment for the promise-bearing twin. +// +// The isolate reference is now owned per env (env_init_rec), not per engine +// bridge (round-13 #5): initialize()'s acquire sites and env_init_cleanup are +// the only callers that mutate g_ref_count via this function, alongside +// release_isolate_ref_locked below for the explicit cleanup() path. The +// per-engine finalize path (bridge_env_cleanup / bridge_end_op) no longer +// touches g_ref_count at all, so a raw multi-engine-per-initialize() caller's +// abandoned env fires exactly one release for the whole balance it holds, +// regardless of how many engines it created. + +// Releases ONE initialization reference on the shared isolate. Caller MUST +// hold g_mutex; this function UNLOCKS g_mutex before returning (the sync and +// waiter teardown paths both require dropping the lock). Returns the napi +// promise to hand back to the JS caller. This is napi_cleanup's original +// Case 1..5 body. +static napi_value release_isolate_ref_locked(napi_env env) { + // Case 1/2: not the last release (or nothing was ever initialized). Decrement + // only if positive -- a second cleanup() call while g_ref_count is already at + // 0 (e.g. one already dropped it while teardown is pending) must not go + // negative. + // Round-13 (#5): an env may release only a reference IT owns. If this env has + // no outstanding init reference (a cleanup() with no matching initialize() on + // this env, or a double-cleanup()), do NOT touch g_ref_count -- releasing here + // would steal another env's reference and could tear the isolate down under a + // live user. No-op: resolve immediately. (g_ref_count == sum of init_refs, so + // this env's zero balance means it contributes nothing to release.) + env_init_rec_t* self = env_init_rec_find_locked(env); + if (self == NULL || self->init_refs == 0) { + uv_mutex_unlock(&g_mutex); + return already_resolved_promise(env); + } + self->init_refs--; + if (g_ref_count > 0) { + g_ref_count--; + } + if (g_ref_count > 0) { + uv_mutex_unlock(&g_mutex); + return already_resolved_promise(env); + } + + // Case 3: a teardown from an earlier cleanup() call is already pending + // (possibly triggered from a different Worker/env). Join its waiter list + // instead of spawning a second waiter thread. + if (g_teardown_state != TEARDOWN_NONE) { + napi_value promise; + teardown_waiter_t* waiter = teardown_waiter_create(env, &promise); + if (waiter == NULL) { + uv_mutex_unlock(&g_mutex); + return NULL; // teardown_waiter_create already threw + } + waiter->next = g_teardown_waiters; + g_teardown_waiters = waiter; + uv_mutex_unlock(&g_mutex); + return promise; + } + + // Case 4: last release, no teardown pending, and nothing active -- the + // original, unchanged synchronous fast path. + if (g_active_ops == 0) { + uv_thread_t tid; + uv_thread_options_t opts; + opts.flags = UV_THREAD_HAS_STACK_SIZE; + opts.stack_size = 2 * 1024 * 1024; + // torn_down is cleanup_thread_fn's out-param (mirrors teardown_waiter_thread_fn's + // `torn_down` local exactly): must be initialized to 0 before the thread runs so + // the attach-failure early-return path (which never touches it) leaves it false. + // uv_thread_join is synchronous, so when spawn_rc == 0 this stack variable safely + // outlives the thread's write to it. + int torn_down = 0; + int spawn_rc = uv_thread_create_ex(&tid, &opts, cleanup_thread_fn, &torn_down); + if (spawn_rc == 0) { + uv_thread_join(&tid); + } + // Only clear global state if the isolate was actually torn down (or there + // was nothing to tear down). If spawn failed, the thread never ran and + // torn_down stays 0 -- leave the globals set rather than orphaning a live + // isolate (unreachable via these globals, could never be torn down), which + // is a strict improvement over unconditionally clearing them here. Same + // reasoning for cleanup_thread_fn's internal attach-failure path: the + // isolate is still alive, g_initialized stays 1, and g_ref_count was + // already decremented to 0 above without being reset here, so a later + // initialize() correctly ref-counts the surviving isolate instead of + // building a second one (identical semantics to teardown_waiter_thread_fn's + // attach-failure path). + if (torn_down) { g_thread = NULL; g_isolate = NULL; g_initialized = 0; g_ref_count = 0; + } else if (g_isolate != NULL && g_ref_count == 0) { + // cleanup_thread_fn spawn/attach failed: the isolate is still live with + // zero owners. Arm the retry signal so a later op-completion drain or the + // next initialize() (review #6 #5) tears it down instead of stranding it — + // mirrors the twin arm in isolate_ref_release_n_locked. Documented residual: + // if no later op or initialize() ever runs, the isolate lingers to process + // exit (OS reclaims it) -- benign, no ref-count violation. + g_teardown_needed = true; + // Make the failure OBSERVABLE (review #10 #5): the promise below still + // RESOLVES (see the deliberate-resolve note), so without a diagnostic a + // failed final teardown would be entirely silent. Mirrors the stderr notice + // Python emits in _release_isolate on the same failure (native.py). + fprintf(stderr, + "[DataWeave Node addon] GraalVM isolate teardown failed on cleanup(); " + "the isolate is retained and teardown will be retried on the next " + "initialize() or op completion.\n"); } + // Deliberate design (review #10 #5): cleanup() RESOLVES even when the final + // Graal teardown failed above -- it does NOT reject. Teardown failure is a + // recoverable, retryable condition (the isolate is retained and + // g_teardown_needed is armed for a later retry), not a caller error, and this + // file never uses napi_reject_deferred: run/streaming/transform failures also + // surface as RESOLVED values. Rejecting here would break the isolate + // adoption/coalescing contract (a still-live PENDING_WAIT isolate a concurrent + // initialize() may adopt) and the existing cleanup() tests. The failure stays + // observable via the armed retry + the stderr diagnostic above. Parity: + // Python's _release_isolate arms _teardown_needed and logs to stderr on the + // same failure rather than surfacing a hard error (native.py). + uv_mutex_unlock(&g_mutex); + return already_resolved_promise(env); + } + + // Case 5: last release, but streaming/transform ops are still active. + // Defer teardown to a dedicated waiter thread instead of blocking this JS + // thread -- this is the deadlock fix. g_initialized/g_isolate/g_thread stay + // set until the waiter thread finishes, matching today's behavior of + // treating "still tearing down" as "still initialized" for concurrent + // initialize() calls (see Task 3). + g_teardown_state = TEARDOWN_PENDING_WAIT; + g_teardown_cancelled = false; + napi_value promise; + teardown_waiter_t* waiter = teardown_waiter_create(env, &promise); + if (waiter == NULL) { + // The last reference was already dropped (g_ref_count == 0) but we cannot + // build the waiter to drain the isolate. Arm the retry signal so the op + // drain retries teardown -- without it this live isolate would have zero + // owners and nothing to tear it down (round-14 #2). + g_teardown_state = TEARDOWN_NONE; + if (g_isolate != NULL && g_ref_count == 0) g_teardown_needed = true; + uv_mutex_unlock(&g_mutex); + return NULL; // teardown_waiter_create already threw + } + waiter->next = NULL; + g_teardown_waiters = waiter; + + uv_thread_t waiter_tid; + uv_thread_options_t waiter_opts; + waiter_opts.flags = UV_THREAD_HAS_STACK_SIZE; + waiter_opts.stack_size = 2 * 1024 * 1024; + int spawn_rc = uv_thread_create_ex(&waiter_tid, &waiter_opts, teardown_waiter_thread_fn, NULL); + // Deliberately not joined -- this thread finishes on its own and resolves + // every waiter's promise itself; joining here would reintroduce exactly + // the blocking-JS-thread problem this fix removes. + + if (spawn_rc != 0) { + // Best-effort degradation: if the waiter thread never starts, nothing + // will ever clear g_teardown_state, which would otherwise permanently + // wedge every future initialize()/cleanup() call. Roll back to "teardown + // did not start" -- the isolate stays up and the caller's promise still + // resolves, mirroring the fast path's ignore-teardown-return-code posture. + g_teardown_state = TEARDOWN_NONE; + g_teardown_waiters = NULL; + + napi_value undefined; + napi_get_undefined(env, &undefined); + napi_resolve_deferred(env, waiter->deferred, undefined); + + napi_release_threadsafe_function(waiter->tsfn, napi_tsfn_release); + free(waiter); + + // Best-effort degradation: the isolate stays live (g_initialized/g_isolate + // untouched) but no waiter will drain it. Restore g_ref_count to the true + // remaining ownership (Σ init_refs) rather than a hardcoded 1: this env just + // decremented its own init_refs above, and reaching Case 5 means g_ref_count + // hit 0, so the sum is 0 (or whatever surviving envs still own). Hardcoding 1 + // here would strand a reference no env owns -- unreleasable by any cleanup() + // or env-death hook -- and would break the invariant g_ref_count == Σ + // init_refs. A later initialize() will re-acquire on the surviving isolate. + g_ref_count = env_init_refs_total_locked(); + // Arm the retry signal: the isolate stays live with no owners and no waiter, + // so the op-completion drain must retry teardown (round-14 #2). + if (g_isolate != NULL && g_ref_count == 0) g_teardown_needed = true; + + uv_mutex_unlock(&g_mutex); + return promise; } + uv_mutex_unlock(&g_mutex); - return NULL; + return promise; +} + +static napi_value napi_cleanup(napi_env env, napi_callback_info info) { + (void)info; + uv_mutex_lock(&g_mutex); + return release_isolate_ref_locked(env); // unlocks g_mutex, returns the promise } // --- Module init --- static void init_g_mutex(void) { uv_mutex_init(&g_mutex); + uv_cond_init(&g_teardown_cond); +} + +// --- Test-only N-API entrypoints (review #12 #3 / #13) --- +// Registered only when DATAWEAVE_TEST_HOOKS is set (see Init). They let the Node +// strand regression test arm a single forced live-isolate strand and inspect the +// resulting bookkeeping. None of these touch thread-affine napi state beyond +// creating a plain return value on the calling env, so they are callable from any +// JS thread (main or Worker) that loaded this addon. +static napi_value napi_test_force_strand_once(napi_env env, napi_callback_info info) { + (void)info; + uv_mutex_lock(&g_mutex); + g_test_force_strand_once = true; + uv_mutex_unlock(&g_mutex); + return NULL; +} + +static napi_value napi_test_stranded_count(napi_env env, napi_callback_info info) { + (void)info; + long long n = 0; + uv_mutex_lock(&g_mutex); + for (engine_bridge_t* b = g_stranded_bridges; b != NULL; b = b->next) n++; + uv_mutex_unlock(&g_mutex); + napi_value out; napi_create_int64(env, (int64_t)n, &out); + return out; +} + +static napi_value napi_test_resolver_ref_delete_count(napi_env env, napi_callback_info info) { + (void)info; + uv_mutex_lock(&g_mutex); + long long n = g_test_resolver_ref_deletes; + uv_mutex_unlock(&g_mutex); + napi_value out; napi_create_int64(env, (int64_t)n, &out); + return out; } static napi_value Init(napi_env env, napi_value exports) { @@ -1039,21 +3213,42 @@ static napi_value Init(napi_env env, napi_value exports) { napi_create_function(env, "initialize", NAPI_AUTO_LENGTH, napi_initialize, NULL, &fn); napi_set_named_property(env, exports, "initialize", fn); - napi_create_function(env, "runScript", NAPI_AUTO_LENGTH, dw_napi_run_script, NULL, &fn); - napi_set_named_property(env, exports, "runScript", fn); + napi_create_function(env, "createEngine", NAPI_AUTO_LENGTH, napi_create_engine, NULL, &fn); + napi_set_named_property(env, exports, "createEngine", fn); + + napi_create_function(env, "createEngineWithResolver", NAPI_AUTO_LENGTH, napi_create_engine_with_resolver, NULL, &fn); + napi_set_named_property(env, exports, "createEngineWithResolver", fn); - napi_create_function(env, "runScriptStreaming", NAPI_AUTO_LENGTH, napi_run_script_streaming, NULL, &fn); - napi_set_named_property(env, exports, "runScriptStreaming", fn); + napi_create_function(env, "destroyEngine", NAPI_AUTO_LENGTH, napi_destroy_engine, NULL, &fn); + napi_set_named_property(env, exports, "destroyEngine", fn); - napi_create_function(env, "runScriptTransform", NAPI_AUTO_LENGTH, napi_run_script_transform, NULL, &fn); - napi_set_named_property(env, exports, "runScriptTransform", fn); + napi_create_function(env, "runScriptEngine", NAPI_AUTO_LENGTH, napi_run_script_engine, NULL, &fn); + napi_set_named_property(env, exports, "runScriptEngine", fn); - napi_create_function(env, "runWithResolver", NAPI_AUTO_LENGTH, napi_run_with_resolver, NULL, &fn); - napi_set_named_property(env, exports, "runWithResolver", fn); + napi_create_function(env, "runScriptStreamingEngine", NAPI_AUTO_LENGTH, napi_run_script_streaming_engine, NULL, &fn); + napi_set_named_property(env, exports, "runScriptStreamingEngine", fn); + + napi_create_function(env, "runScriptTransformEngine", NAPI_AUTO_LENGTH, napi_run_script_transform_engine, NULL, &fn); + napi_set_named_property(env, exports, "runScriptTransformEngine", fn); napi_create_function(env, "cleanup", NAPI_AUTO_LENGTH, napi_cleanup, NULL, &fn); napi_set_named_property(env, exports, "cleanup", fn); + // Test-only entrypoints, registered only when the process opts in via + // DATAWEAVE_TEST_HOOKS (non-empty). getenv() is safe here: Init runs once per + // env on the main JS thread at module load, before any engine/finalize can run, + // so this write-once flag is visible to every later reader without a barrier. + const char* test_hooks = getenv("DATAWEAVE_TEST_HOOKS"); + if (test_hooks != NULL && test_hooks[0] != '\0') { + g_test_hooks = true; + napi_create_function(env, "__test_forceStrandOnce", NAPI_AUTO_LENGTH, napi_test_force_strand_once, NULL, &fn); + napi_set_named_property(env, exports, "__test_forceStrandOnce", fn); + napi_create_function(env, "__test_strandedCount", NAPI_AUTO_LENGTH, napi_test_stranded_count, NULL, &fn); + napi_set_named_property(env, exports, "__test_strandedCount", fn); + napi_create_function(env, "__test_resolverRefDeleteCount", NAPI_AUTO_LENGTH, napi_test_resolver_ref_delete_count, NULL, &fn); + napi_set_named_property(env, exports, "__test_resolverRefDeleteCount", fn); + } + return exports; } diff --git a/native-lib/node/src/dataweave.ts b/native-lib/node/src/dataweave.ts index dbaa63a3..db23d99d 100644 --- a/native-lib/node/src/dataweave.ts +++ b/native-lib/node/src/dataweave.ts @@ -23,23 +23,10 @@ export interface DataWeaveOptions { * * MUST be synchronous (cannot return Promise). * - * Note: the native layer installs at most one resolver per process - * lifetime, bound on the first resolver-backed {@link DataWeave.run} call - * (not on {@link DataWeave.initialize}, which only loads/ref-counts the - * native library) and to the thread (main thread or `worker_threads` - * Worker) that made that first call. If you construct multiple `DataWeave` - * instances with different `resolveModule` callbacks in the same process, - * whichever instance's `run()` executes first wins; later instances - * silently reuse that resolver instead of their own. If a later instance's - * `run()` executes on a *different* thread, its resolver is not invoked at - * all and custom module paths resolve as "not found" (see - * docs/external-modules.md#multiple-resolvers-in-one-process). - * - * Concurrency warning: calling a resolver-backed `run()` concurrently from - * more than one Worker is not just unsupported — it is memory-unsafe (see - * docs/external-modules.md, Worker threads section). Restrict - * resolver-backed execution to a single thread, or serialize calls across - * Workers. + * Each DataWeave instance owns an independent native engine, so multiple + * instances with different resolvers coexist in one process with no + * cross-talk. Streaming/transform still resolve only built-in modules for a + * resolver-backed engine (custom modules fail closed); see external-modules.md. * * Security: the resolver runs with full process permissions and no * sandboxing (same trust model as the CLI resolving `.dwl` files from @@ -61,7 +48,9 @@ export interface DataWeaveOptions { export class DataWeave { private readonly libPath: string; private readonly resolveModule?: ModuleResolver; - private initialized = false; + private state: "uninitialized" | "ready" | "cleaning-up" = "uninitialized"; + private engineHandle: number | null = null; + private cleanupPromise: Promise | null = null; /** * @param options - Configuration options or a legacy libPath string. @@ -83,25 +72,138 @@ export class DataWeave { * initialized. * * @throws DataWeaveError if the native library fails to load or initialize. + * @throws DataWeaveError if called while a `cleanup()` is still in progress + * — await the cleanup first. */ initialize(): void { - if (this.initialized) return; + if (this.state === "ready") return; + if (this.state === "cleaning-up") { + throw new DataWeaveError( + "Cannot initialize while cleanup is in progress; await cleanup() first." + ); + } + let libRefAcquired = false; try { ffi.initialize(this.libPath); + libRefAcquired = true; + this.engineHandle = this.resolveModule + ? ffi.createEngineWithResolver(this.resolveModule) + : ffi.createEngine(); } catch (e: unknown) { + // If ffi.initialize() already succeeded but engine creation then threw, we + // already hold an increment of the native library's ref-counted handle and + // must release it (ffi.cleanup()), or it leaks for the process lifetime. + // ffi.cleanup() is async, so model the rollback as PENDING state instead of + // firing-and-forgetting it (review #7 #3): (1) an un-awaited rejection must + // not become an unhandledRejection, and (2) a concurrent initialize()/run() + // must not race a fresh graal_create_isolate against the in-flight release. + // Reuse the same cleanupPromise/"cleaning-up" machinery cleanup() uses: + // hold state "cleaning-up" until the release settles (so initialize()'s own + // "cleaning-up" guard rejects a concurrent retry deterministically, and a + // concurrent cleanup() coalesces onto this same promise), then return to + // "uninitialized". The synchronous throw to THIS caller is preserved. + this.engineHandle = null; + if (libRefAcquired) { + this.state = "cleaning-up"; + // ffi.cleanup() can fail synchronously (throw) as well as asynchronously + // (reject a returned promise). Calling it inside a try/catch -- rather + // than eagerly as the argument to Promise.resolve(ffi.cleanup()) -- lets + // a synchronous throw be caught and normalized into a rejected promise + // BEFORE cleanupPromise is assigned, so it still flows through the same + // .finally() state reset instead of escaping here and stranding this + // instance in "cleaning-up" forever (review #8 #2). Existing callers + // still observe ffi.cleanup() invoked synchronously, in the same tick as + // this catch block, exactly as before this fix. + let releaseResult: Promise | void; + try { + releaseResult = ffi.cleanup(); + } catch (cleanupError) { + releaseResult = Promise.reject(cleanupError); + } + this.cleanupPromise = Promise.resolve(releaseResult).finally(() => { + this.state = "uninitialized"; + this.cleanupPromise = null; + }); + // Never let an un-awaited rollback surface as an unhandledRejection. A + // caller that awaits cleanup() (which coalesces onto cleanupPromise) + // still observes the rejection; this handler only covers the un-awaited + // path. + this.cleanupPromise.catch(() => {}); + } throw new DataWeaveError(`Failed to initialize: ${e instanceof Error ? e.message : e}`); } - this.initialized = true; + this.state = "ready"; } /** * Releases the native runtime. Idempotent — a no-op if not initialized. After * cleanup the instance can be re-initialized via {@link DataWeave.initialize}. + * + * Resolution depends on whether this call releases the FINAL shared native + * reference in the process. When it does, it resolves once the underlying + * native isolate has actually finished tearing down; if a streaming/transform + * operation on this or any other instance is still in flight at that point, + * native teardown waits for it to drain before resolving — awaiting this + * rather than firing-and-forgetting avoids racing a subsequent + * {@link initialize} against an isolate that is still tearing down. When other + * initialized instances remain, it resolves as soon as this instance's engine + * is released, leaving the shared isolate live for them. */ - cleanup(): void { - if (!this.initialized) return; - ffi.cleanup(); - this.initialized = false; + async cleanup(): Promise { + // Coalesce first: doCleanup() flips `state` to "cleaning-up" synchronously + // as its first statement, so by the time a second overlapping call runs, + // `state` has already left "ready". If the not-ready guard below ran + // first, that second caller would resolve immediately instead of + // awaiting the first caller's in-flight native teardown -- contradicting + // this method's contract of resolving only once the isolate has actually + // finished tearing down (round-6 review, task-1 fix round 1). Checking + // `cleanupPromise` first ensures every concurrent caller that overlaps + // with an in-flight doCleanup() awaits that SAME promise, so the native + // teardown (ffi.destroyEngine/ffi.cleanup) still happens exactly once. + if (this.cleanupPromise) return this.cleanupPromise; + // Not coalescing with an in-flight cleanup: nothing to do unless we're + // "ready" (covers both never-initialized and already-settled cleanup). + if (this.state !== "ready") return; + this.cleanupPromise = this.doCleanup(); + try { + await this.cleanupPromise; + } finally { + // Clear on both fulfilment and rejection so a later cleanup() (after a + // re-initialize, or a retry of a rejected cleanup) can run again. + this.cleanupPromise = null; + } + } + + private async doCleanup(): Promise { + // Transition BEFORE releasing the engine so run()/initialize() called + // during the async teardown window are rejected deterministically rather + // than seeing a stale "ready" state with a null engineHandle (round-6 #1/#3). + this.state = "cleaning-up"; + let destroyError: unknown; + try { + if (this.engineHandle !== null) { + try { + ffi.destroyEngine(this.engineHandle); + } catch (e) { + // Round-14 (#6): a throwing destroyEngine() (e.g. wrong-thread + // destruction) must NOT skip ffi.cleanup() -- that would strand this + // env's native init reference and block isolate teardown. Capture the + // primary error, clear the handle so a retry does not double-destroy, + // and fall through to release the reference below. + destroyError = e; + } finally { + this.engineHandle = null; + } + } + await ffi.cleanup(); + } finally { + this.state = "uninitialized"; + } + // Surface the primary destruction error after the reference was released. If + // ffi.cleanup() itself rejected, its error already propagated from the await + // (the more actionable reference-release failure wins; the destroy error is + // then suppressed). + if (destroyError !== undefined) throw destroyError; } /** @@ -116,17 +218,10 @@ export class DataWeave { * @throws DataWeaveScriptError if the script fails and `opts.raiseOnError` is set. */ run(script: string, inputs?: Inputs, opts?: { raiseOnError?: boolean }): ExecutionResult { - this.ensureInitialized(); + this.ensureReady(); const inputsJson = buildInputsJson(inputs ?? {}); - let raw: string; - if (this.resolveModule) { - // Use resolver-aware entrypoint - raw = ffi.runWithResolver(script, inputsJson, "application/json", this.resolveModule); - } else { - // Use standard entrypoint (backward compatible) - raw = ffi.runScript(script, inputsJson); - } + const raw = ffi.runScriptEngine(this.engineHandle!, script, inputsJson); const result = parseNativeResponse(raw); @@ -148,9 +243,11 @@ export class DataWeave { * @throws DataWeaveError if the runtime is not initialized. */ async *runStreaming(script: string, inputs?: Inputs): AsyncGenerator { - this.ensureInitialized(); + this.ensureReady(); const inputsJson = buildInputsJson(inputs ?? {}); - return yield* streamFromNative((chunkCb) => ffi.runScriptStreaming(script, inputsJson, chunkCb)); + return yield* streamFromNative((chunkCb) => + ffi.runScriptStreamingEngine(this.engineHandle!, script, inputsJson, chunkCb) + ); } /** @@ -174,7 +271,7 @@ export class DataWeave { input: AsyncIterable | Iterable, opts?: TransformOptions ): AsyncGenerator { - this.ensureInitialized(); + this.ensureReady(); const inputName = opts?.inputName ?? "payload"; const inputMimeType = opts?.mimeType ?? "application/json"; @@ -184,30 +281,132 @@ export class DataWeave { const readCb = await createChunkReader(input); + // The instance may have been cleaned up while an async input pre-buffered + // (createChunkReader can await arbitrarily long). Re-check readiness so a + // caller that raced cleanup() gets a synchronous DataWeaveError rather than + // a resolved "Unknown engine handle" envelope. The C admission pin is the + // authoritative memory-safety guard (round 11 #2/#3); this only improves the + // failure ergonomics for a misused instance. (round 12 #4) + this.ensureReady(); + return yield* streamFromNative((writeCb) => - ffi.runScriptTransform(script, inputsJson, inputName, inputMimeType, inputCharset, readCb, writeCb) + ffi.runScriptTransformEngine( + this.engineHandle!, + script, + inputsJson, + inputName, + inputMimeType, + inputCharset, + readCb, + writeCb + ) ); } - private ensureInitialized(): void { - if (!this.initialized) { - throw new DataWeaveError("DataWeave runtime not initialized. Call initialize() first."); + private ensureReady(): void { + if (this.state === "ready") return; + if (this.state === "cleaning-up") { + throw new DataWeaveError( + "DataWeave runtime is cleaning up; await cleanup() before running again." + ); } + throw new DataWeaveError("DataWeave runtime not initialized. Call initialize() first."); } } // Module-level convenience API with lazy singleton let globalInstance: DataWeave | null = null; +// Guards against beforeExit and exit both driving cleanup for the same +// shutdown. Belt-and-suspenders on top of cleanup()'s own idempotency. +let cleanupStarted = false; +// Coalesces overlapping module-level cleanup() calls, mirroring the +// instance-level DataWeave.cleanupPromise. Without it, the second of two +// overlapping module cleanup() calls sees globalInstance already nulled and +// resolves immediately -- before the first call's native teardown finishes, +// violating cleanup()'s "resolves once native teardown has finished" contract +// for the last reference. (round 12 #5) +let cleanupPromise: Promise | null = null; +// The instance that `cleanupPromise` is currently draining. Needed because +// coalescing must NOT be keyed on the module-global promise alone: if a +// caller revives the singleton (via run()/getGlobalInstance()) while a prior +// drain is still in flight, a subsequent cleanup() must clean the freshly +// revived instance rather than returning the stale promise as if it had +// covered it too -- otherwise the revived instance's native ref is silently +// leaked (final-review round 12 #1, fixing round 12 Task 6's regression). +let cleaningInstance: DataWeave | null = null; +// Process exit hooks are registered exactly once for the lifetime of the +// module, NOT per singleton. Re-creating the singleton after cleanup() must +// not attach a second pair of listeners (that accumulates until Node emits +// MaxListenersExceededWarning). The listeners tolerate a null globalInstance: +// cleanup() no-ops when there is nothing to release, and cleanupStarted +// coalesces beforeExit/exit for a given shutdown. Unlike cleanupStarted, this +// guard is never reset — that is the whole point. +let exitHooksRegistered = false; + +/** + * Registers the process-wide exit-cleanup hooks exactly once for this + * module. Subsequent calls (e.g. from a revived singleton after cleanup()) + * are no-ops: the hooks registered on first use are reused for the rest of + * the process's lifetime, which is safe because they tolerate a null + * `globalInstance` and `cleanupStarted` coalesces beforeExit/exit for a + * given shutdown. + * + * Two hooks are registered, covering complementary cases: + * - `beforeExit` fires when the event loop is about to drain naturally and + * CAN run async work (Node keeps the loop alive until it settles), so it + * drains any in-flight streaming/transform operation gracefully. This is + * the common case. + * - `exit` runs strictly synchronously and is only a best-effort fallback for + * the paths that skip `beforeExit` — `process.exit()`, an uncaught + * exception, and normal process termination. Because it is synchronous it + * can only run the fast cleanup path, so an in-flight async operation may be + * abandoned. Node does NOT emit `exit` (nor `beforeExit`) for termination + * signals such as SIGTERM/SIGINT/SIGKILL, nor for every fatal failure mode, + * so this is not a guarantee: callers that require graceful shutdown must + * register and await their own handlers for the catchable signals (e.g. + * `process.on("SIGTERM", async () => { await cleanup(); process.exit(0); })`); + * SIGKILL cannot be caught, so no in-process cleanup can run for it. + * The `cleanupStarted` guard ensures only one of the two hooks actually + * runs cleanup for a given shutdown. + */ +function registerExitHooksOnce(): void { + if (exitHooksRegistered) return; + exitHooksRegistered = true; + process.on("beforeExit", async () => { + if (cleanupStarted) return; + cleanupStarted = true; + await cleanup(); // beforeExit can await: drains in-flight ops + }); + process.on("exit", () => { + if (cleanupStarted) return; // beforeExit already handled it + cleanup(); // fallback: best-effort sync fast path + }); +} /** * Returns the process-wide {@link DataWeave} singleton, creating and - * initializing it (and registering a process-exit cleanup hook) on first use. + * initializing it on first use (or after a prior {@link cleanup}). + * + * The exit-cleanup hooks are registered exactly once for the process via + * {@link registerExitHooksOnce}, not once per singleton: a singleton revived + * after cleanup() reuses the same pair of listeners rather than adding new + * ones, which would otherwise accumulate a pair per init/cleanup cycle until + * Node emits `MaxListenersExceededWarning`. Reuse is safe because the + * listeners tolerate a null `globalInstance` and `cleanupStarted` coalesces + * beforeExit/exit for a given shutdown. */ function getGlobalInstance(): DataWeave { if (!globalInstance) { - globalInstance = new DataWeave(); - globalInstance.initialize(); - process.on("exit", () => cleanup()); + // Initialize a LOCAL candidate first; publish the singleton only after + // initialize() succeeds. A failed first init (bad DATAWEAVE_NATIVE_LIB + // path / transient native failure) must NOT leave a poisoned, uninitialized + // singleton that makes every later run*() fail "not initialized" even after + // the fault is fixed (review #6 #1). On throw, globalInstance stays null and + // the next call retries cleanly with a fresh instance. + const candidate = new DataWeave(); + candidate.initialize(); + globalInstance = candidate; + registerExitHooksOnce(); } return globalInstance; } @@ -247,9 +446,50 @@ export function runTransform( * Releases the shared {@link DataWeave} singleton, if one was created. A fresh * singleton is created lazily on the next convenience-API call. */ -export function cleanup(): void { - if (globalInstance) { - globalInstance.cleanup(); - globalInstance = null; +export async function cleanup(): Promise { + // Coalesce overlapping calls onto one drain (round 12 #5) -- but ONLY when + // nothing new has been revived since that drain started. If `globalInstance` + // is still the same instance the in-flight promise is draining, or is null + // (nobody has revived since), it's safe to piggyback on the existing + // promise. If a DIFFERENT instance is now the singleton (a caller called + // run() and revived it while the old drain was still in flight), that new + // instance has never been handed to a cleanup() call -- returning the old + // promise here would resolve as if it had been cleaned when it hasn't, + // leaking its native ref for the rest of the process (final-review round 12 + // #1). Fall through and drain the current instance instead. + if (cleanupPromise && (globalInstance === null || globalInstance === cleaningInstance)) { + return cleanupPromise; } -} \ No newline at end of file + if (!globalInstance) return; + const instance = globalInstance; + globalInstance = null; + // Chosen semantics for overlapping different-instance drains: coalescing + // tracks only the MOST RECENT drain. An older drain that is still in flight + // when a newer one starts is not stomped -- it keeps running against its own + // promise, which whoever started it already holds and will await -- but it + // stops being the thing later cleanup() calls coalesce onto. Two distinct + // instances tearing down concurrently is fine: each owns its own engine + // handle and native ref, exactly like two DataWeave instances calling + // .cleanup() independently. This keeps the invariant that matters: no + // cleanup() call ever returns as if it drained an instance it didn't. + cleaningInstance = instance; + cleanupPromise = instance.cleanup(); + try { + await cleanupPromise; + } finally { + // Only clear the shared coalescing state if it's still ours to clear -- + // i.e. nobody has started a newer drain (for a newer revived instance) + // that has since taken over `cleanupPromise`/`cleaningInstance`. Guards + // against this drain's finally clobbering a later drain's in-flight state. + if (cleaningInstance === instance) { + cleanupPromise = null; + cleaningInstance = null; + } + // Reset the exit-hook guard only after THIS drain has fully completed, so + // a revived singleton gets its own live hooks for the next real exit. + // Must stay last: resetting earlier could let a concurrent `exit` firing + // on this same shutdown re-enter cleanup while the async drain above is + // in flight. + cleanupStarted = false; + } +} diff --git a/native-lib/node/src/ffi.ts b/native-lib/node/src/ffi.ts index 924de436..1deab6aa 100644 --- a/native-lib/node/src/ffi.ts +++ b/native-lib/node/src/ffi.ts @@ -3,9 +3,18 @@ import type { ModuleResolver } from "./resolver"; interface NativeAddon { initialize(libPath: string): void; - runScript(script: string, inputsJson: string): string; - runScriptStreaming(script: string, inputsJson: string, chunkCb: (chunk: Buffer) => void): Promise; - runScriptTransform( + createEngine(): number; + createEngineWithResolver(resolver: ModuleResolver): number; + destroyEngine(handle: number): void; + runScriptEngine(handle: number, script: string, inputsJson: string): string; + runScriptStreamingEngine( + handle: number, + script: string, + inputsJson: string, + chunkCb: (chunk: Buffer) => void + ): Promise; + runScriptTransformEngine( + handle: number, script: string, inputsJson: string, inputName: string, @@ -14,14 +23,7 @@ interface NativeAddon { readCb: (bufSize: number) => Buffer | null, writeCb: (chunk: Buffer) => void ): Promise; - runWithResolver( - script: string, - inputsJson: string, - mimeType: string, - resolverCallback: ModuleResolver, - isolate: null - ): string; - cleanup(): void; + cleanup(): Promise; } let addon: NativeAddon | null = null; @@ -38,19 +40,33 @@ export function initialize(libPath: string): void { getAddon().initialize(libPath); } -export function runScript(script: string, inputsJson: string): string { - return getAddon().runScript(script, inputsJson); +export function createEngine(): number { + return getAddon().createEngine(); +} + +export function createEngineWithResolver(resolver: ModuleResolver): number { + return getAddon().createEngineWithResolver(resolver); } -export function runScriptStreaming( +export function destroyEngine(handle: number): void { + getAddon().destroyEngine(handle); +} + +export function runScriptEngine(handle: number, script: string, inputsJson: string): string { + return getAddon().runScriptEngine(handle, script, inputsJson); +} + +export function runScriptStreamingEngine( + handle: number, script: string, inputsJson: string, chunkCb: (chunk: Buffer) => void ): Promise { - return getAddon().runScriptStreaming(script, inputsJson, chunkCb); + return getAddon().runScriptStreamingEngine(handle, script, inputsJson, chunkCb); } -export function runScriptTransform( +export function runScriptTransformEngine( + handle: number, script: string, inputsJson: string, inputName: string, @@ -59,18 +75,18 @@ export function runScriptTransform( readCb: (bufSize: number) => Buffer | null, writeCb: (chunk: Buffer) => void ): Promise { - return getAddon().runScriptTransform(script, inputsJson, inputName, inputMimeType, inputCharset, readCb, writeCb); -} - -export function runWithResolver( - script: string, - inputsJson: string, - mimeType: string, - resolverCallback: ModuleResolver -): string { - return getAddon().runWithResolver(script, inputsJson, mimeType, resolverCallback, null); + return getAddon().runScriptTransformEngine( + handle, + script, + inputsJson, + inputName, + inputMimeType, + inputCharset, + readCb, + writeCb + ); } -export function cleanup(): void { - getAddon().cleanup(); +export function cleanup(): Promise { + return getAddon().cleanup(); } diff --git a/native-lib/node/src/stream.ts b/native-lib/node/src/stream.ts index 855807f6..032d5a68 100644 --- a/native-lib/node/src/stream.ts +++ b/native-lib/node/src/stream.ts @@ -36,15 +36,27 @@ export async function* streamFromNative( } }; - const metaPromise = start(chunkCb).then((raw) => { - metaRaw = raw; - done = true; - // Wake all waiting consumers + let startError: unknown; + let startRejected = false; + const wakeAll = () => { while (pendingResolves.length > 0) { const resolve = pendingResolves.shift(); if (resolve) resolve(); } - }); + }; + + // Handle BOTH settlement branches. Without the rejection handler, a rejected + // start() leaves `done` false forever: a consumer parked in next() below is + // never woken and the generator hangs, and the rejection is unhandled + // (review #6 #2). On rejection we record the error, flip startRejected, mark + // completion, and wake every waiter; the error is re-thrown (by settlement + // state, not by value -- see below) after draining any chunks that arrived + // before the rejection. Because we handle rejection here, metaPromise itself + // always fulfills -- `await metaPromise` below never throws. + const metaPromise = start(chunkCb).then( + (raw) => { metaRaw = raw; done = true; wakeAll(); }, + (err) => { startError = err; startRejected = true; done = true; wakeAll(); } + ); while (true) { if (chunks.length > 0) { @@ -55,11 +67,15 @@ export async function* streamFromNative( await new Promise((resolve) => { pendingResolves.push(resolve); }); } - // Drain remaining chunks + // Drain remaining chunks buffered before completion/rejection. while (chunks.length > 0) { yield chunks.shift()!; } await metaPromise; + // Track rejection by settlement STATE, not by the rejected value: Promise.reject(undefined) + // is valid JS, so a value sentinel (startError !== undefined) would swallow it as an empty + // result. startRejected is only ever set in the rejection handler above (review #7 #6). + if (startRejected) throw startError; return parseStreamingResult(metaRaw ?? ""); } \ No newline at end of file diff --git a/native-lib/node/tests/integration/admission-during-teardown.test.ts b/native-lib/node/tests/integration/admission-during-teardown.test.ts new file mode 100644 index 00000000..a87b7f18 --- /dev/null +++ b/native-lib/node/tests/integration/admission-during-teardown.test.ts @@ -0,0 +1,136 @@ +import { describe, it, expect } from "vitest"; +import * as ffi from "../../src/ffi"; +import { findLibrary, buildInputsJson } from "../../src/utils"; + +// Round-6 finding #2: napi_run_script_streaming_engine/napi_run_script_transform_engine +// used to read g_initialized outside g_mutex, then reserve g_active_ops in a +// LATER, separate critical section right before spawning the worker thread -- +// with no reference to g_teardown_state at all. The fix folds the lifecycle +// check (including g_teardown_state) and the g_active_ops reservation into one +// atomic critical section, before any work/tsfn/promise/bridge is allocated, +// and rejects admission once a teardown is queued/underway +// (g_teardown_state != TEARDOWN_NONE), not just when the isolate is fully gone. +// +// Why this test drives the addon through the raw `ffi` module instead of the +// module-level `run`/`runStreaming`/`runTransform`/`cleanup` singleton (as the +// original brief sketch does): the module-level `cleanup()` nulls the +// singleton, so a later module-level `runStreaming()`/`runTransform()` call +// re-creates a fresh `DataWeave` instance and calls `initialize()` again. +// `napi_initialize`'s TEARDOWN_PENDING_WAIT branch (round-5's deadlock fix) +// treats that as a legitimate ADOPTION of the still-live isolate: it sets +// g_teardown_cancelled = true and cancels the pending teardown *before* the +// second op's admission check ever runs -- so by the time streaming/transform +// admission is checked, g_teardown_state is already back to TEARDOWN_NONE +// (verified empirically while developing this test: the brief's literal shape +// resolves the second op cleanly on both pre-fix and post-fix code, so it +// cannot distinguish them -- it never reaches the vulnerable window because +// the intervening initialize() call cancels the teardown as a side effect). +// +// To actually observe admission-during-pending-teardown, the second op must +// run against the SAME still-live handle/isolate WITHOUT any intervening +// ffi.initialize() call. Calling `ffi.cleanup()` directly (skipping +// `destroyEngine`) triggers exactly napi_cleanup's Case 5 (last ref release +// with an active op) and sets g_teardown_state = TEARDOWN_PENDING_WAIT +// synchronously, under g_mutex, before napi_cleanup returns its Promise to +// JS -- with no adoption path involved, since nothing calls initialize() +// afterward. +// +// Determinism: `ffi.cleanup()`'s synchronous prefix (native napi_cleanup body) +// runs entirely synchronously up to the point where it returns a Promise; the +// TEARDOWN_PENDING_WAIT transition happens on that same synchronous call, not +// after an await. The immediately-following `ffi.runScriptStreamingEngine` +// call re-enters native code synchronously (it's a plain N-API call), on the +// very same JS callstack, so it deterministically observes +// g_teardown_state == TEARDOWN_PENDING_WAIT with no timing assumptions -- +// mirroring the round-5 teardown-deadlock test's use of a synchronous native +// read-callback to force deterministic ordering instead of timers. +// +// Real addon, no mocking. +describe("admission rejected while teardown pending (round 6 #2)", () => { + it("a streaming op started on the same handle during pending teardown is rejected, not admitted", async () => { + ffi.initialize(findLibrary()); + const handle = ffi.createEngine(); + + let cleanupPromise: Promise | undefined; + let admitErr: unknown; + let admitted = false; + let secondOpSettled: Promise = Promise.resolve(); + + let firstRead = true; + const readCb = (_bufSize: number): Buffer | null => { + if (firstRead) { + firstRead = false; + + // Trigger Case 5 of napi_cleanup: last release of the shared library + // ref-count while this transform's worker is attached and + // g_active_ops > 0. Synchronously sets g_teardown_state = + // TEARDOWN_PENDING_WAIT before returning. Not awaited -- the point is + // to observe the state it leaves behind, not its eventual settlement. + cleanupPromise = ffi.cleanup(); + + // Attempt a second admission on the SAME still-live handle/isolate + // while teardown is pending. Fixed code rejects admission with a + // synchronous napi_throw_error (the atomic admission check sees + // g_teardown_state != TEARDOWN_NONE, before any promise is even + // created). Pre-fix code admits it: the unlocked g_initialized check + // passes (the isolate genuinely hasn't been torn down yet -- + // TEARDOWN_PENDING_WAIT hasn't reached physical teardown) and + // g_active_ops is reserved without ever consulting g_teardown_state, + // so the call returns a promise that goes on to resolve successfully. + // + // On rejection, napi_throw_error fires synchronously from this very + // call (admission fails before any promise is created), so it must + // be caught here rather than only via a rejected-promise `.then` -- + // mirroring the round-5 teardown-deadlock test's care not to let a + // thrown exception escape a native read-callback body (it would be + // reinterpreted as a read error, masking the real outcome). + try { + secondOpSettled = ffi + .runScriptStreamingEngine( + handle, + "%dw 2.0\noutput application/json\n---\n[1,2,3]", + buildInputsJson({}), + () => {} + ) + .then( + () => { admitted = true; }, + (e) => { admitErr = e; } + ); + } catch (e) { + admitErr = e; + } + + return Buffer.from("[1,2,3]"); + } + return null; // EOF after the first chunk + }; + + const chunks: Buffer[] = []; + const writeCb = (chunk: Buffer) => { chunks.push(chunk); }; + + const resultRaw = await ffi.runScriptTransformEngine( + handle, + "output application/json\n---\npayload", + "{}", + "payload", + "application/json", + null, + readCb, + writeCb + ); + const result = JSON.parse(resultRaw); + expect(result.success).toBe(true); + + // Let the second op settle (whichever branch it took) before asserting, + // and drain the pending teardown so the shared native isolate is left in + // a clean, consistent state for sibling test files in this process. + await secondOpSettled; + await cleanupPromise; + + // The second op admitted while teardown was pending must have been + // rejected, not silently admitted against an isolate a concurrent + // teardown could tear down out from under it. + expect(admitErr).toBeTruthy(); + expect(admitted).toBe(false); + }, 20000); +}); diff --git a/native-lib/node/tests/integration/dataweave-resolver.test.ts b/native-lib/node/tests/integration/dataweave-resolver.test.ts index 6578bb6b..eca77297 100644 --- a/native-lib/node/tests/integration/dataweave-resolver.test.ts +++ b/native-lib/node/tests/integration/dataweave-resolver.test.ts @@ -1,15 +1,16 @@ import { describe, it, expect, afterAll } from "vitest"; import { DataWeave, cleanup } from '../../src/dataweave'; +import { DataWeaveError } from '../../src/errors'; import { modulesFromMap } from '../../src/resolver'; // Every test below constructs its own explicit DataWeave instance (rather // than the module-level singleton) so each can configure its own resolver. // `cleanup()` above only releases the *singleton* (`globalInstance`), which // nothing in this file ever creates -- so without this tracking, every -// explicit instance's native library reference (and the shared addon-level -// ref-count, see addon.c's g_ref_count) would leak for the lifetime of the -// test process. Track every instance created in this file and release them -// all in afterAll. +// explicit instance's native library reference (and its own engine handle, +// see addon.c's create_engine/destroy_engine) would leak for the lifetime of +// the test process. Track every instance created in this file and release +// them all in afterAll. const instances: DataWeave[] = []; function trackedDataWeave(...args: ConstructorParameters): DataWeave { const dw = new DataWeave(...args); @@ -17,31 +18,19 @@ function trackedDataWeave(...args: ConstructorParameters): Dat return dw; } -afterAll(() => { +afterAll(async () => { for (const dw of instances) { - dw.cleanup(); + await dw.cleanup(); } - cleanup(); + await cleanup(); }); -// ScriptRuntime installs at most one resolver for the whole process lifetime -// (see ScriptRuntime.setResolver()): whichever DataWeave instance's resolver -// gets installed first "wins", and every later DataWeave instance in this -// file — regardless of its own resolveModule map — silently reuses it. Since -// vitest runs the `it` blocks in this file sequentially in the same process, -// that's always this first module-map, so it must contain every module path -// any test below needs to resolve for the first time (including the -// cross-thread regression test's two never-before-resolved paths). -const SHARED_RESOLVER_MODULES: Record = { - 'org/test/lib.dwl': '%dw 2.0\nfun greet(n: String) = "Hello " ++ n', - 'org/test/resolverGuardInstall.dwl': '%dw 2.0\nfun greet(n: String) = "Hello " ++ n', - 'org/test/resolverGuardStreamed.dwl': '%dw 2.0\nfun greet(n: String) = "Hello " ++ n', -}; - describe('DataWeave with resolver', () => { it('resolves imported module from map', () => { const dw = trackedDataWeave({ - resolveModule: modulesFromMap(SHARED_RESOLVER_MODULES), + resolveModule: modulesFromMap({ + 'org/test/lib.dwl': '%dw 2.0\nfun greet(n: String) = "Hello " ++ n', + }), }); dw.initialize(); @@ -106,46 +95,27 @@ describe('DataWeave with resolver', () => { expect(JSON.parse(result.getString()!)).toBe("Hello"); }); - // Regression test for the cross-thread resolver hazard: ScriptRuntime's engine - // is a process-wide singleton, so once any .run() call installs a resolver on - // it, that same composite resolver is used by ALL later execution paths -- - // including runStreaming()/runTransform(), whose native call executes on a - // background uv_thread (see addon.c's streaming_thread_fn), not the JS thread - // that registered the resolver. Before the thread-identity guard in addon.c's - // resolve_module_callback, a streamed script importing a non-built-in module - // would trigger a napi call from that background thread -- undefined behavior, - // typically a crash of the whole process. After the guard, the callback fails - // closed (reports "not found" instead of calling back into JS), so the script - // fails cleanly with a compile error and the process survives. - it('runStreaming fails cleanly (does not crash) for a custom module on the shared singleton engine', async () => { - // Once a module name has been resolved anywhere in the process, the - // DataWeave compiler caches it and won't call back into the resolver for - // that same name again — so the install script and the streaming script - // below import two module paths that no earlier test in this file has - // imported yet (both pre-registered in SHARED_RESOLVER_MODULES above, - // since only the first-installed resolver's map is ever consulted). + // Regression test for the cross-thread resolver hazard: each DataWeave + // instance now owns its own native engine (see engine_bridge_t in addon.c), + // but a resolver-backed engine's runStreaming()/runTransform() still + // executes the native call on a background uv_thread (see addon.c's + // streaming_thread_fn/transform_thread_fn), not the JS thread that created + // the engine and its resolver bridge. resolve_module_callback detects that + // thread-identity mismatch and fails closed (reports "not found" instead of + // calling back into JS) rather than making an unsafe cross-thread napi + // call, so the script fails cleanly with a compile error and the process + // survives. + it('runStreaming fails cleanly for a custom module on its own resolver-backed engine', async () => { const dw = trackedDataWeave({ - resolveModule: modulesFromMap(SHARED_RESOLVER_MODULES), + resolveModule: modulesFromMap({ + 'org/test/resolverGuardStreamed.dwl': '%dw 2.0\nfun greet(n: String) = "Hello " ++ n', + }), }); dw.initialize(); - // Install (or confirm already-installed) resolver on the shared singleton - // engine via a synchronous run() call. Per ScriptRuntime.setResolver(), only - // the first resolver registered for the process is ever used, so this is - // safe to call even if an earlier test in this file already installed one. - const installResult = dw.run(` - %dw 2.0 - import org::test::resolverGuardInstall - output application/json - --- - resolverGuardInstall::greet("Installer") - `); - expect(installResult.success).toBe(true); - - // Now stream a script that imports a DIFFERENT non-built-in module, never - // resolved before in this process. The singleton engine's composite - // resolver (ClassLoader + Callback) will miss in the ClassLoader half (not - // a built-in) and fall through to the Callback half, invoking + // Stream a script that imports a non-built-in module. This engine's + // composite resolver (ClassLoader + Callback) misses in the ClassLoader + // half (not a built-in) and falls through to the Callback half, invoking // resolve_module_callback from runStreaming's background thread. const chunks: Buffer[] = []; const gen = dw.runStreaming(` @@ -167,4 +137,345 @@ describe('DataWeave with resolver', () => { expect(metadata.error).toBeTruthy(); expect(chunks.length).toBe(0); }); + + // resolve_module_callback in addon.c catches a JS exception thrown by the + // user-supplied resolver (napi_call_function returning napi_pending_exception), + // clears it via napi_get_and_clear_last_exception, logs a content-free + // diagnostic (see the DATAWEAVE_RESOLVER_DEBUG gating), and reports "not + // found" back to the DataWeave runtime -- rather than letting the pending + // exception leak into a later napi call or crash the process. This is a + // synchronous run() on the JS thread that created the bridge (the "owner" + // thread check in resolve_module_callback passes), so the callback is + // actually invoked, unlike the streaming/transform cross-thread case above. + it('throwing resolver makes run() fail cleanly instead of crashing the process', () => { + const dw = trackedDataWeave({ + resolveModule: () => { + throw new Error('resolver blew up'); + }, + }); + dw.initialize(); + + const result = dw.run(` + %dw 2.0 + import org::test::throwingResolverLib + output application/json + --- + {} + `); + + // The test itself completing (no uncaught exception / segfault) is the + // crash-check. We also assert an error message is surfaced -- but not its + // wording, which is an internal detail. + expect(result.success).toBe(false); + expect(result.error).toBeTruthy(); + }); + + // Regression test for a resolver-backed engine's initialize -> cleanup -> + // initialize cycle. Unlike the resolver-less reinit test in + // edge-cases.test.ts, this exercises createEngineWithResolver's bridge + // (engine_bridge_t) lifecycle: cleanup() destroys the bridge and its engine + // handle, and the following initialize() must build a brand new bridge + // (new napi_ref on the resolver, new owner-thread record) that resolves + // custom modules again, not a stale or dangling one. + it('resolver-backed instance resolves a custom module again after initialize -> cleanup -> initialize', async () => { + const dw = trackedDataWeave({ + resolveModule: modulesFromMap({ + 'org/test/reinitLib.dwl': '%dw 2.0\nfun greet(n: String) = "Hello " ++ n', + }), + }); + dw.initialize(); + await dw.cleanup(); + dw.initialize(); + + const result = dw.run(` + %dw 2.0 + import org::test::reinitLib + output application/json + --- + reinitLib::greet("Reinit") + `); + + expect(result.success).toBe(true); + expect(JSON.parse(result.getString()!)).toBe("Hello Reinit"); + }); + + // Regression test for the F1 use-after-free fix: a resolver-backed engine's + // engine_bridge_t used to be freed by destroy_engine (called from cleanup()) + // even while a background uv_thread (streaming_thread_fn) was still + // mid-flight and could call resolve_module_callback with that bridge as + // ctx -- a use-after-free. The fix adds in-flight accounting under g_mutex: + // destroy_engine now defers the actual free until the background operation + // decrements in_flight back to zero in its completion sentinel. + // + // To race cleanup() against the in-flight operation deterministically, we + // start the generator's *first* `.next()` call but do not await it before + // calling cleanup(). Calling an async generator's .next() runs its body + // synchronously up to the first suspension point (an `await`); by that + // point runStreaming's synchronous prefix -- including the native + // runScriptStreamingEngine call that hands the operation to a libuv + // worker-pool thread -- has already executed. cleanup() is then called + // from the JS thread while that native call may already be running + // concurrently on the worker thread, which is exactly the race the F1 fix + // guards against. Before that fix this was a real crash/UAF risk; after it, + // this must complete cleanly (settle, not crash, not hang) regardless of + // which side of the race wins. + it('cleanup() racing an in-flight resolver-backed runStreaming() does not crash (F1 regression)', async () => { + const dw = trackedDataWeave({ + resolveModule: modulesFromMap({ + 'org/test/cleanupDuringStream.dwl': '%dw 2.0\nfun greet(n: String) = "Hello " ++ n', + }), + }); + dw.initialize(); + + const gen = dw.runStreaming(` + %dw 2.0 + import org::test::cleanupDuringStream + output application/json + --- + cleanupDuringStream::greet("Streaming") + `); + + // Start the native call without awaiting it, then immediately race + // cleanup() against it. + const firstNext = gen.next(); + // Retain the cleanup promise so its rejection cannot escape as an unhandled + // rejection and so native teardown is actually awaited before the test ends + // (review #9 #3). It is awaited in the finally below. + const cleanupPromise = dw.cleanup(); + + try { + // The outcome (a settled chunk, the terminal metadata, or a rejection) + // doesn't matter -- what matters is that it settles instead of crashing + // the process or hanging, and that no unhandled rejection escapes this + // test. We explicitly catch here (rather than asserting a specific + // resolution) and prove settlement, one way or the other. + let settled = false; + try { + await firstNext; + settled = true; + } catch (err) { + settled = true; + expect(err).toBeDefined(); + } + expect(settled).toBe(true); + + // Drain whatever remains so no background callback fires after this test + // (and this file's process) moves on. + try { + let result = await gen.next(); + while (!result.done) { + result = await gen.next(); + } + } catch { + // Draining after a mid-stream cleanup may itself reject; that's fine. + } + } finally { + // Always await the retained cleanup so native teardown finishes before the + // test returns; a cleanup rejection here surfaces rather than dangling, but + // it does not mask a primary assertion failure thrown from the try above. + await cleanupPromise; + } + }); + + // Deadlock regression: unlike the F1 test above (which races cleanup() + // against a stream that fails before emitting data), this test uses a + // script that produces real output with enough volume that the worker + // thread is genuinely attached and mid-delivery -- blocked in + // napi_call_threadsafe_function(..., napi_tsfn_blocking) -- when cleanup() + // drops the last native reference. Before the fix (napi_cleanup's + // synchronous uv_thread_join), this scenario hung the process; after the + // fix, cleanup() defers teardown to a waiter thread until this op drains, + // so both the cleanup() promise and the streaming generator settle. + it('cleanup() during an active, output-producing runStreaming() does not deadlock', async () => { + const dw = trackedDataWeave(); + dw.initialize(); + + const gen = dw.runStreaming( + 'output application/json --- (1 to 5000) map {id: $, name: "item_" ++ $}' + ); + + // Pin the operation without draining it: exactly one .next() call runs + // the generator's synchronous prefix (including the native call that + // hands the op to a background thread) up to its first await. + const firstNext = gen.next(); + + const cleanupPromise = dw.cleanup(); + + await expect( + Promise.race([ + cleanupPromise, + new Promise((_, reject) => setTimeout(() => reject(new Error('cleanup() timed out')), 10000)), + ]) + ).resolves.toBeUndefined(); + + // Drain whatever remains; the stream itself must also settle, not hang. + let result = await firstNext; + while (!result.done) { + result = await gen.next(); + } + expect(result.value).toBeDefined(); + }, 15000); + + // Same deadlock regression as above, for runTransform() -- the design doc + // notes the same problem applies to transform's write_tsfn delivery path. + it('cleanup() during an active, output-producing runTransform() does not deadlock', async () => { + const dw = trackedDataWeave(); + dw.initialize(); + + const parts: Buffer[] = [Buffer.from("[")]; + for (let i = 1; i <= 2000; i++) { + if (i > 1) parts.push(Buffer.from(",")); + parts.push(Buffer.from(`{"id":${i}}`)); + } + parts.push(Buffer.from("]")); + const inputData = [Buffer.concat(parts)]; + + const gen = dw.runTransform( + "output application/json\n---\npayload map $", + inputData, + { mimeType: "application/json" } + ); + + const firstNext = gen.next(); + + // Unlike runStreaming (whose native call is synchronous up to its first + // await), runTransform's generator body awaits createChunkReader(input) + // -- itself a microtask, not real async work for a sync-iterable input -- + // before reaching the native runScriptTransformEngine call. A single + // un-awaited .next() only advances the generator to that intermediate + // await, not past it, so the native op would not yet be dispatched + // (g_active_ops still 0) when cleanup() below fires. One extra microtask + // tick lets that internal await settle so the native call is actually + // in flight, which is what this test needs to race against. + await Promise.resolve(); + + const cleanupPromise = dw.cleanup(); + + await expect( + Promise.race([ + cleanupPromise, + new Promise((_, reject) => setTimeout(() => reject(new Error('cleanup() timed out')), 10000)), + ]) + ).resolves.toBeUndefined(); + + let result = await firstNext; + while (!result.done) { + result = await gen.next(); + } + expect(result.value).toBeDefined(); + }, 15000); + + // Fast-path regression guard: cleanup() called once a stream has already + // fully drained (g_active_ops back to 0 by the time the last reference is + // released) must still resolve via the original, unchanged inline fast + // path -- confirming the new deferred-teardown branch didn't silently + // become the only path through napi_cleanup. + it('cleanup() after a stream has already fully drained resolves via the fast path', async () => { + const dw = trackedDataWeave(); + dw.initialize(); + + const gen = dw.runStreaming('output application/json --- {a: 1}'); + let result = await gen.next(); + while (!result.done) { + result = await gen.next(); + } + expect(result.value.success).toBe(true); + + await expect(dw.cleanup()).resolves.toBeUndefined(); + }); + + // Idempotency / re-entrant cleanup: two cleanup() calls that both arrive + // while a stream is active must both resolve off the same underlying + // teardown -- without spawning a second waiter thread, throwing, or + // decrementing g_ref_count below 0. + it('two concurrent cleanup() calls during an active stream both resolve cleanly', async () => { + const dw = trackedDataWeave(); + dw.initialize(); + + const gen = dw.runStreaming( + 'output application/json --- (1 to 3000) map {id: $}' + ); + const firstNext = gen.next(); + + const [r1, r2] = await Promise.all([ + Promise.race([ + dw.cleanup(), + new Promise((_, reject) => setTimeout(() => reject(new Error('first cleanup() timed out')), 10000)), + ]), + Promise.race([ + dw.cleanup(), + new Promise((_, reject) => setTimeout(() => reject(new Error('second cleanup() timed out')), 10000)), + ]), + ]); + expect(r1).toBeUndefined(); + expect(r2).toBeUndefined(); + + let result = await firstNext; + while (!result.done) { + result = await gen.next(); + } + }, 15000); + + // Re-initialize during pending teardown: starting a stream, calling + // cleanup() without awaiting it, then immediately calling initialize() + // again must block (at the native layer, inside napi_initialize) until the + // pending teardown finishes, rather than racing a second + // graal_create_isolate against an isolate that is still tearing down. The + // instance must be fully usable afterward. + it('initialize() called during a pending teardown waits for it and then works', async () => { + const dw = trackedDataWeave(); + dw.initialize(); + + const gen = dw.runStreaming( + 'output application/json --- (1 to 3000) map {id: $}' + ); + const firstNext = gen.next(); + + // Deliberately not awaited -- this is the pending-teardown state under test. + const cleanupPromise = dw.cleanup(); + + // dw.cleanup() already set dw's own initialized flag false only after its + // internal await resolves; to exercise the *native* pending-teardown path + // independent of this specific instance's TS-level guard, drive a second, + // fresh instance's initialize() concurrently -- it shares the same + // process-global isolate/g_ref_count. + const dw2 = trackedDataWeave(); + const secondInitDone = new Promise((resolve) => { + dw2.initialize(); + resolve(); + }); + + await Promise.race([ + Promise.all([cleanupPromise, secondInitDone]), + new Promise((_, reject) => setTimeout(() => reject(new Error('initialize()-during-teardown timed out')), 10000)), + ]); + + expect(dw2.run("6 * 7").getString()).toBe("42"); + + let result = await firstNext; + while (!result.done) { + result = await gen.next(); + } + }, 15000); + + // Node-layer contract (F4-adjacent): once cleanup() has torn an instance + // down, run() must be rejected by dataweave.ts's own ensureInitialized() + // guard -- a DataWeaveError with a "not initialized" message -- rather than + // reaching the native addon at all with a handle that no longer refers to a + // live engine. This is the TS-level half of the destroyed/unknown-handle + // contract; the native "Unknown engine handle" string is the deeper + // contract the addon enforces if it were ever called with a stale handle, + // which this guard prevents from happening via the public API. + it('run() after cleanup() throws a DataWeaveError via the TS-level ensureInitialized guard', async () => { + const dw = trackedDataWeave({ + resolveModule: modulesFromMap({ + 'org/test/destroyedHandleLib.dwl': '...', + }), + }); + dw.initialize(); + await dw.cleanup(); + + expect(() => dw.run('1 + 1')).toThrow(DataWeaveError); + expect(() => dw.run('1 + 1')).toThrow(/DataWeave runtime not initialized/); + }); }); diff --git a/native-lib/node/tests/integration/dataweave.test.ts b/native-lib/node/tests/integration/dataweave.test.ts index bacf1606..e5af4608 100644 --- a/native-lib/node/tests/integration/dataweave.test.ts +++ b/native-lib/node/tests/integration/dataweave.test.ts @@ -3,8 +3,8 @@ import { readFileSync } from "node:fs"; import { join } from "node:path"; import { DataWeave, run, runStreaming, runTransform, cleanup } from "../../src/index"; -afterAll(() => { - cleanup(); +afterAll(async () => { + await cleanup(); }); describe("DataWeave Node.js API", () => { @@ -21,7 +21,7 @@ describe("DataWeave Node.js API", () => { expect(result.getString()).toBe("42"); }); - it("explicit instance lifecycle", () => { + it("explicit instance lifecycle", async () => { const dw = new DataWeave(); dw.initialize(); try { @@ -30,7 +30,7 @@ describe("DataWeave Node.js API", () => { const r2 = dw.run("sqrt(10000)"); expect(r2.getString()).toBe("100"); } finally { - dw.cleanup(); + await dw.cleanup(); } }); diff --git a/native-lib/node/tests/integration/edge-cases.test.ts b/native-lib/node/tests/integration/edge-cases.test.ts index d1077e67..099659ab 100644 --- a/native-lib/node/tests/integration/edge-cases.test.ts +++ b/native-lib/node/tests/integration/edge-cases.test.ts @@ -6,8 +6,8 @@ import { describe, it, expect, afterAll } from "vitest"; import { DataWeave, run, runStreaming, runTransform, cleanup } from "../../src/index"; import type { StreamingResult } from "../../src/types"; -afterAll(() => { - cleanup(); +afterAll(async () => { + await cleanup(); }); /** Drains a streaming/transform generator, returning its chunks and terminal metadata. */ @@ -61,7 +61,7 @@ describe("runTransform with async-iterable input", () => { }); describe("multi-instance lifecycle", () => { - it("runs two independent instances and cleans them up independently", () => { + it("runs two independent instances and cleans them up independently", async () => { const a = new DataWeave(); const b = new DataWeave(); a.initialize(); @@ -70,8 +70,8 @@ describe("multi-instance lifecycle", () => { expect(a.run("1 + 1").getString()).toBe("2"); expect(b.run("2 + 3").getString()).toBe("5"); } finally { - a.cleanup(); - b.cleanup(); + await a.cleanup(); + await b.cleanup(); } // After cleanup, a fresh instance still works (runtime not permanently torn down). const c = new DataWeave(); @@ -79,22 +79,22 @@ describe("multi-instance lifecycle", () => { try { expect(c.run("6 * 7").getString()).toBe("42"); } finally { - c.cleanup(); + await c.cleanup(); } }); - it("initialize is idempotent and re-initialization after cleanup works", () => { + it("initialize is idempotent and re-initialization after cleanup works", async () => { const dw = new DataWeave(); dw.initialize(); dw.initialize(); // no-op, must not throw expect(dw.run("1").getString()).toBe("1"); - dw.cleanup(); - dw.cleanup(); // double cleanup, must not throw + await dw.cleanup(); + await dw.cleanup(); // double cleanup, must not throw dw.initialize(); // re-init try { expect(dw.run("2").getString()).toBe("2"); } finally { - dw.cleanup(); + await dw.cleanup(); } }); diff --git a/native-lib/node/tests/integration/engine-handle-contract.test.ts b/native-lib/node/tests/integration/engine-handle-contract.test.ts new file mode 100644 index 00000000..e46ac9d9 --- /dev/null +++ b/native-lib/node/tests/integration/engine-handle-contract.test.ts @@ -0,0 +1,314 @@ +import { describe, it, expect, beforeAll, afterAll } from "vitest"; +import * as ffi from "../../src/ffi"; +import { findLibrary, buildInputsJson } from "../../src/utils"; + +// W-23692110 round 11 finding #6. +// +// The Java `ScriptRuntimeTest` only asserts on the UNKNOWN_ENGINE_HANDLE_JSON +// constant -- the @CEntryPoint methods it wraps cannot run in a hosted JVM, so +// nothing has ever driven the real `*_engine` entrypoints through the +// compiled addon against an unknown or destroyed handle. This file closes +// that gap: it loads the REAL addon (no `vi.mock` of ffi) and drives +// `runScriptEngine` / `runScriptStreamingEngine` / `runScriptTransformEngine` +// directly through the raw `ffi` module -- the addon boundary the finding is +// about -- against handles that were never registered and against handles +// that were registered and then destroyed. +// +// Confirmed empirically (see task-6-report.md) against the real addon: +// - sync `runScriptEngine` RETURNS the JSON string +// `{"success":false,"error":"Unknown engine handle"}` -- it does not throw. +// - `runScriptStreamingEngine` / `runScriptTransformEngine` RESOLVE (never +// reject) their promise with that same JSON string as the terminal +// metadata; no chunk callback fires for an unknown/destroyed handle. +// This is the same envelope produced by NativeLib.UNKNOWN_ENGINE_HANDLE_JSON +// on the Java side (native-lib/src/main/java/org/mule/weave/lib/NativeLib.java), +// threaded back through addon.c's engine entrypoints and unmodified by the TS +// parsing layer (parseNativeResponse / parseStreamingResult in src/result.ts). +// +// The native addon globals (g_ref_count, g_initialized, g_bridges, etc.) are +// process-wide C statics -- vitest's per-file module isolation does NOT reset +// them, and napi_initialize/napi_cleanup are plain integer ref-counts (one +// increment per initialize(), one decrement per cleanup(), teardown only on +// the transition to zero). So this file calls ffi.initialize() exactly ONCE +// for the whole suite (beforeAll), balanced by exactly one ffi.cleanup() that +// brings the ref count to zero (in the last real test, "final cleanup..." +// below) -- mirroring independent-engines.test.ts's single +// initialize()/cleanup() pair rather than handle-validation.test.ts's +// per-test balancing (that file calls initialize()/cleanup() once per test, +// which does not fit here since several tests below deliberately build on a +// still-live engine/isolate from a prior test). The trailing afterAll is a +// pure safety net (idempotent no-op on the happy path) in case an earlier +// assertion throws before the drainage test runs, so this file never strands +// a ref-count bump for sibling integration test files sharing the same +// vitest worker process. +describe("*_engine unknown/destroyed-handle contract (round 11 #6)", () => { + beforeAll(() => { + ffi.initialize(findLibrary()); + }); + + afterAll(async () => { + // Idempotent: a no-op if the ref count already reached zero (the normal + // case -- the drainage test below already did that). A genuine safety + // net only if an earlier test threw before reaching that point. + await ffi.cleanup(); + }); + + // A handle value that was never handed out by createEngine()/ + // createEngineWithResolver() (those only ever return small positive + // handles from the Java-side registry) and can never collide with one. + const UNKNOWN_HANDLE = Number.MAX_SAFE_INTEGER; + const UNKNOWN_ENVELOPE = { success: false, error: "Unknown engine handle" }; + + it("runScriptEngine on a never-registered handle returns the terminal envelope, does not throw", () => { + let raw: string | undefined; + expect(() => { + raw = ffi.runScriptEngine( + UNKNOWN_HANDLE, + "%dw 2.0\noutput application/json\n---\n1 + 1", + buildInputsJson({}) + ); + }).not.toThrow(); + + expect(JSON.parse(raw!)).toEqual(UNKNOWN_ENVELOPE); + }); + + it("runScriptStreamingEngine on a never-registered handle resolves (never rejects) with the terminal envelope", async () => { + const chunks: Buffer[] = []; + const raw = await ffi.runScriptStreamingEngine( + UNKNOWN_HANDLE, + "%dw 2.0\noutput application/json\n---\n[1, 2, 3]", + buildInputsJson({}), + (chunk) => chunks.push(chunk) + ); + + expect(JSON.parse(raw)).toEqual(UNKNOWN_ENVELOPE); + // No output was ever produced for an engine that doesn't exist. + expect(chunks).toHaveLength(0); + }); + + it("runScriptTransformEngine on a never-registered handle resolves (never rejects) with the terminal envelope", async () => { + let readCalls = 0; + let firstRead = true; + const readCb = (_bufSize: number): Buffer | null => { + readCalls++; + if (firstRead) { + firstRead = false; + return Buffer.from("1"); + } + return null; + }; + const chunks: Buffer[] = []; + const writeCb = (chunk: Buffer) => chunks.push(chunk); + + const raw = await ffi.runScriptTransformEngine( + UNKNOWN_HANDLE, + "output application/json\n---\npayload", + "{}", + "payload", + "application/json", + null, + readCb, + writeCb + ); + + expect(JSON.parse(raw)).toEqual(UNKNOWN_ENVELOPE); + // The unknown-handle rejection happens before a worker is ever spawned, + // so the read/write callbacks are never invoked. + expect(readCalls).toBe(0); + expect(chunks).toHaveLength(0); + }); + + it("all three entrypoints on a destroyed handle return/resolve the same terminal envelope, after proving the handle worked", async () => { + const handle = ffi.createEngine(); + + // Prove the handle is genuinely live before destroying it. + const preDestroy = JSON.parse( + ffi.runScriptEngine(handle, "%dw 2.0\noutput application/json\n---\n1 + 1", buildInputsJson({})) + ); + expect(preDestroy.success).toBe(true); + + ffi.destroyEngine(handle); + + // Sync entrypoint: returns the envelope, does not throw. + let syncRaw: string | undefined; + expect(() => { + syncRaw = ffi.runScriptEngine(handle, "%dw 2.0\noutput application/json\n---\n1", buildInputsJson({})); + }).not.toThrow(); + expect(JSON.parse(syncRaw!)).toEqual(UNKNOWN_ENVELOPE); + + // Streaming entrypoint: resolves with the envelope. + const streamChunks: Buffer[] = []; + const streamRaw = await ffi.runScriptStreamingEngine( + handle, + "%dw 2.0\noutput application/json\n---\n[1, 2, 3]", + buildInputsJson({}), + (chunk) => streamChunks.push(chunk) + ); + expect(JSON.parse(streamRaw)).toEqual(UNKNOWN_ENVELOPE); + expect(streamChunks).toHaveLength(0); + + // Transform entrypoint: resolves with the envelope. + let transformReadCalls = 0; + let transformFirstRead = true; + const transformReadCb = (_bufSize: number): Buffer | null => { + transformReadCalls++; + if (transformFirstRead) { + transformFirstRead = false; + return Buffer.from("1"); + } + return null; + }; + const transformChunks: Buffer[] = []; + const transformRaw = await ffi.runScriptTransformEngine( + handle, + "output application/json\n---\npayload", + "{}", + "payload", + "application/json", + null, + transformReadCb, + (chunk) => transformChunks.push(chunk) + ); + expect(JSON.parse(transformRaw)).toEqual(UNKNOWN_ENVELOPE); + expect(transformReadCalls).toBe(0); + expect(transformChunks).toHaveLength(0); + }); + + // Same-thread post-admission ordering (deterministic, not best-effort): + // destroyEngine() is fired synchronously immediately after admission of the + // op (right after starting runScriptStreamingEngine, before awaiting it). + // The round-11 #2/#3 pin is taken atomically at admission, under g_mutex, in + // bridge_begin_op_locked -- so this same-thread ordering deterministically + // lands AFTER the pin is already held. That means the op MUST complete + // successfully with complete chunks; there is no closed set of "success or + // Unknown-engine-handle envelope" to tolerate here, because the envelope can + // only arise if the pin were NOT held at admission. Requiring success (and + // no longer accepting the envelope) makes this test fail if a future + // regression drops the admission-time pin, instead of silently passing by + // returning the accepted terminal envelope. + // + // Genuinely concurrent cross-thread interleavings (a real Worker racing + // destroyEngine() against admission on a different thread) are a distinct, + // non-deterministic window that this same-thread ordering does not exercise + // and cannot stand in for. That case remains covered best-effort by the + // forthcoming Worker-based suite (Task 8), matching the documented posture + // of rounds 5-10's cross-Worker races (see run-admission.test.ts / + // admission-during-teardown.test.ts) -- it is not tolerated away in this + // test. + it( + "destroyEngine() fired right after admission of an in-flight streaming op deterministically succeeds (pin held at admission)", + async () => { + const ITERATIONS = 50; + for (let i = 0; i < ITERATIONS; i++) { + const handle = ffi.createEngine(); + const chunks: Buffer[] = []; + const resultPromise = ffi.runScriptStreamingEngine( + handle, + "%dw 2.0\noutput application/json\n---\n[1, 2, 3]", + buildInputsJson({}), + (chunk) => chunks.push(chunk) + ); + // Fire destroy immediately after admission, before awaiting. The round-11 + // pin is taken atomically at admission (under g_mutex, in + // bridge_begin_op_locked), so this ordering lands AFTER the pin and the + // op MUST complete successfully. Requiring success (not tolerating the + // Unknown-engine-handle envelope) makes this test fail if a regression + // drops the admission-time pin. + expect(() => ffi.destroyEngine(handle)).not.toThrow(); + + const raw = await resultPromise; + const parsed = JSON.parse(raw); + expect(parsed.success).toBe(true); + expect(JSON.parse(Buffer.concat(chunks).toString("utf-8"))).toEqual([1, 2, 3]); + } + }, + 60000 + ); + + it("deferred registry removal after an in-flight op finalizes without wedging the isolate (round 12 #3)", async () => { + // Uses the shared beforeAll isolate. Create an engine, start a streaming + // op, destroy the engine while the op is admitted, drain the op. The + // deferred finalize (bridge_end_op -> bridge_finalize_registry) must + // complete and a subsequent run on a fresh engine must still work + // (isolate not torn down / not wedged by the transient reservation). + const handle = ffi.createEngine(); + const chunks: Buffer[] = []; + const resultPromise = ffi.runScriptStreamingEngine( + handle, + "%dw 2.0\noutput application/json\n---\n[1, 2, 3]", + buildInputsJson({}), + (chunk) => chunks.push(chunk) + ); + expect(() => ffi.destroyEngine(handle)).not.toThrow(); + const raw = await resultPromise; + const parsed = JSON.parse(raw); + // Pin held at admission (round 11) -> success expected; either way no crash. + if (parsed.success) { + expect(JSON.parse(Buffer.concat(chunks).toString("utf-8"))).toEqual([1, 2, 3]); + } + // Isolate still healthy after the deferred finalize ran: + const h2 = ffi.createEngine(); + const envelope = JSON.parse( + ffi.runScriptEngine(h2, "%dw 2.0\noutput application/json\n---\n2 + 2", buildInputsJson({})) + ); + expect(envelope.success).toBe(true); + expect(JSON.parse(Buffer.from(envelope.result, "base64").toString("utf-8"))).toBe(4); + ffi.destroyEngine(h2); + }); + + it("destroyEngine on an unknown / already-destroyed handle is a safe no-op and leaves the isolate healthy (review #10 #5)", () => { + // Drives napi_destroy_engine's `found == NULL` else branch on a LIVE isolate + // (the shared beforeAll isolate). Round-10 #5 added a teardown-state guard + // there so the direct registry-removal attach reads g_isolate/g_teardown_state + // under g_mutex and pins the isolate before fn_attach_thread, mirroring + // bridge_finalize_registry. On a live isolate this is a benign no-op; the test + // asserts it does not throw or wedge the isolate. (The crash it guards against + // -- fn_attach_thread on a NULL or TEARDOWN_TEARING_DOWN isolate -- only arises + // when destroyEngine races a concurrent cleanup() teardown, a non-deterministic + // cross-thread window not reproducible through this single-threaded public API; + // see this file's note above on best-effort race coverage.) + expect(() => ffi.destroyEngine(UNKNOWN_HANDLE)).not.toThrow(); + + // Double-destroy: the second call finds no record and takes the same + // else branch. Must not throw or corrupt the isolate. + const handle = ffi.createEngine(); + expect(() => ffi.destroyEngine(handle)).not.toThrow(); + expect(() => ffi.destroyEngine(handle)).not.toThrow(); + + // Isolate remains fully usable after both no-op destroys. + const h2 = ffi.createEngine(); + const envelope = JSON.parse( + ffi.runScriptEngine(h2, "%dw 2.0\noutput application/json\n---\n3 + 4", buildInputsJson({})) + ); + expect(envelope.success).toBe(true); + expect(JSON.parse(Buffer.from(envelope.result, "base64").toString("utf-8"))).toBe(7); + ffi.destroyEngine(h2); + }); + + it("final cleanup drains the shared isolate (idempotent)", async () => { + // Exactly one ffi.initialize() ran for this whole file (beforeAll), so + // this is the ONE balancing ffi.cleanup() that brings the native + // g_ref_count to zero and genuinely tears the isolate down (napi_cleanup + // Case 4, since no op is in flight) -- not a no-op decrement of a + // still-positive count left over from other tests. Prove that teardown + // actually happened, not just that the call resolved: a subsequent + // engine-level call must now observe "not initialized" rather than + // silently succeeding against a still-live isolate. + await ffi.cleanup(); + + expect(() => + ffi.runScriptEngine(UNKNOWN_HANDLE, "%dw 2.0\noutput application/json\n---\n1", buildInputsJson({})) + ).toThrow(/not initialized/i); + + // review #10 #5: with the isolate torn down (g_isolate == NULL, + // g_initialized == 0), destroyEngine on an unknown handle must be a safe + // no-op and must NOT attach to the now-NULL global isolate -- it returns + // early at the !g_initialized guard. The process must survive. + expect(() => ffi.destroyEngine(UNKNOWN_HANDLE)).not.toThrow(); + + // A second cleanup() call after the ref count already reached zero must + // remain a safe no-op, mirroring independent-engines.test.ts's final + // teardown discipline. + await expect(ffi.cleanup()).resolves.toBeUndefined(); + }); +}); diff --git a/native-lib/node/tests/integration/engine-strand-hook.test.ts b/native-lib/node/tests/integration/engine-strand-hook.test.ts new file mode 100644 index 00000000..6219973b --- /dev/null +++ b/native-lib/node/tests/integration/engine-strand-hook.test.ts @@ -0,0 +1,280 @@ +import { describe, it, expect, afterAll } from "vitest"; +import { Worker } from "node:worker_threads"; +import { join } from "node:path"; +import { findLibrary } from "../../src/utils"; + +// W-23692110 PR #157 reviews #12 #3 / #13. +// +// napi_destroy_engine used to remove the env cleanup hook and THEN finalize. If +// the finalize took a live-isolate strand (fn_attach_thread failed while the +// isolate was still alive) the bridge was enqueued on g_stranded_bridges WITHOUT +// deleting resolver_js. drain_stranded_bridges() later runs off the owner thread +// and frees with env_still_alive=false -- SKIPPING napi_delete_reference -- so the +// resolver JS function leaked while the owner env was still alive. +// +// The fix keeps the napi_ref deletion owned by the owner-thread env cleanup hook +// whenever a strand happens on the owner thread with the env alive: the bridge is +// kept by its (still-registered) cleanup hook instead of being enqueued on +// g_stranded_bridges, so the ref is deleted on the owner thread at env teardown. +// +// These tests use the addon's test-only entrypoints (registered only when +// DATAWEAVE_TEST_HOOKS is set -- the integration lane sets it, see +// vitest.config.ts) to deterministically force a SINGLE live-isolate strand: +// - __test_forceStrandOnce(): arm one forced strand in the next +// bridge_finalize_registry (simulates the +// fn_attach_thread failure). +// - __test_strandedCount(): length of g_stranded_bridges. +// - __test_resolverRefDeleteCount(): process-wide count of owner-thread +// napi_delete_reference(resolver_js) calls. + +const ADDON_PATH = join(__dirname, "..", "..", "build", "Release", "dwlib_addon.node"); +const LIB_PATH = findLibrary(); + +interface TestAddon { + initialize(libPath: string): void; + createEngineWithResolver(resolver: (p: string) => string | null): number; + destroyEngine(handle: number): void; + runScriptStreamingEngine( + handle: number, + script: string, + inputsJson: string, + chunkCb: (chunk: Buffer) => void + ): Promise; + cleanup(): Promise; + __test_forceStrandOnce(): void; + __test_strandedCount(): number; + __test_resolverRefDeleteCount(): number; +} + +// eslint-disable-next-line @typescript-eslint/no-var-requires +const addon = require(ADDON_PATH) as TestAddon; + +describe("owner-env-hook-retained finalization for stranded resolver bridges (review #12 #3, #13)", () => { + afterAll(async () => { + // Balance any main-thread init reference this file took so it does not + // perturb sibling integration files sharing the vitest worker process. + await addon.cleanup(); + }); + + it("exposes the test-only strand hooks (integration lane sets DATAWEAVE_TEST_HOOKS)", () => { + // Guards against a silently-inert test: if the hooks were not registered the + // strand assertions below would all trivially pass with 0-deltas. + expect(typeof addon.__test_forceStrandOnce).toBe("function"); + expect(typeof addon.__test_strandedCount).toBe("function"); + expect(typeof addon.__test_resolverRefDeleteCount).toBe("function"); + }); + + it( + "a live-isolate strand during destroyEngine keeps the resolver bridge owned by its env cleanup hook, NOT on g_stranded_bridges", + async () => { + addon.initialize(LIB_PATH); + try { + const strandedBefore = addon.__test_strandedCount(); + + const handle = addon.createEngineWithResolver((_p) => null); + // Arm exactly one forced strand: the next bridge_finalize_registry (the + // one inside this destroyEngine) reports the destroy as skipped with the + // isolate still live -- the exact fault the finding is about. + addon.__test_forceStrandOnce(); + expect(() => addon.destroyEngine(handle)).not.toThrow(); + + const strandedAfter = addon.__test_strandedCount(); + // POST-FIX: the strand is kept by the owner-env cleanup hook, so the + // bridge is NOT enqueued on g_stranded_bridges (delta 0). PRE-FIX: the + // bridge was stranded (delta 1) with resolver_js left undeleted, and the + // hook had already been removed -> the ref would leak. + expect(strandedAfter - strandedBefore).toBe(0); + } finally { + // Release this test's init reference. The kept-hook bridge is finalized + // (ref deleted, record freed) by the main env's cleanup hook at process + // teardown; the isolate teardown here makes that a safe no-op registry + // removal. + await addon.cleanup(); + } + } + ); + + it( + "a strand in a Worker that then exits deletes the resolver ref on the owner thread (not leaked, not drained undeleted)", + async () => { + // Main thread holds an init reference so the shared isolate stays live + // while the Worker's env tears down -- the Worker's env cleanup hook needs a + // live isolate to remove the Java registry entry, and (post-fix) to delete + // resolver_js on the Worker's owner thread. + addon.initialize(LIB_PATH); + try { + const deletesBefore = addon.__test_resolverRefDeleteCount(); + + const body = ` + const { parentPort, workerData } = require('node:worker_threads'); + const addon = require(workerData.addonPath); + addon.initialize(workerData.libPath); // this env's own init reference + const handle = addon.createEngineWithResolver((p) => null); + addon.__test_forceStrandOnce(); + addon.destroyEngine(handle); + // Report the stranded-list delta observed on the Worker thread right + // after the forced strand, then return WITHOUT cleanup() so the env + // cleanup hook fires as this Worker env tears down (post-fix: deletes + // resolver_js on THIS owner thread). + parentPort.postMessage({ strandedCount: addon.__test_strandedCount() }); + `; + const workerMsg = await new Promise<{ strandedCount: number }>((resolve, reject) => { + const w = new Worker(body, { + eval: true, + workerData: { addonPath: ADDON_PATH, libPath: LIB_PATH }, + }); + let msg: { strandedCount: number } | undefined; + w.once("message", (m) => { msg = m; }); + w.once("error", reject); + // Wait for EXIT (not just the message) so the Worker env's cleanup hooks + // have run before we read the process-wide delete counter. + w.once("exit", (code) => { + if (code !== 0) reject(new Error("Worker exited with code " + code + (msg ? "" : " and posted no message"))); + else if (msg === undefined) reject(new Error("Worker exited 0 without posting a result")); + else resolve(msg); + }); + }); + + // POST-FIX: the Worker's strand was kept by its cleanup hook (not stranded). + expect(workerMsg.strandedCount).toBe(0); + + const deletesAfter = addon.__test_resolverRefDeleteCount(); + // POST-FIX: the Worker's env cleanup hook deleted resolver_js on the + // Worker's owner thread at env teardown -> exactly one net delete. + // PRE-FIX: destroyEngine removed the hook and stranded the bridge, so the + // off-thread drain freed it with env_still_alive=false -> 0 deletes (leak). + expect(deletesAfter - deletesBefore).toBe(1); + } finally { + await addon.cleanup(); + } + }, + 20000 + ); + + it( + "SMOKE (env alive): a deferred destroy with the op completing normally finalizes exactly once on the owner thread", + async () => { + // HONEST SCOPE (round-2): this is a happy-path SMOKE test, NOT a regression + // guard for the defer-branch double-owner fix. It runs on the main thread and + // lets the op complete with the env alive, so bridge_end_op runs with + // env_still_alive=TRUE and bridge_finalize's FREE path removes the hook itself + // regardless of whether destroyEngine's defer branch removed it -- so it + // passes with OR without the b06b917 defer-branch hook-removal and cannot + // catch that regression. The double-owner UAF only manifests when + // env_still_alive=FALSE (env torn down mid-flight); that path is exercised by + // the Worker test below. What this does verify: the defer path (in_flight>0 at + // destroy time; round-11 pin taken atomically at admission) drains cleanly, + // finalizes exactly once (resolver_js deleted delta 1 -- not 0=leak, not + // 2=double finalize), and never strands. + addon.initialize(LIB_PATH); + try { + const deletesBefore = addon.__test_resolverRefDeleteCount(); + const strandedBefore = addon.__test_strandedCount(); + + const handle = addon.createEngineWithResolver((_p) => null); + const chunks: Buffer[] = []; + const resultPromise = addon.runScriptStreamingEngine( + handle, + "%dw 2.0\noutput application/json\n---\n[1, 2, 3]", + "{}", + (chunk) => chunks.push(chunk) + ); + // Fire destroy synchronously after admission -> defer path (in_flight==1). + expect(() => addon.destroyEngine(handle)).not.toThrow(); + const raw = await resultPromise; + // Pin held at admission -> the op completes successfully. + expect(JSON.parse(raw).success).toBe(true); + + const deletesAfter = addon.__test_resolverRefDeleteCount(); + const strandedAfter = addon.__test_strandedCount(); + expect(strandedAfter - strandedBefore).toBe(0); + expect(deletesAfter - deletesBefore).toBe(1); + } finally { + await addon.cleanup(); + } + }, + 20000 + ); + + it( + "ROBUSTNESS (defer then Worker terminate mid-flight): the shared isolate/native state survives; state stays consistent", + async () => { + // HONEST SCOPE (round-2): this exercises the defer-then-terminate lifecycle + // safely, but it is NOT a regression guard for the b06b917 defer-branch + // hook-removal fix -- it passes WITH and WITHOUT that fix (verified: see the + // report round-2 section for the empirical revert-check). It cannot open the + // double-owner window because that window requires bridge_end_op to run with + // env_still_alive=FALSE and take its FREE path (which skips the env-gated hook + // removal) so a still-registered hook then fires on the freed bridge. Reaching + // that free needs EITHER: + // (1) the background compute thread still running at teardown so its sentinel + // enqueue returns napi_closing and it runs bridge_end_op(false) itself -- + // but that is an orphaned GraalVM-attached thread which aborts the process + // (SIGABRT) on completion, independent of the hook (see report); OR + // (2) Node draining the queued completion sentinel with env==NULL on the JS + // thread at teardown -- but worker.terminate() DROPS the queued + // threadsafe-function callback rather than draining it, so bridge_end_op + // never runs, in_flight stays pinned, and bridge_env_cleanup hits its + // in_flight>0 branch (addon.c ~L562) which DEFERS instead of freeing -- + // no free, no UAF, with or without the fix. + // So the env_still_alive=FALSE FREE-then-hook-fire window is not reachable from + // JS here without the orthogonal orphaned-thread abort. This test therefore only + // asserts that the defer+terminate path leaves the shared isolate and native + // registry intact (a real UAF / double fn_destroy_engine that did not crash + // outright would corrupt them). The double-owner fix's correctness rests on the + // code review of the four invariants (see report), not on this test. + // + // The op uses a trivial fast script so the background thread finishes and + // DETACHES from the isolate well before terminate() -- avoiding the orphaned- + // thread abort of variant (1) above -- and the Worker blocks its JS event loop + // so the completion sentinel stays queued (never processed while alive). + const ITERATIONS = 10; + for (let i = 0; i < ITERATIONS; i++) { + const body = ` + const { parentPort, workerData } = require('node:worker_threads'); + const addon = require(workerData.addonPath); + addon.initialize(workerData.libPath); + const handle = addon.createEngineWithResolver((p) => null); + // Trivial op: the background compute thread finishes and detaches fast, + // then enqueues the completion sentinel (queued, not yet processed). + addon + .runScriptStreamingEngine(handle, "%dw 2.0\\noutput application/json\\n---\\n[1,2,3]", '{}', (c) => {}) + .then(() => {}, () => {}); + // destroyEngine synchronously after admission -> in_flight==1 -> DEFER. + addon.destroyEngine(handle); + parentPort.postMessage('deferred'); + // Block the JS event loop so the queued sentinel is NOT processed while + // the env is alive; the parent terminates us during this window. + const end = Date.now() + 500; while (Date.now() < end) {} + `; + const w = new Worker(body, { + eval: true, + workerData: { addonPath: ADDON_PATH, libPath: LIB_PATH }, + }); + const workerError = new Promise((_, reject) => w.once("error", reject)); + workerError.catch(() => {}); // avoid unhandled rejection if it fires post-settle + await Promise.race([ + new Promise((resolve) => w.once("message", (m) => { if (m === "deferred") resolve(); })), + workerError, + new Promise((_, reject) => setTimeout(() => reject(new Error("worker did not signal deferred in time")), 10000)), + ]); + // Small settle so the background thread has finished and DETACHED (sentinel + // queued) before we terminate -- terminate then lands after the isolate is + // no longer attached on the worker's compute thread (no orphaned thread). + await new Promise((r) => setTimeout(r, 100)); + const exitCode = await w.terminate(); + expect(typeof exitCode).toBe("number"); + } + + // Prove the shared isolate/native state survived every terminate: the main + // thread must still initialize + create + destroy an engine cleanly (a UAF or + // double fn_destroy_engine that did not crash outright would corrupt the + // registry/isolate and break this). + addon.initialize(LIB_PATH); + const h = addon.createEngineWithResolver((_p) => null); + expect(() => addon.destroyEngine(h)).not.toThrow(); + await addon.cleanup(); + }, + 60000 + ); +}); diff --git a/native-lib/node/tests/integration/env-init-ownership.test.ts b/native-lib/node/tests/integration/env-init-ownership.test.ts new file mode 100644 index 00000000..fe30aa90 --- /dev/null +++ b/native-lib/node/tests/integration/env-init-ownership.test.ts @@ -0,0 +1,94 @@ +import { describe, it, expect } from "vitest"; +import * as ffi from "../../src/ffi"; +import { findLibrary, buildInputsJson } from "../../src/utils"; + +// W-23692110 round 13 #5: the init reference is owned per napi_env, not per +// engine. These raw-ffi tests (no vi.mock) drive the addon boundary directly -- +// the exact surface the finding is about -- and use the ref-count proxy from +// instance-lifecycle.test.ts: after balancing to zero refs a raw engine call +// throws /not initialized/; while the isolate is live a run succeeds. +// +// IMPORTANT -- these are single-env SMOKE tests, NOT true #5 regression teeth. +// #5 is a CROSS-ENV bug: an abandoned/dying env with N engines under one +// initialize() firing N per-engine releases against the one reference it owns, +// or one env's cleanup()/env-death releasing a reference another env owns. Both +// require either a real dying env or two distinct napi_envs with asymmetric +// init/cleanup. Vitest runs these on the single main-thread env, so they cannot +// distinguish the fixed isolate from the pre-fix (buggy) one -- it was verified +// empirically that both cases below pass unchanged when rebuilt against the +// pre-round-13 addon (destroyEngine() never released the init ref in any +// revision, and the second cleanup() was already a no-op via the long-standing +// `if (g_ref_count > 0)` floor). They guard that the sanctioned single-env path +// still behaves (liveness + no double-decrement corruption); they do NOT prove +// #5 is fixed. The cross-env behavior that #5 is actually about -- an abandoned env with N +// engines under one initialize() -- is now pinned by the dedicated cross-env +// regression test in worker-lifecycle.test.ts ("a Worker that inits once + +// creates N engines + exits without cleanup() does NOT tear down the isolate +// under a live main engine"), which fails RED on the round-12 implementation +// and passes at round 13+. These single-env smoke tests remain as a fast guard +// on the sanctioned single-env liveness path. + +const LIB = findLibrary(); + +function runOn(handle: number, expr: string): unknown { + const envelope = JSON.parse( + ffi.runScriptEngine(handle, `%dw 2.0\noutput application/json\n---\n${expr}`, buildInputsJson({})) + ); + expect(envelope.success).toBe(true); + return JSON.parse(Buffer.from(envelope.result, "base64").toString("utf-8")); +} + +describe("per-env init-reference ownership -- single-env smoke tests (round 13 #5)", () => { + // Smoke test (NOT a #5 regression test -- see file header): destroyEngine() + // never released the init reference in any revision, so this held pre-fix too. + it("smoke: one initialize() + multiple engines stays live when a single engine is destroyed", () => { + ffi.initialize(LIB); // ONE init reference for this env + const h1 = ffi.createEngine(); + const h2 = ffi.createEngine(); + expect(runOn(h2, "6 * 7")).toBe(42); + + // Destroy one engine. The isolate reference belongs to initialize(), not to + // an engine, so the isolate must stay alive and h2 must still run. + ffi.destroyEngine(h1); + expect(runOn(h2, "1 + 1")).toBe(2); + + // Balance: destroy the other engine and release the single init reference. + ffi.destroyEngine(h2); + // eslint-disable-next-line @typescript-eslint/no-floating-promises + return ffi.cleanup().then(() => { + expect(() => + ffi.runScriptEngine(Number.MAX_SAFE_INTEGER, "%dw 2.0\noutput application/json\n---\n1", buildInputsJson({})) + ).toThrow(/not initialized/i); + }); + }); + + // Smoke test (NOT a #5 regression test -- see file header): the second + // cleanup() was already a no-op pre-fix via the `if (g_ref_count > 0)` floor, + // so with one env this passes on the buggy addon too. #5's gate protects the + // CROSS-env case (one env stealing another's reference), not observable here. + it("smoke: a second cleanup() on an env that owns no reference does not corrupt the count", async () => { + ffi.initialize(LIB); // init_refs = 1 + const h = ffi.createEngine(); + expect(runOn(h, "2 + 2")).toBe(4); + ffi.destroyEngine(h); + + // First cleanup releases this env's one reference -> isolate torn down. + await ffi.cleanup(); + // Second cleanup: this env's init_refs is already 0. Must be a no-op -- + // it must NOT drive g_ref_count negative or perturb a later isolate. + await ffi.cleanup(); + + // Prove the count was not corrupted: a fresh, fully-balanced init/run/cleanup + // cycle still nets to zero (a corrupted negative count would leave the next + // isolate un-torn-down and this final probe would NOT report not-initialized). + ffi.initialize(LIB); + const h2 = ffi.createEngine(); + expect(runOn(h2, "3 + 4")).toBe(7); + ffi.destroyEngine(h2); + await ffi.cleanup(); + + expect(() => + ffi.runScriptEngine(Number.MAX_SAFE_INTEGER, "%dw 2.0\noutput application/json\n---\n1", buildInputsJson({})) + ).toThrow(/not initialized/i); + }); +}); diff --git a/native-lib/node/tests/integration/first-resolver-wins.test.ts b/native-lib/node/tests/integration/first-resolver-wins.test.ts deleted file mode 100644 index 75e7da59..00000000 --- a/native-lib/node/tests/integration/first-resolver-wins.test.ts +++ /dev/null @@ -1,34 +0,0 @@ -// Verifies the process-wide "first resolver wins" behavior documented in -// docs/external-modules.md#multiple-resolvers-in-one-process and -// ScriptRuntime.setResolver(): once a DataWeave instance's resolver is -// installed on the native engine singleton, a second instance constructed -// with a *different* resolver in the same process never has its resolver -// installed. That's only observable when the second instance's resolver is -// the second one ever installed for the whole process, so — like -// init-bad-path.test.ts — this runs in a dedicated child process rather than -// in-lane, making it order- and pool-configuration-independent. -import { describe, it, expect } from "vitest"; -import { execFileSync } from "node:child_process"; -import { join } from "node:path"; -import { existsSync } from "node:fs"; - -const FIXTURE = join(__dirname, "fixtures", "first-resolver-wins.cjs"); -const DIST_ENTRY = join(__dirname, "..", "..", "dist", "index.js"); - -describe("first-resolver-wins (isolated process)", () => { - it("a second DataWeave instance's resolver is silently ignored in favor of the first", () => { - expect(existsSync(DIST_ENTRY), `built entry missing at ${DIST_ENTRY} — run \`npm run build:ts\``).toBe(true); - - // execFileSync throws on a non-zero exit, so a "wrong resolver won" / - // native-crash outcome in the child fails this test. A timeout is also - // required: execFileSync blocks synchronously with no way for Vitest to - // interrupt it, so a native deadlock in the child would otherwise hang - // the whole suite instead of failing this one test. - const stdout = execFileSync(process.execPath, [FIXTURE], { - encoding: "utf-8", - timeout: 30_000, - }); - - expect(stdout).toContain("OK:first-resolver-wins"); - }); -}); diff --git a/native-lib/node/tests/integration/fixtures/first-resolver-wins.cjs b/native-lib/node/tests/integration/fixtures/first-resolver-wins.cjs deleted file mode 100644 index 3dc2fd42..00000000 --- a/native-lib/node/tests/integration/fixtures/first-resolver-wins.cjs +++ /dev/null @@ -1,103 +0,0 @@ -// Child-process fixture for the first-resolver-wins regression test. -// -// Runs in a FRESH process (spawned by first-resolver-wins.test.ts) so the -// process-wide ScriptRuntime singleton in the native layer starts with no -// resolver installed (see ScriptRuntime.setResolver(): once any DataWeave -// instance's resolver is installed, every later instance's resolver is -// silently ignored — a warning is logged and the first resolver keeps being -// used). That behavior is only observable on the FIRST resolver installation -// of a process, so this fixture -- not an in-lane vitest test -- is the only -// reliable way to exercise it. -// -// Contract with the parent: -// - Requires the built CommonJS entry at ../../../dist/index.js. -// - Constructs dw1 with a resolver for 'first.dwl' and dw2 with a -// *different* resolver for 'second.dwl', then initializes both. -// - Runs a script through dw1 that imports 'first.dwl' to force-install -// dw1's resolver on the singleton engine (must succeed). -// - Runs a script through dw2 that imports 'second.dwl'. Per the singleton -// semantics, dw2's resolver is never installed, so this import must fail. -// - Runs a THIRD script, through dw2, that imports 'first.dwl' again and -// asserts it still returns "Hello World". This is the check that actually -// distinguishes "the first resolver remains active" from "custom -// resolution broke entirely after the first call" — the second script -// alone would fail identically under either explanation. -// - Always calls cleanup() on both instances via try/finally, so teardown -// is exercised even on failure, then exits naturally (no process.exit()). -// - Prints "OK:first-resolver-wins" when all three expectations hold, or -// "FAIL:" (with a non-zero exitCode) otherwise. A native crash -// surfaces as a non-zero signal exit, which the parent also treats as -// failure. -const path = require("node:path"); - -const { DataWeave, modulesFromMap } = require(path.join(__dirname, "..", "..", "..", "dist", "index.js")); - -const dw1 = new DataWeave({ - resolveModule: modulesFromMap({ - "first.dwl": '%dw 2.0\nfun greet(n: String) = "Hello " ++ n', - }), -}); - -const dw2 = new DataWeave({ - resolveModule: modulesFromMap({ - "second.dwl": '%dw 2.0\nfun shout(n: String) = n ++ "!"', - }), -}); - -let failure = null; - -try { - dw1.initialize(); - dw2.initialize(); - - const firstResult = dw1.run(` - %dw 2.0 - import first - output application/json - --- - first::greet("World") - `); - - if (!firstResult.success) { - failure = "first-resolver-did-not-resolve:" + firstResult.error; - } else { - const secondResult = dw2.run(` - %dw 2.0 - import second - output application/json - --- - second::shout("hi") - `); - - if (secondResult.success) { - failure = "second-resolver-unexpectedly-won"; - } else { - // Prove the first resolver is still ACTIVE on dw2 (not merely that - // dw2's own resolver lost). A resolver that died entirely after the - // first call would also make second.dwl fail above -- this second - // check on dw2 is what actually distinguishes "first resolver wins" - // from "custom resolution stopped working after the first run". - const stillFirstResult = dw2.run(` - %dw 2.0 - import first - output application/json - --- - first::greet("World") - `); - - if (!stillFirstResult.success || JSON.parse(stillFirstResult.getString()) !== "Hello World") { - failure = "first-resolver-no-longer-active-on-dw2:" + (stillFirstResult.error || stillFirstResult.getString()); - } - } - } -} finally { - dw1.cleanup(); - dw2.cleanup(); -} - -if (failure) { - console.log("FAIL:" + failure); - process.exitCode = 1; -} else { - console.log("OK:first-resolver-wins"); -} diff --git a/native-lib/node/tests/integration/handle-validation.test.ts b/native-lib/node/tests/integration/handle-validation.test.ts new file mode 100644 index 00000000..2feddfb8 --- /dev/null +++ b/native-lib/node/tests/integration/handle-validation.test.ts @@ -0,0 +1,73 @@ +import { describe, it, expect, afterEach } from "vitest"; +import * as ffi from "../../src/ffi"; +import { findLibrary } from "../../src/utils"; + +// Round-6 finding #1 (defense-in-depth): the native handle-read sites +// (napi_get_value_int64 in napi_run_script_engine, +// napi_run_script_streaming_engine, napi_run_script_transform_engine) must +// reject a non-integer handle argument instead of silently using +// uninitialized/garbage stack data as the engine handle. +// +// This is driven through `ffi` (the raw addon boundary), not through the +// `DataWeave` class, because Task 1's JS-layer state guard only ever passes +// `this.engineHandle` (always a number once initialized) down to the native +// call -- so a bad handle can never reach these C sites through the public +// TS API. Each `ffi.xxx` export is a pure pass-through to the native addon +// (see src/ffi.ts: no validation of its own), so calling them directly with +// a non-numeric "handle" exercises the raw C boundary while reusing the same +// initialize()/findLibrary() bootstrap the other integration tests use. +// +// One test covers all three sites (rather than three separate tests) to keep +// the suite's test count increasing by exactly one for this task. +// +// Real addon, no mocking. +// +// The native addon globals (g_ref_count, g_initialized, etc.) are +// process-wide C statics -- vitest's per-file module isolation does NOT +// reset them. Every ffi.initialize() here must be balanced by a matching +// ffi.cleanup() so this file doesn't leak a ref-count bump into sibling +// integration test files sharing the same vitest worker process (mirrors +// admission-during-teardown.test.ts's care to drain/settle before the file +// ends, and instance-lifecycle.test.ts's afterEach cleanup pattern). +describe("native handle validation (round 6 #1)", () => { + afterEach(async () => { + await ffi.cleanup(); + }); + + it("runScriptEngine/runScriptStreamingEngine/runScriptTransformEngine all throw on a non-integer handle rather than using garbage", () => { + ffi.initialize(findLibrary()); + + // napi_get_value_int64 must fail (and be checked) for a non-numeric + // handle argument; each site must throw cleanly instead of proceeding + // with whatever `handle64` happened to contain on the stack. + expect(() => + ffi.runScriptEngine( + {} as unknown as number, + "%dw 2.0\noutput application/json\n---\n1", + "{}" + ) + ).toThrow(); + + expect(() => + ffi.runScriptStreamingEngine( + {} as unknown as number, + "%dw 2.0\noutput application/json\n---\n1", + "{}", + () => {} + ) + ).toThrow(); + + expect(() => + ffi.runScriptTransformEngine( + {} as unknown as number, + "output application/json\n---\npayload", + "{}", + "payload", + "application/json", + null, + () => null, + () => {} + ) + ).toThrow(); + }); +}); diff --git a/native-lib/node/tests/integration/independent-engines.test.ts b/native-lib/node/tests/integration/independent-engines.test.ts new file mode 100644 index 00000000..6dfdc7f9 --- /dev/null +++ b/native-lib/node/tests/integration/independent-engines.test.ts @@ -0,0 +1,108 @@ +import { describe, it, expect, afterAll } from "vitest"; +import { DataWeave, cleanup } from "../../src/dataweave"; +import { modulesFromMap } from "../../src/resolver"; + +const instances: DataWeave[] = []; +function tracked(...args: ConstructorParameters): DataWeave { + const dw = new DataWeave(...args); + instances.push(dw); + return dw; +} +afterAll(async () => { + for (const dw of instances) await dw.cleanup(); + await cleanup(); +}); + +const scriptImporting = (mod: string) => + `%dw 2.0\nimport org::test::${mod}\noutput application/json\n---\n${mod}::greet("X")`; + +describe("independent engines (W-23692110)", () => { + it("two instances resolve only their OWN module, with no cross-talk", () => { + const dwA = tracked({ resolveModule: modulesFromMap({ + "org/test/a.dwl": '%dw 2.0\nfun greet(n: String) = "A:" ++ n' }) }); + const dwB = tracked({ resolveModule: modulesFromMap({ + "org/test/b.dwl": '%dw 2.0\nfun greet(n: String) = "B:" ++ n' }) }); + dwA.initialize(); + dwB.initialize(); + + expect(JSON.parse(dwA.run(scriptImporting("a")).getString()!)).toBe("A:X"); + expect(JSON.parse(dwB.run(scriptImporting("b")).getString()!)).toBe("B:X"); + + // Each engine misses the other's module. + expect(dwA.run(scriptImporting("b")).success).toBe(false); + expect(dwB.run(scriptImporting("a")).success).toBe(false); + }); + + it("built-in modules resolve in a resolver-backed engine", () => { + const dw = tracked({ resolveModule: modulesFromMap({ "x.dwl": "..." }) }); + dw.initialize(); + const r = dw.run('%dw 2.0\nimport dw::core::Strings\noutput application/json\n---\nStrings::capitalize("hello")'); + expect(r.success).toBe(true); + expect(JSON.parse(r.getString()!)).toBe("Hello"); + }); + + // Carried forward from Task 3's review: runScriptEngine now returns "" (not + // a thrown error) for a NULL native result, pushing error interpretation + // entirely to parseNativeResponse() in this TS layer. A genuine script + // error (as opposed to a NULL/empty native response) must still surface as + // an ordinary unsuccessful ExecutionResult through the new handle-based + // path -- not an unhandled parse exception or process crash. + it("a genuine script error on a resolver-backed engine surfaces as success:false, not a throw", () => { + const dw = tracked({ resolveModule: modulesFromMap({ "x.dwl": "..." }) }); + dw.initialize(); + + let result: ReturnType | undefined; + expect(() => { result = dw.run("invalid_var_xyz"); }).not.toThrow(); + expect(result!.success).toBe(false); + expect(result!.error).toBeTruthy(); + }); + + // Confirms addon.c's argument-shifted runScriptStreamingEngine wiring (handle + // as first argument, per Task 3) actually threads the handle through to a + // real per-engine streaming run, not just the non-streaming run() path + // exercised above. Uses a built-in import (not a custom resolver module): + // runStreaming's native call executes on a background uv_thread whose + // identity differs from the engine's owner thread, so a resolver-backed + // engine fails closed for *custom* modules over streaming by design (see + // dataweave-resolver.test.ts) -- that's not what this test is checking. + it("runStreaming produces output on its own resolver-backed engine", async () => { + const dw = tracked({ resolveModule: modulesFromMap({ "x.dwl": "..." }) }); + dw.initialize(); + + const chunks: Buffer[] = []; + const gen = dw.runStreaming( + '%dw 2.0\nimport dw::core::Strings\noutput application/json\n---\nStrings::capitalize("stream")' + ); + let result = await gen.next(); + while (!result.done) { + chunks.push(result.value); + result = await gen.next(); + } + const metadata = result.value; + + expect(metadata.success).toBe(true); + expect(JSON.parse(Buffer.concat(chunks).toString("utf-8"))).toBe("Stream"); + }); + + // Confirms addon.c's argument-shifted runScriptTransformEngine wiring + // likewise threads the handle through to a real per-engine transform run. + it("runTransform produces output on its own resolver-backed engine", async () => { + const dw = tracked({ resolveModule: modulesFromMap({ "x.dwl": "..." }) }); + dw.initialize(); + + const inputData = [Buffer.from("[1, 2, 3]")]; + const script = "output application/json\n---\npayload map ($ * 10)"; + + const chunks: Buffer[] = []; + const gen = dw.runTransform(script, inputData, { mimeType: "application/json" }); + let result = await gen.next(); + while (!result.done) { + chunks.push(result.value); + result = await gen.next(); + } + const metadata = result.value; + + expect(metadata.success).toBe(true); + expect(JSON.parse(Buffer.concat(chunks).toString("utf-8"))).toEqual([10, 20, 30]); + }); +}); diff --git a/native-lib/node/tests/integration/instance-lifecycle.test.ts b/native-lib/node/tests/integration/instance-lifecycle.test.ts new file mode 100644 index 00000000..e644662e --- /dev/null +++ b/native-lib/node/tests/integration/instance-lifecycle.test.ts @@ -0,0 +1,239 @@ +import { describe, it, expect, afterEach } from "vitest"; +import { DataWeave, run, cleanup } from "../../src/dataweave"; +import { DataWeaveError } from "../../src/errors"; +import * as ffi from "../../src/ffi"; +import { findLibrary, buildInputsJson } from "../../src/utils"; + +// Same-instance lifecycle regression tests (round 6, W-23692110). Round 5's +// coverage used a second instance; the same-instance cleanup window is exactly +// what findings #1 and #3 exploit. Real addon, no mocking. +describe("instance lifecycle during cleanup (round 6)", () => { + let dw: DataWeave | undefined; + afterEach(async (ctx) => { + // Whatever state each test leaves it in, drain and release so the shared + // process-wide isolate is clean for sibling tests. + if (dw) { + const inst = dw; + dw = undefined; + let cleanupErr: unknown; + try { + await inst.cleanup(); + } catch (e) { + cleanupErr = e; + } + // A cleanup() failure is itself a real lifecycle regression: surface it + // when the test body PASSED. Suppress it only when the body already FAILED, + // so the original, more actionable assertion failure keeps propagating + // (review #9 #4; mirrors the worker-lifecycle balancing pattern). + if (cleanupErr !== undefined && ctx.task.result?.state !== "fail") { + throw cleanupErr; + } + } + }); + + // Finding #3: initialize() during the same instance's pending cleanup must + // reject deterministically, not be a silent no-op that leaves the instance + // uninitialized after cleanup settles. + it("initialize() during pending cleanup throws, and re-init works after cleanup settles", async () => { + dw = new DataWeave(); + dw.initialize(); + const closing = dw.cleanup(); // not awaited: instance is now "cleaning-up" + expect(() => dw!.initialize()).toThrow(DataWeaveError); + expect(() => dw!.initialize()).toThrow(/cleanup is in progress/i); + await closing; // now "uninitialized" + // Explicit re-init now succeeds and the instance is usable again. + dw.initialize(); + const r = dw.run("%dw 2.0\noutput application/json\n---\n1 + 1"); + expect(r.success).toBe(true); + expect(JSON.parse(r.getString()!)).toBe(2); + }); + + // Finding #1: run() during the cleanup window must throw a clean DataWeaveError + // (never send a null handle to C), because doCleanup() nulls engineHandle + // synchronously before awaiting native cleanup. + it("run() during pending cleanup throws DataWeaveError, not a native/null-handle error", async () => { + dw = new DataWeave(); + dw.initialize(); + const closing = dw.cleanup(); + expect(() => dw!.run("%dw 2.0\noutput application/json\n---\n1")).toThrow(DataWeaveError); + expect(() => dw!.run("%dw 2.0\noutput application/json\n---\n1")).toThrow(/cleaning up/i); + await closing; + }); + + // Finding #1, streaming/transform variants: the async generators must reject + // on first pull when started during the cleanup window. + it("runStreaming()/runTransform() during pending cleanup reject on first pull", async () => { + dw = new DataWeave(); + dw.initialize(); + const closing = dw.cleanup(); + + const sgen = dw.runStreaming("%dw 2.0\noutput application/json\n---\n[1,2,3]"); + await expect(sgen.next()).rejects.toThrow(DataWeaveError); + + const tgen = dw.runTransform( + "output application/json\n---\npayload", + [Buffer.from("[1,2,3]")], + { mimeType: "application/json" } + ); + await expect(tgen.next()).rejects.toThrow(DataWeaveError); + + await closing; + }); + + // Idempotency preserved: cleanup() before initialize() is a no-op; double + // cleanup() coalesces (round-4 F1 must survive this refactor). + it("cleanup() is a no-op when uninitialized and coalesces when called twice", async () => { + dw = new DataWeave(); + await expect(dw.cleanup()).resolves.toBeUndefined(); // uninitialized no-op + dw.initialize(); + const a = dw.cleanup(); + const b = dw.cleanup(); // must return the same in-flight settlement, one native teardown + await Promise.all([a, b]); + }); +}); + +// Round 12, Task 1: napi_cleanup's Case 1..5 decrement-and-teardown body was +// lifted verbatim into release_isolate_ref_locked() so a later task (round-12 +// #2) can reuse it from the abandoned-env path. This is a behavior-preserving +// refactor; this test pins the observable contract it must not disturb: the +// balancing cleanup() call that drops the ref count to zero must actually +// tear the isolate down synchronously, not leave it silently live. +// +// Driven through the raw `ffi` boundary (like handle-validation.test.ts and +// engine-handle-contract.test.ts), with a balanced initialize()/cleanup() +// pair, so this file doesn't leak a ref-count bump into sibling integration +// test files sharing the same vitest worker process. +describe("napi_cleanup refactor preserves last-release teardown (round 12 Task 1)", () => { + it("the balancing cleanup() actually tears the isolate down (subsequent engine call sees not-initialized)", async () => { + ffi.initialize(findLibrary()); + const h = ffi.createEngine(); + const envelope = JSON.parse( + ffi.runScriptEngine(h, "%dw 2.0\noutput application/json\n---\n1 + 1", buildInputsJson({})) + ); + expect(envelope.success).toBe(true); + expect(JSON.parse(Buffer.from(envelope.result, "base64").toString("utf-8"))).toBe(2); + ffi.destroyEngine(h); + await ffi.cleanup(); + // Ref count reached 0 and the isolate was torn down: a fresh engine call + // must observe "not initialized", not silently run on a live isolate. + expect(() => + ffi.runScriptEngine(Number.MAX_SAFE_INTEGER, "%dw 2.0\noutput application/json\n---\n1", buildInputsJson({})) + ).toThrow(/not initialized/i); + }); +}); + +// Round 12, Task 4: createChunkReader pre-buffers async inputs by awaiting +// the entire iterable up front (see reader.ts), because the native read +// callback is invoked synchronously and cannot await. That await can span +// arbitrarily long, so if the caller cleans up the instance while it's in +// flight, runTransform must re-check readiness on resume rather than +// dispatching to a nulled/destroyed engine handle. +describe("runTransform re-checks readiness after async input pre-buffering (round 12 Task 4)", () => { + it("throws a synchronous DataWeaveError if cleanup() runs during createChunkReader's await, instead of resolving an error envelope", async () => { + const dw = new DataWeave(); + dw.initialize(); + + // An async input whose iterator blocks until released, so cleanup() can + // run while createChunkReader is still pre-buffering it. + let release!: () => void; + const gate = new Promise((r) => { release = r; }); + async function* slowInput(): AsyncGenerator { + await gate; + yield Buffer.from("[1,2,3]"); + } + + const gen = dw.runTransform("%dw 2.0\noutput application/json\n---\npayload", slowInput(), { + mimeType: "application/json", + }); + + // Start driving the generator; it suspends awaiting createChunkReader -> + // slowInput's gate. + const firstNext = gen.next(); + // Clean up while the input is still pre-buffering. + await dw.cleanup(); + // Release the gate so createChunkReader's await resolves; the readiness + // re-check must now throw synchronously rather than proceeding to a + // nulled engine handle. + release(); + + await expect(firstNext).rejects.toBeInstanceOf(DataWeaveError); + }); +}); + +// Round 12, Task 6: the exported module-level cleanup() nulls globalInstance +// synchronously, then awaits instance.cleanup(). A second overlapping +// module-level cleanup() call must coalesce onto the SAME in-flight drain +// rather than seeing globalInstance already nulled and resolving immediately +// -- before the first call's native teardown actually finishes. +describe("module-level cleanup() coalescing (round 12 Task 6)", () => { + it("module-level cleanup() coalesces overlapping calls (round 12 #5)", async () => { + // Create the singleton. + expect(run("%dw 2.0\noutput application/json\n---\n1 + 1").success).toBe(true); + + let firstSettled = false; + const p1 = cleanup().then(() => { firstSettled = true; }); + // Second call overlaps the first's in-flight drain. + const p2 = cleanup(); + // The coalesced second call must not resolve before the first's drain does. + await p2; + expect(firstSettled).toBe(true); + await p1; + + // A subsequent run lazily revives the singleton (no wedged state). + expect(run("%dw 2.0\noutput application/json\n---\n2 + 2").success).toBe(true); + await cleanup(); + }); +}); + +// Final review round 12 #1: Task 6's coalescing guard (`if (cleanupPromise) +// return cleanupPromise;`) is unconditional, so a caller that revives the +// singleton (via run()) while an OLDER drain is still in flight gets the OLD +// drain's promise handed back by the newer cleanup() call -- the freshly +// revived instance is never hooked up to any doCleanup()/ffi.cleanup() call +// and its native ref leaks for the rest of the process. Pinned via the same +// ref-count proxy as the "napi_cleanup refactor" test above: after both +// cleanup() calls settle, the isolate's ref count must have actually returned +// to zero (not be left at 1 by a leaked, unrevived-then-abandoned instance). +describe("module-level cleanup() does not orphan a revived singleton (final review round 12 #1)", () => { + it("cleanup() started during an in-flight drain cleans the CURRENT (revived) singleton, not the stale one", async () => { + // (a) Create the singleton (instance A). + expect(run("%dw 2.0\noutput application/json\n---\n1 + 1").success).toBe(true); + + // (b) Start draining A WITHOUT awaiting. + const p1 = cleanup(); + + // (c) Revive a FRESH singleton (instance B) while A's drain is in flight. + expect(run("%dw 2.0\noutput application/json\n---\n2 + 2").success).toBe(true); + + // (d) Call cleanup() again. Under the bug this returns p1 verbatim, + // leaving B's native ref uncleaned once both promises settle. + const p2 = cleanup(); + await Promise.all([p1, p2]); + + // (e) Prove B was actually torn down via the isolate's ref count, the same + // technique as "napi_cleanup refactor preserves last-release teardown" + // above: do one extra balanced initialize()/cleanup() pair. If the ref + // count was already back to zero (both A and B cleaned), this nets back + // to zero and a subsequent raw engine call observes "not initialized". If + // B's ref instead leaked, the ref count is already >=1 going into this + // balanced pair, so it nets to >=1 afterward and the isolate stays alive + // -- the subsequent call would NOT report "not initialized". + ffi.initialize(findLibrary()); + const h = ffi.createEngine(); + const envelope = JSON.parse( + ffi.runScriptEngine(h, "%dw 2.0\noutput application/json\n---\n5 + 5", buildInputsJson({})) + ); + expect(envelope.success).toBe(true); + expect(JSON.parse(Buffer.from(envelope.result, "base64").toString("utf-8"))).toBe(10); + ffi.destroyEngine(h); + await ffi.cleanup(); // Balances the initialize() just above, ONLY. + + expect(() => + ffi.runScriptEngine(Number.MAX_SAFE_INTEGER, "%dw 2.0\noutput application/json\n---\n1", buildInputsJson({})) + ).toThrow(/not initialized/i); + + // The singleton revives cleanly again afterward -- no wedged module state. + expect(run("%dw 2.0\noutput application/json\n---\n3 + 3").success).toBe(true); + await cleanup(); + }); +}); diff --git a/native-lib/node/tests/integration/malformed-inputs.test.ts b/native-lib/node/tests/integration/malformed-inputs.test.ts new file mode 100644 index 00000000..5d565da0 --- /dev/null +++ b/native-lib/node/tests/integration/malformed-inputs.test.ts @@ -0,0 +1,132 @@ +import { describe, it, expect, afterEach } from "vitest"; +import * as ffi from "../../src/ffi"; +import { findLibrary, buildInputsJson } from "../../src/utils"; + +// Round-7 finding #2 (whole-class sweep): every FFI-facing entrypoint must +// check the status of each napi_get_value_* conversion and throw before using +// the converted value. Pre-fix, non-string script/inputs left *_len +// uninitialized before malloc(len+1) and the buffer write, and destroyEngine +// used an indeterminate handle64 from an ignored napi_get_value_int64. +// +// Driven through the raw `ffi` boundary (the DataWeave TS class always passes +// well-typed values), so these calls exercise the C conversion checks directly. +// The addon globals are process-wide C statics -- balance every initialize() +// with a cleanup() so this file does not leak a ref-count into siblings. +// +// Real addon, no mocking. +describe("malformed raw-ffi inputs throw (round 7 #2)", () => { + afterEach(async () => { + await ffi.cleanup(); + }); + + // Review #10 #5 (svacas P2): napi_initialize used to ignore the status of + // napi_get_cb_info and napi_get_value_string_utf8 and never checked that + // argv[0] is a string, so a non-string libPath left the 4096-byte stack + // lib_path buffer uninitialized before uv_dlopen used it. The TS wrapper + // always passes a string, so drive this through the raw ffi binding + // directly with each malformed shape and assert it throws synchronously + // (and the process survives) rather than reading the uninitialized buffer. + it.each([ + { name: "number", value: 42 }, + { name: "object", value: {} }, + { name: "null", value: null }, + ])("initialize throws synchronously on a non-string libPath ($name)", ({ value }) => { + // Assert on the specific validation message, not just toThrow(): without + // the argv[0] type check, the garbage stack lib_path still happens to + // make uv_dlopen fail downstream, so a bare toThrow() would pass even on + // the unfixed addon for the wrong reason (an accidental "Failed to load + // library" error instead of a synchronous, pre-buffer-use rejection). + expect(() => ffi.initialize(value as unknown as string)).toThrow( + /library path must be a string/ + ); + }); + + it("destroyEngine throws on a non-integer handle", () => { + ffi.initialize(findLibrary()); + expect(() => ffi.destroyEngine({} as unknown as number)).toThrow(); + }); + + it("runScriptEngine throws on non-string script/inputs", () => { + ffi.initialize(findLibrary()); + const handle = ffi.createEngine(); + expect(() => + ffi.runScriptEngine(handle, {} as unknown as string, buildInputsJson({})) + ).toThrow(); + expect(() => + ffi.runScriptEngine(handle, "%dw 2.0\n---\n1", {} as unknown as string) + ).toThrow(); + ffi.destroyEngine(handle); + }); + + it("runScriptStreamingEngine throws on non-string script/inputs", () => { + ffi.initialize(findLibrary()); + const handle = ffi.createEngine(); + expect(() => + ffi.runScriptStreamingEngine( + handle, + {} as unknown as string, + buildInputsJson({}), + () => {} + ) + ).toThrow(); + ffi.destroyEngine(handle); + }); + + it("runScriptStreamingEngine throws on non-string inputsJson", () => { + ffi.initialize(findLibrary()); + const handle = ffi.createEngine(); + expect(() => + ffi.runScriptStreamingEngine( + handle, + "%dw 2.0\noutput application/json\n---\n[1,2,3]", + {} as unknown as string, + () => {} + ) + ).toThrow(); + ffi.destroyEngine(handle); + }); + + it("runScriptTransformEngine throws on non-string script", () => { + ffi.initialize(findLibrary()); + const handle = ffi.createEngine(); + expect(() => + ffi.runScriptTransformEngine( + handle, + {} as unknown as string, + "{}", + "payload", + "application/json", + null, + () => null, + () => {} + ) + ).toThrow(); + ffi.destroyEngine(handle); + }); + + // The transform entrypoint converts four string args (script already covered + // above): inputsJson, inputName, inputMimeType, and a non-null inputCharset. + // A dropped napi_get_value_string check on any of them must throw (review #9 #6). + it.each([ + { name: "inputsJson", script: "%dw 2.0\noutput application/json\n---\npayload", inputsJson: {} as unknown as string, inputName: "payload", mimeType: "application/json", charset: null as string | null }, + { name: "inputName", script: "%dw 2.0\noutput application/json\n---\npayload", inputsJson: "{}", inputName: {} as unknown as string, mimeType: "application/json", charset: null as string | null }, + { name: "inputMimeType", script: "%dw 2.0\noutput application/json\n---\npayload", inputsJson: "{}", inputName: "payload", mimeType: {} as unknown as string, charset: null as string | null }, + { name: "non-null inputCharset", script: "%dw 2.0\noutput application/json\n---\npayload", inputsJson: "{}", inputName: "payload", mimeType: "application/json", charset: {} as unknown as string }, + ])("runScriptTransformEngine throws on non-string $name", ({ script, inputsJson, inputName, mimeType, charset }) => { + ffi.initialize(findLibrary()); + const handle = ffi.createEngine(); + expect(() => + ffi.runScriptTransformEngine( + handle, + script, + inputsJson, + inputName, + mimeType, + charset, + () => null, + () => {} + ) + ).toThrow(); + ffi.destroyEngine(handle); + }); +}); diff --git a/native-lib/node/tests/integration/run-admission.test.ts b/native-lib/node/tests/integration/run-admission.test.ts new file mode 100644 index 00000000..88dea6a2 --- /dev/null +++ b/native-lib/node/tests/integration/run-admission.test.ts @@ -0,0 +1,93 @@ +import { describe, it, expect } from "vitest"; +import * as ffi from "../../src/ffi"; +import { findLibrary, buildInputsJson } from "../../src/utils"; + +// Round-7 finding #1: the synchronous napi_run_script_engine touched the +// isolate (fn_attach_thread -> fn_run_script_engine -> fn_detach_thread) with +// only a top-of-function !g_initialized fast-path and NO g_active_ops +// reservation under g_mutex. A second Worker's last cleanup() (napi_cleanup +// Case 4) could observe g_active_ops == 0 and tear down g_isolate while this +// op was attaching/executing -- a use-after-free. +// +// The genuine cross-Worker TOCTOU is not reliably forceable from single-thread +// JS (same limitation the round-6 #2 admission-during-teardown test documents: +// re-init would trigger the adoption path and cancel the pending teardown +// before the admission check runs). What we CAN assert deterministically is +// the admission-rejection path the fix introduces: once a teardown is pending +// (g_teardown_state != TEARDOWN_NONE), a freshly started run() is rejected with +// a synchronous throw rather than attaching to an isolate a concurrent teardown +// could pull out from under it. The C-level reasoning -- check-and-reserve is +// now one atomic critical section on the run() path -- is what covers the race +// itself. +// +// We drive the addon through the raw `ffi` module (not the module-level +// singleton) so the second op runs against the SAME still-live handle/isolate +// with no intervening ffi.initialize() call to trigger adoption. Calling +// ffi.cleanup() directly triggers napi_cleanup Case 5 and sets +// g_teardown_state = TEARDOWN_PENDING_WAIT synchronously, before its Promise is +// returned; the immediately-following ffi.runScriptEngine re-enters native code +// synchronously on the same callstack and deterministically observes it. +// +// Real addon, no mocking. +describe("run() admission rejected while teardown pending (round 7 #1)", () => { + it("a synchronous run() started during pending teardown throws, not attach to a dead isolate", async () => { + ffi.initialize(findLibrary()); + const handle = ffi.createEngine(); + + // Keep one op in flight so the ref release becomes Case 5 (pending + // teardown) rather than Case 4 (immediate teardown): use a transform whose + // read callback triggers cleanup() and then attempts a run() on the same + // handle, all on the same synchronous callstack. + let cleanupPromise: Promise | undefined; + let runErr: unknown; + let ran = false; + + let firstRead = true; + const readCb = (_bufSize: number): Buffer | null => { + if (firstRead) { + firstRead = false; + // Case 5: last ref release with g_active_ops > 0 -> TEARDOWN_PENDING_WAIT, + // set synchronously before this returns. Not awaited. + cleanupPromise = ffi.cleanup(); + // Synchronous run() on the same still-live handle while teardown is + // pending. Fixed code rejects admission with a synchronous throw + // (g_teardown_state != TEARDOWN_NONE). Must be caught here -- it is a + // synchronous throw, not a rejected promise. Do not let it escape the + // native read-callback body. + try { + ffi.runScriptEngine( + handle, + "%dw 2.0\noutput application/json\n---\n1 + 1", + buildInputsJson({}) + ); + ran = true; + } catch (e) { + runErr = e; + } + return Buffer.from("[1,2,3]"); + } + return null; + }; + + const writeCb = (_chunk: Buffer) => {}; + + const resultRaw = await ffi.runScriptTransformEngine( + handle, + "output application/json\n---\npayload", + "{}", + "payload", + "application/json", + null, + readCb, + writeCb + ); + const result = JSON.parse(resultRaw); + expect(result.success).toBe(true); + + await cleanupPromise; + + // run() started while teardown was pending must have been rejected. + expect(runErr).toBeTruthy(); + expect(ran).toBe(false); + }, 20000); +}); diff --git a/native-lib/node/tests/integration/teardown-deadlock.test.ts b/native-lib/node/tests/integration/teardown-deadlock.test.ts new file mode 100644 index 00000000..efa44cec --- /dev/null +++ b/native-lib/node/tests/integration/teardown-deadlock.test.ts @@ -0,0 +1,120 @@ +import { describe, it, expect } from "vitest"; +import { run, runTransform, cleanup } from "../../src/dataweave"; + +// Regression test for W-23692110 round 5 (Task 1 fix in native-lib/node/src/addon.c). +// +// Bug: napi_initialize used to block the JS thread forever whenever it ran +// while a teardown was pending on the shared native isolate and a +// streaming/transform op was still active elsewhere -- because draining that +// active op can need the very same JS thread napi_initialize was blocking. +// The fix makes napi_initialize adopt the still-live isolate instead of +// waiting, in the window before the teardown waiter thread commits to +// physical teardown. +// +// This loads the REAL native addon (no `vi.mock` of ffi) -- the deadlock is +// entirely in C and cannot be reproduced at the mocked-ffi layer. +// +// Why runTransform (not runStreaming) drives this repro: runStreaming's +// output-chunk delivery uses an unbounded napi_threadsafe_function queue, and +// g_active_ops is decremented on the background worker thread right after it +// detaches from the isolate -- independent of whether the JS event loop ever +// turns. So a blocked JS thread does NOT stop a runStreaming() op from +// draining; there is no genuine circular wait on that path (verified +// empirically: the brief's originally-suggested runStreaming shape resolves +// promptly even against pre-Task-1 addon.c, because an earlier round already +// moved that decrement off the JS thread -- see commit ac8d520). +// +// runTransform's INPUT side is different: transform_read_cb (addon.c) calls +// napi_call_threadsafe_function(w->read_tsfn, &req, napi_tsfn_blocking) and +// then genuinely blocks the background worker thread on a condition variable +// until call_js_read runs on the JS thread and signals it. That JS-thread +// callback synchronously invokes our JS read callback (a plain +// Iterable consumed by a sync generator) via napi_call_function -- +// so firing cleanup() and a concurrent run() from *inside* that generator +// deterministically executes them while the background worker is attached +// and blocked waiting for this exact call to return. No timing assumptions +// (no setTimeout/microtask races) are needed: the call graph itself +// guarantees the ordering "worker attached and mid-read" -> "cleanup() +// fired" -> "run() fired", all on the JS thread, before the generator call +// returns and the worker can proceed. +describe("re-init during pending teardown (W-23692110, round 5 P1)", () => { + // On the UNFIXED addon.c this deadlocks for real: the JS thread never + // returns from run()'s napi_initialize (blocked waiting for g_active_ops to + // drain), so the background transform worker -- itself blocked waiting for + // the JS thread to service its read callback -- can never proceed either. + // Vitest kills the test at the timeout below, a bounded/deterministic red. + // On the fixed code, napi_initialize adopts the still-live isolate and + // run() returns promptly, letting everything drain normally. + it( + "module-level cleanup() during an active transform read does not deadlock a concurrent run()", + async () => { + let fired = false; + let cleanupPromise: Promise | undefined; + let runResult: ReturnType | undefined; + let runError: unknown; + + // Large enough that, at the moment of the very first read pull, the + // vast majority of reads (and thus the transform op) are still + // genuinely ahead -- not a timing-sensitive assumption, since the + // trigger below fires unconditionally on the first pull regardless of + // how many total reads there are. + const totalReads = 200000; + + function* input(): Generator { + for (let i = 0; i < totalReads; i++) { + if (!fired) { + fired = true; + // We are executing synchronously inside the native read + // callback (call_js_read in addon.c), on the JS thread, while + // the background transform worker thread is blocked inside + // transform_read_cb waiting for this exact call to return. + // Deliberately do NOT await cleanup() here, and do NOT let an + // assertion throw from inside this generator -- a thrown + // exception here would be caught by the native read-callback + // wrapper and reinterpreted as a read error, silently masking a + // real assertion failure instead of surfacing it as a test + // failure. Capture results and assert on them after the + // generator (and the transform) have fully drained. + cleanupPromise = cleanup(); + try { + runResult = run('%dw 2.0\noutput application/json\n---\n1 + 1'); + } catch (e) { + runError = e; + } + } + yield Buffer.from("x"); + } + } + + const gen = runTransform( + "output application/octet-stream\n---\npayload", + input(), + { mimeType: "application/octet-stream" } + ); + + // Drain the whole transform. On unfixed code, execution never reaches + // here: the trigger inside input() already froze the JS thread + // forever before the first read even returns. + let result = await gen.next(); + while (!result.done) { + result = await gen.next(); + } + + expect(fired).toBe(true); + expect(runError).toBeUndefined(); + expect(runResult?.success).toBe(true); + expect(JSON.parse(runResult!.getString()!)).toBe(2); + expect(result.value.success).toBe(true); + + // Let both the deferred teardown/cleanup and this test settle cleanly. + // This is essential: the process shares one native isolate across all + // integration test files, so leaving an unresolved cleanup here would + // perturb sibling test files. + await cleanupPromise; + // Idempotent final cleanup: a no-op if the singleton is already fully + // released, leaving the module in a clean state for subsequent tests. + await cleanup(); + }, + 20000 + ); +}); diff --git a/native-lib/node/tests/integration/worker-lifecycle.test.ts b/native-lib/node/tests/integration/worker-lifecycle.test.ts new file mode 100644 index 00000000..75772ca0 --- /dev/null +++ b/native-lib/node/tests/integration/worker-lifecycle.test.ts @@ -0,0 +1,337 @@ +import { describe, it, expect, afterAll } from "vitest"; +import { Worker } from "node:worker_threads"; +import { join } from "node:path"; +import * as ffi from "../../src/ffi"; +import { findLibrary, buildInputsJson } from "../../src/utils"; + +// W-23692110 round 12 #9: real worker_threads coverage for the documented +// per-Worker engine model (README "Custom module resolvers and Worker threads"). +// +// Workers cannot execute the TS sources (npm test runs vitest with no build for +// worker code, and a Worker spawns a fresh Node runtime), so each worker body is +// an inline JS string (eval:true) that require()s the BUILT addon directly -- +// the same raw-addon boundary engine-handle-contract.test.ts drives. addonPath +// and the dwlib path are resolved on the main thread and passed via workerData. +// +// Determinism posture: exact cross-thread teardown interleavings are NOT +// deterministically forceable (best-effort, matching rounds 5-11). The +// deterministic assertions here are: resolver-backed/less engines produce +// correct output inside a Worker, and after N Worker create/exit-without- +// cleanup() cycles the main thread still initializes/runs and the final +// teardown is clean (the round-12 #2 behavioral proof). + +const ADDON_PATH = join(__dirname, "..", "..", "build", "Release", "dwlib_addon.node"); +const LIB_PATH = findLibrary(); + +// Runs one Worker to completion and returns its posted message. `mode` selects +// resolver-backed vs resolver-less and whether the Worker cleans up or abandons. +function runWorker(opts: { + mode: "resolver" | "plain"; + cleanup: boolean; + script: string; +}): Promise<{ ok: boolean; output?: string; error?: string }> { + const body = ` + const { parentPort, workerData } = require('node:worker_threads'); + (async () => { + const addon = require(workerData.addonPath); + addon.initialize(workerData.libPath); + let handle; + if (workerData.mode === 'resolver') { + const resolver = (modulePath) => + modulePath === 'org/test/w.dwl' + ? '%dw 2.0\\nfun greet(n) = "W:" ++ n' + : null; + handle = addon.createEngineWithResolver(resolver); + } else { + handle = addon.createEngine(); + } + let msg; + try { + const raw = addon.runScriptEngine(handle, workerData.script, '{}'); + const parsed = JSON.parse(raw); + if (parsed.success === false) { + msg = { ok: false, error: parsed.error }; + } else { + // Non-streaming engine result carries base64 'result'; decode it. + const out = parsed.result ? Buffer.from(parsed.result, 'base64').toString('utf-8') : ''; + msg = { ok: true, output: out }; + } + } catch (e) { + msg = { ok: false, error: String(e) }; + } + if (workerData.cleanup) { + let destroyErr; + try { + addon.destroyEngine(handle); + } catch (e) { + destroyErr = e; // preserve; do NOT let cleanup() mask a broken destroy + } finally { + await addon.cleanup(); + } + if (destroyErr) msg = { ok: false, error: 'destroyEngine failed: ' + String(destroyErr) }; + } + parentPort.postMessage(msg); + // For the abandon variant we deliberately return WITHOUT cleanup so the + // env cleanup hook fires as the Worker env tears down. + })().catch((e) => { parentPort.postMessage({ ok: false, error: String(e) }); }); + `; + return new Promise((resolve, reject) => { + const w = new Worker(body, { + eval: true, + workerData: { addonPath: ADDON_PATH, libPath: LIB_PATH, mode: opts.mode, cleanup: opts.cleanup, script: opts.script }, + }); + let msg: { ok: boolean; output?: string; error?: string } | undefined; + w.once("message", (m) => { msg = m; }); + w.once("error", reject); + // Resolve only on a CLEAN exit that posted a result. A Worker can post a + // success message and THEN exit nonzero (e.g. an env-cleanup-hook failure + // during teardown) -- resolving on the message alone would hide that. So + // wait for exit: reject every nonzero code, and treat a zero exit with no + // posted message as its own diagnosable failure (round-14 #5). + w.once("exit", (code) => { + if (code !== 0) { + reject(new Error("Worker exited with code " + code + (msg ? "" : " and posted no message"))); + } else if (msg === undefined) { + reject(new Error("Worker exited 0 without posting a result")); + } else { + resolve(msg); + } + }); + }); +} + +describe("worker_threads engine lifecycle (round 12 #9)", () => { + afterAll(async () => { + // Final main-thread balancing cleanup so this file does not perturb sibling + // integration files sharing the vitest worker process. + await ffi.cleanup(); + }); + + it("a resolver-backed engine in a Worker resolves the Worker's own module", async () => { + const script = "%dw 2.0\nimport org::test::w\noutput application/json\n---\nw::greet(\"X\")"; + const msg = await runWorker({ mode: "resolver", cleanup: true, script }); + expect(msg.ok).toBe(true); + expect(JSON.parse(msg.output!)).toBe("W:X"); + }); + + it("a resolver-less engine in a Worker runs a plain script", async () => { + const script = "%dw 2.0\noutput application/json\n---\n6 * 7"; + const msg = await runWorker({ mode: "plain", cleanup: true, script }); + expect(msg.ok).toBe(true); + expect(JSON.parse(msg.output!)).toBe(42); + }); + + it("built-in modules resolve in a resolver-backed engine inside a Worker", async () => { + const script = + "%dw 2.0\nimport dw::core::Strings\noutput application/json\n---\nStrings::capitalize(\"hello\")"; + const msg = await runWorker({ mode: "resolver", cleanup: true, script }); + expect(msg.ok).toBe(true); + expect(JSON.parse(msg.output!)).toBe("Hello"); + }); + + it("N Workers that exit WITHOUT cleanup() do not wedge the isolate; main thread stays healthy (round 12 #2)", async () => { + const CYCLES = 5; + for (let i = 0; i < CYCLES; i++) { + const msg = await runWorker({ + mode: "resolver", + cleanup: false, // exit without cleanup -> env cleanup hook fires + script: "%dw 2.0\noutput application/json\n---\n" + i, + }); + expect(msg.ok).toBe(true); + } + // After all those abandoned Workers, the main thread must still initialize + // and run. Pre-fix, each abandoned Worker leaked its init reference and the + // isolate never returned to zero; the assertion here is behavioral (the + // process is not wedged and cleanup still tears down cleanly at afterAll). + ffi.initialize(LIB_PATH); + const h = ffi.createEngine(); + const envelope = JSON.parse( + ffi.runScriptEngine(h, "%dw 2.0\noutput application/json\n---\n1 + 1", buildInputsJson({})) + ); + expect(envelope.success).toBe(true); + expect(JSON.parse(Buffer.from(envelope.result, "base64").toString("utf-8"))).toBe(2); + ffi.destroyEngine(h); + await ffi.cleanup(); + // Prove this test INDEPENDENTLY that no abandoned Worker leaked its init + // reference: after the main thread balances its own reference to zero, a raw + // op must observe "not initialized". A leaked Worker reference would keep + // g_ref_count >= 1 here, so the isolate would still be live and this would + // NOT throw (review #9 #2). + expect(() => + ffi.runScriptEngine(Number.MAX_SAFE_INTEGER, "%dw 2.0\noutput application/json\n---\n1", buildInputsJson({})) + ).toThrow(/not initialized/i); + }); + + it("Worker.terminate() mid-life leaves the main thread able to initialize and run", async () => { + const body = ` + const { parentPort, workerData } = require('node:worker_threads'); + const addon = require(workerData.addonPath); + addon.initialize(workerData.libPath); + addon.createEngineWithResolver((p) => null); + // Signal readiness only once the engine is actually live, so the parent + // terminates a worker that genuinely has a live engine rather than + // racing a fixed sleep against initialize()/createEngineWithResolver on + // a possibly-loaded box (final review round 12 #3). + parentPort.postMessage('ready'); + // Spin so the parent can terminate() us mid-life (no message posted). + setInterval(() => {}, 10); + `; + const w = new Worker(body, { + eval: true, + workerData: { addonPath: ADDON_PATH, libPath: LIB_PATH }, + }); + // A throw in the worker body (e.g. a bad addon path) must fail this test + // cleanly rather than crash the vitest process -- the ad hoc Worker here, + // unlike runWorker() above, previously had no error listener wired up + // (final review round 12 #2). + const workerError = new Promise((_, reject) => w.once("error", reject)); + // Avoid an unhandled-rejection warning if "error" fires (or would fire) + // after the race below has already settled via the "ready" path. + workerError.catch(() => {}); + // Wait for the worker to report the engine is live, racing against a + // generous timeout so a slow box doesn't false-fail this test, then + // terminate abruptly. + const ready = new Promise((resolve) => w.once("message", (m) => { if (m === "ready") resolve(); })); + await Promise.race([ + ready, + workerError, + new Promise((_, reject) => setTimeout(() => reject(new Error("worker did not signal ready in time")), 10000)), + ]); + await w.terminate(); + + ffi.initialize(LIB_PATH); + const h = ffi.createEngine(); + const envelope = JSON.parse( + ffi.runScriptEngine(h, "%dw 2.0\noutput application/json\n---\n3 + 4", buildInputsJson({})) + ); + expect(envelope.success).toBe(true); + expect(JSON.parse(Buffer.from(envelope.result, "base64").toString("utf-8"))).toBe(7); + ffi.destroyEngine(h); + await ffi.cleanup(); + // Prove INDEPENDENTLY that the terminated Worker's engine reference was + // released: after the main thread balances its own reference, a raw op must + // observe "not initialized" (g_ref_count == 0). A leaked reference from the + // terminated Worker would leave the isolate live and this would NOT throw + // (review #9 #2). + expect(() => + ffi.runScriptEngine(Number.MAX_SAFE_INTEGER, "%dw 2.0\noutput application/json\n---\n1", buildInputsJson({})) + ).toThrow(/not initialized/i); + }); + + it("a Worker that inits once + creates N engines + exits without cleanup() does NOT tear down the isolate under a live main engine (round 13 #5)", async () => { + // This is the cross-env regression the round-13 smoke tests could not pin + // (env-init-ownership.test.ts is single-env). It fails RED on the round-12 + // implementation: the Worker's env death fired N per-engine init-reference + // releases against the ONE reference the Worker owned, driving g_ref_count to + // zero and tearing the shared isolate down under the live main engine -> the + // main engine's run below would fail (isolate gone) or the process wedges. On + // round-13+ each abandoned env releases exactly one reference regardless of + // engine count, so the main engine survives. + const N = 3; + + let hMain: number | null = null; + let bodySucceeded = false; + try { + // 1. Main thread: initialize and keep a live engine. + ffi.initialize(LIB_PATH); + hMain = ffi.createEngine(); + const first = JSON.parse( + ffi.runScriptEngine(hMain, "%dw 2.0\noutput application/json\n---\n6 * 7", buildInputsJson({})) + ); + expect(first.success).toBe(true); + expect(JSON.parse(Buffer.from(first.result, "base64").toString("utf-8"))).toBe(42); + + // 2. Worker: initialize ONCE, create N engines, run one, exit WITHOUT cleanup. + const workerBody = ` + const { parentPort, workerData } = require('node:worker_threads'); + (async () => { + const addon = require(workerData.addonPath); + addon.initialize(workerData.libPath); // ONE init reference for this env + const handles = []; + for (let i = 0; i < workerData.n; i++) handles.push(addon.createEngine()); + const raw = addon.runScriptEngine(handles[0], workerData.script, '{}'); + const parsed = JSON.parse(raw); + parentPort.postMessage({ ok: parsed.success !== false, count: handles.length }); + // Return WITHOUT destroyEngine/cleanup: the env dies with N engines under + // one init reference -> env_init_cleanup releases exactly ONE reference. + })().catch((e) => { parentPort.postMessage({ ok: false, error: String(e) }); }); + `; + const workerMsg = await new Promise<{ ok: boolean; count?: number; error?: string }>((resolve, reject) => { + const w = new Worker(workerBody, { + eval: true, + workerData: { + addonPath: ADDON_PATH, + libPath: LIB_PATH, + n: N, + script: "%dw 2.0\noutput application/json\n---\n1 + 1", + }, + }); + let msg: { ok: boolean; count?: number; error?: string } | undefined; + w.once("message", (m) => { msg = m; }); + w.once("error", reject); + // Wait for EXIT (not just message) so the Worker env's death hooks + // (env_init_cleanup) have run before we assert the main engine survived. + w.once("exit", (code) => { + if (code !== 0) reject(new Error("Worker exited with code " + code + (msg ? "" : " and posted no message"))); + else if (msg === undefined) reject(new Error("Worker exited 0 without posting a result")); + else resolve(msg); + }); + }); + expect(workerMsg.ok).toBe(true); + expect(workerMsg.count).toBe(N); + + // 3. The Worker abandoned N engines under one init reference and its env + // died. The main engine's reference must be intact and the isolate live. + const second = JSON.parse( + ffi.runScriptEngine(hMain, "%dw 2.0\noutput application/json\n---\n1 + 1", buildInputsJson({})) + ); + expect(second.success).toBe(true); + expect(JSON.parse(Buffer.from(second.result, "base64").toString("utf-8"))).toBe(2); + + // 4. Balance the main reference and prove the count reached exactly zero + // (no leak, no over-release): a raw op now throws "not initialized". + ffi.destroyEngine(hMain); + hMain = null; // destroyed; finally must not double-destroy + await ffi.cleanup(); + expect(() => + ffi.runScriptEngine(Number.MAX_SAFE_INTEGER, "%dw 2.0\noutput application/json\n---\n1", buildInputsJson({})) + ).toThrow(/not initialized/i); + bodySucceeded = true; + } finally { + // Balance global native state even if a Worker/assertion above threw, so + // this test cannot strand a live isolate + held reference for sibling + // integration tests (review #6 #7). Suppress a balancing-cleanup error + // ONLY when the body already failed (so the original, more actionable + // failure keeps propagating). When the body SUCCEEDED, a cleanup failure + // is itself a real lifecycle regression and must fail the test rather than + // be silently discarded (review #7 #7). + let destroyErr: unknown; + try { + if (hMain !== null) ffi.destroyEngine(hMain); + } catch (e) { + // Capture but do not early-exit: the global init reference must still be + // released below, or it contaminates sibling integration tests (review #8 + // #3), matching the production cleanup path that releases even when + // destroyEngine() throws. + destroyErr = e; + } + let cleanupErr: unknown; + try { + await ffi.cleanup(); + } catch (e) { + // Always attempt cleanup (never skipped by a destroyEngine throw), but + // capture its failure rather than letting it propagate unconditionally -- + // an already-failing body must keep its original, more actionable error. + cleanupErr = e; + } + // Surface a balancing failure (destroy or cleanup) ONLY when the body + // succeeded; when the body already failed, both are suppressed so the + // original failure keeps propagating (review #7 #7, extended to the + // destroyEngine() throw + cleanup() throw double-fault case). + if (bodySucceeded) { + if (destroyErr !== undefined) throw destroyErr; + if (cleanupErr !== undefined) throw cleanupErr; + } + } + }, 20000); +}); diff --git a/native-lib/node/tests/tck/ignore-list.ts b/native-lib/node/tests/tck/ignore-list.ts index e7598f56..d973f4cb 100644 --- a/native-lib/node/tests/tck/ignore-list.ts +++ b/native-lib/node/tests/tck/ignore-list.ts @@ -91,10 +91,10 @@ const LEGACY_IGNORED_CASES: Readonly> = { "multipart-binary-out.multipart": { reason: "multipart: boundary nondeterminism + binary part encoding" }, "multipart-class-cast-issue-out.multipart": { reason: "multipart: boundary nondeterminism" }, "multipart-empty-part-out.multipart": { reason: "multipart: boundary nondeterminism + empty part handling" }, - "multipart-mixed-message-out.multipart": { reason: "multipart: empty parts / structural" }, + "multipart-mixed-message-out.multipart": { reason: "multipart: execution fails — 'Multipart Object has empty `parts`' (see EXPECTED_EXECUTION_FAILURES, not a skip)" }, "multipart-write-binary-out.json": { reason: "multipart: binary part write" }, - "multipart-write-message-out.multipart": { reason: "multipart: empty parts / structural" }, - "multipart-write-subtype-override-out.multipart": { reason: "multipart: subtype override" }, + "multipart-write-message-out.multipart": { reason: "multipart: execution fails — 'Multipart Object has empty `parts`' (see EXPECTED_EXECUTION_FAILURES, not a skip)" }, + "multipart-write-subtype-override-out.multipart": { reason: "multipart: execution fails — 'Multipart Object has empty `parts`' (see EXPECTED_EXECUTION_FAILURES, not a skip)" }, // slow — passes but risks exceeding the 30s test timeout on CI "big_intersection-out.json": { reason: "slow: 500-way intersection type exceeds the test timeout" }, @@ -108,10 +108,10 @@ const LEGACY_IGNORED_CASES: Readonly> = { "properties-writer-out.properties": { reason: "nondeterministic: properties output embeds a timestamp comment" }, // coercion/runtime behavior (also CLI-ignored) - "access_raw_value-out.json": { reason: "coercion/runtime: Cannot coerce Null to String" }, + "access_raw_value-out.json": { reason: "coercion/runtime: execution fails — 'Cannot coerce Null to String' (see EXPECTED_EXECUTION_FAILURES, not a skip)" }, "csv-invalid-utf8-out.csv": { reason: "coercion/runtime: csv invalid utf8 handling" }, - "read-concat-out.json": { reason: "coercion/runtime: Cannot coerce Null to String" }, - "update-op-out.dwl": { reason: "coercion/runtime: Cannot coerce Null to Number" }, + "read-concat-out.json": { reason: "coercion/runtime: execution fails — 'Cannot coerce Null to String' (see EXPECTED_EXECUTION_FAILURES, not a skip)" }, + "update-op-out.dwl": { reason: "coercion/runtime: execution fails — 'Cannot coerce Null (null) to Number' (see EXPECTED_EXECUTION_FAILURES, not a skip)" }, // xml — attribute selector runtime behavior or serialization differences "multi_attribute_selector_after_empty_filter_slot-out.json": { reason: "xml: attribute selector runtime behavior" }, @@ -164,23 +164,17 @@ export const ACCEPTED_BASELINE_MISMATCHES: ExpectedFailurePolicy = { "core-modules/multipart-binary-out.multipart:out.multipart": "multipart writer output differs from the baseline fixture", "core-modules/multipart-class-cast-issue-out.multipart:out.multipart": "multipart writer output differs from the baseline fixture", "core-modules/multipart-empty-part-out.multipart:out.multipart": "multipart writer output differs from the baseline fixture", - "core-modules/multipart-mixed-message-out.multipart:out.multipart": "multipart writer output differs from the baseline fixture", - "core-modules/multipart-write-message-out.multipart:out.multipart": "multipart writer output differs from the baseline fixture", - "core-modules/multipart-write-subtype-override-out.multipart:out.multipart": "multipart writer output differs from the baseline fixture", "core-modules/properties-passthrough-out.properties:out.properties": "properties writer output differs from the baseline fixture", "core-modules/xml-escaped-data-out.xml:out.xml": "XML character escaping differs from the baseline fixture", "core-modules/xml-streaming-selectors-out.xml:out.xml": "streaming XML serialization differs from the baseline fixture", "core-modules/xml-value-selector-out.xml:out.xml": "XML namespace scoping differs from the baseline fixture", "core-modules/xml_empty_namespace-out.xml:out.xml": "empty XML namespace serialization differs from the baseline fixture", - "runtime/access_raw_value-out.json:out.json": "runtime coercion output differs from the baseline fixture", "runtime/coerciones_toString-out.json:out.json": "locale-sensitive runtime output differs from the baseline fixture", "runtime/properties-writer-out.properties:out.properties": "properties writer output differs from the baseline fixture", - "runtime/read-concat-out.json:out.json": "runtime coercion output differs from the baseline fixture", "runtime/runtime_dataFormatsDescriptors-out.json:out.json": "dw::Runtime output differs from the baseline fixture", "runtime/runtime_orElseTry-out.json:out.json": "source-location runtime output differs from the baseline fixture", "runtime/runtime_run-out.json:out.json": "dw::Runtime output differs from the baseline fixture", "runtime/try-recursive-call-out.json:out.json": "source-location runtime output differs from the baseline fixture", - "runtime/update-op-out.dwl:out.dwl": "runtime coercion output differs from the baseline fixture", }; export const REENABLED_CASES = [ @@ -192,10 +186,29 @@ export const REENABLED_CASES = [ "runtime/repeated_attribute_selector_map_slot_permutations-out.json", ] as const; +// Cases that are known to FAIL AT EXECUTION (not merely produce a mismatched +// output). These run — they are not skipped — and the harness asserts +// `result.success === false` plus a stable error-message discriminator, so a +// behavior recovery (fixed upstream) or a different failure (regression) both +// turn the case red instead of staying silently green under a skip. +export const EXPECTED_EXECUTION_FAILURES: Readonly> = { + "core-modules/multipart-mixed-message-out.multipart:out.multipart": { errorMatch: "Multipart Object has empty `parts`" }, + "core-modules/multipart-write-message-out.multipart:out.multipart": { errorMatch: "Multipart Object has empty `parts`" }, + "core-modules/multipart-write-subtype-override-out.multipart:out.multipart": { errorMatch: "Multipart Object has empty `parts`" }, + "runtime/access_raw_value-out.json:out.json": { errorMatch: "Cannot coerce Null to String" }, + "runtime/read-concat-out.json:out.json": { errorMatch: "Cannot coerce Null to String" }, + "runtime/update-op-out.dwl:out.dwl": { errorMatch: "Cannot coerce Null (null) to Number" }, +} as const; + +const EXPECTED_EXECUTION_FAILURE_CASES = new Set( + Object.keys(EXPECTED_EXECUTION_FAILURES).map((identifier) => identifier.slice(0, identifier.lastIndexOf(":"))) +); + export const CAPABILITY_EXCLUSIONS = Object.fromEntries( Object.entries(LEGACY_POLICY).filter(([identifier]) => !Object.keys(ACCEPTED_BASELINE_MISMATCHES).some((scenario) => scenario.startsWith(`${identifier}:`)) && !REENABLED_CASES.includes(identifier as typeof REENABLED_CASES[number]) + && !EXPECTED_EXECUTION_FAILURE_CASES.has(identifier) ) ); @@ -256,6 +269,7 @@ export function validateReconciledPolicy( expectedFailures: ExpectedFailurePolicy, reenabledCases: readonly string[] = [], runnableScenarios?: ReadonlySet, + expectedExecutionFailures: Readonly> = {}, ): string[] { const errors: string[] = []; const reenabledCounts = new Map(); @@ -276,9 +290,15 @@ export function validateReconciledPolicy( const expectedFailureCases = new Set( Object.keys(expectedFailures).map((identifier) => identifier.slice(0, identifier.lastIndexOf(":"))) ); + const execFailureCases = new Set( + Object.keys(expectedExecutionFailures).map((identifier) => identifier.slice(0, identifier.lastIndexOf(":"))) + ); errors.push(...[...reenabledCounts.keys()] .filter((identifier) => expectedFailureCases.has(identifier)) .map((identifier) => `${identifier}: case is both re-enabled and expected to fail`)); + errors.push(...[...reenabledCounts.keys()] + .filter((identifier) => execFailureCases.has(identifier)) + .map((identifier) => `${identifier}: case is both re-enabled and expected to fail execution`)); for (const [identifier, reason] of Object.entries(expectedFailures)) { if (!reason.trim()) errors.push(`${identifier}: missing expected-failure reason`); if (runnableScenarios && !runnableScenarios.has(identifier)) { @@ -288,6 +308,19 @@ export function validateReconciledPolicy( if (Object.prototype.hasOwnProperty.call(exclusions, caseIdentifier)) { errors.push(`${identifier}: case is both skipped and expected to fail`); } + if (execFailureCases.has(caseIdentifier)) { + errors.push(`${identifier}: case is both an output-mismatch xfail and an expected execution failure`); + } + } + for (const [identifier, entry] of Object.entries(expectedExecutionFailures)) { + if (!entry.errorMatch.trim()) errors.push(`${identifier}: missing errorMatch discriminator`); + if (runnableScenarios && !runnableScenarios.has(identifier)) { + errors.push(`${identifier}: not a discovered runnable scenario`); + } + const caseIdentifier = identifier.slice(0, identifier.lastIndexOf(":")); + if (Object.prototype.hasOwnProperty.call(exclusions, caseIdentifier)) { + errors.push(`${identifier}: case is both skipped and an expected execution failure`); + } } return errors.sort(); } @@ -316,3 +349,17 @@ export function isIgnored(caseIdentifier: string): boolean { export function ignoreReason(caseIdentifier: string): string | undefined { return IGNORED_CASES[caseIdentifier]?.reason; } + +/** + * Whether a scenario (full `/:` id) is a strict expected + * execution failure — it must run and fail with the returned discriminator, + * rather than being skipped. + */ +export function isExpectedExecutionFailure(scenarioId: string): { errorMatch: string } | undefined { + return EXPECTED_EXECUTION_FAILURES[scenarioId]; +} + +/** Whether a case identifier (`/`) has an expected execution failure scenario. */ +export function isExpectedExecutionFailureCase(caseIdentifier: string): boolean { + return EXPECTED_EXECUTION_FAILURE_CASES.has(caseIdentifier); +} diff --git a/native-lib/node/tests/tck/tck.test.ts b/native-lib/node/tests/tck/tck.test.ts index 9b4bee56..71d834c6 100644 --- a/native-lib/node/tests/tck/tck.test.ts +++ b/native-lib/node/tests/tck/tck.test.ts @@ -14,10 +14,13 @@ import { hasAdjacentDwlModule, parseCase, MAIN_TRANSFORM, type TckScenario } fro import { compareOutput } from "./compare"; import { ACCEPTED_BASELINE_MISMATCHES, + EXPECTED_EXECUTION_FAILURES, IGNORED_CASES, REENABLED_CASES, STRUCTURAL_MODULE_CASES, isIgnored, + isExpectedExecutionFailure, + isExpectedExecutionFailureCase, ignoreReason, validateIgnorePolicy, validateInventoryPolicy, @@ -27,6 +30,7 @@ import { const SUITES_DIR = join(__dirname, "suites"); const FIXTURES_DIR = join(__dirname, "fixtures"); +const REQUIRE_CORPUS = process.env.DATAWEAVE_TCK_REQUIRE_CORPUS === "1"; /** A discovered case: its directory and the scenarios parsed from it. */ interface DiscoveredCase { @@ -72,74 +76,137 @@ function discoverCases(): { return { cases, skipped, structuralModuleCases }; } +/** + * Registers a stand-in for the TCK suite when the corpus is missing/empty. + * In the dedicated CI job (DATAWEAVE_TCK_REQUIRE_CORPUS=1) this must be loud — + * a silent skip there would let the conformance lane go green with zero + * cases. Local dev without the flag keeps the quiet skip. + */ +function registerMissingCorpus(reason: string) { + if (REQUIRE_CORPUS) { + describe("TCK conformance", () => { + it("TCK corpus must be staged", () => { + throw new Error(`TCK corpus ${reason} but DATAWEAVE_TCK_REQUIRE_CORPUS=1 — stage it with stageTckSuites`); + }); + }); + } else { + describe.skip(`TCK conformance (corpus ${reason} — run stageTckSuites)`, () => { + it("skipped", () => {}); + }); + } +} + if (!existsSync(SUITES_DIR)) { // Corpus not staged — nothing to run in this lane. `npm run test:tck` on a - // checkout without the Gradle download is a no-op (passWithNoTests). - describe.skip("TCK conformance (corpus not staged — run stageTckSuites)", () => { - it("skipped", () => {}); - }); + // checkout without the Gradle download is a no-op (passWithNoTests), unless + // the dedicated CI job opted into DATAWEAVE_TCK_REQUIRE_CORPUS=1. + registerMissingCorpus("not staged"); } else { const { cases, skipped, structuralModuleCases } = discoverCases(); - const runnableCases = new Set(cases.map((item) => item.caseIdentifier)); - const runnableScenarios = new Set(cases.flatMap((item) => item.scenarios.map((scenario) => scenario.name))); - const policyErrors = [ - ...validateInventoryPolicy(cases.length, skipped), - ...validateIgnorePolicy(IGNORED_CASES, runnableCases), - ...validateReconciledPolicy(IGNORED_CASES, ACCEPTED_BASELINE_MISMATCHES, REENABLED_CASES, runnableScenarios), - ...validateStructuralModulePolicy(STRUCTURAL_MODULE_CASES, structuralModuleCases), - ]; - if (policyErrors.length > 0) { - throw new Error(`Invalid TCK policy:\n${policyErrors.join("\n")}`); - } + if (cases.length === 0) { + // Corpus directory exists but discovery found nothing runnable — same + // silent-green risk as the missing-directory case above. + registerMissingCorpus("empty"); + } else { + const runnableCases = new Set(cases.map((item) => item.caseIdentifier)); + const runnableScenarios = new Set(cases.flatMap((item) => item.scenarios.map((scenario) => scenario.name))); + const policyErrors = [ + ...validateInventoryPolicy(cases.length, skipped), + ...validateIgnorePolicy(IGNORED_CASES, runnableCases), + ...validateReconciledPolicy( + IGNORED_CASES, + ACCEPTED_BASELINE_MISMATCHES, + REENABLED_CASES, + runnableScenarios, + EXPECTED_EXECUTION_FAILURES, + ), + ...validateStructuralModulePolicy(STRUCTURAL_MODULE_CASES, structuralModuleCases), + ]; + if (policyErrors.length > 0) { + throw new Error(`Invalid TCK policy:\n${policyErrors.join("\n")}`); + } - // One shared runtime for the whole lane. Modules imported by a handful of - // TCK cases (org::mule::weave::v2::libs::lib) live only in the private - // data-weave runtime repo's test resources, not in any published - // artifact/TCK zip — resolve them from a committed fixture instead. - const dw = new DataWeave({ resolveModule: modulesFromDirectory(FIXTURES_DIR) }); + // One shared runtime for the whole lane. Modules imported by a handful of + // TCK cases (org::mule::weave::v2::libs::lib) live only in the private + // data-weave runtime repo's test resources, not in any published + // artifact/TCK zip — resolve them from a committed fixture instead. + const dw = new DataWeave({ resolveModule: modulesFromDirectory(FIXTURES_DIR) }); - describe("TCK conformance", () => { - // eslint-disable-next-line no-console - console.log( - `TCK: ${cases.length} runnable cases, ${skipped} structurally skipped, ` - + `${structuralModuleCases.size} structural module cases, ${Object.keys(IGNORED_CASES).length} exclusions, ` - + `${Object.keys(ACCEPTED_BASELINE_MISMATCHES).length} expected failures` - ); - dw.initialize(); + describe("TCK conformance", () => { + // eslint-disable-next-line no-console + console.log( + `TCK: ${cases.length} runnable cases, ${skipped} structurally skipped, ` + + `${structuralModuleCases.size} structural module cases, ${Object.keys(IGNORED_CASES).length} exclusions, ` + + `${Object.keys(ACCEPTED_BASELINE_MISMATCHES).length} expected output-mismatch failures, ` + + `${Object.keys(EXPECTED_EXECUTION_FAILURES).length} expected execution failures` + ); + dw.initialize(); - for (const c of cases) { - const ignored = isIgnored(c.caseIdentifier); - for (const scenario of c.scenarios) { - const expectedFailure = ACCEPTED_BASELINE_MISMATCHES[scenario.name]; - const testFn = ignored ? it.skip : expectedFailure ? it.fails : it; - const label = ignored - ? `${scenario.name} [skip: ${ignoreReason(c.caseIdentifier)}]` - : expectedFailure - ? `${scenario.name} [xfail: ${expectedFailure}]` - : scenario.name; - testFn(label, () => { - const script = readFileSync(join(c.dir, MAIN_TRANSFORM), "utf-8"); + for (const c of cases) { + // Cases with an expected execution failure must run — the harness + // asserts result.success === false plus a stable error discriminator + // for them, so they are never skipped even though they're also + // recorded in the legacy ignore registry for suite-routing purposes. + const ignored = isIgnored(c.caseIdentifier) && !isExpectedExecutionFailureCase(c.caseIdentifier); + for (const scenario of c.scenarios) { + const expectedFailure = ACCEPTED_BASELINE_MISMATCHES[scenario.name]; + const execFail = isExpectedExecutionFailure(scenario.name); + const testFn = ignored ? it.skip : it; + const label = ignored + ? `${scenario.name} [skip: ${ignoreReason(c.caseIdentifier)}]` + : execFail + // Reuse the "[xfail:" marker (not "[exec-xfail:") so the TCK + // accounting reporter's `scenarioIdentifier`/xfailed detection + // (tests/tck/reporter.ts), which only recognizes the literal + // "skip:"/"xfail:" prefixes, still classifies these correctly. + ? `${scenario.name} [xfail: execution failure: ${execFail.errorMatch}]` + : expectedFailure + ? `${scenario.name} [xfail: ${expectedFailure}]` + : scenario.name; + testFn(label, () => { + const script = readFileSync(join(c.dir, MAIN_TRANSFORM), "utf-8"); - const inputs = Object.fromEntries( - scenario.inputs.map((i) => [ - i.name, - { content: readFileSync(join(c.dir, i.fileName)), mimeType: i.mimeType }, - ]) - ); + const inputs = Object.fromEntries( + scenario.inputs.map((i) => [ + i.name, + { content: readFileSync(join(c.dir, i.fileName)), mimeType: i.mimeType }, + ]) + ); - const result = dw.run(script, inputs); - expect(result.success, `script failed: ${result.error}`).toBe(true); + const result = dw.run(script, inputs); - const actual = result.getBytes()!; - const expected = readFileSync(join(c.dir, scenario.outputFileName)); - const encodingFile = join(c.dir, "encoding"); - const charset = existsSync(encodingFile) - ? readFileSync(encodingFile, "utf-8").trim() - : null; - const cmp = compareOutput(scenario.outputExtension, actual, expected, charset); - expect(cmp.match, cmp.detail).toBe(true); - }); + if (execFail) { + expect( + result.success, + `${scenario.name}: expected execution failure but it succeeded — remove it from EXPECTED_EXECUTION_FAILURES` + ).toBe(false); + expect( + result.error ?? "", + `${scenario.name}: execution failed but error changed — update the errorMatch discriminator` + ).toContain(execFail.errorMatch); + return; + } + + expect(result.success, `script failed: ${result.error}`).toBe(true); + + const actual = result.getBytes()!; + const expected = readFileSync(join(c.dir, scenario.outputFileName)); + const encodingFile = join(c.dir, "encoding"); + const charset = existsSync(encodingFile) + ? readFileSync(encodingFile, "utf-8").trim() + : null; + const cmp = compareOutput(scenario.outputExtension, actual, expected, charset); + if (expectedFailure) { + expect( + cmp.match, + `expected baseline mismatch for ${scenario.name} ([xfail: ${expectedFailure}]) but output matched — remove it from ACCEPTED_BASELINE_MISMATCHES` + ).toBe(false); + } else { + expect(cmp.match, cmp.detail).toBe(true); + } + }); + } } - } - }); + }); + } } diff --git a/native-lib/node/tests/unit/dataweave-initialize.test.ts b/native-lib/node/tests/unit/dataweave-initialize.test.ts new file mode 100644 index 00000000..913ffcec --- /dev/null +++ b/native-lib/node/tests/unit/dataweave-initialize.test.ts @@ -0,0 +1,383 @@ +import { describe, it, expect, vi, beforeEach } from "vitest"; + +// Pure-logic test of DataWeave.initialize()'s lifecycle/error handling, with +// the native addon mocked out entirely -- no dwlib required (see the "unit" +// project in vitest.config.ts). This covers a ref-count leak that is only +// observable in the sequencing of calls into ffi.ts, not in any externally +// visible native state, so a real end-to-end native failure isn't a +// practical way to assert on it (see task-4-report.md's fix report for why). +vi.mock("../../src/ffi", () => ({ + initialize: vi.fn(), + createEngine: vi.fn(), + createEngineWithResolver: vi.fn(), + destroyEngine: vi.fn(), + runScriptEngine: vi.fn(), + runScriptStreamingEngine: vi.fn(), + runScriptTransformEngine: vi.fn(), + cleanup: vi.fn(), +})); + +import * as ffi from "../../src/ffi"; +import { DataWeave, run, cleanup } from "../../src/dataweave"; +import { DataWeaveError } from "../../src/errors"; + +describe("DataWeave.initialize() native ref-count safety", () => { + beforeEach(() => { + vi.mocked(ffi.initialize).mockReset(); + vi.mocked(ffi.createEngine).mockReset(); + vi.mocked(ffi.createEngineWithResolver).mockReset(); + vi.mocked(ffi.destroyEngine).mockReset(); + vi.mocked(ffi.cleanup).mockReset(); + }); + + it("releases the native library ref-count if engine creation fails after ffi.initialize() succeeded", () => { + vi.mocked(ffi.initialize).mockImplementation(() => {}); + vi.mocked(ffi.createEngineWithResolver).mockImplementation(() => { + throw new Error("native engine creation boom"); + }); + + const dw = new DataWeave({ libPath: "mock-lib-path", resolveModule: () => null }); + + expect(() => dw.initialize()).toThrow(DataWeaveError); + + // ffi.initialize() already succeeded, incrementing the native library's + // ref count. Since `initialized` never became true, cleanup()'s + // early-return guard means nothing else would ever call ffi.cleanup() -- + // initialize()'s own catch block must have released it. + expect(ffi.cleanup).toHaveBeenCalledTimes(1); + }); + + it("does not call ffi.cleanup() when ffi.initialize() itself is what fails", () => { + vi.mocked(ffi.initialize).mockImplementation(() => { + throw new Error("library not found"); + }); + + const dw = new DataWeave({ libPath: "mock-lib-path" }); + + expect(() => dw.initialize()).toThrow(DataWeaveError); + + // No ref count was ever acquired, so there is nothing to release. + expect(ffi.cleanup).not.toHaveBeenCalled(); + }); + + it("leaves engineHandle unset and the instance cleanly re-initializable after the failed attempt's rollback settles", async () => { + vi.mocked(ffi.initialize).mockImplementation(() => {}); + vi.mocked(ffi.createEngine) + .mockImplementationOnce(() => { + throw new Error("transient native failure"); + }) + .mockImplementationOnce(() => 42); + + const dw = new DataWeave({ libPath: "mock-lib-path" }); + + expect(() => dw.initialize()).toThrow(DataWeaveError); + expect(ffi.cleanup).toHaveBeenCalledTimes(1); + + // The rollback release is modeled as pending state (review #7 #3): until it + // settles the instance is "cleaning-up" and re-init is deliberately rejected + // rather than racing the in-flight release. Let the rollback settle first. + await new Promise((r) => setImmediate(r)); + + // A later initialize() call (e.g. once the transient failure clears) + // must succeed cleanly -- the failed attempt must not have left the + // instance permanently "half-initialized" (this.initialized stuck true + // without an engine handle, or vice versa). + vi.mocked(ffi.cleanup).mockClear(); + dw.initialize(); + expect(ffi.createEngine).toHaveBeenCalledTimes(2); + + await dw.cleanup(); + expect(ffi.destroyEngine).toHaveBeenCalledWith(42); + expect(ffi.cleanup).toHaveBeenCalledTimes(1); + }); + + it("does not call ffi.cleanup() from initialize() on the successful path", () => { + vi.mocked(ffi.initialize).mockImplementation(() => {}); + vi.mocked(ffi.createEngine).mockImplementation(() => 7); + + const dw = new DataWeave({ libPath: "mock-lib-path" }); + dw.initialize(); + + expect(ffi.cleanup).not.toHaveBeenCalled(); + + dw.cleanup(); + expect(ffi.destroyEngine).toHaveBeenCalledWith(7); + expect(ffi.cleanup).toHaveBeenCalledTimes(1); + }); + + it("still clears `initialized` when ffi.cleanup() rejects, so the instance is re-initializable", async () => { + vi.mocked(ffi.initialize).mockImplementation(() => {}); + vi.mocked(ffi.createEngine).mockImplementation(() => 7); + vi.mocked(ffi.cleanup).mockRejectedValueOnce(new Error("native cleanup boom")); + + const dw = new DataWeave({ libPath: "mock-lib-path" }); + dw.initialize(); + + await expect(dw.cleanup()).rejects.toThrow("native cleanup boom"); + + // Even though ffi.cleanup() rejected, the engine handle was already + // destroyed and nulled -- `initialized` must not stay stuck `true`, or a + // later initialize() call becomes a permanent no-op (the early-return + // guard `if (this.initialized) return;`) and the instance is stranded + // with a null engineHandle. + vi.mocked(ffi.initialize).mockClear(); + vi.mocked(ffi.createEngine).mockClear(); + vi.mocked(ffi.createEngine).mockImplementation(() => 9); + + dw.initialize(); + + expect(ffi.initialize).toHaveBeenCalledTimes(1); + expect(ffi.createEngine).toHaveBeenCalledTimes(1); + }); + + it("coalesces concurrent cleanup() calls into a single native teardown", async () => { + vi.mocked(ffi.createEngine).mockReturnValue(1); + let resolveNative!: () => void; + vi.mocked(ffi.cleanup).mockReturnValue( + new Promise((resolve) => { + resolveNative = resolve; + }) + ); + + const dw = new DataWeave("/fake/lib"); + dw.initialize(); + + // Two overlapping cleanup() calls while ffi.cleanup() is still pending. + const p1 = dw.cleanup(); + const p2 = dw.cleanup(); + resolveNative(); + await Promise.all([p1, p2]); + + // The native ref-count decrement (ffi.cleanup) and destroyEngine each run + // exactly once, not once per caller -- this is the double-decrement fix. + expect(ffi.cleanup).toHaveBeenCalledTimes(1); + expect(ffi.destroyEngine).toHaveBeenCalledTimes(1); + }); + + it("second overlapping cleanup() call awaits the SAME in-flight native teardown, not an early resolution", async () => { + // Regression test for task-1 fix round 1: doCleanup() flips `state` to + // "cleaning-up" synchronously as its first statement (an async function + // body runs synchronously up to its first await). If cleanup()'s + // not-ready guard (`if (this.state !== "ready") return;`) ran BEFORE the + // `cleanupPromise` coalescing check, a second overlapping call would see + // state already left "ready" and resolve immediately -- never actually + // awaiting the first call's in-flight native teardown. That would + // contradict cleanup()'s documented contract ("resolves once the + // underlying native isolate has actually finished tearing down") and + // silently regress round-4's coalescing timing. This test asserts the + // second call's promise has NOT settled while ffi.cleanup() is still + // pending, by racing it against a marker that only resolves after + // ffi.cleanup() is allowed to settle. + vi.mocked(ffi.createEngine).mockReturnValue(1); + let resolveNative!: () => void; + vi.mocked(ffi.cleanup).mockReturnValue( + new Promise((resolve) => { + resolveNative = resolve; + }) + ); + + const dw = new DataWeave("/fake/lib"); + dw.initialize(); + + const p1 = dw.cleanup(); + const p2 = dw.cleanup(); // overlaps while doCleanup() is in flight + + const SETTLED = Symbol("settled"); + const PENDING = Symbol("pending"); + // A same-tick race: if p2 resolved early (the regression), it wins; + // Promise.resolve() flushes on the same microtask queue, so this + // reliably distinguishes "already settled" from "still pending" without + // relying on real timers. + const raceResult = await Promise.race([ + p2.then(() => SETTLED), + Promise.resolve().then(() => PENDING), + ]); + expect(raceResult).toBe(PENDING); + + resolveNative(); + await Promise.all([p1, p2]); + + expect(ffi.cleanup).toHaveBeenCalledTimes(1); + expect(ffi.destroyEngine).toHaveBeenCalledTimes(1); + }); + + it("does not accumulate process exit listeners across init/cleanup cycles", async () => { + // The module-level `run`/`cleanup` convenience API drives the lazily + // created singleton through `getGlobalInstance()`, which is what + // registers the process-wide beforeExit/exit hooks (registerExitHooksOnce + // in src/dataweave.ts). Unlike the other tests in this file, this doesn't + // construct DataWeave directly, so it hits DataWeave's default + // `findLibrary()` lookup. Point DATAWEAVE_NATIVE_LIB at this test file + // (guaranteed to exist) so that lookup succeeds without depending on a + // real built dwlib -- ffi.initialize() is mocked, so the path's contents + // are never touched. + const prevEnvLib = process.env.DATAWEAVE_NATIVE_LIB; + process.env.DATAWEAVE_NATIVE_LIB = __filename; + try { + const before = process.listenerCount("exit") + process.listenerCount("beforeExit"); + // Drive several singleton create -> cleanup cycles via the module API. + for (let i = 0; i < 5; i++) { + run("%dw 2.0\noutput application/json\n---\n1 + 1"); // creates the singleton (+ hooks on first) + await cleanup(); // releases the singleton + } + const after = process.listenerCount("exit") + process.listenerCount("beforeExit"); + // Register-once: at most the single pair added on the very first create, + // never one pair per cycle. + expect(after - before).toBeLessThanOrEqual(2); + } finally { + if (prevEnvLib === undefined) delete process.env.DATAWEAVE_NATIVE_LIB; + else process.env.DATAWEAVE_NATIVE_LIB = prevEnvLib; + } + }); + + it("still calls ffi.cleanup() (releasing the native init reference) when destroyEngine() throws", async () => { + // Real path: wrong-thread destroyEngine() throws synchronously. If cleanup() + // skipped ffi.cleanup() on that throw, the native init reference for this env + // would leak and block isolate teardown. cleanup() must release it anyway and + // still surface the primary destruction error. + vi.mocked(ffi.initialize).mockImplementation(() => {}); + vi.mocked(ffi.createEngine).mockReturnValue(7); + vi.mocked(ffi.destroyEngine).mockImplementation(() => { + throw new Error("wrong-thread destroy boom"); + }); + vi.mocked(ffi.cleanup).mockResolvedValue(undefined); + + const dw = new DataWeave("/fake/lib"); + dw.initialize(); + + await expect(dw.cleanup()).rejects.toThrow("wrong-thread destroy boom"); + + // The native init reference was still released despite the destroy throw. + expect(ffi.cleanup).toHaveBeenCalledTimes(1); + + // The instance is not stranded "ready": a later initialize() works. + vi.mocked(ffi.destroyEngine).mockReset(); + vi.mocked(ffi.createEngine).mockReturnValue(9); + vi.mocked(ffi.createEngine).mockClear(); // ignore the first init's call + dw.initialize(); + // Prove the re-init genuinely created a fresh engine (not a no-op that + // false-passes toHaveBeenLastCalledWith because the FIRST init already + // called createEngine() with the same args -- review #6 #8). + expect(ffi.createEngine).toHaveBeenCalledTimes(1); + }); + + it("does not publish a poisoned singleton when the first module-level init fails", async () => { + // Isolate module state: a fresh import gives a null globalInstance so this + // test controls the very first getGlobalInstance() call. + vi.resetModules(); + const ffiMod = await import("../../src/ffi"); + const dwMod = await import("../../src/dataweave"); + + // First module-level run(): ffi.initialize() throws (e.g. bad lib path). + vi.mocked(ffiMod.initialize).mockImplementationOnce(() => { + throw new Error("library not found"); + }); + expect(() => dwMod.run("%dw 2.0\noutput application/json\n---\n1")).toThrow(); + + // The fault is corrected; the NEXT module-level run() must build a fresh, + // working singleton -- not reuse a poisoned, uninitialized one that fails + // "not initialized" forever (review #6 #1). + vi.mocked(ffiMod.initialize).mockImplementation(() => {}); + vi.mocked(ffiMod.createEngine).mockReturnValue(1); + vi.mocked(ffiMod.runScriptEngine).mockReturnValue( + JSON.stringify({ + success: true, + result: Buffer.from("1").toString("base64"), + mimeType: "application/json", + charset: "utf-8", + binary: false, + }) + ); + const result = dwMod.run("%dw 2.0\noutput application/json\n---\n1"); + expect(result.success).toBe(true); + }); + + it("gates re-initialization on the in-flight rollback when engine creation fails", async () => { + // Engine creation fails after ffi.initialize() succeeded. The rollback + // ffi.cleanup() is async; until it settles the instance must be in the + // "cleaning-up" state so a concurrent initialize() is rejected deterministically + // rather than racing a fresh isolate against the in-flight release (review #7 #3). + vi.mocked(ffi.initialize).mockImplementation(() => {}); + vi.mocked(ffi.createEngine).mockImplementation(() => { + throw new Error("native engine creation boom"); + }); + let resolveRollback!: () => void; + vi.mocked(ffi.cleanup).mockReturnValue( + new Promise((resolve) => { resolveRollback = resolve; }) + ); + + const dw = new DataWeave("/fake/lib"); + expect(() => dw.initialize()).toThrow(DataWeaveError); + + // Rollback is still in flight: a concurrent initialize() must be rejected, + // not allowed to race a fresh isolate against the pending native release. + expect(() => dw.initialize()).toThrow(/cleanup is in progress/i); + + // Once the rollback settles, the instance is cleanly re-initializable. + resolveRollback(); + await new Promise((r) => setImmediate(r)); // let the .finally run + vi.mocked(ffi.createEngine).mockReturnValue(5); + dw.initialize(); + dw.cleanup(); + expect(ffi.destroyEngine).toHaveBeenCalledWith(5); + }); + + it("does not emit an unhandled rejection when the rollback ffi.cleanup() rejects", async () => { + // The rollback release can itself reject; initialize() must observe it (via + // the stored cleanupPromise) so it never becomes an unhandledRejection, while + // still surfacing the ORIGINAL engine-creation error synchronously (review #7 #3). + vi.mocked(ffi.initialize).mockImplementation(() => {}); + vi.mocked(ffi.createEngine).mockImplementation(() => { + throw new Error("native engine creation boom"); + }); + vi.mocked(ffi.cleanup).mockRejectedValueOnce(new Error("rollback release boom")); + + const dw = new DataWeave("/fake/lib"); + expect(() => dw.initialize()).toThrow(/native engine creation boom/); + + // Give the rejected rollback promise a tick to settle; the .catch() attached + // in initialize() must have consumed it (no unhandledRejection), and the + // instance must be re-initializable afterward. + await new Promise((r) => setImmediate(r)); + // Clear so the assertion below proves the RETRY re-invoked createEngine, + // not the earlier failed attempt's stale no-arg call (review #9 #1). + vi.mocked(ffi.createEngine).mockClear(); + vi.mocked(ffi.createEngine).mockReturnValue(6); + dw.initialize(); + expect(ffi.createEngine).toHaveBeenCalledTimes(1); + expect(ffi.createEngine).toHaveBeenLastCalledWith(); + }); + + it("does not strand the instance in cleaning-up when the rollback ffi.cleanup() throws synchronously", async () => { + // ffi.cleanup() can fail SYNCHRONOUSLY (throw) rather than returning a + // rejected promise. The rollback must still settle its pending state and the + // instance must stay re-initializable; the ORIGINAL engine-creation error is + // what surfaces synchronously to this caller (review #8 #2). + vi.mocked(ffi.initialize).mockImplementation(() => {}); + vi.mocked(ffi.createEngine).mockImplementationOnce(() => { + throw new Error("native engine creation boom"); + }); + vi.mocked(ffi.cleanup).mockImplementationOnce(() => { + throw new Error("synchronous cleanup boom"); + }); + + const dw = new DataWeave("/fake/lib"); + // The synchronous throw to THIS caller is the ORIGINAL engine-creation error, + // not the cleanup throw. + expect(() => dw.initialize()).toThrow(/native engine creation boom/); + + // Let the deferred rollback settle; state must return to "uninitialized" so a + // later initialize() is not permanently rejected with "cleanup is in progress". + await new Promise((r) => setImmediate(r)); + // Clear so the assertion proves the retry actually re-invoked createEngine + // rather than passing on the failed attempt's stale call (review #9 #1). + vi.mocked(ffi.createEngine).mockClear(); + vi.mocked(ffi.createEngine).mockReturnValue(11); + dw.initialize(); + expect(ffi.createEngine).toHaveBeenCalledTimes(1); + expect(ffi.createEngine).toHaveBeenLastCalledWith(); + + await dw.cleanup(); + expect(ffi.destroyEngine).toHaveBeenCalledWith(11); + }); +}); diff --git a/native-lib/node/tests/unit/stream.test.ts b/native-lib/node/tests/unit/stream.test.ts index 46ca0e4a..ab6e3580 100644 --- a/native-lib/node/tests/unit/stream.test.ts +++ b/native-lib/node/tests/unit/stream.test.ts @@ -20,8 +20,9 @@ async function collect( function deferred() { let resolve!: (v: T) => void; - const promise = new Promise((res) => { resolve = res; }); - return { promise, resolve }; + let reject!: (e: unknown) => void; + const promise = new Promise((res, rej) => { resolve = res; reject = rej; }); + return { promise, resolve, reject }; } describe("streamFromNative", () => { @@ -95,4 +96,48 @@ describe("streamFromNative", () => { expect(result.success).toBe(false); expect(result.error).toBe("Empty response"); }); + + it("rejects a parked consumer when native start() rejects (no hang)", async () => { + const startGate = deferred(); + const gen = streamFromNative(() => startGate.promise); + + // Park a consumer in next() BEFORE the start promise settles: no chunk is + // ready and done is false, so next() awaits on pendingResolves. + const pending = gen.next(); + + // Now reject the native start. The parked consumer must be woken and see a + // rejection -- on the pre-fix code done never flips and this hangs forever. + startGate.reject(new Error("native start boom")); + + await expect(pending).rejects.toThrow("native start boom"); + }); + + it("drains buffered chunks, then throws, when start() rejects after pushing chunks", async () => { + const gen = streamFromNative((cb) => { + cb(Buffer.from("x")); + cb(Buffer.from("y")); + return Promise.reject(new Error("late boom")); + }); + + // Buffered chunks yield first... + const a = await gen.next(); + const b = await gen.next(); + expect([a.value?.toString(), b.value?.toString()]).toEqual(["x", "y"]); + + // ...then the drained generator surfaces the start error. + await expect(gen.next()).rejects.toThrow("late boom"); + }); + + it("propagates a native start() rejection of undefined instead of returning empty metadata", async () => { + // Promise.reject(undefined) is valid JS. The old value-sentinel + // (startError !== undefined) treated it as 'never rejected' and returned the + // normal empty-metadata result; a settlement-state flag must propagate it (review #7 #6). + const gen = streamFromNative(() => Promise.reject(undefined)); + await expect( + (async () => { + // Drain fully: iterate to completion so the post-drain re-throw runs. + for await (const _ of gen) { /* no chunks */ } + })() + ).rejects.toBeUndefined(); + }); }); \ No newline at end of file diff --git a/native-lib/node/tests/unit/tck-policy.test.ts b/native-lib/node/tests/unit/tck-policy.test.ts index 2838f9a1..dd8a799a 100644 --- a/native-lib/node/tests/unit/tck-policy.test.ts +++ b/native-lib/node/tests/unit/tck-policy.test.ts @@ -2,6 +2,7 @@ import { describe, expect, it } from "vitest"; import { ACCEPTED_BASELINE_MISMATCHES, CAPABILITY_EXCLUSIONS, + EXPECTED_EXECUTION_FAILURES, IGNORED_CASES, REENABLED_CASES, STRUCTURAL_MODULE_CASES, @@ -43,9 +44,10 @@ describe("TCK ignore policy", () => { ]); }); - it("reconciles exclusions into capability skips and strict xfails", () => { + it("reconciles exclusions into capability skips, strict xfails, and strict exec-xfails", () => { expect(Object.keys(CAPABILITY_EXCLUSIONS)).toHaveLength(32); - expect(Object.keys(ACCEPTED_BASELINE_MISMATCHES)).toHaveLength(21); + expect(Object.keys(ACCEPTED_BASELINE_MISMATCHES)).toHaveLength(15); + expect(Object.keys(EXPECTED_EXECUTION_FAILURES)).toHaveLength(6); expect(REENABLED_CASES).toHaveLength(6); expect(CAPABILITY_EXCLUSIONS).toHaveProperty("runtime/big_intersection-out.json"); expect(IGNORED_CASES).toBe(CAPABILITY_EXCLUSIONS); @@ -53,6 +55,8 @@ describe("TCK ignore policy", () => { CAPABILITY_EXCLUSIONS, ACCEPTED_BASELINE_MISMATCHES, REENABLED_CASES, + undefined, + EXPECTED_EXECUTION_FAILURES, )).toEqual([]); }); @@ -91,6 +95,27 @@ describe("TCK ignore policy", () => { "expected 193 structurally skipped cases, discovered 194", ]); }); + + const EXEC_FAILURE_TABLE = [ + ["core-modules/multipart-mixed-message-out.multipart:out.multipart", "Multipart Object has empty `parts`"], + ["core-modules/multipart-write-message-out.multipart:out.multipart", "Multipart Object has empty `parts`"], + ["core-modules/multipart-write-subtype-override-out.multipart:out.multipart", "Multipart Object has empty `parts`"], + ["runtime/access_raw_value-out.json:out.json", "Cannot coerce Null to String"], + ["runtime/read-concat-out.json:out.json", "Cannot coerce Null to String"], + ["runtime/update-op-out.dwl:out.dwl", "Cannot coerce Null (null) to Number"], + ] as const; + + it("has exactly the expected 6 execution-failure scenario identifiers", () => { + expect(Object.keys(EXPECTED_EXECUTION_FAILURES)).toEqual(EXEC_FAILURE_TABLE.map(([scenarioId]) => scenarioId)); + }); + + it.each(EXEC_FAILURE_TABLE)("classifies %s as a strict expected execution failure", (scenarioId, errorMatch) => { + expect(EXPECTED_EXECUTION_FAILURES).toHaveProperty([scenarioId]); + expect(EXPECTED_EXECUTION_FAILURES[scenarioId].errorMatch).toBe(errorMatch); + const caseId = scenarioId.slice(0, scenarioId.lastIndexOf(":")); + expect(CAPABILITY_EXCLUSIONS).not.toHaveProperty([caseId]); + expect(ACCEPTED_BASELINE_MISMATCHES).not.toHaveProperty([scenarioId]); + }); }); describe("TCK structural-module policy", () => { diff --git a/native-lib/node/vitest.config.ts b/native-lib/node/vitest.config.ts index 2a7b558d..9d0b7fc2 100644 --- a/native-lib/node/vitest.config.ts +++ b/native-lib/node/vitest.config.ts @@ -24,6 +24,13 @@ export default defineConfig({ name: "integration", include: ["tests/integration/**/*.test.ts"], testTimeout: 30000, + // Opt the integration lane into the addon's test-only entrypoints + // (__test_forceStrandOnce / __test_strandedCount / + // __test_resolverRefDeleteCount). Set before any integration worker + // loads the addon, so its Init() getenv() sees it and registers them; + // inert in every other lane and in production. Workers spawned by a + // test inherit this env, so the addon Init() in a worker sees it too. + env: { DATAWEAVE_TEST_HOOKS: "1" }, }, }, { diff --git a/native-lib/python/README.md b/native-lib/python/README.md index 1b4294c7..b3991679 100644 --- a/native-lib/python/README.md +++ b/native-lib/python/README.md @@ -204,11 +204,21 @@ source, credentials, and local paths are not exposed. Set `DATAWEAVE_RESOLVER_DEBUG=1` only in a trusted debugging environment to include the exception type, message, and traceback. -Each initialized explicit Python `DataWeave` instance owns a dedicated Graal -isolate. Its first resolver-backed run installs that instance's resolver; later -runs reuse it. The instance retains the resolver callback until successful -isolate teardown, then releases callback references during `cleanup()`. -Different live instances can therefore use different resolvers. +There is a single process-wide GraalVM isolate, reference-counted by the +number of live engines across all `DataWeave` instances; it is created on the +first engine and torn down when the last one is released (with a retryable +teardown fallback if that final teardown fails). Each `DataWeave` instance +owns its own handle-addressed engine within that shared isolate. Its first +resolver-backed run installs that instance's resolver; later runs reuse it. +The instance retains the resolver callback until its engine is destroyed, +then releases callback references during `cleanup()`. Different live +instances can therefore use different resolvers. + +### Custom module resolution scope + +- A `resolve_module` you configure applies to `run()`. +- Built-in modules (e.g. `dw::core::*`) resolve everywhere — `run()`, `run_streaming()`, `run_transform()`, and the low-level callback APIs. +- Custom modules do **not** resolve inside `run_streaming()`, `run_transform()`, or the low-level callback APIs: those execute on a background thread that must not call back into your resolver, so such a script fails closed (reports the module as not found) rather than making an unsafe cross-thread call. If you need a custom module in a streamed/transform/callback script, resolve it via `run()` instead, or inline the module into the script. ### Error Handling diff --git a/native-lib/python/src/dataweave/__init__.py b/native-lib/python/src/dataweave/__init__.py index a446621a..5168ab93 100644 --- a/native-lib/python/src/dataweave/__init__.py +++ b/native-lib/python/src/dataweave/__init__.py @@ -1,6 +1,7 @@ """Public facade for the DataWeave Python native binding.""" import ctypes +import threading from typing import Any, Dict, Iterable, Optional @@ -34,16 +35,19 @@ _global_instance: Optional[DataWeave] = None +_global_lock = threading.Lock() def _get_global_instance() -> DataWeave: global _global_instance - if _global_instance is None: - import atexit - _global_instance = DataWeave() - _global_instance.initialize() - atexit.register(cleanup) - return _global_instance + with _global_lock: + if _global_instance is None: + import atexit + candidate = DataWeave() + candidate.initialize() + _global_instance = candidate + atexit.register(cleanup) + return _global_instance def run(script: str, inputs: Optional[Dict[str, Any]] = None, raise_on_error: bool = False) -> ExecutionResult: @@ -68,9 +72,12 @@ def run_input_output_callback(script: str, input_name: str, input_mime_type: str def cleanup() -> None: global _global_instance - if _global_instance is not None: - _global_instance.cleanup() - _global_instance = None + with _global_lock: + if _global_instance is not None: + instance, _global_instance = _global_instance, None + else: + return + instance.cleanup() __all__ = [ diff --git a/native-lib/python/src/dataweave/models.py b/native-lib/python/src/dataweave/models.py index d5e90c9a..a44d1af3 100644 --- a/native-lib/python/src/dataweave/models.py +++ b/native-lib/python/src/dataweave/models.py @@ -30,8 +30,9 @@ class DataWeaveLibraryNotFoundError(Exception): WRITE_CALLBACK = ctypes.CFUNCTYPE(ctypes.c_int, ctypes.c_void_p, ctypes.c_void_p, ctypes.c_int) # int (*ReadCallback)(void *ctx, char *buffer, int bufferSize) READ_CALLBACK = ctypes.CFUNCTYPE(ctypes.c_int, ctypes.c_void_p, ctypes.c_void_p, ctypes.c_int) -# char *resolve_module(void *isolate_thread, const char *module_path) +# char *resolve_module(void *isolate_thread, void *ctx, const char *module_path) RESOLVE_MODULE_CALLBACK = ctypes.CFUNCTYPE( + ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p, ctypes.c_char_p, diff --git a/native-lib/python/src/dataweave/native.py b/native-lib/python/src/dataweave/native.py index d9d010d8..8ebc4298 100644 --- a/native-lib/python/src/dataweave/native.py +++ b/native-lib/python/src/dataweave/native.py @@ -3,7 +3,7 @@ import os from pathlib import Path import sys -from threading import current_thread, get_ident, Lock +from threading import get_ident, Lock import traceback from typing import Optional @@ -26,6 +26,259 @@ class graal_isolatethread_t(ctypes.Structure): GraalIsolateThreadPointer = ctypes.POINTER(graal_isolatethread_t) +# ── Process-wide shared isolate (one per process, N handle-addressed engines) ── +# All mutations happen under _isolate_lock. Invariant: _isolate_ref_count equals +# the number of live engines across all DataWeave instances, and _isolate is not +# None iff the count > 0. +_isolate_lock = Lock() +_lib = None +_lib_path = None +_isolate = None +_isolate_ref_count = 0 +# Set when a final graal_tear_down_isolate (or the attach immediately before +# it) failed. The isolate is still live in that case; teardown must be +# retried -- and must succeed -- before any new isolate is created. Mirrors +# Node's g_teardown_needed retryable-teardown model. Only read/written while +# holding _isolate_lock. +_teardown_needed = False +# When a bootstrap-thread detach AND the immediate teardown BOTH fail in +# _acquire_isolate, the isolate was NOT destroyed and the bootstrap thread is +# still attached. GraalVM teardown cannot succeed while it stays attached, so the +# retry must reuse THIS thread rather than attach a fresh worker (which could +# never tear down). None except across such a double-failure window. Guarded by +# _isolate_lock. +_pending_teardown_thread = None + + +# Per-engine resolver dispatch. The ctx passed to create_engine_with_resolver is +# a Python-allocated monotonic token (NOT the Java handle) so it is known before +# the engine exists -- no resolve callback can fire for an unregistered ctx. +_resolver_lock_global = Lock() +_resolver_registry = {} # token(int) -> NativeRuntime +_resolver_token_seq = 0 + + +def _next_resolver_token() -> int: + global _resolver_token_seq + with _resolver_lock_global: + _resolver_token_seq += 1 + return _resolver_token_seq + + +def _bind_abi(lib) -> None: + """Binds argtypes/restypes for the engine ABI and lifecycle exports (once).""" + for name in ("graal_create_isolate", "graal_attach_thread", "graal_detach_thread", + "graal_tear_down_isolate", "free_cstring", + "create_engine", "create_engine_with_resolver", "destroy_engine", + "run_script_engine", "run_script_callback_engine", + "run_script_input_output_callback_engine"): + if not hasattr(lib, name): + raise DataWeaveError(f"Native library does not export {name}") + + lib.graal_create_isolate.argtypes = [ + ctypes.c_void_p, + ctypes.POINTER(GraalIsolatePointer), + ctypes.POINTER(GraalIsolateThreadPointer), + ] + lib.graal_create_isolate.restype = ctypes.c_int + lib.graal_attach_thread.argtypes = [GraalIsolatePointer, ctypes.POINTER(GraalIsolateThreadPointer)] + lib.graal_attach_thread.restype = ctypes.c_int + lib.graal_detach_thread.argtypes = [GraalIsolateThreadPointer] + lib.graal_detach_thread.restype = ctypes.c_int + lib.graal_tear_down_isolate.argtypes = [GraalIsolateThreadPointer] + lib.graal_tear_down_isolate.restype = ctypes.c_int + lib.free_cstring.argtypes = [GraalIsolateThreadPointer, ctypes.c_void_p] + lib.free_cstring.restype = None + + lib.create_engine.argtypes = [GraalIsolateThreadPointer] + lib.create_engine.restype = ctypes.c_int64 + lib.create_engine_with_resolver.argtypes = [ + GraalIsolateThreadPointer, RESOLVE_MODULE_CALLBACK, ctypes.c_void_p, + ] + lib.create_engine_with_resolver.restype = ctypes.c_int64 + lib.destroy_engine.argtypes = [GraalIsolateThreadPointer, ctypes.c_int64] + lib.destroy_engine.restype = None + lib.run_script_engine.argtypes = [ + GraalIsolateThreadPointer, ctypes.c_int64, ctypes.c_char_p, ctypes.c_char_p, + ] + lib.run_script_engine.restype = ctypes.c_void_p + lib.run_script_callback_engine.argtypes = [ + GraalIsolateThreadPointer, ctypes.c_int64, ctypes.c_char_p, ctypes.c_char_p, + WRITE_CALLBACK, ctypes.c_void_p, + ] + lib.run_script_callback_engine.restype = ctypes.c_void_p + lib.run_script_input_output_callback_engine.argtypes = [ + GraalIsolateThreadPointer, ctypes.c_int64, ctypes.c_char_p, ctypes.c_char_p, + ctypes.c_char_p, ctypes.c_char_p, ctypes.c_char_p, + READ_CALLBACK, WRITE_CALLBACK, ctypes.c_void_p, + ] + lib.run_script_input_output_callback_engine.restype = ctypes.c_void_p + + +def _retry_pending_teardown_locked() -> None: + """If a prior final teardown failed, retry it now (caller holds _isolate_lock). + On success, clears the flag and nulls the isolate globals so the caller may + build fresh. On failure, leaves the isolate live and the flag armed, and + propagates the failure so the caller does not proceed to build a second, + racing isolate.""" + global _lib, _lib_path, _isolate, _teardown_needed, _pending_teardown_thread + if not _teardown_needed: + return + lib, isolate = _lib, _isolate + if _pending_teardown_thread is not None: + # Reuse the still-attached bootstrap thread from a prior double failure + # (bootstrap detach + immediate teardown both failed). Attaching a fresh + # worker would leave that thread attached and teardown could never + # succeed. Its detach already failed, so we must NOT detach it here. + worker = _pending_teardown_thread + attached_fresh = False + else: + worker = GraalIsolateThreadPointer() + if lib.graal_attach_thread(isolate, ctypes.byref(worker)) != 0: + raise DataWeaveError("Failed to attach thread to retry isolate teardown") + attached_fresh = True + try: + _tear_down(lib, worker) # raises on failure -> flag stays armed + except BaseException: + # Teardown failed again. If we attached a fresh worker, detach it (best- + # effort) so it does not stay attached and block the NEXT retry, which + # attaches its own fresh worker. If we reused the retained bootstrap + # thread, keep it retained -- its detach already failed and the isolate + # is still live. _teardown_needed stays armed; globals not nulled. + if attached_fresh: + try: + lib.graal_detach_thread(worker) + except Exception: + pass + raise + # Success: the isolate (and every thread pointer into it) is now invalid, so + # the worker must NOT be detached. + _lib = _lib_path = _isolate = None + _teardown_needed = False + _pending_teardown_thread = None + + +def _acquire_isolate(lib_path: str): + """Returns (lib, isolate), creating the shared isolate on the first reference. + Increments the refcount only on success.""" + global _lib, _lib_path, _isolate, _isolate_ref_count, _teardown_needed, _pending_teardown_thread + with _isolate_lock: + _retry_pending_teardown_locked() + if _isolate is None: + try: + lib = ctypes.CDLL(lib_path) + except OSError as error: + raise DataWeaveError(f"Failed to load library from {lib_path}: {error}") + _bind_abi(lib) + isolate = GraalIsolatePointer() + thread = GraalIsolateThreadPointer() + try: + result = lib.graal_create_isolate(None, ctypes.byref(isolate), ctypes.byref(thread)) + except Exception as error: + raise DataWeaveError(f"Failed to create GraalVM isolate: {error}") from error + if result != 0: + raise DataWeaveError(f"Failed to create GraalVM isolate. Error code: {result}") + # Detach the bootstrap thread immediately. A thread left attached to the + # isolate blocks graal_tear_down_isolate forever when the last release + # runs on a different OS thread (e.g. the atexit cleanup thread). Every + # subsequent native call attaches its own thread on demand and detaches + # when done; teardown attaches a fresh thread. Mirrors the Node/Go bindings. + detach_result = lib.graal_detach_thread(thread) + if detach_result != 0: + # The bootstrap thread could not be detached. The isolate is + # created but not yet published (globals unset, refcount not + # bumped), so tear it down here rather than leak an unreachable + # live isolate. Reuse the same still-attached bootstrap thread to + # tear down (it is the only attached thread). + try: + _tear_down(lib, thread) + except BaseException: + # Even teardown failed: the isolate was NOT destroyed and the + # bootstrap `thread` is still attached to it. Retain both the + # isolate AND that still-attached bootstrap thread so the retry + # can tear down using IT -- GraalVM teardown can never succeed + # while the bootstrap thread stays attached, so a fresh worker + # could never tear this isolate down. Its detach already failed + # above, so we do NOT detach it again; the retry path + # (_retry_pending_teardown_locked) reuses the retained thread. + _lib, _lib_path, _isolate = lib, lib_path, isolate + _teardown_needed = True + _pending_teardown_thread = thread + print( + "DataWeave: bootstrap-thread detach and isolate teardown " + "both failed; isolate retained for retry.", + file=sys.stderr, + ) + raise DataWeaveError( + f"Failed to detach GraalVM isolate bootstrap thread. Error code: {detach_result}" + ) + _lib = lib + _lib_path = lib_path + _isolate = isolate + _isolate_ref_count += 1 + return _lib, _isolate + + +def _release_isolate() -> None: + """Decrements the refcount; tears the isolate down on 0. A failed teardown + (or a failed attach immediately before it) retains the isolate live and + arms _teardown_needed for a retry at the next acquire, instead of nulling + the globals -- nulling would let the next initialize() build a second live + isolate while the first is still alive.""" + global _lib, _lib_path, _isolate, _isolate_ref_count, _teardown_needed + with _isolate_lock: + if _isolate_ref_count == 0: + return + _isolate_ref_count -= 1 + if _isolate_ref_count > 0: + return + # Last release: no thread is persistently attached (the bootstrap was + # detached at create and every op detaches its own thread), so attach a + # fresh thread and tear down. + lib, isolate = _lib, _isolate + worker = GraalIsolateThreadPointer() + if lib.graal_attach_thread(isolate, ctypes.byref(worker)) != 0: + # Cannot even attach to tear down; retain the isolate and arm a retry. + _teardown_needed = True + print( + "DataWeave: could not attach a thread to tear down the GraalVM " + "isolate; teardown will be retried on the next initialize().", + file=sys.stderr, + ) + raise DataWeaveError("Failed to attach thread for isolate teardown") + try: + _tear_down(lib, worker) + except BaseException: + # Teardown failed: detach the worker we just attached FIRST (best- + # effort) so it does not stay attached and block a later retry, which + # attaches its own fresh worker. Then keep the isolate live, arm a + # retry, and do NOT null globals (nulling would let the next + # initialize() build a second live isolate). Mirrors Node's + # g_teardown_needed retryable model. On the SUCCESS path below the + # worker is intentionally left undetached -- after _tear_down returns + # the isolate is gone and the worker pointer is invalid. + try: + lib.graal_detach_thread(worker) + except Exception: + pass + _teardown_needed = True + print( + "DataWeave: GraalVM isolate teardown failed; the isolate is " + "retained and teardown will be retried on the next initialize().", + file=sys.stderr, + ) + raise + _lib = _lib_path = _isolate = None + + +def _tear_down(lib, thread) -> None: + if thread is None: + return + result = lib.graal_tear_down_isolate(thread) + if result != 0: + raise DataWeaveError(f"Failed to tear down GraalVM isolate. Error code: {result}") + + def candidate_library_paths() -> list[Path]: paths: list[Path] = [] env_value = (os.environ.get(_ENV_NATIVE_LIB) or "").strip() @@ -64,102 +317,79 @@ def __init__(self, lib_path: Optional[str] = None): self.lib = None self.isolate = None self.thread = None + self.handle = 0 self.initialized = False - self.has_callback_streaming = False - self.has_callback_input_output = False - self.has_module_resolver = False - self._module_resolver = None - self._module_resolver_callback = None + # Every engine supports every API now (single unified ABI). + self.has_callback_streaming = True + self.has_callback_input_output = True + self.has_module_resolver = True + self._resolver = None + self._resolver_callback = None + self._resolver_token = 0 self._resolver_buffers = [] self._resolver_active = False + self._resolver_active_ident = None self._resolver_lock = Lock() self._execution_owner = None - self._owner_thread = None + # Guards this instance's initialize()/cleanup() lifecycle transitions + # (the initialized-check -> acquire -> create-engine -> publish + # sequence, and cleanup()'s initialized-clearing prologue) so two + # threads calling initialize() on the SAME instance cannot both pass + # the check, both acquire (refcount over-count), and both create an + # engine. Never held across a long native execution call -- only + # instance lifecycle transitions. + self._init_lock = Lock() def initialize(self) -> None: if self.initialized: return - try: - self.lib = ctypes.CDLL(self.lib_path) - except OSError as error: - raise DataWeaveError(f"Failed to load library from {self.lib_path}: {error}") - isolate_created = False - try: - self._create_isolate() - isolate_created = True - self._owner_thread = current_thread() - self._setup_functions() + with self._init_lock: + if self.initialized: + return + acquired = False + try: + self.lib, self.isolate = _acquire_isolate(self.lib_path) + acquired = True + self.handle = self._create_engine() + except Exception: + # Roll back the ref we just took (if any) so a failed init leaks + # nothing. + self.lib = self.isolate = None + # Finding #2: install_resolver() registered a token BEFORE this call. + # A failed init must unregister it, or it leaks: self.initialized stays + # False, so a later cleanup() returns early and never reaches the pop. + if self._resolver_token: + with _resolver_lock_global: + _resolver_registry.pop(self._resolver_token, None) + self._resolver_token = 0 + # Release the ref only if _acquire_isolate actually incremented it + # (a library-load / isolate-create / bootstrap-detach failure inside + # _acquire_isolate never increments the refcount, so releasing here + # unconditionally would decrement someone else's live reference). + if acquired: + _release_isolate() + raise self.initialized = True - except Exception: - if isolate_created: - self._tear_down_isolate(suppress_errors=True) - self._reset() - raise - - def _create_isolate(self) -> None: - self._require_export("graal_create_isolate") - self.lib.graal_create_isolate.argtypes = [ - ctypes.c_void_p, - ctypes.POINTER(GraalIsolatePointer), - ctypes.POINTER(GraalIsolateThreadPointer), - ] - self.lib.graal_create_isolate.restype = ctypes.c_int - self.isolate = GraalIsolatePointer() - self.thread = GraalIsolateThreadPointer() - try: - result = self.lib.graal_create_isolate(None, ctypes.byref(self.isolate), ctypes.byref(self.thread)) - except Exception as error: - raise DataWeaveError(f"Failed to create GraalVM isolate: {error}") from error - if result != 0: - raise DataWeaveError(f"Failed to create GraalVM isolate. Error code: {result}") - - def _setup_functions(self) -> None: - self._require_export("run_script") - self._require_export("free_cstring") - self._require_export("graal_tear_down_isolate") - self.lib.run_script.argtypes = [GraalIsolateThreadPointer, ctypes.c_char_p, ctypes.c_char_p] - self.lib.run_script.restype = ctypes.c_void_p - self.lib.free_cstring.argtypes = [GraalIsolateThreadPointer, ctypes.c_void_p] - self.lib.free_cstring.restype = None - self.lib.graal_tear_down_isolate.argtypes = [GraalIsolateThreadPointer] - self.lib.graal_tear_down_isolate.restype = ctypes.c_int - self._setup_thread_lifecycle_functions() - if hasattr(self.lib, "run_script_with_resolver"): - self.lib.run_script_with_resolver.argtypes = [ - GraalIsolateThreadPointer, - ctypes.c_char_p, - ctypes.c_char_p, - RESOLVE_MODULE_CALLBACK, - ] - self.lib.run_script_with_resolver.restype = ctypes.c_void_p - self.has_module_resolver = True - if hasattr(self.lib, "run_script_callback"): - self._require_streaming_lifecycle_exports("run_script_callback") - self.lib.run_script_callback.argtypes = [GraalIsolateThreadPointer, ctypes.c_char_p, ctypes.c_char_p, WRITE_CALLBACK, ctypes.c_void_p] - self.lib.run_script_callback.restype = ctypes.c_void_p - self.has_callback_streaming = True - if hasattr(self.lib, "run_script_input_output_callback"): - self._require_streaming_lifecycle_exports("run_script_input_output_callback") - self.lib.run_script_input_output_callback.argtypes = [GraalIsolateThreadPointer, ctypes.c_char_p, ctypes.c_char_p, ctypes.c_char_p, ctypes.c_char_p, ctypes.c_char_p, READ_CALLBACK, WRITE_CALLBACK, ctypes.c_void_p] - self.lib.run_script_input_output_callback.restype = ctypes.c_void_p - self.has_callback_input_output = True - - def _require_export(self, name: str) -> None: - if not hasattr(self.lib, name): - raise DataWeaveError(f"Native library does not export {name}") - - def _require_streaming_lifecycle_exports(self, callback_name: str) -> None: - for name in ("free_cstring", "graal_attach_thread", "graal_detach_thread"): - if not hasattr(self.lib, name): - raise DataWeaveError(f"{callback_name} requires native export {name}") - def _setup_thread_lifecycle_functions(self) -> None: - self._require_export("graal_attach_thread") - self._require_export("graal_detach_thread") - self.lib.graal_attach_thread.argtypes = [GraalIsolatePointer, ctypes.POINTER(GraalIsolateThreadPointer)] - self.lib.graal_attach_thread.restype = ctypes.c_int - self.lib.graal_detach_thread.argtypes = [GraalIsolateThreadPointer] - self.lib.graal_detach_thread.restype = ctypes.c_int + def _create_engine(self) -> int: + with self._current_thread_attachment(self.thread) as thread: + try: + if self._resolver is not None: + # Pass the bare int token; the declared c_void_p argtype on the + # real ABI call converts it automatically. (Wrapping it in + # ctypes.c_void_p(...) here would produce an unhashable Python + # object, breaking the FakeLibrary-recorded ctx round-trip used + # in tests -- and offers no benefit for the real ctypes call.) + handle = self.lib.create_engine_with_resolver( + thread, self._resolver_callback, self._resolver_token + ) + else: + handle = self.lib.create_engine(thread) + except Exception as error: + raise DataWeaveError(f"Failed to create DataWeave engine: {error}") from error + if not handle: + raise DataWeaveError("Native create_engine returned a null handle") + return handle def attach_thread(self): worker_thread = GraalIsolateThreadPointer() @@ -196,65 +426,70 @@ def decode_and_free(self, ptr, thread=None) -> str: if primary_error is None: raise - def run_script(self, thread, script: bytes, inputs: bytes): + def run_engine_and_decode(self, script: bytes, inputs: bytes) -> str: with self._serialized_native_operation(): - return self.lib.run_script(thread, script, inputs) - - def run_script_and_decode(self, thread, script: bytes, inputs: bytes) -> str: + with self._current_thread_attachment(self.thread) as thread: + with self._resolver_scope(): + return self.decode_and_free( + self.lib.run_script_engine(thread, self.handle, script, inputs), + thread, + ) + + def run_callback_engine_and_decode(self, thread, script: bytes, inputs: bytes, write_callback) -> str: with self._serialized_native_operation(): - with self._current_thread_attachment(thread) as current_thread: + with self._current_thread_attachment(thread) as current: return self.decode_and_free( - self.lib.run_script(current_thread, script, inputs), - current_thread, + self.lib.run_script_callback_engine( + current, self.handle, script, inputs, write_callback, None + ), + current, ) - def run_script_with_resolver(self, thread, script: bytes, inputs: bytes, resolver: ModuleResolver): - with self._serialized_native_operation(): - return self._run_script_with_resolver(thread, script, inputs, resolver) - - def run_script_with_resolver_and_decode(self, thread, script: bytes, inputs: bytes, resolver: ModuleResolver) -> str: + def run_input_output_callback_engine_and_decode( + self, thread, script: bytes, inputs: bytes, input_name: bytes, + input_mime_type: bytes, input_charset: Optional[bytes], read_callback, write_callback, + ) -> str: with self._serialized_native_operation(): - with self._current_thread_attachment(thread) as current_thread: + with self._current_thread_attachment(thread) as current: return self.decode_and_free( - self._run_script_with_resolver(current_thread, script, inputs, resolver), - current_thread, + self.lib.run_script_input_output_callback_engine( + current, self.handle, script, inputs, input_name, + input_mime_type, input_charset, read_callback, write_callback, None, + ), + current, ) - def _run_script_with_resolver(self, thread, script: bytes, inputs: bytes, resolver: ModuleResolver): - if not self.has_module_resolver: - raise DataWeaveError( - "Native library does not support module resolver API " - "(run_script_with_resolver not found)." - ) - if self._module_resolver is None: - self._module_resolver = resolver - self._module_resolver_callback = self._create_module_resolver_callback(resolver) - elif self._module_resolver is not resolver: - raise DataWeaveError("Native runtime already has a different module resolver") - - self._resolver_buffers.clear() - self._resolver_active = True - try: - return self.lib.run_script_with_resolver( - thread, script, inputs, self._module_resolver_callback - ) - finally: - self._resolver_active = False - self._resolver_buffers.clear() - - def _create_module_resolver_callback(self, resolver: ModuleResolver): - def resolve(_thread, module_path): + def install_resolver(self, resolver: ModuleResolver) -> None: + """Binds a module resolver to this engine. Must be called before initialize().""" + if self.initialized: + raise DataWeaveError("Cannot install a resolver after initialize().") + self._resolver = resolver + self._resolver_token = _next_resolver_token() + self._resolver_callback = self._make_trampoline() + with _resolver_lock_global: + _resolver_registry[self._resolver_token] = self + + def _make_trampoline(self): + token = self._resolver_token + def resolve(_thread, _ctx, module_path): try: - if not self._resolver_active: + entry = _resolver_registry.get(token) + if entry is None: + return None + # Fail-closed guard: resolve only during a synchronous run on the + # thread that installed the scope. Streaming workers run on other + # threads and never enter the scope -> return None without calling + # the Python resolver (preserves calls == calls_after_install). + if not entry._resolver_active or get_ident() != entry._resolver_active_ident: return None path = module_path.decode("utf-8") if path.startswith("/"): path = path[1:] - source = resolver(path) + source = entry._resolver(path) if not isinstance(source, str): return None buffer = ctypes.create_string_buffer(source.encode("utf-8")) - self._resolver_buffers.append(buffer) + entry._resolver_buffers.append(buffer) return ctypes.addressof(buffer) except BaseException: try: @@ -265,56 +500,58 @@ def resolve(_thread, module_path): except BaseException: pass return None - return RESOLVE_MODULE_CALLBACK(resolve) - def run_script_callback(self, thread, script: bytes, inputs: bytes, write_callback): - with self._serialized_native_operation(): - return self.lib.run_script_callback(thread, script, inputs, write_callback, None) - - def run_script_callback_and_decode(self, thread, script: bytes, inputs: bytes, write_callback) -> str: - with self._serialized_native_operation(): - with self._current_thread_attachment(thread) as current_thread: - return self.decode_and_free( - self.lib.run_script_callback(current_thread, script, inputs, write_callback, None), - current_thread, - ) - - def run_script_input_output_callback(self, thread, script: bytes, inputs: bytes, input_name: bytes, input_mime_type: bytes, input_charset: Optional[bytes], read_callback, write_callback): - with self._serialized_native_operation(): - return self.lib.run_script_input_output_callback( - thread, script, inputs, input_name, input_mime_type, input_charset, read_callback, write_callback, None, - ) - - def run_script_input_output_callback_and_decode(self, thread, script: bytes, inputs: bytes, input_name: bytes, input_mime_type: bytes, input_charset: Optional[bytes], read_callback, write_callback) -> str: - with self._serialized_native_operation(): - with self._current_thread_attachment(thread) as current_thread: - return self.decode_and_free( - self.lib.run_script_input_output_callback( - current_thread, script, inputs, input_name, input_mime_type, input_charset, read_callback, write_callback, None, - ), - current_thread, - ) + @contextmanager + def _resolver_scope(self): + if self._resolver is None: + yield + return + self._resolver_buffers = [] + self._resolver_active = True + self._resolver_active_ident = get_ident() + try: + yield + finally: + self._resolver_active = False + self._resolver_active_ident = None + self._resolver_buffers = [] def cleanup(self) -> None: with self._serialized_native_operation(): - if not self.initialized: - return - if current_thread() is getattr(self, "_owner_thread", current_thread()): - self._tear_down_isolate() - self._reset() - return - - attached_thread = self.attach_thread() + # _init_lock is nested INSIDE _resolver_lock here (never the + # reverse -- initialize() only ever takes _init_lock alone, and + # never takes _resolver_lock), so there is no lock-ordering + # inversion between the two. Only the initialized-clearing flag + # flip needs the lock; the actual destroy/release below stays + # outside it, guarded by _serialized_native_operation as before. + # Mirrors _serialized_native_operation's own hasattr guard below: + # some unit tests build a NativeRuntime via __new__ and set + # attributes directly, bypassing __init__. + if not hasattr(self, "_init_lock"): + self._init_lock = Lock() + with self._init_lock: + if not self.initialized: + return + self.initialized = False try: - self._tear_down_isolate(attached_thread) - except Exception: - try: - self.detach_thread(attached_thread) - except Exception: - pass - raise - self._reset() + if self.handle: + with self._current_thread_attachment(self.thread) as thread: + self.lib.destroy_engine(thread, self.handle) + finally: + # Release the isolate ref even if destroy_engine throws, so a + # throwing destroy cannot strand the isolate. + self.lib = self.isolate = self.thread = None + self._resolver = None + self._resolver_callback = None + self._resolver_buffers = [] + self._resolver_active = False + self._resolver_active_ident = None + if self._resolver_token: + with _resolver_lock_global: + _resolver_registry.pop(self._resolver_token, None) + self._resolver_token = 0 + _release_isolate() @contextmanager def _serialized_native_operation(self): @@ -332,11 +569,13 @@ def _serialized_native_operation(self): @contextmanager def _current_thread_attachment(self, thread): - owner = getattr(self, "_owner_thread", current_thread()) - if current_thread() is owner or thread is not self.thread: + # A non-None thread is one the caller already attached (a streaming worker + # passes its own); use it as-is. Otherwise (self.thread is None for every + # synchronous call) attach a fresh thread on demand and detach when done -- + # no thread is persistently attached, so cross-thread teardown never blocks. + if thread is not None: yield thread return - attached_thread = self.attach_thread() primary_error = None try: @@ -351,31 +590,3 @@ def _current_thread_attachment(self, thread): if primary_error is None: raise - def _tear_down_isolate(self, thread=None, suppress_errors: bool = False) -> None: - isolate_thread = thread or self.thread - if isolate_thread is None: - return - try: - result = self.lib.graal_tear_down_isolate(isolate_thread) - if result != 0: - raise DataWeaveError(f"Failed to tear down GraalVM isolate. Error code: {result}") - except DataWeaveError: - if not suppress_errors: - raise - except Exception as error: - if not suppress_errors: - raise DataWeaveError(f"Failed to tear down GraalVM isolate: {error}") from error - - def _reset(self) -> None: - self.initialized = False - self._owner_thread = None - self.thread = None - self.isolate = None - self.lib = None - self.has_callback_streaming = False - self.has_callback_input_output = False - self.has_module_resolver = False - self._module_resolver = None - self._module_resolver_callback = None - self._resolver_buffers = [] - self._resolver_active = False diff --git a/native-lib/python/src/dataweave/runtime.py b/native-lib/python/src/dataweave/runtime.py index cb66b1a1..377c60f1 100644 --- a/native-lib/python/src/dataweave/runtime.py +++ b/native-lib/python/src/dataweave/runtime.py @@ -39,21 +39,44 @@ def __init__( self._stream_workers = set() self._stream_workers_lock = Lock() self._cleaning_up = False + self._lifecycle_lock = Lock() def initialize(self): - self._native.initialize() + # Holds the lock across the whole install-resolver + native-init + # transition so two concurrent initialize() calls on this instance + # cannot both pass the `initialized` guard and both call + # install_resolver(), which would mint and register a second resolver + # token in the module-global registry and orphan it (review #12 #2). + # Always the outermost lock: NativeRuntime._init_lock and the module- + # global _resolver_lock_global are only ever taken INSIDE + # self._native.initialize()/cleanup(), nested within this one. + with self._lifecycle(): + if self._native.initialized: + return + if self._resolve_module is not None: + self._native.install_resolver(self._resolve_module) + self._native.initialize() def cleanup(self): - workers, lock = self._worker_registry() - with lock: - if workers: - raise DataWeaveError("Cannot clean up DataWeave runtime while an active streaming worker is attached.") - self._cleaning_up = True - try: - self._native.cleanup() - finally: + # Symmetric with initialize(): install_resolver() and + # NativeRuntime.cleanup() both mutate the module-global resolver + # registry, so cleanup() takes the same instance-level lock. + with self._lifecycle(): + workers, lock = self._worker_registry() with lock: - self._cleaning_up = False + if workers: + raise DataWeaveError("Cannot clean up DataWeave runtime while an active streaming worker is attached.") + self._cleaning_up = True + try: + self._native.cleanup() + finally: + with lock: + self._cleaning_up = False + + def _lifecycle(self): + if not hasattr(self, "_lifecycle_lock"): + self._lifecycle_lock = Lock() + return self._lifecycle_lock def _worker_registry(self): if not hasattr(self, "_stream_workers"): @@ -86,17 +109,9 @@ def _inputs_json(inputs: Optional[Dict[str, Any]]) -> bytes: def run(self, script: str, inputs: Optional[Dict[str, Any]] = None, raise_on_error: bool = False) -> ExecutionResult: self._require_initialized(True, "script execution") try: - encoded_script = script.encode("utf-8") - encoded_inputs = self._inputs_json(inputs) - if self._resolve_module is None: - raw = self._native.run_script_and_decode(self._native.thread, encoded_script, encoded_inputs) - else: - raw = self._native.run_script_with_resolver_and_decode( - self._native.thread, - encoded_script, - encoded_inputs, - self._resolve_module, - ) + raw = self._native.run_engine_and_decode( + script.encode("utf-8"), self._inputs_json(inputs) + ) result = parse_native_encoded_response(raw) except Exception as error: raise DataWeaveError(f"Failed to execute script: {error}") @@ -113,7 +128,7 @@ def write_cb(_context, buffer, length): except Exception: return -1 try: - raw = self._native.run_script_callback_and_decode(self._native.thread, script.encode("utf-8"), self._inputs_json(inputs), write_cb) + raw = self._native.run_callback_engine_and_decode(self._native.thread, script.encode("utf-8"), self._inputs_json(inputs), write_cb) return parse_streaming_result(json.loads(raw) if raw else {"success": False, "error": "Empty response"}) except Exception as error: raise DataWeaveError(f"Failed to execute callback streaming: {error}") @@ -202,7 +217,7 @@ def run_streaming(self, script: str, inputs: Optional[Dict[str, Any]] = None) -> self._require_initialized(self._native.has_callback_streaming, "callback streaming API (run_script_callback not found)") cancelled = Event() encoded_inputs = self._inputs_json(inputs) - stream = Stream(self._stream_worker(lambda thread, write_cb: self._native.run_script_callback_and_decode(thread, script.encode("utf-8"), encoded_inputs, write_cb), cancelled)) + stream = Stream(self._stream_worker(lambda thread, write_cb: self._native.run_callback_engine_and_decode(thread, script.encode("utf-8"), encoded_inputs, write_cb), cancelled)) stream._on_close = cancelled.set stream._cancelled = cancelled return stream @@ -239,7 +254,7 @@ def run_transform(self, script: str, input_stream: Iterable[bytes], input_name: read_cb = self._chunk_reader(input_stream) encoded_inputs = self._inputs_json(inputs) def invoke(thread, write_cb): - return self._native.run_script_input_output_callback_and_decode(thread, script.encode("utf-8"), encoded_inputs, input_name.encode("utf-8"), input_mime_type.encode("utf-8"), input_charset.encode("utf-8") if input_charset else None, read_cb, write_cb) + return self._native.run_input_output_callback_engine_and_decode(thread, script.encode("utf-8"), encoded_inputs, input_name.encode("utf-8"), input_mime_type.encode("utf-8"), input_charset.encode("utf-8") if input_charset else None, read_cb, write_cb) stream = Stream(self._stream_worker(invoke, cancelled)) stream._on_close = cancelled.set stream._cancelled = cancelled @@ -266,7 +281,7 @@ def write_cb(_context, buffer, length): except Exception: return -1 try: - raw = self._native.run_script_input_output_callback_and_decode(self._native.thread, script.encode("utf-8"), self._inputs_json(inputs), input_name.encode("utf-8"), input_mime_type.encode("utf-8"), input_charset.encode("utf-8") if input_charset else None, read_cb, write_cb) + raw = self._native.run_input_output_callback_engine_and_decode(self._native.thread, script.encode("utf-8"), self._inputs_json(inputs), input_name.encode("utf-8"), input_mime_type.encode("utf-8"), input_charset.encode("utf-8") if input_charset else None, read_cb, write_cb) return parse_streaming_result(json.loads(raw) if raw else {"success": False, "error": "Empty response"}) except Exception as error: raise DataWeaveError(f"Failed to execute callback input/output streaming: {error}") diff --git a/native-lib/python/tests/integration/test_module_resolver.py b/native-lib/python/tests/integration/test_module_resolver.py index 8f9a510c..fb305b0b 100644 --- a/native-lib/python/tests/integration/test_module_resolver.py +++ b/native-lib/python/tests/integration/test_module_resolver.py @@ -4,6 +4,7 @@ from pathlib import Path import subprocess import sys +import threading from zipfile import ZipFile import pytest @@ -318,3 +319,64 @@ def run(): ], "errors": [], } + + +@pytest.mark.integration +def test_shared_isolate_survives_until_the_last_instance_cleans_up(): + from dataweave import native + + a = dataweave.DataWeave(resolve_module=dataweave.modules_from_map({ + "org/test/lib.dwl": "%dw 2.0\nfun answer() = 1", + })) + b = dataweave.DataWeave(resolve_module=dataweave.modules_from_map({ + "org/test/lib.dwl": "%dw 2.0\nfun answer() = 2", + })) + a.initialize() + b.initialize() + try: + assert native._isolate is not None + assert native._isolate_ref_count == 2 + assert a.run(IMPORT_LIB_SCRIPT).get_string() == "1" + assert b.run(IMPORT_LIB_SCRIPT).get_string() == "2" + + a.cleanup() + assert native._isolate is not None # b still holds a ref + assert native._isolate_ref_count == 1 + assert b.run(IMPORT_LIB_SCRIPT).get_string() == "2" # b unaffected + finally: + b.cleanup() + assert native._isolate_ref_count == 0 + assert native._isolate is None # last release tore it down + + +@pytest.mark.integration +def test_last_release_on_a_foreign_thread_does_not_hang(): + from dataweave import native + + # Initialize on a worker thread so the isolate's creating thread differs from + # the main thread that runs the final cleanup (the atexit-style ordering that + # deadlocked before Finding #1's fix). + holder = {} + def make(): + dw = dataweave.DataWeave() + dw.initialize() + holder["dw"] = dw + t = threading.Thread(target=make) + t.start() + t.join(30) + assert not t.is_alive() + dw = holder["dw"] + try: + assert native._isolate_ref_count == 1 + assert dw.run("%dw 2.0\noutput application/json\n---\n1 + 1").get_string() == "2" + finally: + # Last release runs HERE on the main thread (foreign to the creating + # worker). On the unfixed code graal_tear_down_isolate blocks forever; + # run the cleanup on a joinable thread with a timeout so a regression is a + # bounded failure instead of hanging the suite. + done = threading.Thread(target=dw.cleanup) + done.start() + done.join(30) + assert not done.is_alive(), "cleanup() hung: last-release teardown blocked on a foreign thread" + assert native._isolate_ref_count == 0 + assert native._isolate is None diff --git a/native-lib/python/tests/unit/conftest.py b/native-lib/python/tests/unit/conftest.py new file mode 100644 index 00000000..4b0974b4 --- /dev/null +++ b/native-lib/python/tests/unit/conftest.py @@ -0,0 +1,25 @@ +import pytest + +from dataweave import native + + +@pytest.fixture(autouse=True) +def _reset_shared_isolate(): + """Every unit test starts and ends with no shared isolate held. + + The isolate/lib/refcount now live at module scope in dataweave.native, so a + test that leaves a ref behind would leak into the next test. Tests fake the + library, so tearing down here is just clearing globals -- no real native call. + """ + _clear() + yield + _clear() + + +def _clear(): + native._lib = None + native._isolate = None + native._isolate_ref_count = 0 + native._teardown_needed = False + native._pending_teardown_thread = None + native._lib_path = None diff --git a/native-lib/python/tests/unit/test_ci_structure.py b/native-lib/python/tests/unit/test_ci_structure.py index c2d32dec..25f467e9 100644 --- a/native-lib/python/tests/unit/test_ci_structure.py +++ b/native-lib/python/tests/unit/test_ci_structure.py @@ -92,8 +92,20 @@ def test_python_readme_documents_module_resolver_contract(): normalized = " ".join(readme.split()) assert "without a leading path separator" in normalized assert "without a leading slash or separator" not in normalized - assert "Each initialized explicit Python `DataWeave` instance owns a dedicated Graal isolate." in normalized - assert "retains the resolver callback until successful isolate teardown" in normalized + # Lifecycle: one process-wide, reference-counted isolate with per-instance + # handle-addressed engines (review #12 #4 / #13 finding E). The stale + # "dedicated Graal isolate per instance" claim must stay gone. + assert ( + "There is a single process-wide GraalVM isolate, reference-counted by the " + "number of live engines across all `DataWeave` instances" in normalized + ) + assert ( + "Each `DataWeave` instance owns its own handle-addressed engine within " + "that shared isolate." in normalized + ) + assert "owns a dedicated Graal isolate" not in normalized + assert "retains the resolver callback until its engine is destroyed" in normalized + assert "until successful isolate teardown" not in normalized @pytest.mark.unit diff --git a/native-lib/python/tests/unit/test_facade.py b/native-lib/python/tests/unit/test_facade.py index 3191e032..23ec8de6 100644 --- a/native-lib/python/tests/unit/test_facade.py +++ b/native-lib/python/tests/unit/test_facade.py @@ -1,9 +1,12 @@ +import ctypes import inspect +import threading +import time import pytest import dataweave -from dataweave import runtime +from dataweave import native, runtime class FakeNativeRuntime: @@ -12,12 +15,8 @@ def __init__(self): self.thread = "thread" self.calls = [] - def run_script_and_decode(self, *args): - self.calls.append(("run_script_and_decode", args)) - return self._result() - - def run_script_with_resolver_and_decode(self, *args): - self.calls.append(("run_script_with_resolver_and_decode", args)) + def run_engine_and_decode(self, *args): + self.calls.append(("run_engine_and_decode", args)) return self._result() @staticmethod @@ -91,7 +90,7 @@ def test_dataweave_constructor_stores_keyword_only_module_resolver(monkeypatch): @pytest.mark.unit -def test_run_dispatches_to_resolver_aware_native_execution(): +def test_run_uses_engine_execution_regardless_of_resolver(): resolver = lambda _path: "source" instance = configured_runtime(resolver) @@ -102,19 +101,17 @@ def test_run_dispatches_to_resolver_aware_native_execution(): ) assert instance._native.calls == [ ( - "run_script_with_resolver_and_decode", + "run_engine_and_decode", ( - "thread", b"payload", b'{"value": {"content": "MQ==", "mimeType": "application/json", "charset": "utf-8"}}', - resolver, ), ) ] @pytest.mark.unit -def test_run_without_resolver_preserves_native_execution_path(): +def test_run_without_resolver_routes_through_engine(): instance = configured_runtime() result = instance.run("payload") @@ -123,7 +120,7 @@ def test_run_without_resolver_preserves_native_execution_path(): True, "SGVsbG8=", None, False, "text/plain", "utf-8" ) assert instance._native.calls == [ - ("run_script_and_decode", ("thread", b"payload", b"{}")) + ("run_engine_and_decode", (b"payload", b"{}")) ] @@ -170,7 +167,7 @@ def test_cleanup_is_noop_without_global_runtime(): @pytest.mark.unit -def test_global_cleanup_retains_failed_runtime_for_retry(monkeypatch): +def test_global_cleanup_clears_global_before_reraising_on_failure(monkeypatch): created = [] class FakeRuntime: @@ -184,11 +181,197 @@ def cleanup(self): raise dataweave.DataWeaveError("teardown failed") monkeypatch.setattr(dataweave, "DataWeave", FakeRuntime) + monkeypatch.setattr("atexit.register", lambda _fn: None) first = dataweave._get_global_instance() + # cleanup() nulls the global under _global_lock *before* running the + # (potentially slow) instance.cleanup() outside the lock, so a failing + # teardown does not strand the lock held nor leave a half-torn-down + # instance published. The instance identity is not retained for retry -- + # that's fine because isolate-level teardown retry lives one layer down + # in dataweave.native (_teardown_needed), independent of which Python + # DataWeave wrapper object is holding the reference. with pytest.raises(dataweave.DataWeaveError, match="teardown failed"): dataweave.cleanup() + assert dataweave._global_instance is None + second = dataweave._get_global_instance() - assert second is first + assert second is not first + assert len(created) == 2 dataweave._global_instance = None + + +@pytest.mark.unit +def test_get_global_instance_publishes_exactly_one_instance_under_concurrent_first_use(monkeypatch): + thread_count = 8 + barrier = threading.Barrier(thread_count) + counts_lock = threading.Lock() + counts = {"created": 0, "initialized": 0} + + class SlowRuntime: + def __init__(self): + with counts_lock: + counts["created"] += 1 + # Widen the window between the "is it published yet" check and + # publication so concurrent first-callers are very likely to + # overlap while racing to construct+initialize a candidate. + time.sleep(0.05) + + def initialize(self): + with counts_lock: + counts["initialized"] += 1 + + def cleanup(self): + pass + + monkeypatch.setattr(dataweave, "DataWeave", SlowRuntime) + monkeypatch.setattr("atexit.register", lambda _fn: None) + + results = [None] * thread_count + errors = [] + + def worker(index): + barrier.wait() + try: + results[index] = dataweave._get_global_instance() + except Exception as exc: # pragma: no cover - defensive, surfaced via `errors` + errors.append(exc) + + threads = [threading.Thread(target=worker, args=(i,)) for i in range(thread_count)] + for thread in threads: + thread.start() + for thread in threads: + thread.join() + + try: + assert not errors + # Exactly one instance is ever constructed and initialized: creation, + # initialization, and publication all happen under _global_lock, so a + # losing thread never builds (and leaks) a candidate engine. + assert counts["created"] == 1 + assert counts["initialized"] == 1 + assert len({id(result) for result in results}) == 1 + assert results[0] is dataweave._global_instance + finally: + dataweave._global_instance = None + + +class _FakeCallable: + """A settable-attribute stand-in for a ctypes function pointer: plain + objects (unlike bound methods) accept `.argtypes`/`.restype` assignment, + which `native._bind_abi` performs on every ABI export it binds.""" + + def __init__(self, callback=None): + self._callback = callback + + def __call__(self, *args): + return self._callback(*args) if self._callback else 0 + + +class FakeLifecycleLibrary: + """Minimal ctypes-library stand-in that lets `NativeRuntime.initialize()`/ + `install_resolver()`/`cleanup()` run for real -- exercising the actual + module-global `_resolver_registry` / `_isolate_ref_count` bookkeeping in + `dataweave.native` -- without touching a real native library.""" + + def __init__(self): + self._next_handle = 1 + self.graal_create_isolate = _FakeCallable(lambda _params, _isolate, _thread: 0) + self.graal_attach_thread = _FakeCallable(self._attach_thread) + self.graal_detach_thread = _FakeCallable(lambda _thread: 0) + self.graal_tear_down_isolate = _FakeCallable(lambda _thread: 0) + self.free_cstring = _FakeCallable() + self.create_engine = _FakeCallable(self._create_engine) + self.create_engine_with_resolver = _FakeCallable(self._create_engine_with_resolver) + self.destroy_engine = _FakeCallable() + self.run_script_engine = _FakeCallable() + self.run_script_callback_engine = _FakeCallable() + self.run_script_input_output_callback_engine = _FakeCallable() + + @staticmethod + def _attach_thread(_isolate, thread_out): + ctypes.cast(thread_out, ctypes.POINTER(native.GraalIsolateThreadPointer))[0] = ( + native.GraalIsolateThreadPointer() + ) + return 0 + + def _create_engine(self, _thread): + handle = self._next_handle + self._next_handle += 1 + return handle + + def _create_engine_with_resolver(self, _thread, _callback, _ctx): + handle = self._next_handle + self._next_handle += 1 + return handle + + +@pytest.mark.unit +def test_concurrent_initialize_installs_exactly_one_resolver_token(monkeypatch): + # review #12 finding #2 (Medium): DataWeave.initialize() called + # self._native.install_resolver(...) then self._native.initialize() with no + # instance-level lock. Concurrent initialize() calls on the SAME instance + # can each pass the `if self._native.initialized: return` fast-path and + # each call install_resolver(), which allocates a fresh token and + # registers it in the module-global registry before any of them reaches + # NativeRuntime's own _init_lock-guarded engine creation. Only the last + # writer's token survives on `self._native._resolver_token`, so cleanup() + # (which only pops that one token) leaks every earlier registration. + monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: FakeLifecycleLibrary()) + + before = set(native._resolver_registry.keys()) + dw = dataweave.DataWeave(lib_path="/tmp/dwlib", resolve_module=lambda _path: None) + + thread_count = 8 + + # A thread_count-party barrier with a timeout, patched into + # NativeRuntime.initialize (the real engine-creation call, invoked AFTER + # install_resolver() in DataWeave.initialize()). On the UNFIXED code every + # thread passes the `if self._native.initialized: return` fast-path + # concurrently (none of them has finished a full initialize() yet, so the + # flag is still False for all), so every thread reaches this point having + # ALREADY called install_resolver() -- reproducing thread_count + # independent install_resolver() calls, each minting and registering its + # own token, before any of them performs the real (locked) engine + # creation. On the FIXED (per-instance-locked) code only one thread is + # ever inside initialize() at a time, so it is the only caller that ever + # reaches this barrier; the other threads see `initialized` already True + # once they acquire the lock and never call install_resolver or this + # method at all. The lone caller's wait times out, the barrier breaks, + # and it proceeds normally -- this must NOT deadlock the fixed code. + native_initialize_barrier = threading.Barrier(thread_count) + orig_native_initialize = dw._native.initialize + + def synchronized_native_initialize(): + try: + native_initialize_barrier.wait(timeout=0.5) + except threading.BrokenBarrierError: + pass + return orig_native_initialize() + + monkeypatch.setattr(dw._native, "initialize", synchronized_native_initialize) + + barrier = threading.Barrier(thread_count) + errors = [] + + def go(): + barrier.wait() + try: + dw.initialize() + except Exception as exc: # noqa: BLE001 + errors.append(exc) + + threads = [threading.Thread(target=go) for _ in range(thread_count)] + for t in threads: + t.start() + for t in threads: + t.join() + + try: + assert not errors + new_tokens = set(native._resolver_registry.keys()) - before + assert len(new_tokens) == 1 # exactly one token, no orphan + assert native._isolate_ref_count == 1 # exactly one engine reference + finally: + dw.cleanup() diff --git a/native-lib/python/tests/unit/test_models.py b/native-lib/python/tests/unit/test_models.py index b337896d..eea1e8ae 100644 --- a/native-lib/python/tests/unit/test_models.py +++ b/native-lib/python/tests/unit/test_models.py @@ -1,5 +1,6 @@ import base64 +import ctypes import pytest import dataweave @@ -18,6 +19,17 @@ def test_public_models_are_exported_from_models_module(): assert models.WRITE_CALLBACK is dataweave.WRITE_CALLBACK +@pytest.mark.unit +def test_resolve_module_callback_has_ctx_argument(): + # thread, ctx, module_path + assert models.RESOLVE_MODULE_CALLBACK._argtypes_ == ( + ctypes.c_void_p, + ctypes.c_void_p, + ctypes.c_char_p, + ) + assert models.RESOLVE_MODULE_CALLBACK._restype_ is ctypes.c_void_p + + @pytest.mark.unit def test_input_value_encodes_text_with_its_charset(): value = dataweave.InputValue("caf\u00e9", charset="latin-1") diff --git a/native-lib/python/tests/unit/test_native.py b/native-lib/python/tests/unit/test_native.py index 78c0f80d..0eaa9f57 100644 --- a/native-lib/python/tests/unit/test_native.py +++ b/native-lib/python/tests/unit/test_native.py @@ -1,6 +1,6 @@ from pathlib import Path import ctypes -from threading import current_thread, Event, get_ident, Thread +from threading import Barrier, BrokenBarrierError, current_thread, get_ident, Thread import pytest @@ -24,10 +24,15 @@ class FakeLibrary: run_script = Function() free_cstring = Function() - def __init__(self, *, resolver_export=False): + def __init__(self): self.attach_calls = [] self.detach_calls = [] self.tear_down_threads = [] + self.created_engines = [] + self.destroyed_engines = [] + self.create_engine_threads = [] + self.destroy_engine_threads = [] + self._next_handle = 1 self.graal_create_isolate = CallableFunction(lambda _params, _isolate, _thread: 0) self.graal_attach_thread = CallableFunction(self._attach_thread) self.graal_detach_thread = CallableFunction( @@ -36,8 +41,32 @@ def __init__(self, *, resolver_export=False): self.graal_tear_down_isolate = CallableFunction( lambda thread: self.tear_down_threads.append(thread) or 0 ) - if resolver_export: - self.run_script_with_resolver = Function() + self.free_cstring = Function() + self.create_engine = CallableFunction(self._create_engine) + self.create_engine_with_resolver = CallableFunction(self._create_engine_with_resolver) + self.destroy_engine = CallableFunction( + lambda thread, handle: ( + self.destroy_engine_threads.append(thread), + self.destroyed_engines.append(handle), + ) + ) + self.run_script_engine = Function() + self.run_script_callback_engine = Function() + self.run_script_input_output_callback_engine = Function() + + def _create_engine(self, thread): + handle = self._next_handle + self._next_handle += 1 + self.created_engines.append((handle, None, None)) + self.create_engine_threads.append(thread) + return handle + + def _create_engine_with_resolver(self, thread, callback, ctx): + handle = self._next_handle + self._next_handle += 1 + self.created_engines.append((handle, callback, ctx)) + self.create_engine_threads.append(thread) + return handle def _attach_thread(self, _isolate, thread): worker_thread = native.GraalIsolateThreadPointer() @@ -49,6 +78,57 @@ def _attach_thread(self, _isolate, thread): return 0 +@pytest.mark.unit +def test_shared_isolate_is_created_once_and_torn_down_on_last_release(monkeypatch): + library = FakeLibrary() + monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) + + a = native.NativeRuntime("/tmp/dwlib") + b = native.NativeRuntime("/tmp/dwlib") + a.initialize() + b.initialize() + + # One shared isolate, two engines, refcount == live engines. + assert native._isolate_ref_count == 2 + assert len(library.tear_down_threads) == 0 + assert [h for h, _cb, _ctx in library.created_engines] == [a.handle, b.handle] + assert a.handle != b.handle + + a.cleanup() + assert native._isolate_ref_count == 1 + assert library.destroyed_engines == [a.handle] + assert len(library.tear_down_threads) == 0 # isolate stays for b + + b.cleanup() + assert native._isolate_ref_count == 0 + assert library.destroyed_engines == [a.handle, b.handle] + assert len(library.tear_down_threads) == 1 # last release tears down + + # Idempotent double-cleanup releases the ref only once. + b.cleanup() + assert native._isolate_ref_count == 0 + assert len(library.tear_down_threads) == 1 + + +@pytest.mark.unit +def test_engine_create_failure_releases_isolate_ref(monkeypatch): + library = FakeLibrary() + library.create_engine = CallableFunction( + lambda _thread: (_ for _ in ()).throw(RuntimeError("boom")) + ) + monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) + + runtime = native.NativeRuntime("/tmp/dwlib") + with pytest.raises(native.DataWeaveError): + runtime.initialize() + + # Failed init must leak nothing: the isolate it created is torn down. + assert native._isolate_ref_count == 0 + assert native._isolate is None + assert len(library.tear_down_threads) == 1 + assert runtime.initialized is False + + @pytest.mark.unit def test_parse_native_response_rejects_malformed_json(): result = dataweave._parse_native_encoded_response("not json") @@ -112,14 +192,15 @@ def test_decode_and_free_preserves_decode_failure_when_free_also_fails(monkeypat @pytest.mark.unit def test_native_runtime_registers_abi_and_cleans_up_idempotently(monkeypatch): library = FakeLibrary() - monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) runtime = native.NativeRuntime("/tmp/dwlib") runtime.initialize() runtime.cleanup() runtime.cleanup() - assert library.run_script.argtypes[1:] == [native.ctypes.c_char_p, native.ctypes.c_char_p] + assert library.run_script_engine.argtypes[1:] == [ + native.ctypes.c_int64, native.ctypes.c_char_p, native.ctypes.c_char_p, + ] assert library.free_cstring.argtypes[1] is native.ctypes.c_void_p assert len(library.tear_down_threads) == 1 assert runtime.initialized is False @@ -130,8 +211,8 @@ def test_buffered_worker_execution_uses_one_current_thread_attachment_for_run_de calls = [] buffer = ctypes.create_string_buffer(b"result") library = FakeLibrary() - library.run_script = CallableFunction( - lambda thread, _script, _inputs: calls.append(("run", get_ident(), thread)) + library.run_script_engine = CallableFunction( + lambda thread, _handle, _script, _inputs: calls.append(("run", get_ident(), thread)) or ctypes.addressof(buffer) ) library.free_cstring = CallableFunction( @@ -141,11 +222,16 @@ def test_buffered_worker_execution_uses_one_current_thread_attachment_for_run_de runtime = native.NativeRuntime("/tmp/dwlib") runtime.initialize() owner_ident = get_ident() + # Snapshot right after initialize(): the bootstrap create/detach and the + # attach-on-demand engine create already added entries, so we assert the + # DELTA the worker run adds rather than a brittle absolute count. + attach_count_after_init = len(library.attach_calls) + detach_count_after_init = len(library.detach_calls) outcomes = [] worker = Thread( target=lambda: outcomes.append( - (get_ident(), runtime.run_script_and_decode(runtime.thread, b"script", b"{}")) + (get_ident(), runtime.run_engine_and_decode(b"script", b"{}")) ) ) worker.start() @@ -155,9 +241,15 @@ def test_buffered_worker_execution_uses_one_current_thread_attachment_for_run_de worker_ident, result = outcomes[0] assert worker_ident != owner_ident assert result == "result" - assert runtime._owner_thread is current_thread() - assert len(library.attach_calls) == 1 - assert library.attach_calls[0][0] == worker_ident + # Exactly one attach and one detach for the whole run+decode+free, both on + # the worker's OS thread -- no owner fast-path, one attachment shared by + # run and free. + assert len(library.attach_calls) - attach_count_after_init == 1 + assert len(library.detach_calls) - detach_count_after_init == 1 + new_attach = library.attach_calls[attach_count_after_init] + new_detach = library.detach_calls[detach_count_after_init] + assert new_attach[0] == worker_ident + assert new_detach[0] == worker_ident worker_pointer = ctypes.cast(calls[0][2], ctypes.c_void_p).value assert [(name, ident) for name, ident, _thread in calls] == [ ("run", worker_ident), @@ -167,16 +259,21 @@ def test_buffered_worker_execution_uses_one_current_thread_attachment_for_run_de ctypes.cast(thread, ctypes.c_void_p).value == worker_pointer for _name, _ident, thread in calls ) - assert library.detach_calls[0][0] == worker_ident - assert ctypes.cast(library.detach_calls[0][1], ctypes.c_void_p).value == worker_pointer + assert ctypes.cast(new_attach[1], ctypes.c_void_p).value == worker_pointer + assert ctypes.cast(new_detach[1], ctypes.c_void_p).value == worker_pointer @pytest.mark.unit -def test_distinct_thread_object_attaches_when_python_thread_ident_is_reused(monkeypatch): +def test_attach_on_demand_does_not_cache_by_thread_ident(monkeypatch): + # This guarded the OLD owner-reuse-by-thread-object branch (comparing + # `current_thread() is owner` under a spoofed get_ident so a reused ident + # could not be mistaken for the owner). That branch is gone entirely: every + # call attaches on demand regardless of ident. Keep the get_ident spoof to + # prove there is no ident-keyed cache anywhere in the new path. buffer = ctypes.create_string_buffer(b"result") library = FakeLibrary() - library.run_script = CallableFunction( - lambda _thread, _script, _inputs: ctypes.addressof(buffer) + library.run_script_engine = CallableFunction( + lambda _thread, _handle, _script, _inputs: ctypes.addressof(buffer) ) library.free_cstring = CallableFunction(lambda _thread, _ptr: None) monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) @@ -184,12 +281,15 @@ def test_distinct_thread_object_attaches_when_python_thread_ident_is_reused(monk runtime = native.NativeRuntime("/tmp/dwlib") runtime.initialize() owner_thread = current_thread() + attach_count_after_init = len(library.attach_calls) + detach_count_after_init = len(library.detach_calls) observed_threads = [] + outcomes = [] worker = Thread( target=lambda: ( observed_threads.append(current_thread()), - runtime.run_script_and_decode(runtime.thread, b"script", b"{}"), + outcomes.append(runtime.run_engine_and_decode(b"script", b"{}")), ) ) worker.start() @@ -198,23 +298,25 @@ def test_distinct_thread_object_attaches_when_python_thread_ident_is_reused(monk assert not worker.is_alive() assert observed_threads == [worker] assert observed_threads[0] is not owner_thread - assert runtime._owner_thread is owner_thread - assert len(library.attach_calls) == 1 - assert len(library.detach_calls) == 1 + assert outcomes == ["result"] + assert len(library.attach_calls) - attach_count_after_init == 1 + assert len(library.detach_calls) - detach_count_after_init == 1 @pytest.mark.unit -def test_cleanup_clears_owner_thread_reference(monkeypatch): +def test_cleanup_releases_isolate_ref(monkeypatch): + # _owner_thread no longer exists (attach-on-demand for every call); the + # remaining intent this test guards is that cleanup() releases the shared + # isolate ref and, on the last release, clears the module-level isolate. library = FakeLibrary() monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) runtime = native.NativeRuntime("/tmp/dwlib") runtime.initialize() - assert runtime._owner_thread is current_thread() - runtime.cleanup() - assert runtime._owner_thread is None + assert native._isolate_ref_count == 0 + assert native._isolate is None @pytest.mark.unit @@ -223,7 +325,7 @@ def test_buffered_worker_execution_detaches_current_thread_after_failure(monkeyp buffer = ctypes.create_string_buffer(b"result") library = FakeLibrary() - def run_script(_thread, _script, _inputs): + def run_script_engine(_thread, _handle, _script, _inputs): if failure == "run": raise RuntimeError("run failed") return ctypes.addressof(buffer) @@ -232,23 +334,30 @@ def free_cstring(_thread, _ptr): if failure == "free": raise RuntimeError("free failed") - library.run_script = CallableFunction(run_script) + library.run_script_engine = CallableFunction(run_script_engine) library.free_cstring = CallableFunction(free_cstring) - if failure == "detach": - library.graal_detach_thread = CallableFunction( - lambda _thread: (_ for _ in ()).throw(RuntimeError("detach failed")) - ) monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) if failure == "decode": monkeypatch.setattr(native.ctypes, "string_at", lambda _ptr: b"\xff") runtime = native.NativeRuntime("/tmp/dwlib") runtime.initialize() + # Snapshot right after initialize(): the bootstrap create/detach and the + # attach-on-demand engine create already used the library's default + # (working) detach, so the "detach" failure below is installed AFTER + # initialize() -- it must only break the worker run's own detach, not the + # unrelated bootstrap-detach call inside _acquire_isolate. + attach_count_after_init = len(library.attach_calls) + detach_count_after_init = len(library.detach_calls) + if failure == "detach": + library.graal_detach_thread = CallableFunction( + lambda _thread: (_ for _ in ()).throw(RuntimeError("detach failed")) + ) errors = [] worker = Thread( target=lambda: _capture_error( errors, - lambda: runtime.run_script_and_decode(runtime.thread, b"script", b"{}"), + lambda: runtime.run_engine_and_decode(b"script", b"{}"), ) ) worker.start() @@ -258,862 +367,737 @@ def free_cstring(_thread, _ptr): assert len(errors) == 1 if failure == "detach": assert "detach failed" in str(errors[0]) - assert len(library.attach_calls) == 1 + assert len(library.attach_calls) - attach_count_after_init == 1 if failure != "detach": - assert len(library.detach_calls) == 1 - assert library.detach_calls[0][0] == library.attach_calls[0][0] + assert len(library.detach_calls) - detach_count_after_init == 1 + assert library.detach_calls[detach_count_after_init][0] == library.attach_calls[attach_count_after_init][0] + + +def _capture_error(errors, invoke): + try: + invoke() + except Exception as error: + errors.append(error) @pytest.mark.unit -@pytest.mark.parametrize( - ("method_name", "native_name", "extra_args"), - [ - ("run_script", "run_script", ()), - ( - "run_script_with_resolver", - "run_script_with_resolver", - (lambda _path: "module source",), - ), - ("run_script_callback", "run_script_callback", (object(),)), - ( - "run_script_input_output_callback", - "run_script_input_output_callback", - (b"payload", b"application/json", None, object(), object()), - ), - ], -) -def test_raw_pointer_calls_use_supplied_thread_without_automatic_attachment( - monkeypatch, method_name, native_name, extra_args -): - observed_threads = [] - library = FakeLibrary(resolver_export=method_name == "run_script_with_resolver") - setattr( - library, - native_name, - CallableFunction( - lambda thread, *_args: observed_threads.append(thread) or 123 - ), +def test_cleanup_from_worker_uses_current_thread_for_isolate_teardown(monkeypatch): + library = FakeLibrary() + teardown_calls = [] + library.graal_tear_down_isolate = CallableFunction( + lambda thread: teardown_calls.append((get_ident(), thread)) or 0 ) monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) runtime = native.NativeRuntime("/tmp/dwlib") runtime.initialize() - runtime.has_callback_streaming = True - runtime.has_callback_input_output = True - supplied_thread = runtime.thread - outcomes = [] + owner_ident = get_ident() + # Snapshot right after initialize(): the bootstrap create/detach and the + # attach-on-demand engine create already added entries on this (main) + # thread's ident, so we assert the DELTA the worker cleanup() adds rather + # than a brittle absolute count. + attach_count_after_init = len(library.attach_calls) + detach_count_after_init = len(library.detach_calls) - worker = Thread( - target=lambda: outcomes.append( - getattr(runtime, method_name)( - supplied_thread, b"script", b"{}", *extra_args - ) - ) - ) + worker = Thread(target=runtime.cleanup) worker.start() worker.join(1) assert not worker.is_alive() - assert outcomes == [123] - assert observed_threads == [supplied_thread] - assert library.attach_calls == [] - assert library.detach_calls == [] + worker_ident, teardown_thread = teardown_calls[0] + assert worker_ident != owner_ident + # This is the structural guard for Finding #1: the isolate was created on + # the main thread, but the bootstrap thread was detached immediately after + # create, so teardown on a completely different (worker) thread does not + # block on a phantom attachment. Off-owner cleanup attaches/detaches its + # own thread for destroy_engine (the first post-init attach), then the + # isolate teardown attaches a second, separate thread for + # graal_tear_down_isolate (the second post-init attach); teardown itself + # never explicitly detaches (tearing down the isolate implicitly does). + assert len(library.attach_calls) - attach_count_after_init == 2 + destroy_attach = library.attach_calls[attach_count_after_init] + teardown_attach = library.attach_calls[attach_count_after_init + 1] + assert destroy_attach[0] == worker_ident + assert teardown_attach[0] == worker_ident + assert ctypes.cast(teardown_thread, ctypes.c_void_p).value == ctypes.cast( + teardown_attach[1], ctypes.c_void_p + ).value + assert len(library.detach_calls) - detach_count_after_init == 1 + new_detach = library.detach_calls[detach_count_after_init] + assert new_detach[0] == worker_ident + assert ctypes.cast(new_detach[1], ctypes.c_void_p).value == ctypes.cast( + destroy_attach[1], ctypes.c_void_p + ).value + assert runtime.initialized is False -def _capture_error(errors, invoke): - try: - invoke() - except Exception as error: - errors.append(error) +@pytest.mark.unit +def test_native_runtime_wraps_library_load_errors(monkeypatch): + monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: (_ for _ in ()).throw(OSError("bad image"))) + + with pytest.raises(dataweave.DataWeaveError, match="Failed to load library from /tmp/dwlib: bad image"): + native.NativeRuntime("/tmp/dwlib").initialize() @pytest.mark.unit -def test_native_runtime_registers_optional_module_resolver_export(monkeypatch): - library = FakeLibrary(resolver_export=True) +def test_initialize_resets_state_when_isolate_creation_fails(monkeypatch): + library = FakeLibrary() + library.graal_create_isolate = CallableFunction(lambda _params, _isolate, _thread: 9) monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) - runtime = native.NativeRuntime("/tmp/dwlib") - runtime.initialize() - assert runtime.has_module_resolver is True - assert library.run_script_with_resolver.argtypes == [ - native.GraalIsolateThreadPointer, - native.ctypes.c_char_p, - native.ctypes.c_char_p, - dataweave.RESOLVE_MODULE_CALLBACK, - ] - assert library.run_script_with_resolver.restype is native.ctypes.c_void_p + with pytest.raises(dataweave.DataWeaveError, match="Failed to create GraalVM isolate. Error code: 9"): + runtime.initialize() + + assert runtime.lib is None + assert runtime.isolate is None + assert runtime.thread is None + assert runtime.initialized is False + assert native._isolate_ref_count == 0 + assert native._isolate is None @pytest.mark.unit -def test_native_runtime_initializes_without_optional_module_resolver_export(monkeypatch): +def test_initialize_requires_create_isolate_export(monkeypatch): + monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: object()) + + with pytest.raises(dataweave.DataWeaveError, match="Native library does not export graal_create_isolate"): + native.NativeRuntime("/tmp/dwlib").initialize() + + +@pytest.mark.unit +def test_initialize_wraps_create_isolate_exception(monkeypatch): library = FakeLibrary() + library.graal_create_isolate = CallableFunction( + lambda _params, _isolate, _thread: (_ for _ in ()).throw(RuntimeError("native create failure")) + ) monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) - runtime = native.NativeRuntime("/tmp/dwlib") - runtime.initialize() + with pytest.raises(dataweave.DataWeaveError, match="Failed to create GraalVM isolate: native create failure"): + native.NativeRuntime("/tmp/dwlib").initialize() - assert runtime.has_module_resolver is False + assert native._isolate_ref_count == 0 + assert native._isolate is None @pytest.mark.unit -def test_run_script_with_resolver_adapts_path_and_retains_source_buffer(monkeypatch): - observed = [] - resolver_paths = [] - library = FakeLibrary(resolver_export=True) - - def invoke(_thread, _script, _inputs, callback): - address = callback(None, b"/org/test/lib.dwl") - observed.append(ctypes.string_at(address).decode("utf-8")) - assert library.runtime._resolver_buffers - return 0 +@pytest.mark.parametrize("missing_symbol", ["graal_attach_thread", "graal_detach_thread"]) +def test_initialize_rejects_streaming_export_without_thread_lifecycle_symbols(monkeypatch, missing_symbol): + class Function: + def __call__(self, *_args): + return 0 - library.run_script_with_resolver = CallableFunction(invoke) + library = type("Native", (), {})() + library.graal_create_isolate = Function() + library.graal_tear_down_isolate = Function() + library.run_script = Function() + library.free_cstring = Function() + library.run_script_callback = Function() + for symbol in ("graal_attach_thread", "graal_detach_thread"): + if symbol != missing_symbol: + setattr(library, symbol, Function()) monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) - runtime = native.NativeRuntime("/tmp/dwlib") - library.runtime = runtime - runtime.initialize() - stale_buffer = ctypes.create_string_buffer(b"stale") - runtime._resolver_buffers.append(stale_buffer) - resolver = lambda path: resolver_paths.append(path) or "module source" - result = runtime.run_script_with_resolver("thread", b"script", b"{}", resolver) - - assert result == 0 - assert resolver_paths == ["org/test/lib.dwl"] - assert observed == ["module source"] - assert runtime._resolver_buffers == [] + with pytest.raises(dataweave.DataWeaveError, match=f"Native library does not export {missing_symbol}"): + native.NativeRuntime("/tmp/dwlib").initialize() @pytest.mark.unit @pytest.mark.parametrize( - ("module_path", "resolver"), + ("method_name", "error_message"), [ - (b"/missing.dwl", lambda _path: None), - (b"/invalid.dwl", lambda _path: 42), - (b"\xff", lambda _path: "unreachable"), + ("attach_thread", "Failed to attach worker thread to isolate: native attach failure"), + ("detach_thread", "Failed to detach worker thread from isolate: native detach failure"), ], ) -def test_resolver_callback_returns_null_for_unresolved_or_invalid_values( - monkeypatch, module_path, resolver -): - addresses = [] - library = FakeLibrary(resolver_export=True) - library.run_script_with_resolver = CallableFunction( - lambda _thread, _script, _inputs, callback: addresses.append( - callback(None, module_path) - ) or 0 - ) - monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) - runtime = native.NativeRuntime("/tmp/dwlib") - runtime.initialize() +def test_thread_lifecycle_wraps_native_invocation_errors(method_name, error_message): + class Native: + def graal_attach_thread(self, _isolate, _thread): + raise RuntimeError("native attach failure") - runtime.run_script_with_resolver("thread", b"script", b"{}", resolver) + def graal_detach_thread(self, _thread): + raise RuntimeError("native detach failure") - assert addresses == [None] - assert runtime._resolver_buffers == [] + runtime = native.NativeRuntime.__new__(native.NativeRuntime) + runtime.lib = Native() + runtime.isolate = object() + + with pytest.raises(dataweave.DataWeaveError, match=error_message): + if method_name == "attach_thread": + runtime.attach_thread() + else: + runtime.detach_thread(object()) @pytest.mark.unit -def test_resolver_callback_contains_exceptions_and_hides_details_by_default( - monkeypatch, capsys -): - addresses = [] - library = FakeLibrary(resolver_export=True) - library.run_script_with_resolver = CallableFunction( - lambda _thread, _script, _inputs, callback: addresses.append( - callback(None, b"/org/test/lib.dwl") - ) or 0 - ) +def test_engine_create_and_destroy_off_owner_thread_use_an_attached_thread(monkeypatch): + # native._isolate_thread is gone: there is no persistent bootstrap thread to + # compare against anymore (it is detached immediately after + # graal_create_isolate). The new intent is that engine create/destroy always + # run on a freshly *attached* thread, and different OS threads use different + # attachments. + # + # NOTE on comparison strategy: FakeLibrary's graal_attach_thread stub writes + # a brand-new, always-NULL ctypes pointer into its out-param on every call + # (there is no real native memory backing it here), so casting to + # ctypes.c_void_p and comparing .value is always None == None / None != None + # is always False -- vacuous regardless of correctness. Object identity + # (`is`/`is not`) IS meaningful here: attach_thread() allocates a distinct + # Python pointer object on every invocation, so two *different* attaches are + # guaranteed to be different objects, while the (now-removed) bug reused the + # exact SAME object across calls. We anchor on identity + OS thread ident. + library = FakeLibrary() monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) - monkeypatch.delenv("DATAWEAVE_RESOLVER_DEBUG", raising=False) - runtime = native.NativeRuntime("/tmp/dwlib") - runtime.initialize() - - def resolver(_path): - raise RuntimeError("secret /private/path") - - runtime.run_script_with_resolver("thread", b"script", b"{}", resolver) - captured = capsys.readouterr() - assert addresses == [None] - assert "DataWeave module resolver callback failed." in captured.err - assert "secret" not in captured.err - assert "/private/path" not in captured.err + # A initializes on THIS thread -> create_engine runs on a freshly attached + # thread (the bootstrap thread from graal_create_isolate was already + # detached inside _acquire_isolate and is never reused for engine create; + # exactly one attach is added by a.initialize(), used for the create call). + a = native.NativeRuntime("/tmp/dwlib") + a.initialize() + owner_ident = get_ident() + assert len(library.attach_calls) == 1 + assert library.attach_calls[0][0] == owner_ident + a_create_thread = library.create_engine_threads[0] + # B initializes on a DIFFERENT OS thread -> attaches its own fresh thread + # there, distinct from A's. + errors = [] + b = native.NativeRuntime("/tmp/dwlib") -@pytest.mark.unit -def test_resolver_callback_prints_exception_details_in_debug_mode( - monkeypatch, capsys -): - library = FakeLibrary(resolver_export=True) - library.run_script_with_resolver = CallableFunction( - lambda _thread, _script, _inputs, callback: callback( - None, b"/org/test/lib.dwl" - ) or 0 - ) - monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) - monkeypatch.setenv("DATAWEAVE_RESOLVER_DEBUG", "1") - runtime = native.NativeRuntime("/tmp/dwlib") - runtime.initialize() + def init_b(): + try: + b.initialize() + except BaseException as error: # pragma: no cover - surfaced via assert + errors.append(error) - def resolver(_path): - raise RuntimeError("secret /private/path") + t = Thread(target=init_b) + t.start() + t.join(2) + assert not errors + assert len(library.attach_calls) == 2 + assert library.attach_calls[1][0] == t.ident + assert library.attach_calls[1][0] != owner_ident + b_create_thread = library.create_engine_threads[1] + # A freshly attached thread is never the SAME object as a previous one -- + # this is exactly how the (now-removed) reused-bootstrap/owner-thread bug + # would have shown up: B's create thread being the literal object A used. + assert b_create_thread is not a_create_thread + + # Destroy B from yet another non-owner thread -> attaches its own thread, + # matching that thread's ident, and it is a fresh object too. + def cleanup_b(): + try: + b.cleanup() + except BaseException as error: # pragma: no cover + errors.append(error) - runtime.run_script_with_resolver("thread", b"script", b"{}", resolver) + t2 = Thread(target=cleanup_b) + t2.start() + t2.join(2) + assert not errors + assert len(library.attach_calls) == 3 + assert library.attach_calls[2][0] == t2.ident + assert library.destroy_engine_threads[-1] is not a_create_thread + assert library.destroy_engine_threads[-1] is not b_create_thread - captured = capsys.readouterr() - assert "RuntimeError: secret /private/path" in captured.err + a.cleanup() @pytest.mark.unit -def test_resolver_callback_contains_base_exceptions(monkeypatch, capsys): - class ResolverExit(BaseException): - pass - - addresses = [] - library = FakeLibrary(resolver_export=True) - library.run_script_with_resolver = CallableFunction( - lambda _thread, _script, _inputs, callback: addresses.append( - callback(None, b"/org/test/lib.dwl") - ) or 0 - ) +def test_failed_isolate_teardown_retains_isolate_and_arms_retry(monkeypatch): + # Updated for the retryable-teardown contract (review #10 #3, align with + # Node): a failed final teardown must NOT null the globals -- nulling would + # let the next initialize() build a SECOND live isolate while the first is + # still alive. Instead the isolate is retained and a retry is armed; the + # retry runs (and must succeed) before any fresh isolate can be built. + monkeypatch.setattr(native, "_teardown_needed", False) # restored after the test regardless of outcome + library = FakeLibrary() + library.graal_tear_down_isolate = CallableFunction(lambda _thread: 1) # non-zero == failure monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) - monkeypatch.delenv("DATAWEAVE_RESOLVER_DEBUG", raising=False) - runtime = native.NativeRuntime("/tmp/dwlib") - runtime.initialize() - def resolver(_path): - raise ResolverExit("secret /private/path") + a = native.NativeRuntime("/tmp/dwlib") + a.initialize() + with pytest.raises(native.DataWeaveError): + a.cleanup() # last release -> teardown fails -> raises + + # The isolate is retained live (not nulled) and a retry is armed. + assert native._isolate is not None + assert native._isolate_ref_count == 0 + assert native._teardown_needed is True - runtime.run_script_with_resolver("thread", b"script", b"{}", resolver) + # Restore a passing teardown so the pending retry (run before b's isolate + # is built) succeeds. + library.graal_tear_down_isolate = CallableFunction(lambda _thread: 0) - captured = capsys.readouterr() - assert addresses == [None] - assert "DataWeave module resolver callback failed." in captured.err - assert "secret" not in captured.err - assert "/private/path" not in captured.err + b = native.NativeRuntime("/tmp/dwlib") + b.initialize() # retries the pending teardown, then builds a fresh isolate + assert native._teardown_needed is False + assert native._isolate is not None + b.cleanup() @pytest.mark.unit -def test_resolver_callback_contains_diagnostic_writer_failures(monkeypatch): - addresses = [] - library = FakeLibrary(resolver_export=True) - library.run_script_with_resolver = CallableFunction( - lambda _thread, _script, _inputs, callback: addresses.append( - callback(None, b"/org/test/lib.dwl") - ) or 0 - ) - monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) - monkeypatch.delenv("DATAWEAVE_RESOLVER_DEBUG", raising=False) - monkeypatch.setattr( - native.sys, - "stderr", - type( - "FailingStderr", - (), - {"write": lambda _self, _value: (_ for _ in ()).throw(SystemExit(9))}, - )(), - ) - runtime = native.NativeRuntime("/tmp/dwlib") - runtime.initialize() +def test_failed_teardown_retains_isolate_and_retries(monkeypatch): + """A failing graal_tear_down_isolate must NOT null the globals or create a + second isolate; the next acquire retries the pending teardown.""" + monkeypatch.setattr(native, "_teardown_needed", False) # restored after the test regardless of outcome + library = FakeLibrary() + create_isolate_calls = [] - def resolver(_path): - raise KeyboardInterrupt("secret /private/path") + def create_isolate(_params, _isolate, _thread): + create_isolate_calls.append(1) + return 0 - runtime.run_script_with_resolver("thread", b"script", b"{}", resolver) + tear_down_results = [1, 0] # the final teardown fails once, then the retry succeeds - assert addresses == [None] + def tear_down(thread): + library.tear_down_threads.append(thread) + return tear_down_results.pop(0) if tear_down_results else 0 + library.graal_create_isolate = CallableFunction(create_isolate) + library.graal_tear_down_isolate = CallableFunction(tear_down) + monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) -@pytest.mark.unit -def test_run_script_with_resolver_clears_buffers_when_native_call_fails(monkeypatch): - library = FakeLibrary(resolver_export=True) + lib, isolate = native._acquire_isolate("/tmp/dwlib") + assert len(create_isolate_calls) == 1 - def invoke(_thread, _script, _inputs, callback): - assert callback(None, b"/org/test/lib.dwl") - raise RuntimeError("native failure") + with pytest.raises(native.DataWeaveError): + native._release_isolate() # last release -> tear_down fails - library.run_script_with_resolver = CallableFunction(invoke) - monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) - runtime = native.NativeRuntime("/tmp/dwlib") - runtime.initialize() + # Isolate retained, retry armed, NOT nulled, no second isolate created. + assert native._lib is lib + assert native._isolate is isolate + assert native._teardown_needed is True + assert native._isolate_ref_count == 0 + assert len(create_isolate_calls) == 1 - with pytest.raises(RuntimeError, match="native failure"): - runtime.run_script_with_resolver( - "thread", b"script", b"{}", lambda _path: "module source" - ) + # Next acquire retries the pending teardown (which now succeeds) and only + # then builds a fresh isolate. + lib2, isolate2 = native._acquire_isolate("/tmp/dwlib") + assert native._teardown_needed is False + assert len(library.tear_down_threads) == 2 # the failed attempt + the retry + assert len(create_isolate_calls) == 2 # then a fresh isolate + assert isolate2 is not isolate - assert runtime._resolver_buffers == [] + native._release_isolate() @pytest.mark.unit -def test_run_script_with_resolver_serializes_calls_and_buffer_cleanup(monkeypatch): - first_entered = Event() - release_first = Event() - second_entered = Event() - errors = [] - library = FakeLibrary(resolver_export=True) - - def invoke(_thread, script, _inputs, callback): - address = callback(None, b"/org/test/lib.dwl") - if script == b"first": - first_entered.set() - if not release_first.wait(1): - raise AssertionError("first invocation was not released") - assert ctypes.string_at(address) == b"module source" - assert len(library.runtime._resolver_buffers) == 1 - else: - second_entered.set() +def test_bootstrap_detach_failure_tears_down_created_isolate(monkeypatch): + """A failed bootstrap-thread detach must not leak the just-created isolate: + it is torn down (reusing the still-attached bootstrap thread) before the + failure is raised, and nothing is published to the module globals.""" + library = FakeLibrary() + create_isolate_calls = [] + + def create_isolate(_params, _isolate, _thread): + create_isolate_calls.append(1) return 0 - library.run_script_with_resolver = CallableFunction(invoke) + library.graal_create_isolate = CallableFunction(create_isolate) + library.graal_detach_thread = CallableFunction(lambda _thread: 1) # bootstrap detach fails monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) - runtime = native.NativeRuntime("/tmp/dwlib") - library.runtime = runtime - runtime.initialize() - resolver = lambda _path: "module source" - - def run(script): - try: - runtime.run_script_with_resolver("thread", script, b"{}", resolver) - except Exception as error: - errors.append(error) - first = Thread(target=run, args=(b"first",)) - second = Thread(target=run, args=(b"second",)) - first.start() - assert first_entered.wait(1) - second.start() + with pytest.raises(native.DataWeaveError): + native._acquire_isolate("/tmp/dwlib") - assert not second_entered.wait(0.1) - release_first.set() - first.join(1) - second.join(1) - - assert not first.is_alive() - assert not second.is_alive() - assert second_entered.is_set() - assert errors == [] - assert runtime._resolver_buffers == [] + # No leaked live isolate: the just-created isolate was torn down, and + # nothing was published since the detach failure happened before publish. + assert native._isolate is None + assert native._lib is None + assert native._isolate_ref_count == 0 + assert len(create_isolate_calls) == 1 + assert len(library.tear_down_threads) == 1 + assert native._teardown_needed is False @pytest.mark.unit -def test_native_runtime_reentrant_execution_fails_without_deadlocking(monkeypatch): - completed = Event() - nested_errors = [] +def test_bootstrap_detach_and_teardown_both_failing_arms_retry_instead_of_leaking(monkeypatch): + """If the just-created isolate's teardown ALSO fails after a bootstrap + detach failure, the isolate must be retained (not silently leaked) and a + retry armed for the next acquire -- mirroring the release-path contract.""" library = FakeLibrary() - - def invoke(thread, script, inputs): - if script == b"outer": - try: - library.runtime.run_script(thread, b"nested", inputs) - except Exception as error: - nested_errors.append(error) - return 0 - - library.run_script = CallableFunction(invoke) + library.graal_detach_thread = CallableFunction(lambda _thread: 1) # bootstrap detach fails + library.graal_tear_down_isolate = CallableFunction( + lambda thread: library.tear_down_threads.append(thread) or 1 + ) # teardown also fails monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) - runtime = native.NativeRuntime("/tmp/dwlib") - library.runtime = runtime - runtime.initialize() - worker = Thread( - target=lambda: (runtime.run_script("thread", b"outer", b"{}"), completed.set()), - daemon=True, - ) - worker.start() + with pytest.raises(native.DataWeaveError): + native._acquire_isolate("/tmp/dwlib") - assert completed.wait(1), "reentrant native execution deadlocked" - assert len(nested_errors) == 1 - assert isinstance(nested_errors[0], dataweave.DataWeaveError) - assert "reentrant" in str(nested_errors[0]).lower() + assert native._isolate is not None + assert native._lib is library + assert native._isolate_ref_count == 0 + assert native._teardown_needed is True + assert len(library.tear_down_threads) == 1 @pytest.mark.unit -def test_resolver_callback_translates_reentrant_execution_to_null(monkeypatch): - completed = Event() - callback_results = [] - library = FakeLibrary(resolver_export=True) - library.run_script = CallableFunction(lambda _thread, _script, _inputs: 0) - library.run_script_with_resolver = CallableFunction( - lambda thread, _script, inputs, callback: callback_results.append( - callback(thread, b"/org/test/lib.dwl") - ) or 0 - ) - monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) - runtime = native.NativeRuntime("/tmp/dwlib") - runtime.initialize() - - def resolver(_path): - runtime.run_script("thread", b"nested", b"{}") - return "unreachable" +def test_retry_after_double_failure_reuses_retained_bootstrap_thread(monkeypatch): + """Review #13 (finding D): when a bootstrap-thread detach AND the immediate + teardown BOTH fail in _acquire_isolate, the isolate was NOT destroyed and the + bootstrap thread is still attached. GraalVM teardown can never succeed while + that thread stays attached, so the retry must reuse the RETAINED bootstrap + thread -- attaching a fresh worker would leave the bootstrap attached and + teardown could never succeed.""" + monkeypatch.setattr(native, "_teardown_needed", False) + monkeypatch.setattr(native, "_pending_teardown_thread", None) + library = FakeLibrary() - worker = Thread( - target=lambda: ( - runtime.run_script_with_resolver("thread", b"outer", b"{}", resolver), - completed.set(), - ), - daemon=True, - ) - worker.start() + # graal_create_isolate hands out a distinct, non-null bootstrap thread so we + # can prove the retry tears down using THAT thread, not a fresh attach (a + # fresh attach via FakeLibrary would produce a different worker pointer). + def create_isolate(_params, _isolate, thread_ptr): + bootstrap = ctypes.cast(ctypes.c_void_p(0x1000), native.GraalIsolateThreadPointer) + ctypes.cast( + thread_ptr, ctypes.POINTER(native.GraalIsolateThreadPointer) + )[0] = bootstrap + return 0 - assert completed.wait(1), "resolver callback re-entry deadlocked" - assert callback_results == [None] + def failing_detach(_thread): + return 1 # bootstrap detach always fails + teardown_calls = {"threads": []} -@pytest.mark.unit -def test_cleanup_waits_for_resolver_aware_call(monkeypatch): - run_entered = Event() - release_run = Event() - teardown_entered = Event() - library = FakeLibrary(resolver_export=True) - - def invoke(_thread, _script, _inputs, callback): - assert callback(None, b"/org/test/lib.dwl") - run_entered.set() - assert release_run.wait(1) - return 0 + def teardown(thread): + teardown_calls["threads"].append(ctypes.cast(thread, ctypes.c_void_p).value) + return 1 if len(teardown_calls["threads"]) == 1 else 0 # fail first, succeed on retry - library.run_script_with_resolver = CallableFunction(invoke) - library.graal_tear_down_isolate = CallableFunction( - lambda _thread: teardown_entered.set() or 0 - ) + library.graal_create_isolate = CallableFunction(create_isolate) + library.graal_detach_thread = CallableFunction(failing_detach) + library.graal_tear_down_isolate = CallableFunction(teardown) monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) - runtime = native.NativeRuntime("/tmp/dwlib") - runtime.initialize() - run_thread = Thread( - target=runtime.run_script_with_resolver, - args=("thread", b"script", b"{}", lambda _path: "module source"), - ) - cleanup_thread = Thread(target=runtime.cleanup) - run_thread.start() - assert run_entered.wait(1) - cleanup_thread.start() + with pytest.raises(native.DataWeaveError): + native._acquire_isolate("/tmp/dwlib") + assert native._teardown_needed is True + assert native._pending_teardown_thread is not None + bootstrap_addr = ctypes.cast(native._pending_teardown_thread, ctypes.c_void_p).value + assert bootstrap_addr == 0x1000 + + # Retry: teardown must reuse the retained bootstrap thread and succeed. + with native._isolate_lock: + native._retry_pending_teardown_locked() + assert native._teardown_needed is False + assert native._pending_teardown_thread is None + # Two teardown attempts total, both on the SAME retained bootstrap thread. + assert teardown_calls["threads"] == [bootstrap_addr, bootstrap_addr] + + +class RetryTeardownFake: + """Fake native lib for the failed-teardown / cross-thread-retry scenario. + + Each graal_attach_thread hands out a distinct, non-null worker pointer so we + can prove WHICH worker is detached. graal_tear_down_isolate fails on the + first call and succeeds afterwards, modelling a transient teardown failure. + """ + + def __init__(self): + self.attach_workers = [] # worker addr for every attach, in order + self.detached = [] # worker addr passed to every detach + self.tear_down_workers = [] # worker addr passed to every teardown + self.attached = set() # addrs currently attached (naive bookkeeping) + self._next_worker = 1 + self._tear_down_calls = 0 + + def graal_attach_thread(self, _isolate, thread_ptr): + addr = self._next_worker * 0x1000 + self._next_worker += 1 + fake_worker = ctypes.cast(ctypes.c_void_p(addr), native.GraalIsolateThreadPointer) + ctypes.cast( + thread_ptr, ctypes.POINTER(native.GraalIsolateThreadPointer) + )[0] = fake_worker + self.attach_workers.append(addr) + self.attached.add(addr) + return 0 - assert not teardown_entered.wait(0.1) - release_run.set() - run_thread.join(1) - cleanup_thread.join(1) + def graal_detach_thread(self, thread): + addr = ctypes.cast(thread, ctypes.c_void_p).value + self.detached.append(addr) + self.attached.discard(addr) + return 0 - assert not run_thread.is_alive() - assert not cleanup_thread.is_alive() - assert teardown_entered.is_set() + def graal_tear_down_isolate(self, thread): + self._tear_down_calls += 1 + self.tear_down_workers.append(ctypes.cast(thread, ctypes.c_void_p).value) + return 1 if self._tear_down_calls == 1 else 0 # fail once, then succeed @pytest.mark.unit -@pytest.mark.parametrize( - "invoke", - [ - lambda runtime: runtime.run_script_and_decode("thread", b"script", b"{}"), - lambda runtime: runtime.run_script_with_resolver_and_decode( - "thread", b"script", b"{}", lambda _path: "module source" - ), - lambda runtime: runtime.run_script_callback_and_decode( - "thread", b"script", b"{}", object() - ), - lambda runtime: runtime.run_script_input_output_callback_and_decode( - "thread", - b"script", - b"{}", - b"payload", - b"application/json", - None, - object(), - object(), - ), - ], -) -def test_cleanup_waits_until_native_result_is_decoded_and_freed(monkeypatch, invoke): - native_returned = Event() - release_decode = Event() - freed = Event() - teardown_entered = Event() +def test_failed_teardown_detaches_worker_so_cross_thread_retry_succeeds(monkeypatch): + """Finding #2 (review #11): a FAILED final teardown must detach the freshly- + attached teardown worker before arming the retry. Otherwise a later cross- + thread retry attaches a SECOND worker while the first stays attached, and the + leftover attached worker blocks graal_tear_down_isolate forever. + + A SUCCESSFUL teardown must NOT detach its worker (the isolate is gone and the + thread pointer is invalid), so detaches == attaches - 1 across the scenario. + """ + fake = RetryTeardownFake() + # Set up as if one engine already acquired the shared isolate. Bypass real + # library loading -- drive the globals directly (unit/conftest resets them). + monkeypatch.setattr(native, "_lib", fake) + monkeypatch.setattr(native, "_lib_path", "/tmp/dwlib") + monkeypatch.setattr(native, "_isolate", native.GraalIsolatePointer()) + monkeypatch.setattr(native, "_isolate_ref_count", 1) + monkeypatch.setattr(native, "_teardown_needed", False) + + # Last release on the main thread -> teardown fails once -> retry armed. + with pytest.raises(native.DataWeaveError): + native._release_isolate() + + # The isolate is retained live and a retry is armed. + assert native._isolate is not None + assert native._isolate_ref_count == 0 + assert native._teardown_needed is True + # Exactly one worker was attached to attempt teardown, and it WAS detached + # (the bug: it stayed attached). No worker is left dangling attached. + assert fake.attach_workers == [0x1000] + assert fake.detached == [0x1000] + assert fake.attached == set() + + # A cross-thread retry (another OS thread) must now tear down cleanly with a + # fresh worker and no leftover attached worker blocking it. errors = [] - buffer = ctypes.create_string_buffer(b"result") - pointer = ctypes.addressof(buffer) - library = FakeLibrary(resolver_export=True) - return_pointer = lambda *_args: native_returned.set() or pointer - library.run_script = CallableFunction(return_pointer) - library.run_script_with_resolver = CallableFunction(return_pointer) - library.run_script_callback = CallableFunction(return_pointer) - library.run_script_input_output_callback = CallableFunction(return_pointer) - library.graal_attach_thread = CallableFunction(lambda _isolate, _thread: 0) - library.graal_detach_thread = CallableFunction(lambda _thread: 0) - library.free_cstring = CallableFunction( - lambda _thread, _ptr: release_decode.wait(1) and freed.set() - ) - library.graal_tear_down_isolate = CallableFunction( - lambda _thread: teardown_entered.set() or 0 - ) - monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) - runtime = native.NativeRuntime("/tmp/dwlib") - runtime.initialize() - runtime.has_callback_streaming = True - runtime.has_callback_input_output = True - def run(): + def run_retry(): try: - invoke(runtime) - except Exception as error: + with native._isolate_lock: + native._retry_pending_teardown_locked() + except BaseException as error: # pragma: no cover - surfaced via assert errors.append(error) - run_thread = Thread(target=run) - cleanup_thread = Thread(target=runtime.cleanup) - run_thread.start() - assert native_returned.wait(1) - cleanup_thread.start() - - assert not teardown_entered.wait(0.1) - release_decode.set() - assert freed.wait(1) - run_thread.join(1) - cleanup_thread.join(1) - - assert not run_thread.is_alive() - assert not cleanup_thread.is_alive() - assert teardown_entered.is_set() - assert errors == [] + thread = Thread(target=run_retry) + thread.start() + thread.join(5) + + assert not thread.is_alive() + assert not errors + # Retry succeeded: flag cleared and globals nulled. + assert native._teardown_needed is False + assert native._isolate is None + assert native._lib is None + # A second, fresh worker was attached for the retry and used for the + # successful teardown. Its worker is intentionally NOT detached (isolate + # destroyed -> pointer invalid), so only the FAILED-teardown worker (0x1000) + # is ever detached. + assert fake.attach_workers == [0x1000, 0x2000] + assert fake.tear_down_workers == [0x1000, 0x2000] + assert fake.detached == [0x1000] # success path does not detach @pytest.mark.unit -def test_run_script_with_resolver_rejects_missing_native_export(monkeypatch): +def test_two_engines_dispatch_to_their_own_resolver(monkeypatch): library = FakeLibrary() monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) - runtime = native.NativeRuntime("/tmp/dwlib") - runtime.initialize() - with pytest.raises( - dataweave.DataWeaveError, - match=r"Native library does not support module resolver API \(run_script_with_resolver not found\)\.", - ): - runtime.run_script_with_resolver( - "thread", b"script", b"{}", lambda _path: "module source" - ) + a = native.NativeRuntime("/tmp/dwlib") + a.install_resolver(lambda path: f"A:{path}") + a.initialize() + b = native.NativeRuntime("/tmp/dwlib") + b.install_resolver(lambda path: f"B:{path}") + b.initialize() + # ctx tokens are distinct and registered. + _ha, cb_a, ctx_a = next(e for e in library.created_engines if e[0] == a.handle) + _hb, cb_b, ctx_b = next(e for e in library.created_engines if e[0] == b.handle) + assert ctx_a != ctx_b + assert native._resolver_registry[ctx_a] is a + assert native._resolver_registry[ctx_b] is b -@pytest.mark.unit -def test_native_runtime_retains_one_resolver_callback_until_teardown(monkeypatch): - retained_during_teardown = [] - library = FakeLibrary(resolver_export=True) - library.run_script_with_resolver = CallableFunction( - lambda _thread, _script, _inputs, _callback: 0 - ) - monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) - runtime = native.NativeRuntime("/tmp/dwlib") - library.graal_tear_down_isolate = CallableFunction( - lambda _thread: retained_during_teardown.append( - runtime._module_resolver_callback is not None - ) or 0 - ) - runtime.initialize() - resolver = lambda _path: "module source" - - runtime.run_script_with_resolver("thread", b"script", b"{}", resolver) - callback = runtime._module_resolver_callback - runtime.run_script_with_resolver("thread", b"script", b"{}", resolver) + # Simulate a synchronous resolve on each engine's owner thread. + with a._resolver_scope(): + ptr_a = cb_a(None, ctx_a, b"org/x.dwl") + assert ctypes.string_at(ptr_a) == b"A:org/x.dwl" - assert runtime._module_resolver_callback is callback - with pytest.raises(dataweave.DataWeaveError): - runtime.run_script_with_resolver( - "thread", b"script", b"{}", lambda _path: "other source" - ) - - runtime.cleanup() + with b._resolver_scope(): + ptr_b = cb_b(None, ctx_b, b"org/x.dwl") + assert ctypes.string_at(ptr_b) == b"B:org/x.dwl" - assert retained_during_teardown == [True] - assert runtime._module_resolver_callback is None - assert runtime._module_resolver is None + a.cleanup() + assert ctx_a not in native._resolver_registry + b.cleanup() @pytest.mark.unit -def test_cleanup_failure_preserves_runtime_state_for_successful_retry(monkeypatch): - library = FakeLibrary(resolver_export=True) - library.run_script_with_resolver = CallableFunction( - lambda _thread, _script, _inputs, _callback: 0 - ) - tear_down_results = iter((7, 0)) - library.graal_tear_down_isolate = CallableFunction( - lambda _thread: next(tear_down_results) - ) +def test_resolver_fails_closed_off_the_owner_thread_without_invoking_python(monkeypatch): + library = FakeLibrary() monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) - runtime = native.NativeRuntime("/tmp/dwlib") - runtime.initialize() - isolate = runtime.isolate - thread = runtime.thread - resolver = lambda _path: "module source" - runtime.run_script_with_resolver("thread", b"script", b"{}", resolver) - callback = runtime._module_resolver_callback - - with pytest.raises( - dataweave.DataWeaveError, - match="Failed to tear down GraalVM isolate. Error code: 7", - ): - runtime.cleanup() - assert runtime.initialized is True - assert runtime.lib is library - assert runtime.isolate is isolate - assert runtime.thread is thread - assert runtime.has_module_resolver is True - assert runtime._module_resolver is resolver - assert runtime._module_resolver_callback is callback - - runtime.cleanup() - - assert runtime.initialized is False - assert runtime.lib is None - assert runtime.isolate is None - assert runtime.thread is None - assert runtime._module_resolver is None - assert runtime._module_resolver_callback is None + calls = [] + a = native.NativeRuntime("/tmp/dwlib") + a.install_resolver(lambda path: calls.append(path) or "src") + a.initialize() + _h, callback, ctx = library.created_engines[0] + + # Not inside a synchronous resolver scope (mirrors a streaming worker): must + # return None WITHOUT invoking the Python resolver. + assert callback(None, ctx, b"org/x.dwl") is None + assert calls == [] + + # Inside the scope but on a different Python thread ident: still fail-closed. + results = [] + def worker(): + with a._resolver_scope(): + # Overwrite the active ident to the worker's, but call from... actually + # _resolver_scope records THIS thread's ident, so a same-thread call + # resolves. Assert the positive to anchor the guard semantics. + results.append(callback(None, ctx, b"org/y.dwl")) + import threading + t = threading.Thread(target=worker) + t.start(); t.join(2) + assert results and ctypes.string_at(results[0]) == b"src" + + a.cleanup() @pytest.mark.unit -def test_cleanup_from_worker_uses_current_thread_for_isolate_teardown(monkeypatch): +def test_bootstrap_thread_is_detached_after_isolate_create(monkeypatch): + # Regression (final review Finding #1): the isolate's bootstrap thread must be + # detached immediately after graal_create_isolate, before anything attaches a + # fresh thread for engine creation. So a last release on a different OS + # thread can tear down without blocking on a phantom attachment. + # + # NOTE on comparison strategy: FakeLibrary's stubs write NULL pointers into + # their out-params (there is no real native memory backing them here), so + # pointer VALUES (and even object identity, since nothing ever aliases the + # bootstrap thread object across calls) cannot distinguish "the bootstrap + # thread" from a later attach. What CAN be checked -- and is exactly what + # Finding #1 is about -- is call ORDER: detach must happen immediately + # after create_isolate, strictly before the attach used for engine create. library = FakeLibrary() - teardown_calls = [] - library.graal_tear_down_isolate = CallableFunction( - lambda thread: teardown_calls.append((get_ident(), thread)) or 0 - ) - monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) - runtime = native.NativeRuntime("/tmp/dwlib") - runtime.initialize() - owner_ident = get_ident() + events = [] - worker = Thread(target=runtime.cleanup) - worker.start() - worker.join(1) + def create_isolate(_params, _isolate, _thread_out): + events.append("create_isolate") + return 0 - assert not worker.is_alive() - worker_ident, teardown_thread = teardown_calls[0] - assert worker_ident != owner_ident - assert library.attach_calls[0][0] == worker_ident - assert ctypes.cast(teardown_thread, ctypes.c_void_p).value == ctypes.cast( - library.attach_calls[0][1], ctypes.c_void_p - ).value - assert library.detach_calls == [] - assert runtime.initialized is False + def detach_thread(_thread): + events.append("detach") + return 0 + def attach_thread(isolate, thread_out): + events.append("attach") + return library._attach_thread(isolate, thread_out) -@pytest.mark.unit -def test_failed_cleanup_from_worker_detaches_and_preserves_state_for_owner_retry(monkeypatch): - library = FakeLibrary() - tear_down_results = iter((7, 0)) - library.graal_tear_down_isolate = CallableFunction( - lambda _thread: next(tear_down_results) - ) + library.graal_create_isolate = CallableFunction(create_isolate) + library.graal_detach_thread = CallableFunction(detach_thread) + library.graal_attach_thread = CallableFunction(attach_thread) monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) + runtime = native.NativeRuntime("/tmp/dwlib") runtime.initialize() - errors = [] - - worker = Thread(target=lambda: _capture_error(errors, runtime.cleanup)) - worker.start() - worker.join(1) - - assert not worker.is_alive() - assert len(errors) == 1 - assert runtime.initialized is True - assert len(library.attach_calls) == 1 - assert len(library.detach_calls) == 1 + assert events[:2] == ["create_isolate", "detach"], ( + "bootstrap thread was not detached immediately after graal_create_isolate" + ) + assert "attach" in events[2:], "engine create never attached its own thread" + assert events.index("attach") > events.index("detach"), ( + "engine create attached before the bootstrap thread was detached" + ) runtime.cleanup() - assert runtime.initialized is False - @pytest.mark.unit -def test_failed_worker_cleanup_preserves_teardown_error_when_detach_also_fails(monkeypatch): +def test_failed_init_with_resolver_unregisters_the_token(monkeypatch): library = FakeLibrary() - library.graal_tear_down_isolate = CallableFunction(lambda _thread: 7) - library.graal_detach_thread = CallableFunction( - lambda _thread: (_ for _ in ()).throw(RuntimeError("detach failed")) + library.create_engine_with_resolver = CallableFunction( + lambda _thread, _cb, _ctx: (_ for _ in ()).throw(RuntimeError("boom")) ) monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) - runtime = native.NativeRuntime("/tmp/dwlib") - runtime.initialize() - errors = [] - - worker = Thread(target=lambda: _capture_error(errors, runtime.cleanup)) - worker.start() - worker.join(1) - - assert not worker.is_alive() - assert len(errors) == 1 - assert str(errors[0]) == "Failed to tear down GraalVM isolate. Error code: 7" - assert runtime.initialized is True - - -@pytest.mark.unit -def test_native_runtime_wraps_library_load_errors(monkeypatch): - monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: (_ for _ in ()).throw(OSError("bad image"))) - - with pytest.raises(dataweave.DataWeaveError, match="Failed to load library from /tmp/dwlib: bad image"): - native.NativeRuntime("/tmp/dwlib").initialize() - - -@pytest.mark.unit -def test_initialize_resets_state_when_isolate_creation_fails(monkeypatch): - class Function: - def __call__(self, *_args): - return 9 - library = type("Native", (), {"graal_create_isolate": Function()})() - monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) runtime = native.NativeRuntime("/tmp/dwlib") - - with pytest.raises(dataweave.DataWeaveError, match="Failed to create GraalVM isolate. Error code: 9"): + runtime.install_resolver(lambda path: "src") + token = runtime._resolver_token + assert native._resolver_registry.get(token) is runtime + with pytest.raises(native.DataWeaveError): runtime.initialize() - assert runtime.lib is None - assert runtime.isolate is None - assert runtime.thread is None - assert runtime.initialized is False - - -@pytest.mark.unit -def test_initialize_requires_create_isolate_export(monkeypatch): - monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: object()) - - with pytest.raises(dataweave.DataWeaveError, match="Native library does not export graal_create_isolate"): - native.NativeRuntime("/tmp/dwlib").initialize() + assert token not in native._resolver_registry + assert native._isolate_ref_count == 0 + assert native._isolate is None @pytest.mark.unit -def test_initialize_wraps_create_isolate_exception(monkeypatch): - class Function: - def __call__(self, *_args): - raise RuntimeError("native create failure") - - library = type("Native", (), {"graal_create_isolate": Function()})() - monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) - - with pytest.raises(dataweave.DataWeaveError, match="Failed to create GraalVM isolate: native create failure"): - native.NativeRuntime("/tmp/dwlib").initialize() - - -@pytest.mark.unit -def test_cleanup_wraps_teardown_exception(): - runtime = native.NativeRuntime.__new__(native.NativeRuntime) - runtime.initialized = True - runtime.thread = object() - runtime.isolate = object() - runtime.lib = type("Native", (), {"graal_tear_down_isolate": lambda _self, _thread: (_ for _ in ()).throw(RuntimeError("native teardown failure"))})() - - with pytest.raises(dataweave.DataWeaveError, match="Failed to tear down GraalVM isolate: native teardown failure"): - runtime.cleanup() - - -@pytest.mark.unit -def test_initialize_tears_down_isolate_when_required_export_is_missing(monkeypatch): - class Function: - def __init__(self, callback): - self.callback = callback - - def __call__(self, *args): - return self.callback(*args) +def test_failed_acquire_with_resolver_unregisters_the_token(monkeypatch): + """A library-load failure inside _acquire_isolate must still roll back the + resolver token (regression: _acquire_isolate was called outside + initialize()'s try, so the rollback below never ran).""" + monkeypatch.setattr( + native.ctypes, "CDLL", lambda _path: (_ for _ in ()).throw(OSError("no lib")) + ) - torn_down = [] - library = type("Native", (), {})() - library.graal_create_isolate = Function(lambda _params, _isolate, _thread: 0) - library.graal_tear_down_isolate = Function(lambda thread: torn_down.append(thread) or 0) - monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) runtime = native.NativeRuntime("/tmp/dwlib") + runtime.install_resolver(lambda path: "src") + token = runtime._resolver_token + assert native._resolver_registry.get(token) is runtime - with pytest.raises(dataweave.DataWeaveError, match="Native library does not export run_script"): + with pytest.raises(native.DataWeaveError): runtime.initialize() - assert len(torn_down) == 1 - assert runtime.lib is None - assert runtime.isolate is None - assert runtime.thread is None + assert token not in native._resolver_registry + assert runtime._resolver_token == 0 + assert native._isolate_ref_count == 0 + assert native._isolate is None @pytest.mark.unit -def test_initialize_rejects_streaming_export_without_required_lifecycle_symbols(monkeypatch): - class Function: - def __init__(self, callback=lambda *_args: 0): - self.callback = callback - - def __call__(self, *args): - return self.callback(*args) - - torn_down = [] - library = type("Native", (), {})() - library.graal_create_isolate = Function() - library.graal_tear_down_isolate = Function(lambda thread: torn_down.append(thread) or 0) - library.run_script = Function() - library.run_script_callback = Function() +def test_concurrent_initialize_on_one_instance_creates_a_single_engine(monkeypatch): + # Finding (review #10 #2): initialize() has no instance-level lock spanning + # the initialized-check -> _acquire_isolate -> _create_engine -> publish + # sequence. Two threads calling initialize() on the SAME instance can both + # pass the check, both acquire (refcount over-counts), and both create an + # engine -- the second self.handle write orphans the first, and cleanup() + # then releases only one ref. + library = FakeLibrary() monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) - with pytest.raises(dataweave.DataWeaveError, match="Native library does not export free_cstring"): - native.NativeRuntime("/tmp/dwlib").initialize() - - assert len(torn_down) == 1 - - -@pytest.mark.unit -@pytest.mark.parametrize("missing_symbol", ["graal_attach_thread", "graal_detach_thread"]) -def test_initialize_rejects_streaming_export_without_thread_lifecycle_symbols(monkeypatch, missing_symbol): - class Function: - def __call__(self, *_args): - return 0 + runtime = native.NativeRuntime("/tmp/dwlib") - library = type("Native", (), {})() - library.graal_create_isolate = Function() - library.graal_tear_down_isolate = Function() - library.run_script = Function() - library.free_cstring = Function() - library.run_script_callback = Function() - for symbol in ("graal_attach_thread", "graal_detach_thread"): - if symbol != missing_symbol: - setattr(library, symbol, Function()) - monkeypatch.setattr(native.ctypes, "CDLL", lambda _path: library) + # A 2-party barrier with a timeout, patched into the instance's + # _create_engine. On the UNFIXED code both threads pass the `if + # self.initialized: return` fast-path concurrently and reach here at + # roughly the same time, so the barrier is satisfied and both proceed to + # create an engine (reproducing the over-count). On the FIXED + # (per-instance-locked) code only one thread is ever inside initialize() + # at a time, so the second party never arrives here before the timeout; + # the wait times out, the barrier breaks, and the lone thread just + # proceeds -- this must NOT deadlock the fixed code. + barrier = Barrier(2) + orig_create_engine = runtime._create_engine + + def slow_create_engine(): + try: + barrier.wait(timeout=0.5) + except BrokenBarrierError: + pass + return orig_create_engine() - with pytest.raises(dataweave.DataWeaveError, match=f"Native library does not export {missing_symbol}"): - native.NativeRuntime("/tmp/dwlib").initialize() + monkeypatch.setattr(runtime, "_create_engine", slow_create_engine) + errors = [] -@pytest.mark.unit -def test_cleanup_surfaces_native_teardown_error_code(monkeypatch): - runtime = native.NativeRuntime.__new__(native.NativeRuntime) - runtime.initialized = True - runtime.thread = object() - runtime.isolate = object() - runtime.lib = type("Native", (), {"graal_tear_down_isolate": lambda _self, _thread: 7})() + def call_initialize(): + try: + runtime.initialize() + except BaseException as error: # pragma: no cover - surfaced via assert + errors.append(error) - with pytest.raises(dataweave.DataWeaveError, match="Failed to tear down GraalVM isolate. Error code: 7"): - runtime.cleanup() + threads = [Thread(target=call_initialize) for _ in range(2)] + for thread in threads: + thread.start() + for thread in threads: + thread.join(5) + assert not any(thread.is_alive() for thread in threads), "initialize() deadlocked" + assert not errors assert runtime.initialized is True - assert runtime.lib is not None - assert runtime.thread is not None - assert runtime.isolate is not None + # Exactly one acquire, exactly one engine -- no over-count regardless of + # how the two calls interleaved. + assert native._isolate_ref_count == 1 + assert len(library.created_engines) == 1 + assert runtime.handle == library.created_engines[0][0] - -@pytest.mark.unit -@pytest.mark.parametrize( - ("method_name", "error_message"), - [ - ("attach_thread", "Failed to attach worker thread to isolate: native attach failure"), - ("detach_thread", "Failed to detach worker thread from isolate: native detach failure"), - ], -) -def test_thread_lifecycle_wraps_native_invocation_errors(method_name, error_message): - class Native: - def graal_attach_thread(self, _isolate, _thread): - raise RuntimeError("native attach failure") - - def graal_detach_thread(self, _thread): - raise RuntimeError("native detach failure") - - runtime = native.NativeRuntime.__new__(native.NativeRuntime) - runtime.lib = Native() - runtime.isolate = object() - - with pytest.raises(dataweave.DataWeaveError, match=error_message): - if method_name == "attach_thread": - runtime.attach_thread() - else: - runtime.detach_thread(object()) + runtime.cleanup() + assert native._isolate_ref_count == 0 diff --git a/native-lib/python/tests/unit/test_runtime.py b/native-lib/python/tests/unit/test_runtime.py new file mode 100644 index 00000000..b32ad3a0 --- /dev/null +++ b/native-lib/python/tests/unit/test_runtime.py @@ -0,0 +1,69 @@ +import pytest + +from dataweave import native, runtime +from dataweave.runtime import DataWeave + + +class _FakeNative: + def __init__(self, lib_path=None): + self.installed_resolver = None + self.initialized = False + self.handle = 0 + self.thread = object() + self.has_callback_streaming = True + self.has_callback_input_output = True + self.cleaned = 0 + self.runs = [] + self.install_resolver_calls = 0 + + def install_resolver(self, resolver): + assert not self.initialized, "Cannot install a resolver after initialize()" + self.installed_resolver = resolver + self.install_resolver_calls += 1 + + def initialize(self): + self.initialized = True + self.handle = 7 + + def run_engine_and_decode(self, script, inputs): + self.runs.append((script, inputs)) + return '{"success":true,"result":"","binary":false,"mimeType":"application/json","charset":"UTF-8"}' + + def cleanup(self): + self.cleaned += 1 + self.initialized = False + + +@pytest.mark.unit +def test_dataweave_installs_resolver_before_initialize(monkeypatch): + monkeypatch.setattr(runtime, "NativeRuntime", _FakeNative) + resolver = lambda path: None + dw = DataWeave(resolve_module=resolver) + dw.initialize() + assert dw._native.installed_resolver is resolver + assert dw._native.initialized is True + dw.cleanup() + assert dw._native.cleaned == 1 + + +@pytest.mark.unit +def test_initialize_is_idempotent_with_resolver(monkeypatch): + monkeypatch.setattr(runtime, "NativeRuntime", _FakeNative) + resolver = lambda path: None + dw = DataWeave(resolve_module=resolver) + dw.initialize() + # Second call must be a harmless no-op, not raise "Cannot install a resolver after initialize()". + dw.initialize() + assert dw._native.initialized is True + assert dw._native.install_resolver_calls == 1 + dw.cleanup() + + +@pytest.mark.unit +def test_run_routes_through_engine(monkeypatch): + monkeypatch.setattr(runtime, "NativeRuntime", _FakeNative) + dw = DataWeave() + dw.initialize() + dw.run("1 + 1") + assert dw._native.runs == [(b"1 + 1", b"{}")] + dw.cleanup() diff --git a/native-lib/python/tests/unit/test_streaming.py b/native-lib/python/tests/unit/test_streaming.py index 8f68a2ee..ee00ad78 100644 --- a/native-lib/python/tests/unit/test_streaming.py +++ b/native-lib/python/tests/unit/test_streaming.py @@ -1,6 +1,6 @@ import ctypes from queue import Full, Queue -from threading import current_thread, Event, Thread +from threading import Event, Lock, Thread from time import sleep import pytest @@ -40,14 +40,14 @@ def _response_pointer(self): self._buffers.append(buffer) return ctypes.addressof(buffer) - def run_script_callback(self, _thread, _script, _inputs, write_callback, _context): + def run_script_callback_engine(self, _thread, _handle, _script, _inputs, write_callback, _context): if self.emit: buffer = ctypes.create_string_buffer(self.emit) self.write_status = write_callback(None, ctypes.addressof(buffer), len(self.emit)) return self._response_pointer() - def run_script_input_output_callback( - self, _thread, _script, _inputs, _input_name, _mime_type, _charset, read_callback, write_callback, _context, + def run_script_input_output_callback_engine( + self, _thread, _handle, _script, _inputs, _input_name, _mime_type, _charset, read_callback, write_callback, _context, ): if self.consume_input: buffer = ctypes.create_string_buffer(3) @@ -66,6 +66,9 @@ def run_script_input_output_callback( assert write_callback(None, ctypes.addressof(buffer), len(self.emit)) == 0 return self._response_pointer() + def destroy_engine(self, _thread, _handle): + self.destroyed_handle = _handle + def configured_runtime(native): runtime = dataweave.DataWeave.__new__(dataweave.DataWeave) @@ -75,8 +78,19 @@ def configured_runtime(native): native_runtime.has_callback_input_output = True native_runtime.lib = native native_runtime.isolate = object() - native_runtime.thread = object() - native_runtime._owner_thread = current_thread() + # No persistent attachment (attach-on-demand): every synchronous call -- + # including cleanup() -- attaches its own thread via the FakeNative's + # graal_attach_thread/graal_detach_thread. + native_runtime.thread = None + native_runtime.handle = 1 + native_runtime._resolver = None + native_runtime._resolver_callback = None + native_runtime._resolver_token = 0 + native_runtime._resolver_buffers = [] + native_runtime._resolver_active = False + native_runtime._resolver_active_ident = None + native_runtime._resolver_lock = Lock() + native_runtime._execution_owner = None runtime._native = native_runtime return runtime @@ -234,7 +248,7 @@ def __init__(self): self.first_chunk_written = Event() self.cancelled = None - def run_script_callback(self, _thread, _script, _inputs, write_callback, _context): + def run_script_callback_engine(self, _thread, _handle, _script, _inputs, write_callback, _context): first = ctypes.create_string_buffer(b"first") assert write_callback(None, ctypes.addressof(first), 5) == 0 self.first_chunk_written.set() @@ -259,8 +273,8 @@ def run_script_callback(self, _thread, _script, _inputs, write_callback, _contex @pytest.mark.unit def test_run_input_output_callback_rejects_oversized_read_chunk_without_truncating(): class OversizedInputNative(FakeNative): - def run_script_input_output_callback( - self, _thread, _script, _inputs, _input_name, _mime_type, _charset, read_callback, _write_callback, _context, + def run_script_input_output_callback_engine( + self, _thread, _handle, _script, _inputs, _input_name, _mime_type, _charset, read_callback, _write_callback, _context, ): buffer = ctypes.create_string_buffer(3) self.read_status = read_callback(None, ctypes.addressof(buffer), len(buffer)) @@ -298,7 +312,7 @@ def __init__(self): self.queue_full = Event() self.cancelled = None - def run_script_callback(self, _thread, _script, _inputs, write_callback, _context): + def run_script_callback_engine(self, _thread, _handle, _script, _inputs, write_callback, _context): first = ctypes.create_string_buffer(b"first") assert write_callback(None, ctypes.addressof(first), 5) == 0 second = ctypes.create_string_buffer(b"second") @@ -334,7 +348,7 @@ def test_runtime_module_owns_dataweave_orchestration(): @pytest.mark.unit def test_run_streaming_reports_worker_timeout_when_native_call_produces_no_output(monkeypatch): class BlockingFakeNative(FakeNative): - def run_script_callback(self, _thread, _script, _inputs, _write_callback, _context): + def run_script_callback_engine(self, _thread, _handle, _script, _inputs, _write_callback, _context): sleep(0.05) return self._response_pointer() @@ -348,7 +362,6 @@ def run_script_callback(self, _thread, _script, _inputs, _write_callback, _conte @pytest.mark.unit def test_stream_worker_start_failure_does_not_block_cleanup(monkeypatch): native = FakeNative('{"success": true}') - native.graal_tear_down_isolate = lambda _thread: 0 runtime = configured_runtime(native) def fail_start(_worker): @@ -364,7 +377,7 @@ def fail_start(_worker): @pytest.mark.unit def test_stream_finalization_does_not_raise_when_a_native_worker_cannot_cancel(monkeypatch): class UncancellableNative(FakeNative): - def run_script_callback(self, _thread, _script, _inputs, _write_callback, _context): + def run_script_callback_engine(self, _thread, _handle, _script, _inputs, _write_callback, _context): sleep(0.1) return self._response_pointer() @@ -384,14 +397,13 @@ def __init__(self): self.release = Event() self.torn_down = False - def run_script_callback(self, _thread, _script, _inputs, _write_callback, _context): + def run_script_callback_engine(self, _thread, _handle, _script, _inputs, _write_callback, _context): self.started.set() self.release.wait() return self._response_pointer() - def graal_tear_down_isolate(self, _thread): + def destroy_engine(self, _thread, _handle): self.torn_down = True - return 0 monkeypatch.setattr(runtime_module, "_WORKER_JOIN_TIMEOUT_SECONDS", 0.001) native = BlockingNative() @@ -430,10 +442,9 @@ def __init__(self): self.cleanup_started = Event() self.release_cleanup = Event() - def graal_tear_down_isolate(self, _thread): + def destroy_engine(self, _thread, _handle): self.cleanup_started.set() self.release_cleanup.wait() - return 0 native = BlockingCleanupNative() runtime = configured_runtime(native) diff --git a/native-lib/src/main/java/org/mule/weave/lib/CallbackWeaveResourceResolver.java b/native-lib/src/main/java/org/mule/weave/lib/CallbackWeaveResourceResolver.java index d6b80912..c2596084 100644 --- a/native-lib/src/main/java/org/mule/weave/lib/CallbackWeaveResourceResolver.java +++ b/native-lib/src/main/java/org/mule/weave/lib/CallbackWeaveResourceResolver.java @@ -3,6 +3,7 @@ import org.graalvm.nativeimage.CurrentIsolate; import org.graalvm.nativeimage.c.type.CCharPointer; import org.graalvm.nativeimage.c.type.CTypeConversion; +import org.graalvm.word.PointerBase; import org.mule.weave.v2.parser.ast.variables.NameIdentifier; import org.mule.weave.v2.sdk.NameIdentifierHelper; import org.mule.weave.v2.sdk.WeaveResource; @@ -20,12 +21,14 @@ */ public class CallbackWeaveResourceResolver implements WeaveResourceResolver { private final NativeCallbacks.ResolveModuleCallback callback; + private final PointerBase ctx; - public CallbackWeaveResourceResolver(NativeCallbacks.ResolveModuleCallback callback) { + public CallbackWeaveResourceResolver(NativeCallbacks.ResolveModuleCallback callback, PointerBase ctx) { if (callback.isNull()) { throw new IllegalArgumentException("Resolver callback cannot be null"); } this.callback = callback; + this.ctx = ctx; } @Override @@ -42,6 +45,7 @@ public Option resolve(NameIdentifier nameIdentifier) { // Invoke callback (blocks if threadsafe function is in use) CCharPointer resultPtr = callback.invoke( CurrentIsolate.getCurrentThread(), + ctx, pathPtr ); @@ -59,8 +63,21 @@ public Option resolve(NameIdentifier nameIdentifier) { ); } } catch (Exception e) { - // Log and return empty on any error - System.err.println("Error resolving module " + path + ": " + e.getMessage()); + // Log and return empty on any error. Mirrors the C-side resolver bridge's + // policy (see resolve_module_callback in addon.c): both the exception + // message AND the module path are resolver-controlled/dynamic content + // (module source, file paths, credentials can leak through either), so + // the default log line is fully static/content-free, with no path and no + // message. Only include them when the caller has opted in via + // DATAWEAVE_RESOLVER_DEBUG=1. + if ("1".equals(System.getenv("DATAWEAVE_RESOLVER_DEBUG"))) { + System.err.println("Error resolving module " + path + ": " + e.getMessage()); + } else { + System.err.println( + "Error resolving module (details suppressed; set " + + "DATAWEAVE_RESOLVER_DEBUG=1 to log path/message — may expose " + + "resolver-controlled data)."); + } return Option.empty(); } } diff --git a/native-lib/src/main/java/org/mule/weave/lib/NativeCallbacks.java b/native-lib/src/main/java/org/mule/weave/lib/NativeCallbacks.java index 3e993c7e..2deaddd3 100644 --- a/native-lib/src/main/java/org/mule/weave/lib/NativeCallbacks.java +++ b/native-lib/src/main/java/org/mule/weave/lib/NativeCallbacks.java @@ -55,6 +55,6 @@ public interface ReadCallback extends CFunctionPointer { */ public interface ResolveModuleCallback extends CFunctionPointer { @InvokeCFunctionPointer - CCharPointer invoke(IsolateThread thread, CCharPointer modulePath); + CCharPointer invoke(IsolateThread thread, PointerBase ctx, CCharPointer modulePath); } } diff --git a/native-lib/src/main/java/org/mule/weave/lib/NativeLib.java b/native-lib/src/main/java/org/mule/weave/lib/NativeLib.java index 549ea3ac..7abf0832 100644 --- a/native-lib/src/main/java/org/mule/weave/lib/NativeLib.java +++ b/native-lib/src/main/java/org/mule/weave/lib/NativeLib.java @@ -20,26 +20,18 @@ public class NativeLib { /** - * Native method that executes a DataWeave script with inputs and returns the result. - * Can be called from Python via FFI. - * - * @param thread the isolate thread (automatically provided by GraalVM) - * @param script the DataWeave script to execute (C string pointer) - * @param inputsJson JSON string containing the inputs map with content (base64 encoded), mimeType, properties and charset for each binding - * @return the script execution result base64 encoded (C string pointer) + * The exact JSON error payload returned by the per-engine entrypoints + * ({@link #runScriptEngine}, {@link #runScriptCallbackEngine}, + * {@link #runScriptInputOutputCallbackEngine}) when {@code handle} does not identify a + * live engine. Package-visible (rather than embedded as a string literal at each call + * site) so the exact contract can be asserted directly from a JVM unit test, since the + * {@code @CEntryPoint} methods themselves rely on GraalVM word types that only resolve + * inside a compiled native image. */ - @CEntryPoint(name = "run_script") - public static CCharPointer runDwScriptEncoded(IsolateThread thread, CCharPointer script, CCharPointer inputsJson) { - String dwScript = CTypeConversion.toJavaString(script); - String inputs = CTypeConversion.toJavaString(inputsJson); - - ScriptRuntime runtime = ScriptRuntime.getInstance(); - String result = runtime.run(dwScript, inputs); - return toUnmanagedCString(result); - } + static final String UNKNOWN_ENGINE_HANDLE_JSON = "{\"success\":false,\"error\":\"Unknown engine handle\"}"; /** - * Frees a C string previously returned by {@link #runDwScriptEncoded(IsolateThread, CCharPointer, CCharPointer)}. + * Frees a C string previously returned by engine entrypoints. * * @param thread the isolate thread (automatically provided by GraalVM) * @param pointer the pointer to the unmanaged C string to free; if null, this is a no-op @@ -57,38 +49,12 @@ public static void freeCString(IsolateThread thread, CCharPointer pointer) { private static final int CALLBACK_BUFFER_SIZE = 8 * 1024; /** - * Executes a DataWeave script and streams the result to a caller-supplied write callback. - * - *

Instead of the session-based open/read/close cycle, the caller passes a - * {@code WriteCallback} function pointer. The Java side reads the output stream in chunks - * and invokes the callback for each chunk until the stream is exhausted.

- * - *

The returned C string is a JSON object with the execution metadata: - *

    - *
  • On success: {@code {"success":true,"mimeType":"...","charset":"...","binary":true/false}}
    • - *
  • On error: {@code {"success":false,"error":"..."}}
    • - *
- * The caller must free the returned pointer with {@link #freeCString}.

- * - * @param thread the isolate thread - * @param script the DataWeave script (C string) - * @param inputsJson JSON-encoded inputs map (C string), may be null - * @param writeCallback function pointer invoked with each output chunk; must return 0 on success - * @param ctx opaque context pointer forwarded to every callback invocation - * @return an unmanaged C string with JSON metadata/error + * Runs the streaming write-callback loop shared by the per-engine entrypoint + * ({@link #runScriptCallbackEngine}). */ - @CEntryPoint(name = "run_script_callback") - public static CCharPointer runScriptCallback( - IsolateThread thread, - CCharPointer script, - CCharPointer inputsJson, - NativeCallbacks.WriteCallback writeCallback, - PointerBase ctx) { - - String dwScript = CTypeConversion.toJavaString(script); - String inputs = inputsJson.isNull() ? null : CTypeConversion.toJavaString(inputsJson); - - ScriptRuntime runtime = ScriptRuntime.getInstance(); + private static CCharPointer streamToWriteCallback( + ScriptRuntime runtime, String dwScript, String inputs, + NativeCallbacks.WriteCallback writeCallback, PointerBase ctx) { StreamSession session = runtime.runStreaming(dwScript, inputs); if (session.isError()) { @@ -129,133 +95,261 @@ public static CCharPointer runScriptCallback( } /** - * Executes a DataWeave script whose output is streamed via a write callback, and whose - * input named {@code inputName} is fed via a read callback. - * - *

The read callback is invoked on a background thread to pull input data while the - * output is pushed to the write callback on the calling thread. This allows fully - * callback-driven input and output streaming in a single call.

- * - *

The returned C string follows the same JSON schema as - * {@link #runScriptCallback}.

- * - * @param thread the isolate thread - * @param script the DataWeave script (C string) - * @param inputsJson JSON-encoded inputs map (C string), may be null; entries for - * {@code inputName} are ignored since the read callback supplies that input - * @param inputName the binding name for the callback-supplied input (C string) - * @param inputMimeType the MIME type of the callback-supplied input (C string) - * @param inputCharset the charset of the callback-supplied input (C string), may be null for UTF-8 - * @param readCallback function pointer invoked to read the next chunk; must return bytes written, - * 0 on EOF, or -1 on error - * @param writeCallback function pointer invoked with each output chunk; must return 0 on success - * @param ctx opaque context pointer forwarded to every callback invocation - * @return an unmanaged C string with JSON metadata/error + * Runs the input-feeder + output-streaming loop shared by the per-engine entrypoint + * ({@link #runScriptInputOutputCallbackEngine}). */ - @CEntryPoint(name = "run_script_input_output_callback") - public static CCharPointer runScriptInputOutputCallback( - IsolateThread thread, - CCharPointer script, - CCharPointer inputsJson, - CCharPointer inputName, - CCharPointer inputMimeType, - CCharPointer inputCharset, - NativeCallbacks.ReadCallback readCallback, - NativeCallbacks.WriteCallback writeCallback, + private static CCharPointer transformViaCallbacks( + ScriptRuntime runtime, String dwScript, String inputs, + String inName, String inMime, String inCharset, + NativeCallbacks.ReadCallback readCallback, NativeCallbacks.WriteCallback writeCallback, PointerBase ctx) { - String dwScript = CTypeConversion.toJavaString(script); - String inputs = inputsJson.isNull() ? null : CTypeConversion.toJavaString(inputsJson); - String inName = CTypeConversion.toJavaString(inputName); - String inMime = CTypeConversion.toJavaString(inputMimeType); - String inCharset = inputCharset.isNull() ? null : CTypeConversion.toJavaString(inputCharset); + // Register the input session and merge its stream-handle entry into the inputs JSON. + // This setup can throw on a malformed `inputs` string; setUpInputSession closes the + // handle and yields an error envelope in that case, so nothing leaks and no exception + // escapes this @CEntryPoint before the feeder is even started. + InputSetup setup = setUpInputSession(inputs, inName, inMime, inCharset); + if (setup.errorEnvelope != null) { + return toUnmanagedCString(setup.errorEnvelope); + } + long inputHandle = setup.handle; - // Create a piped input stream session for the callback-supplied input - InputStreamSession inputSession = new InputStreamSession(inMime, inCharset); - long inputHandle = inputSession.register(); + InputCallbackFeeder feederRunnable = null; + Thread feeder = null; + boolean cleaned = false; + try { + // Start a background thread that calls the readCallback and feeds data into the pipe. + // Word types (CCharPointer, CFunctionPointer, PointerBase) cannot be captured in + // lambdas in GraalVM Native Image, so we use an explicit Runnable that stores their + // raw addresses and reconstitutes them via WordFactory. + final long readCallbackAddr = readCallback.rawValue(); + final long ctxAddr = ctx.rawValue(); + feederRunnable = new InputCallbackFeeder(readCallbackAddr, ctxAddr, setup.session); + feeder = new Thread(feederRunnable, "dw-input-callback-feeder"); + feeder.setDaemon(true); + feeder.start(); - // Merge the stream handle into the inputs JSON - String streamEntry = "{\"streamHandle\":\"" + inputHandle + "\",\"mimeType\":\"" + inMime + "\"" - + (inCharset != null ? ",\"charset\":\"" + inCharset + "\"" : "") + "}"; - String mergedInputs = mergeInputEntry(inputs, inName, streamEntry); - - // Start a background thread that calls the readCallback and feeds data into the pipe. - // Word types (CCharPointer, CFunctionPointer, PointerBase) cannot be captured in - // lambdas in GraalVM Native Image, so we use an explicit Runnable that stores their - // raw addresses and reconstitutes them via WordFactory. - final long readCallbackAddr = readCallback.rawValue(); - final long ctxAddr = ctx.rawValue(); - Thread feeder = new Thread(new InputCallbackFeeder( - readCallbackAddr, ctxAddr, inputSession), "dw-input-callback-feeder"); - feeder.setDaemon(true); - feeder.start(); - - // Execute the script and stream output via the writeCallback - ScriptRuntime runtime = ScriptRuntime.getInstance(); - StreamSession session = runtime.runStreaming(dwScript, mergedInputs); + // Execute the script and stream output via the writeCallback + StreamSession session = runtime.runStreaming(dwScript, setup.mergedInputs); - if (session.isError()) { - cleanupFeeder(feeder, inputHandle); - return toUnmanagedCString("{\"success\":false,\"error\":\"" - + escapeJsonString(session.getError()) + "\"}"); - } + if (session.isError()) { + return toUnmanagedCString("{\"success\":false,\"error\":\"" + + escapeJsonString(session.getError()) + "\"}"); + } - try { - byte[] buf = new byte[CALLBACK_BUFFER_SIZE]; - CCharPointer writeBuf = UnmanagedMemory.malloc(CALLBACK_BUFFER_SIZE); try { - int n; - while ((n = session.read(buf, buf.length)) > 0) { - for (int i = 0; i < n; i++) { - writeBuf.write(i, buf[i]); - } - int rc = writeCallback.invoke(ctx, writeBuf, n); - if (rc != 0) { - cleanupFeeder(feeder, inputHandle); - return toUnmanagedCString("{\"success\":false,\"error\":\"" - + "Write callback returned error: " + rc + "\"}"); + byte[] buf = new byte[CALLBACK_BUFFER_SIZE]; + CCharPointer writeBuf = UnmanagedMemory.malloc(CALLBACK_BUFFER_SIZE); + try { + int n; + while ((n = session.read(buf, buf.length)) > 0) { + for (int i = 0; i < n; i++) { + writeBuf.write(i, buf[i]); + } + int rc = writeCallback.invoke(ctx, writeBuf, n); + if (rc != 0) { + return toUnmanagedCString("{\"success\":false,\"error\":\"" + + "Write callback returned error: " + rc + "\"}"); + } } + } finally { + UnmanagedMemory.free(writeBuf); } } finally { - UnmanagedMemory.free(writeBuf); + session.closeStream(); + } + + // Join the feeder and select the success/error envelope. Delegated to a helper that + // returns a plain String (rather than inlined here) so a JVM unit test can assert the + // join-before-getError() ordering directly against the exact production code path. + String resultJson = selectTransformResult(feederRunnable, feeder, inputHandle, session); + cleaned = true; + return toUnmanagedCString(resultJson); + } catch (Exception e) { + // No Java exception may escape this @CEntryPoint: convert to an error envelope. + String m = e.getMessage(); + if (m == null || m.trim().isEmpty()) { + m = e.toString(); } - } catch (IOException e) { - cleanupFeeder(feeder, inputHandle); return toUnmanagedCString("{\"success\":false,\"error\":\"" - + escapeJsonString(e.getMessage()) + "\"}"); + + escapeJsonString(m) + "\"}"); } finally { - session.closeStream(); + // Sole close of the input handle + feeder join for every path that did not already + // clean up in-try (exception paths and the early error returns). Safe (and a no-op + // cancel/join) when the feeder never started. + if (!cleaned) { + cleanupFeeder(feederRunnable, feeder, inputHandle); + } } + } - cleanupFeeder(feeder, inputHandle); + /** + * Joins the input feeder — via {@link #cleanupFeeder} — and only then reads its + * terminal error, returning the {@code success:false} envelope if it failed or the + * {@code success:true} envelope built from {@code outputSession} otherwise. + * + *

Ordering is the entire point of this method: an in-flight read + * callback that fails after output reached EOF sets {@link InputCallbackFeeder}'s + * terminal error only once it returns, so {@link InputCallbackFeeder#getError()} must not be + * read until {@code cleanupFeeder} has cancelled, unblocked (by closing the input session), + * and joined the feeder thread to completion — otherwise a late failure is missed and + * {@code success:true} is returned over truncated input. The engine usually errors first via + * {@code StreamSession.isError()} (checked by the caller before this method runs); this + * covers the case where it tolerated the truncated input instead.

+ * + *

Package-private (rather than folded inline into {@link #transformViaCallbacks}) so a JVM + * unit test can assert the join-then-read ordering against this exact code path: + * {@code transformViaCallbacks} itself returns a GraalVM {@code CCharPointer}, which cannot be + * exercised from a hosted JVM, but this method returns a plain {@link String}. A test driving + * an in-flight failing read callback through this method would observe {@code success:true} + * instead of the feeder's error if {@code getError()} were ever read before the join — the + * exact regression this method's ordering prevents.

+ */ + static String selectTransformResult(InputCallbackFeeder feederRunnable, Thread feeder, + long inputHandle, StreamSession outputSession) { + cleanupFeeder(feederRunnable, feeder, inputHandle); - return toUnmanagedCString("{\"success\":true" - + ",\"mimeType\":\"" + session.getMimeType() + "\"" - + ",\"charset\":\"" + session.getCharset() + "\"" - + ",\"binary\":" + session.isBinary() - + "}"); + String feederError = feederRunnable.getError(); + if (feederError != null) { + return "{\"success\":false,\"error\":\"" + escapeJsonString(feederError) + "\"}"; + } + + return "{\"success\":true" + + ",\"mimeType\":\"" + outputSession.getMimeType() + "\"" + + ",\"charset\":\"" + outputSession.getCharset() + "\"" + + ",\"binary\":" + outputSession.isBinary() + + "}"; + } + + /** + * Registers a new {@link InputStreamSession} for the callback-supplied input and merges its + * stream-handle entry into {@code inputs}. + * + *

Package-private (rather than {@code private}) so a JVM unit test can drive this + * leak-prone setup region directly: {@link #transformViaCallbacks} itself takes GraalVM + * {@code Word}-typed callbacks and returns a {@code CCharPointer}, neither of which resolves in + * a hosted JVM. This helper uses only plain-Java types.

+ * + *

On success, {@link InputSetup#errorEnvelope} is {@code null}, {@link InputSetup#session} + * and {@link InputSetup#mergedInputs} are populated, and the session is left registered and + * open for the feeder — its handle must ultimately be closed via {@link #cleanupFeeder}. On a + * malformed {@code inputs} string the handle is already closed and + * {@link InputSetup#errorEnvelope} carries the {@code success:false} payload to return + * verbatim, so nothing leaks and no {@code JSONException} escapes.

+ */ + static InputSetup setUpInputSession(String inputs, String inName, String inMime, String inCharset) { + InputStreamSession inputSession = new InputStreamSession(inMime, inCharset); + long inputHandle = inputSession.register(); + try { + org.json.JSONObject streamEntry = new org.json.JSONObject(); + streamEntry.put("streamHandle", Long.toString(inputHandle)); + streamEntry.put("mimeType", inMime); + if (inCharset != null) { + streamEntry.put("charset", inCharset); + } + String mergedInputs = mergeInputEntry(inputs, inName, streamEntry); + return new InputSetup(inputSession, inputHandle, mergedInputs, null); + } catch (Exception e) { + InputStreamSession.close(inputHandle); + String m = e.getMessage(); + if (m == null || m.trim().isEmpty()) { + m = e.toString(); + } + return new InputSetup(null, inputHandle, null, + "{\"success\":false,\"error\":\"" + escapeJsonString(m) + "\"}"); + } + } + + /** + * Outcome of {@link #setUpInputSession}: either a live registered session plus its merged + * inputs ({@link #errorEnvelope} {@code null}), or a {@code success:false} error envelope with + * the handle already closed ({@link #session}/{@link #mergedInputs} {@code null}). + */ + static final class InputSetup { + final InputStreamSession session; + final long handle; + final String mergedInputs; + final String errorEnvelope; + + InputSetup(InputStreamSession session, long handle, String mergedInputs, String errorEnvelope) { + this.session = session; + this.handle = handle; + this.mergedInputs = mergedInputs; + this.errorEnvelope = errorEnvelope; + } } /** * Merges a single input entry into an existing JSON inputs string. */ - private static String mergeInputEntry(String existingJson, String name, String entryJson) { + private static String mergeInputEntry(String existingJson, String name, org.json.JSONObject entry) { org.json.JSONObject obj = (existingJson == null || existingJson.trim().isEmpty()) ? new org.json.JSONObject() : new org.json.JSONObject(existingJson); - obj.put(name, new org.json.JSONObject(entryJson)); + obj.put(name, entry); return obj.toString(); } /** - * Waits for the feeder thread to finish and closes the input session. + * Cancels the input feeder, waits for it to fully exit {@link InputCallbackFeeder#run()} + * (including its {@code finally} block), and closes the input session. + * + *

Why this must not abandon a live feeder: once this method returns, + * {@link #transformViaCallbacks} returns to its {@code @CEntryPoint}, which returns to the + * native caller — at which point the caller is free to release the callback state + * ({@code ctx}). If the feeder thread were still alive it could invoke + * {@code readCallback(ctx, …)} against freed memory, a native use-after-free. Therefore this + * method may only return once {@code thread.isAlive() == false}.

+ * + *

Order (all three are part of stopping the feeder):

+ *
    + *
  1. Signal cancel — {@link InputCallbackFeeder#cancel()} sets a volatile flag the + * loop checks immediately after each {@code readCallback} invocation returns and before + * re-invoking it, so a slow-but-returning in-flight callback breaks the loop instead of + * being re-entered.
    2. + *
  2. Close the input session — this closes both ends of the pipe, which unblocks a + * feeder parked inside {@link InputStreamSession#write} on a full pipe (the next write + * throws {@link IOException} and breaks the loop). This is a legitimate part of the + * cancel signal for the pipe-backpressure case and is harmless on the success path, + * where the feeder has already reached EOF and exited. It also unregisters the handle.
    3. + *
  3. Join without a finite timeout — we wait for {@code run()} to complete rather + * than abandoning the thread after a bound. An {@link InterruptedException} does not end + * the wait (returning early would reopen the use-after-free window); we re-assert the + * interrupt and keep waiting.
    4. + *
+ * + *

Null-safety: when the feeder never started — a setup failure threw + * before {@code feeder.start()} — {@code feederRunnable} and/or {@code thread} may be + * {@code null}. The cancel and join are then no-ops, but the input handle is always + * closed so a failed setup cannot leak the session.

+ * + *

Documented trade-off: cancellation guarantees we wait only for the + * in-flight {@code readCallback} to return — no signal can interrupt native code + * parked inside the caller's callback. A callback that blocks forever inside a single + * invocation therefore cannot be joined and this method would block indefinitely. That is the + * correct trade: the only alternative — abandoning a still-live feeder — is the + * use-after-free this method exists to prevent.

*/ - private static void cleanupFeeder(Thread feeder, long inputHandle) { - try { - feeder.join(5000); - } catch (InterruptedException ignored) { + static void cleanupFeeder(InputCallbackFeeder feederRunnable, Thread thread, long inputHandle) { + if (feederRunnable != null) { + feederRunnable.cancel(); } + // Always drop the session from the registry (and unblock a feeder parked on a full pipe). + // This runs even when the feeder never started, so the input handle is never leaked. InputStreamSession.close(inputHandle); + if (thread == null) { + return; + } + boolean joined = false; + while (!joined) { + try { + thread.join(); + joined = true; + } catch (InterruptedException e) { + // Never abandon a live feeder: re-assert the interrupt and keep waiting. + Thread.currentThread().interrupt(); + } + } } /** @@ -268,11 +362,26 @@ private static void cleanupFeeder(Thread feeder, long inputHandle) { * *

The feeder allocates its own native read buffer and frees it in its {@code finally} * block, ensuring no shared native memory between threads.

+ * + *

Cancellation: {@link #cancel()} sets a {@code volatile} flag that + * {@link #run()} checks immediately after {@code readChunk} (the read callback) + * returns and before the next iteration re-invokes it. This is what closes the + * use-after-free window: once cancellation is requested, a callback that was blocked and then + * returns breaks the loop instead of being re-entered. See + * {@link NativeLib#cleanupFeeder} for the full stop protocol.

+ * + *

Package-private and non-final (rather than {@code private}) so a JVM unit test can + * subclass it and override {@link #readChunk} with a pure-Java blocking source, exercising the + * cancel/join contract without the GraalVM {@code Word}-type machinery + * ({@link WordFactory#pointer}, {@code cb.invoke}), which only initialises inside a compiled + * native image.

*/ - private static final class InputCallbackFeeder implements Runnable { + static class InputCallbackFeeder implements Runnable { private final long readCallbackAddr; private final long ctxAddr; private final InputStreamSession inputSession; + private volatile boolean cancelled = false; + private volatile String feederError; InputCallbackFeeder(long readCallbackAddr, long ctxAddr, InputStreamSession inputSession) { @@ -281,27 +390,96 @@ private static final class InputCallbackFeeder implements Runnable { this.inputSession = inputSession; } - @Override - public void run() { + /** Requests the feeder loop stop after the in-flight {@code readChunk} returns. */ + void cancel() { + cancelled = true; + } + + boolean isCancelled() { + return cancelled; + } + + /** + * The read-callback contract violation that stopped the feeder as an error, or + * {@code null} if the feeder reached a clean EOF (or never ran). Read by + * {@link NativeLib#transformViaCallbacks} after the output loop so a truncated input + * caused by a misbehaving callback is reported as {@code success:false} rather than + * presented as a successful transform. + */ + String getError() { + return feederError; + } + + /** + * Records an out-of-range read-callback length as a feeder error and maps it to the + * error return code ({@code -1}). Per the read convention {@code 0} = EOF, {@code >0} = + * bytes read, {@code -1} = error; any length outside {@code [-1, max]} is a contract + * violation. + */ + private int rejectOutOfRange(int n, int max) { + feederError = "Input read callback returned out-of-range length " + n + + " (max " + max + ")"; + return -1; + } + + /** + * Pulls the next input chunk from the caller-owned read callback into {@code dest}, + * returning the number of bytes read ({@code 0} = EOF, negative = error). + * + *

Reconstitutes the {@code Word}-typed callback and context from their raw addresses + * and copies the bytes out of a freshly allocated native scratch buffer. Overridable so + * JVM tests can supply a pure-Java implementation; production code never overrides it.

+ */ + int readChunk(byte[] dest, int max) { NativeCallbacks.ReadCallback cb = WordFactory.pointer(readCallbackAddr); PointerBase ctx = WordFactory.pointer(ctxAddr); - CCharPointer buf = UnmanagedMemory.malloc(CALLBACK_BUFFER_SIZE); + CCharPointer buf = UnmanagedMemory.malloc(max); try { - while (true) { - int n = cb.invoke(ctx, buf, CALLBACK_BUFFER_SIZE); + int n = cb.invoke(ctx, buf, max); + // Reject a contract violation BEFORE the copy loop: n > max would index past + // dest[] / the native buf (an out-of-bounds copy that used to silently kill the + // feeder and present the engine with a clean EOF on truncated input). + if (n > max || n < -1) { + return rejectOutOfRange(n, max); + } + if (n > 0) { + for (int i = 0; i < n; i++) { + dest[i] = buf.read(i); + } + } + return n; + } finally { + UnmanagedMemory.free(buf); + } + } + + @Override + public void run() { + byte[] tmp = new byte[CALLBACK_BUFFER_SIZE]; + try { + while (!cancelled) { + int n = readChunk(tmp, CALLBACK_BUFFER_SIZE); + // Defence in depth for the overridable readChunk seam: reject any length + // outside [-1, max] here too, so an out-of-range value can never reach the + // write below (which would throw IndexOutOfBounds out of run()). In + // production readChunk has already recorded this and returned -1. + if (n > CALLBACK_BUFFER_SIZE || n < -1) { + n = rejectOutOfRange(n, CALLBACK_BUFFER_SIZE); + } if (n <= 0) { break; // 0 = EOF, negative = error } - byte[] tmp = new byte[n]; - for (int i = 0; i < n; i++) { - tmp[i] = buf.read(i); + // Check AFTER the callback returns and BEFORE re-invoking / writing: once + // cancelled, a slow-but-returning in-flight callback must not be re-entered + // (its ctx may be freed the moment cleanupFeeder returns). + if (cancelled) { + break; } inputSession.write(tmp, n); } } catch (IOException e) { // pipe broken – DW engine will see the error } finally { - UnmanagedMemory.free(buf); try { inputSession.closeWriter(); } catch (IOException ignored) { @@ -330,239 +508,139 @@ private static CCharPointer toUnmanagedCString(String value) { return ptr; } - // ── Resolver-aware FFI Entrypoints ─────────────────────────────────── + // ── Multi-Engine FFI Entrypoints (W-23692110) ──────────────────────── /** - * Runs a DataWeave script with module resolver callback. + * Creates a new isolated engine (ClassLoader-only resolver) and returns its handle. * - *

This variant accepts a {@link NativeCallbacks.ResolveModuleCallback} to resolve - * external modules during script execution. The resolver is installed before script - * execution and remains active for the lifetime of the process.

+ * @param thread the isolate thread + * @return a non-zero handle identifying the new engine + */ + @CEntryPoint(name = "create_engine") + public static long createEngine(IsolateThread thread) { + return ScriptRuntime.register(new ScriptRuntime()); + } + + /** + * Creates a new isolated engine backed by a caller-supplied module resolver callback, + * and returns its handle. * - * @param thread GraalVM isolate thread - * @param script DataWeave script source (C string) - * @param inputsJson JSON string of inputs (C string) - * @param resolverCallback Callback for resolving external modules - * @return JSON result or error message (unmanaged C string, must be freed) + * @param thread the isolate thread + * @param resolverCallback callback used to resolve external modules for this engine only + * @param ctx opaque context pointer forwarded to every resolver invocation + * @return a non-zero handle identifying the new engine */ - @CEntryPoint(name = "run_script_with_resolver") - public static CCharPointer runScriptWithResolver( + @CEntryPoint(name = "create_engine_with_resolver") + public static long createEngineWithResolver( IsolateThread thread, - CCharPointer script, - CCharPointer inputsJson, - NativeCallbacks.ResolveModuleCallback resolverCallback) { - - try { - // Install resolver (idempotent if already set) - ScriptRuntime.setResolver(resolverCallback); - - // Delegate to existing run logic - String dwScript = CTypeConversion.toJavaString(script); - String inputs = CTypeConversion.toJavaString(inputsJson); + NativeCallbacks.ResolveModuleCallback resolverCallback, + PointerBase ctx) { + CallbackWeaveResourceResolver resolver = + new CallbackWeaveResourceResolver(resolverCallback, ctx); + return ScriptRuntime.register(new ScriptRuntime(resolver)); + } - ScriptRuntime runtime = ScriptRuntime.getInstance(); - String result = runtime.run(dwScript, inputs); - return toUnmanagedCString(result); - } catch (Exception e) { - return toUnmanagedCString("{\"success\":false,\"error\":\"" - + escapeJsonString(e.getMessage()) + "\"}"); - } + /** + * Destroys an engine created by {@link #createEngine} / {@link #createEngineWithResolver}. + * A no-op if the handle is unknown or already destroyed. + * + * @param thread the isolate thread + * @param handle the engine handle to remove + */ + @CEntryPoint(name = "destroy_engine") + public static void destroyEngine(IsolateThread thread, long handle) { + ScriptRuntime.destroy(handle); } /** - * Runs a DataWeave script with streaming output and module resolver. + * Executes a DataWeave script against a specific engine. * - *

This variant combines streaming output via a write callback with external module - * resolution. The resolver is installed before script execution.

+ *

If {@code handle} does not identify a live engine, returns + * {@code {"success":false,"error":"Unknown engine handle"}} rather than throwing.

* - * @param thread GraalVM isolate thread - * @param script DataWeave script source (C string) + * @param thread the isolate thread + * @param handle the target engine's handle + * @param script the DataWeave script (C string) * @param inputsJson JSON-encoded inputs map (C string), may be null - * @param writeCallback function pointer invoked with each output chunk - * @param ctx opaque context pointer forwarded to callback - * @param resolverCallback Callback for resolving external modules - * @return an unmanaged C string with JSON metadata/error (must be freed) - * - *

NOTE: compiled/linked but intentionally NOT invoked from the Node binding's - * TypeScript layer. runStreaming() deliberately uses the resolver-less streaming entrypoint - * instead: streaming runs its native call on a background thread, and wiring a resolver - * callback there would call back into JS from a non-owning OS thread (undefined behavior / - * crash). Do not wire this up without first solving that cross-thread hazard.

+ * @return the script execution result (unmanaged C string, must be freed) */ - @CEntryPoint(name = "run_script_callback_with_resolver") - public static CCharPointer runScriptCallbackWithResolver( - IsolateThread thread, - CCharPointer script, - CCharPointer inputsJson, - NativeCallbacks.WriteCallback writeCallback, - PointerBase ctx, - NativeCallbacks.ResolveModuleCallback resolverCallback) { - - try { - // Install resolver - ScriptRuntime.setResolver(resolverCallback); - - // Delegate to existing streaming logic - String dwScript = CTypeConversion.toJavaString(script); - String inputs = inputsJson.isNull() ? null : CTypeConversion.toJavaString(inputsJson); - - ScriptRuntime runtime = ScriptRuntime.getInstance(); - StreamSession session = runtime.runStreaming(dwScript, inputs); - - if (session.isError()) { - return toUnmanagedCString("{\"success\":false,\"error\":\"" - + escapeJsonString(session.getError()) + "\"}"); - } - - try { - byte[] buf = new byte[CALLBACK_BUFFER_SIZE]; - CCharPointer nativeBuf = UnmanagedMemory.malloc(CALLBACK_BUFFER_SIZE); - try { - int n; - while ((n = session.read(buf, buf.length)) > 0) { - for (int i = 0; i < n; i++) { - nativeBuf.write(i, buf[i]); - } - int rc = writeCallback.invoke(ctx, nativeBuf, n); - if (rc != 0) { - return toUnmanagedCString("{\"success\":false,\"error\":\"" - + "Write callback returned error: " + rc + "\"}"); - } - } - } finally { - UnmanagedMemory.free(nativeBuf); - } - } catch (IOException e) { - return toUnmanagedCString("{\"success\":false,\"error\":\"" - + escapeJsonString(e.getMessage()) + "\"}"); - } finally { - session.closeStream(); - } + @CEntryPoint(name = "run_script_engine") + public static CCharPointer runScriptEngine( + IsolateThread thread, long handle, CCharPointer script, CCharPointer inputsJson) { + ScriptRuntime runtime = ScriptRuntime.get(handle); + if (runtime == null) { + return toUnmanagedCString(UNKNOWN_ENGINE_HANDLE_JSON); + } + String dwScript = CTypeConversion.toJavaString(script); + String inputs = inputsJson.isNull() ? null : CTypeConversion.toJavaString(inputsJson); + return toUnmanagedCString(runtime.run(dwScript, inputs)); + } - return toUnmanagedCString("{\"success\":true" - + ",\"mimeType\":\"" + session.getMimeType() + "\"" - + ",\"charset\":\"" + session.getCharset() + "\"" - + ",\"binary\":" + session.isBinary() - + "}"); - } catch (Exception e) { - return toUnmanagedCString("{\"success\":false,\"error\":\"" - + escapeJsonString(e.getMessage()) + "\"}"); + /** + * Executes a DataWeave script against a specific engine, streaming the result to a + * caller-supplied write callback. See {@link #streamToWriteCallback} for the callback contract. + * + *

If {@code handle} does not identify a live engine, returns + * {@code {"success":false,"error":"Unknown engine handle"}} rather than throwing.

+ * + * @param thread the isolate thread + * @param handle the target engine's handle + * @param script the DataWeave script (C string) + * @param inputsJson JSON-encoded inputs map (C string), may be null + * @param writeCallback function pointer invoked with each output chunk; must return 0 on success + * @param ctx opaque context pointer forwarded to every callback invocation + * @return an unmanaged C string with JSON metadata/error + */ + @CEntryPoint(name = "run_script_callback_engine") + public static CCharPointer runScriptCallbackEngine( + IsolateThread thread, long handle, CCharPointer script, CCharPointer inputsJson, + NativeCallbacks.WriteCallback writeCallback, PointerBase ctx) { + ScriptRuntime runtime = ScriptRuntime.get(handle); + if (runtime == null) { + return toUnmanagedCString(UNKNOWN_ENGINE_HANDLE_JSON); } + String dwScript = CTypeConversion.toJavaString(script); + String inputs = inputsJson.isNull() ? null : CTypeConversion.toJavaString(inputsJson); + return streamToWriteCallback(runtime, dwScript, inputs, writeCallback, ctx); } /** - * Runs a DataWeave script with streaming input/output and module resolver. + * Executes a DataWeave script against a specific engine, with a callback-supplied input + * and callback-streamed output. See {@link #transformViaCallbacks} for the callback + * contract. * - *

This variant combines streaming input via read callback, streaming output via write - * callback, and external module resolution. The resolver is installed before script execution.

+ *

If {@code handle} does not identify a live engine, returns + * {@code {"success":false,"error":"Unknown engine handle"}} rather than throwing.

* - * @param thread GraalVM isolate thread - * @param script DataWeave script source (C string) - * @param inputsJson JSON-encoded inputs map (C string), may be null - * @param inputName the binding name for the callback-supplied input (C string) + * @param thread the isolate thread + * @param handle the target engine's handle + * @param script the DataWeave script (C string) + * @param inputsJson JSON-encoded inputs map (C string), may be null + * @param inputName the binding name for the callback-supplied input (C string) * @param inputMimeType the MIME type of the callback-supplied input (C string) - * @param inputCharset the charset of the callback-supplied input (C string), may be null - * @param readCallback function pointer invoked to read input chunks - * @param writeCallback function pointer invoked with output chunks - * @param ctx opaque context pointer forwarded to callbacks - * @param resolverCallback Callback for resolving external modules - * @return an unmanaged C string with JSON metadata/error (must be freed) - * - *

NOTE: compiled/linked but intentionally NOT invoked from the Node binding's - * TypeScript layer. runTransform() deliberately uses the resolver-less transform entrypoint - * instead: transform runs its native call on a background thread, and wiring a resolver - * callback there would call back into JS from a non-owning OS thread (undefined behavior / - * crash). Do not wire this up without first solving that cross-thread hazard.

+ * @param inputCharset the charset of the callback-supplied input (C string), may be null for UTF-8 + * @param readCallback function pointer invoked to read the next chunk + * @param writeCallback function pointer invoked with each output chunk; must return 0 on success + * @param ctx opaque context pointer forwarded to every callback invocation + * @return an unmanaged C string with JSON metadata/error */ - @CEntryPoint(name = "run_script_input_output_callback_with_resolver") - public static CCharPointer runScriptInputOutputCallbackWithResolver( - IsolateThread thread, - CCharPointer script, - CCharPointer inputsJson, - CCharPointer inputName, - CCharPointer inputMimeType, - CCharPointer inputCharset, - NativeCallbacks.ReadCallback readCallback, - NativeCallbacks.WriteCallback writeCallback, - PointerBase ctx, - NativeCallbacks.ResolveModuleCallback resolverCallback) { - - try { - // Install resolver - ScriptRuntime.setResolver(resolverCallback); - - // Delegate to existing streaming I/O logic - String dwScript = CTypeConversion.toJavaString(script); - String inputs = inputsJson.isNull() ? null : CTypeConversion.toJavaString(inputsJson); - String inName = CTypeConversion.toJavaString(inputName); - String inMime = CTypeConversion.toJavaString(inputMimeType); - String inCharset = inputCharset.isNull() ? null : CTypeConversion.toJavaString(inputCharset); - - // Create a piped input stream session for the callback-supplied input - InputStreamSession inputSession = new InputStreamSession(inMime, inCharset); - long inputHandle = inputSession.register(); - - // Merge the stream handle into the inputs JSON - String streamEntry = "{\"streamHandle\":\"" + inputHandle + "\",\"mimeType\":\"" + inMime + "\"" - + (inCharset != null ? ",\"charset\":\"" + inCharset + "\"" : "") + "}"; - String mergedInputs = mergeInputEntry(inputs, inName, streamEntry); - - // Start background thread for reading input - final long readCallbackAddr = readCallback.rawValue(); - final long ctxAddr = ctx.rawValue(); - Thread feeder = new Thread(new InputCallbackFeeder( - readCallbackAddr, ctxAddr, inputSession), "dw-input-callback-feeder"); - feeder.setDaemon(true); - feeder.start(); - - // Execute the script and stream output via the writeCallback - ScriptRuntime runtime = ScriptRuntime.getInstance(); - StreamSession session = runtime.runStreaming(dwScript, mergedInputs); - - if (session.isError()) { - cleanupFeeder(feeder, inputHandle); - return toUnmanagedCString("{\"success\":false,\"error\":\"" - + escapeJsonString(session.getError()) + "\"}"); - } - - try { - byte[] buf = new byte[CALLBACK_BUFFER_SIZE]; - CCharPointer writeBuf = UnmanagedMemory.malloc(CALLBACK_BUFFER_SIZE); - try { - int n; - while ((n = session.read(buf, buf.length)) > 0) { - for (int i = 0; i < n; i++) { - writeBuf.write(i, buf[i]); - } - int rc = writeCallback.invoke(ctx, writeBuf, n); - if (rc != 0) { - cleanupFeeder(feeder, inputHandle); - return toUnmanagedCString("{\"success\":false,\"error\":\"" - + "Write callback returned error: " + rc + "\"}"); - } - } - } finally { - UnmanagedMemory.free(writeBuf); - } - } catch (IOException e) { - cleanupFeeder(feeder, inputHandle); - return toUnmanagedCString("{\"success\":false,\"error\":\"" - + escapeJsonString(e.getMessage()) + "\"}"); - } finally { - session.closeStream(); - } - - cleanupFeeder(feeder, inputHandle); - - return toUnmanagedCString("{\"success\":true" - + ",\"mimeType\":\"" + session.getMimeType() + "\"" - + ",\"charset\":\"" + session.getCharset() + "\"" - + ",\"binary\":" + session.isBinary() - + "}"); - } catch (Exception e) { - return toUnmanagedCString("{\"success\":false,\"error\":\"" - + escapeJsonString(e.getMessage()) + "\"}"); + @CEntryPoint(name = "run_script_input_output_callback_engine") + public static CCharPointer runScriptInputOutputCallbackEngine( + IsolateThread thread, long handle, CCharPointer script, CCharPointer inputsJson, + CCharPointer inputName, CCharPointer inputMimeType, CCharPointer inputCharset, + NativeCallbacks.ReadCallback readCallback, NativeCallbacks.WriteCallback writeCallback, + PointerBase ctx) { + ScriptRuntime runtime = ScriptRuntime.get(handle); + if (runtime == null) { + return toUnmanagedCString(UNKNOWN_ENGINE_HANDLE_JSON); } + String dwScript = CTypeConversion.toJavaString(script); + String inputs = inputsJson.isNull() ? null : CTypeConversion.toJavaString(inputsJson); + String inName = CTypeConversion.toJavaString(inputName); + String inMime = CTypeConversion.toJavaString(inputMimeType); + String inCharset = inputCharset.isNull() ? null : CTypeConversion.toJavaString(inputCharset); + return transformViaCallbacks(runtime, dwScript, inputs, inName, inMime, inCharset, + readCallback, writeCallback, ctx); } } diff --git a/native-lib/src/main/java/org/mule/weave/lib/ScriptRuntime.java b/native-lib/src/main/java/org/mule/weave/lib/ScriptRuntime.java index 3371127a..b8857313 100644 --- a/native-lib/src/main/java/org/mule/weave/lib/ScriptRuntime.java +++ b/native-lib/src/main/java/org/mule/weave/lib/ScriptRuntime.java @@ -20,9 +20,16 @@ import java.io.InputStream; import java.nio.charset.Charset; import java.util.Base64; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.atomic.AtomicLong; /** - * Singleton wrapper around a {@link DWScriptingEngine} used to compile and execute DataWeave scripts. + * Wrapper around a {@link DWScriptingEngine} used to compile and execute DataWeave scripts. + * + *

Each {@link ScriptRuntime} instance owns its own engine (and therefore its own module + * resolver and script cache), so multiple isolated engines can coexist within one process. + * Instances are tracked in a handle-keyed registry so native callers can address a specific + * engine by an opaque {@code long} handle.

* *

Execution results are returned as a JSON string containing a base64-encoded payload plus metadata * (mime type, charset, and whether the result is binary). Errors are returned as a JSON string with @@ -30,84 +37,65 @@ */ public class ScriptRuntime { - private static final ScriptRuntime INSTANCE = new ScriptRuntime(); + // ── Handle registry ────────────────────────────────────────────────── + private static final ConcurrentHashMap REGISTRY = new ConcurrentHashMap<>(); + private static final AtomicLong NEXT_HANDLE = new AtomicLong(1); - // Static field for callback resolver, volatile for thread-safe double-checked locking - private static volatile CallbackWeaveResourceResolver resolver = null; + /** Registers a runtime and returns its non-zero handle. */ + public static long register(ScriptRuntime runtime) { + long handle = NEXT_HANDLE.getAndIncrement(); + REGISTRY.put(handle, runtime); + return handle; + } - /** - * Returns the singleton instance. - * - * @return the shared {@link ScriptRuntime} - */ - public static ScriptRuntime getInstance() { - return INSTANCE; + /** Returns the runtime for a handle, or {@code null} if unknown/destroyed. */ + public static ScriptRuntime get(long handle) { + return REGISTRY.get(handle); + } + + /** Removes a runtime; returns {@code true} if one was present. */ + public static boolean destroy(long handle) { + return REGISTRY.remove(handle) != null; } + // ── Per-instance engine ─────────────────────────────────────────────── + private final DWScriptingEngine engine; + /** - * Sets the module resolver callback and rebuilds the engine. - * Can only be called once per process (engine is a singleton). - * Thread-safe but should be called early in application lifecycle before script execution. + * Builds an engine whose resolver is Composite(ClassLoader-built-ins + {@code customResolver}); + * a null {@code customResolver} yields ClassLoader-only. * - *

IMPORTANT: The callback function must be thread-safe if using - * GraalVM's threadsafe function pointers, as it may be invoked from multiple threads - * during concurrent module resolution.

- * - * @param callback Thread-safe function pointer for resolving modules + * @param customResolver additional resolver for user-supplied modules, or {@code null} */ - public static synchronized void setResolver(NativeCallbacks.ResolveModuleCallback callback) { - if (resolver != null) { - System.err.println("WARNING: Module resolver already set for this process. " + - "Only one resolver configuration is supported. Ignoring new resolver."); - return; - } - - if (callback.isNull()) { - System.err.println("WARNING: Attempted to set null resolver, ignoring."); - return; - } - - resolver = new CallbackWeaveResourceResolver(callback); + public ScriptRuntime(WeaveResourceResolver customResolver) { + this.engine = DWScriptingEngine.builder() + .withDWModuleComponentsFactory(createModuleComponentsFactory(customResolver)) + .build(); + } - // Rebuild engine with composite resolver (built-ins + callback) - synchronized (INSTANCE) { - INSTANCE.engine = DWScriptingEngine.builder() - .withDWModuleComponentsFactory(createModuleComponentsFactory()) - .build(); - } + /** Builds an engine with built-in (ClassLoader) modules only — no custom resolver. */ + public ScriptRuntime() { + this(null); } /** - * Creates composite resolver: ClassLoader (built-ins) + Callback (user modules). - * If no callback resolver is set, returns ClassLoader only. + * Creates composite resolver: ClassLoader (built-ins) + custom (user modules). + * If no custom resolver is provided, returns ClassLoader only. */ - private static WeaveResourceResolver compositeResolver() { + private static WeaveResourceResolver compositeResolver(WeaveResourceResolver customResolver) { WeaveResourceResolver classLoaderResolver = ClassLoaderWeaveResourceResolver.apply(); - - CallbackWeaveResourceResolver currentResolver = resolver; - if (currentResolver == null) { + if (customResolver == null) { return classLoaderResolver; } - return CompositeWeaveResourceResolver.apply( classLoaderResolver, // Try built-ins first - currentResolver // Then callback for user modules + customResolver // Then callback for user modules ); } - private static DWModuleComponentsFactory createModuleComponentsFactory() { + private static DWModuleComponentsFactory createModuleComponentsFactory(WeaveResourceResolver customResolver) { return DWModuleComponentsFactory.createSimpleDWModuleComponentsFactoryBuilder() - .withWeaveResourceResolver(compositeResolver()) - .build(); - } - - // Instance field for the scripting engine, access synchronized in setResolver - private volatile DWScriptingEngine engine; - - private ScriptRuntime() { - // Initialize with ClassLoader-only resolver (no callback yet) - engine = DWScriptingEngine.builder() - .withDWModuleComponentsFactory(createModuleComponentsFactory()) + .withWeaveResourceResolver(compositeResolver(customResolver)) .build(); } @@ -132,10 +120,10 @@ public String run(String script) { * @return a JSON string describing either the successful result or an error */ public String run(String script, String inputsJson) { - ScriptingBindings bindings = parseJsonInputsToBindings(inputsJson); - String[] inputs = bindings.bindingNames(); - try { + ScriptingBindings bindings = parseJsonInputsToBindings(inputsJson); + String[] inputs = bindings.bindingNames(); + DWScript compiled = engine.compileDWScript(script, inputs); DWResult dwResult = compiled.writeDWResult(bindings); @@ -180,10 +168,10 @@ public String run(String script, String inputsJson) { * @return a {@link StreamSession} with the result stream and metadata, or an error session */ public StreamSession runStreaming(String script, String inputsJson) { - ScriptingBindings bindings = parseJsonInputsToBindings(inputsJson); - String[] inputs = bindings.bindingNames(); - try { + ScriptingBindings bindings = parseJsonInputsToBindings(inputsJson); + String[] inputs = bindings.bindingNames(); + DWScript compiled = engine.compileDWScript(script, inputs); DWResult dwResult = compiled.writeDWResult(bindings); @@ -213,48 +201,48 @@ private ScriptingBindings parseJsonInputsToBindings(String inputsJson) { return bindings; } - try { - JSONObject root = new JSONObject(inputsJson); - - for (String name : root.keySet()) { - JSONObject entry = root.getJSONObject(name); - - if (entry.has("streamHandle")) { - long streamHandle = Long.parseLong(entry.getString("streamHandle")); - InputStreamSession inputSession = InputStreamSession.get(streamHandle); - if (inputSession == null) { - throw new RuntimeException("Invalid streamHandle " + streamHandle + " for input '" + name + "'"); - } - String mimeTypeRaw = entry.optString("mimeType", inputSession.getMimeType()); - String charsetRaw = entry.optString("charset", inputSession.getCharset()); - Charset charset = Charset.forName(charsetRaw); - Option mimeType = Option.apply(mimeTypeRaw); - - BindingValue bindingValue = new BindingValue(inputSession.getInputStream(), mimeType, Map$.MODULE$.empty(), charset); - bindings.addBinding(name, bindingValue); - - } else if (entry.has("content")) { - String contentRaw = entry.getString("content"); - String mimeTypeRaw = entry.optString("mimeType", null); - String charsetRaw = entry.optString("charset", "UTF-8"); - - Map properties = Map$.MODULE$.empty(); - if (entry.has("properties") && !entry.isNull("properties")) { - JSONObject propsObj = entry.getJSONObject("properties"); - properties = parseJsonProperties(propsObj); - } - - Charset charset = Charset.forName(charsetRaw); - Option mimeType = Option.apply(mimeTypeRaw); - - byte[] content = Base64.getDecoder().decode(contentRaw); - BindingValue bindingValue = new BindingValue(content, mimeType, properties, charset); - bindings.addBinding(name, bindingValue); + // Fail closed: any malformed entry (bad JSON / base64 / charset / streamHandle / + // properties) must propagate so the caller returns an error result rather than + // silently executing on partial/empty bindings. Because `bindings` is only + // returned after the loop completes, a propagated exception discards any + // partially-built bindings automatically. + JSONObject root = new JSONObject(inputsJson); + + for (String name : root.keySet()) { + JSONObject entry = root.getJSONObject(name); + + if (entry.has("streamHandle")) { + long streamHandle = Long.parseLong(entry.getString("streamHandle")); + InputStreamSession inputSession = InputStreamSession.get(streamHandle); + if (inputSession == null) { + throw new RuntimeException("Invalid streamHandle " + streamHandle + " for input '" + name + "'"); + } + String mimeTypeRaw = entry.optString("mimeType", inputSession.getMimeType()); + String charsetRaw = entry.optString("charset", inputSession.getCharset()); + Charset charset = Charset.forName(charsetRaw); + Option mimeType = Option.apply(mimeTypeRaw); + + BindingValue bindingValue = new BindingValue(inputSession.getInputStream(), mimeType, Map$.MODULE$.empty(), charset); + bindings.addBinding(name, bindingValue); + + } else if (entry.has("content")) { + String contentRaw = entry.getString("content"); + String mimeTypeRaw = entry.optString("mimeType", null); + String charsetRaw = entry.optString("charset", "UTF-8"); + + Map properties = Map$.MODULE$.empty(); + if (entry.has("properties") && !entry.isNull("properties")) { + JSONObject propsObj = entry.getJSONObject("properties"); + properties = parseJsonProperties(propsObj); } + + Charset charset = Charset.forName(charsetRaw); + Option mimeType = Option.apply(mimeTypeRaw); + + byte[] content = Base64.getDecoder().decode(contentRaw); + BindingValue bindingValue = new BindingValue(content, mimeType, properties, charset); + bindings.addBinding(name, bindingValue); } - } catch (Exception e) { - System.err.println("Error parsing JSON inputs: " + e.getMessage()); - e.printStackTrace(); } return bindings; diff --git a/native-lib/src/test/java/org/mule/weave/lib/NativeLibFeederTest.java b/native-lib/src/test/java/org/mule/weave/lib/NativeLibFeederTest.java new file mode 100644 index 00000000..9a5dff0d --- /dev/null +++ b/native-lib/src/test/java/org/mule/weave/lib/NativeLibFeederTest.java @@ -0,0 +1,383 @@ +package org.mule.weave.lib; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import org.junit.jupiter.api.Test; + +import java.io.ByteArrayInputStream; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicInteger; +import java.util.concurrent.atomic.AtomicReference; + +/** + * Contract test for {@link NativeLib#cleanupFeeder} + {@link NativeLib.InputCallbackFeeder} + * (review #10 #1, Critical): the transform input feeder must be cancelled and fully joined + * before {@code cleanupFeeder} returns, so a slow read callback that is still in-flight cannot + * be re-invoked after the native caller frees the callback state ({@code ctx}). + * + *

The real feeder pulls input via a GraalVM {@code Word}-typed function pointer + * ({@code cb.invoke}), which cannot be exercised from a hosted JVM test. We instead subclass + * {@link NativeLib.InputCallbackFeeder} and override {@link NativeLib.InputCallbackFeeder#readChunk} + * with a pure-Java stand-in that models a read callback which blocks (an in-flight + * {@code cb.invoke}) while cleanup runs.

+ */ +class NativeLibFeederTest { + + /** + * A read callback that always returns data (never EOF) and blocks ~500 ms per call, + * modelling a slow-but-returning in-flight {@code cb.invoke}. + * + *

Post-return invariant under test: after {@code cleanupFeeder} returns, the feeder thread + * is no longer alive (so it can never touch freed callback state), and the "callback" was not + * re-invoked after cancellation was requested.

+ * + *

Against the pre-fix code ({@code join(5000)} then abandon, no cancel signal, and the input + * session closed only after the join) the feeder loops forever writing chunks: the + * join times out with the thread still alive, {@code isAlive()} is {@code true}, and the + * invocation count is large — the test fails, demonstrating the use-after-free window.

+ */ + @Test + void cleanupFeederCancelsAndJoinsInFlightReadCallbackBeforeReturning() throws Exception { + InputStreamSession inputSession = new InputStreamSession("application/json", "UTF-8"); + long inputHandle = inputSession.register(); + + AtomicInteger invocations = new AtomicInteger(0); + CountDownLatch entered = new CountDownLatch(1); + + // Raw addresses are unused: readChunk is overridden and never reconstitutes them. + NativeLib.InputCallbackFeeder feeder = + new NativeLib.InputCallbackFeeder(0L, 0L, inputSession) { + @Override + int readChunk(byte[] dest, int max) { + invocations.incrementAndGet(); + entered.countDown(); + try { + // Simulate a slow in-flight cb.invoke that returns *after* cleanup + // has requested cancellation. + Thread.sleep(500); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + } + // Always return data (never EOF): pre-fix code would loop forever. + dest[0] = 'x'; + return 1; + } + }; + + Thread thread = new Thread(feeder, "test-input-callback-feeder"); + thread.setDaemon(true); + thread.start(); + + // Wait until the feeder is inside the (blocking) callback, then clean up while it blocks. + assertTrue(entered.await(2, TimeUnit.SECONDS), "feeder never entered the read callback"); + + long start = System.nanoTime(); + NativeLib.cleanupFeeder(feeder, thread, inputHandle); + long elapsedMs = (System.nanoTime() - start) / 1_000_000; + + // Post-return invariant: the feeder has fully exited run() — no UAF window remains. + assertFalse(thread.isAlive(), + "cleanupFeeder returned while the feeder thread was still alive (use-after-free window)"); + assertTrue(feeder.isCancelled(), "cleanupFeeder must have signalled cancellation"); + + // The in-flight callback was allowed to return, but it was NOT re-invoked after cancel: + // exactly one invocation proves the loop checks the cancel flag after cb.invoke returns + // and before re-invoking it. + assertEquals(1, invocations.get(), + "read callback was re-invoked after cancellation (should break the loop instead)"); + + // Sanity: the join waited only for the in-flight callback (~500 ms), not a finite abandon + // timeout, and certainly did not hang. + assertTrue(elapsedMs < 4000, + "cleanupFeeder took unexpectedly long (" + elapsedMs + " ms)"); + + System.out.printf("cleanupFeeder returned after %d ms; invocations=%d, alive=%b%n", + elapsedMs, invocations.get(), thread.isAlive()); + } + + /** + * Leak + exception-escape guard for the {@code transformViaCallbacks} setup region + * (review #11 #1, High): a malformed {@code inputs} JSON string must not leak the registered + * {@link InputStreamSession} handle and must not let the {@link org.json.JSONException} escape + * the {@code @CEntryPoint}. It must instead resolve to a {@code success:false} envelope with the + * handle already closed. + * + *

Driven through the package-private {@link NativeLib#setUpInputSession} seam because + * {@code transformViaCallbacks} itself takes GraalVM {@code Word}-typed callbacks and returns a + * {@code CCharPointer}, neither of which resolves in a hosted JVM.

+ */ + @Test + void setUpInputSessionMalformedInputsReturnsErrorEnvelopeAndClosesHandle() { + NativeLib.InputSetup setup = + NativeLib.setUpInputSession("{not json", "payload", "application/json", "UTF-8"); + + assertNotNull(setup.errorEnvelope, "malformed inputs must yield an error envelope"); + assertTrue(setup.errorEnvelope.contains("\"success\":false"), + "envelope must be success:false, was: " + setup.errorEnvelope); + assertNull(setup.mergedInputs, "no merged inputs on the error path"); + assertNull(InputStreamSession.get(setup.handle), + "input session handle leaked after malformed inputs"); + } + + /** + * Happy-path guard: valid {@code inputs} register the session, merge the stream-handle entry + * structurally, and leave the handle live for the feeder (no behavior change). The caller + * (via {@code cleanupFeeder}) is responsible for the eventual close. + */ + @Test + void setUpInputSessionValidInputsMergesEntryAndKeepsHandleLive() { + NativeLib.InputSetup setup = NativeLib.setUpInputSession( + "{\"other\":{\"x\":1}}", "payload", "application/json", "UTF-8"); + + assertNull(setup.errorEnvelope, "valid inputs must not produce an error envelope"); + assertNotNull(setup.mergedInputs, "valid inputs must produce merged inputs"); + assertTrue(setup.mergedInputs.contains("streamHandle"), + "merged inputs must carry the stream handle entry, was: " + setup.mergedInputs); + assertTrue(setup.mergedInputs.contains("payload"), + "merged inputs must carry the input binding name, was: " + setup.mergedInputs); + assertNotNull(InputStreamSession.get(setup.handle), + "session must remain live for the feeder on the success path"); + + // Clean up the still-live session so the test leaves no handle behind. + InputStreamSession.close(setup.handle); + assertNull(InputStreamSession.get(setup.handle)); + } + + // ── Bounds-check on the read-callback length (review #11 #4, Medium) ───── + + /** + * Drives the feeder to completion with the given {@code readChunk} stand-in and returns the + * throwable (if any) that escaped {@link NativeLib.InputCallbackFeeder#run()} via the thread's + * uncaught-exception handler. Uses a fresh registered session so the feeder's {@code finally} + * has a real writer to close, and unregisters it afterwards so no handle leaks. + */ + private static Throwable runFeederCapturingEscapedError(ReadChunkStub stub) throws Exception { + InputStreamSession inputSession = new InputStreamSession("application/json", "UTF-8"); + long inputHandle = inputSession.register(); + try { + NativeLib.InputCallbackFeeder feeder = + new NativeLib.InputCallbackFeeder(0L, 0L, inputSession) { + @Override + int readChunk(byte[] dest, int max) { + return stub.readChunk(dest, max); + } + }; + AtomicReference escaped = new AtomicReference<>(); + Thread thread = new Thread(feeder, "test-bounds-feeder"); + thread.setDaemon(true); + thread.setUncaughtExceptionHandler((t, e) -> escaped.set(e)); + thread.start(); + thread.join(TimeUnit.SECONDS.toMillis(5)); + assertFalse(thread.isAlive(), "feeder thread did not stop after an out-of-range length"); + stub.setFeeder(feeder); + return escaped.get(); + } finally { + InputStreamSession.close(inputHandle); + } + } + + /** Test seam mirroring {@code readChunk} plus a hook to reach the feeder after it stops. */ + private interface ReadChunkStub { + int readChunk(byte[] dest, int max); + + default void setFeeder(NativeLib.InputCallbackFeeder feeder) { + } + } + + /** + * A read callback that returns {@code max + 1} (one past the buffer) must be rejected: the + * feeder stops as an error with {@link NativeLib.InputCallbackFeeder#getError()} naming the + * out-of-range count, and no out-of-bounds exception escapes {@code run()}. + */ + @Test + void readCallbackLengthAboveMaxIsRejectedAsError() throws Exception { + AtomicReference ref = new AtomicReference<>(); + AtomicInteger calls = new AtomicInteger(0); + Throwable escaped = runFeederCapturingEscapedError(new ReadChunkStub() { + @Override + public int readChunk(byte[] dest, int max) { + calls.incrementAndGet(); + return max + 1; // one byte past the destination buffer + } + + @Override + public void setFeeder(NativeLib.InputCallbackFeeder feeder) { + ref.set(feeder); + } + }); + + assertNull(escaped, "an out-of-bounds exception escaped run(): " + escaped); + assertEquals(1, calls.get(), "feeder must stop after the first out-of-range read"); + String error = ref.get().getError(); + assertNotNull(error, "out-of-range length must be recorded as a feeder error"); + assertTrue(error.contains(Integer.toString(NativeLibFeederConstants.BUFFER + 1)), + "error must name the out-of-range count, was: " + error); + } + + /** + * A read callback that returns {@code -5} (outside the {@code [-1, max]} contract) must be + * rejected the same way: recorded feeder error naming the count, no exception out of {@code run()}. + */ + @Test + void readCallbackNegativeOutOfRangeLengthIsRejectedAsError() throws Exception { + AtomicReference ref = new AtomicReference<>(); + Throwable escaped = runFeederCapturingEscapedError(new ReadChunkStub() { + @Override + public int readChunk(byte[] dest, int max) { + return -5; + } + + @Override + public void setFeeder(NativeLib.InputCallbackFeeder feeder) { + ref.set(feeder); + } + }); + + assertNull(escaped, "an exception escaped run(): " + escaped); + String error = ref.get().getError(); + assertNotNull(error, "out-of-range negative length must be recorded as a feeder error"); + assertTrue(error.contains("-5"), "error must name the out-of-range count, was: " + error); + } + + /** + * A clean EOF ({@code 0}) is not an error: the feeder stops with {@code getError() == null}. + */ + @Test + void readCallbackCleanEofLeavesNoFeederError() throws Exception { + AtomicReference ref = new AtomicReference<>(); + Throwable escaped = runFeederCapturingEscapedError(new ReadChunkStub() { + @Override + public int readChunk(byte[] dest, int max) { + return 0; // immediate EOF + } + + @Override + public void setFeeder(NativeLib.InputCallbackFeeder feeder) { + ref.set(feeder); + } + }); + + assertNull(escaped, "no exception may escape run() on clean EOF: " + escaped); + assertNull(ref.get().getError(), "clean EOF must leave getError() == null"); + } + + /** Mirrors the package-private {@code CALLBACK_BUFFER_SIZE} used as the read {@code max}. */ + private static final class NativeLibFeederConstants { + static final int BUFFER = 8 * 1024; + } + + // ── Join-before-getError ordering contract (review #12 #1, High) ───── + + /** + * Contract test for the ordering {@code transformViaCallbacks} relies on: a terminal feeder + * error set by an in-flight {@code readChunk} is only guaranteed visible after + * {@code cleanupFeeder} has joined the feeder thread, not before. Before the round-12 fix, + * {@code transformViaCallbacks} read {@code getError()} before joining the feeder in its + * in-try path, so a callback that was still running when output reached EOF and failed only + * after returning could have its failure missed and a {@code success:true} envelope returned + * instead. This test proves the invariant the fix depends on: pre-join the error is not yet + * observable, and {@code cleanupFeeder} does not return until the join completes and the + * error becomes visible. + */ + @Test + void getErrorReflectsLateFailureOnlyAfterJoin() throws Exception { + CountDownLatch release = new CountDownLatch(1); + InputStreamSession session = new InputStreamSession("application/json", null); + long handle = session.register(); + // A feeder whose read callback blocks until released, then reports an out-of-range + // length (the "in-flight callback fails after output EOF" case). Returning the + // out-of-range value directly (rather than calling the private rejectOutOfRange helper, + // which isn't visible to this subclass) exercises run()'s own defence-in-depth check, + // exactly like readCallbackLengthAboveMaxIsRejectedAsError above. + NativeLib.InputCallbackFeeder feeder = new NativeLib.InputCallbackFeeder(0L, 0L, session) { + @Override + int readChunk(byte[] dest, int max) { + try { + release.await(); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + } + return max + 1; // one past the buffer: recorded as a feeder error, loop breaks + } + }; + Thread t = new Thread(feeder, "dw-input-callback-feeder-test"); + t.setDaemon(true); + t.start(); + + // Pre-join: the callback is still blocked, so no terminal error is visible yet. + assertNull(feeder.getError()); + + // Releasing + joining (via cleanupFeeder) must wait for run() to finish and make the + // late failure observable. + release.countDown(); + NativeLib.cleanupFeeder(feeder, t, handle); + + assertFalse(t.isAlive()); + assertNotNull(feeder.getError()); + } + + /** + * Regression guard for review #12 #1 round 1 follow-up: {@code getErrorReflectsLateFailureOnlyAfterJoin} + * above only proves {@code cleanupFeeder}'s own join contract — it does not touch + * {@code transformViaCallbacks}'s (now {@link NativeLib#selectTransformResult}'s) ordering of + * "join, then read {@code getError()}". This test drives {@code selectTransformResult} + * itself: a read callback blocks (models an in-flight {@code cb.invoke}) and is only released + * from a background thread strictly after the call under test has begun, so the feeder is + * guaranteed still running — and its error not yet recorded — at the moment + * {@code selectTransformResult} is invoked. + * + *

If {@code selectTransformResult} ever read {@code getError()} before joining the feeder + * (i.e. reintroduced the exact round-12 #1 bug inside the extracted method), this test would + * observe a frozen {@code success:true} envelope decided before the late failure was recorded + * — this assertion is what would catch that regression.

+ */ + @Test + void selectTransformResultObservesLateFailureOnlyAfterJoin() throws Exception { + CountDownLatch release = new CountDownLatch(1); + InputStreamSession inputSession = new InputStreamSession("application/json", null); + long inputHandle = inputSession.register(); + NativeLib.InputCallbackFeeder feeder = new NativeLib.InputCallbackFeeder(0L, 0L, inputSession) { + @Override + int readChunk(byte[] dest, int max) { + try { + release.await(); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + } + return max + 1; // one past the buffer: recorded as a feeder error once this returns + } + }; + Thread t = new Thread(feeder, "dw-select-result-test"); + t.setDaemon(true); + t.start(); + + // Release the blocked callback ~100ms from now, on a separate thread, so the call under + // test below begins while the feeder is still guaranteed to be blocked (no error + // recorded yet). A correct implementation's join (inside cleanupFeeder) then waits for + // this release before reading getError(); a buggy re-ordering would read getError() -- and + // freeze the (wrong) success decision -- immediately, before the release even fires. + Thread releaser = new Thread(() -> { + try { + Thread.sleep(100); + } catch (InterruptedException ignored) { + } + release.countDown(); + }); + releaser.setDaemon(true); + releaser.start(); + + StreamSession outputSession = new StreamSession( + new ByteArrayInputStream(new byte[0]), "application/json", "UTF-8", false); + + String resultJson = NativeLib.selectTransformResult(feeder, t, inputHandle, outputSession); + + assertFalse(t.isAlive()); + assertTrue(resultJson.contains("\"success\":false"), + "selectTransformResult must observe the feeder's late failure, was: " + resultJson); + } +} diff --git a/native-lib/src/test/java/org/mule/weave/lib/ScriptRuntimeTest.java b/native-lib/src/test/java/org/mule/weave/lib/ScriptRuntimeTest.java index 70f8044b..77fa2a43 100644 --- a/native-lib/src/test/java/org/mule/weave/lib/ScriptRuntimeTest.java +++ b/native-lib/src/test/java/org/mule/weave/lib/ScriptRuntimeTest.java @@ -6,12 +6,23 @@ import static org.junit.jupiter.api.Assertions.assertNull; import static org.junit.jupiter.api.Assertions.assertTrue; +import org.json.JSONObject; import org.junit.jupiter.api.Test; +import org.mule.weave.v2.parser.ast.variables.NameIdentifier; +import org.mule.weave.v2.sdk.NameIdentifierHelper; +import org.mule.weave.v2.sdk.WeaveResource; +import org.mule.weave.v2.sdk.WeaveResourceResolver; +import scala.Option; +import scala.collection.JavaConverters; +import scala.collection.immutable.Seq; +import scala.collection.immutable.Seq$; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.nio.charset.Charset; import java.util.Base64; +import java.util.Collections; +import java.util.Map; import java.util.concurrent.CountDownLatch; import java.util.concurrent.atomic.AtomicReference; @@ -19,7 +30,7 @@ class ScriptRuntimeTest { @Test void runSimpleScript() { - ScriptRuntime runtime = ScriptRuntime.getInstance(); + ScriptRuntime runtime = new ScriptRuntime(); System.out.println("Running sqrt(144) 10 times with timing:"); System.out.println("=".repeat(50)); @@ -39,7 +50,7 @@ void runSimpleScript() { @Test void runParseError() { - ScriptRuntime runtime = ScriptRuntime.getInstance(); + ScriptRuntime runtime = new ScriptRuntime(); System.out.println("Running sqrt(144) 10 times with timing:"); System.out.println("=".repeat(50)); @@ -55,7 +66,7 @@ void runParseError() { @Test void runWithInputs() { - ScriptRuntime runtime = ScriptRuntime.getInstance(); + ScriptRuntime runtime = new ScriptRuntime(); System.out.println("Testing runWithInputs with two integer numbers:"); System.out.println("=".repeat(50)); @@ -129,7 +140,7 @@ private String encode(Object value) { @Test void runWithXmlInput() { - ScriptRuntime runtime = ScriptRuntime.getInstance(); + ScriptRuntime runtime = new ScriptRuntime(); System.out.println("Testing runWithInputs with XML input to calculate average age:"); System.out.println("=".repeat(50)); @@ -181,7 +192,7 @@ void runWithXmlInput() { @Test void runWithJsonObjectInput() { - ScriptRuntime runtime = ScriptRuntime.getInstance(); + ScriptRuntime runtime = new ScriptRuntime(); System.out.println("Testing runWithInputs with JSON object input:"); System.out.println("=".repeat(50)); @@ -216,7 +227,7 @@ void runWithJsonObjectInput() { @Test void runWithBinaryResult() { - ScriptRuntime runtime = ScriptRuntime.getInstance(); + ScriptRuntime runtime = new ScriptRuntime(); System.out.println("Running fromBase64 10 times with timing:"); System.out.println("=".repeat(50)); @@ -239,7 +250,7 @@ void runWithBinaryResult() { @Test void runWithInputProperties() { - ScriptRuntime runtime = ScriptRuntime.getInstance(); + ScriptRuntime runtime = new ScriptRuntime(); String encodedIn0 = Base64.getEncoder().encodeToString("1234567".getBytes()); Result result = Result.parse(runtime.run("in0.column_1[0] as Number", "{\"in0\": " + @@ -252,7 +263,7 @@ void runWithInputProperties() { @Test void streamSimpleScript() throws IOException { - ScriptRuntime runtime = ScriptRuntime.getInstance(); + ScriptRuntime runtime = new ScriptRuntime(); System.out.println("Testing streaming simple script:"); System.out.println("=".repeat(50)); @@ -279,7 +290,7 @@ void streamSimpleScript() throws IOException { @Test void streamWithInputs() throws IOException { - ScriptRuntime runtime = ScriptRuntime.getInstance(); + ScriptRuntime runtime = new ScriptRuntime(); System.out.println("Testing streaming with inputs:"); System.out.println("=".repeat(50)); @@ -310,7 +321,7 @@ void streamWithInputs() throws IOException { @Test void streamChunkedRead() throws IOException { - ScriptRuntime runtime = ScriptRuntime.getInstance(); + ScriptRuntime runtime = new ScriptRuntime(); System.out.println("Testing streaming chunked read:"); System.out.println("=".repeat(50)); @@ -341,7 +352,7 @@ void streamChunkedRead() throws IOException { @Test void streamWithStreamingInput() throws Exception { - ScriptRuntime runtime = ScriptRuntime.getInstance(); + ScriptRuntime runtime = new ScriptRuntime(); System.out.println("Testing streaming with streaming input:"); System.out.println("=".repeat(50)); @@ -396,7 +407,7 @@ void streamWithStreamingInput() throws Exception { @Test void streamWithLargeStreamingInput() throws Exception { - ScriptRuntime runtime = ScriptRuntime.getInstance(); + ScriptRuntime runtime = new ScriptRuntime(); System.out.println("Testing streaming with large streaming input:"); System.out.println("=".repeat(50)); @@ -455,7 +466,7 @@ void streamWithLargeStreamingInput() throws Exception { @Test void streamErrorSession() { - ScriptRuntime runtime = ScriptRuntime.getInstance(); + ScriptRuntime runtime = new ScriptRuntime(); System.out.println("Testing streaming error session:"); System.out.println("=".repeat(50)); @@ -474,7 +485,7 @@ void streamErrorSession() { @Test void callbackOutputStreaming() throws IOException { - ScriptRuntime runtime = ScriptRuntime.getInstance(); + ScriptRuntime runtime = new ScriptRuntime(); System.out.println("Testing callback-based output streaming:"); System.out.println("=".repeat(50)); @@ -505,7 +516,7 @@ void callbackOutputStreaming() throws IOException { @Test void callbackInputOutputStreaming() throws Exception { - ScriptRuntime runtime = ScriptRuntime.getInstance(); + ScriptRuntime runtime = new ScriptRuntime(); System.out.println("Testing callback-based input+output streaming:"); System.out.println("=".repeat(50)); @@ -566,7 +577,7 @@ void callbackInputOutputStreaming() throws Exception { @Test void callbackOutputStreamingError() { - ScriptRuntime runtime = ScriptRuntime.getInstance(); + ScriptRuntime runtime = new ScriptRuntime(); System.out.println("Testing callback-based output streaming with error:"); System.out.println("=".repeat(50)); @@ -580,6 +591,167 @@ void callbackOutputStreamingError() { System.out.println("=".repeat(50)); } + // --- Multi-engine registry (W-23692110) --- + + /** In-memory WeaveResourceResolver fake — the JVM-constructable seam standing + * in for CallbackWeaveResourceResolver (a CFunctionPointer, which cannot be + * built in test mode). */ + static final class MapResolver implements WeaveResourceResolver { + private final Map modules; + MapResolver(Map modules) { this.modules = modules; } + + @Override + public Option resolve(NameIdentifier id) { + String path = NameIdentifierHelper.toWeaveFilePath(id, "/"); + String key = path.startsWith("/") ? path.substring(1) : path; + String src = modules.get(key); + if (src == null) return Option.empty(); + return Option.apply(WeaveResource.apply(path, src)); + } + + @Override + public Seq resolveAll(NameIdentifier id) { + Option r = resolve(id); + if (r.isDefined()) { + return JavaConverters + .asScalaBuffer(Collections.singletonList(r.get())) + .toList(); + } + return (Seq) Seq$.MODULE$.empty(); + } + } + + private static final String IMPORT_A = + "%dw 2.0\nimport org::test::a\noutput application/json\n---\na::greet(\"X\")"; + private static final String IMPORT_B = + "%dw 2.0\nimport org::test::b\noutput application/json\n---\nb::greet(\"X\")"; + + @Test + void twoEnginesResolveOnlyTheirOwnModule() { + ScriptRuntime engineA = new ScriptRuntime(new MapResolver(Map.of( + "org/test/a.dwl", "%dw 2.0\nfun greet(n: String) = \"A:\" ++ n"))); + ScriptRuntime engineB = new ScriptRuntime(new MapResolver(Map.of( + "org/test/b.dwl", "%dw 2.0\nfun greet(n: String) = \"B:\" ++ n"))); + + long hA = ScriptRuntime.register(engineA); + long hB = ScriptRuntime.register(engineB); + assertNotNull(ScriptRuntime.get(hA)); + assertNotNull(ScriptRuntime.get(hB)); + + // Each engine resolves its own module... + assertEquals("\"A:X\"", Result.parse(ScriptRuntime.get(hA).run(IMPORT_A)).result); + assertEquals("\"B:X\"", Result.parse(ScriptRuntime.get(hB).run(IMPORT_B)).result); + + // ...and NOT the other's (no cross-talk). + assertNotNull(Result.parse(ScriptRuntime.get(hA).run(IMPORT_B)).error); + assertNotNull(Result.parse(ScriptRuntime.get(hB).run(IMPORT_A)).error); + + // destroy removes it; a fresh handle is distinct. + assertTrue(ScriptRuntime.destroy(hA)); + assertNull(ScriptRuntime.get(hA)); + assertFalse(ScriptRuntime.destroy(hA)); // already gone + assertNotNull(ScriptRuntime.get(hB)); + + ScriptRuntime.destroy(hB); + } + + @Test + void engineWithoutResolverStillRunsBuiltins() { + ScriptRuntime engine = new ScriptRuntime(); // ClassLoader-only + long h = ScriptRuntime.register(engine); + String r = ScriptRuntime.get(h).run( + "%dw 2.0\nimport dw::core::Strings\noutput application/json\n---\nStrings::capitalize(\"hello\")"); + assertEquals("\"Hello\"", Result.parse(r).result); + ScriptRuntime.destroy(h); + } + + /** + * Locks in the hard contract for the per-engine FFI entrypoints + * ({@code run_script_engine}, {@code run_script_callback_engine}, + * {@code run_script_input_output_callback_engine} in {@link NativeLib}): running a + * script against an unknown or already-destroyed engine handle must return exactly + * {@code {"success":false,"error":"Unknown engine handle"}} rather than throwing. + * + *

The {@code @CEntryPoint} methods themselves cannot be invoked from a plain JVM + * unit test — they take GraalVM word types ({@code IsolateThread}, {@code CCharPointer}) + * whose boxing infrastructure is only initialized inside a compiled native image (calling + * e.g. {@code WordFactory.nullPointer()} from a hosted JVM test throws + * {@code NullPointerException} from {@code WordBoxFactory}). All three entrypoints funnel + * the unknown-handle case through the same {@code UNKNOWN_ENGINE_HANDLE_JSON} constant, so + * asserting on that constant — combined with {@link #twoEnginesResolveOnlyTheirOwnModule} + * proving {@link ScriptRuntime#get} returns {@code null} for an unregistered/destroyed + * handle — verifies the full contract without needing the native runtime.

+ */ + @Test + void unknownEngineHandleProducesExactErrorJson() { + long unregisteredHandle = Long.MAX_VALUE; + assertNull(ScriptRuntime.get(unregisteredHandle)); + assertEquals("{\"success\":false,\"error\":\"Unknown engine handle\"}", + NativeLib.UNKNOWN_ENGINE_HANDLE_JSON); + } + + // ── Fail-closed input parsing (review #11 #5) ────────────────────────── + + /** (a) Malformed inputs JSON must fail closed, not silently run on empty bindings. */ + @Test + void runMalformedInputsJsonFailsClosed() { + ScriptRuntime runtime = new ScriptRuntime(); + // Script has no input dependency, so pre-fix the swallowed parse error + // would let this run on empty bindings and return success:true. + String result = runtime.run("1 + 1", "{not json"); + assertTrue(result.contains("\"success\":false"), + "Expected success:false for malformed inputs JSON, got: " + result); + assertFalse(Result.parse(result).success); + } + + /** + * (b) A malformed SECOND entry (invalid base64 content) must fail the whole run, + * not silently drop the entry and execute bound to only the first entry. + */ + @Test + void runMalformedSecondEntryFailsClosed() { + ScriptRuntime runtime = new ScriptRuntime(); + + // First entry valid; second entry has invalid base64 content. + String inputsJson = String.format( + "{\"num1\": {\"content\": \"%s\", \"mimeType\": \"application/json\"}, " + + "\"num2\": {\"content\": \"@@@not-valid-base64@@@\", \"mimeType\": \"application/json\"}}", + encode(10)); + + // Script references only the first binding: pre-fix the second (malformed) + // entry would be silently dropped and this would wrongly succeed on num1 alone. + String result = runtime.run("num1", inputsJson); + assertFalse(Result.parse(result).success, + "Expected fail-closed on malformed second entry, got: " + result); + assertNotNull(Result.parse(result).error); + + // And a script that references the malformed binding must not run on a missing var. + String result2 = runtime.run("num1 + num2", inputsJson); + assertFalse(Result.parse(result2).success, + "Expected fail-closed when referencing malformed binding, got: " + result2); + } + + /** (c) A valid single-entry inputs doc must still run successfully (no regression). */ + @Test + void runValidSingleEntryStillSucceeds() { + ScriptRuntime runtime = new ScriptRuntime(); + String inputsJson = String.format( + "{\"num1\": {\"content\": \"%s\", \"mimeType\": \"application/json\"}}", + encode(41)); + String result = runtime.run("num1 + 1", inputsJson); + assertTrue(Result.parse(result).success, "Expected success for valid inputs, got: " + result); + assertEquals("42", Result.parse(result).result); + } + + /** runStreaming must return an error session on malformed inputs JSON. */ + @Test + void runStreamingMalformedInputsJsonReturnsErrorSession() { + ScriptRuntime runtime = new ScriptRuntime(); + StreamSession session = runtime.runStreaming("1 + 1", "{not json"); + assertTrue(session.isError(), "Expected error session for malformed inputs JSON"); + assertNotNull(session.getError()); + } + static class Result { boolean success; String result; @@ -590,7 +762,7 @@ static class Result { static Result parse(String json) { Result result = new Result(); - org.json.JSONObject obj = new org.json.JSONObject(json); + JSONObject obj = new JSONObject(json); result.success = obj.getBoolean("success"); if (result.success) {