[ECO-5232] Updates Chat client options name

[umair-ably]

Updates Chat client options name to prevent clashes with ably-coca client options naming in the future

Summary by CodeRabbit

• Refactor

  • Standardized the chat client configuration options across public interfaces for a more consistent setup.
  • Renamed ClientOptions to ChatClientOptions throughout the SDK.

• Tests

  • Updated test cases to align with the new configuration option adjustments.

[coderabbitai]

Warning

Rate limit exceeded

@umair-ably has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 12 minutes and 59 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 9d21534 and 7d5bc1b.

📒 Files selected for processing (7)

• CHANGELOG.md (1 hunks)
• Example/AblyChatExample/ContentView.swift (1 hunks)
• Example/AblyChatExample/Mocks/MockClients.swift (3 hunks)
• Sources/AblyChat/ChatClient.swift (5 hunks)
• Sources/AblyChat/Rooms.swift (3 hunks)
• Tests/AblyChatTests/DefaultChatClientTests.swift (3 hunks)
• Tests/AblyChatTests/IntegrationTests.swift (1 hunks)

Walkthrough

This pull request updates the configuration type for the chat client across the codebase. All instances where ClientOptions were used have been replaced with ChatClientOptions. The changes span from client initialization in sample and mock implementations to the protocol definitions and test setups. The overall control flow remains unchanged while the specific types used for configuration are updated consistently.

Changes

Files	Change Summary
Example/AblyChatExample/ContentView.swift Example/AblyChatExample/Mocks/MockClients.swift	Updated ClientOptions to ChatClientOptions in the createChatClient function, mock client actors (MockChatClient and MockRooms), including property declarations and initializer parameter types.
Sources/AblyChat/ChatClient.swift Sources/AblyChat/Rooms.swift	Renamed ClientOptions to ChatClientOptions across the chat client protocol and its implementations. Updated property types, initializers, and supporting methods (e.g., isEqualForTestPurposes) to ensure consistency.
Tests/AblyChatTests/DefaultChatClientTests.swift Tests/AblyChatTests/IntegrationTests.swift	Modified test cases and sandbox client creation to initialize and use ChatClientOptions instead of ClientOptions, reflecting the new configuration convention.

Suggested reviewers

• maratal
• lawrence-forooghian

Poem

I'm a rabbit with a code-filled heart,
Hopping through changes with a joyful start.
ClientOptions left, ChatClientOptions in sight,
Updates so neat, they make my day bright.
In the burrows of code, we dance and play,
Here’s to smooth commits and a brighter day! 🐰✨

---

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.
• @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.

[sacOO7]

LGTM ( check if there is usage of ClientOptions in doc comments, will have to update accordingly )

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

CHANGELOG.md (2)

14-14: Heading Level Increment Issue: Adjust Header Level

The header "#### Breaking Changes" is a level-4 header. According to the markdown lint (MD001), heading levels should only increment by one level at a time. Considering the previous header is level 2 ("## What's Changed"), updating this header to level 3 (i.e., "### Breaking Changes") would be more appropriate.

-#### Breaking Changes
+### Breaking Changes

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

14-14: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4

(MD001, heading-increment)

---

15-15: Unordered List Marker and Bare URL Formatting

The list item currently uses an asterisk (*) for the unordered list marker, but markdown lint (MD004) recommends using dashes (-). Additionally, the bare URL included in the text (triggering MD034) should be formatted as a proper markdown hyperlink to improve readability and adhere to style guidelines.

-* Renames `ClientOptions` within this SDK to `ChatClientOptions` (https://github.com/ably/ably-chat-swift/pull/230)
+ - Renames `ClientOptions` within this SDK to `ChatClientOptions` ([Pull Request #230](https://github.com/ably/ably-chat-swift/pull/230))

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

15-15: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)

---

15-15: Bare URL used
null

(MD034, no-bare-urls)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between fb55c14 and 9d21534.

📒 Files selected for processing (7)

• CHANGELOG.md (1 hunks)
• Example/AblyChatExample/ContentView.swift (1 hunks)
• Example/AblyChatExample/Mocks/MockClients.swift (3 hunks)
• Sources/AblyChat/ChatClient.swift (5 hunks)
• Sources/AblyChat/Rooms.swift (3 hunks)
• Tests/AblyChatTests/DefaultChatClientTests.swift (3 hunks)
• Tests/AblyChatTests/IntegrationTests.swift (1 hunks)

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

• Tests/AblyChatTests/IntegrationTests.swift
• Example/AblyChatExample/ContentView.swift
• Sources/AblyChat/Rooms.swift
• Example/AblyChatExample/Mocks/MockClients.swift
• Tests/AblyChatTests/DefaultChatClientTests.swift
• Sources/AblyChat/ChatClient.swift

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

CHANGELOG.md

14-14: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4

(MD001, heading-increment)

---

15-15: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)

---

15-15: Bare URL used
null

(MD034, no-bare-urls)

⏰ 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: Xcode, release configuration, iOS (Xcode 16)
• GitHub Check: Xcode, release configuration, macOS (Xcode 16)
• GitHub Check: SPM, release configuration (Xcode 16)
• GitHub Check: SPM (Xcode 16)

🔇 Additional comments (1)

CHANGELOG.md (1)

16-16: Trailing Line Context

Line 16 is marked as changed. Ensure that the newline or spacing aligns with the overall changelog formatting.