Add connection status monitoring capabilities

Author: jguz-pubnub

PubNubSwiftChatSDK.xcodeproj/project.pbxproj

@@ -13,6 +13,7 @@
 		3D0F90D32D48DB4700986686 /* MutedUsersManagerInterface.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3D0F90D12D48DB4700986686 /* MutedUsersManagerInterface.swift */; };
 		3D0F90D52D48DEC700986686 /* MutedUsersManagerInterface+AsyncAwait.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3D0F90D42D48DEC700986686 /* MutedUsersManagerInterface+AsyncAwait.swift */; };
 		3D1CE5232D79DED800617200 /* String+Helpers.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3D1CE5222D79DED800617200 /* String+Helpers.swift */; };
+		3D1E67D72E3CBC84001454C1 /* ConnectionStatus.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3D1E67D62E3CBC84001454C1 /* ConnectionStatus.swift */; };
 		3D27B8D02D2D9A61003AD459 /* ThreadChannelAsyncIntegrationTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3D27B8CF2D2D9A61003AD459 /* ThreadChannelAsyncIntegrationTests.swift */; };
 		3D27B8D22D2D9BBB003AD459 /* ThreadChannel+AsyncAwait.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3D27B8D12D2D9BBB003AD459 /* ThreadChannel+AsyncAwait.swift */; };
 		3D27B8D42D2EAEA6003AD459 /* MessageDraftAsyncIntegrationTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3D27B8D32D2EAEA5003AD459 /* MessageDraftAsyncIntegrationTests.swift */; };
@@ -154,6 +155,7 @@
 		3D0F90D12D48DB4700986686 /* MutedUsersManagerInterface.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = MutedUsersManagerInterface.swift; sourceTree = "<group>"; };
 		3D0F90D42D48DEC700986686 /* MutedUsersManagerInterface+AsyncAwait.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "MutedUsersManagerInterface+AsyncAwait.swift"; sourceTree = "<group>"; };
 		3D1CE5222D79DED800617200 /* String+Helpers.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "String+Helpers.swift"; sourceTree = "<group>"; };
+		3D1E67D62E3CBC84001454C1 /* ConnectionStatus.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ConnectionStatus.swift; sourceTree = "<group>"; };
 		3D27B8CF2D2D9A61003AD459 /* ThreadChannelAsyncIntegrationTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ThreadChannelAsyncIntegrationTests.swift; sourceTree = "<group>"; };
 		3D27B8D12D2D9BBB003AD459 /* ThreadChannel+AsyncAwait.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "ThreadChannel+AsyncAwait.swift"; sourceTree = "<group>"; };
 		3D27B8D32D2EAEA5003AD459 /* MessageDraftAsyncIntegrationTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MessageDraftAsyncIntegrationTests.swift; sourceTree = "<group>"; };
@@ -497,6 +499,7 @@
 				3D2CA2472C621876008D2284 /* MessageActionType.swift */,
 				3DB2A8B82C80993B00167058 /* ChannelType.swift */,
 				3DB2A8BE2C809B1F00167058 /* EmitEventMethod.swift */,
+				3D1E67D62E3CBC84001454C1 /* ConnectionStatus.swift */,
 			);
 			path = Models;
 			sourceTree = "<group>";
@@ -691,6 +694,7 @@
 				3DB5A3202E30D771001741C8 /* ChannelGroup+AsyncAwait.swift in Sources */,
 				3D2CA2382C5B9ACA008D2284 /* File.swift in Sources */,
 				3DB5A3192E2F900B001741C8 /* ChannelGroupImpl.swift in Sources */,
+				3D1E67D72E3CBC84001454C1 /* ConnectionStatus.swift in Sources */,
 				3DB73A752C57D073007FE249 /* PubNubChat.Event.swift in Sources */,
 				3D2CA2362C5B9320008D2284 /* PubNubChat+Transform.swift in Sources */,
 				3DB73A492C513578007FE249 /* MessageReferencedChannel.swift in Sources */,

Sources/Chat+AsyncAwait.swift

