supabase / supabase-flutter / 39775457039

92%

Build Type

push

github

Committed by web-flow

Commit Message

feat(supabase)!: typed stream order() takes a PostgrestOrdering like the typed query (#2010)

## Summary

The typed stream spelled ordering differently from the typed query:

```dart
// Typed query
supabase.table(Books.table).select().order(Books.createdAt.desc());

// Typed stream, before
supabase
    .table(Books.table)
    .stream(primaryKey: [Books.id])
    .order(Books.createdAt, ascending: false);
```

`SupabaseTypedStreamBuilder.order()` now takes the same
`PostgrestOrdering<Row>` as `PostgrestTypedTransformBuilder.order()`,
for both `stream()` and `streamOnly()`:

```dart
supabase
    .table(Books.table)
    .stream(primaryKey: [Books.id])
    .order(Books.createdAt.desc());
```

A bare column (`.order(Books.title)`) still sorts ascending. Orderings a
stream cannot keep while it merges realtime changes throw an
`ArgumentError`:

- a null placement (`nullsFirst()`/`nullsLast()`), since the stream
always places `null` last ascending and first descending
- an ordering by anything but a stored column, such as a computed field,
a cast or an embedded column, since the stream sorts by a key in each
row

## Implementation

`PostgrestOrdering` previously held only the rendered key string. It now
keeps its column expression, and has `@internal` `column`, `direction`
and `placesNullsFirst` getters that the stream builder reads, the same
way the stream filter reads `PostgrestFilter.comparison`. The rendered
`orderKey` does not change.

## Breaking change

The `ascending` parameter of the typed stream `order()` is gone.
`MIGRATION.md` ("Realtime streams" in the typed table API section) now
shows the `ascending: false` to `.desc()` conversion and lists the
rejected orderings. The same paragraph also no longer says that `not()`
throws on a stream filter, since negated filters are supported.

Resolves SDK-2331


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

<!-- coderabbit-ai-generated:v1 -->

## Summary by CodeRabbit

- **New Fe... (continued)

Coverage Stats

19 of 26 new or added lines in 3 files covered. (73.08%)

10 existing lines in 2 files now uncovered.

10705 of 11666 relevant lines covered (91.76%)

5.39 hits per line