supabase / supabase-py / 41470126133
94%

DEFAULT BRANCH: main
Ran
Jobs 36
Files 166
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
coverage: 95.283%. Remained the same
41470126133

push

github

web-flow 
fix(realtime): default postgres_changes schema to public (#1884)

Fixes #1883.

`on_postgres_changes()` documents `schema` as defaulting to `"public"`,
but the join payload left `schema` out when it was not passed. The
Realtime server's `parse_subscription_params/1` only accepts a binding
without `schema` when it is table-only with no filter, so calls like
`on_postgres_changes("*", cb)` and `on_postgres_changes("INSERT", cb,
table="todos", filter="id=eq.1")` were rejected with "No subscription
params provided...".

## What changed

- `PostgresChangesCallback` now sets `schema` to `"public"` when it is
not given (in `__post_init__`), and `binding_filter` always sends
`schema`.
- Because the default is stored on the callback itself, the join reply
check in `channel.py` compares the server's echoed `schema: "public"`
against `"public"` instead of `None`. Without this, every schemaless
subscription failed with "mismatch between server and client bindings
for postgres changes" and the channel unsubscribed itself.
- `table` is still omitted when not passed. With `schema` present, the
server treats a missing `table` as `"*"`, which matches the docstring.
Calls that pass `schema` send the same payload as before.

## Tests

- `test_subscribe_defaults_postgres_changes_schema_to_public` checks the
`phx_join` payload for both shapes above.
- `test_subscribe_accepts_server_echo_of_default_schema` feeds the
server's echoed reply back into the channel and asserts it reaches
`SUBSCRIBED` with the server's binding id. It fails on the payload-only
fix with the binding mismatch error.
- `test_postgres_changes_callback_binding_filter_includes_select` now
expects `"schema": "public"`.
- `make realtime.tests` against the local Supabase infrastructure passes
(mypy clean, 60 tests), including the `test_postgrest_changes`
integration tests that subscribe with `table` only.

## Notes

The `v3` branch has the same `if self.schema:` conditional in
`src/realtime/src/realtime/type... (continued)

12201 of 12805 relevant lines covered (95.28%)

5.91 hits per line

Coverage Regressions

Lines Coverage ∆ File
5
96.97
0.02% src/realtime/types.py
Jobs
ID Job ID Ran Files Coverage
1 run-ubuntu-latest-3.14-postgrest - 41470126133.1 39
97.5
GitHub Action Run
2 run-ubuntu-latest-3.10-auth - 41470126133.2 56
93.64
GitHub Action Run
3 run-ubuntu-latest-3.10-storage - 41470126133.3 40
94.75
GitHub Action Run
4 run-ubuntu-latest-3.12-functions - 41470126133.4 18
97.31
GitHub Action Run
5 run-ubuntu-latest-3.9-realtime - 41470126133.5 17
88.81
GitHub Action Run
6 run-ubuntu-latest-3.12-postgrest - 41470126133.6 39
97.51
GitHub Action Run
7 run-ubuntu-latest-3.13-auth - 41470126133.7 56
93.68
GitHub Action Run
8 run-ubuntu-latest-3.10-postgrest - 41470126133.8 39
97.51
GitHub Action Run
9 run-ubuntu-latest-3.14-supabase - 41470126133.9 20
96.85
GitHub Action Run
10 run-ubuntu-latest-3.10-realtime - 41470126133.10 17
88.7
GitHub Action Run
11 run-ubuntu-latest-3.14-realtime - 41470126133.11 17
87.88
GitHub Action Run
12 run-ubuntu-latest-3.9-supabase - 41470126133.12 20
96.8
GitHub Action Run
13 run-ubuntu-latest-3.13-supabase - 41470126133.13 20
96.86
GitHub Action Run
14 run-ubuntu-latest-3.12-auth - 41470126133.14 56
93.68
GitHub Action Run
15 run-ubuntu-latest-3.13-postgrest - 41470126133.15 39
97.51
GitHub Action Run
16 run-ubuntu-latest-3.13-storage - 41470126133.16 40
94.75
GitHub Action Run
17 run-ubuntu-latest-3.13-functions - 41470126133.17 18
97.31
GitHub Action Run
18 run-ubuntu-latest-3.11-realtime - 41470126133.18 17
88.7
GitHub Action Run
19 run-ubuntu-latest-3.9-functions - 41470126133.19 18
97.52
GitHub Action Run
20 run-ubuntu-latest-3.9-postgrest - 41470126133.20 39
97.56
GitHub Action Run
21 run-ubuntu-latest-3.12-storage - 41470126133.21 40
94.75
GitHub Action Run
22 run-ubuntu-latest-3.10-functions - 41470126133.22 18
97.31
GitHub Action Run
23 run-ubuntu-latest-3.11-postgrest - 41470126133.23 39
97.51
GitHub Action Run
24 run-ubuntu-latest-3.11-storage - 41470126133.24 40
94.75
GitHub Action Run
25 run-ubuntu-latest-3.11-functions - 41470126133.25 18
97.31
GitHub Action Run
26 run-ubuntu-latest-3.13-realtime - 41470126133.26 17
88.7
GitHub Action Run
27 run-ubuntu-latest-3.12-realtime - 41470126133.27 17
88.7
GitHub Action Run
28 run-ubuntu-latest-3.12-supabase - 41470126133.28 20
96.86
GitHub Action Run
29 run-ubuntu-latest-3.14-auth - 41470126133.29 56
93.66
GitHub Action Run
30 run-ubuntu-latest-3.11-auth - 41470126133.30 56
93.64
GitHub Action Run
31 run-ubuntu-latest-3.14-functions - 41470126133.31 18
97.31
GitHub Action Run
32 run-ubuntu-latest-3.11-supabase - 41470126133.32 20
96.86
GitHub Action Run
33 run-ubuntu-latest-3.9-storage - 41470126133.33 40
94.82
GitHub Action Run
34 run-ubuntu-latest-3.10-supabase - 41470126133.34 20
96.86
GitHub Action Run
35 run-ubuntu-latest-3.14-storage - 41470126133.35 40
94.74
GitHub Action Run
36 run-ubuntu-latest-3.9-auth - 41470126133.36 56
93.59
GitHub Action Run
Source Files on build 41470126133