MessageAction enum changes

[SimonWoolf]

per ably/specification#263

(I have no way of running ably-cocoa tests so this is a blind change)

Breaking change but this was agreed, as no clients are currently using the action yet.

Summary by CodeRabbit

• New Features

  • Added a new message action ARTMessageActionMessageSummary for message summaries.

• Refactor

  • Removed deprecated message action enumeration values related to annotations.
  • Updated test cases to reflect changes in message action handling, ensuring consistency in expected values.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 SwiftLint (0.57.0)

Test/Tests/UtilitiesTests.swift

[
{
"character" : 72,
"file" : "/Test/Tests/UtilitiesTests.swift",
"line" : 101,
"reason" : "Force casts should be avoided",
"rule_id" : "force_cast",
"severity" : "Error",
"type" : "Force Cast"
}
]

Walkthrough

The pull request introduces changes to the ARTMessageAction enumeration in the ARTMessage.h header file. Specifically, it removes three existing enumeration values related to annotations (ARTMessageActionUnset, ARTMessageActionAnnotationCreate, and ARTMessageActionAnnotationDelete) and adds a new enumeration value ARTMessageActionMessageSummary. Corresponding test modifications in UtilitiesTests.swift update the expected action values from .unset to .update for certain message scenarios.

Changes

File	Change Summary
Source/include/Ably/ARTMessage.h	- Removed ARTMessageActionUnset enumeration value - Removed ARTMessageActionAnnotationCreate enumeration value - Removed ARTMessageActionAnnotationDelete enumeration value - Added new ARTMessageActionMessageSummary enumeration value
Test/Tests/UtilitiesTests.swift	- Updated test method assertions to change expected action from .unset to .update

Possibly related PRs

• MessageAction enum changes #2005: This PR directly modifies the ARTMessageAction enumeration in the same file (ARTMessage.h) and includes the same changes regarding the removal and addition of enumeration values, making it highly relevant to the main PR.

Suggested reviewers

• maratal

Poem

🐰 Hop, hop, through message streams so bright,
Annotations fade, summaries take flight!
Enums dance and shift their way,
A rabbit's code update today!
New actions bloom with sparkling might 🌟

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c01363f and ad0db4d.

📒 Files selected for processing (2)

• Source/include/Ably/ARTMessage.h (1 hunks)
• Test/Tests/UtilitiesTests.swift (6 hunks)

Finishing Touches

• 📝 Generate Docstrings

---

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 generate docstrings to generate docstrings for this PR. (Beta)
• @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: 0

🧹 Nitpick comments (1)

Source/include/Ably/ARTMessage.h (1)

28-32: Fix typo in documentation comment.

There's a double period at the end of the documentation comment.

     /**
      * Message action for a message containing the latest rolled-up summary of
-     * annotations that have been made to this message..
+     * annotations that have been made to this message.
      */

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aca9a7c and c01363f.

📒 Files selected for processing (2)

• Source/include/Ably/ARTMessage.h (1 hunks)
• Test/Tests/UtilitiesTests.swift (6 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (5)

• GitHub Check: check (macOS, test_macOS)
• GitHub Check: check (tvOS, test_tvOS17_2)
• GitHub Check: check (iOS, test_iOS17_2)
• GitHub Check: check
• GitHub Check: check

🔇 Additional comments (1)

Test/Tests/UtilitiesTests.swift (1)

Line range hint 495-522: LGTM! Test cases properly validate the message action changes.

The test cases thoroughly verify:

1. Version and serial handling for both create and update actions
2. Timestamp and createdAt field handling for both create and update actions

The assertions are clear and cover the expected behavior after the enum changes.

Also applies to: 561-588

[maratal]

LGTM, left minor comment.