Wait for body to be replaced before caching snapshot when <head> changes#1494
Open
janko wants to merge 1 commit intohotwired:mainfrom
Open
Wait for body to be replaced before caching snapshot when <head> changes#1494janko wants to merge 1 commit intohotwired:mainfrom
<head> changes#1494janko wants to merge 1 commit intohotwired:mainfrom
Conversation
…anges When navigating to a page with new `<head>` children, the body replacement will be delayed by evaluating the new stylesheet/script elements. In Stimulus context, this means any controller `disconnect()` callbacks will be delayed as well. Because there is currently no waiting for the body to be replaced before capturing a snapshot of the previous page, the disconnect callbacks might not have finished in time. This can result in Turbo including dynamicaly created UI components in the page snapshot that didn't have time to tear down. On restoration visit, Turbo will load the cached snapshot together with the UI components, and then Stimulus `connect()` callbacks will create them again, resulting in duplicated UI components. We can mitigate this by waiting for the new page to render before capturing the snapshot – i.e. body to finish replacing – ensuring any `disconnect()` callbacks will have finished by then.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
When navigating to a page with new
<head>children, the body replacement will be delayed by evaluating the new stylesheet/script elements.In Stimulus context, this means any controller
disconnect()callbacks will be delayed as well. Because there is currently no waiting for the body to be replaced before capturing a snapshot of the previous page, the disconnect callbacks might not have finished in time.This can result in Turbo including dynamicaly created UI components in the page snapshot that didn't have time to tear down. On restoration visit, Turbo will load the cached snapshot together with the UI components, and then Stimulus
connect()callbacks will create them again, resulting in duplicated UI components.We can mitigate this by waiting for the new page to render before capturing the snapshot – i.e. body to finish replacing – ensuring any
disconnect()callbacks will have finished by then.Fixes #1397