feat(client): add DevframeRpcClient.close()

[dvcolomban]

What

DevframeRpcClient has no close()/dispose() of any kind — a connection lives until the process ends, with no way for a caller to tear it down. The server transport already has the symmetric piece: WsRpcTransport.close() (attachWsRpcTransport) detaches upgrade routing, force-closes every connected peer, and closes any server it created itself. The client side has never had an equivalent.

This bites any caller that races a connection attempt against its own deadline (Promise.race([connectDevframe(...), timeout])) — the deadline can't cancel the loser, so a slow-to-resolve attempt becomes a fully connected, unreferenced client with nothing able to close it. That's the concrete case that surfaced this: @contentsquare/devkit carries a local patch adding this exact method so its connection-deadline and disconnect() paths can close what they no longer want, rather than leaking it.

createWsRpcChannel returns close(), closing the underlying WebSocket — widening its return type to ChannelOptions & { close: () => void }, since birpc's own ChannelOptions has no teardown of its own. createWsRpcClientMode hoists its channel to a local so it can reach it, and exposes close() on DevframeRpcClientMode. DevframeRpcClient.close() delegates to the mode. Purely additive: no behavior change for anyone not calling it.

Why a no-op close() on the static backend, not an optional one

createStaticRpcClientMode has no live socket — every call is a local fetch — so its close() does nothing. Making it optional instead (close?: () => void) would push the "does this mode support closing" question onto every caller of DevframeRpcClientMode/DevframeRpcClient, for no real benefit: the two modes already union-compatible on every other method this way (requestTrustWithCode, ensureTrusted, …), and a no-op is exactly as safe to call as a real one.

Why not just expose the WebSocket

Handing back the raw socket would let a caller close it out from under the channel without the channel's own bookkeeping (pendingRequestMethods, the queued-send cleanup in post) ever running — the same class of bug #165 declined to reintroduce by not exposing httpServer on the server side. A narrow close() matches that precedent and the shape WsRpcTransport.close() already established server-side.

Why close() doesn't also reject pending calls

It doesn't need to. Closing the socket fires the channel's own close listener, which createWsRpcClientMode already wires to onDisconnected → rejectAllPending(...) — the exact path a real disconnect takes. Adding a second, separate rejection here would just race the first.

Note for maintainers

Opening as draft since I'm an external consumer proposing this from downstream need, not a maintainer. Two things I'd rather leave to you than decide unilaterally:

• Naming. close() mirrors the server transport's own WsRpcTransport.close(), but dispose()/Symbol.dispose are also reasonable given DevframeRpcClient is a resource with a lifetime. Happy to rename either way.
• Async or sync. WsRpcTransport.close() is async (it awaits ownedServer.close()); this one is sync, since WebSocket.close() itself doesn't return anything to await and there's nothing else here to wait on. Flagging the asymmetry in case you'd rather keep the two close()s the same shape regardless.

Tests

• ws-client.test.ts (new): close() closes the underlying WebSocket.
• rpc-ws-status.test.ts: createWsRpcClientMode's close() closes its socket.
• rpc.test.ts: getDevframeRpcClient's close() closes the socket on a websocket backend, and is a no-op (not a throw) on a static one.
• rpc-auth-gate.test.ts: updated its hand-typed DevframeRpcClientMode mock for the new required field.

pnpm --filter devframe exec tsc --noEmit clean. pnpm exec vitest run --project devframe — 51 files, 463 tests (was 459), all green. Also ran --project @devframes/hub --project @devframes/hub-ui (129 tests) and tsc --noEmit across @devframes/hub, @devframes/hub-ui, @devframes/nuxt — the packages consuming DevframeRpcClient — clean. eslint clean on every touched file.

[netlify]

✅ Deploy Preview for devfra ready!

Name	Link
🔨 Latest commit	5c36bbb
🔍 Latest deploy log	https://app.netlify.com/projects/devfra/deploys/6a74cfa7ada06400085fc50f
😎 Deploy Preview	https://deploy-preview-175--devfra.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
🤖 Make changes	Run an agent on this branch

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[Copilot]

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds an explicit close() API to the Devframe RPC client so consumers can deterministically tear down websocket connections (mirroring server transport close behavior).

Changes:

• Extend the public DevframeRpcClient / DevframeRpcClientMode types with close().
• Add close() support to the websocket channel/transport and wire it through websocket/static modes.
• Add unit tests ensuring close() closes the underlying websocket and is a no-op for static mode.

Reviewed changes

Copilot reviewed 8 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
tests/snapshots/tsnapi/devframe/client.snapshot.d.ts	Updates snapshot typings to include close() in the public client/mode interfaces.
packages/devframe/src/rpc/transports/ws-client.ts	Extends ws channel factory to return a closable channel and implements close().
packages/devframe/src/rpc/transports/ws-client.test.ts	Adds a focused unit test verifying channel close() calls WebSocket.close().
packages/devframe/src/client/rpc.ts	Exposes rpc.close() and threads close() through to the selected mode.
packages/devframe/src/client/rpc.test.ts	Adds integration tests for websocket close + static backend no-op close.
packages/devframe/src/client/rpc-ws.ts	Hoists channel creation so mode can expose close() that closes the socket.
packages/devframe/src/client/rpc-ws-status.test.ts	Adds a test verifying mode close() closes the underlying socket.
packages/devframe/src/client/rpc-static.ts	Implements close() as a no-op for static mode.
packages/devframe/src/client/rpc-auth-gate.test.ts	Updates the mocked mode to satisfy the new required close() property.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Copilot reviewed 8 out of 9 changed files in this pull request and generated no new comments.

Suppressed comments (1)

packages/devframe/src/client/rpc.ts:210

• The JSDoc rationale for why DevframeRpcClient.close is optional points at DevframeRpcClientMode implementations predating the method, but that rationale actually applies to DevframeRpcClientMode.close (and/or older DevframeRpcClient mocks), not specifically to the DevframeRpcClient property itself. Rewording this section would make the public API docs less confusing, especially since getDevframeRpcClient() always attaches a close function and treats a missing mode.close as a no-op.

   * Optional so a `DevframeRpcClientMode` implemented before this method existed — a custom
   * transport, a hand-typed mock — still satisfies the interface; an absent `close` is treated
   * as nothing to close.
   */