supabase / supabase-flutter / 29287704963

87%

push

github

feat(postgrest): configurable auto-retry and request timeout (#1560)

## Summary

Makes the PostgREST client's automatic retry behavior configurable and
adds an optional per-request timeout that actually cancels a stalled
attempt. Previously the retry count and the retryable conditions were
hard-coded, and there was no way to bound the duration of a request.
Rebased on top of the request abort feature (#1368), whose
`AbortableRequest` support is what makes a real timeout possible.

All defaults preserve the current behavior, so the change is
non-breaking.

## Configurable auto-retry

New optional configuration on `PostgrestClient` (and per request via
`PostgrestBuilder.retry`):

- `retryEnabled` (default `true`): whether retries are performed for
retryable GET and HEAD requests.
- `retryCount` (default `3`): number of retry attempts for a retryable
request. A negative value throws an `ArgumentError`.
- `retryableStatusCodes` (default `{503, 520}`): HTTP status codes that
trigger a retry. The set is copied defensively so later mutation of the
caller's set does not change retry behavior.
- `PostgrestBuilder.retry({bool enabled = true, int? count, Duration?
requestTimeout})`: the per-request override now also accepts a `count`
and a `requestTimeout`. A `null` `requestTimeout` keeps the client-level
timeout.

The default retryable status codes are exposed as
`PostgrestClient.defaultRetryableStatusCodes`, since the client is where
retries are configured.

## Request timeout

`requestTimeout` is available on `PostgrestClient` and
`PostgrestClientOptions`, and can be overridden per request through
`PostgrestBuilder.retry`. It bounds how long a single request attempt
may take and is built on top of the abort mechanism from #1368, so it
actually cancels a stalled attempt through `AbortableRequest` rather
than leaving it running the way `Future.timeout` would. When `null` (the
default) no timeout is applied.

It is a per-attempt timeout, not a whole-operation d... (continued)

101 of 115 new or added lines in 10 files covered. (87.83%)

4743 of 5439 relevant lines covered (87.2%)

4.1 hits per line