4.61.0 Release

.github/workflows/xcmetrics.yml → .github/workflows/sdk-performance-metrics.yml

@@ -1,4 +1,4 @@
-name: Performance Benchmarks
+name: SDK Performance
 
 on:
   schedule:
@@ -16,8 +16,8 @@ env:
   HOMEBREW_NO_INSTALL_CLEANUP: 1 # Disable cleanup for homebrew, we don't need it on CI
 
 jobs:
-  xcmetrics:
-    name: XCMetrics
+  performance:
+    name: Metrics
     runs-on: macos-14
     env:
       GITHUB_TOKEN: '${{ secrets.CI_BOT_GITHUB_TOKEN }}'
@@ -39,7 +39,7 @@ jobs:
           GOOGLE_APPLICATION_CREDENTIALS: ${{ secrets.GOOGLE_APPLICATION_CREDENTIALS }}
           INSTALL_GCLOUD: true
 
-      - name: Run Performance Metrics
+      - name: Run XCMetrics
         if: ${{ github.event_name != 'pull_request' || github.event.pull_request.draft == false }}
         run: bundle exec fastlane xcmetrics
         timeout-minutes: 120

.github/workflows/sdk-size-metrics.yml

@@ -0,0 +1,43 @@
+name: SDK Size
+
+on:
+  pull_request:
+
+  workflow_dispatch:
+
+  push:
+    branches:
+      - develop
+
+env:
+  HOMEBREW_NO_INSTALL_CLEANUP: 1 # Disable cleanup for homebrew, we don't need it on CI
+
+jobs:
+  sdk_size:
+    name: Metrics
+    runs-on: macos-14
+    env:
+      GITHUB_TOKEN: '${{ secrets.CI_BOT_GITHUB_TOKEN }}'
+    steps:
+      - name: Install Bot SSH Key
+        uses: webfactory/[email protected]
+        with:
+          ssh-private-key: ${{ secrets.BOT_SSH_PRIVATE_KEY }}
+
+      - uses: actions/[email protected]
+
+      - uses: ./.github/actions/bootstrap
+
+      - name: Get branch name
+        id: get_branch_name
+        run: echo "branch=${GITHUB_REF#refs/heads/}" >> $GITHUB_OUTPUT
+
+      - name: Run SDK Size Metrics
+        run: bundle exec fastlane show_frameworks_sizes
+        timeout-minutes: 30
+        env:
+          BRANCH_NAME: ${{ steps.get_branch_name.outputs.branch }}
+          GITHUB_PR_NUM: ${{ github.event.pull_request.number }}
+          GITHUB_EVENT_NAME: ${{ github.event_name }}
+          MATCH_PASSWORD: ${{ secrets.MATCH_PASSWORD }}
+          APPSTORE_API_KEY: ${{ secrets.APPSTORE_API_KEY }}

.github/workflows/smoke-checks.yml

@@ -193,6 +193,7 @@ jobs:
       env:
         ALLURE_TOKEN: ${{ secrets.ALLURE_TOKEN }}
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        GITHUB_PR_NUM: ${{ github.event.number }}
         GITHUB_EVENT: ${{ toJson(github.event) }}
     - id: get_launch_id
       run: echo "launch_id=${{env.LAUNCH_ID}}" >> $GITHUB_OUTPUT

.gitignore

@@ -54,12 +54,6 @@ playground.xcworkspace
 # https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
 Pods/
 
-# Carthage
-#
-# Add this line if you want to avoid checking in source code from Carthage dependencies.
-Carthage/
-!Sample/Carthage/
-
 # fastlane
 #
 # It is recommended to not store the screenshots in the git repo. Instead, use fastlane to re-generate the
@@ -77,13 +71,12 @@ fastlane/allurectl
 fastlane/xcresults
 fastlane/recordings
 fastlane/performance
+fastlane/metrics
 StreamChatCore.framework.coverage.txt
 StreamChatCoreTests.xctest.coverage.txt
 vendor/bundle/
 .bundle/
 .swiftpm
