Fix logout clearing token provider before removing the device (#3772)

Author: nuno-vieira

Sources/StreamChat/ChatClient.swift

@@ -508,19 +508,21 @@ public class ChatClient {
         completion: @escaping () -> Void
     ) {
         let currentUserController = currentUserController()
-
-        // We need to call logout after creating the current user controller.
-        // Otherwise we would not be able to create the controller without currentUserId.
-        authenticationRepository.logOutUser()
-
         if removeDevice, let currentUserDevice = currentUserController.currentUser?.currentDevice {
-            currentUserController.removeDevice(id: currentUserDevice.id) { error in
+            currentUserController.removeDevice(id: currentUserDevice.id) { [weak self] error in
                 if let error {
                     log.error(error)
                 }
+                self?.authenticationRepository.logOutUser()
             }
         }
 
+        authenticationRepository.clearCurrentUserId()
+
+        if removeDevice == false {
+            authenticationRepository.logOutUser()
+        }
+
         // Stop tracking active components
         syncRepository.removeAllTracked()
 

Sources/StreamChat/Repositories/AuthenticationRepository.swift

@@ -211,6 +211,10 @@ class AuthenticationRepository {
         currentUserId = nil
     }
 
+    func clearCurrentUserId() {
+        currentUserId = nil
+    }
+
     func refreshToken(completion: @escaping (Error?) -> Void) {
         guard let tokenProvider = tokenProvider else {
             let error = ClientError.MissingTokenProvider()

TestTools/StreamChatTestTools/Mocks/StreamChat/Repositories/AuthenticationRepository_Mock.swift

@@ -13,6 +13,7 @@ class AuthenticationRepository_Mock: AuthenticationRepository, Spy {
         static let refreshToken = "refreshToken(completion:)"
         static let clearTokenProvider = "clearTokenProvider()"
         static let logOut = "logOutUser()"
+        static let clearCurrentUserId = "clearCurrentUserId()"
         static let completeTokenWaiters = "completeTokenWaiters(token:)"
         static let completeTokenCompletions = "completeTokenCompletions(error:)"
         static let setToken = "setToken(token:completeTokenWaiters:)"
@@ -95,6 +96,10 @@ class AuthenticationRepository_Mock: AuthenticationRepository, Spy {
         record()
     }
 
+    override func clearCurrentUserId() {
+        record()
+    }
+
     var resetCallCount: Int = 0
     override func reset() {
         resetCallCount += 1

Tests/StreamChatTests/ChatClient_Tests.swift

@@ -331,7 +331,7 @@ final class ChatClient_Tests: XCTestCase {
             expectation.fulfill()
         }
         /// Erasing current user id should be called right after calling logout.
-        XCTAssertCall(AuthenticationRepository_Mock.Signature.logOut, on: testEnv.authenticationRepository!)
+        XCTAssertCall(AuthenticationRepository_Mock.Signature.clearCurrentUserId, on: testEnv.authenticationRepository!)
 
         // THEN
         waitForExpectations(timeout: defaultTimeout)