[ECO-5187] Update ably-cocoa dependency

[umair-ably]

Update ably-cocoa dependency prior to release to include updated message actions

Summary by CodeRabbit

• Dependency Updates
  • Updated ably-cocoa package from version 1.2.35 to 1.2.36
  • Upgraded package revision to improve compatibility and potential bug fixes
• Feature Enhancements
  • Adjusted handling of message actions in the application for improved functionality.

[coderabbitai]

Walkthrough

This pull request updates the ably-cocoa dependency across multiple configuration files. The changes involve incrementing the dependency version from 1.2.35 to 1.2.36 in both Package.swift and Package.resolved files. The dependency's revision hash has also been updated, reflecting a new commit in the dependency's repository. Additionally, modifications were made to the MessageAction enum in Events.swift, adjusting the handling of specific cases in the fromRealtimeAction method.

Changes

File	Change Summary
AblyChat.xcworkspace/xcshareddata/swiftpm/Package.resolved	Updated origin hash and ably-cocoa dependency state
Package.resolved	Updated ably-cocoa dependency version and revision
Package.swift	Updated ably-cocoa dependency version constraint
Sources/AblyChat/Events.swift	Modified MessageAction enum, removed and added specific cases

Assessment against linked issues

Objective	Addressed	Explanation
Update ably-cocoa to reflect message action spec changes [ECO-5187]	✅

Possibly related PRs

• Updated to minimum version supporting chat v2. #164: Updates to ably-cocoa dependency in Package.resolved
• [ECO-5181] Fix sending and receiving of reaction metadata and headers #199: Modifications to RoomReactionDTO and related classes that may interact with the updated ably-cocoa dependency.

Suggested reviewers

• maratal
• lawrence-forooghian

Poem

🐰 Hop, hop, dependency update!
A version bump, clean and neat
Ably-cocoa takes a leap
From 1.2.35 to 36, so sweet
Code's journey continues, soft and fleet! 🚀

---

📜 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 a4148c8 and 6897c4c.

📒 Files selected for processing (4)

• AblyChat.xcworkspace/xcshareddata/swiftpm/Package.resolved (1 hunks)
• Package.resolved (1 hunks)
• Package.swift (1 hunks)
• Sources/AblyChat/Events.swift (1 hunks)

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

• Package.swift
• Package.resolved
• AblyChat.xcworkspace/xcshareddata/swiftpm/Package.resolved

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

• GitHub Check: Example app, tvOS (Xcode 16)
• GitHub Check: Example app, iOS (Xcode 16)
• GitHub Check: Example app, macOS (Xcode 16)
• GitHub Check: Xcode, tvOS (Xcode 16)
• GitHub Check: Xcode, iOS (Xcode 16)
• GitHub Check: Xcode, release configuration, tvOS (Xcode 16)
• GitHub Check: Xcode, macOS (Xcode 16)
• GitHub Check: SPM, release configuration (Xcode 16)
• GitHub Check: Xcode, release configuration, iOS (Xcode 16)
• GitHub Check: SPM (Xcode 16)
• GitHub Check: Xcode, release configuration, macOS (Xcode 16)

🔇 Additional comments (2)

Sources/AblyChat/Events.swift (2)

Line range hint 8-24: Consider implications of ignoring new message actions.

While the code intentionally handles only the .create action (as indicated by the comment), verify that ignoring other actions, especially the newly recognized .messageSummary, aligns with the application's requirements after the ably-cocoa update.

✅ Verification successful

Current message action handling aligns with project scope

The selective handling of only the .create action is intentional and appropriate for the current development stage. The project documentation explicitly states that features like message editing and deletion are "coming soon", which explains why other message actions are intentionally ignored.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any breaking changes or new functionality in the dependency update

# Look for changelog entries between versions
cd .build/checkouts/ably-cocoa && \
git log --oneline v1.2.35..v1.2.36 | \
grep -i -E 'break|message|action|summary'

# Check for any documentation updates related to message actions
git diff v1.2.35..v1.2.36 -- '**/README*' '**/CHANGELOG*' '**/docs/*' | \
grep -i -E 'message|action|summary'

Length of output: 311

---

Script:

#!/bin/bash
# Find Package.swift and check dependency configuration
echo "=== Package.swift contents ==="
fd -e swift -d 1 "Package.swift" --exec cat {}

# Search for message action related code
echo -e "\n=== Message Action Usage ==="
rg -A 2 "ARTMessageAction" 

# Look for any documentation files
echo -e "\n=== Documentation ==="
fd -e md . --exec head -n 20 {}

Length of output: 4954

---

17-20: Verify alignment with ably-cocoa's message action changes.

The changes to the switch statement appear to be related to the ably-cocoa dependency update. Let's verify that these changes align with the updated dependency's ARTMessageAction enum.

Additionally, since we're now explicitly handling .messageSummary but returning nil, consider documenting why this case is explicitly listed if it's being ignored.

Consider adding a comment explaining why .messageSummary and other actions are explicitly listed but ignored:

         case .update,
              .delete,
              .metaOccupancy,
              .messageSummary:
+            // Explicitly list known actions that we choose to ignore for clarity
             nil

✅ Verification successful

Changes align with ably-cocoa dependency update and are correctly implemented.

The modifications to the message action handling are consistent with the dependency update:

• Removed obsolete actions (unset, annotationCreate, annotationDelete)
• Added new .messageSummary action
• Grouped actions with identical behavior (returning nil)

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for ARTMessageAction changes in ably-cocoa

# Look for ARTMessageAction definition in the dependency
rg -A 10 "ARTMessageAction" .build/checkouts/ably-cocoa

# Check git diff between the old and new versions
cd .build/checkouts/ably-cocoa && \
git diff v1.2.35..v1.2.36 -- '**/ARTMessageAction*'

Length of output: 286

---

Script:

#!/bin/bash
# Check for dependency management files and documentation
echo "=== Package.swift content ==="
cat Package.swift

echo -e "\n=== Looking for dependency files ==="
fd -t f "^(Podfile|Cartfile)(\.resolved)?$"

echo -e "\n=== Searching for message action documentation ==="
rg -i "message.*action|ARTMessageAction" --type md

echo -e "\n=== Looking for vendored ably files ==="
fd -t f -e swift -e h "ART.*Message.*Action"

Length of output: 2746

---

Script:

#!/bin/bash
# Search for message action related code and tests
echo "=== Searching for message action usages ==="
rg -A 5 "messageSummary|unset|annotationCreate|annotationDelete" --type swift

echo -e "\n=== Checking tests for message actions ==="
fd -t f -e swift . Tests/ -x cat {}

echo -e "\n=== Looking for comments about message actions ==="
rg -i "message.*action" --type swift -C 5

Length of output: 131070

---

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.