Release 1.2.35. #2001
Release 1.2.35. #2001
Conversation
WalkthroughThe pull request introduces version Changes
Possibly related PRs
Suggested reviewers
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
github-actions
bot
temporarily deployed
to
staging/pull/2001/features
github-actions
bot
temporarily deployed
to
staging/pull/2001/jazzydoc
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (2)
Test/Tests/RealtimeClientConnectionTests.swift (2)
Line range hint
1440-1446: Consider simplifying the host order arrangement logic.Reversing
expectedHostOrderbefore mapping may make the code less intuitive. Consider definingexpectedHostOrderin the desired order to eliminate the need for reversal.
Line range hint
1441-1446: Prefer using Swift Array instead of NSMutableArray.Using Swift's native
[Any]type instead ofNSMutableArrayimproves code safety and compatibility with Swift features.Apply this diff to refactor:
- let shuffleArrayInExpectedHostOrder = { (array: NSMutableArray) in + let shuffleArrayInExpectedHostOrder = { (array: inout [Any]) in let arranged = expectedHostOrder.reversed().map { array[$0] } for (i, element) in arranged.enumerated() { array[i] = element } }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (9)
CHANGELOG.md(1 hunks)README.md(3 hunks)Scripts/jazzy.sh(1 hunks)Source/ARTClientInformation.m(1 hunks)Test/Tests/ARTDefaultTests.swift(1 hunks)Test/Tests/ClientInformationTests.swift(3 hunks)Test/Tests/RealtimeClientConnectionTests.swift(1 hunks)Test/Tests/RestClientTests.swift(1 hunks)Version.xcconfig(1 hunks)
✅ Files skipped from review due to trivial changes (3)
- Scripts/jazzy.sh
- Source/ARTClientInformation.m
- Version.xcconfig
🧰 Additional context used
🪛 Markdownlint (0.35.0)
CHANGELOG.md
5-5: null
Bare URL used
(MD034, no-bare-urls)
9-9: null
Bare URL used
(MD034, no-bare-urls)
🔇 Additional comments (13)
Test/Tests/ARTDefaultTests.swift (1)
9-9: LGTM! Version update is aligned with release objectives.
The test expectation has been correctly updated to match the new version 1.2.35.
Let's verify version consistency across all related files:
✅ Verification successful
Version 1.2.35 is consistently updated across all relevant files ✅
The verification confirms that version 1.2.35 is properly synchronized across:
- CHANGELOG.md header
- README.md installation instructions
- Source/ARTClientInformation.m constant definition
- All relevant test files including version expectations
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify version number consistency across all relevant files
# Expected version: 1.2.35
echo "Checking version numbers in key files..."
# Check CHANGELOG.md
echo "CHANGELOG.md:"
rg "## \[1\.2\.35\]" CHANGELOG.md
# Check README.md
echo -e "\nREADME.md installation instructions:"
rg "1\.2\.35" README.md
# Check Source files
echo -e "\nSource files version constants:"
rg "ARTClientInformation_libraryVersion.*1\.2\.35" Source/
# Check other test files
echo -e "\nTest files version expectations:"
rg "1\.2\.35" Test/Tests/
Length of output: 1623
Test/Tests/ClientInformationTests.swift (3)
12-12: LGTM: Version assertion correctly updated
The version string has been properly updated to "1.2.35" in the basic agent assertion test.
30-30: LGTM: Agent identifier version correctly updated
The version string has been properly updated in the agent identifier format test case (nil agents scenario).
45-45: LGTM: Version update consistent with other changes
The version string has been properly updated in the agent identifier format test case (with additional agents).
Let's verify version consistency across the codebase:
✅ Verification successful
Version string "1.2.35" is consistently used across the codebase
The version update has been properly synchronized across all relevant files:
- Version.xcconfig: CURRENT_PROJECT_VERSION = 1.2.35
- Source/ARTClientInformation.m: ARTClientInformation_libraryVersion = "1.2.35"
- README.md: Package and download references
- Test files: All test assertions use "1.2.35"
- CHANGELOG.md: Latest version entry is 1.2.35
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify version string consistency across the codebase
# Expected: All version strings should be "1.2.35"
echo "Checking for any inconsistent version strings..."
rg -g '!.git' '1\.2\.(3[0-9]|[4-9][0-9])' --no-heading
echo "Checking specific version-related files..."
for file in CHANGELOG.md README.md Source/ARTClientInformation.m; do
if [ -f "$file" ]; then
echo "=== $file ==="
rg '1\.2\.[0-9]+' "$file"
fi
done
Length of output: 8633
README.md (2)
64-64: LGTM! Version update for Swift Package Manager installation.
The version number is correctly updated to 1.2.35 in the Swift Package Manager installation instructions.
104-104: LGTM! Version update for manual installation.
The version number and GitHub release link are correctly updated to 1.2.35 in the manual installation instructions.
Test/Tests/RealtimeClientConnectionTests.swift (7)
387-387: Version number updated correctly.
The agent version in the query parameter now reflects the new version 1.2.35.
Line range hint 1481-1481: Custom shuffle function assigned correctly to test options.
The shuffleArray is now set to shuffleArrayInExpectedHostOrder as intended.
Line range hint 2329-2329: Fallback hosts mapped using expected host order.
The expectedFallbackHosts array is correctly constructed by mapping expectedHostOrder to ARTDefault.fallbackHosts().
Line range hint 2394-2394: Verify the equality of fallback hosts.
Ensuring that resultFallbackHosts matches expectedFallbackHosts is essential for the test validity.
Line range hint 2591-2600: Refactored code into testUsesAlternativeHostOnResponse for reusability.
Extracting common logic into this helper function improves code modularity and reduces duplication across tests.
Line range hint 2726-2780: Introduced testMovesToDisconnectedWithNetworkingError for better test organization.
This helper function enhances code reusability and maintainability by handling connectivity error tests in a centralized manner.
Line range hint 2453-2494: Verify direct modification of connectionDetails.
Directly modifying connectionDetails properties, such as maxIdleInterval, may not be appropriate. Ensure that this approach is safe and does not lead to unexpected behavior. Consider using a mock or a subclass if you need to alter these properties for testing purposes.
Run the following script to check if setMaxIdleInterval is a valid method or property setter:
Summary by CodeRabbit
Release Notes for Version 1.2.35
New Features
Improvements
Bug Fixes
Documentation
Tests