-
Notifications
You must be signed in to change notification settings - Fork 78
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
fix: prevent vitetest/ssr errors due to defining components on the server #7521
Merged
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
const isBrowser = (): boolean => | ||
![typeof window, typeof document, typeof location].includes("undefined") && | ||
[typeof process, typeof global].includes("undefined") && | ||
window.location === location && | ||
window.document === document; | ||
|
||
export function autoDefine(component: string) { | ||
benelan marked this conversation as resolved.
Show resolved
Hide resolved
|
||
if (isBrowser()) { | ||
return async () => (await import(`@esri/calcite-components/dist/components/${component}.js`)).defineCustomElement(); | ||
} | ||
return undefined; | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
// patch needed due to Stencil executing client side code on the server | ||
// when using the includeImportCustomElements option | ||
// https://stenciljs.com/docs/react#includeimportcustomelements | ||
// https://github.com/Esri/calcite-design-system/issues/7486 | ||
|
||
const { | ||
promises: { readFile, writeFile }, | ||
} = require("fs"); | ||
const { dirname, resolve } = require("path"); | ||
|
||
(async () => { | ||
try { | ||
const filePath = resolve(`${__dirname}/../src/components.ts`); | ||
const contents = await readFile(filePath, { encoding: "utf8" }); | ||
|
||
const defineCustomElementImports = /import { defineCustomElement as defineCalcite.*(\r\n|\r|\n)/gm; | ||
benelan marked this conversation as resolved.
Show resolved
Hide resolved
|
||
const reactWrapperExports = /createReactComponent<(.*)>.*\((['|\w|-]*)(.*)(defineCalcite\w*)\)/g; | ||
|
||
const patchedContents = contents | ||
.replace( | ||
"import { createReactComponent } from './react-component-lib';", | ||
"$&\nimport { autoDefine } from './auto-define';" | ||
) | ||
.replace(defineCustomElementImports, "") | ||
.replace(reactWrapperExports, "createReactComponent<$1>($2$3autoDefine($2))"); | ||
|
||
await writeFile(filePath, patchedContents); | ||
} catch (err) { | ||
console.error(err); | ||
process.exit(1); | ||
} | ||
})(); |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion (minor): The result of this can be computed earlier or cached. Multiple
autoDefine
calls run the same logic.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Per our Teams conversation, we decided to leave this as is for now just to be very safe.
It is possible (but unlikely) that if we change isBrowser to a constant its could be cached on the server as
false
by an SSR framework trying to be too smart. If this were to happen and the constant didn't get reevaluated on the client, the components would never be defined.This needs a bit more investigation.