Skip to content

docs: Review and conform the Authentication pages, add expired-auth handling (#654)#677

Merged
developerjamiu merged 3 commits into
mainfrom
concepts-phase2-pr4-auth
Jul 9, 2026
Merged

docs: Review and conform the Authentication pages, add expired-auth handling (#654)#677
developerjamiu merged 3 commits into
mainfrom
concepts-phase2-pr4-auth

Conversation

@developerjamiu

@developerjamiu developerjamiu commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Phase 2 IA, PR 4 of 7 (tracked in #671): a review and conformance pass over the Authentication pages. Most of this section was already reworked by earlier PRs, so this is fixes and consistency rather than net-new content, plus the expired-auth gap. Legacy pages stay at their current location (archiving is deferred to the final PR of this series).

What changed

  • The basics: added "Validate the session and handle expiry" (validateAuthentication / initialize, including how transient failures avoid signing offline users out). Corrected two factual errors: session.authenticated is a synchronous getter (not async), and userIdentifier is a String (the user's UuidValue is authUserId).
  • Custom providers (OAuth2 utility): fixed a page-breaking unclosed code fence that collapsed a section and a table into a code block; removed a duplicate heading; corrected int authUserId to UuidValue.
  • Custom overrides: fixed a $localhost string-interpolation bug and two code samples that would not compile.
  • Setup: version pins 3.x.x to 4.0.0-beta.0 (the modular auth packages are on the 4.0-beta line).
  • Firebase: completed the FirebaseServiceAccountCredentials constructor reference (it listed three of four).
  • Across the section: house-style sweep (em dashes, banned vocab, hedge words, sentence-leading code spans, grammar, numbered-list and code-sample fixes) and section headings normalized to sentence case.

Verification

Checked against the framework source (modules/serverpod_auth and the core auth package): session.authenticated is a synchronous AuthenticationInfo? getter; userIdentifier is a String; AuthUser.id is a UuidValue; the modular auth packages are 4.0.0-beta.0; validateAuthentication and initialize behave as documented; FirebaseServiceAccountCredentials has four constructors. Load-bearing API symbols were spot-checked and exist. Build passes locally.

Notes

Closes #654

@developerjamiu developerjamiu self-assigned this Jul 7, 2026
@developerjamiu developerjamiu requested a review from Zfinix July 7, 2026 16:42
@developerjamiu developerjamiu added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 7, 2026
Comment thread docs/06-concepts/11-authentication/02-basics.md Outdated

@Zfinix Zfinix left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚀

@developerjamiu developerjamiu merged commit 5591555 into main Jul 9, 2026
4 checks passed
@developerjamiu developerjamiu deleted the concepts-phase2-pr4-auth branch July 9, 2026 13:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document client URL configuration per environment and handling expired auth

2 participants