fix: properly disable `getSession` endpoint for local and refresh

Armillus commented 5 months ago

🔗 Linked issue

https://github.com/sidebase/nuxt-auth/issues/761

❓ Type of change

[x] 📖 Documentation (updates to the documentation, readme or JSdoc annotations)
[x] 🐞 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

The linked issue just covered half of the problem ; in the current form, getSession cannot be disabled, even with a configuration extracted from the documentation such as:

{
  auth: {
    baseURL: '/api/auth',
    provider: {
      type: 'local',
      endpoints: {
        getSession: false,
      }
    }
  }
}

It's not an issue while you're not calling it, except that it is called by signIn anyways, at least with the local and refresh providers. Eventually, it means that an unexpected HTTP request is sent, which on one hand is inefficient, and on the other hand throws an exception from signIn, thus making it fail.

To fix those problems, this PR is applying the same strategy for getSession as for signOut, in both the function implementation and the exported type.

📝 Checklist

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

zoey-kaiser commented 4 months ago

Hi @Armillus 👋

Firstly, I love the PR title 😆. Thank you for pushing this change, and I apologize for the short delay. I had just run the CI checks on your PR and sadly there are some prepack issues. Could you please look into resolving these 🤗

Armillus commented 4 months ago

Hi @zoey-kaiser,

I'm glad you liked the title 😄 No problem regarding the delay! The prepack issue should be fixed now.

zoey-kaiser commented 4 months ago

The prepack issue should be fixed now.

They are indeed! Thank you so much! There is one small linting issue and otherwise I think we are good to go. Once we get this PR through, I will release a first RC of 0.8.0!

Armillus commented 4 months ago

Wonderful! I fixed linting issues as well, sorry for the slight inconvenience.

zoey-kaiser commented 4 months ago

Hi @Armillus 👋

After testing this PR in 0.8.0, we decided to revert it. You can find a full explanation here: https://github.com/sidebase/nuxt-auth/issues/781#issuecomment-2209074510

sidebase / nuxt-auth