Эх сурвалжийг харах

Replace the py usocket fallback code

Johannes Zellner 7 сар өмнө
parent
commit
da3ad829c5

Файлын зөрүү хэтэрхий том тул дарагдсан байна
+ 435 - 444
package-lock.json


+ 5 - 3
package.json

@@ -5,16 +5,18 @@
   "type": "module",
   "description": "GNOME screen capture over WebSocket (JPEG @ 30fps)",
   "scripts": {
-    "start": "node server/index.mjs"
+    "start": "node server/index.mjs",
+    "postinstall": "node scripts/patch-usocket.mjs"
   },
   "engines": {
     "node": ">=18"
   },
   "dependencies": {
     "dbus-next": "^0.10.2",
+    "usocket": "^1.0.0",
     "ws": "^8.18.0"
   },
-  "optionalDependencies": {
-    "usocket": "^0.3.0"
+  "overrides": {
+    "usocket": "^1.0.0"
   }
 }

+ 25 - 0
scripts/patch-usocket.mjs

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+/**
+ * usocket 1.0.2 uses util.isError() which was removed in Node 24.
+ * Replace it with `instanceof Error` so the module works on modern Node.
+ */
+import { readFile, writeFile } from "node:fs/promises";
+import { createRequire } from "node:module";
+
+const require = createRequire(import.meta.url);
+
+let target;
+try {
+  target = require.resolve("usocket");
+} catch {
+  process.exit(0);
+}
+
+const src = await readFile(target, "utf8");
+if (!src.includes("util.isError")) {
+  process.exit(0);
+}
+
+const patched = src.replace(/util\.isError\((\w+)\)/g, "$1 instanceof Error");
+await writeFile(target, patched);
+console.log("[patch-usocket] replaced util.isError() with instanceof Error");

+ 10 - 6
server/dbus-fd.mjs

@@ -4,14 +4,18 @@ const require = createRequire(import.meta.url);
 
 /**
  * dbus-next needs the native `usocket` module to receive Unix FDs (OpenPipeWireRemote).
- * Without it, Node falls back to net.Socket and FD unmarshalling fails → hang/exit.
+ * Without it, Node falls back to net.Socket and FD unmarshalling fails.
+ * Throws at startup so the user gets a clear error instead of a silent hang.
  */
