[heilhead]

Description

Resolves WCN2-110.

Adds wc_websocket crate with serialization, heartbeat (keep-alive) support, idle timeout (detect disconnects), and observer support for integrating with metrics etc. Includes adapters for warp, axum and tungstenite.

The Observer and DataCodec interfaces are designed around the primary use case (server side of the Relay) to be able to integrate various inbound, outbound and latency metrics.

How Has This Been Tested?

Tests covering serialization, transport disconnect, message codecs, heartbeats and timeouts.

Due Diligence

• Breaking change
• Requires a documentation update
• Requires a e2e/integration test update

[linear]

WCN2-110 Extract common WebSocket logic to a shared crate

[chris13524]

I don't understand why relay needs an abstraction layer for this. Doesn't the relay just use 1 library at a time?

[heilhead]

I don't understand why relay needs an abstraction layer for this. Doesn't the relay just use 1 library at a time?

The point of having this abstraction is not multiple backends supoprt. It's to extract the common logic of serialization, observers, heartbeats and idle timeout. All of these are hard to test and ensure correctness with the current relay websocket handling code.

Lately, every minor feature that touches the transport layer in the relay (e.g. binary encoding support, request in query, batch requests etc) is impossible to integrate in a clean and testable way. It's time to refactor the transport layer, and while doing it, extract common logic like heartbeats and properly cover it with tests.

[heilhead]

@xDarksome I've updated the PR with what we've discussed.

Additionally:

• Renamed the crate wc_websocket -> websocket, as the only crate using the wc_* prefix is wc_metrics.
• Removed Cargo.lock, as we don't need it in the library code.