Skip to content

fix(nextjs): Drop user, session, organization from auth() - #1947

Merged
panteliselef merged 2 commits into
mainfrom
SDK-696-deprecate-resources
Oct 30, 2023
Merged

fix(nextjs): Drop user, session, organization from auth()#1947
panteliselef merged 2 commits into
mainfrom
SDK-696-deprecate-resources

Conversation

@panteliselef

@panteliselefpanteliselef commented Oct 26, 2023•
edited
Loading

Copy link
Copy Markdown
Contributor

Description

In this PR we are dropping user, session, and organization resouces from the returned value of auth(). They were never officially supported as the middleware didn't support types for loadUser, loadSession.

Although by passing the types errors you could still load the resources. We consider bad practice to have extra 1-3 requests for each request that middleware captures so we should not allow developers to expect the resources returned from auth will be populated.

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Packages affected

  • @clerk/clerk-js
  • @clerk/clerk-react
  • @clerk/nextjs
  • @clerk/remix
  • @clerk/types
  • @clerk/themes
  • @clerk/localizations
  • @clerk/clerk-expo
  • @clerk/backend
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/fastify
  • @clerk/chrome-extension
  • gatsby-plugin-clerk
  • build/tooling/chore

@changeset-bot

changeset-botBot commented Oct 26, 2023•
edited
Loading

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 1399570

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
NameType
@clerk/nextjsPatch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@panteliselef
panteliselefforce-pushed the SDK-696-deprecate-resources branch from a6bfe10 to 866a06dCompareOctober 26, 2023 19:24
@panteliselefpanteliselef self-assigned this Oct 26, 2023
@panteliselef
panteliselef marked this pull request as ready for review October 26, 2023 19:29
anagstef
anagstef approved these changes Oct 26, 2023
View reviewed changes

@anagstefanagstef left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🎉

@panteliselef
panteliselefforce-pushed the SDK-696-deprecate-resources branch from 866a06d to 89f0185CompareOctober 29, 2023 21:08
@panteliselef
panteliselef added this pull request to the merge queue Oct 29, 2023
@panteliselef
panteliselef removed this pull request from the merge queue due to a manual request Oct 29, 2023
@panteliselef
panteliselef added this pull request to the merge queue Oct 30, 2023
dimkl
dimkl reviewed Oct 30, 2023
View reviewed changes

@dimkldimkl left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🔧 We should deprecate those return values in v4 before dropping them from auth() in v5.

@dimkl
dimkl removed this pull request from the merge queue due to a manual request Oct 30, 2023
@panteliselef
panteliselefforce-pushed the SDK-696-deprecate-resources branch from 89f0185 to 1399570CompareOctober 30, 2023 09:34
@panteliselefpanteliselef mentioned this pull request Oct 30, 2023
Merged
24 tasks
nikosdouvlis
nikosdouvlis approved these changes Oct 30, 2023
View reviewed changes
Comment threadpackages/nextjs/src/server/getAuth.ts

type GetAuthOpts = Partial<SecretKeyOrApiKey>;

type AuthObjectWithoutResources<T extends AuthObject> = Omit<T, 'user' | 'organization' | 'session'>;

@nikosdouvlisnikosdouvlisOct 30, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Note: we need to rethink how the backend types propagate, as I think we shouldn't resort to this low-level workarounds here. This PR is fine as we need a quick fix, but we should revisit in the future

@panteliselef
panteliselef added this pull request to the merge queue Oct 30, 2023
@dimkl
dimkl removed this pull request from the merge queue due to a manual request Oct 30, 2023
@dimkl
dimkl added this pull request to the merge queue Oct 30, 2023
@github-merge-queue
github-merge-queueBot removed this pull request from the merge queue due to no response for status checks Oct 30, 2023
@panteliselef
panteliselef added this pull request to the merge queue Oct 30, 2023
Merged via the queue into main with commit e5598cfOct 30, 2023
@panteliselef
panteliselef deleted the SDK-696-deprecate-resources branch October 30, 2023 17:07
@LekoArtsLekoArts mentioned this pull request Oct 31, 2023
Closed
@clerk-cookieclerk-cookie mentioned this pull request Nov 1, 2023
Merged
tmilewski pushed a commit that referenced this pull request Nov 17, 2023
@panteliselef@tmilewski
fix(nextjs): Dropuser,session,organizationfromauth()(#1947
9b1b4d0
)
* fix(nextjs): Drop `user`, `session`, `organization` from `auth()`
* fix(nextjs): Typo in changeset
@clerk-cookie

clerk-cookie commented Oct 30, 2024

Copy link
Copy Markdown
Collaborator

This PR has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@clerkclerk locked as resolved and limited conversation to collaborators Oct 30, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@tmilewskitmilewskitmilewski approved these changes
@nikosdouvlisnikosdouvlisnikosdouvlis approved these changes
+2 more reviewers
@dimkldimkldimkl left review comments
@anagstefanagstefanagstef approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@panteliselefpanteliselef

Labels

nextjs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@panteliselef@clerk-cookie@tmilewski@nikosdouvlis@dimkl@anagstef