Document the current state of the Real-Time collaboration experiment #54932
Conversation
| @@ -0,0 +1,56 @@ | |||
| # Status of the sync experiment in Gutenberg | |||
There was a problem hiding this comment.
Do you think this could be in the README directly, why did you go with CODE.md?
There was a problem hiding this comment.
I wasn't sure where to put this, given it documents an experiment that is split across core-data and sync packages. The README is published in the block editor handbook, and I'm not sure if it merits such visibility. I thought the README was also used in the page of the public @wordpress/sync package, although it seems it doesn't.
Happy to add it to the README or move it anywhere else.
There was a problem hiding this comment.
Maybe it's fine to keep it separate like that but link to it from the README or something for discoverability.
There was a problem hiding this comment.
How about we iterate on this file until we have something we are happy with, and then we decide where to show it?
packages/sync/CODE.md
Outdated
|
|
||
| - Undo/redo does not work. | ||
| - Changes can be persisted. | ||
| - When changes are persisted (publish/update a post), the other peers don't have a visual hint (publish/update button is still enabled). |
There was a problem hiding this comment.
I'm not sure this is true. The other peers should receive the visual hint because both the "edits" and the persisted entity are shared.
There was a problem hiding this comment.
It must be something that failed for me for a different reason at some point. For example, at some point, I was able to update an existing post, though I'm now unable 🤔
Gravacao.do.ecra.2023-10-03.as.08.33.14.mov
I just switched a post from published to draft, and it was broadcasted to other peers – so it does work.
There was a problem hiding this comment.
Though it's fairly easy for them to get out of sync (notice how the right screen has the button disabled while the left one has it enabled):
Then, I reloaded the browser at the right screen and this is what happened (right is enabled, left is disabled):
|
@youknowriad how do you feel about merging as it is? I'd like to document a bit the signaling process, using this file as base in Jorge's PR (so it'd be convenient to me to have the file merged). |
packages/sync/CODE.md
Outdated
| - Changes can be persisted and the publish/update button should react accordingly for all peers. | ||
| - Offline. | ||
| - Changes are stored in the browser's local storage (indexedDB) for each user/peer. Users can navigate away from the document and they'll see the changes when they come back. | ||
| - Visually, there is no hint that they are seeing local/offline changes vs published ones. |
There was a problem hiding this comment.
I don't understand this point. It seems independent of real time collaboration or offline editing. When you have edits, you just see that your post is unsaved no?
There was a problem hiding this comment.
Removed that point. I'm not sure if it's related to offline mode, it sounds like an issue with the button status, see #54932 (comment)
|
Flaky tests detected in 6d3f45b. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/6391784285
|
bph
added
the
[Feature] Real-time Collaboration
Related #52593
Add some notes to document how the Real-Time collaboration experiment works at the moment. This is a minimal and ongoing effort, to have some low-level notes to help navigate the code, complementing what has already been shared in make/core and the tracking issue.