supabase / supabase-flutter / 32253470757

89%

Build Type

push

github

Committed by web-flow

Commit Message

refactor(postgrest)!: fix the retried status codes to 503 and 520 (#1737)

## What

`PostgrestRetryOptions.statusCodes` is a static constant now instead of
a configurable field, so `503 Service Unavailable` and `520 Unknown
Error` are the only responses that ever trigger a retry.

Letting callers pass their own set invites retrying responses that
cannot change on a second attempt, a `500` from a failing query for
example, which only multiplies the load on the project without a chance
of a different answer.

```dart
// Before
retryOptions: PostgrestRetryOptions(count: 5, statusCodes: {500, 503, 520}),

// After
retryOptions: PostgrestRetryOptions(count: 5),
```

Everything else about the retry configuration is unchanged: `enabled`,
`count`, the backoff knobs and the per-request `.retry()` override all
stay.

Since the set is a `const` now, the two places that snapshotted it with
`Set.unmodifiable` so a caller could not mutate a live client's behavior
are gone as well.

### Breaking changes

| Before | After |
| --- | --- |
| `PostgrestRetryOptions(statusCodes: …)` | removed |
| `PostgrestRetryOptions.copyWith(statusCodes: …)` | removed |
| `PostgrestRetryOptions.statusCodes` (instance field) |
`PostgrestRetryOptions.statusCodes` (static constant) |
| `PostgrestRetryOptions.defaultStatusCodes` |
`PostgrestRetryOptions.statusCodes` |

The v2 `PostgrestClient(retryableStatusCodes:)` and
`PostgrestClientOptions(retryableStatusCodes:)` were already replaced by
`retryOptions` in #1731, and now have no replacement at all.
`MIGRATION.md` gets a section for that and the existing v3 retry section
drops its `statusCodes` references.

## Tests

- `packages/postgrest/test/retry_test.dart` loses the "configurable
retryable status codes" group, gains an explicit "GET does not retry on
500" case and an assertion that the fixed set is `{503, 520}`.
- `packages/supabase/test/postgrest_options_test.dart` proved that the
configured options were threaded through `from()`, ... (continued)

Coverage Stats

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

2 existing lines in 2 files now uncovered.

5903 of 6653 relevant lines covered (88.73%)

4.25 hits per line