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

chore(clerk-sdk-node): Drop noisy deprecation of unstable_options in sdk-node #1858

Merged
merged 1 commit into from
Oct 11, 2023

Conversation

dimkl
Copy link
Member

@dimkl dimkl commented Oct 10, 2023

Description

The sdk-node package is extending the backend Clerk with some extra methods. To do this, we expose a different Clerk from the sdk-node that returns the clerkClient instance of backend with some extra methods.
To add those extra methods to the return value we currently destruct the clerkClient to a new object and add the extra methods. By destructing the clerkClient, all it's methods and properties are being accessed, causing the __unstable_options deprecation warning to trigger and show the warning every time in applications using the sdk-node package.
To resolve this, we introduced an ExtendedClerk type as the return value of the sdk-node Clerk and changed the destructing to Object.assign(clerkClient, ...extra...).

Warning :

DEPRECATION WARNING: "__unstable_options" is deprecated and will be removed in the next major release.
Use `createClerkClient({...})` to create a new clerk instance instead.

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

@dimkl dimkl self-assigned this Oct 10, 2023
@dimkl dimkl requested a review from a team as a code owner October 10, 2023 23:48
@changeset-bot
Copy link

changeset-bot bot commented Oct 10, 2023

🦋 Changeset detected

Latest commit: 506337f

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

This PR includes changesets to release 3 packages
Name Type
@clerk/clerk-sdk-node Patch
gatsby-plugin-clerk Patch
@clerk/nextjs Patch

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

…sdk-node

The `sdk-node` package is extending the backend `Clerk` with some extra methods.
To do this, we expose a different `Clerk` from the `sdk-node` that returns
the `clerkClient` instance of backend with some extra methods.
To add those extra methods to the return value we currently destruct the
`clerkClient` to a new object and add the extra methods. By destructing the
`clerkClient`, all it's methods and properties are being accessed, causing
the `__unstable_options` deprecation warning to trigger and show the warning
every time in applications using the `sdk-node` package.
To resolve this, we introduced an `ExtendedClerk` type as the return value of
the sdk-node `Clerk` and changed the destructing to
`Object.assign(clerkClient, ...extra...)`.
@dimkl dimkl added this pull request to the merge queue Oct 11, 2023
Merged via the queue into main with commit 451fc33 Oct 11, 2023
6 checks passed
@dimkl dimkl deleted the fix-noisy-deprecations-sdk-node branch October 11, 2023 10:05
@clerk-cookie clerk-cookie mentioned this pull request Oct 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants