supabase / supabase-flutter / 39428007061

92%

Build Type

push

github

Committed by web-flow

Commit Message

fix(postgrest)!: key aggregates and casts by their own expression (#1988)

## What

On the typed surface, aggregates and casts are now sent under an alias
of their own expression and read back under that key, the same way JSON
paths already are since #1915.

```
select([Orders.id.sum(), Orders.amount.sum()])
before: select=id.sum(),amount.sum()                      -> {"sum": 6, "sum": 40}
after:  select="id.sum()":id.sum(),"amount.sum()":amount.sum() -> {"id.sum()": 6, "amount.sum()": 40}
```

## Why

Aggregates came back under the function name, so two aggregates of the
same function in one `select` collided and `jsonDecode` kept the last. A
cast came back under the key of the column it cast, so a column and its
cast in one `select` collided too. Reads go through
`PostgrestPartialRow.read(entry)`, which follows `responseKey`, so
nothing changes for typed reads.

This replaces the public `alias(String)` originally proposed in
SDK-1757: with reads going through the entry the response key is an
internal detail, and embeds can already be renamed through `alias` on
the relation.

## Changes

- `sum()`, `avg()`, `min()`, `max()`, `count()`, `countAll()` and
`cast()` are keyed by their whole expression and aliased in the `select`
list, at the top level and inside an embed,
`todo("amount.sum()":amount.sum())`.
- The per-derivation key override (`_castKey` and the `key:` parameter
of `_derive`) is gone, since every derivation is now keyed the same way.
- The dartdocs no longer warn about colliding aggregates and casts.

## Breaking

Code reading the raw response map, `row['sum']` or a cast under its
source column name, now needs the expression as the key. The typed
surface is `@experimental`.

## Verification

Against the local stack, with `pgrst.db_aggregates_enabled` turned on
temporarily, PostgREST accepts and answers under the quoted alias for
every form sent here: each aggregate, `count()`, a cast of an aggregate,
grouping by a plain column next to an a... (continued)

Coverage Stats

18 of 21 new or added lines in 3 files covered. (85.71%)

1 existing line in 1 file now uncovered.

10173 of 11059 relevant lines covered (91.99%)

5.5 hits per line