Skip to content

v0.3.0
Compare
Choose a tag to compare
@pi0 pi0 released this 04 Sep 20:14
· 14 commits to main since this release
v0.3.0
4a5e168

compare changes

Important

Since this is a major version, ecosystem migration takes time. Stay tuned for listhen, h3 and nitro dependency upgrades.

🌟 What is new?

Better stability

Crossws 0.3.x includes an overhaul of refactors, stability improvements, and new features. A new codebase and testing matrix had been implemented (#55) to make sure all supported adapters and runtimes work as expected and are consistent with each other.

Refined Peer API

The peer object allows easy interaction with connected WebSocket clients from server route hooks (peer docs).

To improve Web standards compatibility, accessing upgrade URL and headers is now possible with peer.request.url and peer.request.headers (breaking change), and peer.addr is also renamed to peer.remoteAddress to improve readability (breaking change) and support is increased across providers. You can also use new lazy-generated and secure peer.id (UUID v4) for various purposes including temporary sessions or persistent state.

Two new methods are now supported to close connected peers using peer.close(code, reason) and peer.terminate(). With this new version, you can access a standard WebSocket interface using peer.websocket.

Note

Today many of the server runtimes don't provide a spec-compliant WebSocket API. Crossws uses an internal proxy to polyfill consistent access to extensions, protocol, and readyState. See compatibility table for more details.

Refined Message API

On message hook, you receive a message object containing data from the client (message docs).

Parsing incoming messages can be tricky across runtimes. Message object now has stable methods .text(), .json(), .uint8Array(), .arrayBuffer(), .blob() to safely read message as desired format. If you need, you can also access .rawData, .peer, .event (if available), and lazy generated secure UUID v4 .id

Authentication via upgrade hook

When you need to authenticate and validate WebSocket clients before they can upgrade, you can now easily use the upgrade hook to check incoming URLs and headers/cookies and return a Web Standard Response in case you need to abort the upgrade.

Pubsub with Deno and Cloudflare Durable Objects

One of the common use cases of WebSockets is pubsub. This release adds pub-sub support to Deno provider and also you can globally broadcast messages using ws.publish for advanced use cases.

Normally with cloudflare workers, it is not possible to connect multiple peers with each other. Cloudflare Durable Objects (available on paid plans) allows building collaborative editing tools, interactive chat, multiplayer games, and applications that need coordination among multiple clients.

Crossws provides a new composable method to easily integrate WebSocket handlers with Durable Objects. Hibernation is supported out of the box to reduce billing costs when connected clients are inactive. (durable object peer docs)

Changelog

🚀 Enhancements

  • ⚠️ Overhaul internal implementation (#55)
  • ⚠️ Overhaul peer and message interface (#70)
  • node, uws: Automatically detect binary message type (#53)
  • peer: Add peer.close() and peer.terminate() support (#36)
  • Cloudflare durable objects support (#54) (docs)
  • deno: Support pub/sub (#58)
  • Universal access to all peers (#60)
  • Global publish using ws.publish (#61)
  • Experimental SSE-based adapter to support websocket in limited runtimes (#62, #66, #68) (docs
  • peer: Use secure lazy random UUID v4 (#64)

🩹 Fixes

  • Should not serailize binary messages (#39)
  • cloudflare-durable: Restore peer url and id after hibernation (#71)

💅 Refactors

  • ⚠️ Move peer.ctx to peer._internal (#59)
  • ⚠️ Remove adapter hooks (#72)
  • Rename internal crossws to hooks (bb4c917)
  • Better internal organization (2744f21)

📖 Documentation

#22, 76fc105, 7dacb00, #46, #45, #44, a96dca3, 898ab49, 2e49cc3

📦 Build

  • Remove optional uWebSockets.js dependency (#52, b23b76d)
  • ⚠️ Esm-only build (#63)

✅ Tests

  • Add adapter tests (#56)
  • cloudflare: Use random port for wrangler inspector (a46265c)
  • Run tests with web standard WebSocket and EventSource (#67)

❤️ Contributors

Contributors

beer
Assets 2
Loading