Allow sync provider to be filtered #70916
Closed
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
This filter allows external code to load its own sync provider. This can be used by both Gutenberg itself and plugins to customize the sync transport.
|
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. |
... but dangerously, as I don't fully understand it!
mcsf
reviewed
Jul 31, 2025
Comment on lines
+9
to
+15
| wp: { | ||
| ajax: { | ||
| settings: { | ||
| url: string; | ||
| }; | ||
| }; | ||
| }; |
Contributor
There was a problem hiding this comment.
Shouldn't these be optional? Otherwise TS will allow consumers of the type to directly access wp.ajax.... without optional chaining.
Contributor
Author
|
Closing in favor of filtering "provider creators" as implemented by #72183. |
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?
Follow up to #68483
core.getSyncProvider) to allow third-party code to load a custom sync provider (transport).Conditionally load theWe have found a new method for avoiding this conflict using a Webpack alias@wordpress/syncpackage to avoid creating conflicts with third-party code (see below).Why?
There is probably no such thing as a universal transport for collaborative editing. Transports place demands on hosting providers that may require complex configuration changes or present scaling challenges. A WebSocket transport, for example, might be ideal for Host A but unworkable for Host B.
Providing a mechanism for custom sync providers will allow us to ship multiple options side-by-side, letting an administrator choose the best one. It will also allow developers and hosting platforms to inject or configure their own transport, if desired.
Additionally, our choice of Yjs comes with an architectural constraint: Yjs expects to be imported and instantiated exactly once. Therefore, Yjs cannot be imported both in Gutenberg and in a separate plugin, because they are separately bundled, will resolve to separate instances, and will result in the linked issue.We therefore need a way to conditionally load any sync providers included in Gutenberg. If a custom sync provider is injected, we need to be certain that Yjs is not loaded at all by Gutenberg.This issue has been separately resolved.How?
core.getSyncProvider) as the default mechanism for resolving the sync provider. When no sync provider is available, a default "no-op" sync provider is loaded. This removes the need for defensive checks whenever the sync provider is loaded.Testing Instructions
Note: The collaboration experiment is broken in
trunkand remains so in this branch. We will open additional PRs to restore the experiment to a working state, along with additional changes to introduce alternative transports.TypeError: undefined is not an object (evaluating 'config[objectType].fromCRDTDoc'). This is the result of the current non-working state of the experiment. Observe thatwp.syncis defined.Testing Instructions for Keyboard
Same as above.