Issue: Browser WebSocket Converts Binary Data to Blob
Description
When using @open-rpc/client-js with a WebSocketTransport in a browser environment, binary data sent from the server is received as a Blob. This behavior causes issues when trying to process the payload in resolveResponse with JSON.parse(payload), as Blob cannot be directly parsed into JSON.
In contrast, when using the library in a Node.js environment, the WebSocket receives binary data as a Buffer, which can be directly passed to JSON.parse to obtain the desired object.
Expected Behavior
The library should handle WebSocket messages consistently across browser and Node.js environments. Binary data sent from the server should be correctly converted into a string or JSON object, regardless of whether the client is running in a browser or Node.js.
Actual Behavior
In the browser:
- Binary data sent from the server is received as a
Blob.
- The
Blob cannot be directly processed by JSON.parse.
In Node.js:
- Binary data is received as a
Buffer.
- The
Buffer can be successfully processed by JSON.parse.
Steps to Reproduce
- Use
@open-rpc/client-js with WebSocketTransport in a browser.
- Connect to a WebSocket server that sends JSON-RPC notifications as binary data.
- Observe that the incoming data is a
Blob and cannot be processed by JSON.parse.
Proposed Solution
- Modify the
WebSocketTransport implementation to detect when incoming messages are Blob objects in the browser.
- Convert the
Blob to a string using Blob.text() or a similar method before passing it to JSON.parse.
Environment
@open-rpc/client-js version: 1.8.1- Browser: Brave Version 1.73.105 Chromium: 131.0.6778.265 (Official Build) (64-bit)
- Node.js version: 22.11
- Operating System: Ubuntu 24.04.1 LTS
Additional Context
This discrepancy between browsers and Node.js arises because the browser WebSocket implementation defaults to converting binary data into Blob, while Node.js treats it as a Buffer.
It would be great if the library could handle this scenario internally to ensure consistent behavior across environments.
Issue: Browser WebSocket Converts Binary Data to Blob
Description
When using
@open-rpc/client-jswith aWebSocketTransportin a browser environment, binary data sent from the server is received as aBlob. This behavior causes issues when trying to process the payload inresolveResponsewithJSON.parse(payload), asBlobcannot be directly parsed into JSON.In contrast, when using the library in a Node.js environment, the WebSocket receives binary data as a
Buffer, which can be directly passed toJSON.parseto obtain the desired object.Expected Behavior
The library should handle WebSocket messages consistently across browser and Node.js environments. Binary data sent from the server should be correctly converted into a string or JSON object, regardless of whether the client is running in a browser or Node.js.
Actual Behavior
In the browser:
Blob.Blobcannot be directly processed byJSON.parse.In Node.js:
Buffer.Buffercan be successfully processed byJSON.parse.Steps to Reproduce
@open-rpc/client-jswithWebSocketTransportin a browser.Bloband cannot be processed byJSON.parse.Proposed Solution
WebSocketTransportimplementation to detect when incoming messages areBlobobjects in the browser.Blobto a string usingBlob.text()or a similar method before passing it toJSON.parse.Environment
@open-rpc/client-jsversion: 1.8.1Additional Context
This discrepancy between browsers and Node.js arises because the browser WebSocket implementation defaults to converting binary data into
Blob, while Node.js treats it as aBuffer.It would be great if the library could handle this scenario internally to ensure consistent behavior across environments.