Implement updateSession & isUpdate parameter by christoph-pflueger · Pull Request #4744 · nextauthjs/next-auth

christoph-pflueger · 2022-06-21T17:04:09Z

☕️ Reasoning

What changes are being made? What feature/bug is being fixed here?

Implements updateSession to be able to update the SessionProvider's state without having to reload the page. The update event is propagated to the jwt and session callbacks via an isUpdate parameter. This helps to avoid having to check if the token and session is up to date on every request.

As there are currently no tests implemented for callbacks, I skipped that step.

🧢 Checklist

Documentation
Tests
Ready to be merged

🎫 Affected issues

Please scout and link issues that might be solved by this PR.

Fixes: #596
Fixes: #3941
Fixes: #2208
Might fix: #2129

📌 Resources

vercel · 2022-06-21T17:04:14Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
next-auth	✅ Ready (Inspect)	Visit Preview	Jun 21, 2022 at 5:05PM (UTC)

DitlevHB · 2022-07-28T15:11:33Z

Any ETA for the release of this?

qiqo · 2022-08-25T17:01:58Z

Can I gently nudge this pull request? I hope if gets merged already as this is also a blocker in our application - I think this should be considered critical

christoph-pflueger · 2022-08-25T17:15:43Z

Can I gently nudge this pull request? I hope if gets merged already as this is also a blocker in our application - I think this should be considered critical

The fact that this pull request hasn't received as much as a reply for almost three months even though there appears to be genuine interest is mind-blowing to me. It's not like other pull requests are not being worked on either.

devrsi0n · 2022-08-27T09:35:18Z

@balazsorban44 Could you help review this PR? It seems like a common feature should be built into next-auth. Thank you for your time.

qiqo · 2022-08-27T11:20:17Z

@balazsorban44 hoping for your time and consideration on this fixes. Thanks

ThangHuuVu

Thanks for the PR @git-chrisp and sorry for the delayed response, I reviewed your PR
It seems like the added method updateSession is exactly the same as getSession, the only difference is in the callback session and jwt
Could you give an example case where the extra isUpdate param is helpful? 🤔

christoph-pflueger · 2022-09-02T07:53:22Z

Thanks for the PR @git-chrisp and sorry for the delayed response, I reviewed your PR It seems like the added method updateSession is exactly the same as getSession, the only difference is in the callback session and jwt Could you give an example case where the extra isUpdate param is helpful? 🤔

The implemented updateSession doesn't call getSession. It calls the __NEXTAUTH._getSession which is encapsulated inside the SessionProvider and cannot be accessed at the moment.

Assume someone changes something in his profile settings that is stored in e.g. the token's custom claims. There is no way to update this change in the SessionProvider at the moment without reloading the entire page.

The isUpdate parameter helps in the backend to differentiate between normal getSession, _getSession and updateSession calls.

shahryarjb · 2022-09-25T22:30:07Z

Is there any deadline to fix this problem? For now the only way to fix this issue is reloading page and this way clean the state or the action user wants to do
Thank you.

mohamedGamalAbuGalala · 2022-10-25T21:00:04Z

Is any update on this pr soon, we are having the same problem authenticating with a custom PKCE provider, and when refreshing the token and have the new token back. the client keeps calling JWT with the old invalid token. and we use one-time refresh tokens so, it's pretty impossible to get around this setup without any compromise with the rules we already have.

rustunooldu · 2022-11-09T03:43:53Z

May I kindly ask for an update? I had this PR bookmarked months ago, and it's a little disheartening to see that there hasn't been any progress... It's a blocker for our application, and there seems to be a lot of interest from other people as well.

raulmarindev · 2022-11-09T10:10:19Z

I'm sorry if I'm mistaken but is this related to this workaround? https://stackoverflow.com/a/70405437/9123724

lemcii · 2022-11-09T11:00:22Z

Currently using window.location.reload()/window.location.pathname since I cannot await session update after updating a users profile. The changes here would likely solve that.

christoph-pflueger · 2022-11-09T11:07:11Z

I'm sorry if I'm mistaken but this related to this workaround? https://stackoverflow.com/a/70405437/9123724

This only works if refetchOnWindowFocus is enabled. And even then the solution only works if the current visibilityState of the document is visible (https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilityState).

