supabase / supabase-flutter / 32821305408

89%

Build Type

push

github

Committed by web-flow

Commit Message

refactor(realtime)!: make RealtimeClient internal mutable fields private (#1758)

## What kind of change does this PR introduce?

Breaking change for v3, implementing
[SDK-818](https://linear.app/supabase/issue/SDK-818/breakingrealtime-make-realtimeclient-internal-mutable-fields-private).

## What is the current behavior?

`RealtimeClient` exposes its internal state machine as public mutable
fields: external code can mutate `channels` directly (bypassing all
lifecycle management), reset `ref`, cancel `heartbeatTimer` or
`reconnectTimer`, overwrite `connection`/`connectionState`, and reassign
`accessToken` without the token propagating to joined channels.

## What is the new behavior?

The internals are private and the remaining public surface is read-only,
with mutation going through intentional paths only:

- `channels` is an unmodifiable view; channels are added with
`channel()` and removed with `removeChannel()`/`removeAllChannels()`.
- `accessToken` is a getter; token rotation goes through
`setAccessToken()`, which also propagates the token to every joined
channel (a raw setter would silently skip that, so the ticket's proposed
setter was intentionally not added).
- `heartbeatInterval`, `customAccessToken` and `reconnectAfter` are
final and settable only via the constructor. `RealtimeClientOptions`
gains `heartbeatInterval` and `reconnectAfter` so a client managed by
`SupabaseClient` keeps those knobs, and the `TimerCalculation` typedef
plus `RealtimeConstants.defaultHeartbeatInterval` are exported to
support them.
- `connection` and `connectionState` are read-only getters with no
setters at all; the tests that used to fake socket state now drive the
real `connect()` flow through the mocked transport.
- `ref`, `pendingHeartbeatRef`, `heartbeatTimer`, `reconnectTimer` and
`sendBuffer` are private. The few read accessors tests still need (plus
the `ref` setter for the overflow test, which has no transport-driven
equivalent) are kept behind `@interna... (continued)

Coverage Stats

59 of 60 new or added lines in 2 files covered. (98.33%)

14 existing lines in 2 files now uncovered.

5978 of 6749 relevant lines covered (88.58%)

4.44 hits per line