RTC: Add optional shouldSync function to entity sync config#76947
Merged
alecgeatches merged 3 commits intotrunkfrom Apr 7, 2026
Merged
RTC: Add optional shouldSync function to entity sync config#76947alecgeatches merged 3 commits intotrunkfrom
shouldSync function to entity sync config#76947alecgeatches merged 3 commits intotrunkfrom
Conversation
chriszarate
added
the
[Type] Task
chriszarate
added
the
[Feature] Real-time Collaboration
|
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. |
|
Size Change: +44 B (0%) Total Size: 7.74 MB 📦 View Changed
ℹ️ View Unchanged
|
|
Flaky tests detected in 2d20936. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/24095556867
|
alecgeatches
approved these changes
Apr 7, 2026
Contributor
alecgeatches
left a comment
alecgeatches
left a comment
There was a problem hiding this comment.
Makes sense to me! Will merge when tests pass.
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
3 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.
What?
Add optional
shouldSyncfunction to entity sync config to control whether an entity or entity collection should be synced.Closes #76932
Why?
In #76932, @mmtr notes that when a
core/commentsblock is added to a post with existing comments, each comment is loaded for syncing, even though there is no possibility of collaborating on those comments. This contributes to unnecessary resource usage: additional WebSocket connections (if using a WebSocket provider) or additional database storage (if using the default polling provider).The root cause is that the
commententity is used for both regular post comments and block comments. By enabling sync for block comments, we also enable syncing for regular post comments.It might be ideal to represent block comments as a separate entity (e.g.,
blockComment) that targets the same REST API endpoint ascomment. However, this would require changes both to the block comments feature as well as the permissions system.An alternative approach, taken in this PR, is to add an optional
shouldSyncfunction to the entity sync config, allowing it to control whether specific entities or entity collections should be loaded. This will probably find utility in other circumstances. Often, we want to sync individual entities but not the collection, or vice versa. We might also want a way to sync specific entity subtypes while excluding others.How?
Add an optional
shouldSyncfunction to the entity sync config. If it is present and returnsfalse, the entity or collection are not synced.Testing Instructions
1/ "Hello world") and open it for editing./wp-json/wp-sync/v1/updates.root/comment:nwherenis the comment ID.