Skip to content

fix(sync): push local changes on reconnect #5279

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
juliusknorr merged 6 commits into from
Jan 19, 2024
Merged

fix(sync): push local changes on reconnect #5279

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
57662df
fix(sync): push local changes on reconnect
max-nextcloud Jan 17, 2024
fa145e8
fix(sync): keep yjs file during sync session cleanup
max-nextcloud Jan 18, 2024
a643da0
test(cy): components in CI
max-nextcloud Jan 18, 2024
31d0592
enh(log): debug log when sending updateMessage
max-nextcloud Jan 18, 2024
a7b6175
docs(js): add return type annotations
max-nextcloud Jan 18, 2024
89493af
fix(sync): yjs messages are Uint8Arrays in the queue
max-nextcloud Jan 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
enh(log): debug log when sending updateMessage 
Signed-off-by: Max <[email protected]>
  • Loading branch information
@max-nextcloud
max-nextcloud committed Jan 18, 2024
commit 31d0592423d7c5e5fd2e1224dba5fe8ab6d832ea
1 change: 1 addition & 0 deletions src/components/Editor.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -490,6 +490,7 @@ export default {
// distribute additional state that may exist locally
Copy link
Member

@juliusknorr juliusknorr Jan 18, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So we always distribute the local (possibly outdated) state? Can we ensure/proof somehow that this does not lead to unexpected reverting of newer changes from the server?

Copy link
Collaborator Author

@max-nextcloud max-nextcloud Jan 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This state is yjs document state. So basically what we are distributing is our local knowledge of the history of the document. yjs will handle sorting those edits and turning them into a current state. In the end it will produce a consistent view for everyone - as long as all are on the same page. We need to share all local history so our future edits will be applied.

Let's say we worked together on a text. I got disconnected but made some changes before the editor noticed. Now I'm reconnecting.

If I distribute my local changes yjs will put all changes in an order and create a current content that may contain my or your changes depending on the order picked by yjs. There's no way of knowing what would be the correct order and we would have to live with that. At least we have a consistent view on the content.

If I keep connect without distributing my local changes I will receive your changes - the doc would probably look the same as above for me. Your view would stay the same as it was when i was disconnected and changes i make later on will not show for you.

If I drop all local changes and basically reload the editor we'd also be on the same page and my changes would be lost.

const updateMessage = getUpdateMessage(this.$ydoc, documentState)
if (updateMessage) {
logger.debug('onLoaded: Pushing local changes to server')
this.$queue.push(updateMessage)
}
}
Expand Down