Use the new preview screen when tapping media on the room and pinned events screens. (#3736)

* Use the new TimelineMediaPreview modifier on the room and pinned timeline screens.

* Use the same presentation logic for all timeline media previews.

* Fix a bug with the detection of the timeline end.

* Send pagination requests from the media preview screen.

* Add SwiftLint to the Danger workflow (it is no longer installed on the runner).

* Put SwiftLint back on all of the GitHub runners too.

* Set the function_parameter_count lint rule to 10.

* Make sure to clean-up any previews when the coordinator is done.

* Handle the viewInRoomTimeline action more appropriately.

ElementX/Sources/Services/Timeline/TimelineController/MockTimelineController.swift

@@ -74,8 +74,11 @@ class MockTimelineController: TimelineControllerProtocol {
         focusLiveCallCount += 1
         callbacks.send(.isLive(true))
     }
-
+    
+    private(set) var paginateBackwardsCallCount = 0
     func paginateBackwards(requestSize: UInt16) async -> Result<Void, TimelineControllerError> {
+        paginateBackwardsCallCount += 1
+        
         paginationState = PaginationState(backward: .paginating, forward: .timelineEndReached)
         
         if client == nil {
@@ -85,9 +88,10 @@ class MockTimelineController: TimelineControllerProtocol {
         return .success(())
     }
     
+    private(set) var paginateForwardsCallCount = 0
     func paginateForwards(requestSize: UInt16) async -> Result<Void, TimelineControllerError> {
-        // try? await simulateForwardPagination()
-        .success(())
+        paginateForwardsCallCount += 1
+        return .success(())
     }
     
     func sendReadReceipt(for itemID: TimelineItemIdentifier) async {

ElementX/Sources/Services/Timeline/TimelineController/TimelineController.swift

@@ -42,7 +42,7 @@ class TimelineController: TimelineControllerProtocol {
     }
     
     var timelineKind: TimelineKind {
-        liveTimelineProvider.kind
+        activeTimelineProvider.kind
     }
     
     init(roomProxy: JoinedRoomProxyProtocol,

ElementX/Sources/Services/Timeline/TimelineController/TimelineControllerFactory.swift

@@ -36,12 +36,13 @@ struct TimelineControllerFactory: TimelineControllerFactoryProtocol {
                                   appSettings: ServiceLocator.shared.settings)
     }
     
-    func buildMessageFilteredTimelineController(allowedMessageTypes: [RoomMessageEventMessageType],
+    func buildMessageFilteredTimelineController(focus: TimelineFocus,
+                                                allowedMessageTypes: [TimelineAllowedMessageType],
                                                 presentation: TimelineKind.MediaPresentation,
                                                 roomProxy: JoinedRoomProxyProtocol,
                                                 timelineItemFactory: RoomTimelineItemFactoryProtocol,
                                                 mediaProvider: MediaProviderProtocol) async -> Result<TimelineControllerProtocol, TimelineFactoryControllerError> {
-        switch await roomProxy.messageFilteredTimeline(allowedMessageTypes: allowedMessageTypes, presentation: presentation) {
+        switch await roomProxy.messageFilteredTimeline(focus: focus, allowedMessageTypes: allowedMessageTypes, presentation: presentation) {
         case .success(let timelineProxy):
             return .success(TimelineController(roomProxy: roomProxy,
                                                timelineProxy: timelineProxy,

ElementX/Sources/Services/Timeline/TimelineController/TimelineControllerFactoryProtocol.swift

@@ -23,7 +23,8 @@ protocol TimelineControllerFactoryProtocol {
                                              timelineItemFactory: RoomTimelineItemFactoryProtocol,
                                              mediaProvider: MediaProviderProtocol) async -> TimelineControllerProtocol?
     
-    func buildMessageFilteredTimelineController(allowedMessageTypes: [RoomMessageEventMessageType],
+    func buildMessageFilteredTimelineController(focus: TimelineFocus,
+                                                allowedMessageTypes: [TimelineAllowedMessageType],
                                                 presentation: TimelineKind.MediaPresentation,
                                                 roomProxy: JoinedRoomProxyProtocol,
                                                 timelineItemFactory: RoomTimelineItemFactoryProtocol,

ElementX/Sources/Services/Timeline/TimelineController/TimelineControllerProtocol.swift

@@ -16,7 +16,14 @@ enum TimelineControllerCallback {
 }
 
 enum TimelineControllerAction {
-    case displayMediaFile(file: MediaFileHandleProxy, title: String?)
+    enum TimelineViewModelKind {
+        /// Use the active timeline view model.
+        case active
+        /// Use the newly generated view model provided.
+        case new(TimelineViewModel)
+    }
+    
+    case displayMediaPreview(item: EventBasedMessageTimelineItemProtocol, timelineViewModel: TimelineViewModelKind)
     case displayLocation(body: String, geoURI: GeoURI, description: String?)
     case none
 }