Event Permalink Tweaks (#2754)

* Handle errors focussing the timeline. * Add a test for focussing on an existing timeline item.
2026-11-03 06:55:59 +00:00 · 2024-04-29 10:00:41 +01:00
parent 231fc6defb
commit 7b2168a540
12 changed files with 100 additions and 8 deletions
@@ -234,9 +234,14 @@ class RoomScreenViewModel: RoomScreenViewModelType, RoomScreenViewModelProtocol
        switch await timelineController.focusOnEvent(eventID, timelineSize: Constants.detachedTimelineSize) {
        case .success:
            state.timelineViewState.focussedEventID = eventID
-        case .failure:
+        case .failure(let error):
            MXLog.error("Failed to focus on event \(eventID)")
-            displayError(.toast(L10n.commonFailed))
+            
+            if case .eventNotFound = error {
+                displayError(.toast(L10n.errorMessageNotFound))
+            } else {
+                displayError(.toast(L10n.commonFailed))
+            }
        }
    }
    
@@ -163,8 +163,20 @@ class RoomProxy: RoomProxyProtocol {
        do {
            let timeline = try await room.timelineFocusedOnEvent(eventId: eventID, numContextEvents: numberOfEvents, internalIdPrefix: UUID().uuidString)
            return .success(TimelineProxy(timeline: timeline, isLive: false))
+        } catch let error as FocusEventError {
+            switch error {
+            case .InvalidEventId(_, let error):
+                MXLog.error("Invalid event \(eventID) Error: \(error)")
+                return .failure(.eventNotFound)
+            case .EventNotFound:
+                MXLog.error("Event \(eventID) not found.")
+                return .failure(.eventNotFound)
+            case .Other(let message):
+                MXLog.error("Failed to create a timeline focussed on event \(eventID) Error: \(message)")
+                return .failure(.sdkError(error))
+            }
        } catch {
-            MXLog.error("Failed to create a timeline focussed on: \(eventID) with error: \(error)")
+            MXLog.error("Unexpected error: \(error)")
            return .failure(.sdkError(error))
        }
    }
@@ -23,6 +23,7 @@ enum RoomProxyError: Error {
    
    case invalidURL
    case invalidMedia
+    case eventNotFound
 }

 enum RoomProxyAction {
@@ -241,11 +241,19 @@ enum RoomTimelineItemFixtures {
    static var outgoingPolls: [RoomTimelineItemProtocol] {
        [PollRoomTimelineItem.mock(poll: .disclosed(createdByAccountOwner: true), isOutgoing: true)]
    }
+    
+    static var permalinkChunk: [RoomTimelineItemProtocol] {
+        (1...20).map { index in
+            TextRoomTimelineItem(id: .init(timelineID: "\(index)", eventID: "$\(index)"),
+                                 text: "Message ID \(index)",
+                                 senderDisplayName: index > 10 ? "Alice" : "Bob")
+        }
+    }
 }

 private extension TextRoomTimelineItem {
-    init(text: String, senderDisplayName: String) {
-        self.init(id: .random,
+    init(id: TimelineItemIdentifier? = nil, text: String, senderDisplayName: String) {
+        self.init(id: id ?? .random,
                  timestamp: "10:47 am",
                  isOutgoing: senderDisplayName == "Alice",
                  isEditable: false,
@@ -66,8 +66,12 @@ class RoomTimelineController: RoomTimelineControllerProtocol {
            activeTimeline = timeline
            activeTimelineProvider = timeline.timelineProvider
            return .success(())
-        case .failure:
-            return .failure(.generic)
+        case .failure(let error):
+            if case .eventNotFound = error {
+                return .failure(.eventNotFound)
+            } else {
+                return .failure(.generic)
+            }
        }
    }
    
@@ -32,6 +32,7 @@ enum RoomTimelineControllerAction {

 enum RoomTimelineControllerError: Error {
    case generic
+    case eventNotFound
 }

@MainActor
@@ -95,6 +95,8 @@ class MockScreen: Identifiable {
    let windowManager: SecureWindowManagerProtocol
    let navigationRootCoordinator: NavigationRootCoordinator
    
+    private var client: UITestsSignalling.Client?
+    
    private var retainedState = [Any]()
    private var cancellables = Set<AnyCancellable>()
    
@@ -393,6 +395,37 @@ class MockScreen: Identifiable {
            
            navigationStackCoordinator.setRootCoordinator(coordinator)
            return navigationStackCoordinator
+        case .roomLayoutHighlight:
+            let navigationStackCoordinator = NavigationStackCoordinator()
+            
+            let timelineController = MockRoomTimelineController()
+            timelineController.timelineItems = RoomTimelineItemFixtures.permalinkChunk
+            let parameters = RoomScreenCoordinatorParameters(roomProxy: RoomProxyMock(with: .init(name: "Timeline highlight", avatarURL: URL.picturesDirectory)),
+                                                             timelineController: timelineController,
+                                                             mediaProvider: MockMediaProvider(),
+                                                             mediaPlayerProvider: MediaPlayerProviderMock(),
+                                                             voiceMessageMediaManager: VoiceMessageMediaManagerMock(),
+                                                             emojiProvider: EmojiProvider(),
+                                                             completionSuggestionService: CompletionSuggestionServiceMock(configuration: .init()),
+                                                             appMediator: AppMediatorMock.default,
+                                                             appSettings: ServiceLocator.shared.settings)
+            let coordinator = RoomScreenCoordinator(parameters: parameters)
+            navigationStackCoordinator.setRootCoordinator(coordinator)
+            
+            do {
+                let client = try UITestsSignalling.Client(mode: .app)
+                client.signals.sink { [weak self] signal in
+                    guard case .timeline(.focusOnEvent(let eventID)) = signal else { return }
+                    coordinator.focusOnEvent(eventID: eventID)
+                    try? client.send(.success)
+                }
+                .store(in: &cancellables)
+            } catch {
+                fatalError("Failure setting up signalling: \(error)")
+            }
+            
+            self.client = client
+            return navigationStackCoordinator
        case .roomWithDisclosedPolls:
            let navigationStackCoordinator = NavigationStackCoordinator()

@@ -34,6 +34,7 @@ enum UITestsScreenIdentifier: String {
    case roomLayoutBottom
    case roomLayoutMiddle
    case roomLayoutTop
+    case roomLayoutHighlight
    case roomMembersListScreenPendingInvites
    case roomPlainNoAvatar
    case roomRolesAndPermissionsFlow
@@ -27,11 +27,13 @@ enum UITestsSignal: Codable, Equatable {
    case success
    
    case timeline(Timeline)
-    enum Timeline: Codable {
+    enum Timeline: Codable, Equatable {
        /// Ask the app to back paginate.
        case paginate
        /// Ask the app to simulate an incoming message.
        case incomingMessage
+        /// Ask the app to simulate focussing on an event ID.
+        case focusOnEvent(String)
    }
    
    /// Posts a notification.