search

ably / ably-cocoa

iOS, tvOS and macOS Objective-C and Swift client library SDK for Ably realtime messaging service
https://ably.com/download
Apache License 2.0
46 stars 25 forks source link

[ECO-4940] `NS_SWIFT_SENDABLE` to every type that has a docstring #1963

Closed maratal closed 2 months ago

maratal commented 3 months ago

I've added NS_SWIFT_SENDABLE to every type that has a docstring and their accompanied enums and params types.

Closes #1962

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The updates introduce the NS_SWIFT_SENDABLE annotation to various Objective-C interfaces in the Ably SDK, indicating that instances can be safely used across Swift concurrency contexts. Additionally, private headers and read-only properties are added to enhance encapsulation and manage mutability, ensuring better control over the state of objects.

Changes

File(s) Change Summary
Source/include/Ably/ARTConnectionDetails.h, Source/include/Ably/ARTRestChannels.h, Source/include/Ably/ARTRealtimeChannels.h, Source/include/Ably/ARTDevicePushDetails.h Added NS_SWIFT_SENDABLE to enhance concurrency safety for respective interfaces.
Source/include/Ably/ARTDeviceDetails.h Changed properties to read-only to enhance encapsulation and immutability.
Ably.xcodeproj/project.pbxproj, Source/Ably.modulemap, Source/PrivateHeaders/... Added private headers to improve encapsulation and internal management of device details.
Source/ARTDevicePushDetails.m, Source/ARTJsonLikeEncoder.m Introduced mechanisms to access private properties and enhance functionality.
Test/Tests/RealtimeClientChannelTests.swift Added a test to verify immutability of ARTRealtimeChannelOptions.

Assessment against linked issues

Objective Addressed Explanation
Add Swift concurrency annotations to improve thread safety (ECO-4940, #1962) ✅

🐰 In fields so wide, where bunnies hop,
Swift concurrency now has a safer crop.
With NS_SWIFT_SENDABLE, our paths align,
In harmony, Objective-C and Swift entwine.
Celebrate the change, let’s all take a leap,
For safe threads await, in code we keep! 🌼

[!TIP] We have updated our review workflow to use the Anthropic's Claude family of models. Please share any feedback in the discussion post on our Discord.

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
lawrence-forooghian commented 3 months ago

Please can you mention the resolved issue in the commit message?

maratal commented 3 months ago

Please can you mention the resolved issue in the commit message?

Done.

I’m curious why you've annotated some of the types in PrivateHeaders?

Yeah, Xcode doesn't show real file path, so somehow those ended up there, sorry, fixed in https://github.com/ably/ably-cocoa/pull/1963/commits/de49b6705f470dfde272384918b447c7cc37420c

umair-ably commented 2 months ago

LGTM once @lawrence-forooghian is happy with the open conversation

lawrence-forooghian commented 2 months ago

Looks good, I just want to test it out in Chat to check that it makes our warnings go away, will do that shortly

maratal commented 2 months ago

It seems like ARTRealtimeChannels isn't marked as sendable. Please could you address that and have another check of everything to make sure there isn't anything else missed?

Made a quick check and added private interface to ARTDevicePushDetails as well. Also made it sendable. I'll need Xcode 16 for a proper review of all warnings, so let me know if you find anything else before that.

lawrence-forooghian commented 2 months ago

Tested again in Chat and there are no warnings now. Still might be some types that Chat isn't using that aren't covered here, but I’m happy to approve and address other needs if we discover them.