[CIS-371] LLC for macOS

.github/workflows/macos-checks.yml

@@ -0,0 +1,77 @@
+name: macOS checks
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  release:
+    types:
+      - created
+
+env:
+  HOMEBREW_NO_INSTALL_CLEANUP=1: 1 # Disable cleanup for homebrew, we don't need it on CI
+  DEVELOPER_DIR: /Applications/Xcode_12.4.app/Contents/Developer # Use Xcode 12.4
+
+jobs:
+  build-and-test-release-macos:
+    name: Run Tests macOS (Release)
+    runs-on: macos-latest
+    steps:
+    - name: Install Bot SSH Key
+      uses: webfactory/ssh-agent@v0.4.1
+      with:
+        ssh-private-key: ${{ secrets.BOT_SSH_PRIVATE_KEY }}
+    - uses: actions/checkout@v1
+    - name: Cache RubyGems
+      uses: actions/cache@v2
+      id: rubygem-cache
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: ${{ runner.os }}-gem-
+    - name: Cache Mint
+      uses: actions/cache@v2
+      id: mint-cache
+      with:
+        path: /usr/local/lib/mint
+        key: ${{ runner.os }}-mint-${{ hashFiles('./Mintfile') }}
+        restore-keys: ${{ runner.os }}-mint-
+    - name: Run bootstrap.sh
+      run: ./bootstrap.sh
+    - name: Run Tests (Release)
+      env:
+        MATCH_PASSWORD: ${{ secrets.MATCH_PASSWORD }}
+      run: bundle exec fastlane test_release_macos
+
+  build-and-test-debug-macos:
+    name: Run Tests macOS (Debug)
+    runs-on: macos-latest
+    steps:
+    - name: Install Bot SSH Key
+      uses: webfactory/ssh-agent@v0.4.1
+      with:
+        ssh-private-key: ${{ secrets.BOT_SSH_PRIVATE_KEY }}
+    - uses: actions/checkout@v1
+    - name: Cache RubyGems
+      uses: actions/cache@v2
+      id: rubygem-cache
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: ${{ runner.os }}-gem-
+    - name: Cache Mint
+      uses: actions/cache@v2
+      id: mint-cache
+      with:
+        path: /usr/local/lib/mint
+        key: ${{ runner.os }}-mint-${{ hashFiles('./Mintfile') }}
+        restore-keys: ${{ runner.os }}-mint-
+    - name: Run bootstrap.sh
+      run: ./bootstrap.sh
+    - name: Run Tests (Release)
+      env:
+        MATCH_PASSWORD: ${{ secrets.MATCH_PASSWORD }}
+      run: bundle exec fastlane test_debug_macos

CHANGELOG.md

