supabase / supabase-flutter / 39775588260

92%

Build Type

push

github

Committed by web-flow

Commit Message

fix(supabase_flutter): dispose Supabase inside testWidgets without hanging (#2012)

Fixes [SDK-2330](https://linear.app/supabase/issue/SDK-2330).

## Problem

The documented `initializeTestSupabase` pattern hung inside
`testWidgets` until the test timed out:

```dart
final supabase = await initializeTestSupabase(httpClient: httpClient);
addTearDown(supabase.dispose);
```

Initialization and queries actually completed. The hang was in
`Supabase.dispose`, for two reasons:

1. The `Supabase` singleton is created lazily, so in a widget test it is
created inside the first test's fake async zone, and so is its lifecycle
queue, which started as `Future.value()`. Awaiting an already completed
future schedules the continuation in that future's zone. Nobody flushes
that fake zone after the test body ends, so `dispose` hung in
`addTearDown` and in every later test.
2. `SupabaseClient.dispose` awaited the cancel of the auth state
subscription. A broadcast subscription's cancel returns the root zone's
null future, so `dispose` resumed outside the fake zone, and its next
await never completed. This hit `dispose` called inside the test body.

## Changes

- `Supabase` keeps the lifecycle queue `null` while nothing is in
flight, so `dispose` only awaits a lifecycle operation that is actually
running.
- `SupabaseClient.dispose` no longer awaits the cancel of the auth state
subscription, which takes effect immediately.
- Added widget tests to `testing_test.dart` that use the plain `await`
pattern: a widget queries through `MockSupabaseHttpClient` during
`pumpWidget` and settles with `pumpAndSettle`, twice in a row, plus a
test that disposes inside the body. They run before the `test()` cases
so the singleton is created in a fake zone. Without the fix they hang.

The README and the `initializeTestSupabase` dartdoc already show the
plain `await` pattern, which now works, so `tester.runAsync` is not
needed.

Coverage Stats

13 of 13 new or added lines in 2 files covered. (100.0%)

7 existing lines in 2 files now uncovered.

10705 of 11666 relevant lines covered (91.76%)

5.39 hits per line