@gjsify/node-gi 0.51.1 → 0.53.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gjsify/node-gi",
-  "version": "0.51.1",
+  "version": "0.53.0",
   "description": "GObject-Introspection runtime for Node.js — load gi:// namespaces (GLib/GObject/Gio/…) with GJS-compatible semantics. Vendored + rewritten from node-gtk under MIT.",
   "type": "module",
   "license": "MIT",
@@ -88,23 +88,23 @@
     "build:prebuild": "node-gyp rebuild && node scripts/stage-prebuild.mjs",
     "rebuild": "node-gyp rebuild",
     "clean": "node-gyp clean",
-    "test": "LC_ALL=C NODE_GI_NATIVE=build node --test",
-    "test:node": "LC_ALL=C NODE_GI_NATIVE=build node --test",
-    "test:gc": "LC_ALL=C NODE_GI_NATIVE=build node --test --expose-gc",
-    "test:dbus": "dbus-run-session --config-file=test/session.conf -- env LC_ALL=C NODE_GI_NATIVE=build node --test --expose-gc test/dbus.test.mjs test/dbus-async.test.mjs",
+    "test": "node scripts/pinned-env.mjs --test",
+    "test:node": "node scripts/pinned-env.mjs --test",
+    "test:gc": "node scripts/pinned-env.mjs --test --expose-gc",
+    "test:dbus": "dbus-run-session --config-file=test/session.conf -- node scripts/pinned-env.mjs --test --expose-gc test/dbus.test.mjs test/dbus-async.test.mjs",
     "test:bun": "node scripts/cross-runtime.mjs bun",
     "test:conformance": "node scripts/conformance.mjs",
     "test:conformance:gjs-napi": "node scripts/conformance.mjs --runtimes=gjs-napi",
     "test:gimarshalling": "node scripts/gimarshalling.mjs",
     "test:deno": "node scripts/cross-runtime.mjs deno",