shahryarjb · 2022-11-09T11:15:05Z

window.location.reload()

It is not good, I need to update my auth 2 tokens {refresh token, access token} every 1 hour, but for now I am forced to reload my site: it is my next auth API, and it is my client:

https://github.com/mishka-group/mishka-cms-front/blob/master/apps/mishka_user/helper/authHelper.ts#L121-L123

But how update it without refresh

rolanday · 2022-12-22T09:22:55Z

Happy to send reviewers a case of beer to get this PR approved (and pulled). As others have noted, this is basic/needed functionality. Thanks!

devrsi0n · 2022-12-23T01:36:26Z

      return baseUrl
    },
-    async session({ session, user, token }) {
+    async session({ session, user, token, isUpdate }) {


Could you use isUpdated instead? isUpdate has a grammar issue.

kblizeck · 2023-01-13T03:56:13Z

I'd pitch in for a second case - this would be super beneficial!

balazsorban44 · 2023-03-25T14:08:46Z

Closing in favor of #7056

christoph-pflueger added 4 commits June 21, 2022 17:33

Implement updateSession

5e6fe0b

Implement isUpdate parameter

be7806c

Document updateSession

abcce1d

Document isUpdate

551a439

christoph-pflueger requested review from balazsorban44 and ndom91 as code owners June 21, 2022 17:04

github-actions bot added client Client related code core Refers to `@auth/core` TypeScript Issues relating to TypeScript labels Jun 21, 2022

vercel bot temporarily deployed to Preview June 21, 2022 17:05 Inactive

balazsorban44 force-pushed the main branch from 2f7629d to c1f7ce3 Compare July 8, 2022 17:24

christoph-pflueger requested review from 0ubbe and ThangHuuVu as code owners August 1, 2022 11:44

ThangHuuVu reviewed Sep 2, 2022

View reviewed changes

kachar mentioned this pull request Oct 11, 2022

getSession call does not trigger session object update until window loses focus #596

Closed

balazsorban44 force-pushed the main branch from d125517 to f498e9c Compare November 5, 2022 22:10

balazsorban44 force-pushed the main branch from 6cf7608 to f4a2430 Compare December 14, 2022 01:45

devrsi0n reviewed Dec 23, 2022

View reviewed changes

balazsorban44 force-pushed the main branch 6 times, most recently from 19c6807 to 3be7bb7 Compare January 7, 2023 08:50

balazsorban44 force-pushed the main branch from 6445eb6 to 4258857 Compare February 5, 2023 13:41

balazsorban44 closed this Mar 25, 2023

Conversation

christoph-pflueger commented Jun 21, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

☕️ Reasoning

🧢 Checklist

🎫 Affected issues

📌 Resources

Uh oh!

vercel bot commented Jun 21, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DitlevHB commented Jul 28, 2022

Uh oh!

qiqo commented Aug 25, 2022

Uh oh!

christoph-pflueger commented Aug 25, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

devrsi0n commented Aug 27, 2022

Uh oh!

qiqo commented Aug 27, 2022

Uh oh!

ThangHuuVu left a comment

Choose a reason for hiding this comment

Uh oh!

christoph-pflueger commented Sep 2, 2022

Uh oh!

shahryarjb commented Sep 25, 2022

Uh oh!

mohamedGamalAbuGalala commented Oct 25, 2022

Uh oh!

rustunooldu commented Nov 9, 2022

Uh oh!

raulmarindev commented Nov 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lemcii commented Nov 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

christoph-pflueger commented Nov 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

shahryarjb commented Nov 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rolanday commented Dec 22, 2022

Uh oh!

devrsi0n Dec 23, 2022

Choose a reason for hiding this comment

Uh oh!

kblizeck commented Jan 13, 2023

Uh oh!

balazsorban44 commented Mar 25, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

13 participants

christoph-pflueger commented Jun 21, 2022 •

edited

Loading

vercel bot commented Jun 21, 2022 •

edited

Loading

christoph-pflueger commented Aug 25, 2022 •

edited

Loading

raulmarindev commented Nov 9, 2022 •

edited

Loading

lemcii commented Nov 9, 2022 •

edited

Loading

christoph-pflueger commented Nov 9, 2022 •

edited

Loading

shahryarjb commented Nov 9, 2022 •

edited

Loading