[AIT-286] Fix BufferedObjectOperations clearing rules for LiveObjects sync #416
+3
−1
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
BufferedObjectOperations should only be cleared when ATTACHED with RESUMED flag not set is received or on sync completion, not when a new sync sequence ID arrives. This is because the server caches object state at channel attachment time, not at the start of a sync sequence. Resolves AIT-286
There was a problem hiding this comment.
Pull request overview
This PR fixes the BufferedObjectOperations clearing behavior for LiveObjects synchronization by ensuring operations are cleared at the correct time based on when the server caches object state.
Changes:
- Added RTO4d to specify that BufferedObjectOperations must be cleared when ATTACHED is received without the RESUMED flag, since the server caches object state at channel attachment time
- Added RTO5f as an explanatory note describing the expected and edge-case behaviors for server-initiated resyncs
- Deleted RTO5a2b which previously required clearing BufferedObjectOperations when a new sync sequence ID arrived
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| *** @(RTO5a2)@ If a new sequence id is sent from Ably, the client library must treat it as the start of a new objects sync sequence, and any previous in-flight sync must be discarded: | ||
| **** @(RTO5a2a)@ The @SyncObjectsPool@ list must be cleared | ||
| **** @(RTO5a2b)@ The @BufferedObjectOperations@ list must be cleared | ||
| **** @(RTO5a2b)@ This clause has been deleted |
There was a problem hiding this comment.
The deleted clause statement should end with a period for consistency with other deleted clauses in the specification (see RSN4c, TS3, etc. in features.textile).
Suggested change
| **** @(RTO5a2b)@ This clause has been deleted | |
| **** @(RTO5a2b)@ This clause has been deleted. |
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.
BufferedObjectOperations should only be cleared when ATTACHED with RESUMED flag not set is received or on sync completion, not when a new sync sequence ID arrives. This is because the server caches object state at channel attachment time, not at the start of a sync sequence.
Resolves AIT-286
See ably-js implementation ably/ably-js#2150