[WIP] Rename SyncObjectsPool to SyncObjectMessages and clarify its type
#370
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
VeskeR
changed the title
SyncObjectsPool to SyncObjectMessages and clarify its typeSyncObjectsPool to SyncObjectMessages and clarify its type
textile/objects-features.textile
Outdated
| *** @(RTO5a4)@ The objects sync sequence for that sequence identifier is considered complete once the cursor is empty; that is when the @channelSerial@ looks like @<sequence id>:@ | ||
| *** @(RTO5a5)@ An @OBJECT_SYNC@ may also be sent with no @channelSerial@ attribute. In this case, the sync data is entirely contained within the @ProtocolMessage@ | ||
| ** @(RTO5b)@ During the sync sequence, the @ObjectMessage.object@ values from incoming @OBJECT_SYNC@ @ProtocolMessages@ must be temporarily stored in the internal @SyncObjectsPool@ list | ||
| ** @(RTO5b)@ During the sync sequence, the @ObjectMessage.object@ values from incoming @OBJECT_SYNC@ @ProtocolMessages@ must be temporarily stored in the internal @SyncObjectMessages@ list |
There was a problem hiding this comment.
Given what you said in the PR description (about needing info from the ObjectMessage) I think that this and its subpoint need changing?
VeskeR
force-pushed
the
PUB-1829/object-write-API
branch
2 times, most recently
from
79ad8d9 to
3517453
Compare
VeskeR
force-pushed
the
clarify-SyncObjectsPool
branch
from
b053152 to
28f8ef5
Compare
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.
The name
SyncObjectsPoolincorrectly suggests it has something to do with theObjectsPoolused to store actual live objects, while it's only a temporary array of object sync messages received during sync sequence.The current ably-js implementation is also too complicated as there is no need anymore to store object sync messages in any kind of map of
objectId -> objectMessage, and it can be replaced via simple list like the current spec suggests.Also for spec items points
RTLC6fandRTLM6fwhich refer tothe outer @ObjectMessage@ for the @ObjectState@it would make more sense for theSyncObjectsPoolto directly hold a list ofObjectMessagemessages, not the underlyingObjectState, hence the renaming toSyncObjectMessages