supabase / supabase-flutter / 29006230524
87%

DEFAULT BRANCH: main
Ran
Jobs 8
Files 83
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 86.443%. Remained the same
29006230524

push

github

web-flow 
docs(auth): document getOAuthSignInUrl for URL-without-launch, mark oauth parity implemented (#1548)

## What

Marks `auth.sign_in.sign_in_with_oauth` as `implemented` in the SDK
compliance matrix and documents the URL-without-launch path.

- `sdk-compliance.yaml`: `auth.sign_in.sign_in_with_oauth` moves from
`partially_implemented` to `implemented`.
- `signInWithOAuth` doc comment now points callers to
`getOAuthSignInUrl` when they want the OAuth URL without launching a
browser.

## Why

The compliance gap was "the `skipBrowserRedirect` option is not publicly
exposed." In supabase-js `skipBrowserRedirect` does two things: (1)
suppresses the automatic `window.location.assign(url)` browser
navigation, and (2) adds a `skip_http_redirect` server hint.

In Flutter, half (1) is already the default behavior of
`getOAuthSignInUrl`, which builds and returns the OAuth `OAuthResponse`
(including the URL) without ever launching a browser. That is the
meaningful Flutter equivalent of "skip the browser redirect and hand me
the URL."

Adding an explicit `skipBrowserRedirect` flag was considered and
dropped:
- On `signInWithOAuth` it would only build the URL and discard it, since
that method returns `Future<bool>` (launch success), not the URL.
- On `getOAuthSignInUrl` it would only toggle the `skip_http_redirect`
server hint, which is a niche flag that makes the server return JSON
instead of a 302, undesirable for the common flow of opening the URL in
a browser/webview, and oddly named on a method that never touches a
browser.

So the capability is satisfied by the existing API; this PR reclassifies
it and adds a doc pointer.

## Non-breaking

Documentation and compliance-metadata only; no API or behavior change.

Closes SDK-1261

4476 of 5178 relevant lines covered (86.44%)

4.03 hits per line

Jobs
ID Job ID Ran Files Coverage
8 supabase_flutter - 29006230524.8 11
79.0
 GitHub Action Run
6 yet_another_json_isolate - 28999966848.6 1
77.78
 GitHub Action Run
2 realtime_client - 28999966848.2 11
89.06
 GitHub Action Run
3 storage_client - 28999966848.3 5
93.26
 GitHub Action Run
4 postgrest - 28999966848.4 9
84.57
 GitHub Action Run
6 gotrue - 29003395872.6 29
86.02
 GitHub Action Run
7 supabase - 29003395872.7 15
80.69
 GitHub Action Run
5 functions_client - 28999966848.5 2
98.8
 GitHub Action Run
Source Files on build 29006230524