Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: ✨ add flag to disable getSession after signIn on local / refresh provider #702

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

bitfactory-frank-spee
Copy link

πŸ”— Linked issue

#701

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

See issue for clarification. This adds a flag to the signInOptions named withGetSession which defaults to true. This makes sure this will be backwards compatible. When withGetSession === false the getSession method will not be called.

This also includes a bug fix (681fdb0) where refresh was not equal to local provider.

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have added tests (if possible).
  • I have updated the documentation accordingly.

@phoenix-ru
Copy link
Collaborator

Hi @bitfactory-frank-spee , thanks for your contribution, it looks good to me.

I will come back to it after #694 , so that we can ensure that it's functionally good.

@phoenix-ru
Copy link
Collaborator

@bitfactory-frank-spee Could you please sync your PR with the current main?

@phoenix-ru
Copy link
Collaborator

bump @bitfactory-frank-spee

@bitfactory-frank-spee
Copy link
Author

@phoenix-ru I will update it this week πŸ‘

@bitfactory-frank-spee
Copy link
Author

@bitfactory-frank-spee Could you please sync your PR with the current main?

Done πŸš€

@zoey-kaiser zoey-kaiser added enhancement An improvement that needs to be added provider-local An issue with the local provider provider-refresh An issue with the refresh provider labels May 9, 2024
Copy link
Member

@zoey-kaiser zoey-kaiser left a comment

Choose a reason for hiding this comment

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

Hi @bitfactory-frank-spee πŸ‘‹

Very close to being done! I have one minor renaming request and then we should be good to go, to release this in 0.8!

@@ -103,12 +105,16 @@ await signIn(credentials, { callbackUrl: '/protected' })
// Trigger a sign-in with a redirect afterwards to an external page (if set, this will cause a hard refresh of the page)
await signIn(credentials, { callbackUrl: 'https://sidebase.io', external: true })

// Trigger a sign-in without calling getSession directly. You have to manually call it to get session data.
await signIn(credentials, { withGetSession: false })
Copy link
Member

Choose a reason for hiding this comment

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

Can we rename this new option from withGetSession to just getSession? I think this would be a bit more readable!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement An improvement that needs to be added provider-local An issue with the local provider provider-refresh An issue with the refresh provider
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feat: ✨ add flag to disable getSession after signIn on local / refresh provider
4 participants