Migration guide and changelog for v0.15.0

[Totodore]

Migration Guide

With v0.15.0, multiple breaking changes have been introduced. Here is a little migration guide to help migrating from v0.14 to v0.15.

Packet parsing system reworked

The new system is more optimized and allows you to emit !Sized data such as reference:

#[serde::Serialize]
struct Data<'a> {
  data: &'a str,
  index: usize
}
let data = Data {
  data: "test",
  index: 3
}
socket.emit(&data)?;

In case of emit error it means that you can keep your data and try to resend it rather than loosing its ownership.
You can also now directly specify binary data inside your structs when emitting and receiving data:

#[serde::Serialize]
struct Data<'a> {
  data: &'a str,
  index: usize,
  buffer: Bytes
}
let data = Data {
  data: "test",
  index: 3,
  buffer: my_image  // Will be received on the other side as the same object
}
socket.emit(&data)?; 

Changelog

socketioxide

• (Breaking): New parsing system. You can now serialize and deserialize binary data inside your own types.
  It also improve performances by avoiding unnecessary allocations.
• fix: missing extractor error logs for async message handlers.
• feat: add custom compiler error for unimplemented handler traits.
• deps: switch from tower to tower-service and tower-layer subcrates.
• deps: bump tokio to 1.40.
• deps: bump http to 1.1.
• deps: bump hyper to 1.5.

What's Changed

• chore(deps): bump micromatch from 4.0.5 to 4.0.8 in /examples/react-rooms-chat/client by @dependabot in chore(deps): bump micromatch from 4.0.5 to 4.0.8 in /examples/react-rooms-chat/client #364
• chore(deps): bump micromatch from 4.0.5 to 4.0.8 in /examples/loco-rooms-chat/client by @dependabot in chore(deps): bump micromatch from 4.0.5 to 4.0.8 in /examples/loco-rooms-chat/client #365
• chore(deps-dev): bump vite from 5.0.13 to 5.4.6 in /examples/react-rooms-chat/client by @dependabot in chore(deps-dev): bump vite from 5.0.13 to 5.4.6 in /examples/react-rooms-chat/client #368
• chore(ci): switch from node v16 to node v22 for e2e testing by @Totodore in chore(ci): switch from node v16 to node v22 for e2e testing #371
• chore(deps-dev): bump vite from 5.0.13 to 5.4.7 in /examples/loco-rooms-chat/client by @dependabot in chore(deps-dev): bump vite from 5.0.13 to 5.4.7 in /examples/loco-rooms-chat/client #370
• chore(deps): update tokio-tungstenite requirement from 0.23.0 to 0.24.0 by @dependabot in chore(deps): update tokio-tungstenite requirement from 0.23.0 to 0.24.0 #367
• feat(socketio/parser): Refactor socketioxide parsing by @Totodore in Refactor socketioxide parsing #376
• chore(deps): bump deps and switch to tower-layer and tower-service rather than tower by @Totodore in chore: bump deps and switch to tower-layer and tower-service rather than tower #379
• fix(socketio/handler): trace extractor errors by @Totodore in fix(socketio/handler): trace extractor errors #380
• feat(socketio/handler): Add custom errors for unimplemented handlers by @Totodore in Add custom errors for unimplemented handlers #381
• doc(socketio): improve extractor docs by @Totodore in doc(socketio): improve extractor docs #382
• chore(deps): prepare v0.15.0 by @Totodore in chore(deps): prepare v0.15.0 #383

Full Changelog: v0.14.1...v0.15.0

---

This discussion was created from the release v0.15.0.