Supply Awareness instance to connection and observe changes#33
Merged
Conversation
|
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. |
chriszarate
commented
Sep 19, 2025
| }, | ||
| LOCAL_SYNC_PROVIDER_ORIGIN, | ||
| false | ||
| true |
Member
Author
There was a problem hiding this comment.
This change to the local parameter is intentional. Previously, it had no effect because we ignored it and checked the origin against a list of known local origins. Now we check transaction.local so it needs to be updated to properly reflect a local update.
There was a problem hiding this comment.
Would add this as a comment here, and or at the top of this class to make sure it's known how important it is that this is followed.
Member
Author
There was a problem hiding this comment.
I might prefer to just omit the argument or move to ydoc.transact (where it's not even possible to override) instead of the more verbose Y.transact syntax. Local is the default and only needs to be overridden in rare circumstances.
ingeniumed
approved these changes
Sep 22, 2025
| }, | ||
| LOCAL_SYNC_PROVIDER_ORIGIN, | ||
| false | ||
| true |
There was a problem hiding this comment.
Would add this as a comment here, and or at the top of this class to make sure it's known how important it is that this is followed.
ingeniumed
requested changes
Sep 22, 2025
ingeniumed
left a comment
There was a problem hiding this comment.
I realized the undo/redo functionality is now broken in this branch. The undo/redo changes are visible on the remote client, but not on the local client.
undobug.mp4
|
Figured it out - it's because the transaction is a local one for the local client. The origin should also be checked in such cases to see if it's the undo manager or not. Something like the following will fix this if ( transaction.local && ( ! transaction.origin || ! ( typeof transaction.origin === 'object' && transaction.origin instanceof Y.UndoManager ) ) ) {
return;
}The idea for when the updates should be applied:
In any other case, the default behaviour of "if its not the origin we want, ignore it" should apply. |
|
Warning: Type of PR label mismatch To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.
Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task. |
|
Size Change: +195 B (+0.01%) Total Size: 1.93 MB
ℹ️ View Unchanged
|
Member
Author
👍 Done in d2fff34 |
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
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.
What?
Three related changes here:
SyncProviderin control of creating theAwarenessinstance (if supported) and store on entity state. This will be needed as we incorporate awareness / presence features from our plugin. Passing the awareness instance to the connection function gives extenders access to it early, which is needed to catch events that happen on connection or soon after..observe/.observeDeeplisteners for each root-level CRDT map instead of a single global.on( 'update' )listener. This allows us to organize our listener code and provides better performance.