Merge pull request #7518 from vector-im/nimau/7497_timeline_closed_polls

Fix: allow to render a TimelinePoll even if the poll is loading
element-hq · Apr 27, 2023 · ef4dc46 · ef4dc46
2 parents 0b0d925 + c9e9bd0
commit ef4dc46
Show file tree

Hide file tree

Showing 12 changed files with 173 additions and 94 deletions.
diff --git a/Riot/Assets/en.lproj/Vector.strings b/Riot/Assets/en.lproj/Vector.strings
@@ -2405,6 +2405,8 @@ Tap the + to start adding people.";
 
 "poll_timeline_reply_ended_poll" = "Ended poll";
 
+"poll_timeline_loading" = "Loading...";
+
 // MARK: - Location sharing
 
 "location_sharing_title" = "Location";

diff --git a/Riot/Generated/Strings.swift b/Riot/Generated/Strings.swift
@@ -4927,6 +4927,10 @@ public class VectorL10n: NSObject {
   public static var pollTimelineEndedText: String { 
     return VectorL10n.tr("Vector", "poll_timeline_ended_text") 
   }
+  /// Loading...
+  public static var pollTimelineLoading: String { 
+    return VectorL10n.tr("Vector", "poll_timeline_loading") 
+  }
   /// Please try again
   public static var pollTimelineNotClosedSubtitle: String { 
     return VectorL10n.tr("Vector", "poll_timeline_not_closed_subtitle") 

diff --git a/...SwiftUI/Modules/Room/PollHistory/PollHistoryDetail/MockPollHistoryDetailScreenState.swift b/...SwiftUI/Modules/Room/PollHistory/PollHistoryDetail/MockPollHistoryDetailScreenState.swift
@@ -48,7 +48,7 @@ enum MockPollHistoryDetailScreenState: MockScreenState, CaseIterable {
     }
 
     var screenView: ([Any], AnyView) {
-        let timelineViewModel = TimelinePollViewModel(timelinePollDetails: poll)
+        let timelineViewModel = TimelinePollViewModel(timelinePollDetailsState: .loaded(poll))
         let viewModel = PollHistoryDetailViewModel(poll: poll)
 
         return ([viewModel], AnyView(PollHistoryDetail(viewModel: viewModel.context, contentPoll: TimelinePollView(viewModel: timelineViewModel.context))))

diff --git a/RiotSwiftUI/Modules/Room/PollHistory/Service/MatrixSDK/PollHistoryService.swift b/RiotSwiftUI/Modules/Room/PollHistory/Service/MatrixSDK/PollHistoryService.swift
@@ -209,13 +209,13 @@ extension PollHistoryService: PollAggregatorDelegate {
     func pollAggregator(_ aggregator: PollAggregator, didFailWithError: Error) { }
 
     func pollAggregatorDidEndLoading(_ aggregator: PollAggregator) {
-        guard let context = pollAggregationContexts[aggregator.poll.id], context.published == false else {
+        guard let poll = aggregator.poll, let context = pollAggregationContexts[poll.id], context.published == false else {
             return
         }
 
         context.published = true
 
-        let newPoll: TimelinePollDetails = .init(poll: aggregator.poll, represent: .started)
+        let newPoll: TimelinePollDetails = .init(poll: poll, represent: .started)
 
         if context.isLivePoll {
             livePollsSubject.send(newPoll)
@@ -225,9 +225,9 @@ extension PollHistoryService: PollAggregatorDelegate {
     }
 
     func pollAggregatorDidUpdateData(_ aggregator: PollAggregator) {
-        guard let context = pollAggregationContexts[aggregator.poll.id], context.published else {
+        guard let poll = aggregator.poll, let context = pollAggregationContexts[poll.id], context.published else {
             return
         }
-        updatesSubject.send(.init(poll: aggregator.poll, represent: .started))
+        updatesSubject.send(.init(poll: poll, represent: .started))
     }
 }
diff --git a/RiotSwiftUI/Modules/Room/TimelinePoll/Coordinator/TimelinePollCoordinator.swift b/RiotSwiftUI/Modules/Room/TimelinePoll/Coordinator/TimelinePollCoordinator.swift
@@ -32,7 +32,7 @@ final class TimelinePollCoordinator: Coordinator, Presentable, PollAggregatorDel
     private let parameters: TimelinePollCoordinatorParameters
     private let selectedAnswerIdentifiersSubject = PassthroughSubject<[String], Never>()
 
-    private var pollAggregator: PollAggregator
+    private var pollAggregator: PollAggregator!
     private(set) var viewModel: TimelinePollViewModelProtocol!
     private var cancellables = Set<AnyCancellable>()
 
@@ -46,10 +46,9 @@ final class TimelinePollCoordinator: Coordinator, Presentable, PollAggregatorDel
     init(parameters: TimelinePollCoordinatorParameters) throws {
         self.parameters = parameters
 
-        try pollAggregator = PollAggregator(session: parameters.session, room: parameters.room, pollEvent: parameters.pollEvent)
-        pollAggregator.delegate = self
+        viewModel = TimelinePollViewModel(timelinePollDetailsState: .loading)
+        try pollAggregator = PollAggregator(session: parameters.session, room: parameters.room, pollEvent: parameters.pollEvent, delegate: self)
 
-        viewModel = TimelinePollViewModel(timelinePollDetails: buildTimelinePollFrom(pollAggregator.poll))
         viewModel.completion = { [weak self] result in
             guard let self = self else { return }
 
@@ -92,11 +91,11 @@ final class TimelinePollCoordinator: Coordinator, Presentable, PollAggregatorDel
     }
 
     func canEndPoll() -> Bool {
-        pollAggregator.poll.isClosed == false
+        pollAggregator.poll?.isClosed == false
     }
 
     func canEditPoll() -> Bool {
-        pollAggregator.poll.isClosed == false && pollAggregator.poll.totalAnswerCount == 0
+        pollAggregator.poll?.isClosed == false && pollAggregator.poll?.totalAnswerCount == 0
     }
 
     func endPoll() {
@@ -108,14 +107,23 @@ final class TimelinePollCoordinator: Coordinator, Presentable, PollAggregatorDel
     // MARK: - PollAggregatorDelegate
 
     func pollAggregatorDidUpdateData(_ aggregator: PollAggregator) {
-        viewModel.updateWithPollDetails(buildTimelinePollFrom(aggregator.poll))
+        if let poll = aggregator.poll {
+            viewModel.updateWithPollDetailsState(.loaded(buildTimelinePollFrom(poll)))
+        }
     }
 
     func pollAggregatorDidStartLoading(_ aggregator: PollAggregator) { }
 
-    func pollAggregatorDidEndLoading(_ aggregator: PollAggregator) { }
+    func pollAggregatorDidEndLoading(_ aggregator: PollAggregator) {
+        guard let poll = aggregator.poll else {
+            return
+        }
+        viewModel.updateWithPollDetailsState(.loaded(buildTimelinePollFrom(poll)))
+    }
 
-    func pollAggregator(_ aggregator: PollAggregator, didFailWithError: Error) { }
+    func pollAggregator(_ aggregator: PollAggregator, didFailWithError: Error) {
+        viewModel.updateWithPollDetailsState(.errored)
+    }
 
     // MARK: - Private
 

diff --git a/RiotSwiftUI/Modules/Room/TimelinePoll/Test/Unit/TimelinePollViewModelTests.swift b/RiotSwiftUI/Modules/Room/TimelinePoll/Test/Unit/TimelinePollViewModelTests.swift
@@ -41,111 +41,134 @@ class TimelinePollViewModelTests: XCTestCase {
                                                hasBeenEdited: false,
                                                hasDecryptionError: false)
 
-        viewModel = TimelinePollViewModel(timelinePollDetails: timelinePoll)
+        viewModel = TimelinePollViewModel(timelinePollDetailsState: .loaded(timelinePoll))
         context = viewModel.context
     }
 
     func testInitialState() {
-        XCTAssertEqual(context.viewState.poll.answerOptions.count, 3)
-        XCTAssertFalse(context.viewState.poll.closed)
-        XCTAssertEqual(context.viewState.poll.type, .disclosed)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions.count, 3)
+        XCTAssertEqual(context.viewState.pollState.poll?.closed, false)
+        XCTAssertEqual(context.viewState.pollState.poll?.type, .disclosed)
     }
 
     func testSingleSelectionOnMax1Allowed() {
         context.send(viewAction: .selectAnswerOptionWithIdentifier("1"))
-
-        XCTAssertTrue(context.viewState.poll.answerOptions[0].selected)
-        XCTAssertFalse(context.viewState.poll.answerOptions[1].selected)
-        XCTAssertFalse(context.viewState.poll.answerOptions[2].selected)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[0].selected, true)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[1].selected, false)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[2].selected, false)
     }
 
     func testSingleReselectionOnMax1Allowed() {
         context.send(viewAction: .selectAnswerOptionWithIdentifier("1"))
         context.send(viewAction: .selectAnswerOptionWithIdentifier("1"))
-
-        XCTAssertTrue(context.viewState.poll.answerOptions[0].selected)
-        XCTAssertFalse(context.viewState.poll.answerOptions[1].selected)
-        XCTAssertFalse(context.viewState.poll.answerOptions[2].selected)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[0].selected, true)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[1].selected, false)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[2].selected, false)
     }
 
     func testMultipleSelectionOnMax1Allowed() {
         context.send(viewAction: .selectAnswerOptionWithIdentifier("1"))
         context.send(viewAction: .selectAnswerOptionWithIdentifier("3"))
-
-        XCTAssertFalse(context.viewState.poll.answerOptions[0].selected)
-        XCTAssertFalse(context.viewState.poll.answerOptions[1].selected)
-        XCTAssertTrue(context.viewState.poll.answerOptions[2].selected)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[0].selected, false)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[1].selected, false)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[2].selected, true)
     }
 
     func testMultipleReselectionOnMax1Allowed() {
         context.send(viewAction: .selectAnswerOptionWithIdentifier("1"))
         context.send(viewAction: .selectAnswerOptionWithIdentifier("3"))
         context.send(viewAction: .selectAnswerOptionWithIdentifier("3"))
-
-        XCTAssertFalse(context.viewState.poll.answerOptions[0].selected)
-        XCTAssertFalse(context.viewState.poll.answerOptions[1].selected)
-        XCTAssertTrue(context.viewState.poll.answerOptions[2].selected)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[0].selected, false)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[1].selected, false)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[2].selected, true)
     }
 
     func testClosedSelection() {
-        viewModel.state.poll.closed = true
+        guard case var .loaded(poll) = context.viewState.pollState else {
+            return XCTFail()
+        }
+        poll.closed = true
+        viewModel.updateWithPollDetailsState(.loaded(poll))
 
         context.send(viewAction: .selectAnswerOptionWithIdentifier("1"))
         context.send(viewAction: .selectAnswerOptionWithIdentifier("3"))
 
-        XCTAssertFalse(context.viewState.poll.answerOptions[0].selected)
-        XCTAssertFalse(context.viewState.poll.answerOptions[1].selected)
-        XCTAssertFalse(context.viewState.poll.answerOptions[2].selected)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[0].selected, false)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[1].selected, false)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[2].selected, false)
     }
 
     func testSingleSelectionOnMax2Allowed() {
-        viewModel.state.poll.maxAllowedSelections = 2
+        guard case var .loaded(poll) = context.viewState.pollState else {
+            return XCTFail()
+        }
+        poll.maxAllowedSelections = 2
+        viewModel.updateWithPollDetailsState(.loaded(poll))
 
         context.send(viewAction: .selectAnswerOptionWithIdentifier("1"))
 
-        XCTAssertTrue(context.viewState.poll.answerOptions[0].selected)
-        XCTAssertFalse(context.viewState.poll.answerOptions[1].selected)
-        XCTAssertFalse(context.viewState.poll.answerOptions[2].selected)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[0].selected, true)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[1].selected, false)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[2].selected, false)
     }
 
     func testSingleReselectionOnMax2Allowed() {
-        viewModel.state.poll.maxAllowedSelections = 2
+        guard case var .loaded(poll) = context.viewState.pollState else {
+            return XCTFail()
+        }
+        poll.maxAllowedSelections = 2
+        viewModel.updateWithPollDetailsState(.loaded(poll))
 
         context.send(viewAction: .selectAnswerOptionWithIdentifier("1"))
         context.send(viewAction: .selectAnswerOptionWithIdentifier("1"))
 
-        XCTAssertFalse(context.viewState.poll.answerOptions[0].selected)
-        XCTAssertFalse(context.viewState.poll.answerOptions[1].selected)
-        XCTAssertFalse(context.viewState.poll.answerOptions[2].selected)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[0].selected, false)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[1].selected, false)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[2].selected, false)
     }
 
     func testMultipleSelectionOnMax2Allowed() {
-        viewModel.state.poll.maxAllowedSelections = 2
-
+        guard case var .loaded(poll) = context.viewState.pollState else {
+            return XCTFail()
+        }
+        poll.maxAllowedSelections = 2
+        viewModel.updateWithPollDetailsState(.loaded(poll))
+
         context.send(viewAction: .selectAnswerOptionWithIdentifier("1"))
         context.send(viewAction: .selectAnswerOptionWithIdentifier("3"))
         context.send(viewAction: .selectAnswerOptionWithIdentifier("2"))
 
-        XCTAssertTrue(context.viewState.poll.answerOptions[0].selected)
-        XCTAssertFalse(context.viewState.poll.answerOptions[1].selected)
-        XCTAssertTrue(context.viewState.poll.answerOptions[2].selected)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[0].selected, true)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[1].selected, false)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[2].selected, true)
 
         context.send(viewAction: .selectAnswerOptionWithIdentifier("1"))
 
