feat(react): make session requireable in useSession
#2236
Merged
Conversation
This file contains 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
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/nextauthjs/next-auth/EuDgeRfzdP4vdMCRFMRuL9VomnnV |
github-actions
bot
added
client
Codecov Report
@@ Coverage Diff @@
## next #2236 +/- ##
=========================================
+ Coverage 9.94% 10.74% +0.79%
=========================================
Files 83 83
Lines 1397 1414 +17
Branches 383 393 +10
=========================================
+ Hits 139 152 +13
- Misses 1039 1042 +3
- Partials 219 220 +1
Continue to review full report at Codecov.
|
This was referenced Jun 28, 2021
Co-authored-by: Kristóf Poduszló <kripod@protonmail.com>
ubbe-xyz
requested changes
Jul 1, 2021
Co-authored-by: Lluis Agusti <hi@llu.lu>
|
@lluia had some requests which first need to be reviewed again, when this PR is updated. 😊 |
Remove `loading` value from `useSession` in V4 given we already return a `status`value which scales better to identify the different states of the session request.
• rename `action` to `onFail` • reword documentation • document `useSession` return • reword `<SessionProvider />` usage to state is mandatory
Rename the handler name on `useSession` when authentication didn't pass to be more accurate.
ubbe-xyz
approved these changes
Jul 5, 2021
mnphpexpert
added a commit
to mnphpexpert/next-auth
that referenced
this pull request
Sep 2, 2024
A living session could be a requirement for specific pages (like dashboards). If it doesn’t exist, the user should be redirected to a page asking them to sign in again.
Sometimes, a user might log out by accident, or by deleting cookies on purpose. If that happens (e.g. on a separate tab), then `useSession({ required: true })` should detect the absence of a session cookie and always return a non-nullable Session object type.
When `required: true` is set, the default behavior will be to redirect the user to the sign-in page. This can be overridden by an `action()` callback:
```js
const session = useSession({
required: true,
action() {
// ....
}
})
if (session.status === "Loading") return "Loading or not authenticated..."
// session.data is always defined here.
```
Co-authored-by: Kristóf Poduszló <kripod@protonmail.com>
Co-authored-by: Lluis Agusti <hi@llu.lu>
BREAKING CHANGE:
The `useSession` hook now returns an object. Here is how to accommodate for this change:
```diff
- const [ session, loading ] = useSession()
+ const { data: session, status } = useSession()
+ const loading = status === "loading"
```
With the new `status` option, you can test states much more clearly.
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.
Reasoning 💡
A living session could be a requirement for specific pages (like dashboards). If it doesn’t exist, then the user should be redirected to a page that asks them to sign in again.
Sometimes, a user might log out by accident, or by deleting cookies on purpose. If that happens (e.g. on a separate tab), then
useSession({ required: true })should detect the absence of a session cookie and always return a non-nullable Session object type.When
required: trueis set, the default behavior will be to redirect the user to the sign-in page. This can be overridden by anaction()callback:Checklist 🧢
Affected issues 🎟
Fixes #1210
Related: #2269
BREAKING CHANGE:
The
useSessionhook now returns an object. Here is how to accommodate for this change: