• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

supabase / supabase-py / 41641760894 / 20
98%
main: 98%

Build:
DEFAULT BRANCH: main
Ran 03 Nov 2026 01:12PM UTC
Files 22
Run time 0s
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst

03 Nov 2026 01:08PM UTC coverage: 96.918%. Remained the same
41641760894.20

push

github

web-flow
fix(realtime): deprecate channel.join() and route it through subscribe (#1928)

Fixes SDK-2673.

## Problem

`AsyncRealtimeChannel.join()` built `{"config": {...}}` and then sent it
wrapped again as `payload={"config": config_payload}`, so the server
received `{"config": {"config": {...}}}`. It also omitted `access_token`
(required for private channels) and sent a raw message instead of going
through `join_push`, so there was no join timeout, no rejoin, no
subscribe callback handling and no channel state change.

## Change

`join()` is now deprecated. It emits a `DeprecationWarning` through
`warnings.warn(..., stacklevel=2)`, the mechanism storage, postgrest and
functions use, and delegates to `subscribe()`, so callers get the same
correct join payload and lifecycle. It still returns the channel. The
method is kept to avoid a breaking change and can be removed in the next
major version.

Why deprecate instead of fixing the payload in place:

- realtime-js has no public `join` equivalent on `RealtimeChannel`;
`subscribe()` is the only public way to join.
- Nothing in this repo, its READMEs or docs calls `channel.join()`.
- A fixed `join()` would just duplicate `subscribe()`.

Behavior notes:

- Since `join()` now goes through `subscribe()`, it connects the socket
if needed.
- If the channel was already joined or subscribed, `join()` returns the
channel without sending anything. It does not raise the "subscribe
multiple times" error that a second `subscribe()` raises, because the
old `join()` could be called repeatedly without raising.

`join()` is not listed in `sdk-compliance.yaml` or any docs, so nothing
else needed updating. `realtime` is async-only, so there is no `_sync`
counterpart.

The ticket mentions a strict `xfail` test,
`test_join_sends_channel_config` in `test_channel_internals.py`, from
SDK-2666. That file is not on `main` yet. When it lands, that test
should be rewritten to match the deprecation (or dropped in favor of the
tests here).

... (continued)

849 of 876 relevant lines covered (96.92%)

0.97 hits per line

Source Files on job run-ubuntu-latest-3.14-supabase - 41641760894.20
  • Tree
  • List 22
  • Changed 0
  • Source Changed 0
  • Coverage Changed 0
Coverage ∆ File Lines Relevant Covered Missed Hits/Line
  • Back to Build 41641760894
  • 8ac936cc on github
  • Prev Job for on main (#41641729152.3)
  • Next Job for on main (#41641867822.1)
  • Delete
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE TRIAL · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc