@rainbow-robotics/muscat-plugin-kit 0.1.2-dev.6 → 0.1.2-dev.8

package/cli/bin/muscat-pk.mjs

@@ -10,6 +10,7 @@ import { runDev } from "../src/dev.mjs";
 import { runUpdate } from "../src/update.mjs";
 import { runSdk } from "../src/sdk.mjs";
 import { runType } from "../src/type.mjs";
+import { runPreview } from "../src/preview.mjs";
 
 const [, , cmd, ...args] = process.argv;
 
@@ -25,6 +26,7 @@ Commands:
   dev              Run dev:ui and dev:back together
   dev:ui           Preview the plugin in a mini-Muscat (preview-host)
   dev:back         Run the plugin back end (python: watchfiles reload / ros2: Docker)
+  preview          Preview against a real Muscat server (prompts for robot IP)
   update           Update @rainbow-robotics/muscat-plugin-kit and @rainbow-robotics/plugin-ui
   sdk <list|update [version]>   Manage the python rainbow-rb-sdk version
 
@@ -47,6 +49,8 @@ async function main() {
         return await runDevUi(args);
       case "dev:back":
         return await runDevBack(args);
+      case "preview":
+        return await runPreview(args);
       case "update":
         return await runUpdate(args);
       case "sdk":

package/cli/src/devUi.mjs

@@ -81,4 +81,4 @@ export async function runDevUi(args = []) {
   child.on("exit", (code) => process.exit(code ?? 0));
 }
 
-export { findPluginRoot };
+export { findPluginRoot, findPreviewHostRoot };

package/cli/src/preview.mjs

@@ -0,0 +1,91 @@
+// muscat-pk preview — build the plugin and open preview-host connected to a
+// real Muscat server (robot or local). No local Socket.IO server is started.
+import { createInterface } from "node:readline";
+import { spawn } from "node:child_process";
+import { existsSync } from "node:fs";
+import { resolve } from "node:path";
+import { buildPlugin } from "./build.mjs";
+import { findPreviewHostRoot } from "./devUi.mjs";
+import { checkKitUpdate, log, parseArgs } from "./util.mjs";
+
+function prompt(question, defaultValue) {
+  const rl = createInterface({ input: process.stdin, output: process.stdout });
+  return new Promise((res) => {
+    rl.question(question, (answer) => {
+      rl.close();
+      res(answer.trim() || defaultValue);
+    });
+  });
+}
+
+export async function runPreview(args = []) {
+  const opts = parseArgs(args, { booleans: ["help"] });
+
+  if (opts.help) {
+    console.log(
+      [
+        "",
+        "Usage: muscat-pk preview [options]",
+        "",
+        "  빌드된 플러그인을 실제 Muscat 서버에 연결해 미리봅니다.",
+        "  Socket.IO 서버를 직접 띄우지 않습니다.",
+        "",
+        "Options:",
+        "  --host <ip>    Muscat 서버 IP 또는 hostname (default: localhost)",
+        "  --port <n>     preview-host 로컬 포트 (default: 4180)",
+        "  --ws-port <n>  Muscat Socket.IO 포트 (default: 10000)",
+        "",
+      ].join("\n"),
+    );
+    return;
+  }
+
+  await checkKitUpdate();
+
+  // ── 로봇 IP 결정 ────────────────────────────────────────────────────────────
+  let robotHost = opts.host ?? "";
+  if (!robotHost) {
+    robotHost = await prompt(
+      "Muscat 서버 IP 또는 hostname [localhost]: ",
+      "localhost",
+    );
+  }
+  const wsPort = opts["ws-port"] ?? "10000";
+  const socketUrl = `ws://${robotHost}:${wsPort}`;
+
+  const previewPort = opts.port ?? "4180";
+
+  log.step(`Muscat 서버: ${socketUrl}`);
+
+  // ── 플러그인 빌드 ────────────────────────────────────────────────────────────
+  const { distDir } = await buildPlugin();
+
+  // ── preview-host 실행 ────────────────────────────────────────────────────────
+  const previewRoot = findPreviewHostRoot();
+  const serveEntry = resolve(previewRoot, "serve.mjs");
+
+  if (!existsSync(resolve(previewRoot, "dist", "index.html"))) {
+    log.step("preview-host 번들 빌드 중 (최초 1회)…");
+    await new Promise((res, rej) => {
+      const p = spawn(process.execPath, [resolve(previewRoot, "build.mjs")], {
+        stdio: "inherit",
+      });
+      p.on("exit", (c) => (c === 0 ? res() : rej(new Error("preview-host build failed"))));
+    });
+  }
+
+  log.step(`preview-host 시작 → http://localhost:${previewPort}`);
+  log.step(`Socket.IO URL: ${socketUrl}`);
+
+  const child = spawn(
+    process.execPath,
+    [
+      serveEntry,
+      "--plugin", distDir,
+      "--port", String(previewPort),
+      "--socket-url", socketUrl,
+    ],
+    { stdio: "inherit" },
+  );
+  child.on("exit", (code) => process.exit(code ?? 0));
+}

package/cli/templates/common/main.py

@@ -1,24 +1,114 @@
+"""
+Muscat plugin backend — __PLUGIN_NAME__
+
+플러그인 UI(브라우저)와 Socket.IO로 통신한다.
+`muscat-pk dev:back` 또는 `python main.py`로 실행.
+
+토픽 자동 네임스페이스:
+  "sensor/data"  →  plugin/__PLUGIN_ID__/sensor/data  (자동)
+  "/broadcast/x" →  broadcast/x                       (앞 / = 절대경로)
+"""
+
 import asyncio
+import socketio
+from aiohttp import web
+
+sio = socketio.AsyncServer(async_mode="aiohttp", cors_allowed_origins="*")
+app = web.Application()
+sio.attach(app)
+
+PLUGIN_ID = "__PLUGIN_ID__"
+_PREFIX = f"plugin/{PLUGIN_ID}"
+
+
+def _topic(relative: str) -> str:
+    """상대 토픽 → 전체 네임스페이스 토픽."""
+    return relative if relative.startswith("/") else f"{_PREFIX}/{relative}"
+
+
+# ── 구독·쿼리어블 핸들러 저장소 ────────────────────────────────────────────────
+_sub_handlers: dict[str, list] = {}
+_queryable_handlers: dict[str, object] = {}
+_serve_pending: dict[str, asyncio.Future] = {}
+
+
+# ── Socket.IO 이벤트 ───────────────────────────────────────────────────────────
+
+@sio.event
+async def sub(sid, data):
+    """브라우저가 토픽을 구독."""
+    await sio.enter_room(sid, f"t:{data['topic']}")
+
+
+@sio.event
+async def unsub(sid, data):
+    await sio.leave_room(sid, f"t:{data['topic']}")
+
+
+@sio.event
+async def pub(sid, data):
+    """브라우저가 발행 → Python 구독 핸들러로 전달."""
+    topic = data.get("topic", "")
+    payload = data.get("payload")
+    for handler in _sub_handlers.get(topic, []):
+        asyncio.create_task(handler(payload))
+
+
+@sio.event
+async def action(sid, data):
+    """브라우저 rb.action() 호출 → Python queryable 핸들러 → ack 반환."""
+    topic = data.get("topic", "")
+    handler = _queryable_handlers.get(topic)
+    if handler:
+        return await handler(data.get("payload"))
+
+
+@sio.event
+async def serve_reply(sid, data):
+    """브라우저가 serve_call에 응답."""
+    fut = _serve_pending.pop(data.get("id", ""), None)
+    if fut and not fut.done():
+        fut.set_result(data.get("payload"))
+
+
+# ── 헬퍼 데코레이터 ────────────────────────────────────────────────────────────
+
+def subscribe(relative_topic: str):
+    """브라우저 → Python 메시지 구독 핸들러 등록."""
+    def decorator(fn):
+        _sub_handlers.setdefault(_topic(relative_topic), []).append(fn)
+        return fn
+    return decorator
+
+
+def queryable(relative_topic: str):
+    """브라우저 rb.action() 호출을 처리할 핸들러 등록."""
+    def decorator(fn):
+        _queryable_handlers[_topic(relative_topic)] = fn
+        return fn
+    return decorator
 
-from rainbow_rb_zenoh import ZenohRouter
 
-router = ZenohRouter(prefix="plugin/__PLUGIN_ID__")
+async def publish(relative_topic: str, payload) -> None:
+    """Python → 브라우저 구독자에게 메시지 발행."""
+    full = _topic(relative_topic)
+    await sio.emit("msg", {"topic": full, "payload": payload}, room=f"t:{full}")
 
 
-@router.subscribe("sensor/data")
-async def on_sensor(*, dict_payload, **_):
-    print(f"[__PLUGIN_NAME__] received: {dict_payload}")
+# ── 플러그인 로직 ──────────────────────────────────────────────────────────────
 
+@subscribe("sensor/data")
+async def on_sensor_data(payload):
+    print(f"[__PLUGIN_NAME__] sensor/data: {payload}")
 
-@router.queryable("get-status")
-async def get_status(req=None, **_):
-    return {"ok": True}
 
+@queryable("get-status")
+async def get_status(payload=None):
+    return {"ok": True, "plugin": "__PLUGIN_NAME__"}
 
-async def main():
-    await router.startup()
-    await asyncio.Event().wait()
 
+# ── 진입점 ─────────────────────────────────────────────────────────────────────
 
 if __name__ == "__main__":
-    asyncio.run(main())
+    print("[__PLUGIN_NAME__] Socket.IO server starting on :10000")
+    web.run_app(app, host="0.0.0.0", port=10000)

package/cli/templates/common/requirements.txt

@@ -1,2 +1,3 @@
 rainbow-rb-sdk
 rainbow-rb-flat-buffers
+python-socketio[aiohttp]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rainbow-robotics/muscat-plugin-kit",
-  "version": "0.1.2-dev.6",
+  "version": "0.1.2-dev.8",
   "type": "module",
   "engines": {
     "node": ">=20"
@@ -31,7 +31,7 @@
     "@types/react-dom": "^19.0.4"
   },
   "dependencies": {
-    "@rainbow-robotics/preview-host": "*",
+    "@rainbow-robotics/preview-host": "0.1.2-dev.8",
     "esbuild": "^0.25.0"
   },
   "optionalDependencies": {