supabase / supabase-flutter / 37280549742

92%

Build Type

push

github

Committed by web-flow

Commit Message

feat(supabase)!: add negated filters and column selection to stream() (#1909)

## What kind of change does this PR introduce?

Feature. Brings the remaining parts of the Realtime server's [Postgres
Changes filters and column
selection](https://supabase.com/blog/postgres-changes-filters-and-column-selection)
to `stream()`, on the untyped and the typed surface.

Closes #338. Several AND-combined filters and the new operators already
reached `stream()` in #1610, and `RealtimeChannel.onPostgresChanges`
already takes `filters`, `select` and `PostgresChangeFilter.negate`.

## What is the current behavior?

- `stream()` cannot negate a filter: there is no `not` on
`SupabaseStreamFilterBuilder`, and the typed `filter()` rejects
`Books.status.inFilter([...]).not()` because
`PostgrestFilter.comparison` is `null` for a negated node.
- `stream()` always selects `*` from PostgREST and receives full rows
over Realtime; `select` cannot be passed through.

## What is the new behavior?

- `SupabaseStreamFilterBuilder.not(column, type, value)` sends
`column=not.<op>.value` to Realtime and `column=not.<op>.value` to
PostgREST, combined with the other filters as before.
- `PostgrestComparison.negated` reports a `not()` around a single
comparison, so the typed `filter()` accepts `Books.status.eq('x').not()`
and forwards it the same way. Composed filters (`&`, `|`) are still
rejected.
- `stream(primaryKey: [...], select: [...])` restricts the initial
snapshot and every change payload to the listed columns. The primary key
columns are always added, since the stream matches change payloads to
rows by them.
- The typed `streamOnly(primaryKey: [...], columns: [...])` mirrors
`selectOnly` and resolves to `List<PostgrestPartialRow<Row>>`, so a
column that was left out cannot be read by mistake. For that,
`SupabaseTypedStreamBuilder` and `SupabaseTypedStreamFilterBuilder` gain
an `Element` type parameter next to `Row`, the way the postgrest typed
builders carry `Result`. The type... (continued)

Coverage Stats

82 of 85 new or added lines in 8 files covered. (96.47%)

41 existing lines in 4 files now uncovered.

9224 of 10093 relevant lines covered (91.39%)

5.13 hits per line