supabase / supabase-flutter / 40340509539

94%

push

github

refactor(supabase): remove pause from the client interceptors (#2059)

Follow-up to https://github.com/supabase/supabase-flutter/pull/1940,
which added `SupabaseClientInterceptor.pause` and fired it on
`AppLifecycleState.hidden`.

Part of the [interceptor
RFC](https://linear.app/supabase/project/rfc-client-interceptor-seam-for-the-sdks-cf968a76040c/overview).

## Why

- `hidden` fires on every tab switch on the web, while the realtime
lifecycle only reacts to `paused` and `detached`, so the hook did not
match what "pause" suggests.
- A pause cannot be relied on for correctness: the app can be killed, or
a tab frozen or discarded, without one. Interceptors such as offline
have to persist what must survive when it is written, so `pause` only
ever offered an optimization nobody needs yet.
- `resume` is what an interceptor needs to react to the app coming back,
for example to start a synchronization.

## Changes

- Remove `SupabaseClientInterceptor.pause` and its registration in
`sdk-compliance.yaml`.
- `supabase_flutter` only notifies interceptors on `resumed`, still
through one chain per interceptor so resumes never overlap and `dispose`
waits for a running one.
- The `resume` docs say it also arrives after the app was only inactive,
so a reaction should be cheap to repeat.

`pause` was never released, so this is not a breaking change for users.


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

<!-- coderabbit-ai-generated:v1 -->

## Summary by CodeRabbit

* **API Changes**
* Removed the interceptor `pause` lifecycle hook. Interceptors can no
longer receive pause notifications when the app moves out of the
foreground.
* **Behavior Changes**
* Interceptors receive a resume notification each time the app resumes,
including after it was temporarily inactive, such as behind a system
dialog. Resume notifications run in order, and one interceptor’s failure
does not prevent others from resuming.

<!-- end of auto-generated comment: ... (continued)

9 of 9 new or added lines in 1 file covered. (100.0%)

12154 of 12920 relevant lines covered (94.07%)

6.34 hits per line