@player-devtools/client-flipper 0.15.1--canary.28.1248 → 0.15.2-next.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/index.cjs +128 -4
- package/dist/cjs/index.cjs.map +1 -1
- package/dist/index.legacy-esm.js +128 -4
- package/dist/index.mjs +128 -4
- package/dist/index.mjs.map +1 -1
- package/package.json +4 -2
- package/src/__tests__/transport.test.ts +266 -0
- package/src/transport.ts +176 -4
- package/types/transport.d.ts +71 -0
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/devtools/client/flipper/src/transport.ts"],"sourcesContent":["import {\n createFlipperServer,\n FlipperServerState,\n type FlipperServer,\n} from \"flipper-server-client\";\nimport { spawn } from \"child_process\";\nimport * as net from \"net\";\nimport * as fs from \"fs\";\nimport * as os from \"os\";\nimport * as path from \"path\";\nimport { WebSocket as WsWebSocket } from \"ws\";\nimport type {\n CommunicationLayerMethods,\n ExtensionSupportedEvents,\n MessengerEvent,\n TransactionMetadata,\n Transport,\n} from \"@player-devtools/types\";\n\n// polyfill WebSocket for Node < 22\nif (typeof (globalThis as { WebSocket?: unknown }).WebSocket === \"undefined\") {\n (globalThis as { WebSocket?: unknown }).WebSocket =\n WsWebSocket as unknown as typeof WebSocket;\n}\n\ntype MessageCallback = (\n message: TransactionMetadata & MessengerEvent<ExtensionSupportedEvents>,\n) => void;\n\nconst PLUGIN_API = \"player-ui-devtools\";\n\n/**\n * All diagnostics go to stderr.\n *\n * This transport runs inside the MCP server process, where stdout is the\n * JSON-RPC channel — every byte written there must be a newline-delimited\n * JSON-RPC message. `console.log` and `console.debug` both write to stdout in\n * Node, so they would corrupt the protocol stream.\n */\nconst log = (...args: Array<unknown>): void => {\n console.error(...args);\n};\n\n/** Shape of a Flipper `client-message` payload after JSON.parse */\ntype FlipperExecuteMessage = {\n method: \"execute\";\n params: {\n api: string;\n method: string;\n params?: unknown;\n };\n};\n\n/**\n * Flipper headless transport\n *\n * Connects to a running `flipper-server` process and routes messages for the\n * \"flipper-plugin-player-ui-devtools\" plugin through to the Messenger layer.\n */\n/** Wait until a TCP port is accepting connections, polling every 500ms */\nfunction waitForPort(\n host: string,\n port: number,\n timeoutMs = 30_000,\n): Promise<void> {\n return new Promise((resolve, reject) => {\n const deadline = Date.now() + timeoutMs;\n const attempt = () => {\n const socket = net.connect(port, host);\n socket.once(\"connect\", () => {\n socket.destroy();\n resolve();\n });\n socket.once(\"error\", () => {\n socket.destroy();\n if (Date.now() >= deadline) {\n reject(new Error(`Timed out waiting for ${host}:${port}`));\n } else {\n setTimeout(attempt, 500);\n }\n });\n };\n attempt();\n });\n}\n\n/**\n * Cross-process refcount for the shared `flipper-server` daemon.\n *\n * Many MCP server processes (one per project/user registration) attach to a\n * single `flipper-server` on a fixed port. No in-process variable can\n * coordinate their lifecycles, so we track liveness in a small file guarded by\n * an atomic lock directory:\n *\n * - The first attach starts the daemon and records its PID with `refs: 1`.\n * - Each subsequent attach increments `refs`.\n * - Each detach decrements `refs`; the last one out shuts the daemon down.\n *\n * The lock directory (`mkdir` is atomic across processes) serializes the\n * read-modify-write so concurrently-starting instances don't race.\n */\ntype RefcountFile = { pid: number; refs: number };\n\nclass FlipperRefcount {\n private readonly dir = path.join(os.tmpdir(), \"player-devtools-mcp\");\n private readonly file = path.join(this.dir, \"flipper-server.refcount\");\n private readonly lock = path.join(this.dir, \"flipper-server.lock\");\n\n /** Acquire the cross-process lock, run `fn`, then release — even on throw. */\n private withLock<T>(fn: () => T): T {\n fs.mkdirSync(this.dir, { recursive: true });\n const deadline = Date.now() + 5_000;\n // Spin on an atomic mkdir until we own the lock or time out.\n for (;;) {\n try {\n fs.mkdirSync(this.lock);\n break;\n } catch (err) {\n if ((err as NodeJS.ErrnoException).code !== \"EEXIST\") throw err;\n if (Date.now() >= deadline) {\n // Stale lock from a crashed process — reclaim it.\n try {\n fs.rmdirSync(this.lock);\n } catch {\n /* another instance won the reclaim; retry */\n }\n }\n }\n }\n try {\n return fn();\n } finally {\n try {\n fs.rmdirSync(this.lock);\n } catch {\n /* already gone */\n }\n }\n }\n\n private read(): RefcountFile | null {\n try {\n return JSON.parse(fs.readFileSync(this.file, \"utf8\")) as RefcountFile;\n } catch {\n return null;\n }\n }\n\n private write(state: RefcountFile): void {\n fs.writeFileSync(this.file, JSON.stringify(state));\n }\n\n private clear(): void {\n try {\n fs.unlinkSync(this.file);\n } catch {\n /* already gone */\n }\n }\n\n /** Is the recorded daemon PID still alive? */\n private isAlive(pid: number): boolean {\n try {\n process.kill(pid, 0);\n return true;\n } catch {\n return false;\n }\n }\n\n /**\n * Register interest in the daemon. Returns whether this caller is the one\n * responsible for starting it (because no live daemon was recorded).\n * `recordPid` is called with the started PID once the daemon is up.\n */\n acquire(): { shouldStart: boolean; commit: (pid: number) => void } {\n return this.withLock(() => {\n const state = this.read();\n if (state && this.isAlive(state.pid)) {\n this.write({ pid: state.pid, refs: state.refs + 1 });\n return { shouldStart: false, commit: () => {} };\n }\n // No live daemon — this caller will start one and record its PID.\n return {\n shouldStart: true,\n commit: (pid: number) =>\n this.withLock(() => this.write({ pid, refs: 1 })),\n };\n });\n }\n\n /**\n * Drop this caller's interest. Returns the PID to kill if this was the last\n * reference, otherwise null.\n */\n release(): number | null {\n return this.withLock(() => {\n const state = this.read();\n if (!state) return null;\n if (state.refs <= 1) {\n this.clear();\n return state.pid;\n }\n this.write({ pid: state.pid, refs: state.refs - 1 });\n return null;\n });\n }\n}\n\nexport class FlipperServerTransport implements Transport {\n private server: FlipperServer | null = null;\n private refcount = new FlipperRefcount();\n private listeners = new Set<MessageCallback>();\n\n /**\n * Client IDs that have sent at least one message through the devtools\n * plugin — these are the clients we send outbound messages to.\n */\n private activeClientIds = new Set<string>();\n\n constructor(\n private options: {\n /** Flipper server host; defaults to \"localhost\" */\n host?: string;\n /** Flipper server WebSocket port; defaults to 52342 */\n port?: number;\n } = {},\n ) {}\n\n async connect(): Promise<void> {\n const host = this.options.host ?? \"localhost\";\n const port = this.options.port ?? 52342;\n\n // Register interest in the shared daemon. The first instance to do so is\n // told to start it; the rest just attach. The daemon outlives any single\n // MCP process and is only torn down when the last instance detaches.\n const { shouldStart, commit } = this.refcount.acquire();\n\n if (shouldStart) {\n log(\"[FlipperServerTransport] Starting flipper-server...\");\n const serverScript = require.resolve(\"flipper-server/server.js\");\n // Detached + unref'd: the daemon must survive this process exiting so\n // other instances keep their connections. We never kill it directly —\n // shutdown is driven by the refcount in close().\n //\n // The daemon must never inherit our fd 1: it outlives this process and\n // would write into a later session's JSON-RPC stream. Its stderr stays\n // inherited so daemon diagnostics remain visible.\n const child = spawn(process.execPath, [serverScript, \"--open=true\"], {\n stdio: [\"ignore\", \"ignore\", \"inherit\"],\n detached: true,\n });\n child.on(\"error\", (err: Error) => {\n console.error(\n \"[FlipperServerTransport] flipper-server process error:\",\n err,\n );\n });\n child.unref();\n await waitForPort(host, port);\n commit(child.pid!);\n log(\"[FlipperServerTransport] flipper-server ready.\");\n } else {\n // Daemon already running (started by another instance) — wait for it to\n // accept connections in case it's still coming up, then attach.\n await waitForPort(host, port);\n log(\"[FlipperServerTransport] Attached to flipper-server.\");\n }\n\n // Read the auth token the flipper-server wrote during startup\n const { getAuthToken } =\n // eslint-disable-next-line @typescript-eslint/no-require-imports\n require(\"flipper-server/lib/app-connectivity/certificate-exchange/certificate-utils\") as {\n getAuthToken: () => Promise<string>;\n };\n\n let cachedToken: string | null = null;\n try {\n cachedToken = await getAuthToken();\n } catch (err) {\n console.warn(\"[FlipperServerTransport] Could not read auth token:\", err);\n }\n\n this.server = await createFlipperServer(\n host,\n port,\n () => cachedToken,\n (state) => {\n if (state === FlipperServerState.DISCONNECTED) {\n console.warn(\"[FlipperServerTransport] Disconnected from server\");\n }\n },\n );\n\n await this.server.connect();\n\n // Track client connects/disconnects\n this.server.on(\"client-connected\", (info) => {\n log(\"[FlipperServerTransport] client-connected:\", JSON.stringify(info));\n });\n this.server.on(\"client-disconnected\", ({ id }) => {\n log(\"[FlipperServerTransport] client-disconnected:\", id);\n this.activeClientIds.delete(id);\n });\n\n // Route inbound device messages to our Messenger listeners\n this.server.on(\"client-message\", ({ id, message }) => {\n let parsed: FlipperExecuteMessage;\n try {\n parsed = JSON.parse(message) as FlipperExecuteMessage;\n } catch {\n return;\n }\n\n log(\n `[FlipperServerTransport] client-message from ${id}: method=${parsed.method} api=${(parsed.params as { api?: string })?.api} pluginMethod=${(parsed.params as { method?: string })?.method}`,\n );\n\n if (\n parsed.method !== \"execute\" ||\n parsed.params?.api !== PLUGIN_API ||\n parsed.params?.method !== \"message::plugin\"\n ) {\n return;\n }\n\n // This client is talking through the devtools plugin — remember it\n this.activeClientIds.add(id);\n\n const payload = parsed.params.params as TransactionMetadata &\n MessengerEvent<ExtensionSupportedEvents>;\n\n for (const listener of this.listeners) {\n listener(payload);\n }\n });\n }\n\n sendMessage: CommunicationLayerMethods[\"sendMessage\"] = async (message) => {\n if (!this.server) return;\n\n const payload: FlipperExecuteMessage = {\n method: \"execute\",\n params: {\n api: PLUGIN_API,\n method: \"message::flipper\",\n params: message,\n },\n };\n\n await Promise.all(\n [...this.activeClientIds].map((clientId) =>\n this.server!.exec(\"client-request-response\", clientId, payload).catch(\n (err) => {\n console.warn(\n `[FlipperServerTransport] Failed to send to client ${clientId}:`,\n err,\n );\n // Remove dead client so we stop trying\n this.activeClientIds.delete(clientId);\n },\n ),\n ),\n );\n };\n\n addListener: CommunicationLayerMethods[\"addListener\"] = (callback) => {\n this.listeners.add(callback);\n };\n\n removeListener: CommunicationLayerMethods[\"removeListener\"] = (callback) => {\n this.listeners.delete(callback);\n };\n\n async close(): Promise<void> {\n this.listeners.clear();\n this.activeClientIds.clear();\n this.server?.close();\n this.server = null;\n\n // Drop our reference to the shared daemon. If we were the last user, the\n // refcount hands back its PID and we shut it down; otherwise it keeps\n // running for the remaining instances.\n const pidToKill = this.refcount.release();\n if (pidToKill !== null) {\n try {\n process.kill(pidToKill);\n log(\"[FlipperServerTransport] Shut down flipper-server.\");\n } catch {\n /* already gone */\n }\n }\n }\n}\n"],"mappings":";;;;;;;;AAAA;AAAA,EACE;AAAA,EACA;AAAA,OAEK;AACP,SAAS,aAAa;AACtB,YAAY,SAAS;AACrB,YAAY,QAAQ;AACpB,YAAY,QAAQ;AACpB,YAAY,UAAU;AACtB,SAAS,aAAa,mBAAmB;AAUzC,IAAI,OAAQ,WAAuC,cAAc,aAAa;AAC5E,EAAC,WAAuC,YACtC;AACJ;AAMA,IAAM,aAAa;AAUnB,IAAM,MAAM,IAAI,SAA+B;AAC7C,UAAQ,MAAM,GAAG,IAAI;AACvB;AAmBA,SAAS,YACP,MACA,MACA,YAAY,KACG;AACf,SAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,UAAM,WAAW,KAAK,IAAI,IAAI;AAC9B,UAAM,UAAU,MAAM;AACpB,YAAM,SAAa,YAAQ,MAAM,IAAI;AACrC,aAAO,KAAK,WAAW,MAAM;AAC3B,eAAO,QAAQ;AACf,gBAAQ;AAAA,MACV,CAAC;AACD,aAAO,KAAK,SAAS,MAAM;AACzB,eAAO,QAAQ;AACf,YAAI,KAAK,IAAI,KAAK,UAAU;AAC1B,iBAAO,IAAI,MAAM,yBAAyB,IAAI,IAAI,IAAI,EAAE,CAAC;AAAA,QAC3D,OAAO;AACL,qBAAW,SAAS,GAAG;AAAA,QACzB;AAAA,MACF,CAAC;AAAA,IACH;AACA,YAAQ;AAAA,EACV,CAAC;AACH;AAmBA,IAAM,kBAAN,MAAsB;AAAA,EAAtB;AACE,SAAiB,MAAW,UAAQ,UAAO,GAAG,qBAAqB;AACnE,SAAiB,OAAY,UAAK,KAAK,KAAK,yBAAyB;AACrE,SAAiB,OAAY,UAAK,KAAK,KAAK,qBAAqB;AAAA;AAAA;AAAA,EAGzD,SAAY,IAAgB;AAClC,IAAG,aAAU,KAAK,KAAK,EAAE,WAAW,KAAK,CAAC;AAC1C,UAAM,WAAW,KAAK,IAAI,IAAI;AAE9B,eAAS;AACP,UAAI;AACF,QAAG,aAAU,KAAK,IAAI;AACtB;AAAA,MACF,SAAS,KAAK;AACZ,YAAK,IAA8B,SAAS,SAAU,OAAM;AAC5D,YAAI,KAAK,IAAI,KAAK,UAAU;AAE1B,cAAI;AACF,YAAG,aAAU,KAAK,IAAI;AAAA,UACxB,QAAQ;AAAA,UAER;AAAA,QACF;AAAA,MACF;AAAA,IACF;AACA,QAAI;AACF,aAAO,GAAG;AAAA,IACZ,UAAE;AACA,UAAI;AACF,QAAG,aAAU,KAAK,IAAI;AAAA,MACxB,QAAQ;AAAA,MAER;AAAA,IACF;AAAA,EACF;AAAA,EAEQ,OAA4B;AAClC,QAAI;AACF,aAAO,KAAK,MAAS,gBAAa,KAAK,MAAM,MAAM,CAAC;AAAA,IACtD,QAAQ;AACN,aAAO;AAAA,IACT;AAAA,EACF;AAAA,EAEQ,MAAM,OAA2B;AACvC,IAAG,iBAAc,KAAK,MAAM,KAAK,UAAU,KAAK,CAAC;AAAA,EACnD;AAAA,EAEQ,QAAc;AACpB,QAAI;AACF,MAAG,cAAW,KAAK,IAAI;AAAA,IACzB,QAAQ;AAAA,IAER;AAAA,EACF;AAAA;AAAA,EAGQ,QAAQ,KAAsB;AACpC,QAAI;AACF,cAAQ,KAAK,KAAK,CAAC;AACnB,aAAO;AAAA,IACT,QAAQ;AACN,aAAO;AAAA,IACT;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,UAAmE;AACjE,WAAO,KAAK,SAAS,MAAM;AACzB,YAAM,QAAQ,KAAK,KAAK;AACxB,UAAI,SAAS,KAAK,QAAQ,MAAM,GAAG,GAAG;AACpC,aAAK,MAAM,EAAE,KAAK,MAAM,KAAK,MAAM,MAAM,OAAO,EAAE,CAAC;AACnD,eAAO,EAAE,aAAa,OAAO,QAAQ,MAAM;AAAA,QAAC,EAAE;AAAA,MAChD;AAEA,aAAO;AAAA,QACL,aAAa;AAAA,QACb,QAAQ,CAAC,QACP,KAAK,SAAS,MAAM,KAAK,MAAM,EAAE,KAAK,MAAM,EAAE,CAAC,CAAC;AAAA,MACpD;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,UAAyB;AACvB,WAAO,KAAK,SAAS,MAAM;AACzB,YAAM,QAAQ,KAAK,KAAK;AACxB,UAAI,CAAC,MAAO,QAAO;AACnB,UAAI,MAAM,QAAQ,GAAG;AACnB,aAAK,MAAM;AACX,eAAO,MAAM;AAAA,MACf;AACA,WAAK,MAAM,EAAE,KAAK,MAAM,KAAK,MAAM,MAAM,OAAO,EAAE,CAAC;AACnD,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AACF;AAEO,IAAM,yBAAN,MAAkD;AAAA,EAWvD,YACU,UAKJ,CAAC,GACL;AANQ;AAXV,SAAQ,SAA+B;AACvC,SAAQ,WAAW,IAAI,gBAAgB;AACvC,SAAQ,YAAY,oBAAI,IAAqB;AAM7C;AAAA;AAAA;AAAA;AAAA,SAAQ,kBAAkB,oBAAI,IAAY;AAwH1C,uBAAwD,OAAO,YAAY;AACzE,UAAI,CAAC,KAAK,OAAQ;AAElB,YAAM,UAAiC;AAAA,QACrC,QAAQ;AAAA,QACR,QAAQ;AAAA,UACN,KAAK;AAAA,UACL,QAAQ;AAAA,UACR,QAAQ;AAAA,QACV;AAAA,MACF;AAEA,YAAM,QAAQ;AAAA,QACZ,CAAC,GAAG,KAAK,eAAe,EAAE;AAAA,UAAI,CAAC,aAC7B,KAAK,OAAQ,KAAK,2BAA2B,UAAU,OAAO,EAAE;AAAA,YAC9D,CAAC,QAAQ;AACP,sBAAQ;AAAA,gBACN,qDAAqD,QAAQ;AAAA,gBAC7D;AAAA,cACF;AAEA,mBAAK,gBAAgB,OAAO,QAAQ;AAAA,YACtC;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAEA,uBAAwD,CAAC,aAAa;AACpE,WAAK,UAAU,IAAI,QAAQ;AAAA,IAC7B;AAEA,0BAA8D,CAAC,aAAa;AAC1E,WAAK,UAAU,OAAO,QAAQ;AAAA,IAChC;AAAA,EAjJG;AAAA,EAEH,MAAM,UAAyB;AAC7B,UAAM,OAAO,KAAK,QAAQ,QAAQ;AAClC,UAAM,OAAO,KAAK,QAAQ,QAAQ;AAKlC,UAAM,EAAE,aAAa,OAAO,IAAI,KAAK,SAAS,QAAQ;AAEtD,QAAI,aAAa;AACf,UAAI,qDAAqD;AACzD,YAAM,eAAe,UAAQ,QAAQ,0BAA0B;AAQ/D,YAAM,QAAQ,MAAM,QAAQ,UAAU,CAAC,cAAc,aAAa,GAAG;AAAA,QACnE,OAAO,CAAC,UAAU,UAAU,SAAS;AAAA,QACrC,UAAU;AAAA,MACZ,CAAC;AACD,YAAM,GAAG,SAAS,CAAC,QAAe;AAChC,gBAAQ;AAAA,UACN;AAAA,UACA;AAAA,QACF;AAAA,MACF,CAAC;AACD,YAAM,MAAM;AACZ,YAAM,YAAY,MAAM,IAAI;AAC5B,aAAO,MAAM,GAAI;AACjB,UAAI,gDAAgD;AAAA,IACtD,OAAO;AAGL,YAAM,YAAY,MAAM,IAAI;AAC5B,UAAI,sDAAsD;AAAA,IAC5D;AAGA,UAAM,EAAE,aAAa;AAAA;AAAA,MAEnB,UAAQ,4EAA4E;AAAA;AAItF,QAAI,cAA6B;AACjC,QAAI;AACF,oBAAc,MAAM,aAAa;AAAA,IACnC,SAAS,KAAK;AACZ,cAAQ,KAAK,uDAAuD,GAAG;AAAA,IACzE;AAEA,SAAK,SAAS,MAAM;AAAA,MAClB;AAAA,MACA;AAAA,MACA,MAAM;AAAA,MACN,CAAC,UAAU;AACT,YAAI,UAAU,mBAAmB,cAAc;AAC7C,kBAAQ,KAAK,mDAAmD;AAAA,QAClE;AAAA,MACF;AAAA,IACF;AAEA,UAAM,KAAK,OAAO,QAAQ;AAG1B,SAAK,OAAO,GAAG,oBAAoB,CAAC,SAAS;AAC3C,UAAI,8CAA8C,KAAK,UAAU,IAAI,CAAC;AAAA,IACxE,CAAC;AACD,SAAK,OAAO,GAAG,uBAAuB,CAAC,EAAE,GAAG,MAAM;AAChD,UAAI,iDAAiD,EAAE;AACvD,WAAK,gBAAgB,OAAO,EAAE;AAAA,IAChC,CAAC;AAGD,SAAK,OAAO,GAAG,kBAAkB,CAAC,EAAE,IAAI,QAAQ,MAAM;AACpD,UAAI;AACJ,UAAI;AACF,iBAAS,KAAK,MAAM,OAAO;AAAA,MAC7B,QAAQ;AACN;AAAA,MACF;AAEA;AAAA,QACE,gDAAgD,EAAE,YAAY,OAAO,MAAM,QAAS,OAAO,QAA6B,GAAG,iBAAkB,OAAO,QAAgC,MAAM;AAAA,MAC5L;AAEA,UACE,OAAO,WAAW,aAClB,OAAO,QAAQ,QAAQ,cACvB,OAAO,QAAQ,WAAW,mBAC1B;AACA;AAAA,MACF;AAGA,WAAK,gBAAgB,IAAI,EAAE;AAE3B,YAAM,UAAU,OAAO,OAAO;AAG9B,iBAAW,YAAY,KAAK,WAAW;AACrC,iBAAS,OAAO;AAAA,MAClB;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAsCA,MAAM,QAAuB;AAC3B,SAAK,UAAU,MAAM;AACrB,SAAK,gBAAgB,MAAM;AAC3B,SAAK,QAAQ,MAAM;AACnB,SAAK,SAAS;AAKd,UAAM,YAAY,KAAK,SAAS,QAAQ;AACxC,QAAI,cAAc,MAAM;AACtB,UAAI;AACF,gBAAQ,KAAK,SAAS;AACtB,YAAI,oDAAoD;AAAA,MAC1D,QAAQ;AAAA,MAER;AAAA,IACF;AAAA,EACF;AACF;","names":[]}
|
|
1
|
+
{"version":3,"sources":["../../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/devtools/client/flipper/src/transport.ts"],"sourcesContent":["import {\n createFlipperServer,\n FlipperServerState,\n type FlipperServer,\n} from \"flipper-server-client\";\nimport type { InstalledPluginDetails } from \"flipper-common\";\nimport { spawn } from \"child_process\";\nimport open from \"open\";\nimport * as net from \"net\";\nimport * as fs from \"fs\";\nimport * as os from \"os\";\nimport * as path from \"path\";\nimport { WebSocket as WsWebSocket } from \"ws\";\nimport type {\n CommunicationLayerMethods,\n ExtensionSupportedEvents,\n MessengerEvent,\n TransactionMetadata,\n Transport,\n} from \"@player-devtools/types\";\n\n// polyfill WebSocket for Node < 22\nif (typeof (globalThis as { WebSocket?: unknown }).WebSocket === \"undefined\") {\n (globalThis as { WebSocket?: unknown }).WebSocket =\n WsWebSocket as unknown as typeof WebSocket;\n}\n\ntype MessageCallback = (\n message: TransactionMetadata & MessengerEvent<ExtensionSupportedEvents>,\n) => void;\n\nconst PLUGIN_API = \"player-ui-devtools\";\nconst PLUGIN_NPM_NAME = \"flipper-plugin-player-ui-devtools\";\n\n/**\n * All diagnostics go to stderr.\n *\n * This transport runs inside the MCP server process, where stdout is the\n * JSON-RPC channel — every byte written there must be a newline-delimited\n * JSON-RPC message. `console.log` and `console.debug` both write to stdout in\n * Node, so they would corrupt the protocol stream.\n */\nconst log = (...args: Array<unknown>): void => {\n console.error(...args);\n};\n\n/** Shape of a Flipper `client-message` payload after JSON.parse */\ntype FlipperExecuteMessage = {\n method: \"execute\";\n params: {\n api: string;\n method: string;\n params?: unknown;\n };\n};\n\n/** Wire shape of the `init`/`deinit` plugin-activation handshake (`js-flipper`'s `FlipperClient.onMessageReceived`) */\ntype FlipperPluginLifecycleMessage = {\n method: \"init\" | \"deinit\";\n params: { plugin: string };\n};\n\n/**\n * Flipper headless transport\n *\n * Connects to a running `flipper-server` process and routes messages for the\n * \"flipper-plugin-player-ui-devtools\" plugin through to the Messenger layer.\n */\n/** Wait until a TCP port is accepting connections, polling every 500ms */\nfunction waitForPort(\n host: string,\n port: number,\n timeoutMs = 30_000,\n): Promise<void> {\n return new Promise((resolve, reject) => {\n const deadline = Date.now() + timeoutMs;\n const attempt = () => {\n const socket = net.connect(port, host);\n socket.once(\"connect\", () => {\n socket.destroy();\n resolve();\n });\n socket.once(\"error\", () => {\n socket.destroy();\n if (Date.now() >= deadline) {\n reject(new Error(`Timed out waiting for ${host}:${port}`));\n } else {\n setTimeout(attempt, 500);\n }\n });\n };\n attempt();\n });\n}\n\n/**\n * Cross-process refcount for the shared `flipper-server` daemon.\n *\n * Many MCP server processes (one per project/user registration) attach to a\n * single `flipper-server` on a fixed port. No in-process variable can\n * coordinate their lifecycles, so we track liveness in a small file guarded by\n * an atomic lock directory:\n *\n * - The first attach starts the daemon and records its PID with `refs: 1`.\n * - Each subsequent attach increments `refs`.\n * - Each detach decrements `refs`; the last one out shuts the daemon down.\n *\n * The lock directory (`mkdir` is atomic across processes) serializes the\n * read-modify-write so concurrently-starting instances don't race.\n */\ntype RefcountFile = { pid: number; refs: number };\n\nclass FlipperRefcount {\n private readonly dir = path.join(os.tmpdir(), \"player-devtools-mcp\");\n private readonly file = path.join(this.dir, \"flipper-server.refcount\");\n private readonly lock = path.join(this.dir, \"flipper-server.lock\");\n\n /** Acquire the cross-process lock, run `fn`, then release — even on throw. */\n private withLock<T>(fn: () => T): T {\n fs.mkdirSync(this.dir, { recursive: true });\n const deadline = Date.now() + 5_000;\n // Spin on an atomic mkdir until we own the lock or time out.\n for (;;) {\n try {\n fs.mkdirSync(this.lock);\n break;\n } catch (err) {\n if ((err as NodeJS.ErrnoException).code !== \"EEXIST\") throw err;\n if (Date.now() >= deadline) {\n // Stale lock from a crashed process — reclaim it.\n try {\n fs.rmdirSync(this.lock);\n } catch {\n /* another instance won the reclaim; retry */\n }\n }\n }\n }\n try {\n return fn();\n } finally {\n try {\n fs.rmdirSync(this.lock);\n } catch {\n /* already gone */\n }\n }\n }\n\n private read(): RefcountFile | null {\n try {\n return JSON.parse(fs.readFileSync(this.file, \"utf8\")) as RefcountFile;\n } catch {\n return null;\n }\n }\n\n private write(state: RefcountFile): void {\n fs.writeFileSync(this.file, JSON.stringify(state));\n }\n\n private clear(): void {\n try {\n fs.unlinkSync(this.file);\n } catch {\n /* already gone */\n }\n }\n\n /** Is the recorded daemon PID still alive? */\n private isAlive(pid: number): boolean {\n try {\n process.kill(pid, 0);\n return true;\n } catch {\n return false;\n }\n }\n\n /**\n * Register interest in the daemon. Returns whether this caller is the one\n * responsible for starting it (because no live daemon was recorded).\n * `recordPid` is called with the started PID once the daemon is up.\n */\n acquire(): { shouldStart: boolean; commit: (pid: number) => void } {\n return this.withLock(() => {\n const state = this.read();\n if (state && this.isAlive(state.pid)) {\n this.write({ pid: state.pid, refs: state.refs + 1 });\n return { shouldStart: false, commit: () => {} };\n }\n // No live daemon — this caller will start one and record its PID.\n return {\n shouldStart: true,\n commit: (pid: number) =>\n this.withLock(() => this.write({ pid, refs: 1 })),\n };\n });\n }\n\n /**\n * Drop this caller's interest. Returns the PID to kill if this was the last\n * reference, otherwise null.\n */\n release(): number | null {\n return this.withLock(() => {\n const state = this.read();\n if (!state) return null;\n if (state.refs <= 1) {\n this.clear();\n return state.pid;\n }\n this.write({ pid: state.pid, refs: state.refs - 1 });\n return null;\n });\n }\n}\n\nexport class FlipperServerTransport implements Transport {\n private server: FlipperServer | null = null;\n private refcount = new FlipperRefcount();\n private listeners = new Set<MessageCallback>();\n\n /**\n * Client IDs that have sent at least one message through the devtools\n * plugin — these are the clients we send outbound messages to.\n */\n private activeClientIds = new Set<string>();\n\n /**\n * Client IDs currently connected to flipper-server, regardless of whether\n * the devtools plugin has been activated for them. Used by `enablePlugin`'s\n * \"all connected clients\" convenience.\n */\n private connectedClientIds = new Set<string>();\n\n constructor(\n private options: {\n /** Flipper server host; defaults to \"localhost\" */\n host?: string;\n /** Flipper server WebSocket port; defaults to 52342 */\n port?: number;\n /**\n * Whether to open a browser/PWA UI once the server is up. Defaults to\n * `false` — an agent driving this transport has no use for a browser\n * tab, unlike a human running `flipper-server` directly.\n */\n open?: boolean;\n /**\n * URL to open in the browser when `open` is true. Defaults to\n * `http://localhost:{port}`. `flipper-server` itself always binds to\n * localhost regardless of this value — this only controls what URL\n * gets opened, so a custom host (e.g. a branded domain) must already\n * resolve to this machine (e.g. via `/etc/hosts`) for it to work.\n */\n url?: string;\n /**\n * Activate the devtools plugin automatically for every client that\n * connects, instead of requiring an explicit `enablePlugin()` call per\n * client. Off by default so a caller can choose when/whether to\n * activate a given device; turn this on for a fully hands-off session\n * where every connecting device should be watched immediately.\n */\n autoEnablePlugin?: boolean;\n } = {},\n ) {}\n\n async connect(): Promise<void> {\n const host = this.options.host ?? \"localhost\";\n const port = this.options.port ?? 52342;\n\n // Register interest in the shared daemon. The first instance to do so is\n // told to start it; the rest just attach. The daemon outlives any single\n // MCP process and is only torn down when the last instance detaches.\n const { shouldStart, commit } = this.refcount.acquire();\n\n if (shouldStart) {\n log(\"[FlipperServerTransport] Starting flipper-server...\");\n const serverScript = require.resolve(\"flipper-server/server.js\");\n // We always pass --open=false and drive any browser-open ourselves\n // (below) so we control both whether it happens and what URL is used —\n // flipper-server's own --open only ever opens http://localhost:{port}.\n\n // Detached + unref'd: the daemon must survive this process exiting so\n // other instances keep their connections. We never kill it directly —\n // shutdown is driven by the refcount in close().\n //\n // The daemon must never inherit our fd 1: it outlives this process and\n // would write into a later session's JSON-RPC stream. Its stderr stays\n // inherited so daemon diagnostics remain visible.\n const child = spawn(\n process.execPath,\n [serverScript, \"--open=false\", `--port=${port}`],\n {\n stdio: [\"ignore\", \"ignore\", \"inherit\"],\n detached: true,\n },\n );\n child.on(\"error\", (err: Error) => {\n console.error(\n \"[FlipperServerTransport] flipper-server process error:\",\n err,\n );\n });\n child.unref();\n await waitForPort(host, port);\n commit(child.pid!);\n log(\"[FlipperServerTransport] flipper-server ready.\");\n } else {\n // Daemon already running (started by another instance) — wait for it to\n // accept connections in case it's still coming up, then attach.\n await waitForPort(host, port);\n log(\"[FlipperServerTransport] Attached to flipper-server.\");\n }\n\n if (this.options.open) {\n const url = this.options.url ?? `http://localhost:${port}`;\n log(`[FlipperServerTransport] Opening ${url}`);\n try {\n await open(url);\n } catch (err) {\n console.warn(\"[FlipperServerTransport] Failed to open UI:\", err);\n }\n }\n\n // Read the auth token the flipper-server wrote during startup\n const { getAuthToken } =\n // eslint-disable-next-line @typescript-eslint/no-require-imports\n require(\"flipper-server/lib/app-connectivity/certificate-exchange/certificate-utils\") as {\n getAuthToken: () => Promise<string>;\n };\n\n let cachedToken: string | null = null;\n try {\n cachedToken = await getAuthToken();\n } catch (err) {\n console.warn(\"[FlipperServerTransport] Could not read auth token:\", err);\n }\n\n this.server = await createFlipperServer(\n host,\n port,\n () => cachedToken,\n (state) => {\n if (state === FlipperServerState.DISCONNECTED) {\n console.warn(\"[FlipperServerTransport] Disconnected from server\");\n }\n },\n );\n\n await this.server.connect();\n\n // Track client connects/disconnects\n this.server.on(\"client-connected\", (info) => {\n log(\"[FlipperServerTransport] client-connected:\", JSON.stringify(info));\n this.connectedClientIds.add(info.id);\n if (this.options.autoEnablePlugin) {\n this.enablePlugin(info.id).catch((err) => {\n console.warn(\n `[FlipperServerTransport] Failed to auto-enable plugin for client ${info.id}:`,\n err,\n );\n });\n }\n });\n this.server.on(\"client-disconnected\", ({ id }) => {\n log(\"[FlipperServerTransport] client-disconnected:\", id);\n this.activeClientIds.delete(id);\n this.connectedClientIds.delete(id);\n });\n\n // Route inbound device messages to our Messenger listeners\n this.server.on(\"client-message\", ({ id, message }) => {\n let parsed: FlipperExecuteMessage;\n try {\n parsed = JSON.parse(message) as FlipperExecuteMessage;\n } catch {\n return;\n }\n\n log(\n `[FlipperServerTransport] client-message from ${id}: method=${parsed.method} api=${(parsed.params as { api?: string })?.api} pluginMethod=${(parsed.params as { method?: string })?.method}`,\n );\n\n if (\n parsed.method !== \"execute\" ||\n parsed.params?.api !== PLUGIN_API ||\n parsed.params?.method !== \"message::plugin\"\n ) {\n return;\n }\n\n // This client is talking through the devtools plugin — remember it\n this.activeClientIds.add(id);\n\n const payload = parsed.params.params as TransactionMetadata &\n MessengerEvent<ExtensionSupportedEvents>;\n\n for (const listener of this.listeners) {\n listener(payload);\n }\n });\n }\n\n sendMessage: CommunicationLayerMethods[\"sendMessage\"] = async (message) => {\n if (!this.server) return;\n\n const payload: FlipperExecuteMessage = {\n method: \"execute\",\n params: {\n api: PLUGIN_API,\n method: \"message::flipper\",\n params: message,\n },\n };\n\n await Promise.all(\n [...this.activeClientIds].map((clientId) =>\n this.server!.exec(\"client-request-response\", clientId, payload).catch(\n (err) => {\n console.warn(\n `[FlipperServerTransport] Failed to send to client ${clientId}:`,\n err,\n );\n // Remove dead client so we stop trying\n this.activeClientIds.delete(clientId);\n },\n ),\n ),\n );\n };\n\n /**\n * Ensures `flipper-plugin-player-ui-devtools` is installed on the attached\n * flipper-server, installing the published npm package if it's missing.\n *\n * This is Flipper's own documented plugin-install RPC (the same\n * `exec(...)` commands the desktop UI's \"Install Plugin\" button calls) —\n * not a filesystem workaround. It's opt-in: callers that manage plugin\n * installation themselves (or run against a flipper-server that already\n * has it) can skip calling this.\n */\n async ensurePluginInstalled(): Promise<InstalledPluginDetails> {\n if (!this.server) {\n throw new Error(\"FlipperServerTransport is not connected\");\n }\n\n const installed = await this.server.exec(\"plugins-get-installed-plugins\");\n const existing = installed.find((p) => p.name === PLUGIN_NPM_NAME);\n if (existing) {\n log(\n `[FlipperServerTransport] ${PLUGIN_NPM_NAME}@${existing.version} already installed.`,\n );\n return existing;\n }\n\n log(`[FlipperServerTransport] Installing ${PLUGIN_NPM_NAME} from npm...`);\n const details = await this.server.exec(\n \"plugins-install-from-npm\",\n PLUGIN_NPM_NAME,\n );\n log(\n `[FlipperServerTransport] Installed ${PLUGIN_NPM_NAME}@${details.version}.`,\n );\n return details;\n }\n\n /**\n * Activates the devtools plugin for a connected client by sending the\n * `init` handshake `js-flipper`'s device SDK requires before it will open\n * a live plugin connection (`onConnect`/`FlipperConnection`) and start\n * relaying `client-message`s for our api. Nothing in flipper-server itself\n * sends this automatically for a non-background plugin like ours unless a\n * full Flipper desktop app is attached and its tab is selected — this\n * method lets a caller trigger the same handshake directly, without\n * needing a desktop UI at all.\n *\n * Calls `ensurePluginInstalled()` first, every time — the plugin can be\n * installed/removed on the attached flipper-server independently of this\n * transport (e.g. a human using the desktop UI concurrently), so there's\n * no snapshot of \"already installed\" we can trust across calls.\n *\n * Pass a specific `clientId`, or omit it to enable for every client\n * currently connected to flipper-server that we don't already believe is\n * active (see `activeClientIds`) — `init` is otherwise harmless to repeat,\n * but there's no reason to re-send it to a client already talking to us.\n */\n async enablePlugin(clientId?: string): Promise<void> {\n await this.ensurePluginInstalled();\n const targets = clientId\n ? [clientId]\n : [...this.connectedClientIds].filter(\n (id) => !this.activeClientIds.has(id),\n );\n await this.sendLifecycleMessage(\"init\", targets);\n }\n\n /**\n * Symmetric counterpart to `enablePlugin` — releases the plugin connection\n * without disconnecting the client from flipper-server.\n *\n * Pass a specific `clientId`, or omit it to disable for every client we\n * currently believe is active (see `activeClientIds`) — there's nothing to\n * release for a client that was never activated.\n */\n async disablePlugin(clientId?: string): Promise<void> {\n const targets = clientId ? [clientId] : [...this.activeClientIds];\n await this.sendLifecycleMessage(\"deinit\", targets);\n }\n\n private async sendLifecycleMessage(\n method: \"init\" | \"deinit\",\n targets: Array<string>,\n ): Promise<void> {\n if (!this.server) {\n throw new Error(\"FlipperServerTransport is not connected\");\n }\n\n const payload: FlipperPluginLifecycleMessage = {\n method,\n params: { plugin: PLUGIN_API },\n };\n\n await Promise.all(\n targets.map((id) =>\n this.server!.exec(\"client-request-response\", id, payload).catch(\n (err) => {\n console.warn(\n `[FlipperServerTransport] Failed to ${method} plugin for client ${id}:`,\n err,\n );\n },\n ),\n ),\n );\n }\n\n addListener: CommunicationLayerMethods[\"addListener\"] = (callback) => {\n this.listeners.add(callback);\n };\n\n removeListener: CommunicationLayerMethods[\"removeListener\"] = (callback) => {\n this.listeners.delete(callback);\n };\n\n async close(): Promise<void> {\n this.listeners.clear();\n this.activeClientIds.clear();\n this.connectedClientIds.clear();\n this.server?.close();\n this.server = null;\n\n // Drop our reference to the shared daemon. If we were the last user, the\n // refcount hands back its PID and we shut it down; otherwise it keeps\n // running for the remaining instances.\n const pidToKill = this.refcount.release();\n if (pidToKill !== null) {\n try {\n process.kill(pidToKill);\n log(\"[FlipperServerTransport] Shut down flipper-server.\");\n } catch {\n /* already gone */\n }\n }\n }\n}\n"],"mappings":";;;;;;;;AAAA;AAAA,EACE;AAAA,EACA;AAAA,OAEK;AAEP,SAAS,aAAa;AACtB,OAAO,UAAU;AACjB,YAAY,SAAS;AACrB,YAAY,QAAQ;AACpB,YAAY,QAAQ;AACpB,YAAY,UAAU;AACtB,SAAS,aAAa,mBAAmB;AAUzC,IAAI,OAAQ,WAAuC,cAAc,aAAa;AAC5E,EAAC,WAAuC,YACtC;AACJ;AAMA,IAAM,aAAa;AACnB,IAAM,kBAAkB;AAUxB,IAAM,MAAM,IAAI,SAA+B;AAC7C,UAAQ,MAAM,GAAG,IAAI;AACvB;AAyBA,SAAS,YACP,MACA,MACA,YAAY,KACG;AACf,SAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,UAAM,WAAW,KAAK,IAAI,IAAI;AAC9B,UAAM,UAAU,MAAM;AACpB,YAAM,SAAa,YAAQ,MAAM,IAAI;AACrC,aAAO,KAAK,WAAW,MAAM;AAC3B,eAAO,QAAQ;AACf,gBAAQ;AAAA,MACV,CAAC;AACD,aAAO,KAAK,SAAS,MAAM;AACzB,eAAO,QAAQ;AACf,YAAI,KAAK,IAAI,KAAK,UAAU;AAC1B,iBAAO,IAAI,MAAM,yBAAyB,IAAI,IAAI,IAAI,EAAE,CAAC;AAAA,QAC3D,OAAO;AACL,qBAAW,SAAS,GAAG;AAAA,QACzB;AAAA,MACF,CAAC;AAAA,IACH;AACA,YAAQ;AAAA,EACV,CAAC;AACH;AAmBA,IAAM,kBAAN,MAAsB;AAAA,EAAtB;AACE,SAAiB,MAAW,UAAQ,UAAO,GAAG,qBAAqB;AACnE,SAAiB,OAAY,UAAK,KAAK,KAAK,yBAAyB;AACrE,SAAiB,OAAY,UAAK,KAAK,KAAK,qBAAqB;AAAA;AAAA;AAAA,EAGzD,SAAY,IAAgB;AAClC,IAAG,aAAU,KAAK,KAAK,EAAE,WAAW,KAAK,CAAC;AAC1C,UAAM,WAAW,KAAK,IAAI,IAAI;AAE9B,eAAS;AACP,UAAI;AACF,QAAG,aAAU,KAAK,IAAI;AACtB;AAAA,MACF,SAAS,KAAK;AACZ,YAAK,IAA8B,SAAS,SAAU,OAAM;AAC5D,YAAI,KAAK,IAAI,KAAK,UAAU;AAE1B,cAAI;AACF,YAAG,aAAU,KAAK,IAAI;AAAA,UACxB,QAAQ;AAAA,UAER;AAAA,QACF;AAAA,MACF;AAAA,IACF;AACA,QAAI;AACF,aAAO,GAAG;AAAA,IACZ,UAAE;AACA,UAAI;AACF,QAAG,aAAU,KAAK,IAAI;AAAA,MACxB,QAAQ;AAAA,MAER;AAAA,IACF;AAAA,EACF;AAAA,EAEQ,OAA4B;AAClC,QAAI;AACF,aAAO,KAAK,MAAS,gBAAa,KAAK,MAAM,MAAM,CAAC;AAAA,IACtD,QAAQ;AACN,aAAO;AAAA,IACT;AAAA,EACF;AAAA,EAEQ,MAAM,OAA2B;AACvC,IAAG,iBAAc,KAAK,MAAM,KAAK,UAAU,KAAK,CAAC;AAAA,EACnD;AAAA,EAEQ,QAAc;AACpB,QAAI;AACF,MAAG,cAAW,KAAK,IAAI;AAAA,IACzB,QAAQ;AAAA,IAER;AAAA,EACF;AAAA;AAAA,EAGQ,QAAQ,KAAsB;AACpC,QAAI;AACF,cAAQ,KAAK,KAAK,CAAC;AACnB,aAAO;AAAA,IACT,QAAQ;AACN,aAAO;AAAA,IACT;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,UAAmE;AACjE,WAAO,KAAK,SAAS,MAAM;AACzB,YAAM,QAAQ,KAAK,KAAK;AACxB,UAAI,SAAS,KAAK,QAAQ,MAAM,GAAG,GAAG;AACpC,aAAK,MAAM,EAAE,KAAK,MAAM,KAAK,MAAM,MAAM,OAAO,EAAE,CAAC;AACnD,eAAO,EAAE,aAAa,OAAO,QAAQ,MAAM;AAAA,QAAC,EAAE;AAAA,MAChD;AAEA,aAAO;AAAA,QACL,aAAa;AAAA,QACb,QAAQ,CAAC,QACP,KAAK,SAAS,MAAM,KAAK,MAAM,EAAE,KAAK,MAAM,EAAE,CAAC,CAAC;AAAA,MACpD;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,UAAyB;AACvB,WAAO,KAAK,SAAS,MAAM;AACzB,YAAM,QAAQ,KAAK,KAAK;AACxB,UAAI,CAAC,MAAO,QAAO;AACnB,UAAI,MAAM,QAAQ,GAAG;AACnB,aAAK,MAAM;AACX,eAAO,MAAM;AAAA,MACf;AACA,WAAK,MAAM,EAAE,KAAK,MAAM,KAAK,MAAM,MAAM,OAAO,EAAE,CAAC;AACnD,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AACF;AAEO,IAAM,yBAAN,MAAkD;AAAA,EAkBvD,YACU,UA2BJ,CAAC,GACL;AA5BQ;AAlBV,SAAQ,SAA+B;AACvC,SAAQ,WAAW,IAAI,gBAAgB;AACvC,SAAQ,YAAY,oBAAI,IAAqB;AAM7C;AAAA;AAAA;AAAA;AAAA,SAAQ,kBAAkB,oBAAI,IAAY;AAO1C;AAAA;AAAA;AAAA;AAAA;AAAA,SAAQ,qBAAqB,oBAAI,IAAY;AA0K7C,uBAAwD,OAAO,YAAY;AACzE,UAAI,CAAC,KAAK,OAAQ;AAElB,YAAM,UAAiC;AAAA,QACrC,QAAQ;AAAA,QACR,QAAQ;AAAA,UACN,KAAK;AAAA,UACL,QAAQ;AAAA,UACR,QAAQ;AAAA,QACV;AAAA,MACF;AAEA,YAAM,QAAQ;AAAA,QACZ,CAAC,GAAG,KAAK,eAAe,EAAE;AAAA,UAAI,CAAC,aAC7B,KAAK,OAAQ,KAAK,2BAA2B,UAAU,OAAO,EAAE;AAAA,YAC9D,CAAC,QAAQ;AACP,sBAAQ;AAAA,gBACN,qDAAqD,QAAQ;AAAA,gBAC7D;AAAA,cACF;AAEA,mBAAK,gBAAgB,OAAO,QAAQ;AAAA,YACtC;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AA2GA,uBAAwD,CAAC,aAAa;AACpE,WAAK,UAAU,IAAI,QAAQ;AAAA,IAC7B;AAEA,0BAA8D,CAAC,aAAa;AAC1E,WAAK,UAAU,OAAO,QAAQ;AAAA,IAChC;AAAA,EAtRG;AAAA,EAEH,MAAM,UAAyB;AAC7B,UAAM,OAAO,KAAK,QAAQ,QAAQ;AAClC,UAAM,OAAO,KAAK,QAAQ,QAAQ;AAKlC,UAAM,EAAE,aAAa,OAAO,IAAI,KAAK,SAAS,QAAQ;AAEtD,QAAI,aAAa;AACf,UAAI,qDAAqD;AACzD,YAAM,eAAe,UAAQ,QAAQ,0BAA0B;AAY/D,YAAM,QAAQ;AAAA,QACZ,QAAQ;AAAA,QACR,CAAC,cAAc,gBAAgB,UAAU,IAAI,EAAE;AAAA,QAC/C;AAAA,UACE,OAAO,CAAC,UAAU,UAAU,SAAS;AAAA,UACrC,UAAU;AAAA,QACZ;AAAA,MACF;AACA,YAAM,GAAG,SAAS,CAAC,QAAe;AAChC,gBAAQ;AAAA,UACN;AAAA,UACA;AAAA,QACF;AAAA,MACF,CAAC;AACD,YAAM,MAAM;AACZ,YAAM,YAAY,MAAM,IAAI;AAC5B,aAAO,MAAM,GAAI;AACjB,UAAI,gDAAgD;AAAA,IACtD,OAAO;AAGL,YAAM,YAAY,MAAM,IAAI;AAC5B,UAAI,sDAAsD;AAAA,IAC5D;AAEA,QAAI,KAAK,QAAQ,MAAM;AACrB,YAAM,MAAM,KAAK,QAAQ,OAAO,oBAAoB,IAAI;AACxD,UAAI,oCAAoC,GAAG,EAAE;AAC7C,UAAI;AACF,cAAM,KAAK,GAAG;AAAA,MAChB,SAAS,KAAK;AACZ,gBAAQ,KAAK,+CAA+C,GAAG;AAAA,MACjE;AAAA,IACF;AAGA,UAAM,EAAE,aAAa;AAAA;AAAA,MAEnB,UAAQ,4EAA4E;AAAA;AAItF,QAAI,cAA6B;AACjC,QAAI;AACF,oBAAc,MAAM,aAAa;AAAA,IACnC,SAAS,KAAK;AACZ,cAAQ,KAAK,uDAAuD,GAAG;AAAA,IACzE;AAEA,SAAK,SAAS,MAAM;AAAA,MAClB;AAAA,MACA;AAAA,MACA,MAAM;AAAA,MACN,CAAC,UAAU;AACT,YAAI,UAAU,mBAAmB,cAAc;AAC7C,kBAAQ,KAAK,mDAAmD;AAAA,QAClE;AAAA,MACF;AAAA,IACF;AAEA,UAAM,KAAK,OAAO,QAAQ;AAG1B,SAAK,OAAO,GAAG,oBAAoB,CAAC,SAAS;AAC3C,UAAI,8CAA8C,KAAK,UAAU,IAAI,CAAC;AACtE,WAAK,mBAAmB,IAAI,KAAK,EAAE;AACnC,UAAI,KAAK,QAAQ,kBAAkB;AACjC,aAAK,aAAa,KAAK,EAAE,EAAE,MAAM,CAAC,QAAQ;AACxC,kBAAQ;AAAA,YACN,oEAAoE,KAAK,EAAE;AAAA,YAC3E;AAAA,UACF;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF,CAAC;AACD,SAAK,OAAO,GAAG,uBAAuB,CAAC,EAAE,GAAG,MAAM;AAChD,UAAI,iDAAiD,EAAE;AACvD,WAAK,gBAAgB,OAAO,EAAE;AAC9B,WAAK,mBAAmB,OAAO,EAAE;AAAA,IACnC,CAAC;AAGD,SAAK,OAAO,GAAG,kBAAkB,CAAC,EAAE,IAAI,QAAQ,MAAM;AACpD,UAAI;AACJ,UAAI;AACF,iBAAS,KAAK,MAAM,OAAO;AAAA,MAC7B,QAAQ;AACN;AAAA,MACF;AAEA;AAAA,QACE,gDAAgD,EAAE,YAAY,OAAO,MAAM,QAAS,OAAO,QAA6B,GAAG,iBAAkB,OAAO,QAAgC,MAAM;AAAA,MAC5L;AAEA,UACE,OAAO,WAAW,aAClB,OAAO,QAAQ,QAAQ,cACvB,OAAO,QAAQ,WAAW,mBAC1B;AACA;AAAA,MACF;AAGA,WAAK,gBAAgB,IAAI,EAAE;AAE3B,YAAM,UAAU,OAAO,OAAO;AAG9B,iBAAW,YAAY,KAAK,WAAW;AACrC,iBAAS,OAAO;AAAA,MAClB;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAwCA,MAAM,wBAAyD;AAC7D,QAAI,CAAC,KAAK,QAAQ;AAChB,YAAM,IAAI,MAAM,yCAAyC;AAAA,IAC3D;AAEA,UAAM,YAAY,MAAM,KAAK,OAAO,KAAK,+BAA+B;AACxE,UAAM,WAAW,UAAU,KAAK,CAAC,MAAM,EAAE,SAAS,eAAe;AACjE,QAAI,UAAU;AACZ;AAAA,QACE,4BAA4B,eAAe,IAAI,SAAS,OAAO;AAAA,MACjE;AACA,aAAO;AAAA,IACT;AAEA,QAAI,uCAAuC,eAAe,cAAc;AACxE,UAAM,UAAU,MAAM,KAAK,OAAO;AAAA,MAChC;AAAA,MACA;AAAA,IACF;AACA;AAAA,MACE,sCAAsC,eAAe,IAAI,QAAQ,OAAO;AAAA,IAC1E;AACA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA,MAAM,aAAa,UAAkC;AACnD,UAAM,KAAK,sBAAsB;AACjC,UAAM,UAAU,WACZ,CAAC,QAAQ,IACT,CAAC,GAAG,KAAK,kBAAkB,EAAE;AAAA,MAC3B,CAAC,OAAO,CAAC,KAAK,gBAAgB,IAAI,EAAE;AAAA,IACtC;AACJ,UAAM,KAAK,qBAAqB,QAAQ,OAAO;AAAA,EACjD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,cAAc,UAAkC;AACpD,UAAM,UAAU,WAAW,CAAC,QAAQ,IAAI,CAAC,GAAG,KAAK,eAAe;AAChE,UAAM,KAAK,qBAAqB,UAAU,OAAO;AAAA,EACnD;AAAA,EAEA,MAAc,qBACZ,QACA,SACe;AACf,QAAI,CAAC,KAAK,QAAQ;AAChB,YAAM,IAAI,MAAM,yCAAyC;AAAA,IAC3D;AAEA,UAAM,UAAyC;AAAA,MAC7C;AAAA,MACA,QAAQ,EAAE,QAAQ,WAAW;AAAA,IAC/B;AAEA,UAAM,QAAQ;AAAA,MACZ,QAAQ;AAAA,QAAI,CAAC,OACX,KAAK,OAAQ,KAAK,2BAA2B,IAAI,OAAO,EAAE;AAAA,UACxD,CAAC,QAAQ;AACP,oBAAQ;AAAA,cACN,sCAAsC,MAAM,sBAAsB,EAAE;AAAA,cACpE;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAUA,MAAM,QAAuB;AAC3B,SAAK,UAAU,MAAM;AACrB,SAAK,gBAAgB,MAAM;AAC3B,SAAK,mBAAmB,MAAM;AAC9B,SAAK,QAAQ,MAAM;AACnB,SAAK,SAAS;AAKd,UAAM,YAAY,KAAK,SAAS,QAAQ;AACxC,QAAI,cAAc,MAAM;AACtB,UAAI;AACF,gBAAQ,KAAK,SAAS;AACtB,YAAI,oDAAoD;AAAA,MAC1D,QAAQ;AAAA,MAER;AAAA,IACF;AAAA,EACF;AACF;","names":[]}
|
package/package.json
CHANGED
|
@@ -6,13 +6,15 @@
|
|
|
6
6
|
"types"
|
|
7
7
|
],
|
|
8
8
|
"name": "@player-devtools/client-flipper",
|
|
9
|
-
"version": "0.15.
|
|
9
|
+
"version": "0.15.2-next.0",
|
|
10
10
|
"main": "dist/cjs/index.cjs",
|
|
11
11
|
"dependencies": {
|
|
12
|
-
"@player-devtools/types": "0.15.
|
|
12
|
+
"@player-devtools/types": "0.15.2-next.0",
|
|
13
13
|
"@types/ws": "^8.0.0",
|
|
14
|
+
"flipper-common": "^0.273.0",
|
|
14
15
|
"flipper-server": "^0.273.0",
|
|
15
16
|
"flipper-server-client": "^0.273.0",
|
|
17
|
+
"open": "^8.4.2",
|
|
16
18
|
"ws": "^8.0.0",
|
|
17
19
|
"tslib": "^2.6.2"
|
|
18
20
|
},
|
|
@@ -0,0 +1,266 @@
|
|
|
1
|
+
import { describe, it, expect, vi } from "vitest";
|
|
2
|
+
import type { FlipperServer } from "flipper-server-client";
|
|
3
|
+
import { FlipperServerTransport } from "../transport";
|
|
4
|
+
|
|
5
|
+
const INSTALLED = {
|
|
6
|
+
name: "flipper-plugin-player-ui-devtools",
|
|
7
|
+
version: "1.2.3",
|
|
8
|
+
};
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* A fake `FlipperServer` whose `exec` outcomes the test controls.
|
|
12
|
+
*
|
|
13
|
+
* `plugins-get-installed-plugins` resolves to `INSTALLED` by default (as if
|
|
14
|
+
* the plugin is already present) so tests unrelated to installation don't
|
|
15
|
+
* have to stub it; pass a custom `exec` to override that.
|
|
16
|
+
*/
|
|
17
|
+
function fakeFlipperServer(
|
|
18
|
+
exec: (method: string, ...args: Array<unknown>) => Promise<unknown> = async (
|
|
19
|
+
method,
|
|
20
|
+
) => {
|
|
21
|
+
if (method === "plugins-get-installed-plugins") return [INSTALLED];
|
|
22
|
+
return undefined;
|
|
23
|
+
},
|
|
24
|
+
): FlipperServer {
|
|
25
|
+
return { exec } as unknown as FlipperServer;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
/** Reaches into the transport's private fields to set up state without going through `connect()`. */
|
|
29
|
+
function attach(
|
|
30
|
+
transport: FlipperServerTransport,
|
|
31
|
+
server: FlipperServer,
|
|
32
|
+
{
|
|
33
|
+
connectedClientIds = [],
|
|
34
|
+
activeClientIds = [],
|
|
35
|
+
}: {
|
|
36
|
+
connectedClientIds?: Array<string>;
|
|
37
|
+
activeClientIds?: Array<string>;
|
|
38
|
+
} = {},
|
|
39
|
+
): void {
|
|
40
|
+
const t = transport as unknown as {
|
|
41
|
+
server: FlipperServer;
|
|
42
|
+
connectedClientIds: Set<string>;
|
|
43
|
+
activeClientIds: Set<string>;
|
|
44
|
+
};
|
|
45
|
+
t.server = server;
|
|
46
|
+
t.connectedClientIds = new Set(connectedClientIds);
|
|
47
|
+
t.activeClientIds = new Set(activeClientIds);
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
describe("FlipperServerTransport", () => {
|
|
51
|
+
describe("ensurePluginInstalled", () => {
|
|
52
|
+
it("returns the existing plugin without installing when already present", async () => {
|
|
53
|
+
const exec = vi.fn(async (method: string) => {
|
|
54
|
+
if (method === "plugins-get-installed-plugins") return [INSTALLED];
|
|
55
|
+
throw new Error(`unexpected exec: ${method}`);
|
|
56
|
+
});
|
|
57
|
+
const transport = new FlipperServerTransport();
|
|
58
|
+
attach(transport, fakeFlipperServer(exec));
|
|
59
|
+
|
|
60
|
+
await expect(transport.ensurePluginInstalled()).resolves.toBe(INSTALLED);
|
|
61
|
+
expect(exec).not.toHaveBeenCalledWith(
|
|
62
|
+
"plugins-install-from-npm",
|
|
63
|
+
expect.anything(),
|
|
64
|
+
);
|
|
65
|
+
});
|
|
66
|
+
|
|
67
|
+
it("installs from npm when the plugin is missing", async () => {
|
|
68
|
+
const installed = {
|
|
69
|
+
name: "flipper-plugin-player-ui-devtools",
|
|
70
|
+
version: "4.5.6",
|
|
71
|
+
};
|
|
72
|
+
const exec = vi.fn(async (method: string) => {
|
|
73
|
+
if (method === "plugins-get-installed-plugins") return [];
|
|
74
|
+
if (method === "plugins-install-from-npm") return installed;
|
|
75
|
+
throw new Error(`unexpected exec: ${method}`);
|
|
76
|
+
});
|
|
77
|
+
const transport = new FlipperServerTransport();
|
|
78
|
+
attach(transport, fakeFlipperServer(exec));
|
|
79
|
+
|
|
80
|
+
await expect(transport.ensurePluginInstalled()).resolves.toBe(installed);
|
|
81
|
+
expect(exec).toHaveBeenCalledWith(
|
|
82
|
+
"plugins-install-from-npm",
|
|
83
|
+
"flipper-plugin-player-ui-devtools",
|
|
84
|
+
);
|
|
85
|
+
});
|
|
86
|
+
|
|
87
|
+
it("rejects when not connected", async () => {
|
|
88
|
+
const transport = new FlipperServerTransport();
|
|
89
|
+
await expect(transport.ensurePluginInstalled()).rejects.toThrow(
|
|
90
|
+
"not connected",
|
|
91
|
+
);
|
|
92
|
+
});
|
|
93
|
+
});
|
|
94
|
+
|
|
95
|
+
describe("enablePlugin", () => {
|
|
96
|
+
it("ensures the plugin is installed before sending init", async () => {
|
|
97
|
+
const exec = vi.fn(async (method: string) => {
|
|
98
|
+
if (method === "plugins-get-installed-plugins") return [INSTALLED];
|
|
99
|
+
return undefined;
|
|
100
|
+
});
|
|
101
|
+
const transport = new FlipperServerTransport();
|
|
102
|
+
attach(transport, fakeFlipperServer(exec), { connectedClientIds: ["a"] });
|
|
103
|
+
|
|
104
|
+
await transport.enablePlugin("a");
|
|
105
|
+
|
|
106
|
+
const installCallOrder = exec.mock.invocationCallOrder[0];
|
|
107
|
+
const initCall = exec.mock.calls.findIndex(
|
|
108
|
+
(call) => call[0] === "client-request-response",
|
|
109
|
+
);
|
|
110
|
+
expect(installCallOrder).toBeLessThan(
|
|
111
|
+
exec.mock.invocationCallOrder[initCall],
|
|
112
|
+
);
|
|
113
|
+
expect(exec).toHaveBeenCalledWith("plugins-get-installed-plugins");
|
|
114
|
+
});
|
|
115
|
+
|
|
116
|
+
it("sends init to a single client id when one is given", async () => {
|
|
117
|
+
const exec = vi.fn(fakeFlipperServer().exec);
|
|
118
|
+
const transport = new FlipperServerTransport();
|
|
119
|
+
attach(transport, fakeFlipperServer(exec), {
|
|
120
|
+
connectedClientIds: ["a", "b"],
|
|
121
|
+
});
|
|
122
|
+
|
|
123
|
+
await transport.enablePlugin("a");
|
|
124
|
+
|
|
125
|
+
expect(exec).toHaveBeenCalledWith("client-request-response", "a", {
|
|
126
|
+
method: "init",
|
|
127
|
+
params: { plugin: "player-ui-devtools" },
|
|
128
|
+
});
|
|
129
|
+
expect(exec).not.toHaveBeenCalledWith(
|
|
130
|
+
"client-request-response",
|
|
131
|
+
"b",
|
|
132
|
+
expect.anything(),
|
|
133
|
+
);
|
|
134
|
+
});
|
|
135
|
+
|
|
136
|
+
it("sends init to every connected client that isn't already active when no id is given", async () => {
|
|
137
|
+
const exec = vi.fn(fakeFlipperServer().exec);
|
|
138
|
+
const transport = new FlipperServerTransport();
|
|
139
|
+
attach(transport, fakeFlipperServer(exec), {
|
|
140
|
+
connectedClientIds: ["a", "b", "c"],
|
|
141
|
+
activeClientIds: ["c"],
|
|
142
|
+
});
|
|
143
|
+
|
|
144
|
+
await transport.enablePlugin();
|
|
145
|
+
|
|
146
|
+
expect(exec).toHaveBeenCalledWith(
|
|
147
|
+
"client-request-response",
|
|
148
|
+
"a",
|
|
149
|
+
expect.objectContaining({ method: "init" }),
|
|
150
|
+
);
|
|
151
|
+
expect(exec).toHaveBeenCalledWith(
|
|
152
|
+
"client-request-response",
|
|
153
|
+
"b",
|
|
154
|
+
expect.objectContaining({ method: "init" }),
|
|
155
|
+
);
|
|
156
|
+
expect(exec).not.toHaveBeenCalledWith(
|
|
157
|
+
"client-request-response",
|
|
158
|
+
"c",
|
|
159
|
+
expect.anything(),
|
|
160
|
+
);
|
|
161
|
+
});
|
|
162
|
+
|
|
163
|
+
it("still sends init to an explicit client id even if already active", async () => {
|
|
164
|
+
const exec = vi.fn(fakeFlipperServer().exec);
|
|
165
|
+
const transport = new FlipperServerTransport();
|
|
166
|
+
attach(transport, fakeFlipperServer(exec), {
|
|
167
|
+
connectedClientIds: ["a"],
|
|
168
|
+
activeClientIds: ["a"],
|
|
169
|
+
});
|
|
170
|
+
|
|
171
|
+
await transport.enablePlugin("a");
|
|
172
|
+
|
|
173
|
+
expect(exec).toHaveBeenCalledWith(
|
|
174
|
+
"client-request-response",
|
|
175
|
+
"a",
|
|
176
|
+
expect.objectContaining({ method: "init" }),
|
|
177
|
+
);
|
|
178
|
+
});
|
|
179
|
+
|
|
180
|
+
it("swallows a per-client failure instead of rejecting the whole call", async () => {
|
|
181
|
+
vi.spyOn(console, "warn").mockImplementation(() => {});
|
|
182
|
+
const exec = vi.fn(async (method: string, id?: string) => {
|
|
183
|
+
if (method === "plugins-get-installed-plugins") return [INSTALLED];
|
|
184
|
+
if (id === "bad") throw new Error("boom");
|
|
185
|
+
return undefined;
|
|
186
|
+
});
|
|
187
|
+
const transport = new FlipperServerTransport();
|
|
188
|
+
attach(transport, fakeFlipperServer(exec), {
|
|
189
|
+
connectedClientIds: ["good", "bad"],
|
|
190
|
+
});
|
|
191
|
+
|
|
192
|
+
await expect(transport.enablePlugin()).resolves.toBeUndefined();
|
|
193
|
+
expect(exec).toHaveBeenCalledWith(
|
|
194
|
+
"client-request-response",
|
|
195
|
+
"good",
|
|
196
|
+
expect.anything(),
|
|
197
|
+
);
|
|
198
|
+
expect(exec).toHaveBeenCalledWith(
|
|
199
|
+
"client-request-response",
|
|
200
|
+
"bad",
|
|
201
|
+
expect.anything(),
|
|
202
|
+
);
|
|
203
|
+
});
|
|
204
|
+
|
|
205
|
+
it("rejects when not connected", async () => {
|
|
206
|
+
const transport = new FlipperServerTransport();
|
|
207
|
+
await expect(transport.enablePlugin()).rejects.toThrow("not connected");
|
|
208
|
+
});
|
|
209
|
+
});
|
|
210
|
+
|
|
211
|
+
describe("disablePlugin", () => {
|
|
212
|
+
it("sends deinit to a single client id when one is given", async () => {
|
|
213
|
+
const exec = vi.fn(fakeFlipperServer().exec);
|
|
214
|
+
const transport = new FlipperServerTransport();
|
|
215
|
+
attach(transport, fakeFlipperServer(exec), { activeClientIds: ["a"] });
|
|
216
|
+
|
|
217
|
+
await transport.disablePlugin("a");
|
|
218
|
+
|
|
219
|
+
expect(exec).toHaveBeenCalledWith(
|
|
220
|
+
"client-request-response",
|
|
221
|
+
"a",
|
|
222
|
+
expect.objectContaining({ method: "deinit" }),
|
|
223
|
+
);
|
|
224
|
+
});
|
|
225
|
+
|
|
226
|
+
it("sends deinit only to clients currently believed active when no id is given", async () => {
|
|
227
|
+
const exec = vi.fn(fakeFlipperServer().exec);
|
|
228
|
+
const transport = new FlipperServerTransport();
|
|
229
|
+
attach(transport, fakeFlipperServer(exec), {
|
|
230
|
+
connectedClientIds: ["a", "b"],
|
|
231
|
+
activeClientIds: ["a"],
|
|
232
|
+
});
|
|
233
|
+
|
|
234
|
+
await transport.disablePlugin();
|
|
235
|
+
|
|
236
|
+
expect(exec).toHaveBeenCalledWith(
|
|
237
|
+
"client-request-response",
|
|
238
|
+
"a",
|
|
239
|
+
expect.objectContaining({ method: "deinit" }),
|
|
240
|
+
);
|
|
241
|
+
expect(exec).not.toHaveBeenCalledWith(
|
|
242
|
+
"client-request-response",
|
|
243
|
+
"b",
|
|
244
|
+
expect.anything(),
|
|
245
|
+
);
|
|
246
|
+
});
|
|
247
|
+
|
|
248
|
+
it("does not call ensurePluginInstalled", async () => {
|
|
249
|
+
const exec = vi.fn(async (method: string) => {
|
|
250
|
+
if (method === "plugins-get-installed-plugins") {
|
|
251
|
+
throw new Error("should not be called");
|
|
252
|
+
}
|
|
253
|
+
return undefined;
|
|
254
|
+
});
|
|
255
|
+
const transport = new FlipperServerTransport();
|
|
256
|
+
attach(transport, fakeFlipperServer(exec), { activeClientIds: ["a"] });
|
|
257
|
+
|
|
258
|
+
await expect(transport.disablePlugin("a")).resolves.toBeUndefined();
|
|
259
|
+
});
|
|
260
|
+
|
|
261
|
+
it("rejects when not connected", async () => {
|
|
262
|
+
const transport = new FlipperServerTransport();
|
|
263
|
+
await expect(transport.disablePlugin()).rejects.toThrow("not connected");
|
|
264
|
+
});
|
|
265
|
+
});
|
|
266
|
+
});
|
package/src/transport.ts
CHANGED
|
@@ -3,7 +3,9 @@ import {
|
|
|
3
3
|
FlipperServerState,
|
|
4
4
|
type FlipperServer,
|
|
5
5
|
} from "flipper-server-client";
|
|
6
|
+
import type { InstalledPluginDetails } from "flipper-common";
|
|
6
7
|
import { spawn } from "child_process";
|
|
8
|
+
import open from "open";
|
|
7
9
|
import * as net from "net";
|
|
8
10
|
import * as fs from "fs";
|
|
9
11
|
import * as os from "os";
|
|
@@ -28,6 +30,7 @@ type MessageCallback = (
|
|
|
28
30
|
) => void;
|
|
29
31
|
|
|
30
32
|
const PLUGIN_API = "player-ui-devtools";
|
|
33
|
+
const PLUGIN_NPM_NAME = "flipper-plugin-player-ui-devtools";
|
|
31
34
|
|
|
32
35
|
/**
|
|
33
36
|
* All diagnostics go to stderr.
|
|
@@ -51,6 +54,12 @@ type FlipperExecuteMessage = {
|
|
|
51
54
|
};
|
|
52
55
|
};
|
|
53
56
|
|
|
57
|
+
/** Wire shape of the `init`/`deinit` plugin-activation handshake (`js-flipper`'s `FlipperClient.onMessageReceived`) */
|
|
58
|
+
type FlipperPluginLifecycleMessage = {
|
|
59
|
+
method: "init" | "deinit";
|
|
60
|
+
params: { plugin: string };
|
|
61
|
+
};
|
|
62
|
+
|
|
54
63
|
/**
|
|
55
64
|
* Flipper headless transport
|
|
56
65
|
*
|
|
@@ -218,12 +227,41 @@ export class FlipperServerTransport implements Transport {
|
|
|
218
227
|
*/
|
|
219
228
|
private activeClientIds = new Set<string>();
|
|
220
229
|
|
|
230
|
+
/**
|
|
231
|
+
* Client IDs currently connected to flipper-server, regardless of whether
|
|
232
|
+
* the devtools plugin has been activated for them. Used by `enablePlugin`'s
|
|
233
|
+
* "all connected clients" convenience.
|
|
234
|
+
*/
|
|
235
|
+
private connectedClientIds = new Set<string>();
|
|
236
|
+
|
|
221
237
|
constructor(
|
|
222
238
|
private options: {
|
|
223
239
|
/** Flipper server host; defaults to "localhost" */
|
|
224
240
|
host?: string;
|
|
225
241
|
/** Flipper server WebSocket port; defaults to 52342 */
|
|
226
242
|
port?: number;
|
|
243
|
+
/**
|
|
244
|
+
* Whether to open a browser/PWA UI once the server is up. Defaults to
|
|
245
|
+
* `false` — an agent driving this transport has no use for a browser
|
|
246
|
+
* tab, unlike a human running `flipper-server` directly.
|
|
247
|
+
*/
|
|
248
|
+
open?: boolean;
|
|
249
|
+
/**
|
|
250
|
+
* URL to open in the browser when `open` is true. Defaults to
|
|
251
|
+
* `http://localhost:{port}`. `flipper-server` itself always binds to
|
|
252
|
+
* localhost regardless of this value — this only controls what URL
|
|
253
|
+
* gets opened, so a custom host (e.g. a branded domain) must already
|
|
254
|
+
* resolve to this machine (e.g. via `/etc/hosts`) for it to work.
|
|
255
|
+
*/
|
|
256
|
+
url?: string;
|
|
257
|
+
/**
|
|
258
|
+
* Activate the devtools plugin automatically for every client that
|
|
259
|
+
* connects, instead of requiring an explicit `enablePlugin()` call per
|
|
260
|
+
* client. Off by default so a caller can choose when/whether to
|
|
261
|
+
* activate a given device; turn this on for a fully hands-off session
|
|
262
|
+
* where every connecting device should be watched immediately.
|
|
263
|
+
*/
|
|
264
|
+
autoEnablePlugin?: boolean;
|
|
227
265
|
} = {},
|
|
228
266
|
) {}
|
|
229
267
|
|
|
@@ -239,6 +277,10 @@ export class FlipperServerTransport implements Transport {
|
|
|
239
277
|
if (shouldStart) {
|
|
240
278
|
log("[FlipperServerTransport] Starting flipper-server...");
|
|
241
279
|
const serverScript = require.resolve("flipper-server/server.js");
|
|
280
|
+
// We always pass --open=false and drive any browser-open ourselves
|
|
281
|
+
// (below) so we control both whether it happens and what URL is used —
|
|
282
|
+
// flipper-server's own --open only ever opens http://localhost:{port}.
|
|
283
|
+
|
|
242
284
|
// Detached + unref'd: the daemon must survive this process exiting so
|
|
243
285
|
// other instances keep their connections. We never kill it directly —
|
|
244
286
|
// shutdown is driven by the refcount in close().
|
|
@@ -246,10 +288,14 @@ export class FlipperServerTransport implements Transport {
|
|
|
246
288
|
// The daemon must never inherit our fd 1: it outlives this process and
|
|
247
289
|
// would write into a later session's JSON-RPC stream. Its stderr stays
|
|
248
290
|
// inherited so daemon diagnostics remain visible.
|
|
249
|
-
const child = spawn(
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
291
|
+
const child = spawn(
|
|
292
|
+
process.execPath,
|
|
293
|
+
[serverScript, "--open=false", `--port=${port}`],
|
|
294
|
+
{
|
|
295
|
+
stdio: ["ignore", "ignore", "inherit"],
|
|
296
|
+
detached: true,
|
|
297
|
+
},
|
|
298
|
+
);
|
|
253
299
|
child.on("error", (err: Error) => {
|
|
254
300
|
console.error(
|
|
255
301
|
"[FlipperServerTransport] flipper-server process error:",
|
|
@@ -267,6 +313,16 @@ export class FlipperServerTransport implements Transport {
|
|
|
267
313
|
log("[FlipperServerTransport] Attached to flipper-server.");
|
|
268
314
|
}
|
|
269
315
|
|
|
316
|
+
if (this.options.open) {
|
|
317
|
+
const url = this.options.url ?? `http://localhost:${port}`;
|
|
318
|
+
log(`[FlipperServerTransport] Opening ${url}`);
|
|
319
|
+
try {
|
|
320
|
+
await open(url);
|
|
321
|
+
} catch (err) {
|
|
322
|
+
console.warn("[FlipperServerTransport] Failed to open UI:", err);
|
|
323
|
+
}
|
|
324
|
+
}
|
|
325
|
+
|
|
270
326
|
// Read the auth token the flipper-server wrote during startup
|
|
271
327
|
const { getAuthToken } =
|
|
272
328
|
// eslint-disable-next-line @typescript-eslint/no-require-imports
|
|
@@ -297,10 +353,20 @@ export class FlipperServerTransport implements Transport {
|
|
|
297
353
|
// Track client connects/disconnects
|
|
298
354
|
this.server.on("client-connected", (info) => {
|
|
299
355
|
log("[FlipperServerTransport] client-connected:", JSON.stringify(info));
|
|
356
|
+
this.connectedClientIds.add(info.id);
|
|
357
|
+
if (this.options.autoEnablePlugin) {
|
|
358
|
+
this.enablePlugin(info.id).catch((err) => {
|
|
359
|
+
console.warn(
|
|
360
|
+
`[FlipperServerTransport] Failed to auto-enable plugin for client ${info.id}:`,
|
|
361
|
+
err,
|
|
362
|
+
);
|
|
363
|
+
});
|
|
364
|
+
}
|
|
300
365
|
});
|
|
301
366
|
this.server.on("client-disconnected", ({ id }) => {
|
|
302
367
|
log("[FlipperServerTransport] client-disconnected:", id);
|
|
303
368
|
this.activeClientIds.delete(id);
|
|
369
|
+
this.connectedClientIds.delete(id);
|
|
304
370
|
});
|
|
305
371
|
|
|
306
372
|
// Route inbound device messages to our Messenger listeners
|
|
@@ -364,6 +430,111 @@ export class FlipperServerTransport implements Transport {
|
|
|
364
430
|
);
|
|
365
431
|
};
|
|
366
432
|
|
|
433
|
+
/**
|
|
434
|
+
* Ensures `flipper-plugin-player-ui-devtools` is installed on the attached
|
|
435
|
+
* flipper-server, installing the published npm package if it's missing.
|
|
436
|
+
*
|
|
437
|
+
* This is Flipper's own documented plugin-install RPC (the same
|
|
438
|
+
* `exec(...)` commands the desktop UI's "Install Plugin" button calls) —
|
|
439
|
+
* not a filesystem workaround. It's opt-in: callers that manage plugin
|
|
440
|
+
* installation themselves (or run against a flipper-server that already
|
|
441
|
+
* has it) can skip calling this.
|
|
442
|
+
*/
|
|
443
|
+
async ensurePluginInstalled(): Promise<InstalledPluginDetails> {
|
|
444
|
+
if (!this.server) {
|
|
445
|
+
throw new Error("FlipperServerTransport is not connected");
|
|
446
|
+
}
|
|
447
|
+
|
|
448
|
+
const installed = await this.server.exec("plugins-get-installed-plugins");
|
|
449
|
+
const existing = installed.find((p) => p.name === PLUGIN_NPM_NAME);
|
|
450
|
+
if (existing) {
|
|
451
|
+
log(
|
|
452
|
+
`[FlipperServerTransport] ${PLUGIN_NPM_NAME}@${existing.version} already installed.`,
|
|
453
|
+
);
|
|
454
|
+
return existing;
|
|
455
|
+
}
|
|
456
|
+
|
|
457
|
+
log(`[FlipperServerTransport] Installing ${PLUGIN_NPM_NAME} from npm...`);
|
|
458
|
+
const details = await this.server.exec(
|
|
459
|
+
"plugins-install-from-npm",
|
|
460
|
+
PLUGIN_NPM_NAME,
|
|
461
|
+
);
|
|
462
|
+
log(
|
|
463
|
+
`[FlipperServerTransport] Installed ${PLUGIN_NPM_NAME}@${details.version}.`,
|
|
464
|
+
);
|
|
465
|
+
return details;
|
|
466
|
+
}
|
|
467
|
+
|
|
468
|
+
/**
|
|
469
|
+
* Activates the devtools plugin for a connected client by sending the
|
|
470
|
+
* `init` handshake `js-flipper`'s device SDK requires before it will open
|
|
471
|
+
* a live plugin connection (`onConnect`/`FlipperConnection`) and start
|
|
472
|
+
* relaying `client-message`s for our api. Nothing in flipper-server itself
|
|
473
|
+
* sends this automatically for a non-background plugin like ours unless a
|
|
474
|
+
* full Flipper desktop app is attached and its tab is selected — this
|
|
475
|
+
* method lets a caller trigger the same handshake directly, without
|
|
476
|
+
* needing a desktop UI at all.
|
|
477
|
+
*
|
|
478
|
+
* Calls `ensurePluginInstalled()` first, every time — the plugin can be
|
|
479
|
+
* installed/removed on the attached flipper-server independently of this
|
|
480
|
+
* transport (e.g. a human using the desktop UI concurrently), so there's
|
|
481
|
+
* no snapshot of "already installed" we can trust across calls.
|
|
482
|
+
*
|
|
483
|
+
* Pass a specific `clientId`, or omit it to enable for every client
|
|
484
|
+
* currently connected to flipper-server that we don't already believe is
|
|
485
|
+
* active (see `activeClientIds`) — `init` is otherwise harmless to repeat,
|
|
486
|
+
* but there's no reason to re-send it to a client already talking to us.
|
|
487
|
+
*/
|
|
488
|
+
async enablePlugin(clientId?: string): Promise<void> {
|
|
489
|
+
await this.ensurePluginInstalled();
|
|
490
|
+
const targets = clientId
|
|
491
|
+
? [clientId]
|
|
492
|
+
: [...this.connectedClientIds].filter(
|
|
493
|
+
(id) => !this.activeClientIds.has(id),
|
|
494
|
+
);
|
|
495
|
+
await this.sendLifecycleMessage("init", targets);
|
|
496
|
+
}
|
|
497
|
+
|
|
498
|
+
/**
|
|
499
|
+
* Symmetric counterpart to `enablePlugin` — releases the plugin connection
|
|
500
|
+
* without disconnecting the client from flipper-server.
|
|
501
|
+
*
|
|
502
|
+
* Pass a specific `clientId`, or omit it to disable for every client we
|
|
503
|
+
* currently believe is active (see `activeClientIds`) — there's nothing to
|
|
504
|
+
* release for a client that was never activated.
|
|
505
|
+
*/
|
|
506
|
+
async disablePlugin(clientId?: string): Promise<void> {
|
|
507
|
+
const targets = clientId ? [clientId] : [...this.activeClientIds];
|
|
508
|
+
await this.sendLifecycleMessage("deinit", targets);
|
|
509
|
+
}
|
|
510
|
+
|
|
511
|
+
private async sendLifecycleMessage(
|
|
512
|
+
method: "init" | "deinit",
|
|
513
|
+
targets: Array<string>,
|
|
514
|
+
): Promise<void> {
|
|
515
|
+
if (!this.server) {
|
|
516
|
+
throw new Error("FlipperServerTransport is not connected");
|
|
517
|
+
}
|
|
518
|
+
|
|
519
|
+
const payload: FlipperPluginLifecycleMessage = {
|
|
520
|
+
method,
|
|
521
|
+
params: { plugin: PLUGIN_API },
|
|
522
|
+
};
|
|
523
|
+
|
|
524
|
+
await Promise.all(
|
|
525
|
+
targets.map((id) =>
|
|
526
|
+
this.server!.exec("client-request-response", id, payload).catch(
|
|
527
|
+
(err) => {
|
|
528
|
+
console.warn(
|
|
529
|
+
`[FlipperServerTransport] Failed to ${method} plugin for client ${id}:`,
|
|
530
|
+
err,
|
|
531
|
+
);
|
|
532
|
+
},
|
|
533
|
+
),
|
|
534
|
+
),
|
|
535
|
+
);
|
|
536
|
+
}
|
|
537
|
+
|
|
367
538
|
addListener: CommunicationLayerMethods["addListener"] = (callback) => {
|
|
368
539
|
this.listeners.add(callback);
|
|
369
540
|
};
|
|
@@ -375,6 +546,7 @@ export class FlipperServerTransport implements Transport {
|
|
|
375
546
|
async close(): Promise<void> {
|
|
376
547
|
this.listeners.clear();
|
|
377
548
|
this.activeClientIds.clear();
|
|
549
|
+
this.connectedClientIds.clear();
|
|
378
550
|
this.server?.close();
|
|
379
551
|
this.server = null;
|
|
380
552
|
|