Improve user session overview tests

* Add sessions overview UI tests * Expose static methods from the UserSession name and lastActivity formatters; cleaned up the UserSessionsOverview a bit * Add UserSessionsOverviewViewModel unit tests * Add UserSessionsOverviewService unit tests
2026-04-20 00:24:43 +02:00 · 2022-09-30 13:49:16 +03:00
parent fa7c7a49d6
commit f8d6f43967
21 changed files with 650 additions and 143 deletions
@@ -0,0 +1,50 @@
+// 
+// Copyright 2022 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import Foundation
+import MatrixSDK
+
+class UserSessionsDataProvider: UserSessionsDataProviderProtocol {
+    private let session: MXSession
+    
+    init(session: MXSession) {
+        self.session = session
+    }
+    
+    var myDeviceId: String {
+        session.myDeviceId
+    }
+    
+    var myUserId: String? {
+        session.myUserId
+    }
+    
+    var activeAccounts: [MXKAccount] {
+        MXKAccountManager.shared().activeAccounts
+    }
+    
+    func devices(completion: @escaping (MXResponse<[MXDevice]>) -> Void) {
+        session.matrixRestClient.devices(completion: completion)
+    }
+    
+    func device(withDeviceId deviceId: String, ofUser userId: String) -> MXDeviceInfo {
+        session.crypto.device(withDeviceId: deviceId, ofUser: userId)
+    }
+    
+    func accountData(for eventType: String) -> [AnyHashable : Any]? {
+        session.accountData.accountData(forEventType: eventType)
+    }
+}
@@ -0,0 +1,32 @@
+// 
+// Copyright 2022 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import Foundation
+import MatrixSDK
+
+protocol UserSessionsDataProviderProtocol {
+    var myDeviceId: String { get }
+    
+    var myUserId: String? { get }
+    
+    var activeAccounts: [MXKAccount] { get }
+    
+    func devices(completion: @escaping (MXResponse<[MXDevice]>) -> Void)
+    
+    func device(withDeviceId deviceId: String, ofUser userId: String) -> MXDeviceInfo
+    
+    func accountData(for eventType: String) -> [AnyHashable: Any]?
+}
@@ -21,12 +21,12 @@ class UserSessionsOverviewService: UserSessionsOverviewServiceProtocol {
    /// Delay after which session is considered inactive, 90 days
    private static let inactiveSessionDurationTreshold: TimeInterval = 90 * 86400
    
-    private let mxSession: MXSession
+    private let dataProvider: UserSessionsDataProviderProtocol
    
    private(set) var overviewData: UserSessionsOverviewData
    
-    init(mxSession: MXSession) {
-        self.mxSession = mxSession
+    init(dataProvider: UserSessionsDataProviderProtocol) {
+        self.dataProvider = dataProvider
        
        overviewData = UserSessionsOverviewData(currentSession: nil,
                                                unverifiedSessions: [],
@@ -39,7 +39,7 @@ class UserSessionsOverviewService: UserSessionsOverviewServiceProtocol {
    // MARK: - Public
    
    func updateOverviewData(completion: @escaping (Result<UserSessionsOverviewData, Error>) -> Void) {
-        mxSession.matrixRestClient.devices { response in
+        dataProvider.devices { response in
            switch response {
            case .success(let devices):
                self.overviewData = self.sessionsOverviewData(from: devices)
@@ -61,16 +61,18 @@ class UserSessionsOverviewService: UserSessionsOverviewServiceProtocol {
    // MARK: - Private
    
    private func setupInitialOverviewData() {
-        let currentSessionInfo = currentSessionInfo()
+        guard let currentSessionInfo = getCurrentSessionInfo() else {
+            return
+        }
        
        overviewData = UserSessionsOverviewData(currentSession: currentSessionInfo,
-                                                unverifiedSessions: [],
-                                                inactiveSessions: [],
+                                                unverifiedSessions: currentSessionInfo.isVerified ? [] : [currentSessionInfo],
+                                                inactiveSessions: currentSessionInfo.isActive ? [] : [currentSessionInfo],
                                                otherSessions: [])
    }
    
-    private func currentSessionInfo() -> UserSessionInfo? {
-        guard let mainAccount = MXKAccountManager.shared().activeAccounts.first,
+    private func getCurrentSessionInfo() -> UserSessionInfo? {
+        guard let mainAccount = dataProvider.activeAccounts.first,
              let device = mainAccount.device else {
            return nil
        }
@@ -80,7 +82,7 @@ class UserSessionsOverviewService: UserSessionsOverviewServiceProtocol {
    private func sessionsOverviewData(from devices: [MXDevice]) -> UserSessionsOverviewData {
        let allSessions = devices
            .sorted { $0.lastSeenTs > $1.lastSeenTs }
-            .map { sessionInfo(from: $0, isCurrentSession: $0.deviceId == mxSession.myDeviceId) }
+            .map { sessionInfo(from: $0, isCurrentSession: $0.deviceId == dataProvider.myDeviceId) }
        
        return UserSessionsOverviewData(currentSession: allSessions.filter(\.isCurrent).first,
                                        unverifiedSessions: allSessions.filter { !$0.isVerified },
@@ -92,7 +94,7 @@ class UserSessionsOverviewService: UserSessionsOverviewServiceProtocol {
        let isSessionVerified = deviceInfo(for: device.deviceId)?.trustLevel.isVerified ?? false

        let eventType = kMXAccountDataTypeClientInformation + "." + device.deviceId
-        let appData = mxSession.accountData.accountData(forEventType: eventType)
+        let appData = dataProvider.accountData(for: eventType)
        var userAgent: UserAgent?
        var isSessionActive = true

@@ -114,11 +116,11 @@ class UserSessionsOverviewService: UserSessionsOverviewServiceProtocol {
    }
    
    private func deviceInfo(for deviceId: String) -> MXDeviceInfo? {
-        guard let userId = mxSession.myUserId else {
+        guard let userId = dataProvider.myUserId else {
            return nil
        }
        
-        return mxSession.crypto.device(withDeviceId: deviceId, ofUser: userId)
+        return dataProvider.device(withDeviceId: deviceId, ofUser: userId)
    }
 }

@@ -17,28 +17,70 @@
 import Foundation

 class MockUserSessionsOverviewService: UserSessionsOverviewServiceProtocol {
-    let overviewData: UserSessionsOverviewData
+    enum Mode {
+        case currentSessionUnverified
+        case currentSessionVerified
+        case onlyUnverifiedSessions
+        case onlyInactiveSessions
+        case noOtherSessions
+    }
+    
+    private let mode: Mode
+    
+    var overviewData: UserSessionsOverviewData
+    
+    init(mode: Mode = .currentSessionUnverified) {
+        self.mode = mode
+        
+        overviewData = UserSessionsOverviewData(currentSession: nil,
+                                                unverifiedSessions: [],
+                                                inactiveSessions: [],
+                                                otherSessions: [])
+    }
    
    func updateOverviewData(completion: @escaping (Result<UserSessionsOverviewData, Error>) -> Void) {
+        let unverifiedSessions = buildSessions(verified: false, active: true)
+        let inactiveSessions = buildSessions(verified: true, active: false)
+        
+        switch mode {
+        case .noOtherSessions:
+            overviewData = UserSessionsOverviewData(currentSession: currentSession,
+                                                    unverifiedSessions: [],
+                                                    inactiveSessions: [],
+                                                    otherSessions: [])
+        case .onlyUnverifiedSessions:
+            overviewData = UserSessionsOverviewData(currentSession: currentSession,
+                                                    unverifiedSessions: unverifiedSessions + [currentSession],
+                                                    inactiveSessions: [],
+                                                    otherSessions: unverifiedSessions)
+        case .onlyInactiveSessions:
+            overviewData = UserSessionsOverviewData(currentSession: currentSession,
+                                                    unverifiedSessions: [],
+                                                    inactiveSessions: inactiveSessions,
+                                                    otherSessions: inactiveSessions)
+        default:
+            let otherSessions = unverifiedSessions + inactiveSessions + buildSessions(verified: true, active: true)
+            
+            overviewData = UserSessionsOverviewData(currentSession: currentSession,
+                                                    unverifiedSessions: unverifiedSessions,
+                                                    inactiveSessions: inactiveSessions,
+                                                    otherSessions: otherSessions)
+        }
+        
        completion(.success(overviewData))
    }
    
    func sessionForIdentifier(_ sessionId: String) -> UserSessionInfo? {
-        nil
+        overviewData.otherSessions.first { $0.id == sessionId }
    }
+
+    // MARK: - Private
    
-    init() {
-        overviewData = UserSessionsOverviewData(currentSession: Self.allSessions.filter(\.isCurrent).first,
-                                                unverifiedSessions: Self.allSessions.filter { !$0.isVerified },
-                                                inactiveSessions: Self.allSessions.filter { !$0.isActive },
-                                                otherSessions: Self.allSessions.filter { !$0.isCurrent })
-    }
-    
-    static let allSessions = [
+    private var currentSession: UserSessionInfo {
        UserSessionInfo(id: "alice",
                        name: "iOS",
                        deviceType: .mobile,
-                        isVerified: false,
+                        isVerified: mode == .currentSessionVerified,
                        lastSeenIP: "10.0.0.10",
                        lastSeenTimestamp: nil,
                        applicationName: "Element iOS",
@@ -49,51 +91,54 @@ class MockUserSessionsOverviewService: UserSessionsOverviewServiceProtocol {
                        lastSeenIPLocation: nil,
                        deviceName: "My iPhone",
                        isActive: true,
-                        isCurrent: true),
-        UserSessionInfo(id: "1",
-                        name: "macOS",
-                        deviceType: .desktop,
-                        isVerified: true,
-                        lastSeenIP: "1.0.0.1",
-                        lastSeenTimestamp: Date().timeIntervalSince1970 - 130_000,
-                        applicationName: "Element MacOS",
-                        applicationVersion: "1.0.0",
-                        applicationURL: nil,
-                        deviceModel: nil,
-                        deviceOS: "macOS 12.5.1",
-                        lastSeenIPLocation: nil,
-                        deviceName: "My Mac",
-                        isActive: false,
-                        isCurrent: false),
-        UserSessionInfo(id: "2",
-                        name: "Firefox on Windows",
-                        deviceType: .web,
-                        isVerified: true,
-                        lastSeenIP: "2.0.0.2",
-                        lastSeenTimestamp: Date().timeIntervalSince1970 - 100,
-                        applicationName: "Element Web",
-                        applicationVersion: "1.0.0",
-                        applicationURL: nil,
-                        deviceModel: nil,
-                        deviceOS: "Windows 10",
-                        lastSeenIPLocation: nil,
-                        deviceName: "My Windows",
-                        isActive: true,
-                        isCurrent: false),
-        UserSessionInfo(id: "3",
-                        name: "Android",
-                        deviceType: .mobile,
-                        isVerified: false,
-                        lastSeenIP: "3.0.0.3",
-                        lastSeenTimestamp: Date().timeIntervalSince1970 - 10,
-                        applicationName: "Element Android",
-                        applicationVersion: "1.0.0",
-                        applicationURL: nil,
-                        deviceModel: nil,
-                        deviceOS: "Android 4.0",
-                        lastSeenIPLocation: nil,
-                        deviceName: "My Phone",
-                        isActive: true,
-                        isCurrent: false)
-    ]
+                        isCurrent: true)
+    }
+    
+    private func buildSessions(verified: Bool, active: Bool) -> [UserSessionInfo] {
+        [UserSessionInfo(id: "1 verified: \(verified) active: \(active)",
+                         name: "macOS verified: \(verified) active: \(active)",
+                         deviceType: .desktop,
+                         isVerified: verified,
+                         lastSeenIP: "1.0.0.1",
+                         lastSeenTimestamp: Date().timeIntervalSince1970 - 130_000,
+                         applicationName: "Element MacOS",
+                         applicationVersion: "1.0.0",
+                         applicationURL: nil,
+                         deviceModel: nil,
+                         deviceOS: "macOS 12.5.1",
+                         lastSeenIPLocation: nil,
+                         deviceName: "My Mac",
+                         isActive: active,
+                         isCurrent: false),
+         UserSessionInfo(id: "2 verified: \(verified) active: \(active)",
+                         name: "Firefox on Windows verified: \(verified) active: \(active)",
+                         deviceType: .web,
+                         isVerified: verified,
+                         lastSeenIP: "2.0.0.2",
+                         lastSeenTimestamp: Date().timeIntervalSince1970 - 100,
+                         applicationName: "Element Web",
+                         applicationVersion: "1.0.0",
+                         applicationURL: nil,
+                         deviceModel: nil,
+                         deviceOS: "Windows 10",
+                         lastSeenIPLocation: nil,
+                         deviceName: "My Windows",
+                         isActive: active,
+                         isCurrent: false),
+         UserSessionInfo(id: "3 verified: \(verified) active: \(active)",
+                         name: "Android verified: \(verified) active: \(active)",
+                         deviceType: .mobile,
+                         isVerified: verified,
+                         lastSeenIP: "3.0.0.3",
+                         lastSeenTimestamp: Date().timeIntervalSince1970 - 10,
+                         applicationName: "Element Android",
+                         applicationVersion: "1.0.0",
+                         applicationURL: nil,
+                         deviceModel: nil,
+                         deviceOS: "Android 4.0",
+                         lastSeenIPLocation: nil,
+                         deviceName: "My Phone",
+                         isActive: active,
+                         isCurrent: false)]
+    }
 }