Fix connection not resuming after guest user goes to background (#3483)

* Fix the connection not resuming after the app is foregrounded * Make the token refresh details more clear in the Demo App * Update CHANGELOG.md * Rename forgotten variable
GetStream · Nov 8, 2024 · 7d7145b · 7d7145b
1 parent f908d69
commit 7d7145b
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 19 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,7 +3,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 # Upcoming
 
-### 🔄 Changed
+## StreamChat
+### 🐞 Fixed
+- Fix connection not resuming after guest user goes to background [#3483](https://github.com/GetStream/stream-chat-swift/pull/3483)
 
 # [4.66.0](https://github.com/GetStream/stream-chat-swift/releases/tag/4.66.0)
 _November 05, 2024_

diff --git a/DemoApp/Screens/AppConfigViewController/AppConfigViewController.swift b/DemoApp/Screens/AppConfigViewController/AppConfigViewController.swift
@@ -28,11 +28,10 @@ struct DemoAppConfig {
         /// The app secret from the dashboard.
         let appSecret: String
         /// The duration in seconds until the token is expired.
-        let duration: TimeInterval
+        let expirationDuration: TimeInterval
         /// In order to test token refresh fails, we can set a value of how
-        /// many token refresh will succeed before it starts failing.
-        /// By default it is 0. Which means it will always succeed.
-        let numberOfSuccessfulRefreshesBeforeFailing: Int
+        /// many token refresh will fail before a successful one.
+        let numberOfFailures: Int
     }
 }
 
@@ -317,8 +316,8 @@ class AppConfigViewController: UITableViewController {
                 self?.demoAppConfig.isLocationAttachmentsEnabled = newValue
             }
         case .tokenRefreshDetails:
-            if let tokenRefreshDuration = demoAppConfig.tokenRefreshDetails?.duration {
-                cell.detailTextLabel?.text = "Duration: \(tokenRefreshDuration)s"
+            if let tokenRefreshDuration = demoAppConfig.tokenRefreshDetails?.expirationDuration {
+                cell.detailTextLabel?.text = "Duration before expired: \(tokenRefreshDuration)s"
             } else {
                 cell.detailTextLabel?.text = "Disabled"
             }
@@ -626,28 +625,28 @@ class AppConfigViewController: UITableViewController {
             }
         }
         alert.addTextField { textField in
-            textField.placeholder = "Duration (Seconds)"
+            textField.placeholder = "Expiration duration (Seconds)"
             textField.keyboardType = .numberPad
-            if let duration = self.demoAppConfig.tokenRefreshDetails?.duration {
+            if let duration = self.demoAppConfig.tokenRefreshDetails?.expirationDuration {
                 textField.text = "\(duration)"
             }
         }
         alert.addTextField { textField in
-            textField.placeholder = "Number of Refreshes Before Failing"
+            textField.placeholder = "Number of refresh fails"
             textField.keyboardType = .numberPad
-            if let numberOfRefreshes = self.demoAppConfig.tokenRefreshDetails?.numberOfSuccessfulRefreshesBeforeFailing {
+            if let numberOfRefreshes = self.demoAppConfig.tokenRefreshDetails?.numberOfFailures {
                 textField.text = "\(numberOfRefreshes)"
             }
         }
 
         alert.addAction(.init(title: "Enable", style: .default, handler: { _ in
             guard let appSecret = alert.textFields?[0].text else { return }
             guard let duration = alert.textFields?[1].text else { return }
-            guard let successfulRetries = alert.textFields?[2].text else { return }
+            guard let numberOfFailures = alert.textFields?[2].text else { return }
             self.demoAppConfig.tokenRefreshDetails = .init(
                 appSecret: appSecret,
-                duration: TimeInterval(duration) ?? 60,
-                numberOfSuccessfulRefreshesBeforeFailing: Int(successfulRetries) ?? 0
+                expirationDuration: TimeInterval(duration) ?? 60,
+                numberOfFailures: Int(numberOfFailures) ?? 0
             )
         }))
 

diff --git a/DemoApp/Shared/Token+Development.swift b/DemoApp/Shared/Token+Development.swift
@@ -17,16 +17,15 @@ extension StreamChatWrapper {
                 let generatedToken: Token? = _generateUserToken(
                     secret: refreshDetails.appSecret,
                     userID: initialToken.userId,
-                    expirationDate: Date().addingTimeInterval(refreshDetails.duration)
+                    expirationDate: Date().addingTimeInterval(refreshDetails.expirationDuration)
                 )
 
                 if generatedToken == nil {
                     log.error("Demo App Token Refreshing: Unable to generate token. Using initialToken instead.")
                 }
 
-                let numberOfSuccessfulRefreshes = refreshDetails.numberOfSuccessfulRefreshesBeforeFailing
-                let shouldNotFail = numberOfSuccessfulRefreshes == 0
-                if shouldNotFail || self.numberOfRefreshTokens >= numberOfSuccessfulRefreshes {
+                let shouldNotFail = refreshDetails.numberOfFailures == 0
+                if shouldNotFail || self.numberOfRefreshTokens >= refreshDetails.numberOfFailures {
                     print("Demo App Token Refreshing: New token generated successfully.")
                     let newToken = generatedToken ?? initialToken
                     completion(.success(newToken))

diff --git a/Sources/StreamChat/ChatClient.swift b/Sources/StreamChat/ChatClient.swift
@@ -456,7 +456,6 @@ public class ChatClient {
     /// Disconnects the chat client from the chat servers. No further updates from the servers
     /// are received.
     public func disconnect(completion: @escaping () -> Void) {
-        connectionRecoveryHandler?.stop()
         connectionRepository.disconnect(source: .userInitiated) {
             log.info("The `ChatClient` has been disconnected.", subsystems: .webSocket)
             completion()