Live Location Sharing Banner (#5370)

* Live Location Sharing Banner # Conflicts: # ElementX.xcodeproj/project.pbxproj * updated the top banner modifier and the top banner views # Conflicts: # ElementX/Resources/Localizations/en-US.lproj/Localizable.strings # ElementX/Resources/Localizations/en.lproj/Localizable.strings * improved the stopping function from the timeline item * stop live location sharing before starting a new one. * added some tests for LiveLocationManager * pr suggestions
2026-11-02 12:07:55 +00:00 · 2026-04-10 14:50:42 +02:00
parent 148b292ca6
commit 922fcafcd5
47 changed files with 413 additions and 83 deletions
@@ -0,0 +1,165 @@
+//
+// Copyright 2026 Element Creations Ltd.
+//
+// SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial.
+// Please see LICENSE files in the repository root for full details.
+//
+
+@testable import ElementX
+import Foundation
+import Testing
+
+@MainActor
+final class LiveLocationManagerTests {
+    private var clientProxy: ClientProxyMock!
+    private var manager: LiveLocationManager!
+    
+    private let appSettings: AppSettings
+    
+    init() {
+        AppSettings.resetAllSettings()
+        appSettings = AppSettings()
+        clientProxy = ClientProxyMock(.init())
+        manager = LiveLocationManager(clientProxy: clientProxy, appSettings: appSettings)
+    }
+    
+    deinit {
+        AppSettings.resetAllSettings()
+    }
+    
+    // MARK: - startLiveLocation
+    
+    @Test
+    func startLiveLocationWithNoExistingSession() async throws {
+        let roomProxy = makeRoomProxy(roomID: "!room:matrix.org")
+        clientProxy.roomForIdentifierClosure = { _ in .joined(roomProxy) }
+        
+        let result = await manager.startLiveLocation(roomID: "!room:matrix.org", duration: .seconds(300))
+        
+        try result.get()
+        #expect(roomProxy.startLiveLocationShareDurationCalled)
+        #expect(!roomProxy.stopLiveLocationShareCalled)
+        #expect(appSettings.liveLocationSharingTimeoutDatesByRoomID["!room:matrix.org"] != nil)
+    }
+    
+    @Test
+    func startLiveLocationWithExistingSessionStopsItFirst() async throws {
+        let roomProxy = makeRoomProxy(roomID: "!room:matrix.org")
+        clientProxy.roomForIdentifierClosure = { _ in .joined(roomProxy) }
+        appSettings.liveLocationSharingTimeoutDatesByRoomID["!room:matrix.org"] = Date().addingTimeInterval(300)
+        
+        var callOrder: [String] = []
+        roomProxy.stopLiveLocationShareClosure = {
+            callOrder.append("stop")
+            return .success(())
+        }
+        roomProxy.startLiveLocationShareDurationClosure = { _ in
+            callOrder.append("start")
+            return .success(())
+        }
+        
+        let result = await manager.startLiveLocation(roomID: "!room:matrix.org", duration: .seconds(600))
+        
+        try result.get()
+        #expect(callOrder == ["stop", "start"])
+        #expect(appSettings.liveLocationSharingTimeoutDatesByRoomID["!room:matrix.org"] != nil)
+    }
+    
+    @Test
+    func startLiveLocationDoesNotStopSessionForOtherRoom() async {
+        let roomProxy = makeRoomProxy(roomID: "!room1:matrix.org")
+        clientProxy.roomForIdentifierClosure = { _ in .joined(roomProxy) }
+        
+        appSettings.liveLocationSharingTimeoutDatesByRoomID["!room2:matrix.org"] = Date().addingTimeInterval(300)
+        
+        _ = await manager.startLiveLocation(roomID: "!room1:matrix.org", duration: .seconds(300))
+        
+        #expect(!roomProxy.stopLiveLocationShareCalled)
+        #expect(appSettings.liveLocationSharingTimeoutDatesByRoomID["!room2:matrix.org"] != nil)
+    }
+    
+    @Test
+    func startLiveLocationWhenRoomNotJoined() async {
+        clientProxy.roomForIdentifierClosure = { _ in nil }
+        
+        let result = await manager.startLiveLocation(roomID: "!room:matrix.org", duration: .seconds(300))
+        
+        #expect(throws: LiveLocationManagerError.roomNotJoined) { try result.get() }
+        #expect(appSettings.liveLocationSharingTimeoutDatesByRoomID["!room:matrix.org"] == nil)
+    }
+    
+    @Test
+    func startLiveLocationWhenStartShareFails() async {
+        let roomProxy = makeRoomProxy(roomID: "!room:matrix.org")
+        roomProxy.startLiveLocationShareDurationReturnValue = .failure(.sdkError(RoomProxyMockError.generic))
+        clientProxy.roomForIdentifierClosure = { _ in .joined(roomProxy) }
+        
+        let result = await manager.startLiveLocation(roomID: "!room:matrix.org", duration: .seconds(300))
+        
+        #expect(throws: LiveLocationManagerError.startFailed) { try result.get() }
+        #expect(appSettings.liveLocationSharingTimeoutDatesByRoomID["!room:matrix.org"] == nil)
+    }
+    
+    @Test
+    func startLiveLocationStoresTimeoutDate() async throws {
+        let roomProxy = makeRoomProxy(roomID: "!room:matrix.org")
+        clientProxy.roomForIdentifierClosure = { _ in .joined(roomProxy) }
+        
+        let duration = Duration.seconds(300)
+        let beforeStart = Date()
+        _ = await manager.startLiveLocation(roomID: "!room:matrix.org", duration: duration)
+        let afterStart = Date()
+        
+        let storedTimeout = appSettings.liveLocationSharingTimeoutDatesByRoomID["!room:matrix.org"]
+        let expectedMinTimeout = beforeStart.addingTimeInterval(TimeInterval(duration.seconds))
+        let expectedMaxTimeout = afterStart.addingTimeInterval(TimeInterval(duration.seconds))
+        
+        try #expect((expectedMinTimeout...expectedMaxTimeout).contains(#require(storedTimeout)))
+    }
+    
+    // MARK: - stopLiveLocation
+    
+    @Test
+    func stopLiveLocationWhenSessionExists() async {
+        let roomProxy = makeRoomProxy(roomID: "!room:matrix.org")
+        clientProxy.roomForIdentifierClosure = { _ in .joined(roomProxy) }
+        appSettings.liveLocationSharingTimeoutDatesByRoomID["!room:matrix.org"] = Date().addingTimeInterval(300)
+        
+        await manager.stopLiveLocation(roomID: "!room:matrix.org")
+        
+        #expect(roomProxy.stopLiveLocationShareCalled)
+        #expect(appSettings.liveLocationSharingTimeoutDatesByRoomID["!room:matrix.org"] == nil)
+    }
+    
+    @Test
+    func stopLiveLocationWhenNoSession() async {
+        let roomProxy = makeRoomProxy(roomID: "!room:matrix.org")
+        clientProxy.roomForIdentifierClosure = { _ in .joined(roomProxy) }
+        
+        await manager.stopLiveLocation(roomID: "!room:matrix.org")
+        
+        #expect(roomProxy.stopLiveLocationShareCalled)
+    }
+    
+    @Test
+    func stopLiveLocationDoesNotRemoveOtherSessions() async {
+        let roomProxy = makeRoomProxy(roomID: "!room1:matrix.org")
+        clientProxy.roomForIdentifierClosure = { _ in .joined(roomProxy) }
+        appSettings.liveLocationSharingTimeoutDatesByRoomID["!room1:matrix.org"] = Date().addingTimeInterval(300)
+        appSettings.liveLocationSharingTimeoutDatesByRoomID["!room2:matrix.org"] = Date().addingTimeInterval(300)
+        
+        await manager.stopLiveLocation(roomID: "!room1:matrix.org")
+        
+        #expect(appSettings.liveLocationSharingTimeoutDatesByRoomID["!room1:matrix.org"] == nil)
+        #expect(appSettings.liveLocationSharingTimeoutDatesByRoomID["!room2:matrix.org"] != nil)
+    }
+    
+    // MARK: - Private
+    
+    private func makeRoomProxy(roomID: String) -> JoinedRoomProxyMock {
+        let roomProxy = JoinedRoomProxyMock(.init(id: roomID))
+        roomProxy.startLiveLocationShareDurationReturnValue = .success(())
+        roomProxy.stopLiveLocationShareReturnValue = .success(())
+        return roomProxy
+    }
+}