Version 6.3.0 #144
Version 6.3.0 #144
Conversation
Summary of ChangesHello @kustomer-builds, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on a significant version bump for the KustomerChat SDK to 6.3.0. The update primarily introduces a more streamlined and modern API for managing read states within chat sessions, by deprecating older Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
|
Caution Review failedThe pull request is closed. 📝 WalkthroughWalkthroughVersion 6.3.0 updates KustomerChat's read-marking API, deprecating two Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro Disabled knowledge base sources:
📒 Files selected for processing (11)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the KustomerChat SDK to version 6.3.0. The main change is the introduction of a new markSessionAsRead function and the deprecation of the older markRead functions, guiding developers towards the new session-based API. The version updates are applied across various configuration files. I've noted a minor inconsistency in the base version number in the podspec file compared to other configuration files, which should be corrected to ensure release process consistency.
| Pod::Spec.new do |s| | ||
| s.name = 'KustomerChat' | ||
| s.version = '6.1.2' | ||
| s.version = '6.3.0' |
There was a problem hiding this comment.
There's an inconsistency in the base version number. This file indicates a version bump from 6.1.2, while other files like KustomerChat.xcframework/ios-arm64/dSYMs/KustomerChat.framework.dSYM/Contents/Info.plist show a bump from 6.2.1. This discrepancy could point to a missed update in a previous release and should be corrected to ensure consistency in your release process.
![baz-reviewer[bot]](https://avatars.githubusercontent.com/in/933528?s=60&v=4){kind=small}
| @available(*, deprecated, message: "Use markSessionAsRead(sessionId:completion:) instead") | ||
| public func markRead(conversationId: Swift.String) | ||
| @available(*, deprecated, message: "Use markSessionAsRead(sessionId:completion:) instead. Note: messageIds and satisfactionId parameters are ignored - all unread messages and CSATs will be marked as read.") | ||
| public func markRead(conversationId: Swift.String, messageIds: [Swift.String], satisfactionId: Swift.String? = nil) | ||
| public func markSessionAsRead(sessionId: Swift.String, completion: @escaping (Swift.Result<Swift.Void, KustomerChat.KError>) -> Swift.Void) |
There was a problem hiding this comment.
The newly added markSessionAsRead(sessionId:completion:) now requires a sessionId, but the public models and APIs that clients already use (e.g. KUSConversation: id, brandId, preview, conversationId only) do not expose a session identifier anywhere. Because integrators have only ever tracked conversationId, there is no way for them to supply the required sessionId, so this API is unusable for existing clients.
| @available(*, deprecated, message: "Use markSessionAsRead(sessionId:completion:) instead") | |
| public func markRead(conversationId: Swift.String) | |
| @available(*, deprecated, message: "Use markSessionAsRead(sessionId:completion:) instead. Note: messageIds and satisfactionId parameters are ignored - all unread messages and CSATs will be marked as read.") | |
| public func markRead(conversationId: Swift.String, messageIds: [Swift.String], satisfactionId: Swift.String? = nil) | |
| public func markSessionAsRead(sessionId: Swift.String, completion: @escaping (Swift.Result<Swift.Void, KustomerChat.KError>) -> Swift.Void) | |
| @available(*, deprecated, message: "Use markSessionAsRead(conversationId:completion:) instead") | |
| public func markRead(conversationId: Swift.String) | |
| @available(*, deprecated, message: "Use markSessionAsRead(conversationId:completion:) instead. Note: messageIds and satisfactionId parameters are ignored - all unread messages and CSATs will be marked as read.") | |
| public func markRead(conversationId: Swift.String, messageIds: [Swift.String], satisfactionId: Swift.String? = nil) | |
| public func markSessionAsRead(conversationId: Swift.String, completion: @escaping (Swift.Result<Swift.Void, KustomerChat.KError>) -> Swift.Void) |
Finding type: Type Inconsistency
There was a problem hiding this comment.
Pull request overview
This PR updates the KustomerChat iOS framework from version 6.2.1 to version 6.3.0, introducing API improvements for marking messages as read while maintaining backward compatibility through deprecation warnings.
Key Changes:
- Version bump from 6.2.1 to 6.3.0 across all framework files
- Introduction of new
markSessionAsRead(sessionId:completion:)API method - Deprecation of existing
markReadmethods with migration guidance
Reviewed changes
Copilot reviewed 11 out of 25 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
KustomerChat.podspec |
Updated version from 6.1.2 to 6.3.0 |
| Swift interface files (arm64, x86_64, simulator) | Added new markSessionAsRead method and deprecated existing markRead methods |
Info.plist files |
Updated CFBundleShortVersionString to 6.3.0 |
dSYM/Info.plist files |
Updated debug symbol version strings to 6.3.0 |
CodeResources files |
Updated code signature hashes for modified binaries |
.swiftdoc files |
Added comprehensive documentation (991 lines) for the framework |
The changes are consistent across all architectures and build configurations, properly updating version numbers and introducing the new API with appropriate deprecation warnings for the legacy methods.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
User description
Version 6.3.0
Generated description
Below is a concise technical summary of the changes proposed in this PR:
Updates the
KustomerChatSDK to version6.3.0, introducing a newmarkSessionAsReadfunction. Deprecates previousmarkReadfunctions, guiding developers to use the new session-based API for managing chat read statuses.KustomerChatSDK to version6.3.0.Modified files (5)
Latest Contributors(2)
markSessionAsReadfunction for managing chat session read statuses, deprecating oldermarkReadfunctions.Modified files (2)
Latest Contributors(2)