fix: discard preload fork when navigating to a different route#15071
Closed
gordysc wants to merge 6 commits intosveltejs:mainfrom
Closed
fix: discard preload fork when navigating to a different route#15071gordysc wants to merge 6 commits intosveltejs:mainfrom
gordysc wants to merge 6 commits intosveltejs:mainfrom
Conversation
🦋 Changeset detectedLatest commit: d067b45 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 |
Contributor
|
Much needed fix! There's also this related underlying issue too sveltejs/svelte#17335 |
Member
|
I don't think this PR fixes the issue. I tested it against the reproduction from the issue and it does not work. The tests in this PR also pass even without the fix. I'm going to close this to keep the PR queue clean but let me know if you want me to reopen it. |
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
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.
Fixes #14987
When preloading a route via
data-sveltekit-preload-data="hover"and then navigating to a different route, the preload fork was not being discarded. This caused the orphan fork to interfere with subsequent DOM updates, resulting in the URL changing but page content remaining stale - particularly noticeable when navigating between routes with different layouts.The issue was at line 1696 in
client.js: when the navigation intent didn't match the preloaded route's ID, we correctly setload_cache_fork = nullbut only cleared theload_cachereference withload_cache = null. This failed to callfork.discard()on the orphan fork.The fix conditionally calls
discard_load_cache()(which properly discards the fork) when we're not using the preloaded fork, instead of just clearing the reference.Please don't delete this checklist! Before submitting the PR, please make sure you do the following:
Tests
pnpm testand lint the project withpnpm lintandpnpm checkChangesets
pnpm changesetand following the prompts. Changesets that add features should beminorand those that fix bugs should bepatch. Please prefix changeset messages withfeat:,fix:, orchore:.Edits