zevairouter 1.0.57 → 1.0.59

package/src/lib/oauth/services/displayEnv.js

@@ -0,0 +1,134 @@
+/**
+ * Headed browsers need a display. On bare Linux VPS there is no $DISPLAY.
+ * We try to start Xvfb automatically so CloakBrowser / Turnstile can run.
+ */
+import { spawn, execFileSync } from "node:child_process";
+import fs from "node:fs";
+import path from "node:path";
+
+const g = globalThis.__zevaiXvfb ??= {
+  proc: null,
+  display: null,
+};
+
+function which(bin) {
+  try {
+    return execFileSync("which", [bin], { encoding: "utf8" }).trim() || null;
+  } catch {
+    return null;
+  }
+}
+
+export function hasUsableDisplay() {
+  // Desktop OS: headed Chromium/Playwright works without $DISPLAY
+  // (macOS GUI session / Windows). Only bare Linux servers need Xvfb.
+  if (process.platform === "darwin" || process.platform === "win32") {
+    return true;
+  }
+
+  const d = process.env.DISPLAY;
+  if (!d || !String(d).trim()) return false;
+
+  // On Linux, verify something is listening if xdpyinfo exists
+  if (which("xdpyinfo")) {
+    try {
+      execFileSync("xdpyinfo", ["-display", d], {
+        stdio: "ignore",
+        timeout: 2000,
+      });
+      return true;
+    } catch {
+      return false;
+    }
+  }
+  return true;
+}
+
+function findFreeDisplayNumber() {
+  for (let n = 99; n <= 119; n += 1) {
+    const lock = path.join("/tmp", `.X${n}-lock`);
+    if (!fs.existsSync(lock)) return n;
+  }
+  return 99;
+}
+
+/**
+ * Ensure process.env.DISPLAY is set for headed launches.
+ * @returns {{ ok: boolean, display?: string, managed?: boolean, error?: Error }}
+ */
+export function ensureDisplayForHeadedBrowser() {
+  if (hasUsableDisplay()) {
+    return {
+      ok: true,
+      display: process.env.DISPLAY || (process.platform === "darwin" ? "aqua" : ""),
+      managed: false,
+    };
+  }
+
+  // Only Linux VPS needs a virtual framebuffer
+  if (process.platform !== "linux") {
+    // Should not reach here (hasUsableDisplay is true on darwin/win32)
+    return { ok: true, display: process.env.DISPLAY || "", managed: false };
+  }
+
+  if (g.display && g.proc && !g.proc.killed) {
+    process.env.DISPLAY = g.display;
+    return { ok: true, display: g.display, managed: true };
+  }
+
+  const xvfb = which("Xvfb");
+  if (!xvfb) {
+    const err = new Error(
+      "This VPS has no graphical display ($DISPLAY). Grok/CloakBrowser needs a virtual screen.\n" +
+        "Fix (Ubuntu/Debian as root):\n" +
+        "  apt-get update && apt-get install -y xvfb\n" +
+        "Then restart zevai / zevairouter and retry bulk import.\n" +
+        "ZevaiRouter will auto-start Xvfb when it is installed."
+    );
+    err.code = "XVFB_MISSING";
+    return { ok: false, error: err };
+  }
+
+  const num = findFreeDisplayNumber();
+  const display = `:${num}`;
+  try {
+    const proc = spawn(
+      xvfb,
+      [display, "-screen", "0", "1280x900x24", "-ac", "-nolisten", "tcp"],
+      {
+        stdio: "ignore",
+        detached: true,
+      }
+    );
+    proc.unref();
+    g.proc = proc;
+    g.display = display;
+    process.env.DISPLAY = display;
+
+    // Brief settle so clients don't connect before X is up
+    const start = Date.now();
+    while (Date.now() - start < 800) {
+      /* spin */
+    }
+    if (which("xdpyinfo")) {
+      try {
+        execFileSync("xdpyinfo", ["-display", display], {
+          stdio: "ignore",
+          timeout: 2000,
+        });
+      } catch {
+        // still proceed — some images lack xdpyinfo
+      }
+    }
+
+    console.log(`[display] Started Xvfb on ${display} for headed browser automation`);
+    return { ok: true, display, managed: true };
+  } catch (error) {
+    const err = new Error(
+      `Failed to start Xvfb: ${error?.message || error}. Install with: apt-get install -y xvfb`
+    );
+    err.code = "XVFB_START_FAILED";
+    err.cause = error;
+    return { ok: false, error: err };
+  }
+}