supabase / supabase-flutter / 32832987965

89%

push

github

refactor(auth)!: make Session.expiresAt read-only and auth DTO fields final (#1766)

Closes SDK-1602.

A few mutable public fields were left in `supabase_auth`. This makes
them immutable.

## `Session.expiresAt`

`expiresAt` is derived from the `exp` claim of the access token, not
from the login response body, so a public setter only let a consumer
desynchronize the value from the token that the auto refresh logic acts
on. It is now `late final`, which keeps the lazy derivation and its
caching while making assignment a compile error.

## `ResendResponse.messageId`

Now `final`, like every other response type in the package.

## `UserAttributes` and `AdminUserAttributes`

All six inherited request fields (`email`, `phone`, `password`, `nonce`,
`data`, `currentPassword`) are `final`. `AdminUserAttributes` already
declared its own additions as `final`, so the two halves of the class
now agree.

## Breaking change

Assigning to any of these fields no longer compiles. `MIGRATION.md`
documents the change and shows constructing the request objects instead
of mutating them after construction.

## Testing

`dart analyze` is clean across the workspace and the full
`supabase_auth` suite passes (530 tests, run with `-j 1` against a local
GoTrue). Added a test that pins `Session.expiresAt` to a single cached
derivation across reads.

No capability matrix changes: the field names are unchanged, and
`check-api-symbols` against the base reports no new uncovered symbols.

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

- **Documentation**
- Added v2-to-v3 migration guidance for immutable session,
authentication response, and user attribute fields.
- Documented using constructors and `copyWith` when updating these
values.

- **Refactor**
- Session expiration, resend response IDs, and user attribute request
fields are now immutable.
- Session expiration is derived from the access token and remains
consistent across re... (continued)

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

6029 of 6801 relevant lines covered (88.65%)

4.57 hits per line