supabase / supabase-flutter / 37944513512

92%

Build Type

push

github

Committed by web-flow

Commit Message

feat!: make the request timeout an idle timeout and add it to auth, storage and functions (#1938)

Fixes
[SDK-2133](https://linear.app/supabase/issue/SDK-2133/feat-configurable-request-timeout-for-auth-storage-and-functions).

## What

- **Idle timeout everywhere.** `requestTimeout` now bounds how long a
request may go without progress instead of its total duration. The timer
restarts on every chunk of a request body that is sent (large in-memory
bodies are fed in 64 KB slices so they show progress too), when the
response headers arrive, and on every chunk of the response body. A
large but steady transfer is never cut short, and a stalled request is
still cancelled. This matches Swift (supabase/supabase-swift#1343),
which uses `URLRequest.timeoutInterval` for the same reason.
- **One shared implementation.** `IdleTimeout` in `supabase_common`
builds abortable requests whose bodies it watches (`request()`,
`multipartRequest()`, and `watchRequestBody()` for streamed uploads),
and wraps the response body stream. The timer pauses while the consumer
pauses its subscription and stops once the body is done. It also
surfaces a `TimeoutException` when the HTTP client ignores the abort
trigger, releases the late response in that case, stops the timer when a
send fails, and cancels a response body nobody listened to once the
timeout expires. PostgREST drops its own timer code and uses it too.
- **New options.**
- `SupabaseClient(requestTimeout:)` and
`Supabase.initialize(requestTimeout:)` set a default for every HTTP
service.
- `AuthClientOptions`, `StorageClientOptions` and
`FunctionsClientOptions` each get `requestTimeout`, which overrides the
global value for that service. `PostgrestClientOptions.requestTimeout`
now does the same.
- The `AuthClient`, `AuthAdminApi`, `SupabaseStorageClient` and
`FunctionsClient` constructors take it as well.
- `FunctionsClient.invoke(requestTimeout:)` overrides it for a single
invocation, next to the existing per-request overr... (continued)

Coverage Stats

134 of 147 new or added lines in 11 files covered. (91.16%)

1 existing line in 1 file now uncovered.

9496 of 10377 relevant lines covered (91.51%)

5.18 hits per line