Add specification for apply operations on ACK (LODR-054) #415
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
Written by Claude based on JS at 194aed7 (i.e. the commit into which the path-based API was merged in a9aea33).
This implements the decision from LODR-054 to apply operations to local objects immediately upon receiving the ACK, before the echo arrives over the Realtime connection. This ensures that when operation promises resolve, the local state has already been updated. Changes to objects-features.textile: - RTO3c: Add appliedOnAckSerials set to track operations applied on ACK - RTO3d: Add siteCode storage for siteTimeserials checks - RTO20: Define rules for applying operations on ACK - RTO21: Define ACK buffering during SYNCING state - RTO9a0: Check appliedOnAckSerials before applying echoed operations - Update sync-related spec points to clear appliedOnAckSerials and BufferedAcks Changes to features.textile: - CD2j: Add siteCode field to ConnectionDetails Related: https://ably.atlassian.net/browse/AIT-281 Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Collaborator
Author
|
@claude are you able to make changes to this PR? |
| ** @(CD2g)@ @serverId@ string is a unique identifier for the front-end server that the client has connected to. This server ID is only used for the purposes of debugging | ||
| ** @(CD2h)@ @maxIdleInterval@ is the maximum length of time in milliseconds that the server will allow no activity to occur in the server->client direction. After such a period of inactivity, the server will send a @HEARTBEAT@ or transport-level ping to the client. If the value is 0, the server will allow arbitrarily-long levels of inactivity. | ||
| ** @(CD2i)@ @objectsGCGracePeriod@ integer - the length of time, in milliseconds, that the client library must wait before releasing resources for tombstoned objects and map entries (see "RTO10":../objects-features#RTO10) | ||
| ** @(CD2j)@ @siteCode@ string - the identifier for the regional site that the connection is connected to. This is used when applying operations on ACK to perform the @siteTimeserials@ check (see "RTO3d":../objects-features#RTO3d, "RTO20a":../objects-features#RTO20a) |
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.
Summary
This PR adds specification points for applying LiveObjects operations immediately upon receiving the ACK, before the echo arrives over the Realtime connection. This implements the decision from LODR-054.
Motivation
Currently, the LiveObjects SDK only applies operations when received over the Realtime connection (the echo), which means users cannot immediately read their own writes. This causes issues in agentic applications where subsequent operations depend on previous updates being applied locally.
Implementation
This PR implements Option 1 from the decision record: Store the serials of all applied-on-ACK operations in a sliding window.
Changes
objects-features.textile
appliedOnAckSerialsset to track operations applied on ACK but not yet echoedsiteCodestorage from ConnectionDetails for siteTimeserials checksappliedOnAckSerialsbefore applying echoed operations to avoid duplicatesappliedOnAckSerialsandBufferedAcksfeatures.textile
siteCodefield toConnectionDetails(implements AIT-281)Next Steps
Related
🤖 Generated with Claude Code