@player-devtools/client-flipper 0.14.3--canary.24.1132 → 0.15.1--canary.29.1254
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 +146 -106
- package/dist/cjs/index.cjs.map +1 -1
- package/dist/index.legacy-esm.js +146 -106
- package/dist/index.mjs +146 -106
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -4
- package/src/__tests__/transport.test.ts +433 -0
- package/src/transport.ts +199 -152
- package/types/transport.d.ts +50 -54
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 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(process.execPath, [serverScript, \"--open=false\"], {\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 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 * Pass a specific `clientId`, or omit it to enable for every client\n * currently connected to flipper-server.\n */\n async enablePlugin(clientId?: string): Promise<void> {\n await this.sendLifecycleMessage(\"init\", clientId);\n }\n\n /** Symmetric counterpart to `enablePlugin` — releases the plugin connection without disconnecting the client from flipper-server. */\n async disablePlugin(clientId?: string): Promise<void> {\n await this.sendLifecycleMessage(\"deinit\", clientId);\n }\n\n private async sendLifecycleMessage(\n method: \"init\" | \"deinit\",\n clientId?: string,\n ): Promise<void> {\n if (!this.server) {\n throw new Error(\"FlipperServerTransport is not connected\");\n }\n\n const targets = clientId ? [clientId] : [...this.connectedClientIds];\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;AAsK7C,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;AAuFA,uBAAwD,CAAC,aAAa;AACpE,WAAK,UAAU,IAAI,QAAQ;AAAA,IAC7B;AAEA,0BAA8D,CAAC,aAAa;AAC1E,WAAK,UAAU,OAAO,QAAQ;AAAA,IAChC;AAAA,EA9PG;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,MAAM,QAAQ,UAAU,CAAC,cAAc,cAAc,GAAG;AAAA,QACpE,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;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,EAeA,MAAM,aAAa,UAAkC;AACnD,UAAM,KAAK,qBAAqB,QAAQ,QAAQ;AAAA,EAClD;AAAA;AAAA,EAGA,MAAM,cAAc,UAAkC;AACpD,UAAM,KAAK,qBAAqB,UAAU,QAAQ;AAAA,EACpD;AAAA,EAEA,MAAc,qBACZ,QACA,UACe;AACf,QAAI,CAAC,KAAK,QAAQ;AAChB,YAAM,IAAI,MAAM,yCAAyC;AAAA,IAC3D;AAEA,UAAM,UAAU,WAAW,CAAC,QAAQ,IAAI,CAAC,GAAG,KAAK,kBAAkB;AACnE,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":[]}
|
|
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 /**\n * Read the current refcount state without mutating it. Still goes through\n * `withLock` so a concurrent acquire/release can't be observed mid-write.\n */\n peek(): RefcountFile | null {\n return this.withLock(() => this.read());\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 /** Resolved connection target, set at the top of `connect()`. */\n private host = \"localhost\";\n private port = 52342;\n\n /**\n * Whether this instance started the shared daemon (vs. attaching to one\n * another instance started). Only an owner may consider restarting it.\n */\n private owns = false;\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.host = this.options.host ?? \"localhost\");\n const port = (this.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 this.owns = shouldStart;\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 try {\n await waitForPort(host, port);\n } catch (err) {\n // Nothing has recorded this PID in the refcount file yet, so nobody\n // else can track or kill it — if we leave it running here it becomes\n // an orphan daemon that a later connect() would compete with on the\n // same port instead of detecting. Wait for it to actually exit (via\n // the same bounded kill-and-confirm mechanism used everywhere else in\n // this file) before rethrowing, so a caller that retries connect()\n // right away doesn't spawn a second daemon racing this one for the\n // port during teardown.\n await this.killAndWait(child.pid!);\n throw err;\n }\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 /**\n * In-flight `close()` promise, if one is currently running on this\n * instance. Guards `refcount.release()` and `killAndWait()` against being\n * invoked twice for a single logical close — e.g. `restart()`'s internal\n * `close()` racing an external `MCPServer.stop()` -> `transport.close()`.\n */\n private closing: Promise<void> | null = null;\n\n async close(): Promise<void> {\n if (this.closing) return this.closing;\n\n this.closing = this.doClose().finally(() => {\n this.closing = null;\n });\n return this.closing;\n }\n\n private async doClose(): 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 await this.killAndWait(pidToKill);\n }\n }\n\n /**\n * Send SIGTERM and wait for the process to actually exit (or a bounded\n * timeout) before resolving, so callers — notably `restart()` — can rely on\n * the port being free once `close()` returns instead of racing a new child\n * for it.\n */\n private killAndWait(pid: number, timeoutMs = 5_000): Promise<void> {\n return new Promise((resolve) => {\n try {\n process.kill(pid);\n } catch {\n // Already gone.\n resolve();\n return;\n }\n\n const deadline = Date.now() + timeoutMs;\n const poll = () => {\n if (!this.isPidAlive(pid)) {\n log(\"[FlipperServerTransport] Shut down flipper-server.\");\n resolve();\n return;\n }\n if (Date.now() >= deadline) {\n log(\n \"[FlipperServerTransport] Timed out waiting for flipper-server to exit.\",\n );\n resolve();\n return;\n }\n setTimeout(poll, 100);\n };\n poll();\n });\n }\n\n private isPidAlive(pid: number): boolean {\n try {\n process.kill(pid, 0);\n return true;\n } catch {\n return false;\n }\n }\n\n /** Read-only snapshot of this transport's connection to the shared daemon. */\n getDiagnostics(): {\n connected: boolean;\n host: string;\n port: number;\n owns: boolean;\n refs: number | null;\n activeClientIds: string[];\n } {\n const state = this.refcount.peek();\n return {\n connected: this.server !== null,\n host: this.host,\n port: this.port,\n owns: this.owns,\n refs: state?.refs ?? null,\n activeClientIds: [...this.activeClientIds],\n };\n }\n\n /**\n * Restart the shared daemon. Only ever acts when this instance both owns\n * the daemon (started it) and is its sole remaining consumer — otherwise\n * this soft-errors without touching the daemon, since killing it out from\n * under other attached instances would break their connections.\n */\n async restart(): Promise<\n { ok: true; host: string; port: number } | { ok: false; reason: string }\n > {\n if (!this.owns) {\n return {\n ok: false,\n reason: \"this instance does not own the flipper-server daemon\",\n };\n }\n\n const state = this.refcount.peek();\n if (state?.refs !== 1) {\n return {\n ok: false,\n reason: \"other consumers are attached to this daemon\",\n };\n }\n\n // Re-verify immediately before the destructive close(): another instance\n // could have called connect()/acquire() between the check above and here,\n // bumping refs to 2+. This narrows but does not eliminate the race — a\n // consumer could still slip in between this re-check and close() itself;\n // a fully atomic fix would need close()+connect() to run inside\n // refcount.withLock(), which isn't reentrant-safe with connect()'s own\n // internal use of the lock, so we accept this narrow residual window.\n const recheck = this.refcount.peek();\n if (recheck?.refs !== 1) {\n return {\n ok: false,\n reason: \"other consumers attached to this daemon just before restart\",\n };\n }\n\n try {\n await this.close();\n await this.connect();\n } catch (err) {\n // The daemon this instance owned/attempted to own is now in an unknown\n // or dead state — don't leave `owns` set, or a later restart() call\n // will misreport \"other consumers are attached\" against a stale\n // refcount for a daemon that no longer exists.\n this.owns = false;\n return {\n ok: false,\n reason: err instanceof Error ? err.message : String(err),\n };\n }\n return { ok: true, host: this.host, port: this.port };\n }\n\n /** Whether the devtools Flipper plugin is installed, per the live daemon. */\n async getPluginInstallStatus(): Promise<{\n installed: boolean;\n version?: string;\n reason?: string;\n }> {\n if (!this.server) return { installed: false, reason: \"not connected\" };\n\n try {\n const plugins = (await this.server.exec(\n \"plugins-get-installed-plugins\",\n )) as Array<{ id?: string; name?: string; version?: string }>;\n\n const plugin = plugins.find(\n (candidate) =>\n candidate.id === PLUGIN_API || candidate.name === PLUGIN_API,\n );\n\n if (!plugin) return { installed: false };\n return plugin.version\n ? { installed: true, version: plugin.version }\n : { installed: true };\n } catch (err) {\n return {\n installed: false,\n reason: err instanceof Error ? err.message : String(err),\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;AAAA;AAAA;AAAA;AAAA,EAMA,OAA4B;AAC1B,WAAO,KAAK,SAAS,MAAM,KAAK,KAAK,CAAC;AAAA,EACxC;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,EAqBvD,YACU,UAKJ,CAAC,GACL;AANQ;AArBV,SAAQ,SAA+B;AACvC,SAAQ,WAAW,IAAI,gBAAgB;AACvC,SAAQ,YAAY,oBAAI,IAAqB;AAM7C;AAAA;AAAA;AAAA;AAAA,SAAQ,kBAAkB,oBAAI,IAAY;AAG1C;AAAA,SAAQ,OAAO;AACf,SAAQ,OAAO;AAMf;AAAA;AAAA;AAAA;AAAA,SAAQ,OAAO;AAsIf,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;AAQA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,SAAQ,UAAgC;AAAA,EAvKrC;AAAA,EAEH,MAAM,UAAyB;AAC7B,UAAM,OAAQ,KAAK,OAAO,KAAK,QAAQ,QAAQ;AAC/C,UAAM,OAAQ,KAAK,OAAO,KAAK,QAAQ,QAAQ;AAK/C,UAAM,EAAE,aAAa,OAAO,IAAI,KAAK,SAAS,QAAQ;AACtD,SAAK,OAAO;AAEZ,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,UAAI;AACF,cAAM,YAAY,MAAM,IAAI;AAAA,MAC9B,SAAS,KAAK;AASZ,cAAM,KAAK,YAAY,MAAM,GAAI;AACjC,cAAM;AAAA,MACR;AACA,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,EA8CA,MAAM,QAAuB;AAC3B,QAAI,KAAK,QAAS,QAAO,KAAK;AAE9B,SAAK,UAAU,KAAK,QAAQ,EAAE,QAAQ,MAAM;AAC1C,WAAK,UAAU;AAAA,IACjB,CAAC;AACD,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,MAAc,UAAyB;AACrC,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,YAAM,KAAK,YAAY,SAAS;AAAA,IAClC;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQQ,YAAY,KAAa,YAAY,KAAsB;AACjE,WAAO,IAAI,QAAQ,CAAC,YAAY;AAC9B,UAAI;AACF,gBAAQ,KAAK,GAAG;AAAA,MAClB,QAAQ;AAEN,gBAAQ;AACR;AAAA,MACF;AAEA,YAAM,WAAW,KAAK,IAAI,IAAI;AAC9B,YAAM,OAAO,MAAM;AACjB,YAAI,CAAC,KAAK,WAAW,GAAG,GAAG;AACzB,cAAI,oDAAoD;AACxD,kBAAQ;AACR;AAAA,QACF;AACA,YAAI,KAAK,IAAI,KAAK,UAAU;AAC1B;AAAA,YACE;AAAA,UACF;AACA,kBAAQ;AACR;AAAA,QACF;AACA,mBAAW,MAAM,GAAG;AAAA,MACtB;AACA,WAAK;AAAA,IACP,CAAC;AAAA,EACH;AAAA,EAEQ,WAAW,KAAsB;AACvC,QAAI;AACF,cAAQ,KAAK,KAAK,CAAC;AACnB,aAAO;AAAA,IACT,QAAQ;AACN,aAAO;AAAA,IACT;AAAA,EACF;AAAA;AAAA,EAGA,iBAOE;AACA,UAAM,QAAQ,KAAK,SAAS,KAAK;AACjC,WAAO;AAAA,MACL,WAAW,KAAK,WAAW;AAAA,MAC3B,MAAM,KAAK;AAAA,MACX,MAAM,KAAK;AAAA,MACX,MAAM,KAAK;AAAA,MACX,MAAM,OAAO,QAAQ;AAAA,MACrB,iBAAiB,CAAC,GAAG,KAAK,eAAe;AAAA,IAC3C;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,UAEJ;AACA,QAAI,CAAC,KAAK,MAAM;AACd,aAAO;AAAA,QACL,IAAI;AAAA,QACJ,QAAQ;AAAA,MACV;AAAA,IACF;AAEA,UAAM,QAAQ,KAAK,SAAS,KAAK;AACjC,QAAI,OAAO,SAAS,GAAG;AACrB,aAAO;AAAA,QACL,IAAI;AAAA,QACJ,QAAQ;AAAA,MACV;AAAA,IACF;AASA,UAAM,UAAU,KAAK,SAAS,KAAK;AACnC,QAAI,SAAS,SAAS,GAAG;AACvB,aAAO;AAAA,QACL,IAAI;AAAA,QACJ,QAAQ;AAAA,MACV;AAAA,IACF;AAEA,QAAI;AACF,YAAM,KAAK,MAAM;AACjB,YAAM,KAAK,QAAQ;AAAA,IACrB,SAAS,KAAK;AAKZ,WAAK,OAAO;AACZ,aAAO;AAAA,QACL,IAAI;AAAA,QACJ,QAAQ,eAAe,QAAQ,IAAI,UAAU,OAAO,GAAG;AAAA,MACzD;AAAA,IACF;AACA,WAAO,EAAE,IAAI,MAAM,MAAM,KAAK,MAAM,MAAM,KAAK,KAAK;AAAA,EACtD;AAAA;AAAA,EAGA,MAAM,yBAIH;AACD,QAAI,CAAC,KAAK,OAAQ,QAAO,EAAE,WAAW,OAAO,QAAQ,gBAAgB;AAErE,QAAI;AACF,YAAM,UAAW,MAAM,KAAK,OAAO;AAAA,QACjC;AAAA,MACF;AAEA,YAAM,SAAS,QAAQ;AAAA,QACrB,CAAC,cACC,UAAU,OAAO,cAAc,UAAU,SAAS;AAAA,MACtD;AAEA,UAAI,CAAC,OAAQ,QAAO,EAAE,WAAW,MAAM;AACvC,aAAO,OAAO,UACV,EAAE,WAAW,MAAM,SAAS,OAAO,QAAQ,IAC3C,EAAE,WAAW,KAAK;AAAA,IACxB,SAAS,KAAK;AACZ,aAAO;AAAA,QACL,WAAW;AAAA,QACX,QAAQ,eAAe,QAAQ,IAAI,UAAU,OAAO,GAAG;AAAA,MACzD;AAAA,IACF;AAAA,EACF;AACF;","names":[]}
|
package/package.json
CHANGED
|
@@ -6,15 +6,13 @@
|
|
|
6
6
|
"types"
|
|
7
7
|
],
|
|
8
8
|
"name": "@player-devtools/client-flipper",
|
|
9
|
-
"version": "0.
|
|
9
|
+
"version": "0.15.1--canary.29.1254",
|
|
10
10
|
"main": "dist/cjs/index.cjs",
|
|
11
11
|
"dependencies": {
|
|
12
|
-
"@player-devtools/types": "0.
|
|
12
|
+
"@player-devtools/types": "0.15.1--canary.29.1254",
|
|
13
13
|
"@types/ws": "^8.0.0",
|
|
14
|
-
"flipper-common": "^0.273.0",
|
|
15
14
|
"flipper-server": "^0.273.0",
|
|
16
15
|
"flipper-server-client": "^0.273.0",
|
|
17
|
-
"open": "^8.4.2",
|
|
18
16
|
"ws": "^8.0.0",
|
|
19
17
|
"tslib": "^2.6.2"
|
|
20
18
|
},
|
|
@@ -0,0 +1,433 @@
|
|
|
1
|
+
import { describe, it, expect, vi } from "vitest";
|
|
2
|
+
import * as fs from "fs";
|
|
3
|
+
import * as os from "os";
|
|
4
|
+
import * as path from "path";
|
|
5
|
+
|
|
6
|
+
import { FlipperServerTransport } from "../transport";
|
|
7
|
+
|
|
8
|
+
/** Access private fields for seeding — this is the pattern the plan calls for
|
|
9
|
+
* to avoid real sockets/child processes while exercising the diagnostics
|
|
10
|
+
* surface added for the MCP server's flipper tools. */
|
|
11
|
+
type TransportInternals = {
|
|
12
|
+
server: unknown;
|
|
13
|
+
refcount: { peek: () => { pid: number; refs: number } | null };
|
|
14
|
+
owns: boolean;
|
|
15
|
+
host: string;
|
|
16
|
+
port: number;
|
|
17
|
+
activeClientIds: Set<string>;
|
|
18
|
+
};
|
|
19
|
+
|
|
20
|
+
function internals(transport: FlipperServerTransport): TransportInternals {
|
|
21
|
+
return transport as unknown as TransportInternals;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* A transport whose refcount is stubbed to `null` so tests don't depend on
|
|
26
|
+
* (or race) a real `flipper-server.refcount` file possibly left on disk by
|
|
27
|
+
* other processes on the machine running the test.
|
|
28
|
+
*/
|
|
29
|
+
function makeIsolatedTransport(
|
|
30
|
+
options?: ConstructorParameters<typeof FlipperServerTransport>[0],
|
|
31
|
+
): FlipperServerTransport {
|
|
32
|
+
const transport = new FlipperServerTransport(options);
|
|
33
|
+
internals(transport).refcount = { peek: () => null };
|
|
34
|
+
return transport;
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
describe("FlipperServerTransport", () => {
|
|
38
|
+
describe("getDiagnostics", () => {
|
|
39
|
+
it("reports disconnected defaults before connect() is called", () => {
|
|
40
|
+
const transport = makeIsolatedTransport();
|
|
41
|
+
expect(transport.getDiagnostics()).toEqual({
|
|
42
|
+
connected: false,
|
|
43
|
+
host: "localhost",
|
|
44
|
+
port: 52342,
|
|
45
|
+
owns: false,
|
|
46
|
+
refs: null,
|
|
47
|
+
activeClientIds: [],
|
|
48
|
+
});
|
|
49
|
+
});
|
|
50
|
+
|
|
51
|
+
it("reflects custom host/port options even before connecting", () => {
|
|
52
|
+
const transport = makeIsolatedTransport({
|
|
53
|
+
host: "127.0.0.1",
|
|
54
|
+
port: 9999,
|
|
55
|
+
});
|
|
56
|
+
// host/port are only assigned inside connect(); options alone don't
|
|
57
|
+
// seed the instance fields, matching the plan's "set at top of
|
|
58
|
+
// connect()" requirement.
|
|
59
|
+
expect(transport.getDiagnostics()).toMatchObject({
|
|
60
|
+
host: "localhost",
|
|
61
|
+
port: 52342,
|
|
62
|
+
});
|
|
63
|
+
});
|
|
64
|
+
|
|
65
|
+
it("reports connected + owns + refs + activeClientIds once seeded", () => {
|
|
66
|
+
const transport = makeIsolatedTransport();
|
|
67
|
+
const state = internals(transport);
|
|
68
|
+
state.server = {};
|
|
69
|
+
state.owns = true;
|
|
70
|
+
state.activeClientIds = new Set(["a", "b"]);
|
|
71
|
+
state.refcount = { peek: () => ({ pid: 123, refs: 1 }) };
|
|
72
|
+
|
|
73
|
+
expect(transport.getDiagnostics()).toEqual({
|
|
74
|
+
connected: true,
|
|
75
|
+
host: "localhost",
|
|
76
|
+
port: 52342,
|
|
77
|
+
owns: true,
|
|
78
|
+
refs: 1,
|
|
79
|
+
activeClientIds: ["a", "b"],
|
|
80
|
+
});
|
|
81
|
+
});
|
|
82
|
+
});
|
|
83
|
+
|
|
84
|
+
describe("FlipperRefcount.peek (via getDiagnostics)", () => {
|
|
85
|
+
it("does not mutate the refcount file", () => {
|
|
86
|
+
const dir = path.join(os.tmpdir(), "player-devtools-mcp");
|
|
87
|
+
const file = path.join(dir, "flipper-server.refcount");
|
|
88
|
+
fs.mkdirSync(dir, { recursive: true });
|
|
89
|
+
fs.writeFileSync(file, JSON.stringify({ pid: process.pid, refs: 4 }));
|
|
90
|
+
|
|
91
|
+
try {
|
|
92
|
+
const transport = new FlipperServerTransport();
|
|
93
|
+
const before = fs.readFileSync(file, "utf8");
|
|
94
|
+
const { refs } = transport.getDiagnostics();
|
|
95
|
+
const after = fs.readFileSync(file, "utf8");
|
|
96
|
+
|
|
97
|
+
expect(refs).toBe(4);
|
|
98
|
+
expect(after).toBe(before);
|
|
99
|
+
} finally {
|
|
100
|
+
fs.rmSync(file, { force: true });
|
|
101
|
+
}
|
|
102
|
+
});
|
|
103
|
+
});
|
|
104
|
+
|
|
105
|
+
describe("restart", () => {
|
|
106
|
+
it("soft-errors without touching the daemon when this instance does not own it", async () => {
|
|
107
|
+
const transport = new FlipperServerTransport();
|
|
108
|
+
const close = vi.spyOn(transport, "close");
|
|
109
|
+
const connect = vi.spyOn(transport, "connect");
|
|
110
|
+
|
|
111
|
+
const result = await transport.restart();
|
|
112
|
+
|
|
113
|
+
expect(result).toEqual({
|
|
114
|
+
ok: false,
|
|
115
|
+
reason: "this instance does not own the flipper-server daemon",
|
|
116
|
+
});
|
|
117
|
+
expect(close).not.toHaveBeenCalled();
|
|
118
|
+
expect(connect).not.toHaveBeenCalled();
|
|
119
|
+
});
|
|
120
|
+
|
|
121
|
+
it("soft-errors without touching the daemon when other consumers are attached", async () => {
|
|
122
|
+
const transport = new FlipperServerTransport();
|
|
123
|
+
const state = internals(transport);
|
|
124
|
+
state.owns = true;
|
|
125
|
+
state.refcount = { peek: () => ({ pid: 1, refs: 3 }) };
|
|
126
|
+
|
|
127
|
+
const close = vi.spyOn(transport, "close");
|
|
128
|
+
const connect = vi.spyOn(transport, "connect");
|
|
129
|
+
|
|
130
|
+
const result = await transport.restart();
|
|
131
|
+
|
|
132
|
+
expect(result).toEqual({
|
|
133
|
+
ok: false,
|
|
134
|
+
reason: "other consumers are attached to this daemon",
|
|
135
|
+
});
|
|
136
|
+
expect(close).not.toHaveBeenCalled();
|
|
137
|
+
expect(connect).not.toHaveBeenCalled();
|
|
138
|
+
});
|
|
139
|
+
|
|
140
|
+
it("closes and reconnects when this instance is the sole owner", async () => {
|
|
141
|
+
const transport = new FlipperServerTransport();
|
|
142
|
+
const state = internals(transport);
|
|
143
|
+
state.owns = true;
|
|
144
|
+
state.refcount = { peek: () => ({ pid: 1, refs: 1 }) };
|
|
145
|
+
|
|
146
|
+
const close = vi.spyOn(transport, "close").mockResolvedValue(undefined);
|
|
147
|
+
const connect = vi
|
|
148
|
+
.spyOn(transport, "connect")
|
|
149
|
+
.mockImplementation(async () => {
|
|
150
|
+
state.host = "localhost";
|
|
151
|
+
state.port = 52342;
|
|
152
|
+
});
|
|
153
|
+
|
|
154
|
+
const result = await transport.restart();
|
|
155
|
+
|
|
156
|
+
expect(close).toHaveBeenCalledOnce();
|
|
157
|
+
expect(connect).toHaveBeenCalledOnce();
|
|
158
|
+
expect(result).toEqual({ ok: true, host: "localhost", port: 52342 });
|
|
159
|
+
});
|
|
160
|
+
|
|
161
|
+
it("aborts with a soft error when refs change between the initial check and the pre-kill re-check", async () => {
|
|
162
|
+
const transport = new FlipperServerTransport();
|
|
163
|
+
const state = internals(transport);
|
|
164
|
+
state.owns = true;
|
|
165
|
+
let calls = 0;
|
|
166
|
+
state.refcount = {
|
|
167
|
+
peek: () => {
|
|
168
|
+
calls += 1;
|
|
169
|
+
// First peek (in the initial guard) sees refs=1; the re-check
|
|
170
|
+
// immediately before close() sees a consumer that just attached.
|
|
171
|
+
return calls === 1 ? { pid: 1, refs: 1 } : { pid: 1, refs: 2 };
|
|
172
|
+
},
|
|
173
|
+
};
|
|
174
|
+
|
|
175
|
+
const close = vi.spyOn(transport, "close");
|
|
176
|
+
const connect = vi.spyOn(transport, "connect");
|
|
177
|
+
|
|
178
|
+
const result = await transport.restart();
|
|
179
|
+
|
|
180
|
+
expect(result).toEqual({
|
|
181
|
+
ok: false,
|
|
182
|
+
reason: "other consumers attached to this daemon just before restart",
|
|
183
|
+
});
|
|
184
|
+
expect(close).not.toHaveBeenCalled();
|
|
185
|
+
expect(connect).not.toHaveBeenCalled();
|
|
186
|
+
});
|
|
187
|
+
|
|
188
|
+
it("returns a soft error and resets owns to false when connect() fails after close() succeeds", async () => {
|
|
189
|
+
const transport = new FlipperServerTransport();
|
|
190
|
+
const state = internals(transport);
|
|
191
|
+
state.owns = true;
|
|
192
|
+
state.refcount = { peek: () => ({ pid: 1, refs: 1 }) };
|
|
193
|
+
|
|
194
|
+
const close = vi.spyOn(transport, "close").mockResolvedValue(undefined);
|
|
195
|
+
const connect = vi
|
|
196
|
+
.spyOn(transport, "connect")
|
|
197
|
+
.mockRejectedValue(new Error("Timed out waiting for localhost:52342"));
|
|
198
|
+
|
|
199
|
+
const result = await transport.restart();
|
|
200
|
+
|
|
201
|
+
expect(close).toHaveBeenCalledOnce();
|
|
202
|
+
expect(connect).toHaveBeenCalledOnce();
|
|
203
|
+
expect(result).toEqual({
|
|
204
|
+
ok: false,
|
|
205
|
+
reason: "Timed out waiting for localhost:52342",
|
|
206
|
+
});
|
|
207
|
+
expect(internals(transport).owns).toBe(false);
|
|
208
|
+
});
|
|
209
|
+
});
|
|
210
|
+
|
|
211
|
+
describe("getPluginInstallStatus", () => {
|
|
212
|
+
it("returns not-installed when the server is not connected", async () => {
|
|
213
|
+
const transport = new FlipperServerTransport();
|
|
214
|
+
await expect(transport.getPluginInstallStatus()).resolves.toEqual({
|
|
215
|
+
installed: false,
|
|
216
|
+
reason: "not connected",
|
|
217
|
+
});
|
|
218
|
+
});
|
|
219
|
+
|
|
220
|
+
it("returns not-installed when the daemon has no matching plugin", async () => {
|
|
221
|
+
const transport = new FlipperServerTransport();
|
|
222
|
+
internals(transport).server = {
|
|
223
|
+
exec: vi.fn().mockResolvedValue([{ id: "some-other-plugin" }]),
|
|
224
|
+
};
|
|
225
|
+
|
|
226
|
+
await expect(transport.getPluginInstallStatus()).resolves.toEqual({
|
|
227
|
+
installed: false,
|
|
228
|
+
});
|
|
229
|
+
});
|
|
230
|
+
|
|
231
|
+
it("matches by id and reports the version when present", async () => {
|
|
232
|
+
const transport = new FlipperServerTransport();
|
|
233
|
+
internals(transport).server = {
|
|
234
|
+
exec: vi
|
|
235
|
+
.fn()
|
|
236
|
+
.mockResolvedValue([{ id: "player-ui-devtools", version: "1.2.3" }]),
|
|
237
|
+
};
|
|
238
|
+
|
|
239
|
+
await expect(transport.getPluginInstallStatus()).resolves.toEqual({
|
|
240
|
+
installed: true,
|
|
241
|
+
version: "1.2.3",
|
|
242
|
+
});
|
|
243
|
+
});
|
|
244
|
+
|
|
245
|
+
it("matches by name when id is absent, without a version", async () => {
|
|
246
|
+
const transport = new FlipperServerTransport();
|
|
247
|
+
internals(transport).server = {
|
|
248
|
+
exec: vi.fn().mockResolvedValue([{ name: "player-ui-devtools" }]),
|
|
249
|
+
};
|
|
250
|
+
|
|
251
|
+
await expect(transport.getPluginInstallStatus()).resolves.toEqual({
|
|
252
|
+
installed: true,
|
|
253
|
+
});
|
|
254
|
+
});
|
|
255
|
+
|
|
256
|
+
it("resolves with a failure reason instead of throwing when exec() rejects", async () => {
|
|
257
|
+
const transport = new FlipperServerTransport();
|
|
258
|
+
internals(transport).server = {
|
|
259
|
+
exec: vi.fn().mockRejectedValue(new Error("daemon dropped")),
|
|
260
|
+
};
|
|
261
|
+
|
|
262
|
+
await expect(transport.getPluginInstallStatus()).resolves.toEqual({
|
|
263
|
+
installed: false,
|
|
264
|
+
reason: "daemon dropped",
|
|
265
|
+
});
|
|
266
|
+
});
|
|
267
|
+
|
|
268
|
+
it("returns the soft-error shape instead of throwing when exec() resolves with a malformed non-array value", async () => {
|
|
269
|
+
const transport = new FlipperServerTransport();
|
|
270
|
+
internals(transport).server = {
|
|
271
|
+
// Simulates a version-mismatched daemon response: exec() resolves
|
|
272
|
+
// (doesn't reject) with something that isn't an array, so `.find()`
|
|
273
|
+
// would throw a TypeError if called outside the try/catch.
|
|
274
|
+
exec: vi.fn().mockResolvedValue({ unexpected: "shape" }),
|
|
275
|
+
};
|
|
276
|
+
|
|
277
|
+
await expect(transport.getPluginInstallStatus()).resolves.toEqual({
|
|
278
|
+
installed: false,
|
|
279
|
+
reason: "plugins.find is not a function",
|
|
280
|
+
});
|
|
281
|
+
});
|
|
282
|
+
});
|
|
283
|
+
|
|
284
|
+
describe("close", () => {
|
|
285
|
+
it("waits for the killed daemon process to actually exit before resolving", async () => {
|
|
286
|
+
vi.useFakeTimers();
|
|
287
|
+
try {
|
|
288
|
+
const transport = new FlipperServerTransport();
|
|
289
|
+
const state = internals(transport);
|
|
290
|
+
state.refcount = {
|
|
291
|
+
peek: () => null,
|
|
292
|
+
} as unknown as TransportInternals["refcount"];
|
|
293
|
+
(
|
|
294
|
+
transport as unknown as {
|
|
295
|
+
refcount: { release: () => number | null };
|
|
296
|
+
}
|
|
297
|
+
).refcount.release = () => 4242;
|
|
298
|
+
|
|
299
|
+
let alive = true;
|
|
300
|
+
const killSpy = vi.spyOn(process, "kill").mockImplementation(((
|
|
301
|
+
pid: number,
|
|
302
|
+
signal?: string | number,
|
|
303
|
+
) => {
|
|
304
|
+
if (signal === 0) {
|
|
305
|
+
if (!alive) throw new Error("ESRCH");
|
|
306
|
+
return true;
|
|
307
|
+
}
|
|
308
|
+
return true;
|
|
309
|
+
}) as typeof process.kill);
|
|
310
|
+
|
|
311
|
+
const closePromise = transport.close();
|
|
312
|
+
let resolved = false;
|
|
313
|
+
void closePromise.then(() => {
|
|
314
|
+
resolved = true;
|
|
315
|
+
});
|
|
316
|
+
|
|
317
|
+
// Still "alive" — close() must not have resolved yet.
|
|
318
|
+
await vi.advanceTimersByTimeAsync(300);
|
|
319
|
+
expect(resolved).toBe(false);
|
|
320
|
+
|
|
321
|
+
// Now the process exits; the next poll should observe it and resolve.
|
|
322
|
+
alive = false;
|
|
323
|
+
await vi.advanceTimersByTimeAsync(200);
|
|
324
|
+
await closePromise;
|
|
325
|
+
expect(resolved).toBe(true);
|
|
326
|
+
|
|
327
|
+
killSpy.mockRestore();
|
|
328
|
+
} finally {
|
|
329
|
+
vi.useRealTimers();
|
|
330
|
+
}
|
|
331
|
+
});
|
|
332
|
+
|
|
333
|
+
it("is idempotent: a second concurrent close() does not re-run teardown", async () => {
|
|
334
|
+
const transport = new FlipperServerTransport();
|
|
335
|
+
|
|
336
|
+
let releaseCalls = 0;
|
|
337
|
+
(
|
|
338
|
+
transport as unknown as {
|
|
339
|
+
refcount: { release: () => number | null };
|
|
340
|
+
}
|
|
341
|
+
).refcount = {
|
|
342
|
+
peek: () => null,
|
|
343
|
+
release: () => {
|
|
344
|
+
releaseCalls += 1;
|
|
345
|
+
return null;
|
|
346
|
+
},
|
|
347
|
+
} as unknown as TransportInternals["refcount"];
|
|
348
|
+
|
|
349
|
+
const first = transport.close();
|
|
350
|
+
const second = transport.close();
|
|
351
|
+
|
|
352
|
+
await Promise.all([first, second]);
|
|
353
|
+
|
|
354
|
+
expect(releaseCalls).toBe(1);
|
|
355
|
+
});
|
|
356
|
+
});
|
|
357
|
+
|
|
358
|
+
describe("connect", () => {
|
|
359
|
+
it("kills the spawned child and waits for it to exit when waitForPort fails after spawn", async () => {
|
|
360
|
+
// Exercises connect()'s `shouldStart` spawn path: the real flipper-server
|
|
361
|
+
// child is spawned, but nothing is listening on the target port, so
|
|
362
|
+
// waitForPort() times out. Nothing has committed this child's PID to
|
|
363
|
+
// the refcount file yet, so connect() must kill it itself (via the same
|
|
364
|
+
// killAndWait() used elsewhere in this file) or it orphans.
|
|
365
|
+
//
|
|
366
|
+
// Under this workspace's vitest environment (happy-dom), `vi.mock`
|
|
367
|
+
// cannot reliably intercept Node builtin modules (`child_process`,
|
|
368
|
+
// `net`) for code paths already resolved outside the test file's own
|
|
369
|
+
// module graph, so this spies on the module-level `process.kill`
|
|
370
|
+
// instead — the real spawn() runs, but against a port nothing listens
|
|
371
|
+
// on, and fake timers fast-forward both waitForPort's 30s polling loop
|
|
372
|
+
// and killAndWait's exit-confirmation poll.
|
|
373
|
+
let alive = true;
|
|
374
|
+
const processKillSpy = vi.spyOn(process, "kill").mockImplementation(((
|
|
375
|
+
pid: number,
|
|
376
|
+
signal?: string | number,
|
|
377
|
+
) => {
|
|
378
|
+
if (signal === 0) {
|
|
379
|
+
if (!alive) throw new Error("ESRCH");
|
|
380
|
+
return true;
|
|
381
|
+
}
|
|
382
|
+
// The SIGTERM sent by killAndWait().
|
|
383
|
+
alive = false;
|
|
384
|
+
return true;
|
|
385
|
+
}) as typeof process.kill);
|
|
386
|
+
|
|
387
|
+
vi.useFakeTimers();
|
|
388
|
+
try {
|
|
389
|
+
const transport = new FlipperServerTransport({
|
|
390
|
+
host: "127.0.0.1",
|
|
391
|
+
// Reserved/unused port: nothing should ever be listening here in CI
|
|
392
|
+
// or locally, so real net.connect attempts genuinely fail fast.
|
|
393
|
+
port: 1,
|
|
394
|
+
});
|
|
395
|
+
const state = internals(transport);
|
|
396
|
+
state.refcount = {
|
|
397
|
+
peek: () => null,
|
|
398
|
+
} as unknown as TransportInternals["refcount"];
|
|
399
|
+
(
|
|
400
|
+
transport as unknown as {
|
|
401
|
+
refcount: {
|
|
402
|
+
acquire: () => {
|
|
403
|
+
shouldStart: boolean;
|
|
404
|
+
commit: (pid: number) => void;
|
|
405
|
+
};
|
|
406
|
+
};
|
|
407
|
+
}
|
|
408
|
+
).refcount.acquire = () => ({
|
|
409
|
+
shouldStart: true,
|
|
410
|
+
commit: vi.fn(),
|
|
411
|
+
});
|
|
412
|
+
|
|
413
|
+
const connectPromise = transport.connect().catch((err) => err as Error);
|
|
414
|
+
|
|
415
|
+
// Advance past waitForPort's internal 30s timeout so it rejects, then
|
|
416
|
+
// past killAndWait's poll interval so it observes the SIGTERM'd
|
|
417
|
+
// child's exit before connect() rethrows.
|
|
418
|
+
await vi.advanceTimersByTimeAsync(31_200);
|
|
419
|
+
|
|
420
|
+
const result = await connectPromise;
|
|
421
|
+
|
|
422
|
+
expect(result).toBeInstanceOf(Error);
|
|
423
|
+
// The SIGTERM from killAndWait().
|
|
424
|
+
expect(processKillSpy).toHaveBeenCalledWith(expect.any(Number));
|
|
425
|
+
// The liveness poll from killAndWait()'s isPidAlive().
|
|
426
|
+
expect(processKillSpy).toHaveBeenCalledWith(expect.any(Number), 0);
|
|
427
|
+
} finally {
|
|
428
|
+
vi.useRealTimers();
|
|
429
|
+
processKillSpy.mockRestore();
|
|
430
|
+
}
|
|
431
|
+
});
|
|
432
|
+
});
|
|
433
|
+
});
|