Skip to content

Commit 7aa0bc8

Browse files
committed
docs(uts): proxy supports both JSON and msgpack, not text frames only
uts-proxy v0.3.0 (ably/uts-proxy#4) derives a WebSocket message's encoding from the `format` query parameter — matching the Ably server — rather than from the WebSocket frame type. The proxy can therefore decode and match both JSON and msgpack messages, including SDKs (e.g. ably-java) that send JSON payloads over binary WebSocket frames.
1 parent 8a8fbff commit 7aa0bc8

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

uts/docs/integration-testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ Only tests on the **data path** need both protocols. These are tests where messa
246246

247247
Tests for **connection lifecycle**, **authentication**, **channel attach/detach**, and other protocol-agnostic behaviours do not need protocol variants. These tests exercise control-plane operations whose correctness does not depend on the wire encoding of message payloads.
248248

249-
**Proxy tests always use JSON.** The proxy only supports text WebSocket frames, so proxy-based tests cannot use msgpack.
249+
**Proxy tests may use either protocol.** As of [uts-proxy v0.3.0](https://github.com/ably/uts-proxy/pull/4), the proxy determines a WebSocket message's encoding from the `format` query parameter — matching the Ably server — instead of from the WebSocket frame type (text vs binary). It can therefore decode and match both JSON and msgpack messages, including SDKs that send JSON payloads over binary frames. Proxy data-path tests should follow the `## Protocol Variants` convention below; pin a test to JSON only when the SDK under test does not implement msgpack.
250250

251251
### Spec file convention
252252

0 commit comments

Comments
 (0)