feat: Add Document State Replacement for document-versioning based applications to y-partykit #271
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
🦋 Changeset detectedLatest commit: 3053118 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
abhi-arya1
changed the title
abhi-arya1
changed the title
… in y-partyserver - Introduced `base64ToUint8Array` and `uint8ArrayToBase64` functions in `utils.ts` for base64 encoding/decoding. - Added `replaceDocumentState` method in `index.ts` to handle document state updates using base64 encoded data. - Updated `package.json` to include `@types/node` and changed `partyserver` dependency to use workspace. - Created new `bun.lockb` file.
- Removed the `base64ToUint8Array` and `uint8ArrayToBase64` functions from `utils.ts` and added them to a new `shared/utils.ts` file for better organization. - Implemented a `revertUpdate` method in `YServer` to allow reverting document states using Yjs's UndoManager. - Cleaned up the `replaceDocumentState` method, which is no longer present in the codebase. - Updated the `document` property in `YServer` to be explicitly typed as `WSSharedDoc`.
- Renamed `revertUpdate` method to `replaceDocument` to better reflect its functionality of replacing the document with a previous state. - Updated method documentation to clarify parameters and error messages related to document replacement.
- Modified the comment for the document replacement method to clarify that it replaces the document with a different state instead of a previous state, enhancing the accuracy of the method's description.
Collaborator
|
looks like you don't need to remove readonly, so I'm bringing it back? |
Merged
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.
Problem
For applications that provide version restoration functionality such as Google Docs, they require replacement of the document content. Other attempts to solve this previously resulted in a bug based on how Y.js works, where the document that's stored includes clock information about updates, so when it's applied on top of a newer doc, the algorithm simply discards it because it already has a newer version.
Resolution
Implemented and documented the
replaceDocumentmethod inYServerto allow changing document states without removing connections or other data using Y.js's UndoManager, and document snapshot information.This can be tested using the drop-in replacement for
fixtures/tiptap-yjs/src/client/index.tsxavailable here: https://abhi-arya.opennote.space/4b830300-a8a7-4015-a39b-48a9c68a2170 (this also contains a video example of a use case that i'm using in prod)Side Effects
This required removing the
readonlyproperty onWSSharedDocto allow for replacements.Other References