@@ -9,6 +9,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 - Add `areTypingEventsEnabled`, `areReactionsEnabled`, `areRepliesEnabled`, `areReadEventsEnabled`, `areUploadsEnabled` to `ChatChannelListController` [#1085](https://github.com/GetStream/stream-chat-swift/pull/1085)
 - Add `ImageCDN` protocol to improve work with image cache and thumbnails [#1111](https://github.com/GetStream/stream-chat-swift/pull/1111)
 - Add missing APIs `open` of `ComposerVC`. Including the delegate implementations and showing the suggestions as a child view controller. [#1140](https://github.com/GetStream/stream-chat-swift/pull/1140)
+- Add possibility to build the StreamChat framework on macOS
+    [#1132](https://github.com/GetStream/stream-chat-swift/pull/1132)
 
 ### 🐞 Fixed
 - Fix background color of message list in dark mode [#1109](https://github.com/GetStream/stream-chat-swift/pull/1109)

Package.swift

@@ -61,6 +61,7 @@ var streamChatSourcesExcluded: [String] { [
     "Database/DTOs/DeviceDTO_Tests.swift",
     "Database/DatabaseContainer_Tests.swift",
     "Config/TokenProvider_Tests.swift",
+    "WebSocketClient/BackgroundTaskScheduler_Tests.swift",
     "WebSocketClient/WebSocketClient_Mock.swift",
     "WebSocketClient/EventMiddlewares/ChannelTruncatedEventMiddleware_Tests.swift",
     "WebSocketClient/EventMiddlewares/MemberEventMiddleware_Tests.swift",

Sources/StreamChat/APIClient/APIClient_Tests.swift

@@ -318,7 +318,7 @@ extension URLSessionConfiguration {
     // simply compares the pointers.
     @available(iOS, deprecated: 12.0, message: "Remove this workaround when dropping iOS 12 support.")
     func isTestEqual(to otherConfiguration: URLSessionConfiguration) -> Bool {
-        identifier == otherConfiguration.identifier
+        let commonEquatability = identifier == otherConfiguration.identifier
             && requestCachePolicy == otherConfiguration.requestCachePolicy
             && timeoutIntervalForRequest == otherConfiguration.timeoutIntervalForRequest
             && timeoutIntervalForResource == otherConfiguration.timeoutIntervalForResource
@@ -333,16 +333,19 @@ extension URLSessionConfiguration {
             && urlCredentialStorage == otherConfiguration.urlCredentialStorage
             && urlCache == otherConfiguration.urlCache
             && shouldUseExtendedBackgroundIdleMode == otherConfiguration.shouldUseExtendedBackgroundIdleMode
-//            && protocolClasses == otherConfiguration.protocolClasses
-            && multipathServiceType == otherConfiguration.multipathServiceType
             && waitsForConnectivity == otherConfiguration.waitsForConnectivity
             && isDiscretionary == otherConfiguration.isDiscretionary
             && sharedContainerIdentifier == otherConfiguration.sharedContainerIdentifier
-            && sessionSendsLaunchEvents == otherConfiguration.sessionSendsLaunchEvents
-//            && connectionProxyDictionary == otherConfiguration.connectionProxyDictionary
             && waitsForConnectivity == otherConfiguration.waitsForConnectivity
             && isDiscretionary == otherConfiguration.isDiscretionary
             && sharedContainerIdentifier == otherConfiguration.sharedContainerIdentifier
+
+        #if os(iOS)
+        return commonEquatability
+            && multipathServiceType == otherConfiguration.multipathServiceType
             && sessionSendsLaunchEvents == otherConfiguration.sessionSendsLaunchEvents
+        #endif
+
+        return commonEquatability
     }
 }

Sources/StreamChat/Config/ChatClientConfig.swift

@@ -22,8 +22,13 @@ public struct ChatClientConfig {
 
     /// The folder `ChatClient` uses to store its local cache files.
     public var localStorageFolderURL: URL? = {
+        #if os(macOS)
+        let urls = FileManager.default.urls(for: .applicationSupportDirectory, in: .userDomainMask)
+        return urls.first.map { $0.appendingPathComponent("io.getstream.StreamChat") }
+        #else
         let urls = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask)
         return urls.first
+        #endif
     }()
 
     /// The datacenter `ChatClient` uses for connecting.

Sources/StreamChat/Controllers/ChannelController/ChannelController+Combine.swift

@@ -3,7 +3,7 @@
 //
 
 import Combine
-import UIKit
+import Foundation
 
 @available(iOS 13, *)
 extension _ChatChannelController {

Sources/StreamChat/Controllers/ChannelListController/ChannelListController+Combine.swift

@@ -3,7 +3,7 @@
 //
 
 import Combine
-import UIKit
+import Foundation
 
 @available(iOS 13, *)
 extension _ChatChannelListController {

Sources/StreamChat/Controllers/ChannelWatcherListController/ChatChannelWatcherListController+Combine.swift

@@ -3,7 +3,7 @@
 //
 
 import Combine
-import UIKit
+import Foundation
 
 @available(iOS 13, *)
 extension _ChatChannelWatcherListController {

Sources/StreamChat/Controllers/ConnectionController/ConnectionController+Combine.swift

@@ -3,7 +3,7 @@
 //
 
 import Combine
-import UIKit
+import Foundation
 
 @available(iOS 13, *)
 extension _ChatConnectionController {

Sources/StreamChat/Controllers/CurrentUserController/CurrentUserController+Combine.swift

@@ -3,7 +3,7 @@
 //
 
 import Combine
-import UIKit
+import Foundation
 
 @available(iOS 13, *)
 extension _CurrentChatUserController {

Sources/StreamChat/Controllers/ListDatabaseObserver_Tests.swift

@@ -48,17 +48,17 @@ final class ListChange_Tests: XCTestCase {
 
     func test_fieldChange() {
         let insertedItem: MemberPayload<NoExtraData> = .dummy()
-        let insertedAt = IndexPath(row: 1, section: 1)
+        let insertedAt = IndexPath(item: 1, section: 1)
 
         let updatedItem: MemberPayload<NoExtraData> = .dummy()
-        let updatedAt = IndexPath(row: 2, section: 3)
+        let updatedAt = IndexPath(item: 2, section: 3)
 
         let removedItem: MemberPayload<NoExtraData> = .dummy()
-        let removedAt = IndexPath(row: 3, section: 4)
+        let removedAt = IndexPath(item: 3, section: 4)
 
         let movedItem: MemberPayload<NoExtraData> = .dummy()
-        let movedFrom = IndexPath(row: 5, section: 6)
-        let movedTo = IndexPath(row: 7, section: 8)
+        let movedFrom = IndexPath(item: 5, section: 6)
+        let movedTo = IndexPath(item: 7, section: 8)
 
         let path = \MemberPayload<NoExtraData>.user.id
 

Sources/StreamChat/Controllers/MemberController/MemberController+Combine.swift

@@ -3,7 +3,7 @@
 //
 
 import Combine
-import UIKit
+import Foundation
 
 @available(iOS 13, *)
 extension _ChatChannelMemberController {

Sources/StreamChat/Controllers/MemberListController/MemberListController+Combine.swift

@@ -3,7 +3,7 @@
 //
 
 import Combine
-import UIKit
+import Foundation
 
 @available(iOS 13, *)
 extension _ChatChannelMemberListController {

Sources/StreamChat/Controllers/MessageController/MessageController+Combine.swift

@@ -3,7 +3,7 @@
 //
 
 import Combine
-import UIKit
+import Foundation
 
 @available(iOS 13, *)
 extension _ChatMessageController {

Sources/StreamChat/Controllers/UserController/UserController+Combine.swift

@@ -3,7 +3,7 @@
 //
 
 import Combine
-import UIKit
+import Foundation
 
 @available(iOS 13, *)
 extension _ChatUserController {

Sources/StreamChat/Controllers/UserListController/UserListController+Combine.swift

@@ -3,7 +3,7 @@
 //
 
 import Combine
-import UIKit
+import Foundation
 
 @available(iOS 13, *)
 extension _ChatUserListController {

Sources/StreamChat/Utils/SystemEnvironment.swift

@@ -2,7 +2,7 @@
 // Copyright © 2021 Stream.io Inc. All rights reserved.
 //
 
-import UIKit
+import Foundation
 
 enum SystemEnvironment {
     static let systemName = UIDevice.current.systemName + UIDevice.current.systemVersion

Sources/StreamChat/WebSocketClient/BackgroundTaskScheduler.swift

@@ -0,0 +1,82 @@
+//
+// Copyright © 2021 Stream.io Inc. All rights reserved.
+//
+
+import Foundation
+
+/// Object responsible for platform specific handling of background tasks
+protocol BackgroundTaskScheduler {
+    /// It's your responsibility to finish previously running task.
+    ///
+    /// Returns: `false` if system forbid background task, `true` otherwise
+    func beginTask(expirationHandler: (() -> Void)?) -> Bool
+    func endTask()
+    func startListeningForAppStateUpdates(
+        onEnteringBackground: @escaping () -> Void,
+        onEnteringForeground: @escaping () -> Void
+    )
+}
+
+#if os(iOS)
+import UIKit
+
+class IOSBackgroundTaskScheduler: BackgroundTaskScheduler {
+    private lazy var app: UIApplication? = {
+        // We can't use `UIApplication.shared` directly because there's no way to convince the compiler
+        // this code is accessible only for non-extension executables.
+        UIApplication.value(forKeyPath: "sharedApplication") as? UIApplication
+    }()
+
+    /// The identifier of the currently running background task. `nil` if no background task is running.
+    private var activeBackgroundTask: UIBackgroundTaskIdentifier?
+
+    func beginTask(expirationHandler: (() -> Void)?) -> Bool {
+        activeBackgroundTask = app?.beginBackgroundTask { [weak self] in
+            expirationHandler?()
+            self?.endTask()
+        }
+        return activeBackgroundTask != .invalid
+    }
+
+    func endTask() {
+        if let activeTask = activeBackgroundTask {
+            app?.endBackgroundTask(activeTask)
+            activeBackgroundTask = nil
+        }
+    }
+
+    private var onEnteringBackground: () -> Void = {}
+    private var onEnteringForeground: () -> Void = {}
+
+    func startListeningForAppStateUpdates(
+        onEnteringBackground: @escaping () -> Void,
+        onEnteringForeground: @escaping () -> Void
+    ) {
+        self.onEnteringForeground = onEnteringForeground
+        self.onEnteringBackground = onEnteringBackground
+
+        NotificationCenter.default.addObserver(
+            self,
+            selector: #selector(handleAppDidEnterBackground),
+            name: UIApplication.didEnterBackgroundNotification,
+            object: nil
+        )
+
+        NotificationCenter.default.addObserver(
+            self,
+            selector: #selector(handleAppDidBecomeActive),
+            name: UIApplication.didBecomeActiveNotification,
+            object: nil
+        )
+    }
+
+    @objc private func handleAppDidEnterBackground() {
+        onEnteringBackground()
+    }
+
+    @objc private func handleAppDidBecomeActive() {
+        onEnteringForeground()
+    }
+}
+
+#endif

Sources/StreamChat/WebSocketClient/BackgroundTaskScheduler_Tests.swift

@@ -0,0 +1,46 @@
+//
+// Copyright © 2021 Stream.io Inc. All rights reserved.
+//
+
+@testable import StreamChat
+import XCTest
+
+#if os(iOS)
+class IOSBackgroundTaskScheduler_Tests: XCTestCase {
+    func test_notifications_foreground() {
+        // Arrange: Subscribe for app notifications
+        let scheduler = IOSBackgroundTaskScheduler()
+        var calledBackground = false
+        var calledForeground = false
+        scheduler.startListeningForAppStateUpdates(
+            onEnteringBackground: { calledBackground = true },
+            onEnteringForeground: { calledForeground = true }
+        )
+
+        // Act: Send notification
+        NotificationCenter.default.post(name: UIApplication.didBecomeActiveNotification, object: nil)
+
+        // Assert: Only intended closure is called
+        XCTAssertTrue(calledForeground)
+        XCTAssertFalse(calledBackground)
+    }
+
+    func test_notifications_background() {
+        // Arrange: Subscribe for app notifications
+        let scheduler = IOSBackgroundTaskScheduler()
+        var calledBackground = false
+        var calledForeground = false
+        scheduler.startListeningForAppStateUpdates(
+            onEnteringBackground: { calledBackground = true },
+            onEnteringForeground: { calledForeground = true }
+        )
+
+        // Act: Send notification
+        NotificationCenter.default.post(name: UIApplication.didEnterBackgroundNotification, object: nil)
+
+        // Assert: Only intended closure is called
+        XCTAssertFalse(calledForeground)
+        XCTAssertTrue(calledBackground)
+    }
+}
+#endif