supabase / supabase-flutter / 37470514274

92%

Build Type

push

github

Committed by web-flow

Commit Message

feat(postgrest)!: require a filter or all() on typed update() and delete() (#1913)

## Summary

The typed `update()` and `delete()` returned a
`PostgrestTypedFilterBuilder`, which is awaitable, so `await
client.table(Books.table).delete()` compiled and deleted every row in
the table.

They now return a `PostgrestTypedUnscopedBuilder<Row>`, a type with two
methods and no `Future` interface:

- `where(filter)` scopes the mutation to the matching rows.
- `all()` opts into writing every row in the table.

Both return the `PostgrestTypedFilterBuilder<Row, void>` the mutation
used to start with, so everything after them (`select()`,
`maxAffected()`, request options, further `where()` calls) is unchanged.
A mutation without one of them does not compile. The insert half, which
rejects a filter after `insert()` and `upsert()`, was already in place.

`update()` and `delete()` on `from()` are unchanged. Every existing call
site already filtered, so only the types moved.

## Changes

- `packages/postgrest/lib/src/postgrest_typed_unscoped_builder.dart`:
the new builder.
- `postgrest_typed_query_builder.dart`: `update()` and `delete()` return
it.
- `typed_query_test.dart`: static shape of the chain, `all()` on an
update and a delete renders no filter, a filter after `all()` scopes the
request, transforms and `select()` on a scoped mutation.
- `MIGRATION.md`: a v3 section next to the insert filter one, and a note
in the typed table guide.
- `sdk-compliance.yaml`: the new symbols registered under
`database.mutate.update` and `database.mutate.delete`.

## Verification

- `melos analyze`, `melos format`, `dcm analyze` on postgrest: clean.
- `dart test -j 1` in `packages/postgrest` against the local stack: 583
passed.
- `supabase_typegen` behavior tests, which use typed writes: passed.
- Compliance symbol, drift and schema checks at the pinned
`capability-matrix/v1.14.0`: passed.

Swift equivalent: supabase/supabase-swift#1425.

Fixes SDK-2123

<!-- This is an auto-gene... (continued)

Coverage Stats

11 of 11 new or added lines in 2 files covered. (100.0%)

17 existing lines in 1 file now uncovered.

9297 of 10161 relevant lines covered (91.5%)

5.22 hits per line