iAPI: Fix using getServerContext in derived state getters
#73518
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
|
Size Change: +19 B (0%) Total Size: 2.54 MB
ℹ️ View Unchanged
|
Member
Author
|
@t-hamano I'm also working on this fix for 6.9 RC3, related to I have it working, although I still want to give the solution another thought in case there is a better way to fix it. I'll have it ready before tomorrow. |
|
Flaky tests detected in bfd0742. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/19639118509
|
|
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. |
DAreRodz
approved these changes
Nov 24, 2025
Contributor
DAreRodz
left a comment
There was a problem hiding this comment.
I've tested it, and the fix works as expected. I've also ensured the test passes only with the fix in place.
Codewise, using useLayoutEffect makes sense to me: the signal invalidation occurs right after the render finishes and before any visual changes are made. It is true that it could cause re-renders and multiple getters re-evaluation, but at least this shouldn't visually affect the layout.
Thanks for the fix, @luisherranz! ❤️
…within a microtask
…updates within a microtask" This reverts commit c2bf701.
Member
Author
|
Thanks David!
I have been testing it, and I think Preact batches that phase internally because, even though the signal is invalidated multiple times, the computations only run once. However, there is indeed a difference between the invalidation done for the state during Merging now 👍 |
luisherranz
commented
Nov 24, 2025
|
There was a conflict while trying to cherry-pick the commit to the wp/6.9 branch. Please resolve the conflict manually and create a PR to the wp/6.9 branch. PRs to wp/6.9 are similar to PRs to trunk, but you should base your PR on the wp/6.9 branch instead of trunk. |
luisherranz
added a commit
that referenced
this pull request
Nov 24, 2025
* Add failing test for context * Fix test * Add changelog * Don't trigger invalidations twice in the navigation phase * Debounce navigation signal invalidation to prevent redundant updates within a microtask * Revert "Debounce navigation signal invalidation to prevent redundant updates within a microtask" This reverts commit c2bf701. * Use a different navigation signal for context Co-authored-by: luisherranz <luisherranz@git.wordpress.org> Co-authored-by: DAreRodz <darerodz@git.wordpress.org>
Member
Author
t-hamano
added a commit
that referenced
this pull request
Nov 25, 2025
…73531) * Add failing test for context * Fix test * Add changelog * Don't trigger invalidations twice in the navigation phase * Debounce navigation signal invalidation to prevent redundant updates within a microtask * Revert "Debounce navigation signal invalidation to prevent redundant updates within a microtask" This reverts commit c2bf701. * Use a different navigation signal for context Co-authored-by: luisherranz <luisherranz@git.wordpress.org> Co-authored-by: DAreRodz <darerodz@git.wordpress.org> Co-authored-by: t-hamano <wildworks@git.wordpress.org>
Contributor
|
This PR was manually backported into the |
This was referenced Nov 25, 2025
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?
Fixes an issue where derived state using
getServerContextwas not updating correctly during client-side navigation in the Interactivity API.Why?
When navigating between pages using the Interactivity API router, the server context changes. However, derived state properties that relied on
getServerContext()were not being re-evaluated or invalidated correctly in some scenarios, causing them to return stale data from the previous page.How?
We added a
useLayoutEffectin the router region directive to trigger anavigationSignalupdate when the VDOM changes. This ensures that any reactive dependencies, including those relying ongetServerContext, are properly notified and updated when the router region content is replaced during navigation.Testing Instructions
npm run test:e2e packages/e2e-tests/specs/interactivity/get-sever-context.spec.ts