Update Message to support updateSerial

[splindsay-92]

To handle ordering of operation messages, we have added an updateSerial field to the Message type.
We will now use this new field and updatedAt to define the global and total order of operations (updates/deletes)

Summary by CodeRabbit

• New Features

  • Introduced a new property updateSerial in the Message interface.
  • Removed the deletedAt property.

• Documentation

  • Updated serialization methods to reflect changes in message state representation.

[coderabbitai]

Walkthrough

The changes involve modifications to the Message interface in ably.d.ts and the Message class in src/common/lib/types/message.ts. The deletedAt property has been removed and replaced with a new property called updateSerial. This adjustment alters how message updates are tracked and serialized within the Ably library, impacting message lifecycle management without introducing new methods or significant changes to existing functionality.

Changes

File	Change Summary
ably.d.ts	Removed deletedAt?: number, added updateSerial?: string in Message interface.
src/common/lib/types/message.ts	Renamed deletedAt to updateSerial in Message class; updated toJSON and toString methods accordingly.

Poem

🐇 In the meadow, messages fly,
With updateSerial, we reach for the sky!
No more deletedAt to weigh us down,
Just updates and joy, let’s spin round and round!
Hopping along, with each change we cheer,
In our code garden, the future is clear! 🌼

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 5731271 and 21e42ea.

📒 Files selected for processing (2)

• ably.d.ts (1 hunks)
• src/common/lib/types/message.ts (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

• ably.d.ts
• src/common/lib/types/message.ts

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4b46254 and 5731271.

📒 Files selected for processing (2)

• ably.d.ts (1 hunks)
• src/common/lib/types/message.ts (3 hunks)

🔇 Additional comments (4)

src/common/lib/types/message.ts (3)

410-410: LGTM: String representation is consistent.

The toString() implementation correctly uses the updateSerial property name, maintaining consistency with the class property.

---

344-344: Property declaration looks good but consider type constraints.

The updateSerial optional string property aligns with the PR objectives. However, consider if this should be a required property or if there should be constraints on the string format for better type safety.

Let's check if there are any existing format constraints for serial properties:

---

Line range hint 344-410: Verify backwards compatibility with message updates.

The change from deletedAt to updateSerial represents a significant change in how message updates are tracked. We should ensure this change is backward compatible and properly handled in message processing logic.

Let's analyze the impact:

ably.d.ts (1)

2359-2361: LGTM: The updateSerial property addition aligns with the PR objectives.

The addition of the updateSerial property to the Message interface is correctly typed as an optional string and properly documented. This change aligns with the PR's goal of replacing deletedAt with updateSerial for tracking message updates.