supabase / supabase-flutter / 36696892879

92%

push

github

feat(postgrest)!: type a partial select as a partial row instead of the full row (#1897)

Closes
[SDK-1976](https://linear.app/supabase/issue/SDK-1976/featpostgrest-type-a-partial-select-as-a-selection-instead-of-the-full).

## Problem

`select([Books.id, Books.title])` on the typed builders resolved to
`List<BooksRow>`. The generated row type reads `_json['created_at'] as
String`, so every getter of a column the list left out compiled and
crashed at runtime with a null cast that did not name the column. Since
#1891 the same applied to embeds: `Books.author.select([Authors.name])`
was read through `BooksRow.authors`, which converted the partial
embedded object into a full `AuthorsRow`.

## What changes

### `postgrest`

- **`selectOnly([...])`** replaces `select([...])` on
`PostgrestTypedQueryBuilder` and `PostgrestTypedTransformBuilder` and
resolves to `List<PostgrestPartialRow<Row>>`. `select()` keeps resolving
to `List<Row>`.
- **`PostgrestPartialRow.read`** reads a value through the select list
entry, so the entry types the read and an entry of another table does
not compile:

  ```dart
  final books = await client
      .table(Books.table)
.selectOnly([Books.id, Books.title,
Books.author.select([Authors.name])]);

  final int id = books.first.read(Books.id);
final String? author =
books.first.read(Books.author)?.read(Authors.name);
books.first.read(Books.createdAt); // StateError: `created_at` was not
selected. The row holds `id`, `title`, `authors`.
  ```

A `PostgrestColumn` reads as its value type, a
`PostgrestNullableColumn`, a derived expression and a JSON path as the
nullable form, a to-one relation as a nested `PostgrestPartialRow?`, a
to-many relation as a list of them. Aggregates come back under the
function name, a cast under the key of what was cast, a JSON path under
its last key. Entries of one relation merge into the nested row the way
they merge into one embed, and `Books.author.select()` lets any column
of the embedded table be re... (continued)

180 of 190 new or added lines in 10 files covered. (94.74%)

8711 of 9526 relevant lines covered (91.44%)

5.08 hits per line