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

supabase / supabase-py / 41641760894
98%

Build:
DEFAULT BRANCH: main
Ran 03 Nov 2026 01:09PM UTC
Jobs 30
Files 175
Run time 1min
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.967% (+0.06%) from 96.91%
41641760894

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)

13364 of 13782 relevant lines covered (96.97%)

5.01 hits per line

Coverage Regressions

Lines Coverage ∆ File
6
94.86
2.5% src/realtime/_async/channel.py
Jobs
ID Job ID Ran Files Coverage
1 run-ubuntu-latest-3.11-storage - 41641760894.1 03 Nov 2026 01:10PM UTC 42
96.09
GitHub Action Run
2 run-ubuntu-latest-3.15-postgrest - 41641760894.2 03 Nov 2026 01:10PM UTC 39
97.82
GitHub Action Run
3 run-ubuntu-latest-3.14-postgrest - 41641760894.3 03 Nov 2026 01:10PM UTC 39
97.82
GitHub Action Run
4 run-ubuntu-latest-3.12-supabase - 41641760894.4 03 Nov 2026 01:09PM UTC 22
96.93
GitHub Action Run
5 run-ubuntu-latest-3.13-auth - 41641760894.5 03 Nov 2026 01:09PM UTC 61
96.37
GitHub Action Run
6 run-ubuntu-latest-3.15-functions - 41641760894.6 03 Nov 2026 01:09PM UTC 18
97.98
GitHub Action Run
7 run-ubuntu-latest-3.11-functions - 41641760894.7 03 Nov 2026 01:09PM UTC 18
97.98
GitHub Action Run
8 run-ubuntu-latest-3.13-realtime - 41641760894.8 03 Nov 2026 01:10PM UTC 17
94.21
GitHub Action Run
9 run-ubuntu-latest-3.15-supabase - 41641760894.9 03 Nov 2026 01:09PM UTC 22
96.92
GitHub Action Run
10 run-ubuntu-latest-3.12-postgrest - 41641760894.10 03 Nov 2026 01:10PM UTC 39
97.83
GitHub Action Run
11 run-ubuntu-latest-3.13-storage - 41641760894.11 03 Nov 2026 01:10PM UTC 42
96.09
GitHub Action Run
12 run-ubuntu-latest-3.15-realtime - 41641760894.12 03 Nov 2026 01:10PM UTC 17
93.84
GitHub Action Run
13 run-ubuntu-latest-3.11-postgrest - 41641760894.13 03 Nov 2026 01:10PM UTC 39
97.83
GitHub Action Run
14 run-ubuntu-latest-3.12-auth - 41641760894.14 03 Nov 2026 01:10PM UTC 61
96.37
GitHub Action Run
15 run-ubuntu-latest-3.11-auth - 41641760894.15 03 Nov 2026 01:10PM UTC 61
96.37
GitHub Action Run
16 run-ubuntu-latest-3.11-realtime - 41641760894.16 03 Nov 2026 01:11PM UTC 17
94.3
GitHub Action Run
17 run-ubuntu-latest-3.13-functions - 41641760894.17 03 Nov 2026 01:09PM UTC 18
97.98
GitHub Action Run
18 run-ubuntu-latest-3.13-supabase - 41641760894.18 03 Nov 2026 01:09PM UTC 22
96.93
GitHub Action Run
19 run-ubuntu-latest-3.15-storage - 41641760894.19 03 Nov 2026 01:12PM UTC 42
96.08
GitHub Action Run
20 run-ubuntu-latest-3.14-supabase - 41641760894.20 03 Nov 2026 01:09PM UTC 22
96.92
GitHub Action Run
21 run-ubuntu-latest-3.13-postgrest - 41641760894.21 03 Nov 2026 01:10PM UTC 39
97.83
GitHub Action Run
22 run-ubuntu-latest-3.12-functions - 41641760894.22 03 Nov 2026 01:09PM UTC 18
97.98
GitHub Action Run
23 run-ubuntu-latest-3.12-realtime - 41641760894.23 03 Nov 2026 01:10PM UTC 17
94.21
GitHub Action Run
24 run-ubuntu-latest-3.12-storage - 41641760894.24 03 Nov 2026 01:10PM UTC 42
96.09
GitHub Action Run
25 run-ubuntu-latest-3.14-realtime - 41641760894.25 03 Nov 2026 01:10PM UTC 17
93.84
GitHub Action Run
26 run-ubuntu-latest-3.11-supabase - 41641760894.26 03 Nov 2026 01:09PM UTC 22
96.93
GitHub Action Run
27 run-ubuntu-latest-3.14-auth - 41641760894.27 03 Nov 2026 01:10PM UTC 61
96.36
GitHub Action Run
28 run-ubuntu-latest-3.15-auth - 41641760894.28 03 Nov 2026 01:10PM UTC 61
96.36
GitHub Action Run
29 run-ubuntu-latest-3.14-storage - 41641760894.29 03 Nov 2026 01:10PM UTC 42
96.08
GitHub Action Run
30 run-ubuntu-latest-3.14-functions - 41641760894.30 03 Nov 2026 01:09PM UTC 18
97.98
GitHub Action Run
Source Files on build 41641760894
  • Tree
  • List 175
  • Changed 1
  • Source Changed 0
  • Coverage Changed 1
Coverage ∆ File Lines Relevant Covered Missed Hits/Line
  • Back to Repo
  • Github Actions Build #41641760894
  • 8ac936cc on github
  • Prev Build on main (#41641729152)
  • Next Build on main (#41641867822)
  • 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