-
Notifications
You must be signed in to change notification settings - Fork 26.3k
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: ensure hidden iframe apps render in development mode #39514
Merged
Merged
Changes from all commits
Commits
Show all changes
2 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,24 @@ | ||
// This wrapper function is used to avoid raising a Trusted Types violation. | ||
const safeSetTimeout = (callback: () => void) => setTimeout(callback) | ||
// This wrapper function is used to safely select the best available function | ||
// to schedule removal of the no-FOUC styles workaround. requestAnimationFrame | ||
// is the ideal choice, but when used in iframes, there are no guarantees that | ||
// the callback will actually be called, which could stall the promise returned | ||
// from displayContent. | ||
// | ||
// See: https://www.vector-logic.com/blog/posts/on-request-animation-frame-and-embedded-iframes | ||
const safeCallbackQueue = (callback: () => void) => { | ||
if (window.requestAnimationFrame && window.self === window.top) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Even though the issue is with hidden iframes, I think it's safe to scope this check to iframes in general (given that this is a |
||
window.requestAnimationFrame(callback) | ||
} else { | ||
window.setTimeout(callback) | ||
} | ||
} | ||
|
||
// This function is used to remove Next.js' no-FOUC styles workaround for using | ||
// `style-loader` in development. It must be called before hydration, or else | ||
// rendering won't have the correct computed values in effects. | ||
export function displayContent(): Promise<void> { | ||
return new Promise((resolve) => { | ||
;(window.requestAnimationFrame || safeSetTimeout)(function () { | ||
safeCallbackQueue(function () { | ||
for ( | ||
var x = document.querySelectorAll('[data-next-hide-fouc]'), | ||
i = x.length; | ||
|
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.
Summary of the issue:
requestAnimationFrame
. This table breaks it down browser to browser. For example, on Chrome,window.requestAnimationFrame
is available, but the callback is never called in a hidden cross-origin iframe.displayContent
(below) is passed as an option tobeforeRender
which is specificallyawait
-ed before hydrating the app. IfdisplayContent
never resolves, the app never hydrates.