@@ -749,6 +749,20 @@ public extension Chat {
       }
     }
   }
+
+  /// Returns a stream of connection status changes.
+  ///
+  /// - Returns: An `AsyncStream` of ``ConnectionStatus``
+  func connectionStatusStream() -> AsyncStream<ConnectionStatus> {
+    AsyncStream { continuation in
+      let listener = addConnectionStatusListener { status in
+        continuation.yield(status)
+      }
+      continuation.onTermination = { _ in
+        listener.close()
+      }
+    }
+  }
 }
 
 extension ChatImpl {

Sources/Chat.swift

@@ -525,5 +525,25 @@ public protocol Chat: AnyObject {
   ///     - **Failure**: An `Error` describing the failure
   func removeChannelGroup(id: String, completion: ((Swift.Result<Void, Error>) -> Void)?)
 
+  /// Adds a listener for connection status changes.
+  ///
+  /// - Parameter listener: A closure that will be called when the connection status changes
+  /// - Returns: ``AutoCloseable`` interface you can call to stop listening for new statuses and clean up resources when they re no longer needed by invoking the ``AutoCloseable/close()`` method
+  func addConnectionStatusListener(_ listener: @escaping (ConnectionStatus) -> Void) -> AutoCloseable
+
+  /// Reconnects the client to the PubNub system.
+  ///
+  /// - Parameter completion: The async `Result` of the method call
+  ///     - **Success**: A `Void` indicating a success
+  ///     - **Failure**: An `Error` describing the failure
+  func reconnectSubscriptions()
+
+  /// Disconnects the client from the PubNub system.
+  ///
+  /// - Parameter completion: The async `Result` of the method call
+  ///     - **Success**: A `Void` indicating a success
+  ///     - **Failure**: An `Error` describing the failure
+  func disconnectSubscriptions()
+
   // swiftlint:disable:next file_length
 }

Sources/ChatImpl.swift

@@ -813,5 +813,32 @@ extension ChatImpl: Chat {
     }
   }
 
+  public func addConnectionStatusListener(_ listener: @escaping (ConnectionStatus) -> Void) -> AutoCloseable {
+    AutoCloseableImpl(
+      chat.addConnectionStatusListener { kmpConnectionStatus in
+        switch kmpConnectionStatus.category {
+        case .pnConnectionOnline:
+          listener(.online)
+        case .pnConnectionOffline:
+          listener(.offline)
+        case .pnConnectionError:
+          if let exception = kmpConnectionStatus.exception {
+            listener(.connectionError(error: exception.asError()))
+          }
+        default:
+          break
+        }
+      }, owner: self
+    )
+  }
+
+  public func reconnectSubscriptions() {
+    chat.reconnectSubscriptions()
+  }
+
+  public func disconnectSubscriptions() {
+    chat.disconnectSubscriptions()
+  }
+
   // swiftlint:disable:next file_length
 }

Sources/Models/ConnectionStatus.swift

@@ -0,0 +1,54 @@
+//
+//  ConnectionStatus.swift
+//
+//  Copyright (c) PubNub Inc.
+//  All rights reserved.
+//
+//  This source code is licensed under the license found in the
+//  LICENSE file in the root directory of this source tree.
+//
+
+import Foundation
+
+/// The connection status of the Chat SDK.
+public enum ConnectionStatus: Equatable {
+  /// The client is connected to the PubNub network.
+  case online
+  /// The client is disconnected from the PubNub network.
+  case offline
+  /// The client is experiencing an error while connecting to the PubNub network.
+  case connectionError(error: Error)
+
+  /// Returns an error (if any) associated with the connection status.
+  public var error: Error? {
+    switch self {
+    case let .connectionError(error):
+      return error
+    default:
+      return nil
+    }
+  }
+
+  /// Returns `true` if the connection status is `online`, otherwise `false`.
+  public var isConnected: Bool {
+    switch self {
+    case .online:
+      return true
+    default:
+      return false
+    }
+  }
+
+  public static func == (lhs: ConnectionStatus, rhs: ConnectionStatus) -> Bool {
+    switch (lhs, rhs) {
+    case (.online, .online):
+      return true
+    case (.offline, .offline):
+      return true
+    case (.connectionError, .connectionError):
+      return true
+    default:
+      return false
+    }
+  }
+}

