supabase / supabase-flutter / 39768280064

92%

push

github

fix(postgrest): warn on a bare await of typed update() and delete() (#2007)

## What

The typed `update()` and `delete()` return a
`PostgrestTypedUnscopedBuilder`, which is not a `Future` and sends
nothing until `where()` or `all()` is called. Dart allows `await` on any
value, so this compiled and silently did nothing:

```dart
await supabase.table(Books.table).delete();
await supabase.table(Books.table).update(BooksUpdate(inPrint: false));
```

The only signal was the `await_only_futures` lint, which projects
without the core lint set do not get.

Both methods are now annotated with `@UseResult`, so the analyzer's
`unused_result` warning, which is on by default and needs no lint
configuration, reports a bare call or a bare `await` of either one.
Chaining `where()` or `all()` counts as using the result and stays
clean.

`MIGRATION.md` and the `PostgrestTypedUnscopedBuilder` dartdoc now point
at the `unused_result` warning instead of `await_only_futures`.

## Verification

There is no analyzer-output test harness in the repository, so this was
checked by running `dart analyze` on a scratch file in the postgrest
package:

```dart
await t.delete();          // warning: unused_result
t.delete();                // warning: unused_result
await t.update(Object());  // warning: unused_result
await t.delete().all();    // clean
```

`dart analyze packages` reports no issues, so no existing caller is
affected.

Fixes SDK-2326

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

<!-- coderabbit-ai-generated:v1 -->

## Summary by CodeRabbit

* **New Features**
* Added analyzer warnings when typed `update()` or `delete()` calls are
awaited without sending a request. Use `where()` or `all()` to send the
request.
* **Documentation**
* Updated the migration guide and typed-write guidance to reflect the
`unused_result` warning.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

2 of 2 new or added lines in 1 file covered. (100.0%)

10705 of 11666 relevant lines covered (91.76%)

5.39 hits per line