supabase / supabase-flutter / 32183188729

89%

push

github

refactor(postgrest)!: expose retry configuration as PostgrestRetryOptions (#1731)

## What

Promotes the internal `_RetryConfig` added in #1560 to a public
`PostgrestRetryOptions` and replaces the individual retry parameters
with a single `retryOptions` value, so the retry configuration is one
object everywhere.

```dart
final supabase = SupabaseClient(
  supabaseUrl,
  supabaseKey,
  postgrestOptions: const PostgrestClientOptions(
    retryOptions: PostgrestRetryOptions(count: 5, statusCodes: {503}),
  ),
);

// Per-request override, unchanged:
await supabase.from('todos').select().retry(enabled: false);
```

`PostgrestRetryOptions` has a const constructor and carries `enabled`,
`count`, `statusCodes`, the backoff knobs `initialDelay`, `maxDelay` and
`randomizationFactor`, a `delay(attempt)` computed from them with the
shared `exponentialBackoff` helper, and a `copyWith`. Tuning the backoff
was not possible before, and the field names match the `RetryOptions` of
`supabase_common` so a later unification is a rename. Sharing one retry
configuration across every client is tracked separately in #1735.
`PostgrestBuilder.retry()` delegates to `retryOptions.copyWith(...)`, so
the ergonomic shortcut keeps working and now composes on top of the
client configuration.

### Breaking changes

| Before | After |
| --- | --- |
| `PostgrestClient(retryEnabled:, retryCount:, retryableStatusCodes:)` |
`PostgrestClient(retryOptions:)` |
| `PostgrestClientOptions(retryEnabled:, retryCount:,
retryableStatusCodes:)` | `PostgrestClientOptions(retryOptions:)` |
| `PostgrestQueryBuilder(retryEnabled:, …)` /
`PostgrestRpcBuilder(retryEnabled:, …)` | `…(retryOptions:)` |
| `PostgrestClient.defaultRetryableStatusCodes` |
`PostgrestRetryOptions.defaultStatusCodes` |

A negative retry count is now rejected by an assertion on
`PostgrestRetryOptions` instead of an `ArgumentError` from the
`PostgrestClient` constructor, and the retry loop treats a count below
one as "send once" so a... (continued)

31 of 36 new or added lines in 7 files covered. (86.11%)

5782 of 6539 relevant lines covered (88.42%)

4.19 hits per line