supabase / supabase-flutter / 36977860469

92%

push

github

feat(postgrest): add retry, requestTimeout, abortSignal and setHeader to the typed builders (#1907)

## Summary

The untyped builders let a caller control each request, but the typed
builders returned by `client.table(...)` could not do any of it. A typed
caller had no way to cancel a request, override the timeout or retry
policy, or set a header. That includes the `Authorization` header, which
is how a single request overrides the token. The `Future.timeout()` the
typed builder inherits only stops waiting for the result, while the HTTP
request keeps running.

This adds `retry({bool enabled, int? count})`,
`requestTimeout(Duration)`, `abortSignal(Future<void>)` and
`setHeader(String, String)` to `PostgrestTypedQueryBuilder`,
`PostgrestTypedFilterBuilder`, `PostgrestTypedTransformBuilder` and
`PostgrestTypedBuilder`. Each one returns its own builder type, so the
chain continues. Unlike the untyped API, `abortSignal` is available at
every phase, so `.where()` still works after it.

```dart
final books = await client
    .table(Books.table)
    .select()
    .abortSignal(abort.future)
    .setHeader('Authorization', 'Bearer $token')
    .where(Books.id.eq(1))
    .requestTimeout(const Duration(seconds: 5));
```

## How it works

The typed builders collect an immutable `PostgrestTableRequest` and a
`PostgrestTableExecutor` runs it. They do not wrap untyped builders, so
these settings cannot just be forwarded. Instead:

- The new `PostgrestRequestOptions` class holds the headers, the retry
override, the timeout and the abort signal. It is stored as
`PostgrestTableRequest.options`, separate from the query fields, because
it controls how the request is sent rather than what it asks for. Its
dartdoc says an executor that does not use HTTP, such as a cache or a
local store, may ignore it, and that a cache keying on the request
should leave the abort signal out of the key.
- `PostgrestHttpTableExecutor` applies the options to the final untyped
builder, for both... (continued)

76 of 93 new or added lines in 6 files covered. (81.72%)

9080 of 9946 relevant lines covered (91.29%)

4.96 hits per line