Make some classes private

[lawrence-forooghian]

These are all implementation details and should never have been exposed.

Summary by CodeRabbit

• Refactor

  • Improved internal organization by converting certain headers from public to private, ensuring clearer separation between external interfaces and internal implementation.

• Chore

  • Streamlined module declarations and reduced unnecessary public imports to maintain a cleaner API exposure without affecting existing functionality.

• New Features

  • Added several new private header files to enhance internal functionality related to protocol messages, connection details, and more.

[coderabbitai]

Walkthrough

The pull request updates the accessibility and organization of several header files in the Ably project. In the Xcode project file, header attributes for multiple files are changed from Public to Private, with updated paths reflecting a new directory structure. Additionally, the module maps in both Source/Ably.modulemap and Source/include/Ably.modulemap now include declarations for these private headers. Finally, the public header file (AblyPublic.h) has been modified to remove import statements for these headers.

Changes

File(s)	Change Summary
Ably.xcodeproj/project.pbxproj	Updated header file attributes from Public to Private and updated file paths to the PrivateHeaders/Ably/ location.
Source/Ably.modulemap, Source/include/Ably.modulemap	Added declarations for private headers: ARTProtocolMessage.h, ARTConnectionDetails.h, ARTFallback.h, ARTQueuedMessage.h, ARTPendingMessage.h, ARTEncoder.h, ARTDeviceStorage.h.
Source/include/Ably/AblyPublic.h	Removed public import statements for headers: ARTConnectionDetails.h, ARTFallback.h, ARTProtocolMessage.h, ARTQueuedMessage.h, ARTEncoder.h, ARTDeviceStorage.h, ARTPendingMessage.h.

Possibly related PRs

• Release/1.2.34 #1996: The changes involve modifying the visibility of several header files to Private, related to the same headers as this PR.
• [ECO-4379] Remove AblyDeltaCodec import from public API #2022: Similar modifications to header file visibility and organization, adjusting the same set of header files.

Suggested reviewers

• umair-ably
• maratal

Poem

I'm a rabbit in the code, hopping all around,
Rearranging headers, where new paths are found.
From public to private, the changes now sing,
Files tucked away safe, like treasures they bring.
With a skip and a jump, the project feels light—
🐇 CodeRabbit’s delight in every byte!

---

📜 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 ff6508e and af36ee9.

📒 Files selected for processing (5)

• Ably.xcodeproj/project.pbxproj (22 hunks)
• Source/Ably.modulemap (1 hunks)
• Source/PrivateHeaders/Ably/ARTEncoder.h (1 hunks)
• Source/include/Ably.modulemap (1 hunks)
• Source/include/Ably/AblyPublic.h (0 hunks)

💤 Files with no reviewable changes (1)

• Source/include/Ably/AblyPublic.h

✅ Files skipped from review due to trivial changes (1)

• Source/PrivateHeaders/Ably/ARTEncoder.h

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

• Source/include/Ably.modulemap
• Ably.xcodeproj/project.pbxproj

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

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

🔇 Additional comments (1)

Source/Ably.modulemap (1)

126-132: Appropriate encapsulation of implementation details.

The addition of these headers to the Private module aligns with the PR's objective of making implementation classes private. This is a good practice as it:

1. Reduces the public API surface area
2. Provides better encapsulation of internal implementation details
3. Allows for more flexibility in future refactoring without breaking compatibility

The headers being moved to private (ARTProtocolMessage.h, ARTConnectionDetails.h, etc.) appear to be implementation details that should indeed not be part of the public API.

---

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.

[lawrence-forooghian]

Ah, there are some failures in CI, will take a look.

[lawrence-forooghian]

Alright, fixed now.