supabase / supabase-flutter / 40305369626

94%

push

github

fix(realtime)!: reject invalid broadcast payloads in release builds and document that v2 and v3 broadcasts are incompatible (#2051)

Linear:
https://linear.app/supabase/issue/SDK-2375/docsrealtime-document-reading-broadcasts-from-v2-clients-after-the

#2036 moved broadcast data under `payload`. Apps built with v2 still
send it at the top level, and v2 listeners read it from there, so v2 and
v3 clients on the same channel cannot read each other's broadcasts.

## Changes

- **MIGRATION.md**: the "Broadcast data arrives under `payload`" section
now says that v2 and v3 clients cannot read each other's broadcasts, in
both directions, and that every app sharing a channel should move to v3
together.
- **`examples/realtime_room`**: the typing stream reads the username
only from `payload` and skips a ping without one, such as a ping from a
v2 app, instead of throwing a `NoSuchMethodError` inside the stream. A
new widget test sends a v2-shaped ping followed by a v3 one and expects
only the v3 sender in the indicator.
- **Realtime skill**: one sentence saying the two shapes are
incompatible. Skills regenerated with `melos run sync-skills`.
- **`sendBroadcastMessage()` and `httpSend()`**: a payload that is
neither a map nor binary data now completes the returned future with an
`ArgumentError` in every build mode. Before, only a debug `assert`
checked it, so a release build sent `payload: 'text'` anyway. Any `Map`
is accepted, not only `Map<String, dynamic>`, so a platform channel
result (`Map<Object?, Object?>`) that release builds used to send keeps
working. The error names the runtime type only, not the payload value.
This change has its own MIGRATION.md section. Tests cover both methods
and an untyped map.

## Decisions

- **No v2 fallback in v3.** The ticket asked for docs showing how to
read both shapes. A v3 listener can fall back to the top level, but
nothing on the v3 side lets a v2 listener read a v3 message. A fallback
that only covers one direction sug... (continued)

10 of 10 new or added lines in 1 file covered. (100.0%)

12077 of 12839 relevant lines covered (94.06%)

6.21 hits per line