Merge pull request #612 from GetStream/add/polls-improvements

nuno-vieira · web-flow · commit 5e9de531ba0c · 2024-10-02T01:22:20.000+01:00
Polls UI fixes and UX Improvements
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,10 +3,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 # Upcoming
 
+### 🔄 Changed
+- Improves Poll voting UX by making it possible to tap on the whole option as well [#612](https://github.com/GetStream/stream-chat-swiftui/pull/612)
 ### 🐞 Fixed
 - Rare crash when accessing frame of the view [#607](https://github.com/GetStream/stream-chat-swiftui/pull/607)
 - `ChatChannelListView` navigation did not trigger when using a custom container and its body reloaded [#609](https://github.com/GetStream/stream-chat-swiftui/pull/609)
 - Channel was sometimes not marked as read when tapping the x on the unread message pill in the message list [#610](https://github.com/GetStream/stream-chat-swiftui/pull/610)
+- Fix the poll vote progress view not having full width when the Poll is closed [#612](https://github.com/GetStream/stream-chat-swiftui/pull/612)
+- Fix the last vote author not accurate in the channel preview [#612](https://github.com/GetStream/stream-chat-swiftui/pull/612)
 
 # [4.63.0](https://github.com/GetStream/stream-chat-swiftui/releases/tag/4.63.0)
 _September 12, 2024_
diff --git a/Sources/StreamChatSwiftUI/ChatChannel/MessageList/Polls/PollAllOptionsView.swift b/Sources/StreamChatSwiftUI/ChatChannel/MessageList/Polls/PollAllOptionsView.swift
@@ -31,7 +31,8 @@ struct PollAllOptionsView: View {
                                 viewModel: viewModel,
                                 option: option,
                                 optionFont: fonts.headline,
-                                alternativeStyle: true
+                                alternativeStyle: true,
+                                checkboxButtonSpacing: 8
                             )
                         }
                     }
diff --git a/Sources/StreamChatSwiftUI/ChatChannel/MessageList/Polls/PollAttachmentView.swift b/Sources/StreamChatSwiftUI/ChatChannel/MessageList/Polls/PollAttachmentView.swift
@@ -55,8 +55,8 @@ public struct PollAttachmentView<Factory: ViewFactory>: View {
                 PollOptionView(
                     viewModel: viewModel,
                     option: option,
-                    optionVotes: poll.voteCountsByOption?[option.id],
-                    maxVotes: poll.voteCountsByOption?.values.max()
+                    optionVotes: poll.voteCount(for: option),
+                    maxVotes: poll.currentMaximumVoteCount
                 )
                 .layoutPriority(1) // do not compress long text
             }
@@ -190,53 +190,63 @@ struct PollOptionView: View {
     var maxVotes: Int?
     /// If true, only option name and vote count is shown, otherwise votes indicator and avatars appear as well.
     var alternativeStyle: Bool = false
-    
+    /// The spacing between the checkbox and the option name.
+    /// By default it is 4. For All Options View is 8.
+    var checkboxButtonSpacing: CGFloat = 4
+
     var body: some View {
-        VStack(spacing: 4) {
-            HStack(alignment: .top) {
-                if !viewModel.poll.isClosed {
-                    Button {
-                        if viewModel.optionVotedByCurrentUser(option) {
-                            viewModel.removePollVote(for: option)
-                        } else {
-                            viewModel.castPollVote(for: option)
-                        }
-                    } label: {
-                        if viewModel.optionVotedByCurrentUser(option) {
-                            Image(systemName: "checkmark.circle.fill")
-                        } else {
-                            Image(systemName: "circle")
-                        }
+        HStack(alignment: .top, spacing: checkboxButtonSpacing) {
+            if !viewModel.poll.isClosed {
+                Button {
+                    togglePollVote()
+                } label: {
+                    if viewModel.optionVotedByCurrentUser(option) {
+                        Image(systemName: "checkmark.circle.fill")
+                    } else {
+                        Image(systemName: "circle")
                     }
                 }
-
-                Text(option.text)
-                    .font(optionFont)
-                Spacer()
-                if !alternativeStyle, viewModel.showVoterAvatars {
-                    HStack(spacing: -4) {
-                        ForEach(
-                            option.latestVotes.sorted(by: { $0.createdAt > $1.createdAt }).suffix(2)
-                        ) { vote in
-                            MessageAvatarView(
-                                avatarURL: vote.user?.imageURL,
-                                size: .init(width: 20, height: 20)
-                            )
+            }
+            VStack(spacing: 4) {
+                HStack(alignment: .top) {
+                    Text(option.text)
+                        .font(optionFont)
+                    Spacer()
+                    if !alternativeStyle, viewModel.showVoterAvatars {
+                        HStack(spacing: -4) {
+                            ForEach(
+                                option.latestVotes.prefix(2)
+                            ) { vote in
+                                MessageAvatarView(
+                                    avatarURL: vote.user?.imageURL,
+                                    size: .init(width: 20, height: 20)
+                                )
+                            }
                         }
                     }
+                    Text("\(viewModel.poll.voteCountsByOption?[option.id] ?? 0)")
+                }
+                if !alternativeStyle {
+                    PollVotesIndicatorView(
+                        alternativeStyle: viewModel.poll.isClosed && viewModel.hasMostVotes(for: option),
+                        optionVotes: optionVotes ?? 0,
+                        maxVotes: maxVotes ?? 0
+                    )
                 }
-                Text("\(viewModel.poll.voteCountsByOption?[option.id] ?? 0)")
-            }
-            
-            if !alternativeStyle {
-                PollVotesIndicatorView(
-                    alternativeStyle: viewModel.poll.isClosed && viewModel.hasMostVotes(for: option),
-                    optionVotes: optionVotes ?? 0,
-                    maxVotes: maxVotes ?? 0
-                )
-                .padding(.leading, 24)
             }
         }
+        .contentShape(Rectangle())
+        .onTapGesture {
+            togglePollVote()
+        }
+    }
+
+    func togglePollVote() {
+        if viewModel.optionVotedByCurrentUser(option) {
+            viewModel.removePollVote(for: option)
+        } else {
+            viewModel.castPollVote(for: option)
+        }
     }
 }
 
diff --git a/Sources/StreamChatSwiftUI/ChatChannel/MessageList/Polls/PollAttachmentViewModel.swift b/Sources/StreamChatSwiftUI/ChatChannel/MessageList/Polls/PollAttachmentViewModel.swift
@@ -198,7 +198,7 @@ public class PollAttachmentViewModel: ObservableObject, PollControllerDelegate {
     
     /// True, if the current user has voted for the specified option, otherwise false.
     public func optionVotedByCurrentUser(_ option: PollOption) -> Bool {
-        currentUserVote(for: option) != nil
+        poll.hasCurrentUserVoted(for: option)
     }
     
     /// Adds a new option to the poll.
@@ -219,13 +219,7 @@ public class PollAttachmentViewModel: ObservableObject, PollControllerDelegate {
     ///
     /// - Note: When multiple options have the highest vote count, this function returns false.
     public func hasMostVotes(for option: PollOption) -> Bool {
-        guard let allCounts = poll.voteCountsByOption else { return false }
-        guard let optionVoteCount = allCounts[option.id], optionVoteCount > 0 else { return false }
-        guard let highestVotePerOption = allCounts.values.max() else { return false }
-        guard optionVoteCount == highestVotePerOption else { return false }
-        // Check if only one option has highest number for votes
-        let optionsByVoteCounts = Dictionary(grouping: allCounts, by: { $0.value })
-        return optionsByVoteCounts[optionVoteCount]?.count == 1
+        poll.isOptionWithMostVotes(option)
     }
     
     // MARK: - PollControllerDelegate
@@ -244,7 +238,7 @@ public class PollAttachmentViewModel: ObservableObject, PollControllerDelegate {
     // MARK: - private
     
     private func currentUserVote(for option: PollOption) -> PollVote? {
-        currentUserVotes.first(where: { $0.optionId == option.id })
+        poll.currentUserVote(for: option)
     }
     
     private func notifySheetPresentation(shown: Bool) {
diff --git a/Sources/StreamChatSwiftUI/ChatChannel/MessageList/Polls/PollCommentsViewModel.swift b/Sources/StreamChatSwiftUI/ChatChannel/MessageList/Polls/PollCommentsViewModel.swift
@@ -25,10 +25,7 @@ class PollCommentsViewModel: ObservableObject, PollVoteListControllerDelegate {
     convenience init(poll: Poll, pollController: PollController) {
         let query = PollVoteListQuery(
             pollId: poll.id,
-            optionId: nil,
-            filter: .and(
-                [.equal(.pollId, to: poll.id), .equal(.isAnswer, to: true)]
-            )
+            filter: .equal(.isAnswer, to: true)
         )
         self.init(
             pollController: pollController,
diff --git a/Sources/StreamChatSwiftUI/ChatChannel/MessageList/Polls/PollOptionAllVotesViewModel.swift b/Sources/StreamChatSwiftUI/ChatChannel/MessageList/Polls/PollOptionAllVotesViewModel.swift
@@ -24,7 +24,7 @@ class PollOptionAllVotesViewModel: ObservableObject, PollVoteListControllerDeleg
         self.option = option
         let query = PollVoteListQuery(
             pollId: poll.id,
-            optionId: option.id, filter: .equal(.optionId, to: option.id)
+            optionId: option.id
         )
         controller = InjectedValues[\.chatClient].pollVoteListController(query: query)
         controller.delegate = self
diff --git a/Sources/StreamChatSwiftUI/ChatChannel/MessageList/Polls/PollResultsView.swift b/Sources/StreamChatSwiftUI/ChatChannel/MessageList/Polls/PollResultsView.swift
@@ -45,7 +45,7 @@ struct PollResultsView: View {
                         poll: viewModel.poll,
                         option: option,
                         votes: Array(
-                            option.latestVotes.sorted(by: { $0.createdAt > $1.createdAt })
+                            option.latestVotes
                                 .prefix(numberOfItemsShown)
                         ),
                         hasMostVotes: viewModel.hasMostVotes(for: option),
diff --git a/Sources/StreamChatSwiftUI/ChatChannelList/ChatChannelListItem.swift b/Sources/StreamChatSwiftUI/ChatChannelList/ChatChannelListItem.swift
@@ -360,8 +360,8 @@ extension ChatChannel {
     private func pollMessageText(for previewMessage: ChatMessage) -> String? {
         guard let poll = previewMessage.poll, !previewMessage.isDeleted else { return nil }
         var components = ["📊"]
-        if let latestVoter = poll.latestVotesByOption.first?.latestVotes.first?.user {
-            if previewMessage.isSentByCurrentUser {
+        if let latestVoter = poll.latestVotes.first?.user {
+            if latestVoter.id == membership?.id {
                 components.append(L10n.Channel.Item.pollYouVoted)
             } else {
                 components.append(L10n.Channel.Item.pollSomeoneVoted(latestVoter.name ?? latestVoter.id))
diff --git a/StreamChatSwiftUI.xcodeproj/project.pbxproj b/StreamChatSwiftUI.xcodeproj/project.pbxproj
@@ -3720,8 +3720,8 @@
 			isa = XCRemoteSwiftPackageReference;
 			repositoryURL = "https://github.com/GetStream/stream-chat-swift.git";
 			requirement = {
-				kind = upToNextMajorVersion;
-				minimumVersion = 4.63.0;
+				branch = develop;
+				kind = branch;
 			};
 		};
 		E3A1C01A282BAC66002D1E26 /* XCRemoteSwiftPackageReference "sentry-cocoa" */ = {
diff --git a/StreamChatSwiftUITests/Infrastructure/Mocks/Poll_Mock.swift b/StreamChatSwiftUITests/Infrastructure/Mocks/Poll_Mock.swift
@@ -51,7 +51,9 @@ extension Poll {
             createdBy: .mock(id: "test", name: "test"),
             latestAnswers: [],
             options: [option],
-            latestVotesByOption: [option]
+            latestVotesByOption: [option],
+            latestVotes: [],
+            ownVotes: []
         )
         return poll
     }
@@ -89,7 +91,9 @@ extension Poll {
             createdBy: .mock(id: "test", name: "test"),
             latestAnswers: [],
             options: options,
-            latestVotesByOption: options
+            latestVotesByOption: options,
+            latestVotes: [],
+            ownVotes: []
         )
     }
 }
diff --git a/StreamChatSwiftUITests/Tests/ChatChannel/PollAttachmentViewModel_Tests.swift b/StreamChatSwiftUITests/Tests/ChatChannel/PollAttachmentViewModel_Tests.swift
@@ -58,14 +58,13 @@ final class PollAttachmentViewModel_Tests: StreamChatTestCase {
     
     func test_pollAttachmentViewModel_removeVoteCalled() {
         // Given
+        let vote = makePollVote()
         let pollController = makePollController()
         let viewModel = PollAttachmentViewModel(
             message: .mock(),
-            poll: .unique,
+            poll: .mock(ownVotes: [vote]),
             pollController: pollController
         )
-        let vote = makePollVote()
-        viewModel.currentUserVotes = [vote]
         
         // When
         viewModel.removePollVote(for: .init(id: vote.optionId!, text: ""))
@@ -92,15 +91,14 @@ final class PollAttachmentViewModel_Tests: StreamChatTestCase {
     
     func test_pollAttachmentViewModel_optionVotedByCurrentUser() {
         // Given
+        let vote = makePollVote()
         let pollController = makePollController()
         let viewModel = PollAttachmentViewModel(
             message: .mock(),
-            poll: .unique,
+            poll: .mock(ownVotes: [vote]),
             pollController: pollController
         )
-        let vote = makePollVote()
         let option = PollOption(id: vote.optionId!, text: "")
-        viewModel.currentUserVotes = [vote]
         
         // When
         let optionVoted = viewModel.optionVotedByCurrentUser(option)
diff --git a/StreamChatSwiftUITests/Tests/ChatChannel/PollCommentsViewModel_Tests.swift b/StreamChatSwiftUITests/Tests/ChatChannel/PollCommentsViewModel_Tests.swift
@@ -82,10 +82,7 @@ final class PollCommentsViewModel_Tests: StreamChatTestCase {
     private func makeCommentsController() -> PollVoteListController_Mock {
         let query = PollVoteListQuery(
             pollId: .unique,
-            optionId: nil,
-            filter: .and(
-                [.equal(.pollId, to: .unique), .equal(.isAnswer, to: true)]
-            )
+            filter: .equal(.isAnswer, to: true)
         )
         return PollVoteListController_Mock(query: query, client: chatClient)
     }
diff --git a/StreamChatSwiftUITests/Tests/ChatChannel/__Snapshots__/PollAttachmentView_Tests/test_pollAttachmentView_closedPoll.1.png b/StreamChatSwiftUITests/Tests/ChatChannel/__Snapshots__/PollAttachmentView_Tests/test_pollAttachmentView_closedPoll.1.png
diff --git a/StreamChatSwiftUITests/Tests/ChatChannel/__Snapshots__/PollAttachmentView_Tests/test_pollAttachmentView_snapshotCommentsAndSuggestions.1.png b/StreamChatSwiftUITests/Tests/ChatChannel/__Snapshots__/PollAttachmentView_Tests/test_pollAttachmentView_snapshotCommentsAndSuggestions.1.png
diff --git a/StreamChatSwiftUITests/Tests/ChatChannel/__Snapshots__/PollAttachmentView_Tests/test_pollAttachmentView_snapshotUniqueVotes.1.png b/StreamChatSwiftUITests/Tests/ChatChannel/__Snapshots__/PollAttachmentView_Tests/test_pollAttachmentView_snapshotUniqueVotes.1.png
diff --git a/StreamChatSwiftUITests/Tests/ChatChannelList/ChatChannelListItemView_Tests.swift b/StreamChatSwiftUITests/Tests/ChatChannelList/ChatChannelListItemView_Tests.swift
@@ -153,6 +153,54 @@ final class ChatChannelListItemView_Tests: StreamChatTestCase {
         assertSnapshot(matching: view, as: .image(perceptualPrecision: precision))
     }
 
+    func test_channelListItem_pollMessage_youVoted() throws {
+        // Given
+        let currentUserId = UserId.unique
+        let message = try mockPollMessage(isSentByCurrentUser: false, latestVotes: [
+            .mock(pollId: .unique, optionId: .unique, user: .mock(id: currentUserId)),
+            .unique,
+            .unique
+        ])
+        let channel = ChatChannel.mock(cid: .unique, membership: .mock(id: currentUserId), latestMessages: [message])
+
+        // When
+        let view = ChatChannelListItem(
+            channel: channel,
+            channelName: "Test",
+            avatar: .circleImage,
+            onlineIndicatorShown: true,
+            onItemTap: { _ in }
+        )
+        .frame(width: defaultScreenSize.width)
+
+        // Then
+        assertSnapshot(matching: view, as: .image(perceptualPrecision: precision))
+    }
+
+    func test_channelListItem_pollMessage_someoneVoted() throws {
+        // Given
+        let currentUserId = UserId.unique
+        let message = try mockPollMessage(isSentByCurrentUser: false, latestVotes: [
+            .mock(pollId: .unique, optionId: .unique, user: .mock(id: .unique, name: "Steve Jobs")),
+            .unique,
+            .mock(pollId: .unique, optionId: .unique, user: .mock(id: currentUserId))
+        ])
+        let channel = ChatChannel.mock(cid: .unique, membership: .mock(id: currentUserId), latestMessages: [message])
+
+        // When
+        let view = ChatChannelListItem(
+            channel: channel,
+            channelName: "Test",
+            avatar: .circleImage,
+            onlineIndicatorShown: true,
+            onItemTap: { _ in }
+        )
+        .frame(width: defaultScreenSize.width)
+
+        // Then
+        assertSnapshot(matching: view, as: .image(perceptualPrecision: precision))
+    }
+
     // MARK: - private
     
     private func mockAudioMessage(text: String, isSentByCurrentUser: Bool) throws -> ChatMessage {
@@ -271,7 +319,7 @@ final class ChatChannelListItemView_Tests: StreamChatTestCase {
         )
     }
     
-    private func mockPollMessage(isSentByCurrentUser: Bool) throws -> ChatMessage {
+    private func mockPollMessage(isSentByCurrentUser: Bool, latestVotes: [PollVote] = []) throws -> ChatMessage {
         .mock(
             id: .unique,
             cid: .unique,
@@ -281,7 +329,11 @@ final class ChatChannelListItemView_Tests: StreamChatTestCase {
             createdAt: Date(timeIntervalSince1970: 100),
             localState: nil,
             isSentByCurrentUser: isSentByCurrentUser,
-            poll: .mock(optionCount: 1, voteCountForOption: { _ in 0 })
+            poll: .mock(
+                name: "Test poll",
+                createdBy: .mock(id: "test", name: "test"),
+                latestVotes: latestVotes
+            )
         )
     }
 }
diff --git a/StreamChatSwiftUITests/Tests/ChatChannelList/__Snapshots__/ChatChannelListItemView_Tests/test_channelListItem_pollMessage_someoneVoted.1.png b/StreamChatSwiftUITests/Tests/ChatChannelList/__Snapshots__/ChatChannelListItemView_Tests/test_channelListItem_pollMessage_someoneVoted.1.png
diff --git a/StreamChatSwiftUITests/Tests/ChatChannelList/__Snapshots__/ChatChannelListItemView_Tests/test_channelListItem_pollMessage_youVoted.1.png b/StreamChatSwiftUITests/Tests/ChatChannelList/__Snapshots__/ChatChannelListItemView_Tests/test_channelListItem_pollMessage_youVoted.1.png

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,8 @@ struct PollAllOptionsView: View {`
`31`	`31`	`viewModel: viewModel,`
`32`	`32`	`option: option,`
`33`	`33`	`optionFont: fonts.headline,`
`34`		`- alternativeStyle: true`
	`34`	`+ alternativeStyle: true,`
	`35`	`+ checkboxButtonSpacing: 8`
`35`	`36`	`)`
`36`	`37`	`}`
`37`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ class PollOptionAllVotesViewModel: ObservableObject, PollVoteListControllerDeleg`
`24`	`24`	`self.option = option`
`25`	`25`	`let query = PollVoteListQuery(`
`26`	`26`	`pollId: poll.id,`
`27`		`- optionId: option.id, filter: .equal(.optionId, to: option.id)`
	`27`	`+ optionId: option.id`
`28`	`28`	`)`
`29`	`29`	`controller = InjectedValues[\.chatClient].pollVoteListController(query: query)`
`30`	`30`	`controller.delegate = self`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,9 @@ extension Poll {`
`51`	`51`	`createdBy: .mock(id: "test", name: "test"),`
`52`	`52`	`latestAnswers: [],`
`53`	`53`	`options: [option],`
`54`		`- latestVotesByOption: [option]`
	`54`	`+ latestVotesByOption: [option],`
	`55`	`+ latestVotes: [],`
	`56`	`+ ownVotes: []`
`55`	`57`	`)`
`56`	`58`	`return poll`
`57`	`59`	`}`
`@@ -89,7 +91,9 @@ extension Poll {`
`89`	`91`	`createdBy: .mock(id: "test", name: "test"),`
`90`	`92`	`latestAnswers: [],`
`91`	`93`	`options: options,`
`92`		`- latestVotesByOption: options`
	`94`	`+ latestVotesByOption: options,`
	`95`	`+ latestVotes: [],`
	`96`	`+ ownVotes: []`
`93`	`97`	`)`
`94`	`98`	`}`
`95`	`99`	`}`