-Example/Carthage/.env
-Example/Carthage/fastlane/report.xml
 Sample/Cocoapods/Podfile.lock
 docusaurus/.env
 reports/

.swiftlint.yml

@@ -12,12 +12,12 @@ excluded:
   - UISDKdocumentation
   - Tests
   - TestTools
-  - Carthage
   - Pods
   - .build
   - spm_cache
   - vendor/bundle
   - .ruby-lsp
+  - derived_data
 
 disabled_rules:
   - large_tuple

CHANGELOG.md

@@ -5,6 +5,24 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ### 🔄 Changed
 
+# [4.61.0](https://github.com/GetStream/stream-chat-swift/releases/tag/4.61.0)
+_July 30, 2024_
+
+## StreamChat
+### ⚡ Performance
+- Improve performance of `ChatChannel` database model conversions more than 7 times [#3325](https://github.com/GetStream/stream-chat-swift/pull/3325)
+- Improve performance of `ChatChannel` and `ChatMessage` equality checks [#3335](https://github.com/GetStream/stream-chat-swift/pull/3335)
+### ✅ Added
+- Expose `MissingConnectionId` + `InvalidURL` + `InvalidJSON` Errors [#3332](https://github.com/GetStream/stream-chat-swift/pull/3332)
+- Add support for `.hasUnread` filter key to `ChannelListQuery` [#3340](https://github.com/GetStream/stream-chat-swift/pull/3340)
+### 🐞 Fixed
+- Fix a rare issue with incorrect message order when sending multiple messages while offline [#3316](https://github.com/GetStream/stream-chat-swift/issues/3316)
+- Fix sorting channel list by unread count [#3340](https://github.com/GetStream/stream-chat-swift/pull/3340)
+
+## StreamChatUI
+### 🐞 Fixed
+- Fix message search not showing results for new search terms [#3345](https://github.com/GetStream/stream-chat-swift/pull/3345)
+
 # [4.60.0](https://github.com/GetStream/stream-chat-swift/releases/tag/4.60.0)
 _July 18, 2024_
 
@@ -20,13 +38,11 @@ _July 18, 2024_
 - Increase QoS for `Throttler` and `Debouncer` to `utility` [#3297](https://github.com/GetStream/stream-chat-swift/issues/3297)
 - Improve reliability of accessing data in controllers' completion handlers [#3305](https://github.com/GetStream/stream-chat-swift/issues/3305)
 
-## StreamChatUI
-### 🐞 Fixed
-- Fix Channel List not hiding error state view when data is available [#3303](https://github.com/GetStream/stream-chat-swift/pull/3303)
-
 ## StreamChatUI
 ### ✅ Added
 - Add support for enabling message list view animations [#3314](https://github.com/GetStream/stream-chat-swift/pull/3314)
+### 🐞 Fixed
+- Fix Channel List not hiding error state view when data is available [#3303](https://github.com/GetStream/stream-chat-swift/pull/3303)
 
 # [4.59.0](https://github.com/GetStream/stream-chat-swift/releases/tag/4.59.0)
 _July 10, 2024_

DemoApp/StreamChat/Components/DemoChatChannelListVC.swift

@@ -41,6 +41,11 @@ final class DemoChatChannelListVC: ChatChannelListVC {
         .equal(.hidden, to: true)
     ]))
 
+    lazy var unreadChannelsQuery: ChannelListQuery = .init(filter: .and([
+        .containMembers(userIds: [currentUserId]),
+        .hasUnread
+    ]), sort: [.init(key: .unreadCount, isAscending: false)])
+
     lazy var mutedChannelsQuery: ChannelListQuery = .init(filter: .and([
         .containMembers(userIds: [currentUserId]),
         .equal(.muted, to: true)
@@ -113,6 +118,15 @@ final class DemoChatChannelListVC: ChatChannelListVC {
             }
         )
 
+        let unreadChannelsAction = UIAlertAction(
+            title: "Unread Channels",
+            style: .default,
+            handler: { [weak self] _ in
+                self?.title = "Unread Channels"
+                self?.setUnreadChannelsQuery()
+            }
+        )
+
         let coolChannelsAction = UIAlertAction(
             title: "Cool Channels",
             style: .default,
@@ -133,7 +147,13 @@ final class DemoChatChannelListVC: ChatChannelListVC {
 
         presentAlert(
             title: "Filter Channels",
-            actions: [defaultChannelsAction, hiddenChannelsAction, mutedChannelsAction, coolChannelsAction],
+            actions: [
+                defaultChannelsAction,
+                unreadChannelsAction,
+                hiddenChannelsAction,
+                mutedChannelsAction,
+                coolChannelsAction
+            ],
             preferredStyle: .actionSheet,
             sourceView: filterChannelsButton
         )
@@ -143,6 +163,10 @@ final class DemoChatChannelListVC: ChatChannelListVC {
         replaceQuery(hiddenChannelsQuery)
     }
 
+    func setUnreadChannelsQuery() {
+        replaceQuery(unreadChannelsQuery)
+    }
+
     func setMutedChannelsQuery() {
         replaceQuery(mutedChannelsQuery)
     }

DemoApp/StreamChat/StreamChatWrapper+DemoApp.swift

@@ -14,7 +14,7 @@ extension StreamChatWrapper {
         }
 
         // Set the log level
-        LogConfig.level = .warning
+        LogConfig.level = StreamRuntimeCheck.logLevel ?? .warning
         LogConfig.formatters = [
             PrefixLogFormatter(prefixes: [.info: "ℹ️", .debug: "🛠", .warning: "⚠️", .error: "🚨"])
         ]

DemoApp/StreamRuntimeCheck+StreamInternal.swift

@@ -9,4 +9,10 @@ extension StreamRuntimeCheck {
     static var isStreamInternalConfiguration: Bool {
         ProcessInfo.processInfo.environment["STREAM_DEV"] != nil
     }
+
+    static var logLevel: LogLevel? {
+        guard let value = ProcessInfo.processInfo.environment["STREAM_LOG_LEVEL"] else { return nil }
+        guard let intValue = Int(value) else { return nil }
+        return LogLevel(rawValue: intValue)
+    }
 }

Documentation.docc/Documentation.md

@@ -17,7 +17,7 @@ This is the official iOS SDK for [Stream Chat](https://getstream.io/chat/sdk/ios
 
 * [iOS/Swift Chat Tutorial](https://getstream.io/tutorials/ios-chat/): Learn how to use the SDK by following our simple tutorial.
 * [Register](https://getstream.io/chat/trial/): Register to get an API key for Stream Chat.
-* [Installation](https://getstream.io/chat/docs/sdk/ios/basics/integration): Learn more about how to install the SDK using CocoaPods, SPM or Carthage.
+* [Installation](https://getstream.io/chat/docs/sdk/ios/basics/integration): Learn more about how to install the SDK using SPM or CocoaPods.
   * Do you want to use Module Stable XCFrameworks? [Check this out](https://getstream.io/chat/docs/sdk/ios/basics/integration#xcframeworks)
 * [Documentation](https://getstream.io/chat/docs/sdk/ios/): An extensive documentation is available to help with you integration.
 * [SwiftUI](https://github.com/GetStream/stream-chat-swiftui): Check our SwiftUI SDK if you are developing with SwiftUI.

README.md

@@ -4,7 +4,6 @@
 
 <p align="center">
   <a href="https://cocoapods.org/pods/StreamChatUI"><img src="https://img.shields.io/badge/CocoaPods-compatible-green" /></a>
-  <a href="https://github.com/Carthage/Carthage"><img src="https://img.shields.io/badge/Carthage-compatible-green" /></a>
   <a href="https://www.swift.org/package-manager/"><img src="https://img.shields.io/badge/SPM-compatible-green" /></a>
 </p>
 <p align="center">
@@ -14,8 +13,8 @@
   <a href="https://sonarcloud.io/summary/new_code?id=GetStream_stream-chat-swift"><img src="https://sonarcloud.io/api/project_badges/measure?project=GetStream_stream-chat-swift&metric=coverage" /></a>
 </p>
 <p align="center">
-  <img id="stream-chat-label" alt="StreamChat" src="https://img.shields.io/badge/StreamChat-6.7MB-blue"/>
-  <img id="stream-chat-ui-label" alt="StreamChatUI" src="https://img.shields.io/badge/StreamChatUI-4.4MB-blue"/>
+  <img id="stream-chat-label" alt="StreamChat" src="https://img.shields.io/badge/StreamChat-6.76MB-blue"/>
+  <img id="stream-chat-ui-label" alt="StreamChatUI" src="https://img.shields.io/badge/StreamChatUI-4.41MB-blue"/>
 </p>
 
 This is the official iOS SDK for [Stream Chat](https://getstream.io/chat/sdk/ios/), a service for building chat and messaging applications. This library includes both a low-level SDK and a set of reusable UI components.
@@ -49,7 +48,7 @@ The **StreamChatSwiftUI SDK** is our UI SDK for SwiftUI components. If your appl
 
 - [iOS/Swift Chat Tutorial](https://getstream.io/tutorials/ios-chat/): Learn how to use the SDK by following our simple tutorial with UIKit (or [SwiftUI](https://getstream.io/tutorials/swiftui-chat/)).
 - [Register](https://getstream.io/chat/trial/): Register to get an API key for Stream Chat.
-- [Installation](https://getstream.io/chat/docs/sdk/ios/basics/integration): Learn more about how to install the SDK using CocoaPods, SPM or Carthage.
+- [Installation](https://getstream.io/chat/docs/sdk/ios/basics/integration): Learn more about how to install the SDK using SPM or CocoaPods.
   - Do you want to use Module Stable XCFrameworks? [Check this out](https://getstream.io/chat/docs/sdk/ios/basics/integration#xcframeworks)
 - [Documentation](https://getstream.io/chat/docs/sdk/ios/): An extensive documentation is available to help with you integration.
 - [SwiftUI](https://github.com/GetStream/stream-chat-swiftui): Check our SwiftUI SDK if you are developing with SwiftUI.

Sources/StreamChat/APIClient/RequestEncoder.swift

@@ -303,7 +303,7 @@ protocol ConnectionDetailsProviderDelegate: AnyObject {
     func provideToken(timeout: TimeInterval, completion: @escaping (Result<Token, Error>) -> Void)
 }
 
-extension ClientError {
+public extension ClientError {
     final class InvalidURL: ClientError {}
     final class InvalidJSON: ClientError {}
     final class MissingConnectionId: ClientError {}

Sources/StreamChat/ChatClient.swift

@@ -660,6 +660,7 @@ extension ChatClient: ConnectionStateDelegate {
             }
         )
         connectionRecoveryHandler?.webSocketClient(client, didUpdateConnectionState: state)
+        try? backgroundWorker(of: MessageSender.self).didUpdateConnectionState(state)
     }
 }
 
@@ -674,6 +675,21 @@ extension ChatClient: ConnectionDetailsProviderDelegate {
     }
 }
 
+extension ChatClient {
+    func backgroundWorker<T>(of type: T.Type) throws -> T {
+        if let worker = backgroundWorkers.compactMap({ $0 as? T }).first {
+            return worker
+        }
+        if currentUserId == nil {
+            throw ClientError.CurrentUserDoesNotExist()
+        }
+        if !config.isClientInActiveMode {
+            throw ClientError.ClientIsNotInActiveMode()
+        }
+        throw ClientError("Background worker of type \(T.self) is not set up")
+    }
+}
+
 extension ClientError {
     public final class MissingLocalStorageURL: ClientError {
         override public var localizedDescription: String { "The URL provided in ChatClientConfig is `nil`." }