-        XCTAssertFalse(context.viewState.poll.answerOptions[0].selected)
-        XCTAssertFalse(context.viewState.poll.answerOptions[1].selected)
-        XCTAssertTrue(context.viewState.poll.answerOptions[2].selected)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[0].selected, false)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[1].selected, false)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[2].selected, true)
 
         context.send(viewAction: .selectAnswerOptionWithIdentifier("2"))
 
-        XCTAssertFalse(context.viewState.poll.answerOptions[0].selected)
-        XCTAssertTrue(context.viewState.poll.answerOptions[1].selected)
-        XCTAssertTrue(context.viewState.poll.answerOptions[2].selected)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[0].selected, false)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[1].selected, true)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[2].selected, true)
 
         context.send(viewAction: .selectAnswerOptionWithIdentifier("3"))
 
-        XCTAssertFalse(context.viewState.poll.answerOptions[0].selected)
-        XCTAssertTrue(context.viewState.poll.answerOptions[1].selected)
-        XCTAssertFalse(context.viewState.poll.answerOptions[2].selected)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[0].selected, false)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[1].selected, true)
+        XCTAssertEqual(context.viewState.pollState.poll?.answerOptions[2].selected, false)
+    }
+}
+
+private extension TimelinePollDetailsState {
+    var poll: TimelinePollDetails? {
+        switch self {
+        case .loaded(let poll):
+            return poll
+        default:
+            return nil
+        }
     }
 }