-    "test:cairo": "LC_ALL=C NODE_GI_NATIVE=build node --test test/cairo.test.mjs",
-    "test:cairo-canvas2d": "LC_ALL=C NODE_GI_NATIVE=build node --test test/cairo-canvas2d.test.mjs",
-    "test:gtk": "LC_ALL=C NODE_GI_NATIVE=build node --test test/gtk-smoke.test.mjs",
-    "test:gtk-cairo": "LC_ALL=C NODE_GI_NATIVE=build node --test test/cairo-drawfunc.test.mjs",
-    "test:adw": "LC_ALL=C NODE_GI_NATIVE=build node --test test/adw-smoke.test.mjs",
-    "test:gtk-template": "LC_ALL=C NODE_GI_NATIVE=build node --test test/gtk-template.test.mjs",
-    "test:gtk-template-callbacks": "LC_ALL=C NODE_GI_NATIVE=build node --test test/gtk-template-callbacks.test.mjs",
-    "test:gtk-template-signals": "LC_ALL=C NODE_GI_NATIVE=build node --test test/gtk-template-signals.test.mjs"
+    "test:cairo": "node scripts/pinned-env.mjs --test test/cairo.test.mjs",
+    "test:cairo-canvas2d": "node scripts/pinned-env.mjs --test test/cairo-canvas2d.test.mjs",
+    "test:gtk": "node scripts/pinned-env.mjs --test test/gtk-smoke.test.mjs",
+    "test:gtk-cairo": "node scripts/pinned-env.mjs --test test/cairo-drawfunc.test.mjs",
+    "test:adw": "node scripts/pinned-env.mjs --test test/adw-smoke.test.mjs",
+    "test:gtk-template": "node scripts/pinned-env.mjs --test test/gtk-template.test.mjs",
+    "test:gtk-template-callbacks": "node scripts/pinned-env.mjs --test test/gtk-template-callbacks.test.mjs",
+    "test:gtk-template-signals": "node scripts/pinned-env.mjs --test test/gtk-template-signals.test.mjs"
   },
   "dependencies": {
     "node-addon-api": "^8.0.0"

package/src/addon.cc

@@ -155,6 +155,7 @@ static Napi::Object Init(Napi::Env env, Napi::Object exports) {
   exports.Set("localeCategories", Napi::Function::New(env, LocaleCategories));
   // The native cairo binding + foreign-struct registration (the `__cairo` export).
   InitCairo(env, exports);
+  InitOpenGLWin32(env, exports);
   return exports;
 }
 

package/src/calls.cc

@@ -223,58 +223,34 @@ static void NodeGiCallbackTrampoline(ffi_cif* /*cif*/, void* result, void** args
   if (cb->scope != GI_SCOPE_TYPE_CALL) depthReset = std::make_unique<SyncEmitDepthReset>();
 
   GICallableInfo* ci = cb->info;
-  unsigned int n = gi_callable_info_get_n_args(ci);
+  // Arguments and the answer in gjs's OUT/INOUT shape, shared with the vfunc
+  // trampoline (CToJsCall, marshal.cc): a pure OUT is not a JS argument and is
+  // written back from the return value. ffi hands each argument's storage as
+  // args[i] (a user_data/void IN arg marshals to undefined, which JS ignores).
+  CToJsCall call(napiEnv, ci, std::string("callback '") +
+                                  gi_base_info_get_name(reinterpret_cast<GIBaseInfo*>(ci)) + "'");
   std::vector<napi_value> jsArgs;
-  jsArgs.reserve(n);
-  bool ok = true;
-  for (unsigned int i = 0; i < n; i++) {
-    GIArgInfo* ai = gi_callable_info_get_arg(ci, i);
-    GITypeInfo* ti = gi_arg_info_get_type_info(ai);
-    // ffi hands each argument's storage as args[i]; reinterpret as a GIArgument
-    // union (a user_data/void arg marshals to undefined, which JS ignores).
-    Napi::Value v = GIArgumentToJs(napiEnv, ti, static_cast<GIArgument*>(args[i]), GI_TRANSFER_NOTHING);
-    gi_base_info_unref(ti);
-    gi_base_info_unref(ai);
-    if (napiEnv.IsExceptionPending()) {
-      ok = false;
-      break;
-    }
-    jsArgs.push_back(v);
-  }
+  bool ok = call.MarshalArgs(args, 0, &jsArgs);
 
   // Zero the result slot first (it is >= ffi_arg wide; narrow returns leave the
   // upper bytes indeterminate otherwise).
   if (result != nullptr) static_cast<GIArgument*>(result)->v_uint64 = 0;
 
-  GITypeInfo* retType = gi_callable_info_get_return_type(ci);
+  napi_value ret = nullptr;
   if (ok) {
     napi_value fn = nullptr;
     if (napi_get_reference_value(env, cb->jsFn, &fn) == napi_ok && fn != nullptr) {
       napi_value global = nullptr;
       napi_get_global(env, &global);
-      napi_value ret = nullptr;
       // napi_make_callback drains nextTick/microtasks around the call (Node; on
       // Bun/Deno the checkpoint is run by NodeGiMaybeDrainMicrotasks below).
       g_loopDispatchDepth++;
       napi_status st = napi_make_callback(env, nullptr, global, fn, jsArgs.size(), jsArgs.data(), &ret);
       g_loopDispatchDepth--;
-      if (st == napi_ok && result != nullptr) {
-        GITypeTag rtag = gi_type_info_get_tag(retType);
-        if (rtag == GI_TYPE_TAG_UTF8 || rtag == GI_TYPE_TAG_FILENAME) {
-          // Hand the caller an owned copy — a JsToGIArgument string would point
-          // into a std::string that dies with this frame.
-          Napi::Value rv(env, ret);
-          static_cast<GIArgument*>(result)->v_string =
-              rv.IsString() ? g_strdup(rv.As<Napi::String>().Utf8Value().c_str()) : nullptr;
-        } else if (rtag != GI_TYPE_TAG_VOID) {
-          std::string held;
-          JsToGIArgument(napiEnv, Napi::Value(env, ret), retType, static_cast<GIArgument*>(result),
-                         &held);
-        }
-      }
+      if (st != napi_ok) ret = nullptr;
     }
   }
-  gi_base_info_unref(retType);
+  call.WriteAnswer(ret, result);
   // A CALL-scope callback (e.g. a list `foreach`) runs synchronously inside a
   // JS-initiated GI invoke, so a pending exception must propagate to that JS
   // caller — leave it to surface at the invoke's N-API boundary. A NOTIFIED/ASYNC

package/src/class.cc

@@ -223,37 +223,27 @@ static void NodeGiVFuncTrampoline(ffi_cif* /*cif*/, void* result, void** args,
 
   GICallableInfo* ci = reinterpret_cast<GICallableInfo*>(vf->info);
   // args[0] is the instance; declared args follow at args[1..].
-  Napi::Value recv = WrapGObject(
-      napiEnv, static_cast<GObject*>(static_cast<GIArgument*>(args[0])->v_pointer),
-      GI_TRANSFER_NOTHING);
-
-  unsigned int n = gi_callable_info_get_n_args(ci);
+  GObject* instance = static_cast<GObject*>(static_cast<GIArgument*>(args[0])->v_pointer);
+  Napi::Value recv = WrapGObject(napiEnv, instance, GI_TRANSFER_NOTHING);
+
+  // Arguments and the answer in gjs's OUT/INOUT shape, shared with the GI-callback
+  // trampoline (CToJsCall, marshal.cc). args[0] is the instance, so the declared
+  // arguments start at offset 1. `instance` is also the owner a transfer-none string
+  // answer ties its lifetime to (StringForC, marshal.cc) instead of interning it
+  // forever — a real vfunc can answer a fresh string every call (e.g.
+  // Gtk.Editable's vfunc_get_text on a live-updating buffer).
+  CToJsCall call(napiEnv, ci, "vfunc '" + vf->name + "'", instance);
   std::vector<napi_value> jsArgs;
-  jsArgs.reserve(n);
-  bool ok = true;
-  for (unsigned int i = 0; i < n; i++) {
-    GIArgInfo* ai = gi_callable_info_get_arg(ci, i);
-    GITypeInfo* ti = gi_arg_info_get_type_info(ai);
-    Napi::Value v =
-        GIArgumentToJs(napiEnv, ti, static_cast<GIArgument*>(args[i + 1]), GI_TRANSFER_NOTHING);
-    gi_base_info_unref(ti);
-    gi_base_info_unref(ai);
-    if (napiEnv.IsExceptionPending()) {
-      ok = false;
-      break;
-    }
-    jsArgs.push_back(v);
-  }
+  bool ok = call.MarshalArgs(args, 1, &jsArgs);
 
   // Zero the result slot first (it is >= ffi_arg wide; narrow returns leave the
   // upper bytes indeterminate otherwise).
   if (result != nullptr) static_cast<GIArgument*>(result)->v_uint64 = 0;
 
-  GITypeInfo* retType = gi_callable_info_get_return_type(ci);
+  napi_value ret = nullptr;
   if (ok) {
     napi_value fn = nullptr;
     if (napi_get_reference_value(env, vf->fn, &fn) == napi_ok && fn != nullptr) {
-      napi_value ret = nullptr;
       // napi_make_callback drains nextTick/microtasks around the call (Node; on
       // Bun/Deno the checkpoint is run by NodeGiMaybeDrainMicrotasks below); the
       // wrapped instance is the receiver (`this`).
@@ -261,23 +251,10 @@ static void NodeGiVFuncTrampoline(ffi_cif* /*cif*/, void* result, void** args,
       napi_status st =
           napi_make_callback(env, nullptr, recv, fn, jsArgs.size(), jsArgs.data(), &ret);
       g_loopDispatchDepth--;
-      if (st == napi_ok && result != nullptr) {
-        GITypeTag rtag = gi_type_info_get_tag(retType);
-        if (rtag == GI_TYPE_TAG_UTF8 || rtag == GI_TYPE_TAG_FILENAME) {
-          // Hand the caller an owned copy — a JsToGIArgument string would point
-          // into a std::string that dies with this frame.
-          Napi::Value rv(env, ret);
-          static_cast<GIArgument*>(result)->v_string =
-              rv.IsString() ? g_strdup(rv.As<Napi::String>().Utf8Value().c_str()) : nullptr;
-        } else if (rtag != GI_TYPE_TAG_VOID) {
-          std::string held;
-          JsToGIArgument(napiEnv, Napi::Value(env, ret), retType, static_cast<GIArgument*>(result),
-                         &held);
-        }
-      }
+      if (st != napi_ok) ret = nullptr;
     }
   }
-  gi_base_info_unref(retType);
+  call.WriteAnswer(ret, result);
   // A pending JS exception surfaces at the next N-API boundary (e.g. when the
   // constructType / method call that triggered this vfunc returns).
   //

package/src/common.h

@@ -176,6 +176,8 @@ const ForeignStructOps* ForeignOpsForInfo(GIBaseInfo* iface);
 // from addon.cc's Init; sets the `__cairo` export + registers Context/Surface/
 // Pattern foreign converters.
 void InitCairo(Napi::Env env, Napi::Object exports);
+// win32: probeHostOpenGL / preloadOpenGL / currentGLStrings (opengl-win32.cc); a no-op elsewhere.
+void InitOpenGLWin32(Napi::Env env, Napi::Object exports);
 
 // ---- GJS-exact 64-bit integer marshalling helpers (shared) -------------------
 //
@@ -413,6 +415,42 @@ bool IsSupportedContainerType(GITypeInfo* type, std::string* why, ContainerUse u
 // function-invoke path (calls.cc) and the vfunc chain-up path (class.cc).
 bool IsSupportedOutType(GITypeInfo* type, std::string* why);
 size_t CElementSize(GITypeInfo* elem);
+// One call C makes INTO JS — a JS vfunc override (class.cc) or a GI callback
+// (calls.cc) — marshalled in gjs's OUT/INOUT shape (see marshal.cc). Lives on the
+// trampoline's stack under its HandleScope; `ci` is borrowed.
+class CToJsCall {
+ public:
+  // `owner` is the vfunc's instance (class.cc passes args[0]'s GObject*); nullptr for a
+  // plain GI callback (calls.cc), which has no natural object. Only used to tie a
+  // transfer-none string ANSWER's lifetime to something bounded (StringForC,
+  // marshal.cc) — gjs's own fallback (g_intern_string, unbounded) when there is none.
+  CToJsCall(Napi::Env env, GICallableInfo* ci, std::string label, GObject* owner = nullptr);
+  ~CToJsCall();
+  CToJsCall(const CToJsCall&) = delete;
+  CToJsCall& operator=(const CToJsCall&) = delete;
+  // The JS arguments from the ffi args (`args[offset + i]` is declared arg i): IN as
+  // values, INOUT as their current value, pure OUT omitted. False = exception pending.
+  bool MarshalArgs(void** args, unsigned int offset, std::vector<napi_value>* jsArgs);
+  // Write JS's answer back: the return value into `result` (already zeroed by the
+  // caller), the OUT/INOUT through their pointers. A wrong shape or a failed
+  // conversion throws; every pure OUT left unanswered is zeroed, never uninitialised.
+  // `ret` is nullptr when the JS call itself failed.
+  void WriteAnswer(napi_value ret, void* result);
+
+ private:
+  struct Slot {
+    GIArgInfo* ai;   // owned
+    GITypeInfo* ti;  // owned
+    gpointer dest;   // the caller's variable (or caller-allocated record); may be NULL
+  };
+  void ThrowUnsupported(const Slot& s) const;
+  bool WriteOut(const Slot& s, Napi::Value v);
+  Napi::Env env_;
+  GICallableInfo* ci_;
+  std::string label_;
+  GObject* owner_;  // borrowed; see the constructor comment
+  std::vector<Slot> outs_;
+};
 void WriteLengthValue(GITypeInfo* lenType, GIArgument* slot, long n);
 
 // One IN length-argument autofill, remembered so a SECOND array naming the same length

package/src/loop.cc

@@ -379,8 +379,9 @@ Napi::Value IterateMainContext(const Napi::CallbackInfo& info) {
 struct PumpPoll {
   uv_poll_t handle;
   int fd;
-  int events;     // currently-subscribed uv event mask
-  gboolean seen;  // mark/sweep flag for SyncPumpPolls
+  int events;        // currently-subscribed uv event mask
+  gboolean seen;     // mark/sweep flag for SyncPumpPolls
+  gboolean started;  // whether the watcher is currently armed (see PumpPollCb)
 };
 
 static gboolean g_pump_inited = FALSE;
@@ -398,7 +399,26 @@ static gboolean g_pump_poll_warned = FALSE;
 // Wake-only callbacks: readiness/expiry just ends libuv's poll sleep; the actual
 // GLib dispatch happens in the check phase of the same loop turn (PumpCheckCb).
 static void PumpTimerCb(uv_timer_t* /*t*/) {}
-static void PumpPollCb(uv_poll_t* /*p*/, int /*status*/, int /*events*/) {}
+
+// A wake-up is an EDGE, so the watcher DISARMS itself on the first fire and
+// PumpArmWakeups re-arms it on the next libuv turn. uv_poll is level-triggered
+// and this callback reads nothing, so a GLib fd that stays ready — a dead D-Bus
+// socket stuck at POLLHUP, or the context's own wakeup eventfd, which
+// `block_source()` re-signals on every dispatch — leaves uv's backend fd
+// PERPETUALLY readable. That fd is embedded in UvLoopSource, so GLib then reads
+// "Node has work" on every prepare, and any foreign drain loop of the shape
+// `while (g_main_context_iteration(ctx, FALSE));` never terminates: measured in
+// `e_source_registry_new_sync`'s failure path (no D-Bus reachable), 6.9 M
+// dispatches in 20 s at 100 % CPU with `uv_backend_timeout()` sitting at ~4.6 s,
+// i.e. never once because Node actually had work. The pump's own drain would
+// have cleared the GLib side, but it no-ops at `g_main_depth() > 0` — exactly
+// where a foreign nested iteration runs. Regression
+// `test/foreign-context-drain.test.mjs`.
+static void PumpPollCb(uv_poll_t* p, int /*status*/, int /*events*/) {
+  PumpPoll* pp = reinterpret_cast<PumpPoll*>(p->data);
+  uv_poll_stop(p);
+  pp->started = FALSE;
+}
 
 static void PumpPollCloseCb(uv_handle_t* h) {
   delete reinterpret_cast<PumpPoll*>(h->data);
@@ -440,9 +460,12 @@ static gboolean SyncPumpPolls(int nfds) {
     if (it != g_pump_polls->end()) {
       PumpPoll* pp = it->second;
       pp->seen = TRUE;
-      if (pp->events != ev) {
+      // Re-arm a watcher that disarmed itself on its last fire, as well as one
+      // whose event mask changed.
+      if (pp->events != ev || !pp->started) {
         if (uv_poll_start(&pp->handle, ev, PumpPollCb) == 0) {
           pp->events = ev;
+          pp->started = TRUE;
           uv_unref(reinterpret_cast<uv_handle_t*>(&pp->handle));
         } else {
           all_ok = FALSE;
@@ -466,6 +489,7 @@ static gboolean SyncPumpPolls(int nfds) {
       all_ok = FALSE;
       continue;
     }
+    pp->started = TRUE;
     uv_unref(reinterpret_cast<uv_handle_t*>(&pp->handle));
     (*g_pump_polls)[fd] = pp;
   }