Add polls "creator view" (#1765)

* Add end button in PollRoomTimelineView

* Add creator logic

* Refine PollRoomTimelineView previews

* Add UI tests

* Update preview tests

ElementX/Sources/Mocks/PollMock.swift

@@ -21,29 +21,33 @@ extension Poll {
                      pollKind: Poll.Kind = .disclosed,
                      options: [Poll.Option],
                      votes: [String: [String]] = [:],
-                     ended: Bool = false) -> Self {
+                     ended: Bool = false,
+                     createdByAccountOwner: Bool = false) -> Self {
         .init(question: question,
               kind: pollKind,
               maxSelections: 1,
               options: options,
               votes: votes,
-              endDate: ended ? Date() : nil)
+              endDate: ended ? Date() : nil,
+              createdByAccountOwner: createdByAccountOwner)
     }
 
-    static var disclosed: Self {
+    static func disclosed(createdByAccountOwner: Bool = false) -> Self {
         mock(question: "What country do you like most?",
              pollKind: .disclosed,
              options: [.mock(text: "Italy 🇮🇹", votes: 5, allVotes: 10, isWinning: true),
                        .mock(text: "China 🇨🇳", votes: 3, allVotes: 10),
-                       .mock(text: "USA 🇺🇸", votes: 2, allVotes: 10)])
+                       .mock(text: "USA 🇺🇸", votes: 2, allVotes: 10)],
+             createdByAccountOwner: createdByAccountOwner)
     }
 
