fix: preserve $page.state when calling invalidate or invalidateAll #15266
+21
−1
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
The _invalidate function defaulted to reset_page_state=true, which caused $page.state (shallow routing state) to be cleared whenever invalidate() or invalidateAll() was called. This was unexpected since these functions are meant to re-run load functions, not affect navigation state. Changed the default to false, matching the behavior already used by refreshAll(). Added a test verifying state persistence across invalidation. Fixes sveltejs#11783
🦋 Changeset detectedLatest commit: 05a5aae 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 |
Member
Contributor
Author
|
Oh, I missed your existing PR — sorry about the duplicate! Closing in favor of #11810. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Summary
$page.state(shallow routing state set viapushState/replaceState) was incorrectly being cleared wheneverinvalidate()orinvalidateAll()was called. These functions are meant to re-run load functions, not affect navigation state.Root cause
The internal
_invalidate()function defaulted toreset_page_state = true, which causes the state to be wiped afterload_route()creates a new page object withstate: {}. Meanwhile,refreshAll()already correctly passesreset_page_state = false.Fix
Changed the default parameter from
reset_page_state = truetoreset_page_state = false, soinvalidate()andinvalidateAll()preserve the existing$page.state— consistent withrefreshAll().Fixes #11783
Test plan
pushState, callsinvalidateAll, verifies state is preserved and load function re-ran