Appends: note about append on a new attachment, remove note about continuous history not being supported yet#3277
Conversation
m-hulbert
left a comment
m-hulbert
left a comment
There was a problem hiding this comment.
LGTM with a minor suggestion.
|
|
||
| When Ably receives an append, it concatenates the provided data with the current latest version to calculate a full (non-incremental) version of the message. That version (with an action of `message.update`) is then used in contexts like [History](/docs/storage-history/history) and [rewind](/docs/channels/options/rewind), so that when using those APIs, you will always receive complete messages without needing to do any concatenation yourself, and can specify e.g. `rewind=10` to get the most recent 10 full, distinct messages. | ||
|
|
||
| The first append you receive for a given message on an attachment is delivered as a fully-aggregated `message.update`, so that you don't need to reach into history to discover the full prior state of the message. You can then just concatenate the payloads of any subsequent `message.append`s for that message onto that first one to get the full payload. (And the server may at any time deliver an append as a `message.update` with the full rolled-up payload). |
There was a problem hiding this comment.
I'd suggest dropping the brackets (and replace "and the server" with "Ably") on the final sentence since they need to handle this in their app.
SimonWoolf
force-pushed
the
append-history
branch
from
a4352fc to
c07f5e4
Compare
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
…tinuous history not being supported yet
SimonWoolf
force-pushed
the
append-history
branch
from
c07f5e4 to
afe25c8
Compare
2 participants
Continuous history is now fully supported. And note about the change in append semantics I made (AITDR-006).
(not for merging until next week's prod deploy)