feat: Add documentation for proactive token refresh and session-only auth #2273
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2273 +/- ##
=======================================
Coverage 85.39% 85.39%
=======================================
Files 26 26
Lines 2471 2471
Branches 462 462
=======================================
Hits 2110 2110
Misses 355 355
Partials 6 6 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
6 tasks
| @@ -162,6 +162,9 @@ export default function Profile() { | |||
|
|
|||
| On the server, the `getSession()` helper can be used in Server Components, Server Routes, and Server Actions to get the session of the currently authenticated user and to protect resources, like so: | |||
|
|
|||
| > [!NOTE] | |||
| > The `getSession()` method is perfect for applications that only need user identity information without calling external APIs. It provides access to the user's profile data from the ID token without requiring access tokens, making it ideal for session-only authentication patterns. | |||
There was a problem hiding this comment.
Doesn't getSession return the RT and AT?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR enhances the examples to include patterns for proactive token refresh and session-only authentication. It also clarifies important considerations for refresh token rotation.
Fixes: #2149
📋 Changes
These changes provide developers with more advanced and robust patterns for handling tokens and sessions. The proactive refresh example helps prevent API call failures due to expired tokens in latency-sensitive applications.
EXAMPLES.md: Added a note ongetSessionusage, a warning about refresh token rotation, and a new example for proactive token refresh. Corrected the import path forwithPageAuthRequired.README.md: Fixed minor list formatting.🎯 Testing
Manual:
EXAMPLES.md.getSession, refresh token rotation, and proactive token refresh for clarity and accuracy.