supabase / supabase-flutter / 32018494325

89%

Build Type

push

github

Committed by web-flow

Commit Message

refactor(auth)!: return a Uri from OAuthResponse.url instead of a String (#1729)

## What kind of change does this PR introduce?

Breaking change, refactor. Closes SDK-1496.

> [!NOTE]
> This was originally stacked on #1728. That has landed, so this branch
is
> rebased directly onto `main` and stands on its own.

## What is the current behavior?

#1722 changed `getSSOSignInUrl` to return a `Future<Uri>`, which left
the two
sibling URL getters disagreeing with it:

| Method | Returns |
| --- | --- |
| `AuthClient.getSSOSignInUrl` | `Future<Uri>` |
| `AuthClient.getOAuthSignInUrl` | `Future<OAuthResponse>` with `String
url` |
| `AuthClient.getLinkIdentityUrl` | `Future<OAuthResponse>` with `String
url` |

Shipping v3 that way means three URL-returning auth methods with two
different
types for the same concept, and callers still writing `Uri.parse` for
two of
them.

## What is the new behavior?

`OAuthResponse.url` is a `Uri`. Both getters share that type, so this
covers
them in one change and makes all three consistent.

Two internal tidy-ups fall out of it:

- `_getUrlForProvider` returns the `Uri` it builds rather than a whole
`OAuthResponse`. `getLinkIdentityUrl` only ever wanted the URL to send a
request to, and the response type belongs at the public boundary, so it
is now
  constructed there by both public methods.
- `supabase_flutter`'s `_launchAuthUrl` takes a `Uri` and drops its
internal
  `Uri.parse`. It hands the value straight to `launchUrl`.

## The wire format is unchanged

This is the part worth scrutinising, since the URL is built by string
interpolation and is now parsed before it leaves the client.

The query is still built with `Uri(queryParameters: ...)` exactly as
before, and
`Uri.parse` round-trips the result byte for byte. Verified against the
shapes
this code actually produces:

```
SAME  ...?provider=google&redirect_to=https%3A%2F%2Fsupabase.com
SAME  ...?provider=github&scopes=repo&redirect_to=redirectToURL
SAME  ...?provider=c... (continued)

Coverage Stats

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

71 existing lines in 2 files now uncovered.

5732 of 6495 relevant lines covered (88.25%)

4.11 hits per line