supabase / supabase-flutter / 39780106395

93%

Build Type

push

github

Committed by web-flow

Commit Message

feat(supabase)!: reject unsupported typed stream orderings at compile time (#2014)

## Summary

Follow-up to #2010. The typed stream `order()` took any
`PostgrestOrdering`, so orderings a stream cannot honour compiled and
only threw an `ArgumentError` when the stream was built:

```dart
supabase
    .table(Books.table)
    .stream(primaryKey: [Books.id])
    .order(Books.price.desc().nullsLast()); // compiled, threw at runtime
```

The old `PostgrestStoredColumn` parameter made these compile errors.
This PR does the same again, without going back to the `ascending`
argument.

## Changes

- **New `PostgrestColumnOrdering<Row>`**, a subtype of
`PostgrestOrdering<Row>` that is an ordering by a stored column with at
most a direction. Every stored column is one, and its `asc()`/`desc()`
return one.
- **Plain `PostgrestOrdering<Row>`** is still what you get from
`nullsFirst()`/`nullsLast()` and from every non-stored expression
(computed fields, casts, JSON paths, embedded columns).
- **`SupabaseTypedStreamBuilder.order()`** now takes a
`PostgrestColumnOrdering<Row>`, and both `ArgumentError` checks are
gone. `PostgrestTypedTransformBuilder.order()` still takes
`PostgrestOrdering<Row>`, so queries accept everything they did before.
- **Internal getters** that the stream reads (`column`, `direction`) now
live on `PostgrestColumnOrdering` only. `PostgrestOrdering` no longer
has them, so they no longer show up in autocomplete on computed fields,
casts or orderings with a null placement.

```dart
stream.order(Books.title);                    // compiles
stream.order(Books.createdAt.desc());         // compiles
stream.order(Books.createdAt.desc().nullsLast()); // compile error
stream.order(Users.fullName);                 // compile error (computed field)
query.order(Books.createdAt.desc().nullsLast());  // still compiles
```

The rendered `order` keys do not change.

## Breaking change

Only for code that passed a null placement or a non-stored expression to
a t... (continued)

Coverage Stats

22 of 37 new or added lines in 3 files covered. (59.46%)

2 existing lines in 1 file now uncovered.

10723 of 11699 relevant lines covered (91.66%)

5.38 hits per line