PubNub Swift Chat SDK 0.10.3 release

fix(membership): Fix the error when retrieving the unread messages count on the Membership instance

Author: jguz-pubnub

Sources/Entities/Membership.swift

@@ -85,10 +85,10 @@ public protocol Membership {
   ///
   /// - Parameters:
   ///   - completion: The async `Result` of the method call
-  ///     - **Success**: The number of unread messages on the membership's channel
+  ///     - **Success**: The number of unread messages on the membership's channel or `nil` when ``lastReadMessageTimetoken`` is also `nil`
   ///     - **Failure**: An `Error` describing the failure
   func getUnreadMessagesCount(
-    completion: ((Swift.Result<UInt64, Error>) -> Void)?
+    completion: ((Swift.Result<UInt64?, Error>) -> Void)?
   )
 
   /// You can receive updates when specific user-channel Membership object(s) are added, edited, or removed.

Sources/Entities/MembershipImpl.swift

@@ -124,8 +124,8 @@ extension MembershipImpl: Membership {
     }
   }
 
-  public func getUnreadMessagesCount(completion: ((Swift.Result<UInt64, Error>) -> Void)? = nil) {
-    membership.getUnreadMessagesCount().async(caller: self) { (result: FutureResult<MembershipImpl, UInt64>) in
+  public func getUnreadMessagesCount(completion: ((Swift.Result<UInt64?, Error>) -> Void)? = nil) {
+    membership.getUnreadMessagesCount().async(caller: self) { (result: FutureResult<MembershipImpl, UInt64?>) in
       switch result.result {
       case let .success(messagesCount):
         completion?(.success(messagesCount))

Tests/MembershipIntegrationTests.swift

@@ -106,6 +106,19 @@ final class MembershipTests: PubNubSwiftChatSDKIntegrationTests {
     )
   }
 
+  func testMembership_GetUnreadMessagesCountForEmptyChannel() throws {
+    let someMembership = MembershipImpl(
+      chat: chat,
+      channel: channel,
+      user: UserImpl(chat: chat, id: randomString())
+    )
+    XCTAssertNil(
+      try awaitResultValue {
+        someMembership.getUnreadMessagesCount(completion: $0)
+      }
+    )
+  }
+
   func testMembership_StreamUpdates() throws {
     let expectation = expectation(description: "MembershipStreamUpdates")
     expectation.assertForOverFulfill = true