feat(clerk-react,nextjs): Speed up clerk-js loading by using a <script/> tag
#3156
Conversation
This file contains hidden or 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: 897e5b8 The changes in this PR will be included in the next version bump. This PR includes changesets to release 6 packages
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
requested review from
brkalow,
dimkl and
nikosdouvlis
and removed request for
nikosdouvlis
…e the next package
panteliselef
commented
Apr 10, 2024
Comment on lines
+25
to
+38
| const existingScript = document.querySelector<HTMLScriptElement>('script[data-clerk-js-script]'); | ||
|
|
||
| if (existingScript) { | ||
| return new Promise((resolve, reject) => { | ||
| existingScript.addEventListener('load', () => { | ||
| resolve(existingScript); | ||
| }); | ||
|
|
||
| existingScript.addEventListener('error', () => { | ||
| reject(FAILED_TO_LOAD_ERROR); | ||
| }); | ||
| }); | ||
| } | ||
|
|
There was a problem hiding this comment.
This also allows anyone to add a script without waiting for an official support.
brkalow
reviewed
Apr 11, 2024
brkalow
approved these changes
Apr 11, 2024
nikosdouvlis
approved these changes
Apr 11, 2024
| async | ||
| crossOrigin='anonymous' | ||
| {...buildClerkJsScriptAttributes(options)} | ||
| {...(props.router === 'pages' ? { strategy: 'beforeInteractive' } : {})} |
There was a problem hiding this comment.
Suggested change
| {...(props.router === 'pages' ? { strategy: 'beforeInteractive' } : {})} | |
| strategy: props.router === 'pages' ? 'beforeInteractive' : undefined |
dimkl
approved these changes
Apr 11, 2024
9 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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
Metrics (Fast 3G)
Previous 4120ms
New Nextjs 2907ms
-30% in loading time
Metrics (Cable)
Previous 613ms
New Nextjs 617ms
Almost no change
Nextjs
Benefits of using the
next/scriptis that it moves scripts inside<head/>in Pages router. It also has build it cache to avoid loading 2 scripts at the same time.Using
next/scriptwith our ClerkProvide that targets the App Router was not possible asnext/scriptneed to be used inside the "document" which means inside<html/>.More SSR Frameworks
<head/>.For these I would offer a dedicated
<ClerkJSScript/>.CSR React
Checklist
npm testruns as expected.npm run buildruns as expected.Type of change