Skip to content

feat(nextjs,shared): Improve CLERK_API_URL default value - #1955

Merged
desiprisg merged 2 commits into
mainfrom
improve_api_url_default
Nov 3, 2023
Merged

feat(nextjs,shared): Improve CLERK_API_URL default value#1955
desiprisg merged 2 commits into
mainfrom
improve_api_url_default

Conversation

@desiprisg

@desiprisgdesiprisg commented Oct 30, 2023•
edited
Loading

Copy link
Copy Markdown
Contributor

Description

Improve the default value for CLERK_API_URL by utilizing the publishable key to differentiate between local, staging and prod environments.

We can also add this to other packages that can import the shared package.

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 30, 2023•
edited
Loading

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 149da8b

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

This PR includes changesets to release 11 packages
NameType
@clerk/nextjsPatch
@clerk/remixPatch
gatsby-plugin-clerkPatch
@clerk/sharedPatch
@clerk/fastifyPatch
@clerk/backendPatch
@clerk/clerk-jsPatch
@clerk/clerk-expoPatch
@clerk/clerk-reactPatch
@clerk/clerk-sdk-nodePatch
@clerk/chrome-extensionPatch

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

@desiprisg
desiprisg requested a review from a teamOctober 30, 2023 01:40
@desiprisg
desiprisgforce-pushed the improve_api_url_default branch from a36d4a2 to 1a2021cCompareOctober 30, 2023 01:52
octoper
octoper approved these changes Oct 30, 2023
View reviewed changes

@octoperoctoper 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.

💯

LekoArts
LekoArts suggested changes Oct 30, 2023
View reviewed changes
Comment thread.changeset/rude-jobs-yawn.md Outdated
Comment threadpackages/shared/src/index.ts
Comment threadpackages/shared/src/utils/apiUrlFromPublishableKey.ts Outdated
panteliselef
panteliselef suggested changes Oct 30, 2023
View reviewed changes

@panteliselefpanteliselef 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.

❓ Shouldn't we merge to main-v4 ?

Comment threadpackages/shared/src/utils/apiUrlFromPublishableKey.ts Outdated
SokratisVidros
SokratisVidros reviewed Oct 30, 2023
View reviewed changes
Comment threadpackages/shared/src/constants.ts Outdated
@dimkl

dimkl commented Oct 30, 2023

Copy link
Copy Markdown
Contributor

❓ Shouldn't we merge to main-v4 ?

@panteliselef even though this is not a breaking change we should merge it to main. This is an improvement in our current resolution of apiUrl and not a hotfix that should be deployed to main-v4.

dimkl
dimkl reviewed Oct 30, 2023
View reviewed changes
Comment threadpackages/gatsby-plugin-clerk/src/constants.ts Outdated
@desiprisg
desiprisgforce-pushed the improve_api_url_default branch from 1a2021c to 7f31f93CompareOctober 30, 2023 17:11
@desiprisg

desiprisg commented Oct 31, 2023•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

Not merging yet as DEV_OR_STAGING_SUFFIXES seems to mean dev as in dev instance and not local. This is why accounts.dev in included in there. I'll have to make a different suffixes array for this case only.

dimkl
dimkl suggested changes Oct 31, 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.

Blocking this PR until unit test is added to avoid accidentally merging it.

@desiprisg
desiprisgforce-pushed the improve_api_url_default branch from 1318b2f to 7c56c1eCompareOctober 31, 2023 12:47
panteliselef
panteliselef reviewed Oct 31, 2023
View reviewed changes
Comment threadpackages/shared/src/constants.ts Outdated
LekoArts
LekoArts suggested changes Nov 1, 2023
View reviewed changes
Comment threadpackages/clerk-js/src/utils/url.ts Outdated
Comment threadpackages/nextjs/src/server/url.ts Outdated
@desiprisg
desiprisgforce-pushed the improve_api_url_default branch 3 times, most recently from e887e97 to a0e4b24CompareNovember 2, 2023 12:49
LekoArts
LekoArts suggested changes Nov 2, 2023
View reviewed changes

@LekoArtsLekoArts 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.

If you add apiUrlFromPublishableKey and constants as individual files and to the export of the main index file you'll need to add both here:

  1. https://github.com/clerkinc/javascript/blob/main/packages/shared/package.json#L47-L68
  2. https://github.com/clerkinc/javascript/blob/main/packages/shared/subpaths.mjs#L4-L23

@desiprisg
desiprisgforce-pushed the improve_api_url_default branch from 33ea988 to 0de2540CompareNovember 2, 2023 14:10
@desiprisg
desiprisgforce-pushed the improve_api_url_default branch 2 times, most recently from 1526d50 to 028876cCompareNovember 3, 2023 10:55
@desiprisg
desiprisgforce-pushed the improve_api_url_default branch from 028876c to ee9cdfdCompareNovember 3, 2023 11:07
@dimkl
dimkl self-requested a review November 3, 2023 14:11
dimkl
dimkl reviewed Nov 3, 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.

I reverted the request changes

@dimkl
dimkl self-requested a review November 3, 2023 14:13
@desiprisg
desiprisg added this pull request to the merge queue Nov 3, 2023
@tmilewski
tmilewski removed this pull request from the merge queue due to a manual request Nov 3, 2023
@desiprisg
desiprisg added this pull request to the merge queue Nov 3, 2023
Merged via the queue into main with commit 7644b74Nov 3, 2023
@desiprisg
desiprisg deleted the improve_api_url_default branch November 3, 2023 15:32
@clerk-cookieclerk-cookie mentioned this pull request Nov 3, 2023
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dimkldimklAwaiting requested review from dimkl
5 more reviewers
@SokratisVidrosSokratisVidrosSokratisVidros left review comments
@panteliselefpanteliselefpanteliselef approved these changes
@gkatsgkatsgkats approved these changes
@octoperoctoperoctoper approved these changes
@LekoArtsLekoArtsLekoArts approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

clerk-jsfastifynextjsremix

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@desiprisg@dimkl@gkats@SokratisVidros@octoper@LekoArts@panteliselef@clerk-cookie