Interactivity API: Fix navigate() issues related to initial state merges
#57134
Conversation
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
47 tasks
|
Size Change: +2.75 kB (0%) Total Size: 1.71 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in 80f28ad. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/8012361745
|
|
We need to avoid overriding the getters, because the state in the server is just their initial state: wp_initial_state( "myPlugin", array(
"counter": 1,
"double": 2
));const { state } = store("myPlugin", {
state: {
get double() {
return state.counter * 2;
},
},
}); |
gziolo
added
[Feature] Interactivity API
DAreRodz
force-pushed
the
add/interactivity-api-merge-initial-state
branch
from
7ca0847
to
ffa8db8
Compare
DAreRodz
changed the title
navigate() callsnavigate() calls
DAreRodz
changed the title
navigate() callsnavigate() issues related to initial state merges
DAreRodz
requested review from
kevin940726,
Mamaduka and
ntwb
as code owners
DAreRodz
requested review from
nerrad,
ajitbohra and
luisherranz
as code owners
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
luisherranz
approved these changes
Feb 26, 2024
9 tasks
getdave
added
Backported to WP Core
|
I just manually cherry-picked this PR to the cherry-pick-wp-6-5-beta-3 branch to get it included in the next release. |
getdave
pushed a commit
that referenced
this pull request
Feb 27, 2024
…erges (#57134) * Use deepMerge and stores to update state * Add test case * Do not render state when `data` is not present * Move batch call inside braces * Move initial data related code together * Fix initial data tag ID * Prevent passing the state proxy as receiver * Add comment * Move links to a nav element to prevent hydration issues * Add failing test for getters merge * Simplify assignments * Add a try-catch to ignore getter assignments * Fix disabled navigation test * Test navigations to pages with csn disabled * Update changelogs Co-authored-by: DAreRodz <darerodz@git.wordpress.org> Co-authored-by: luisherranz <luisherranz@git.wordpress.org> # Conflicts: # packages/interactivity-router/CHANGELOG.md # packages/interactivity/CHANGELOG.md
getdave
pushed a commit
that referenced
this pull request
Feb 27, 2024
…erges (#57134) * Use deepMerge and stores to update state * Add test case * Do not render state when `data` is not present * Move batch call inside braces * Move initial data related code together * Fix initial data tag ID * Prevent passing the state proxy as receiver * Add comment * Move links to a nav element to prevent hydration issues * Add failing test for getters merge * Simplify assignments * Add a try-catch to ignore getter assignments * Fix disabled navigation test * Test navigations to pages with csn disabled * Update changelogs Co-authored-by: DAreRodz <darerodz@git.wordpress.org> Co-authored-by: luisherranz <luisherranz@git.wordpress.org> # Conflicts: # packages/interactivity-router/CHANGELOG.md # packages/interactivity/CHANGELOG.md
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.
What?
Epic: #56803
Related discussion: #53056
Fixes the initial state not being merged with the current state during
navigate()calls and the page not being reloaded whenclientNavigationDisabledis true for the target page.Also, fixes a hidden bug related to state proxies being passed as the
receiverto deepSignal proxy handlers.How?
The
@wordpress/interactivitymodule now exposes three more private functions:parseInitialData: deserializes and returns the content of the initial data tag.populateInitialData: merges the passed data onto the current state/config. Property values are overwritten, except for getters.batch: the Preact signals'batchfunction.Those functions are used by the
@wordpress/interactivity-routermodule to preserve a cached copy of the initial state and update the global state during navigation. That update occurs inside abatchcall to prevent directives from updating before the new page rendering has finished.