diff --git a/RiotSwiftUI/Modules/Room/TimelinePoll/TimelinePollModels.swift b/RiotSwiftUI/Modules/Room/TimelinePoll/TimelinePollModels.swift
@@ -37,6 +37,12 @@ enum TimelinePollEventType {
     case ended
 }
 
+enum TimelinePollDetailsState {
+    case loading
+    case loaded(TimelinePollDetails)
+    case errored
+}
+
 struct TimelinePollAnswerOption: Identifiable {
     var id: String
     var text: String
@@ -94,7 +100,7 @@ struct TimelinePollDetails {
 extension TimelinePollDetails: Identifiable { }
 
 struct TimelinePollViewState: BindableState {
-    var poll: TimelinePollDetails
+    var pollState: TimelinePollDetailsState
     var bindings: TimelinePollViewStateBindings
 }
 

diff --git a/RiotSwiftUI/Modules/Room/TimelinePoll/TimelinePollScreenState.swift b/RiotSwiftUI/Modules/Room/TimelinePoll/TimelinePollScreenState.swift
@@ -23,6 +23,9 @@ enum MockTimelinePollScreenState: MockScreenState, CaseIterable {
     case openUndisclosed
     case closedUndisclosed
     case closedPollEnded
+    case loading
+    case invalidStartEvent
+    case withAlert
 
     var screenType: Any.Type {
         TimelinePollDetails.self
@@ -45,7 +48,20 @@ enum MockTimelinePollScreenState: MockScreenState, CaseIterable {
                                        hasBeenEdited: false,
                                        hasDecryptionError: false)
 
-        let viewModel = TimelinePollViewModel(timelinePollDetails: poll)
+        let viewModel: TimelinePollViewModel
+
+        switch self {
+        case .loading:
+            viewModel = TimelinePollViewModel(timelinePollDetailsState: .loading)
+        case .invalidStartEvent:
+            viewModel = TimelinePollViewModel(timelinePollDetailsState: .errored)
+        default:
+            viewModel = TimelinePollViewModel(timelinePollDetailsState: .loaded(poll))
+        }
+
+        if self == .withAlert {
+            viewModel.showAnsweringFailure()
+        }
 
         return ([viewModel], AnyView(TimelinePollView(viewModel: viewModel.context)))
     }