@rainbow-robotics/muscat-plugin-kit 1.3.8-dev.3 → 1.10.1-dev.1

package/cli/src/devUi.mjs

@@ -1,238 +1,243 @@
-
-import { spawn, spawnSync } from "node:child_process";
-import { createServer as createNetServer } from "node:net";
-import { createRequire } from "node:module";
-import { copyFileSync, cpSync, existsSync, mkdirSync, readFileSync, rmSync, watch } from "node:fs";
-import { homedir } from "node:os";
-import { dirname, resolve } from "node:path";
-import { fileURLToPath } from "node:url";
-import { checkKitUpdate, findPluginRoot, hasBin, kitRoot, log, parseArgs, prompt } from "./util.mjs";
-import { ensureLocalMuscat } from "./muscatLocal.mjs";
-import { isRemoteRobot } from "./zenohDev.mjs";
-
-
-const DEV_PLUGIN_PORT = 4181;
-
-function getFreePort(preferred) {
-  return new Promise((res) => {
-    const srv = createNetServer();
-    srv.once("error", () => {
-      const s2 = createNetServer();
-      s2.listen(0, () => {
-        const { port } = s2.address();
-        s2.close(() => res(port));
-      });
-    });
-    srv.listen(preferred, () => srv.close(() => res(preferred)));
-  });
-}
-
-const PREVIEW_PKG = "@rainbow-robotics/preview-host";
-const CACHE_DIR = resolve(homedir(), ".muscat-pk");
-const CACHE_ROOT = resolve(CACHE_DIR, "node_modules", "@rainbow-robotics", "preview-host");
-
-
-const DEV_OUT = ".muscat-dev";
-
-function findNodeBin() {
-  if (typeof Bun === "undefined") return process.execPath;
-  for (const c of ["node", "node20", "node18"]) {
-    if (hasBin(c)) return c;
-  }
-  return null;
-}
-
-function findPreviewHostRoot() {
-  try {
-    const req = createRequire(import.meta.url);
-    return dirname(req.resolve(`${PREVIEW_PKG}/package.json`));
-  } catch {
-    console.log("Try the sibling and cached package locations below.")
-  }
-
-  const sibling = resolve(kitRoot, "../preview-host");
-  if (existsSync(resolve(sibling, "package.json"))) return sibling;
-
-  if (existsSync(resolve(CACHE_ROOT, "package.json"))) return CACHE_ROOT;
-
-  if (!hasBin("npm")) {
-    throw new Error(
-      `preview-host를 찾을 수 없습니다.\n` +
-      `Node.js 20+ 를 설치하면 자동으로 준비됩니다: https://nodejs.org`,
-    );
-  }
-  log.step(`preview-host 설치 중 (~/.muscat-pk) — 첫 실행 시 한 번만 수행됩니다…`);
-  mkdirSync(CACHE_DIR, { recursive: true });
-  const r = spawnSync(
-    "npm",
-    ["install", "--prefix", CACHE_DIR, "--save", PREVIEW_PKG],
-    { stdio: "inherit" },
-  );
-  if (r.status !== 0) throw new Error("preview-host 설치 실패.");
-  if (!existsSync(resolve(CACHE_ROOT, "package.json"))) {
-    throw new Error("preview-host 설치 후에도 패키지를 찾을 수 없습니다.");
-  }
-  return CACHE_ROOT;
-}
-
-function syncAssets(pluginRoot, outDir) {
-  const assetsSrc = resolve(pluginRoot, "assets");
-  if (existsSync(assetsSrc)) cpSync(assetsSrc, resolve(outDir, "assets"), { recursive: true });
-}
-
-
-function stageDevAssets(pluginRoot) {
-  const outDir = resolve(pluginRoot, DEV_OUT);
-  mkdirSync(outDir, { recursive: true });
-  const manifestSrc = resolve(pluginRoot, "manifest.json");
-  if (existsSync(manifestSrc)) copyFileSync(manifestSrc, resolve(outDir, "manifest.json"));
-  syncAssets(pluginRoot, outDir);
-  return outDir;
-}
-
-function watchAssets(pluginRoot, outDir) {
-  const assetsSrc = resolve(pluginRoot, "assets");
-  if (!existsSync(assetsSrc)) return;
-  watch(assetsSrc, { recursive: true }, () => syncAssets(pluginRoot, outDir));
-}
-
-
-function findViteBin(pluginRoot) {
-  try {
-    const req = createRequire(resolve(pluginRoot, "package.json"));
-    const vitePkg = req.resolve("vite/package.json");
-    return resolve(dirname(vitePkg), "bin", "vite.js");
-  } catch {
-    return null;
-  }
-}
-
-
-function spawnPluginDevServer(pluginRoot, node, port, readyFile, sharedRuntimeBase) {
-  if (!node || !findViteBin(pluginRoot)) return null;
-  const runner = fileURLToPath(new URL("./pluginDevServer.mjs", import.meta.url));
-
-  rmSync(resolve(pluginRoot, "node_modules", ".vite"), { recursive: true, force: true });
-  log.step(`vite dev server (HMR) starting at :${port} — ui/*.tsx`);
-
-  return spawn(node, [runner, pluginRoot, String(port), readyFile], {
-    cwd: pluginRoot,
-    stdio: "inherit",
-    env: {
-      ...process.env,
-      VITE_PLUGIN_PREVIEW: "true",
-      MUSCAT_PLUGIN_SHARED_RUNTIME_BASE: sharedRuntimeBase,
-    },
-  });
-}
-
-function waitForPluginDevPort(readyFile, proc, timeoutMs = 15_000) {
-  const start = Date.now();
-  return new Promise((res, rej) => {
-    let exited = false;
-    proc.once("exit", (code) => {
-      exited = true;
-      rej(new Error(`plugin dev server exited before ready (code ${code ?? 0})`));
-    });
-
-    const tick = () => {
-      if (existsSync(readyFile)) {
-        try {
-          const { port } = JSON.parse(readFileSync(readyFile, "utf8"));
-          if (Number.isInteger(port)) return res(port);
-        } catch {
-          console.log("Keep polling until the ready file contains valid JSON.")
-        }
-      }
-      if (Date.now() - start > timeoutMs)
-        return rej(new Error("plugin dev server did not become ready in time"));
-      if (!exited) setTimeout(tick, 100);
-    };
-    tick();
-  });
-}
-
-export async function runDevUi(args = []) {
-  const parsed = parseArgs(args);
-  const requestedPort = Number(parsed.port ?? "4180");
-  const robotIp = parsed["robot-ip"] ?? process.env.MUSCAT_ROBOT_HOST ?? await prompt("  Robot IP (skip if no robot): ");
-
-  await checkKitUpdate();
-  const pluginRoot = findPluginRoot();
-  const outDir = stageDevAssets(pluginRoot);
-  const port = await getFreePort(requestedPort);
-  if (port !== requestedPort)
-    log.warn(`preview-host port ${requestedPort} is in use — using ${port} instead.`);
-
-  if (robotIp) log.info(`MUSCAT_API_ORIGIN → http://${robotIp}:*`);
-  // No robot: the bundle talks to localhost:3000, so put a Muscat there (`dev` already did).
-  if (!isRemoteRobot(robotIp) && process.env.MUSCAT_PK_MANAGED_DEV !== "1") {
-    await ensureLocalMuscat().catch((e) => log.warn(`local Muscat: ${e.message}`));
-  }
-
-  watchAssets(pluginRoot, outDir);
-
-  const node = findNodeBin();
-  const readyFile = resolve(outDir, "plugin-dev-port.json");
-  rmSync(readyFile, { force: true });
-  const sharedRuntimeBase = `http://localhost:${port}/plugin-shared`;
-  const viteProc = spawnPluginDevServer(
-    pluginRoot,
-    node,
-    DEV_PLUGIN_PORT,
-    readyFile,
-    sharedRuntimeBase,
-  );
-  let devPort = DEV_PLUGIN_PORT;
-
-  if (!viteProc) {
-    log.warn("vite not found — UI will not load. Run `npm install` in the plugin project.");
-  } else {
-    devPort = await waitForPluginDevPort(readyFile, viteProc);
-    viteProc.on("exit", (code) => {
-      if (code) log.warn(`plugin dev server exited (code ${code}) — UI won't load (is :${devPort} free?).`);
-    });
-  }
-
-  const previewRoot = findPreviewHostRoot();
-  const serveEntry = resolve(previewRoot, "serve.mjs");
-  if (!existsSync(resolve(previewRoot, "dist", "index.html"))) {
-    log.step("building preview-host bundle (first run)…");
-    await new Promise((res, rej) => {
-      const p = spawn(node ?? process.execPath, [resolve(previewRoot, "build.mjs")], {
-        stdio: "inherit",
-        env: { ...process.env, VITE_PLUGIN_PREVIEW: "true" },
-      });
-      p.on("exit", (c) => (c === 0 ? res() : rej(new Error("preview-host build failed"))));
-    });
-  }
-
-  log.step(`starting preview-host on :${port}`);
-  const child = spawn(
-    node ?? process.execPath,
-    [
-      serveEntry,
-      "--plugin", outDir,
-      "--port", String(port),
-      "--dev-server-url", `http://localhost:${devPort}`,
-      ...(robotIp ? ["--robot-host", robotIp] : []),
-    ],
-    { stdio: "inherit" },
-  );
-
-  let cleaned = false;
-  const cleanup = () => {
-    if (cleaned) return;
-    cleaned = true;
-    if (viteProc && !viteProc.killed && viteProc.exitCode === null) viteProc.kill();
-    if (!child.killed && child.exitCode === null) child.kill();
-  };
-  process.once("SIGINT", cleanup);
-  process.once("SIGTERM", cleanup);
-  child.on("exit", (code) => {
-    cleanup();
-    process.exit(code ?? 0);
-  });
-}
-
-export { findPluginRoot, findPreviewHostRoot };
+
+import { spawn, spawnSync } from "node:child_process";
+import { createServer as createNetServer } from "node:net";
+import { createRequire } from "node:module";
+import { copyFileSync, cpSync, existsSync, mkdirSync, readFileSync, rmSync, watch } from "node:fs";
+import { homedir } from "node:os";
+import { dirname, resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+import { checkKitUpdate, findPluginRoot, hasBin, kitRoot, log, parseArgs, prompt } from "./util.mjs";
+import { ensureLocalMuscat, GATEWAY_PORT, robotHasMuscat } from "./muscatLocal.mjs";
+import { isRemoteRobot } from "./zenohDev.mjs";
+
+
+const DEV_PLUGIN_PORT = 4181;
+
+function getFreePort(preferred) {
+  return new Promise((res) => {
+    const srv = createNetServer();
+    srv.once("error", () => {
+      const s2 = createNetServer();
+      s2.listen(0, () => {
+        const { port } = s2.address();
+        s2.close(() => res(port));
+      });
+    });
+    srv.listen(preferred, () => srv.close(() => res(preferred)));
+  });
+}
+
+const PREVIEW_PKG = "@rainbow-robotics/preview-host";
+const CACHE_DIR = resolve(homedir(), ".muscat-pk");
+const CACHE_ROOT = resolve(CACHE_DIR, "node_modules", "@rainbow-robotics", "preview-host");
+
+
+const DEV_OUT = ".muscat-dev";
+
+function findNodeBin() {
+  if (typeof Bun === "undefined") return process.execPath;
+  for (const c of ["node", "node20", "node18"]) {
+    if (hasBin(c)) return c;
+  }
+  return null;
+}
+
+function findPreviewHostRoot() {
+  try {
+    const req = createRequire(import.meta.url);
+    return dirname(req.resolve(`${PREVIEW_PKG}/package.json`));
+  } catch {
+    console.log("Try the sibling and cached package locations below.")
+  }
+
+  const sibling = resolve(kitRoot, "../preview-host");
+  if (existsSync(resolve(sibling, "package.json"))) return sibling;
+
+  if (existsSync(resolve(CACHE_ROOT, "package.json"))) return CACHE_ROOT;
+
+  if (!hasBin("npm")) {
+    throw new Error(
+      `preview-host를 찾을 수 없습니다.\n` +
+      `Node.js 20+ 를 설치하면 자동으로 준비됩니다: https://nodejs.org`,
+    );
+  }
+  log.step(`preview-host 설치 중 (~/.muscat-pk) — 첫 실행 시 한 번만 수행됩니다…`);
+  mkdirSync(CACHE_DIR, { recursive: true });
+  const r = spawnSync(
+    "npm",
+    ["install", "--prefix", CACHE_DIR, "--save", PREVIEW_PKG],
+    { stdio: "inherit" },
+  );
+  if (r.status !== 0) throw new Error("preview-host 설치 실패.");
+  if (!existsSync(resolve(CACHE_ROOT, "package.json"))) {
+    throw new Error("preview-host 설치 후에도 패키지를 찾을 수 없습니다.");
+  }
+  return CACHE_ROOT;
+}
+
+function syncAssets(pluginRoot, outDir) {
+  const assetsSrc = resolve(pluginRoot, "assets");
+  if (existsSync(assetsSrc)) cpSync(assetsSrc, resolve(outDir, "assets"), { recursive: true });
+}
+
+
+function stageDevAssets(pluginRoot) {
+  const outDir = resolve(pluginRoot, DEV_OUT);
+  mkdirSync(outDir, { recursive: true });
+  const manifestSrc = resolve(pluginRoot, "manifest.json");
+  if (existsSync(manifestSrc)) copyFileSync(manifestSrc, resolve(outDir, "manifest.json"));
+  syncAssets(pluginRoot, outDir);
+  return outDir;
+}
+
+function watchAssets(pluginRoot, outDir) {
+  const assetsSrc = resolve(pluginRoot, "assets");
+  if (!existsSync(assetsSrc)) return;
+  watch(assetsSrc, { recursive: true }, () => syncAssets(pluginRoot, outDir));
+}
+
+
+function findViteBin(pluginRoot) {
+  try {
+    const req = createRequire(resolve(pluginRoot, "package.json"));
+    const vitePkg = req.resolve("vite/package.json");
+    return resolve(dirname(vitePkg), "bin", "vite.js");
+  } catch {
+    return null;
+  }
+}
+
+
+function spawnPluginDevServer(pluginRoot, node, port, readyFile, sharedRuntimeBase) {
+  if (!node || !findViteBin(pluginRoot)) return null;
+  const runner = fileURLToPath(new URL("./pluginDevServer.mjs", import.meta.url));
+
+  rmSync(resolve(pluginRoot, "node_modules", ".vite"), { recursive: true, force: true });
+
+  return spawn(node, [runner, pluginRoot, String(port), readyFile], {
+    cwd: pluginRoot,
+    stdio: "inherit",
+    env: {
+      ...process.env,
+      VITE_PLUGIN_PREVIEW: "true",
+      MUSCAT_PLUGIN_SHARED_RUNTIME_BASE: sharedRuntimeBase,
+    },
+  });
+}
+
+function waitForPluginDevPort(readyFile, proc, timeoutMs = 15_000) {
+  const start = Date.now();
+  return new Promise((res, rej) => {
+    let exited = false;
+    proc.once("exit", (code) => {
+      exited = true;
+      rej(new Error(`plugin dev server exited before ready (code ${code ?? 0})`));
+    });
+
+    const tick = () => {
+      if (existsSync(readyFile)) {
+        try {
+          const { port } = JSON.parse(readFileSync(readyFile, "utf8"));
+          if (Number.isInteger(port)) return res(port);
+        } catch {
+          console.log("Keep polling until the ready file contains valid JSON.")
+        }
+      }
+      if (Date.now() - start > timeoutMs)
+        return rej(new Error("plugin dev server did not become ready in time"));
+      if (!exited) setTimeout(tick, 100);
+    };
+    tick();
+  });
+}
+
+export async function runDevUi(args = []) {
+  const parsed = parseArgs(args);
+  const requestedPort = Number(parsed.port ?? "4180");
+  const robotIp = parsed["robot-ip"] ?? process.env.MUSCAT_ROBOT_HOST ?? await prompt("  Robot IP (skip if no robot): ");
+
+  await checkKitUpdate();
+  const pluginRoot = findPluginRoot();
+  const outDir = stageDevAssets(pluginRoot);
+  const port = await getFreePort(requestedPort);
+
+  // No robot: the bundle talks to localhost:3000, so put a Muscat there (`dev` already did).
+  if (!isRemoteRobot(robotIp) && process.env.MUSCAT_PK_MANAGED_DEV !== "1") {
+    await ensureLocalMuscat().catch((e) => log.warn(`local Muscat: ${e.message}`));
+  }
+
+  watchAssets(pluginRoot, outDir);
+
+  const node = findNodeBin();
+  const readyFile = resolve(outDir, "plugin-dev-port.json");
+  rmSync(readyFile, { force: true });
+  const sharedRuntimeBase = `http://localhost:${port}/plugin-shared`;
+  const viteProc = spawnPluginDevServer(
+    pluginRoot,
+    node,
+    DEV_PLUGIN_PORT,
+    readyFile,
+    sharedRuntimeBase,
+  );
+  let devPort = DEV_PLUGIN_PORT;
+
+  if (!viteProc) {
+    log.warn("vite not found — UI will not load. Run `npm install` in the plugin project.");
+  } else {
+    devPort = await waitForPluginDevPort(readyFile, viteProc);
+    viteProc.on("exit", (code) => {
+      if (code) log.warn(`plugin dev server exited (code ${code}) — UI won't load (is :${devPort} free?).`);
+    });
+  }
+
+  const previewRoot = findPreviewHostRoot();
+  const serveEntry = resolve(previewRoot, "serve.mjs");
+  if (!existsSync(resolve(previewRoot, "dist", "index.html"))) {
+    log.step("building preview-host bundle (first run)…");
+    await new Promise((res, rej) => {
+      const p = spawn(node ?? process.execPath, [resolve(previewRoot, "build.mjs")], {
+        stdio: "inherit",
+        env: { ...process.env, VITE_PLUGIN_PREVIEW: "true" },
+      });
+      p.on("exit", (c) => (c === 0 ? res() : rej(new Error("preview-host build failed"))));
+    });
+  }
+
+  const child = spawn(
+    node ?? process.execPath,
+    [
+      serveEntry,
+      "--plugin", outDir,
+      "--port", String(port),
+      "--dev-server-url", `http://localhost:${devPort}`,
+      // A remote robot turns the bundle into that robot's Muscat UI; localhost stays the mock preview.
+      ...(isRemoteRobot(robotIp) ? ["--robot-host", robotIp] : []),
+      // The dev plugin's socket goes to the robot's gateway when the robot runs Muscat (the UI is
+      // that robot's Muscat then); otherwise to the local runtime.
+      ...((await robotHasMuscat(robotIp)) ? ["--socket-url", `ws://${robotIp}:${GATEWAY_PORT}`] : []),
+    ],
+    // preview-host only prints its address and paths; the "UI →" line below says what matters.
+    { stdio: ["inherit", "ignore", "inherit"] },
+  );
+
+  for (let i = 0; i < 50 && !(await fetch(`http://localhost:${port}/`).then(() => true, () => false)); i++)
+    await new Promise((r) => setTimeout(r, 200));
+  log.ok(`UI → http://localhost:${port}`);
+
+  let cleaned = false;
+  const cleanup = () => {
+    if (cleaned) return;
+    cleaned = true;
+    if (viteProc && !viteProc.killed && viteProc.exitCode === null) viteProc.kill();
+    if (!child.killed && child.exitCode === null) child.kill();
+  };
+  process.once("SIGINT", cleanup);
+  process.once("SIGTERM", cleanup);
+  process.once("SIGHUP", cleanup);
+  child.on("exit", (code) => {
+    cleanup();
+    process.exit(code ?? 0);
+  });
+}
+
+export { findPluginRoot, findPreviewHostRoot };

package/cli/src/esbuild.mjs

@@ -1,56 +1,56 @@
-// When compiled with `bun --compile`, esbuild's native subprocess binary is
-// not bundled. Use Bun's built-in bundler instead.
-async function buildWithBun(options) {
-  const { entryPoints, outfile, format, minify, loader, define, external } = options;
-  const { dirname } = await import("node:path");
-  const result = await Bun.build({
-    entrypoints: entryPoints,
-    outdir: dirname(outfile),
-    format: format ?? "esm",
-    minify: minify ?? false,
-    loader,
-    define,
-    external,
-    target: "node",
-    throw: false,
-  });
-  if (!result.success) {
-    for (const log of result.logs) console.error(log.message);
-    throw new Error("Bun.build() failed");
-  }
-}
-
-async function buildWithWasm(options) {
-  const wasm = await import("esbuild-wasm");
-  return wasm.build(options);
-}
-
-function isNativeMissing(err) {
-  const msg = String(err?.message || err?.code || err || "");
-  return (
-    msg.includes("another platform") ||
-    msg.includes("Cannot find module") ||
-    msg.includes("Cannot find package") ||
-    msg.includes("not found") ||
-    msg.includes("No such file") ||
-    msg.includes("ENOENT") ||
-    msg.includes("MODULE_NOT_FOUND")
-  );
-}
-
-export async function buildWithFallback(options) {
-  if (typeof Bun !== "undefined") return buildWithBun(options);
-
-  // Try native esbuild (faster, no extra setup). Falls back to wasm when:
-  // - esbuild was not installed (removed from hard dependencies to avoid
-  //   postinstall script blocking npm i -g on Windows)
-  // - binary was built for a different platform
-  try {
-    const native = await import("esbuild");
-    return await native.build(options);
-  } catch (err) {
-    if (!isNativeMissing(err)) throw err;
-  }
-
-  return buildWithWasm(options);
-}
+// When compiled with `bun --compile`, esbuild's native subprocess binary is
+// not bundled. Use Bun's built-in bundler instead.
+async function buildWithBun(options) {
+  const { entryPoints, outfile, format, minify, loader, define, external } = options;
+  const { dirname } = await import("node:path");
+  const result = await Bun.build({
+    entrypoints: entryPoints,
+    outdir: dirname(outfile),
+    format: format ?? "esm",
+    minify: minify ?? false,
+    loader,
+    define,
+    external,
+    target: "node",
+    throw: false,
+  });
+  if (!result.success) {
+    for (const log of result.logs) console.error(log.message);
+    throw new Error("Bun.build() failed");
+  }
+}
+
+async function buildWithWasm(options) {
+  const wasm = await import("esbuild-wasm");
+  return wasm.build(options);
+}
+
+function isNativeMissing(err) {
+  const msg = String(err?.message || err?.code || err || "");
+  return (
+    msg.includes("another platform") ||
+    msg.includes("Cannot find module") ||
+    msg.includes("Cannot find package") ||
+    msg.includes("not found") ||
+    msg.includes("No such file") ||
+    msg.includes("ENOENT") ||
+    msg.includes("MODULE_NOT_FOUND")
+  );
+}
+
+export async function buildWithFallback(options) {
+  if (typeof Bun !== "undefined") return buildWithBun(options);
+
+  // Try native esbuild (faster, no extra setup). Falls back to wasm when:
+  // - esbuild was not installed (removed from hard dependencies to avoid
+  //   postinstall script blocking npm i -g on Windows)
+  // - binary was built for a different platform
+  try {
+    const native = await import("esbuild");
+    return await native.build(options);
+  } catch (err) {
+    if (!isNativeMissing(err)) throw err;
+  }
+
+  return buildWithWasm(options);
+}