supabase / supabase-flutter / 36537528666

94%

push

github

feat(postgrest): type the embedded rows of a relation (#1891)

Stacked on https://github.com/supabase/supabase-flutter/pull/1890, which
adds `PostgrestRelation.select` and merges same-relation entries. Only
the last commit is this PR.

## Summary

Embedded rows came back as `Map<String, dynamic>` (or a list of them)
even on the typed surface, so reading `order.lineItems` meant casting by
hand. The generated row types now read embedded rows as their row type,
and hinted embeds get an alias so two relations to one table no longer
collide in the response.

## Changes

- **Row getters for relations (typegen).** Every generated row type gets
a getter per relation, named like the relation constant on the namespace
class. A to-one relation reads `AuthorsRow?`, `null` unless the relation
was selected and the key points at a row. A to-many relation reads
`List<BooksRow>`, and is only readable when the relation was selected,
in line with how column getters behave for columns left out of a
`select`.
- **Relation names are settled once.** The generator claims relation
member names against both scopes they appear in, the namespace class and
the row type, so the constant and the getter share a name.
- **`PostgrestRelation.alias` and `key`.** A hinted embed comes back
under the plain table name, so two hinted relations to the same table
overwrite each other in the response. `alias` renders as
`alias:table!hint(...)` in `select` and replaces the name in `order` and
in the filter form, which PostgREST requires once an alias is set. `key`
names what the embedded rows come back under: the alias, or the table
name. Verified against the local stack that an aliased embed must be
ordered and filtered by the alias, and that `limit` on the embed accepts
either.
- **Typegen aliases ambiguous relations** to the member name in snake
case, `map_by_mood:map!postgrest_table_mood_fkey`, and the row getter
reads under that key.

## Tests

- Postgrest: alias rendering in select, order... (continued)

79 of 81 new or added lines in 5 files covered. (97.53%)

8796 of 9642 relevant lines covered (91.23%)

4.95 hits per line