[ECO-4999] Preparing for use with Xcode 16
Closes #1977
Preparing library for use with Xcode 16 (but not exclusevly switching to it yet).
Summary by CodeRabbit
- Bug Fixes
- Improved error handling in the encoding process to prevent operations on invalid data types.
- Enhanced type safety during decoding to avoid runtime errors related to data type mismatches.
- New Features
- Added string representation capabilities for various types, improving debugging and logging.
- Introduced conditional compilation for
RealtimeClientChannelsandRestChannelsto support retroactive behavior based on feature availability. - Updated testing configurations to align with the latest iOS and tvOS versions (iOS 18.0 and tvOS 18.0).
- Enhanced CI/CD workflows to utilize newer macOS and Xcode versions for improved build processes.
Walkthrough
The changes made in the ARTDataEncoder.m file enhance error handling and type safety in encoding and decoding processes. A new check is introduced to handle cases where the encoded variable is nil, ensuring an appropriate error message is returned. Additionally, the conditions for processing data with "vcdiff" encoding are refined to verify that the data is of the expected type before applying the codec. Extensions in TestUtilities.swift, RealtimeClientChannelsTests.swift, and RestClientChannelsTests.swift implement conditional compilation based on the RetroactiveAttribute feature. Workflow files have been updated to reflect new macOS and Xcode versions.
Changes
| Files | Change Summary |
|---|---|
| Source/ARTDataEncoder.m | Added error handling for nil input in encode: method and refined type checks in decode:identifier:encoding: method. |
| Test/Test Utilities/TestUtilities.swift | Added extensions for various types to conform to CustomStringConvertible, enhancing string representation. |
| Test/Tests/RealtimeClientChannelsTests.swift | Introduced conditional compilation for ARTRealtimeChannels to conform to @retroactive Sequence when available. |
| Test/Tests/RestClientChannelsTests.swift | Modified ARTRestChannels extension for conditional compilation to conform to @retroactive Sequence when available. |
| .github/workflows/*.yaml | Updated workflows to use macOS 14 and Xcode 16, along with adjustments in output paths for testing. |
| fastlane/Fastfile | Updated testing configurations to reflect new iOS 18.0 and tvOS 18.0 versions. |
Assessment against linked issues
| Objective | Addressed | Explanation |
|---|---|---|
| Prepare for Xcode 16 compatibility (#1977) | ✅ |
Possibly related PRs
- #1963: The changes in the main PR regarding error handling in the
encode:anddecode:identifier:encoding:methods may relate to the modifications in theARTDevicePushDetailsandARTDeviceDetailsclasses, as they both involve handling data types and improving robustness in the context of device management and push notifications.
Poem
In the code, a rabbit hops,
Fixing bugs, it never stops.
With checks in place, oh what a sight,
Encoding safely, day and night!
Errors handled, all is well,
In the forest of code, we dwell! 🐇✨
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?
🪧 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
@coderabbitaiin 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
@coderabbitaiin 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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.