Improve docs for OpSource + add new Ack message (for future use) #2934
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
Acks will become a new message type instead of the hacky Op type they are currently.
nvie
requested review from
Copilot,
jrowny and
ofoucherot
and removed request for
SugarDarius,
jrowny,
marcbouchenoire and
ofoucherot
There was a problem hiding this comment.
Pull request overview
This PR improves documentation and prepares for protocol V8 by renaming OpSource enum values to be more intuitive and adding type definitions for a new acknowledgment message.
- Renamed
OpSourceenum values:UNDOREDO_RECONNECT→LOCAL,REMOTE→THEIRS,ACK→OURS - Consolidated
AckOpV7andAckOpV8into a singleAckOptype with updated documentation - Added
StorageAckServerMsgtype definition for future protocol V8 support
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| packages/liveblocks-core/src/crdts/AbstractCrdt.ts | Added comprehensive JSDoc comments for the renamed OpSource enum values (LOCAL, THEIRS, OURS) explaining their purpose in CRDT conflict resolution |
| packages/liveblocks-core/src/protocol/Op.ts | Consolidated AckOpV7 and AckOpV8 into single AckOp type, renamed isAck to isAckOp, and updated comments to clarify V7 vs V8 protocol differences |
| packages/liveblocks-core/src/protocol/ServerMsg.ts | Added new STORAGE_ACK message code (202) and StorageAckServerMsg type definition for protocol V8 acknowledgments |
| packages/liveblocks-core/src/room.ts | Updated all OpSource references to use new enum names, renamed isAck to isAckOp, added inline comments for isLocal parameters, and added TODO comments linking V8 protocol migration to removal of isAckOp check |
| packages/liveblocks-core/src/crdts/LiveObject.ts | Updated OpSource.UNDOREDO_RECONNECT to OpSource.LOCAL |
| packages/liveblocks-core/src/crdts/LiveMap.ts | Updated OpSource.ACK to OpSource.OURS and OpSource.REMOTE to OpSource.THEIRS |
| packages/liveblocks-core/src/crdts/LiveList.ts | Updated all OpSource references to use new enum names throughout list operation handling |
| packages/liveblocks-core/src/index.ts | Updated exports to reflect consolidated AckOp type and added StorageAckServerMsg to public API |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR renames and documents the
OpSourceenum values for clarity:UNDOREDO_RECONNECT→LOCALREMOTE→THEIRSACK→OURSAlso, this PR adds preparatory type definitions for the upcoming protocol V8, including a new
StorageAckServerMsgmessage type. (This undoes my prior approach from #2932, I figured we actually need a new message type.)These types are not used/implemented yet.