-export function dbusUnixFdTransportAvailable() {
+export function assertUsocketAvailable() {
   try {
-    require.resolve("usocket");
     require("usocket");
-    return true;
-  } catch {
-    return false;
+  } catch (err) {
+    throw new Error(
+      "The native `usocket` module failed to load. " +
+        "Wayland screen capture requires it for D-Bus Unix FD passing. " +
+        "Run `npm rebuild usocket` or reinstall dependencies.\n" +
+        `  Original error: ${err.message}`,
+    );
   }
 }

+ 21 - 48
server/index.mjs

@@ -7,8 +7,7 @@ import { dirname, join } from "node:path";
 import { WebSocketServer } from "ws";
 
 import { negotiateScreencastPortal } from "./portal.mjs";
-import { dbusUnixFdTransportAvailable } from "./dbus-fd.mjs";
-import { startPythonWaylandBridge } from "./wayland-python-bridge.mjs";
+import { assertUsocketAvailable } from "./dbus-fd.mjs";
 import {
   buildPipeline,
   startGstreamer,
@@ -51,7 +50,6 @@ Environment:
   NEBUCAST_VERBOSE=1           Same as --verbose
   NEBUCAST_PORTAL_TRACE=0      Disable step-by-step [portal] logs
   NEBUCAST_PROCESS_DEBUG=1     Log beforeExit when the event loop drains
-  NEBUCAST_FORCE_PYTHON_BRIDGE=1  Always use Python Wayland bridge (skip usocket path)
 `);
       process.exit(0);
     }
@@ -247,52 +245,27 @@ async function main() {
     let child;
 
     if (!source && sessionType !== "x11") {
-      console.info("Wayland (or non-X11) — using XDG Desktop Portal for screen capture");
-      const useUsocket =
-        process.env.NEBUCAST_FORCE_PYTHON_BRIDGE !== "1" && dbusUnixFdTransportAvailable();
-      if (opts.verbose) {
-        console.info("[nebucast] D-Bus Unix FD (usocket) available:", useUsocket);
-      }
+      console.info("Wayland (or non-X11) -- using XDG Desktop Portal for screen capture");
+      assertUsocketAvailable();
 
-      if (useUsocket) {
-        const p = await negotiateScreencastPortal({ verbose: opts.verbose });
-        portalBus = p.bus;
-        pwFd = p.fd;
-        const pipeSource = pipewireSourceForChild(p.nodeId);
-        const pipeline = buildPipeline(pipeSource, {
-          fps: opts.fps,
-          quality: opts.quality,
-        });
-        if (opts.verbose) console.info("[gstreamer] pipeline:", pipeline);
-        const gst = startGstreamer({
-          pipeline,
-          pipeWireFd: pwFd,
-          onFrame: broadcastFrame,
-          onSpawnError: (err) => console.error("[gstreamer]", err),
-          onExit: (code, signal) => handleCaptureExit(code, signal, "gstreamer"),
-        });
-        child = gst.child;
-        stopGst = gst.stop;
-      } else {
-        console.warn(
-          "[nebucast] The native `usocket` module is missing or failed to load. " +
-            "Node’s D-Bus socket cannot receive PipeWire fds (OpenPipeWireRemote). " +
-            "Falling back to Python: server/wayland-capture-bridge.py " +
-            "(python3, dbus-python, PyGObject, GStreamer). " +
-            "For pure Node on Wayland, install usocket (often works on Node 20–22).",
-        );
-        portalBus = null;
-        pwFd = null;
-        const py = startPythonWaylandBridge({
-          fps: opts.fps,
-          quality: opts.quality,
-          onFrame: broadcastFrame,
-          onSpawnError: (err) => console.error("[wayland-bridge]", err),
-          onExit: (code, signal) => handleCaptureExit(code, signal, "wayland-bridge"),
-        });
-        child = py.child;
-        stopGst = py.stop;
-      }
+      const p = await negotiateScreencastPortal({ verbose: opts.verbose });
+      portalBus = p.bus;
+      pwFd = p.fd;
+      const pipeSource = pipewireSourceForChild(p.nodeId);
+      const pipeline = buildPipeline(pipeSource, {
+        fps: opts.fps,
+        quality: opts.quality,
+      });
+      if (opts.verbose) console.info("[gstreamer] pipeline:", pipeline);
+      const gst = startGstreamer({
+        pipeline,
+        pipeWireFd: pwFd,
+        onFrame: broadcastFrame,
+        onSpawnError: (err) => console.error("[gstreamer]", err),
+        onExit: (code, signal) => handleCaptureExit(code, signal, "gstreamer"),
+      });
+      child = gst.child;
+      stopGst = gst.stop;
     } else {
       if (!source) source = defaultSourceForSession();
       const pipeline = buildPipeline(source, {

+ 0 - 184
server/wayland-capture-bridge.py

@@ -1,184 +0,0 @@
-#!/usr/bin/env python3
-"""
-Wayland screen capture: XDG portal + GStreamer → raw JPEG stream on stdout.
-Used when Node cannot receive D-Bus Unix FDs (no `usocket` native module).
-
-Requires: python-dbus, PyGObject, GStreamer (same as screencast).
-"""
-from __future__ import annotations
-
-import argparse
-import logging
-import shutil
-import signal
-import subprocess
-import sys
-import threading
-
-import dbus
-from dbus.mainloop.glib import DBusGMainLoop
-
-import gi
-
-gi.require_version("GLib", "2.0")
-from gi.repository import GLib
-
-log = logging.getLogger("nebucast-bridge")
-
-SCREEN_CAST_IFACE = "org.freedesktop.portal.ScreenCast"
-REQUEST_IFACE = "org.freedesktop.portal.Request"
-PORTAL_BUS = "org.freedesktop.portal.Desktop"
-PORTAL_PATH = "/org/freedesktop/portal/desktop"
-
-SOURCE_TYPE_MONITOR = 1
-CURSOR_MODE_EMBEDDED = 2
-
-
-class PortalSession:
-    def __init__(self):
-        DBusGMainLoop(set_as_default=True)
-        self._bus = dbus.SessionBus()
-        self._portal = self._bus.get_object(PORTAL_BUS, PORTAL_PATH)
-        self._sc = dbus.Interface(self._portal, SCREEN_CAST_IFACE)
-        self._loop = GLib.MainLoop()
-        self._session = None
-        self._node_id = None
-        self._pw_fd = None
-        self._n = 0
-        self._sender = self._bus.get_unique_name().replace(".", "_").lstrip(":")
-
-    def _token(self):
-        self._n += 1
-        return f"nb{self._n}"
-
-    def _on_response(self, token, callback):
-        path = f"/org/freedesktop/portal/desktop/request/{self._sender}/{token}"
-        self._bus.add_signal_receiver(
-            callback,
-            signal_name="Response",
-            dbus_interface=REQUEST_IFACE,
-            path=path,
-        )
-
-    def _fail(self, stage, code):
-        log.error("%s failed with response %d", stage, code)
-        self._loop.quit()
-
-    def run(self) -> tuple[int, int]:
-        t = self._token()
-        self._on_response(t, self._created)
-        self._sc.CreateSession(
-            {
-                "handle_token": t,
-                "session_handle_token": "nebucast_py_bridge",
-            }
-        )
-        self._loop.run()
-        if self._pw_fd is None or self._node_id is None:
-            raise RuntimeError(
-                "Portal session failed. Use GNOME on Wayland with xdg-desktop-portal-gnome."
-            )
-        return self._pw_fd, self._node_id
-
-    def _created(self, code, results):
-        if code != 0:
-            return self._fail("CreateSession", code)
-        self._session = str(results["session_handle"])
-        log.info("Session: %s", self._session)
-        t = self._token()
-        self._on_response(t, self._sources_selected)
-        self._sc.SelectSources(
-            self._session,
-            {
-                "handle_token": t,
-                "types": dbus.UInt32(SOURCE_TYPE_MONITOR),
-                "cursor_mode": dbus.UInt32(CURSOR_MODE_EMBEDDED),
-            },
-        )
-
-    def _sources_selected(self, code, results):
-        if code != 0:
-            return self._fail("SelectSources", code)
-        log.info("Source selected, starting…")
-        t = self._token()
-        self._on_response(t, self._started)
-        self._sc.Start(self._session, "", {"handle_token": t})
-
-    def _started(self, code, results):
-        if code != 0:
-            return self._fail("Start", code)
-        streams = results.get("streams", [])
-        if not streams:
-            return self._fail("Start (no streams)", -1)
-        self._node_id = int(streams[0][0])
-        fd_obj = self._sc.OpenPipeWireRemote(self._session, {})
-        self._pw_fd = fd_obj.take()
-        log.info("PipeWire fd=%d node=%d", self._pw_fd, self._node_id)
-        self._loop.quit()
-
-
-def build_pipeline(pw_fd: int, node_id: int, fps: int, quality: int) -> list[str]:
-    src = (
-        f"pipewiresrc fd={pw_fd} path={node_id} do-timestamp=true keepalive-time=1000"
-    )
-    rest = (
-        f"! videoconvert ! videoscale ! video/x-raw,width=1280,height=720 ! "
-        f"videorate ! video/x-raw,framerate={fps}/1 ! "
-        f"jpegenc quality={quality} ! fdsink fd=1 sync=false"
-    )
-    return ["gst-launch-1.0", "-q", *src.split(), *rest.split()]
-
-
-def main() -> None:
-    logging.basicConfig(
-        level=logging.INFO,
-        format="%(asctime)s [%(levelname)s] %(name)s: %(message)s",
-    )
-    ap = argparse.ArgumentParser()
-    ap.add_argument("--fps", type=int, default=30)
-    ap.add_argument("--quality", type=int, default=80)
-    args = ap.parse_args()
-
-    session = PortalSession()
-    pw_fd, node_id = session.run()
-
-    argv = build_pipeline(pw_fd, node_id, args.fps, args.quality)
-    log.info("Starting gstreamer (fd=%d node=%d)", pw_fd, node_id)
-
-    proc = subprocess.Popen(
-        argv,
-        stdout=subprocess.PIPE,
-        stderr=subprocess.PIPE,
-        pass_fds=(pw_fd,),
-    )
-
-    def cleanup(*_args):
-        if proc.poll() is None:
-            proc.terminate()
-
-    signal.signal(signal.SIGTERM, cleanup)
-    signal.signal(signal.SIGINT, cleanup)
-
-    def drain_stderr():
-        if proc.stderr:
-            for line in iter(proc.stderr.readline, b""):
-                sys.stderr.buffer.write(line)
-                sys.stderr.buffer.flush()
-
-    threading.Thread(target=drain_stderr, daemon=True).start()
-
-    try:
-        assert proc.stdout is not None
-        shutil.copyfileobj(proc.stdout, sys.stdout.buffer)
-    finally:
-        cleanup()
-        proc.wait()
-
-    rc = proc.returncode
-    if rc not in (0, -signal.SIGTERM, -signal.SIGINT):
-        log.error("gst-launch exited %s", rc)
-        sys.exit(1)
-
-
-if __name__ == "__main__":
-    main()

+ 0 - 42
server/wayland-python-bridge.mjs

@@ -1,42 +0,0 @@
-import { spawn } from "node:child_process";
-import { fileURLToPath } from "node:url";
-import { dirname, join } from "node:path";
-import { createJpegFramer } from "./jpeg-framer.mjs";
-
-const __dirname = dirname(fileURLToPath(import.meta.url));
-const SCRIPT = join(__dirname, "wayland-capture-bridge.py");
-
-/**
- * Portal + GStreamer in Python (OpenPipeWireRemote works with dbus-python).
- * Emits the same JPEG stream as startGstreamer on stdout.
- */
-export function startPythonWaylandBridge(opts) {
-  const { fps, quality, onFrame, onSpawnError, onExit } = opts;
-
-  const child = spawn("python3", [SCRIPT, "--fps", String(fps), "--quality", String(quality)], {
-    stdio: ["ignore", "pipe", "pipe"],
-  });
-
-  if (!child.stdout) {
-    onSpawnError?.(new Error("python bridge: no stdout"));
-    return { child: null, stop: () => {} };
-  }
-
-  const framer = createJpegFramer(onFrame);
-
-  child.stdout.on("data", (chunk) => framer.push(chunk));
-
-  child.stderr?.on("data", (d) => {
-    process.stderr.write(d);
-  });
-
-  child.on("error", (err) => onSpawnError?.(err));
-
-  child.on("exit", (code, signal) => onExit?.(code, signal));
-
-  function stop() {
-    child.kill("SIGTERM");
-  }
-
-  return { child, stop };
-}

Энэ ялгаанд хэт олон файл өөрчлөгдсөн тул зарим файлыг харуулаагүй болно