Tests/AsyncAwait/ChannelAsyncIntegrationTests.swift

@@ -102,9 +102,8 @@ class ChannelIntegrationTests: BaseAsyncIntegrationTestCase {
   }
 
   func testChannelAsync_WhoIsPresent() async throws {
-    // Keeping a strong reference to this object for test purposes to simulate that someone is already present on the given channel.
-    // If this object is not retained, it will be deallocated, resulting in no subscription to the channel,
-    // which would cause the behavior being tested to fail.
+    // Keeps a strong reference to the returned AsyncStream to prevent it from being deallocated. If this object is not retained,
+    // the AsyncStream will be deallocated, which would cause the behavior being tested to fail.
     let joinResult = try await channel.join()
     debugPrint(joinResult)
 
@@ -116,9 +115,8 @@ class ChannelIntegrationTests: BaseAsyncIntegrationTestCase {
   }
 
   func testChannelAsync_IsPresent() async throws {
-    // Keeping a strong reference to this object for test purposes to simulate that someone is already present on the given channel.
-    // If this object is not retained, it will be deallocated, resulting in no subscription to the channel,
-    // which would cause the behavior being tested to fail.
+    // Keeps a strong reference to the returned AsyncStream to prevent it from being deallocated. If this object is not retained,
+    // the AsyncStream will be deallocated, which would cause the behavior being tested to fail.
     let joinResult = try await channel.join()
     debugPrint(joinResult)
 

Tests/AsyncAwait/ChatAsyncIntegrationTests.swift

@@ -101,9 +101,8 @@ class ChatAsyncIntegrationTests: BaseAsyncIntegrationTestCase {
     let channelId = randomString()
     let channel = try await chat.createChannel(id: channelId, name: channelId)
 
-    // Keeping a strong reference to this object for test purposes to simulate that someone is already present on the given channel.
-    // If this object is not retained, it will be deallocated, resulting in no subscription to the channel,
-    // which would cause the behavior being tested to fail.
+    // Keeps a strong reference to the returned AsyncStream to prevent it from being deallocated. If this object is not retained,
+    // the AsyncStream will be deallocated, which would cause the behavior being tested to fail.
     let connectResult = channel.connect()
     debugPrint(connectResult)
 
@@ -122,9 +121,8 @@ class ChatAsyncIntegrationTests: BaseAsyncIntegrationTestCase {
     let channelId = randomString()
     let channel = try await chat.createChannel(id: channelId, name: channelId)
 
-    // Keeping a strong reference to these objects for test purposes to simulate that someone is already present on the given channel.
-    // If this object is not retained, it will be deallocated, resulting in no subscription to the channel,
-    // which would cause the behavior being tested to fail.
+    // Keeps a strong reference to the returned AsyncStream to prevent it from being deallocated. If this object is not retained,
+    // the AsyncStream will be deallocated, which would cause the behavior being tested to fail.
     let connectResult = channel.connect()
     let joinResult = try await channel.join()
 
@@ -229,9 +227,8 @@ class ChatAsyncIntegrationTests: BaseAsyncIntegrationTestCase {
       name: "ChannelName"
     )
 
-    // Keeping a strong reference to these objects for test purposes to simulate that someone is already present on the given channel.
-    // If this object is not retained, it will be deallocated, resulting in no subscription to the channel,
-    // which would cause the behavior being tested to fail.
+    // Keeps a strong reference to the returned AsyncStream to prevent it from being deallocated. If this object is not retained,
+    // the AsyncStream will be deallocated, which would cause the behavior being tested to fail.
     let joinValue = try await channel.join()
     debugPrint(joinValue)
 
@@ -636,5 +633,44 @@ class ChatAsyncIntegrationTests: BaseAsyncIntegrationTestCase {
     try await chat.removeChannelGroup(id: channelGroup.id)
   }
 
+  func testChatAsync_ConnectionStatusListener() async throws {
+    let expectation = expectation(description: "Status Listener")
+    expectation.assertForOverFulfill = true
+    expectation.expectedFulfillmentCount = 2
+
+    let channel = try await chat.createChannel(id: randomString())
+
+    let statusStreamTask = Task { [weak chat] in
+      if let chat {
+        for await status in chat.connectionStatusStream() {
+          if status == .online {
+            expectation.fulfill()
+            chat.disconnectSubscriptions()
+          } else if status == .offline {
+            expectation.fulfill()
+          } else {
+            XCTFail("Unexpected condition")
+          }
+        }
+      } else {
+        XCTFail("Unexpected condition")
+      }
+    }
+
+    let connectTask = Task {
+      for await message in channel.connect() {
+        debugPrint(message)
+      }
+    }
+
+    addTeardownBlock { [unowned self] in
+      statusStreamTask.cancel()
+      connectTask.cancel()
+      _ = try? await chat.deleteChannel(id: channel.id)
+    }
+
+    await fulfillment(of: [expectation], timeout: 4)
+  }
+
   // swiftlint:disable:next file_length
 }

Tests/AsyncAwait/UserAsyncIntegrationTests.swift

@@ -115,9 +115,8 @@ class UserAsyncIntegrationTests: BaseAsyncIntegrationTestCase {
     let channelId = randomString()
     let createdChannel = try await chat.createChannel(id: channelId, name: channelId)
 
-    // Keeping a strong reference to this object for test purposes to simulate that someone is already present on the given channel.
-    // If this object is not retained, it will be deallocated, resulting in no subscription to the channel,
-    // which would cause the behavior being tested to fail.
+    // Keeps a strong reference to the returned AsyncStream to prevent it from being deallocated. If this object is not retained,
+    // the AsyncStream will be deallocated, which would cause the behavior being tested to fail.
     let connectResult = createdChannel.connect()
     debugPrint(connectResult)
 
@@ -162,9 +161,8 @@ class UserAsyncIntegrationTests: BaseAsyncIntegrationTestCase {
     let channelId = randomString()
     let channel = try await chat.createChannel(id: channelId, name: channelId)
 
-    // Keeping a strong reference to this object for test purposes to simulate that someone is already present on the given channel.
-    // If this object is not retained, it will be deallocated, resulting in no subscription to the channel,
-    // which would cause the behavior being tested to fail.
+    // Keeps a strong reference to the returned AsyncStream to prevent it from being deallocated. If this object is not retained,
+    // the AsyncStream will be deallocated, which would cause the behavior being tested to fail.
     let connectResult = channel.connect()
     debugPrint(connectResult)
 

Tests/ChatIntegrationTests.swift

@@ -1014,5 +1014,47 @@ class ChatIntegrationTests: BaseClosureIntegrationTestCase {
     }
   }
 
+  func testChat_ConnectionStatusListener() throws {
+    let expectation = expectation(description: "Status Listener")
+    expectation.assertForOverFulfill = true
+    expectation.expectedFulfillmentCount = 2
+
+    let channel = try awaitResultValue {
+      chat.createChannel(
+        id: randomString(),
+        completion: $0
+      )
+    }
+
+    let statusListenerCloseable = chat.addConnectionStatusListener { [unowned self] newStatus in
+      if newStatus == .online {
+        expectation.fulfill()
+        chat.disconnectSubscriptions()
+      } else if newStatus == .offline {
+        expectation.fulfill()
+      } else {
+        XCTFail("Unexpected condition")
+      }
+    }
+
+    let autoCloseable = channel.connect { _ in }
+
+    defer {
+      statusListenerCloseable.close()
+      autoCloseable.close()
+
+      addTeardownBlock { [unowned self] in
+        try awaitResult {
+          self.chat.deleteChannel(
+            id: channel.id,
+            completion: $0
+          )
+        }
+      }
+    }
+
+    wait(for: [expectation], timeout: 4)
+  }
+
   // swiftlint:disable:next file_length
 }