Rework the way messages are exchanged between server and client (msgpack + chunking)

Kitware / wslink

Python/JavaScript library for communicating over WebSocket

https://kitware.github.io/wslink/

BSD 3-Clause "New" or "Revised" License

83 stars 26 forks source link

Closed alesgenova closed 6 months ago

alesgenova commented 6 months ago

Use msgpack for serialization of the messages between server and client
- slightly reduced message size
- binary values can directly be in the object serialized/deserialized (no need to use previous attachment mechanism)
Chunk messages
- avoids the websocket connection to close unexpectedly when a large message is exchanged
- use existing environmental variable WSLINK_MAX_MSG_SIZE to determine the chunk size

jourdain commented 6 months ago

I haven't looked at the code yet. But make sure your commit is marked with BREAKING CHANGE: ....

jourdain commented 6 months ago

Tested and it looks good

jourdain commented 6 months ago

:tada: This PR is included in version 2.0.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket: