supabase / supabase-flutter / 40930418497

94%

push

github

fix(postgrest)!: remove defaultToNull from the typed insert and upsert methods (#2106)

## What

Removes `defaultToNull` from the typed `insert`, `insertAll`, `upsert`
and `upsertAll` on `PostgrestTypedQueryBuilder`. Typed bulk writes now
always send `Prefer: missing=default`, and single-row writes send
nothing extra. The untyped `PostgrestQueryBuilder.insert` and `upsert`
keep `defaultToNull` with its default of `true`.

## Why

The generated `Insert` types already tell an absent field (database
default) from an explicit null (`set…ToNull()`). On the bulk methods,
`defaultToNull: true` contradicted that contract and was a second, less
precise way to write `NULL`. On the single-row methods it had no effect,
since no `columns` parameter is sent.

## Changes

- `PostgrestTypedQueryBuilder`: the four methods lose the parameter, and
their dartdoc points at `set…ToNull()` for writing `NULL`.
- `PostgrestTableRequest.defaultToNull` is removed as well, since
nothing on the typed API could set it anymore.
`PostgrestHttpTableExecutor` sends `missing=default` for a list payload
and nothing for a single row.
- Tests: the `defaultToNull: true` tests are replaced by tests that
write `NULL` through `set…ToNull()` next to a left out column, both
against the mock client and the local stack. Added assertions that
single-row insert and upsert send no `columns` and no `missing=default`.
- `MIGRATION.md`: the typed writes paragraph now points at
`set…ToNull()`, and a new section covers the removal.
- `skills_src/migrate-v3` updated, and the package skills regenerated
with `melos run sync-skills`.
- `sdk-compliance.yaml`: notes on `database.mutate.insert`, `upsert` and
`missing_defaults` pointing at the proposed spec change in
supabase/sdk#306, to be removed once that is merged.
`PostgrestTableRequest.defaultToNull` is unregistered.

## Breaking

Yes, for the typed API, which is still `@experimental`. Callers that
passed `defaultToNull: true` to `insertAll` or `upsertAll`... (continued)

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

12491 of 13254 relevant lines covered (94.24%)

6.58 hits per line