Merge branch 'develop' into ismail/5068_start_thread

RiotSwiftUI/Modules/Room/TimelinePoll/Coordinator/TimelinePollCoordinator.swift

@@ -0,0 +1,155 @@
+//
+// Copyright 2021 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 SwiftUI
+import MatrixSDK
+import Combine
+
+struct TimelinePollCoordinatorParameters {
+    let session: MXSession
+    let room: MXRoom
+    let pollStartEvent: MXEvent
+}
+
+@available(iOS 14.0, *)
+final class TimelinePollCoordinator: Coordinator, Presentable, PollAggregatorDelegate {
+    
+    // MARK: - Properties
+    
+    // MARK: Private
+    
+    private let parameters: TimelinePollCoordinatorParameters
+    private let selectedAnswerIdentifiersSubject = PassthroughSubject<[String], Never>()
+    
+    private var pollAggregator: PollAggregator
+    private var viewModel: TimelinePollViewModel!
+    private var cancellables = Set<AnyCancellable>()
+    
+    // MARK: Public
+
+    // Must be used only internally
+    var childCoordinators: [Coordinator] = []
+    
+    // MARK: - Setup
+    
+    @available(iOS 14.0, *)
+    init(parameters: TimelinePollCoordinatorParameters) throws {
+        self.parameters = parameters
+        
+        try pollAggregator = PollAggregator(session: parameters.session, room: parameters.room, pollStartEventId: parameters.pollStartEvent.eventId)
+        pollAggregator.delegate = self
+        
+        viewModel = TimelinePollViewModel(timelinePollDetails: buildTimelinePollFrom(pollAggregator.poll))
+        viewModel.callback = { [weak self] result in
+            guard let self = self else { return }
+            
+            switch result {
+            case .selectedAnswerOptionsWithIdentifiers(let identifiers):
+                self.selectedAnswerIdentifiersSubject.send(identifiers)
+            }
+        }
+        
+        selectedAnswerIdentifiersSubject
+            .debounce(for: 1.0, scheduler: RunLoop.main)
+            .removeDuplicates()
+            .sink { [weak self] identifiers in
+                guard let self = self else { return }
+
+                self.parameters.room.sendPollResponse(for: parameters.pollStartEvent,
+                                                      withAnswerIdentifiers: identifiers,
+                                                      threadId: nil,
+                                                      localEcho: nil, success: nil) { [weak self] error in
+                    guard let self = self else { return }
+                    
+                    MXLog.error("[TimelinePollCoordinator]] Failed submitting response with error \(String(describing: error))")
+                    
+                    self.viewModel.dispatch(action: .showAnsweringFailure)
+                }
+            }
+            .store(in: &cancellables)
+    }
+    
+    // MARK: - Public
+    func start() {
+        
+    }
+    
+    func toPresentable() -> UIViewController {
+        return VectorHostingController(rootView: TimelinePollView(viewModel: viewModel.context))
+    }
+    
+    func canEndPoll() -> Bool {
+        return pollAggregator.poll.isClosed == false
+    }
+    
+    func canEditPoll() -> Bool {
+        return false // Intentionally disabled until platform parity.
+        // return pollAggregator.poll.isClosed == false && pollAggregator.poll.totalAnswerCount == 0
+    }
+    
+    func endPoll() {
+        parameters.room.sendPollEnd(for: parameters.pollStartEvent, threadId: nil, localEcho: nil, success: nil) { [weak self] error in
+            self?.viewModel.dispatch(action: .showClosingFailure)
+        }
+    }
+    
+    // MARK: - PollAggregatorDelegate
+    
+    func pollAggregatorDidUpdateData(_ aggregator: PollAggregator) {
+        viewModel.dispatch(action: .updateWithPoll(buildTimelinePollFrom(aggregator.poll)))
+    }
+    
+    func pollAggregatorDidStartLoading(_ aggregator: PollAggregator) {
+        
+    }
+    
+    func pollAggregatorDidEndLoading(_ aggregator: PollAggregator) {
+        
+    }
+    
+    func pollAggregator(_ aggregator: PollAggregator, didFailWithError: Error) {
+        
+    }
+    
+    // MARK: - Private
+    
+    // PollProtocol is intentionally not available in the SwiftUI target as we don't want
+    // to add the SDK as a dependency to it. We need to translate from one to the other on this level.
+    func buildTimelinePollFrom(_ poll: PollProtocol) -> TimelinePollDetails {
+        let answerOptions = poll.answerOptions.map { pollAnswerOption in
+            TimelinePollAnswerOption(id: pollAnswerOption.id,
+                                 text: pollAnswerOption.text,
+                                 count: pollAnswerOption.count,
+                                 winner: pollAnswerOption.isWinner,
+                                 selected: pollAnswerOption.isCurrentUserSelection)
+        }
+        
+        return TimelinePollDetails(question: poll.text,
+                            answerOptions: answerOptions,
+                            closed: poll.isClosed,
+                            totalAnswerCount: poll.totalAnswerCount,
+                            type: pollKindToTimelinePollType(poll.kind),
+                            maxAllowedSelections: poll.maxAllowedSelections,
+                            hasBeenEdited: poll.hasBeenEdited)
+    }
+    
+    private func pollKindToTimelinePollType(_ kind: PollKind) -> TimelinePollType {
+        let mapping = [PollKind.disclosed: TimelinePollType.disclosed,
+                       PollKind.undisclosed: TimelinePollType.undisclosed]
+        
+        return mapping[kind] ?? .disclosed
+    }
+}

RiotSwiftUI/Modules/Room/TimelinePoll/Coordinator/TimelinePollProvider.swift

@@ -0,0 +1,55 @@
+// 
+// Copyright 2021 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
+
+@available(iOS 14, *)
+class TimelinePollProvider {
+    static let shared = TimelinePollProvider()
+    
+    var session: MXSession?
+    var coordinatorsForEventIdentifiers = [String: TimelinePollCoordinator]()
+    
+    private init() {
+        
+    }
+    
+    /// Create or retrieve the poll timeline coordinator for this event and return
+    /// a view to be displayed in the timeline
+    func buildTimelinePollViewForEvent(_ event: MXEvent) -> UIView? {
+        guard let session = session, let room = session.room(withRoomId: event.roomId) else {
+            return nil
+        }
+        
+        if let coordinator = coordinatorsForEventIdentifiers[event.eventId] {
+            return coordinator.toPresentable().view
+        }
+        
+        let parameters = TimelinePollCoordinatorParameters(session: session, room: room, pollStartEvent: event)
+        guard let coordinator = try? TimelinePollCoordinator(parameters: parameters) else {
+            return nil
+        }
+        
+        coordinatorsForEventIdentifiers[event.eventId] = coordinator
+        
+        return coordinator.toPresentable().view
+    }
+    
+    /// Retrieve the poll timeline coordinator for the given event or nil if it hasn't been created yet
+    func timelinePollCoordinatorForEventIdentifier(_ eventIdentifier: String) -> TimelinePollCoordinator? {
+        return coordinatorsForEventIdentifiers[eventIdentifier]
+    }
+}