-    static var undisclosed: Self {
+    static func undisclosed(createdByAccountOwner: Bool = false) -> Self {
         mock(question: "What country do you like most?",
              pollKind: .undisclosed,
              options: [.mock(text: "Italy 🇮🇹", votes: 5, allVotes: 10, isWinning: true),
                        .mock(text: "China 🇨🇳", votes: 3, allVotes: 10, isSelected: true),
-                       .mock(text: "USA 🇺🇸", votes: 2, allVotes: 10)])
+                       .mock(text: "USA 🇺🇸", votes: 2, allVotes: 10)],
+             createdByAccountOwner: createdByAccountOwner)
     }
 
     static var endedDisclosed: Self {
@@ -77,12 +81,12 @@ extension Poll.Option {
 }
 
 extension PollRoomTimelineItem {
-    static func mock(poll: Poll) -> Self {
-        .init(id: .random,
+    static func mock(poll: Poll, isOutgoing: Bool = true) -> Self {
+        .init(id: .init(timelineID: UUID().uuidString, eventID: UUID().uuidString),
               poll: poll,
               body: "poll",
               timestamp: "Now",
-              isOutgoing: true,
+              isOutgoing: isOutgoing,
               isEditable: false,
               sender: .init(id: "userID"),
               properties: .init())

ElementX/Sources/Screens/RoomScreen/RoomScreenModels.swift

@@ -60,7 +60,8 @@ enum RoomScreenViewAction {
     case sendReadReceiptIfNeeded(TimelineItemIdentifier)
     case paginateBackwards
     case selectedPollOption(pollStartID: String, optionID: String)
-    
+    case endPoll(pollStartID: String)
+
     case timelineItemMenu(itemID: TimelineItemIdentifier)
     case timelineItemMenuAction(itemID: TimelineItemIdentifier, action: TimelineItemMenuAction)
     

ElementX/Sources/Screens/RoomScreen/RoomScreenViewModel.swift

@@ -154,6 +154,8 @@ class RoomScreenViewModel: RoomScreenViewModelType, RoomScreenViewModelProtocol
             state.longPressDisabledItemID = nil
         case .disableLongPress(let itemID):
             state.longPressDisabledItemID = itemID
+        case let .endPoll(pollStartID):
+            endPoll(pollStartID: pollStartID)
         }
     }
 

ElementX/Sources/Screens/RoomScreen/View/Timeline/PollRoomTimelineView.swift

@@ -29,22 +29,9 @@ struct PollRoomTimelineView: View {
         TimelineStyler(timelineItem: timelineItem) {
             VStack(alignment: .leading, spacing: 16) {
                 questionView
-
-                ForEach(poll.options, id: \.id) { option in
-                    Button {
-                        guard let eventID, !option.isSelected else { return }
-                        context.send(viewAction: .selectedPollOption(pollStartID: eventID, optionID: option.id))
-                        feedbackGenerator.impactOccurred()
-                    } label: {
-                        PollOptionView(pollOption: option,
-                                       showVotes: showVotes,
-                                       isFinalResult: poll.hasEnded)
-                            .foregroundColor(progressBarColor(for: option))
-                    }
-                    .disabled(poll.hasEnded || eventID == nil)
-                }
-
+                optionsView
                 summaryView
+                toolbarView
             }
             .frame(maxWidth: 450)
         }
@@ -74,6 +61,22 @@ struct PollRoomTimelineView: View {
         }
     }
 
+    private var optionsView: some View {
+        ForEach(poll.options, id: \.id) { option in
+            Button {
+                guard let eventID, !option.isSelected else { return }
+                context.send(viewAction: .selectedPollOption(pollStartID: eventID, optionID: option.id))
+                feedbackGenerator.impactOccurred()
+            } label: {
+                PollOptionView(pollOption: option,
+                               showVotes: showVotes,
+                               isFinalResult: poll.hasEnded)
+                    .foregroundColor(progressBarColor(for: option))
+            }
+            .disabled(poll.hasEnded || eventID == nil)
+        }
+    }
+
     @ViewBuilder
     private var summaryView: some View {
         if let summaryText = poll.summaryText {
@@ -85,6 +88,28 @@ struct PollRoomTimelineView: View {
         }
     }
 
+    @ViewBuilder
+    private var toolbarView: some View {
+        if !poll.hasEnded, poll.createdByAccountOwner, let eventID {
+            Button {
+                context.send(viewAction: .endPoll(pollStartID: eventID))
+            } label: {
+                Text(L10n.actionEndPoll)
+                    .lineLimit(2, reservesSpace: false)
+                    .font(.compound.bodyLGSemibold)
+                    .foregroundColor(.compound.textOnSolidPrimary)
+                    .padding(.horizontal, 24)
+                    .padding(.vertical, 10)
+                    .frame(maxWidth: .infinity)
+                    .background {
+                        Capsule()
+                            .foregroundColor(.compound.bgActionPrimaryRest)
+                    }
+            }
+            .padding(.top, 8)
+        }
+    }
+
     private func progressBarColor(for option: Poll.Option) -> Color {
         if poll.hasEnded {
             return option.isWinning ? .compound.textActionAccent : .compound.textDisabled
@@ -121,12 +146,12 @@ struct PollRoomTimelineView_Previews: PreviewProvider, TestablePreview {
     static let viewModel = RoomScreenViewModel.mock
 
     static var previews: some View {
-        PollRoomTimelineView(timelineItem: .mock(poll: .disclosed))
+        PollRoomTimelineView(timelineItem: .mock(poll: .disclosed(), isOutgoing: false))
             .environment(\.timelineStyle, .bubbles)
             .environmentObject(viewModel.context)
             .previewDisplayName("Disclosed, Bubble")
 
-        PollRoomTimelineView(timelineItem: .mock(poll: .undisclosed))
+        PollRoomTimelineView(timelineItem: .mock(poll: .undisclosed(), isOutgoing: false))
             .environment(\.timelineStyle, .bubbles)
             .environmentObject(viewModel.context)
             .previewDisplayName("Undisclosed, Bubble")
@@ -141,12 +166,17 @@ struct PollRoomTimelineView_Previews: PreviewProvider, TestablePreview {
             .environmentObject(viewModel.context)
             .previewDisplayName("Ended, Undisclosed, Bubble")
 
-        PollRoomTimelineView(timelineItem: .mock(poll: .disclosed))
+        PollRoomTimelineView(timelineItem: .mock(poll: .disclosed(createdByAccountOwner: true)))
+            .environment(\.timelineStyle, .bubbles)
+            .environmentObject(viewModel.context)
+            .previewDisplayName("Creator, disclosed, Bubble")
+
+        PollRoomTimelineView(timelineItem: .mock(poll: .disclosed(), isOutgoing: false))
             .environment(\.timelineStyle, .plain)
             .environmentObject(viewModel.context)
             .previewDisplayName("Disclosed, Plain")
 
-        PollRoomTimelineView(timelineItem: .mock(poll: .undisclosed))
+        PollRoomTimelineView(timelineItem: .mock(poll: .undisclosed(), isOutgoing: false))
             .environment(\.timelineStyle, .plain)
             .environmentObject(viewModel.context)
             .previewDisplayName("Undisclosed, Plain")
@@ -160,5 +190,10 @@ struct PollRoomTimelineView_Previews: PreviewProvider, TestablePreview {
             .environment(\.timelineStyle, .plain)
             .environmentObject(viewModel.context)
             .previewDisplayName("Ended, Undisclosed, Plain")
+
+        PollRoomTimelineView(timelineItem: .mock(poll: .disclosed(createdByAccountOwner: true)))
+            .environment(\.timelineStyle, .plain)
+            .environmentObject(viewModel.context)
+            .previewDisplayName("Creator, disclosed, Plain")
     }
 }

ElementX/Sources/Services/Timeline/Fixtures/RoomTimelineItemFixtures.swift

@@ -221,14 +221,18 @@ enum RoomTimelineItemFixtures {
     }
 
     static var disclosedPolls: [RoomTimelineItemProtocol] {
-        [PollRoomTimelineItem.mock(poll: .disclosed),
+        [PollRoomTimelineItem.mock(poll: .disclosed(), isOutgoing: false),
          PollRoomTimelineItem.mock(poll: .endedDisclosed)]
     }
 
     static var undisclosedPolls: [RoomTimelineItemProtocol] {
-        [PollRoomTimelineItem.mock(poll: .undisclosed),
+        [PollRoomTimelineItem.mock(poll: .undisclosed(), isOutgoing: false),
          PollRoomTimelineItem.mock(poll: .endedUndisclosed)]
     }
+
+    static var outgoingPolls: [RoomTimelineItemProtocol] {
+        [PollRoomTimelineItem.mock(poll: .disclosed(createdByAccountOwner: true), isOutgoing: true)]
+    }
 }
 
 private extension TextRoomTimelineItem {

ElementX/Sources/Services/Timeline/TimelineItems/Items/Other/PollRoomTimelineItem.swift

@@ -34,6 +34,8 @@ struct Poll: Equatable {
     let options: [Option]
     let votes: [String: [String]]
     let endDate: Date?
+    /// Whether the poll has been created by the account owner
+    let createdByAccountOwner: Bool
 
     var hasEnded: Bool {
         endDate != nil

ElementX/Sources/Services/Timeline/TimelineItems/RoomTimelineItemFactory.swift

@@ -389,7 +389,8 @@ struct RoomTimelineItemFactory: RoomTimelineItemFactoryProtocol {
                         maxSelections: Int(maxSelections),
                         options: options,
                         votes: votes,
-                        endDate: endTime.map { Date(timeIntervalSince1970: TimeInterval($0 / 1000)) })
+                        endDate: endTime.map { Date(timeIntervalSince1970: TimeInterval($0 / 1000)) },
+                        createdByAccountOwner: eventItemProxy.sender.id == userID)
 
         return PollRoomTimelineItem(id: eventItemProxy.id,
                                     poll: poll,

ElementX/Sources/UITests/UITestsAppCoordinator.swift

@@ -354,11 +354,39 @@ class MockScreen: Identifiable {
             
             navigationStackCoordinator.setRootCoordinator(coordinator)
             return navigationStackCoordinator
-        case .roomWithDisclosedPolls, .roomWithUndisclosedPolls:
+        case .roomWithDisclosedPolls:
             let navigationStackCoordinator = NavigationStackCoordinator()
 
             let timelineController = MockRoomTimelineController()
-            timelineController.timelineItems = id == .roomWithDisclosedPolls ? RoomTimelineItemFixtures.disclosedPolls : RoomTimelineItemFixtures.undisclosedPolls
+            timelineController.timelineItems = RoomTimelineItemFixtures.disclosedPolls
+            timelineController.incomingItems = []
+            let parameters = RoomScreenCoordinatorParameters(roomProxy: RoomProxyMock(with: .init(displayName: "Polls timeline", avatarURL: URL.picturesDirectory)),
+                                                             timelineController: timelineController,
+                                                             mediaProvider: MockMediaProvider(),
+                                                             emojiProvider: EmojiProvider())
+            let coordinator = RoomScreenCoordinator(parameters: parameters)
+
+            navigationStackCoordinator.setRootCoordinator(coordinator)
+            return navigationStackCoordinator
+        case .roomWithUndisclosedPolls:
+            let navigationStackCoordinator = NavigationStackCoordinator()
+
+            let timelineController = MockRoomTimelineController()
+            timelineController.timelineItems = RoomTimelineItemFixtures.undisclosedPolls
+            timelineController.incomingItems = []
+            let parameters = RoomScreenCoordinatorParameters(roomProxy: RoomProxyMock(with: .init(displayName: "Polls timeline", avatarURL: URL.picturesDirectory)),
+                                                             timelineController: timelineController,
+                                                             mediaProvider: MockMediaProvider(),
+                                                             emojiProvider: EmojiProvider())
+            let coordinator = RoomScreenCoordinator(parameters: parameters)
+
+            navigationStackCoordinator.setRootCoordinator(coordinator)
+            return navigationStackCoordinator
+        case .roomWithOutgoingPolls:
+            let navigationStackCoordinator = NavigationStackCoordinator()
+
+            let timelineController = MockRoomTimelineController()
+            timelineController.timelineItems = RoomTimelineItemFixtures.outgoingPolls
             timelineController.incomingItems = []
             let parameters = RoomScreenCoordinatorParameters(roomProxy: RoomProxyMock(with: .init(displayName: "Polls timeline", avatarURL: URL.picturesDirectory)),
                                                              timelineController: timelineController,

ElementX/Sources/UITests/UITestsScreenIdentifier.swift

@@ -48,6 +48,7 @@ enum UITestsScreenIdentifier: String {
     case roomLayoutBottom
     case roomWithDisclosedPolls
     case roomWithUndisclosedPolls
+    case roomWithOutgoingPolls
     case sessionVerification
     case userSessionScreen
     case userSessionScreenReply

UITests/Sources/RoomScreenUITests.swift

@@ -173,6 +173,12 @@ class RoomScreenUITests: XCTestCase {
         try await app.assertScreenshot(.roomWithUndisclosedPolls)
     }
 
+    func testTimelineOutgoingPolls() async throws {
+        let app = Application.launch(.roomWithOutgoingPolls)
+
+        try await app.assertScreenshot(.roomWithOutgoingPolls)
+    }
+
     // MARK: - Helper Methods
     
     private func performOperation(_ operation: UITestsSignal, using client: UITestsSignalling.Client) async throws {