Messages: Add new message fields to message spec #210
Conversation
This file contains 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
splindsay-92
changed the title
AndyTWF
reviewed
Oct 15, 2024
splindsay-92
force-pushed
the
materialisation/support-new-message-fields
branch
from
32a69df
to
151d71f
Compare
splindsay-92
force-pushed
the
materialisation/support-new-message-fields
branch
from
151d71f
to
ec04d4e
Compare
splindsay-92
force-pushed
the
materialisation/support-new-message-fields
branch
from
ec04d4e
to
bf88949
Compare
splindsay-92
force-pushed
the
materialisation/support-new-message-fields
branch
from
bf88949
to
cc0073d
Compare
AndyTWF
reviewed
Oct 28, 2024
SimonWoolf
requested changes
Oct 29, 2024
textile/features.textile
Outdated
| ** @(TM2M)@ @refType@ string - if the @refSerial@ is set, this must be set. If describes the type of the reference. | ||
| ** @(TM2N)@ @updatedAt@ time in milliseconds since epoch. If a message received from Ably has the @action@ field set to "MESSAGE_UPDATE" then the @updatedAt@ field must be set to the time the message was updated. | ||
| ** @(TM2O)@ @deletedAt@ time in milliseconds since epoch. If a message received from Ably has the @action@ field set to "MESSAGE_DELETE" then the @deleteAt@ field must be set to the time the message was deleted. | ||
| ** @(TM2P)@ @operation@ operation is an JSON-encodable object that contains the following `optional` fields; |
There was a problem hiding this comment.
I don't see why we'd need to make this a JsonObject. It's a well-defined optional substruct of the Message with three known fields, why shouldn't the library expose it accordingly? (In JS there might not be a difference (other than the typings), it could just be a plain object, but eg in java this would be much more usable as a MessageOperation class or whatever vs a JSONObject)
splindsay-92
force-pushed
the
materialisation/support-new-message-fields
branch
from
cc0073d
to
b25f641
Compare
…documentation - Added @action@ enum field in the message structure, which specifies the type of the message action. It includes a series of predefined actions (CREATE, UPDATE, DELETE, etc.). - Added additional fields `serial`, `refSerial`, `refType`, `updatedAt`, `deletedAt`, and `operation` to the Message data type. - Update the Message class to reflect the new members. - Added section on REST and Realtime publish that now requires the message action field to be set on publish.
splindsay-92
force-pushed
the
materialisation/support-new-message-fields
branch
from
b25f641
to
edaf89c
Compare
…documentation - Added @action@ enum field in the message structure, which specifies the type of the message action. It includes a series of predefined actions (CREATE, UPDATE, DELETE, etc.). - Added additional fields `serial`, `refSerial`, `refType`, `updatedAt`, `updateSerial`, and `operation` to the Message data type. - Update the Message class to reflect the new members.
SimonWoolf
approved these changes
Nov 6, 2024
| *** @(TM2N2)@ @description@ string | ||
| *** @(TM2N3)@ @metadata@ object - used to contain any arbitrary key value pairs of type string. | ||
| ** @(TM2O)@ @updatedAt@ time in milliseconds since epoch at which an operation occurred. This field is always populated on messages received with an @action@ of @MESSAGE_UPDATE@ or @MESSAGE_DELETE@.. | ||
| ** @(TM2P)@ @updateSerial@ string - an opaque string that uniquely identifies the operation. This field is always populated on messages received with an @action@ of @MESSAGE_UPDATE@ or @MESSAGE_DELETE@. |
There was a problem hiding this comment.
- the spec uses the convention that the letters in spec items other than the initial section name (eg the p in TM2p) is lowercase
- you reference a TM5 from the IDL that lists the actions, where is it?
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.
Updated
Messageclass in thetextile/features.textilefile to support new message fields related to materialisation.Additions to the
Messageclass:actionfield to represent the type of the message, using theMessageActionenum. (serialfield to store the serial number of the message.refSerialandrefTypefields for messages that reference other messages.updatedAtandupdateSerialfields to track the update and deletion ordering.operationfield, which is a object containing optional fields such asclientId,description, andmetadata.