chore(nextjs): Introduce build-time error for server-only helpers on client-side #3758
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: e8048e9 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
LauraBeatris
force-pushed
the
server-only-build-time-error
branch
from
1fa5832
to
790eea2
Compare
LauraBeatris
changed the title
LauraBeatris
changed the title
LauraBeatris
commented
Jul 18, 2024
| @@ -1,3 +1,5 @@ | |||
| jest.mock('server-only', () => null); | |||
There was a problem hiding this comment.
It's tricky to run server-only on Jest due to its multiple environments. I went ahead and decided to mock it instead:
LauraBeatris
commented
Jul 18, 2024
| @@ -1,3 +1,5 @@ | |||
| import 'server-only'; | |||
There was a problem hiding this comment.
I've imported it separately on auth and currentUser only instead of importing it once on server index.
My concern is that the error would be thrown even when importing type definitions, but I'd like to minimize the surface here.
tmilewski
approved these changes
Jul 18, 2024
9 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Resolves #3660
Uses the
server-onlypackage to throw a build-time error if Clerk server-side helpers get accidentally imported on the client side.Checklist
npm testruns as expected.npm run buildruns as expected.Type of change