[Polls] Add PollAttachmentView + ViewContainerBuilder

.styles/config/vocabularies/Base/accept.txt

@@ -46,4 +46,6 @@ swappable
 telehealth
 subclassing
 [Ss]ubview
-scrollable
+scrollable
+HContainer
+VContainer

CHANGELOG.md

@@ -4,8 +4,32 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 # Upcoming
 
 ## StreamChat
+### ✅ Added
+- Add helper functions to `Poll` that extracts common domain logic [#3374](https://github.com/GetStream/stream-chat-swift/pull/3374)
 ### 🐞 Fixed
 - Fix Logger printing the incorrect thread name [#3382](https://github.com/GetStream/stream-chat-swift/pull/3382)
+- Fix `PollOption.latestVotes` sorting [#3374](https://github.com/GetStream/stream-chat-swift/pull/3374)
+- Fix `Poll.latestAnswers` sorting [#3374](https://github.com/GetStream/stream-chat-swift/pull/3374)
+- Fix `Poll` updates not triggering message updates in `ChannelController` [#3374](https://github.com/GetStream/stream-chat-swift/pull/3374)
+
+## StreamChatUI
+### ✅ Added
+- ✨ Introducing `ViewContainerBuilder`, a new, easier way to customize views [#3374](https://github.com/GetStream/stream-chat-swift/pull/3374) (Learn more by reading the docs [here](https://getstream.io/chat/docs/sdk/ios/uikit/custom-components/))
+- Add `PollAttachmentView` component to render polls in the message list [#3374](https://github.com/GetStream/stream-chat-swift/pull/3374)
+- Add `ChatUserAvatarView.shouldShowOnlineIndicator` to disable the online indicator easily [#3374](https://github.com/GetStream/stream-chat-swift/pull/3374)
+### 🎭 New Localizations
+- `message.polls.subtitle.selectOne`
+- `message.polls.subtitle.selectOneOrMore`
+- `message.polls.subtitle.selectUpTo`
+- `message.polls.subtitle.voteEnded`
+- `message.polls.button.endVote`
+- `message.polls.button.viewResults`
+- `message.preview.poll-someone-voted`
+- `message.preview.poll-you-voted`
+- `message.preview.poll-someone-created`
+- `message.preview.poll-you-created`
+- `alert.poll.end-title`
+- `alert.poll.end`
 
 # [4.62.0](https://github.com/GetStream/stream-chat-swift/releases/tag/4.62.0)
 _August 15, 2024_

Sources/StreamChat/APIClient/Endpoints/Payloads/PollsPayloads.swift

@@ -174,7 +174,7 @@ struct PollPayload: Decodable {
     var voteCount: Int
     var latestAnswers: [PollVotePayload?]?
     var options: [PollOptionPayload?]
-    var ownVotes: [PollVotePayload?]
+    var ownVotes: [PollVotePayload?]?
     var custom: [String: RawJSON]?
     var latestVotesByOption: [String: [PollVotePayload]]?
     var voteCountsByOption: [String: Int]?
@@ -183,6 +183,8 @@ struct PollPayload: Decodable {
     var votingVisibility: String?
     var createdBy: UserPayload?
 
+    var fromEvent: Bool = false
+
     init(
         allowAnswers: Bool,
         allowUserSuggestedOptions: Bool,

Sources/StreamChat/Database/DTOs/PollDTO.swift

@@ -24,6 +24,7 @@ class PollDTO: NSManagedObject {
     @NSManaged var votingVisibility: String?
     @NSManaged var createdBy: UserDTO?
     @NSManaged var latestAnswers: Set<PollVoteDTO>
+    @NSManaged var ownVotes: Set<PollVoteDTO>
     @NSManaged var message: MessageDTO?
     @NSManaged var options: NSOrderedSet
     @NSManaged var latestVotesByOption: Set<PollOptionDTO>
@@ -88,9 +89,12 @@ extension PollDTO {
             maxVotesAllowed: maxVotesAllowed?.intValue,
             votingVisibility: votingVisibility(from: votingVisibility),
             createdBy: createdBy?.asModel(),
-            latestAnswers: latestAnswers.map { try $0.asModel() },
+            latestAnswers: latestAnswers
+                .map { try $0.asModel() }
+                .sorted(by: { $0.createdAt < $1.createdAt }),
             options: optionsArray.map { try $0.asModel() },
-            latestVotesByOption: latestVotesByOption.map { try $0.asModel() }
+            latestVotesByOption: latestVotesByOption.map { try $0.asModel() },
+            ownVotes: ownVotes.map { try $0.asModel() }
         )
     }
 
@@ -174,7 +178,24 @@ extension NSManagedObjectContext {
                 }
             } ?? []
         )
-
+
+        if let payloadOwnVotes = payload.ownVotes, !payload.fromEvent {
+            pollDto.ownVotes = try Set(
+                payloadOwnVotes.compactMap { payload in
+                    if let payload {
+                        let voteDto = try savePollVote(payload: payload, query: nil, cache: cache)
+                        voteDto.poll = pollDto
+                        return voteDto
+                    } else {
+                        return nil
+                    }
+                }
+            )
+        }
+
+        // Trigger FRC message update
+        pollDto.message?.poll = pollDto
+
         return pollDto
     }
 

Sources/StreamChat/Database/DTOs/PollOptionDTO.swift

@@ -56,7 +56,9 @@ extension PollOptionDTO {
         return PollOption(
             id: id,
             text: text,
-            latestVotes: try latestVotes.map { try $0.asModel() },
+            latestVotes: try latestVotes
+                .map { try $0.asModel() }
+                .sorted(by: { $0.createdAt < $1.createdAt }),
             extraData: extraData
         )
     }

Sources/StreamChat/Database/DTOs/PollVoteDTO.swift

@@ -131,7 +131,14 @@ extension NSManagedObjectContext {
             let queryDTO = try saveQuery(query: query)
             queryDTO?.votes.insert(dto)
         }
-
+
+        if currentUser?.user.id == dto.user?.id {
+            poll.ownVotes.insert(dto)
+        }
+
+        // Trigger FRC message update
+        poll.message?.poll = poll
+
         return dto
     }
 
@@ -187,7 +194,14 @@ extension NSManagedObjectContext {
         }
 
         option?.latestVotes.insert(dto)
-
+
+        if currentUser?.user.id == dto.user?.id {
+            poll.ownVotes.insert(dto)
+        }
+
+        // Trigger FRC message update
+        poll.message?.poll = poll
+
         return dto
     }
 
@@ -213,8 +227,14 @@ extension NSManagedObjectContext {
                 poll?.voteCountsByOption?[optionId] = votes
             }
             dto.option?.latestVotes.remove(dto)
+            if currentUser?.user.id == dto.user?.id {
+                dto.poll?.ownVotes.remove(dto)
+            }
         }
 
+        // Trigger FRC message update
+        poll?.message?.poll = poll
+
         delete(pollVote: dto)
         return dto
     }

Sources/StreamChat/Database/DatabaseSession.swift

@@ -695,7 +695,8 @@ extension DatabaseSession {
             }
         }
 
-        if let poll = payload.poll {
+        if var poll = payload.poll {
+            poll.fromEvent = true
             try savePoll(payload: poll, cache: nil)
         }
 

Sources/StreamChat/Database/StreamChatModel.xcdatamodeld/StreamChatModel.xcdatamodel/contents

@@ -332,6 +332,7 @@
         <relationship name="latestVotesByOption" optional="YES" toMany="YES" deletionRule="Nullify" destinationEntity="PollOptionDTO" inverseName="pollLatestVotes" inverseEntity="PollOptionDTO"/>
         <relationship name="message" optional="YES" maxCount="1" deletionRule="Nullify" destinationEntity="MessageDTO" inverseName="poll" inverseEntity="MessageDTO"/>
         <relationship name="options" optional="YES" toMany="YES" deletionRule="Nullify" ordered="YES" destinationEntity="PollOptionDTO" inverseName="poll" inverseEntity="PollOptionDTO"/>
+        <relationship name="ownVotes" optional="YES" toMany="YES" deletionRule="Nullify" destinationEntity="PollVoteDTO" inverseName="currentUserPoll" inverseEntity="PollVoteDTO"/>
     </entity>
     <entity name="PollOptionDTO" representedClassName="PollOptionDTO" syncable="YES">
         <attribute name="custom" optional="YES" attributeType="Binary"/>
@@ -349,6 +350,7 @@
         <attribute name="optionId" optional="YES" attributeType="String"/>
         <attribute name="pollId" attributeType="String"/>
         <attribute name="updatedAt" attributeType="Date" usesScalarValueType="NO"/>
+        <relationship name="currentUserPoll" optional="YES" maxCount="1" deletionRule="Nullify" destinationEntity="PollDTO" inverseName="ownVotes" inverseEntity="PollDTO"/>
         <relationship name="option" optional="YES" maxCount="1" deletionRule="Nullify" destinationEntity="PollOptionDTO" inverseName="latestVotes" inverseEntity="PollOptionDTO"/>
         <relationship name="poll" optional="YES" maxCount="1" deletionRule="Nullify" destinationEntity="PollDTO" inverseName="latestAnswers" inverseEntity="PollDTO"/>
         <relationship name="queries" optional="YES" toMany="YES" deletionRule="Nullify" destinationEntity="PollVoteListQueryDTO" inverseName="votes" inverseEntity="PollVoteListQueryDTO"/>

Sources/StreamChat/Models/ChatMessage.swift

@@ -363,6 +363,7 @@ extension ChatMessage: Hashable {
         guard lhs.localState == rhs.localState else { return false }
         guard lhs.updatedAt == rhs.updatedAt else { return false }
         guard lhs.allAttachments == rhs.allAttachments else { return false }
+        guard lhs.poll == rhs.poll else { return false }
         guard lhs.author == rhs.author else { return false }
         guard lhs.currentUserReactionsCount == rhs.currentUserReactionsCount else { return false }
         guard lhs.text == rhs.text else { return false }

Sources/StreamChat/Models/Poll.swift

@@ -68,4 +68,62 @@ public struct Poll: Equatable {
 
     /// A list of the latest votes received for each option in the poll.
     public let latestVotesByOption: [PollOption]
+
+    /// The list of the current user votes.
+    public let ownVotes: [PollVote]
+}
+
+/// Poll domain logic helpers.
+public extension Poll {
+    /// The value of the option with the most votes.
+    var currentMaximumVoteCount: Int {
+        voteCountsByOption?.values.max() ?? 0
+    }
+
+    /// Whether the poll is already closed and the provided option is the one, and **the only one** with the most votes.
+    func isOptionWinner(_ option: PollOption) -> Bool {
+        isClosed && isOptionWithMostVotes(option)
+    }
+
+    /// Whether the poll is already close and the provided option is one of that has the most votes.
+    func isOptionOneOfTheWinners(_ option: PollOption) -> Bool {
+        isClosed && isOptionWithMaximumVotes(option)
+    }
+
+    /// Whether the provided option is the one, and **the only one** with the most votes.
+    func isOptionWithMostVotes(_ option: PollOption) -> Bool {
+        let optionsWithMostVotes = voteCountsByOption?.filter { $0.value == currentMaximumVoteCount }
+        return optionsWithMostVotes?.count == 1 && optionsWithMostVotes?[option.id] != nil
+    }
+
+    /// Whether the provided option is one of that has the most votes.
+    func isOptionWithMaximumVotes(_ option: PollOption) -> Bool {
+        let optionsWithMostVotes = voteCountsByOption?.filter { $0.value == currentMaximumVoteCount }
+        return optionsWithMostVotes?[option.id] != nil
+    }
+
+    /// The vote count for the given option.
+    func voteCount(for option: PollOption) -> Int {
+        voteCountsByOption?[option.id] ?? 0
+    }
+
+    // The ratio of the votes for the given option in comparison with the number of total votes.
+    func voteRatio(for option: PollOption) -> Float {
+        if currentMaximumVoteCount == 0 {
+            return 0
+        }
+
+        let optionVoteCount = voteCount(for: option)
+        return Float(optionVoteCount) / Float(currentMaximumVoteCount)
+    }
+
+    /// Returns the vote of the current user for the given option in case the user has voted.
+    func currentUserVote(for option: PollOption) -> PollVote? {
+        ownVotes.first(where: { $0.optionId == option.id })
+    }
+
+    /// Returns a Boolean value indicating whether the current user has voted the given option.
+    func hasCurrentUserVoted(for option: PollOption) -> Bool {
+        ownVotes.map(\.optionId).contains(option.id)
+    }
 }

Sources/StreamChatUI/Appearance+Images.swift

@@ -79,6 +79,14 @@ public extension Appearance {
         public var messageDeliveryStatusRead: UIImage = loadImageSafely(with: "message_receipt_read")
         public var messageDeliveryStatusFailed: UIImage = loadImageSafely(with: "message_receipt_failed")
 
+        // MARK: - Polls
+
+        public var pollVoteCheckmarkActive: UIImage = .checkmark
+        public var pollVoteCheckmarkInactive: UIImage = UIImage(
+            systemName: "circle",
+            withConfiguration: UIImage.SymbolConfiguration(weight: .thin)
+        ) ?? loadSafely(systemName: "circle", assetsFallback: "checkmark_confirm")
+
         // MARK: - Threads
 
         public var threadIcon: UIImage = loadSafely(systemName: "text.bubble", assetsFallback: "text_bubble")

Sources/StreamChatUI/ChatChannelList/ChatChannelListItemView.swift

@@ -150,6 +150,10 @@ open class ChatChannelListItemView: _View, ThemeProvider, SwiftUIRepresentable {
         }
 
         if let previewMessage = content.channel.previewMessage {
+            if let pollPreviewText = pollAttachmentPreviewText(for: previewMessage) {
+                return pollPreviewText
+            }
+
             if isLastMessageVoiceRecording {
                 return previewMessageForAudioRecordingMessage(messageText: previewMessage.text)
             }
@@ -440,6 +444,7 @@ open class ChatChannelListItemView: _View, ThemeProvider, SwiftUIRepresentable {
         guard let attachment = previewMessage.allAttachments.first else {
             return nil
         }
+
         let text = messageText
         switch attachment.type {
         case .audio:
@@ -464,6 +469,31 @@ open class ChatChannelListItemView: _View, ThemeProvider, SwiftUIRepresentable {
         }
     }
 
+    /// The message preview text in case it is a Poll.
+    /// - Parameter previewMessage: The preview message of the channel.
+    /// - Returns: A string representing the message preview text.
+    open func pollAttachmentPreviewText(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 && latestVoter.id == previewMessage.author.id {
+                components.append(L10n.Message.Preview.pollYouVoted)
+            } else {
+                components.append(L10n.Message.Preview.pollSomeoneVoted(latestVoter.name ?? latestVoter.id))
+            }
+        } else if let creator = poll.createdBy {
+            if previewMessage.isSentByCurrentUser {
+                components.append(L10n.Message.Preview.pollYouCreated)
+            } else {
+                components.append(L10n.Message.Preview.pollSomeoneCreated(creator.name ?? creator.id))
+            }
+        }
+        if !poll.name.isEmpty {
+            components.append(poll.name)
+        }
+        return components.joined(separator: " ")
+    }
+
     // MARK: - Channel preview when user is typing
 
     /// The formatted string containing the typing member.

Sources/StreamChatUI/ChatMessageList/Attachments/AttachmentViewCatalog.swift

@@ -15,6 +15,10 @@ open class AttachmentViewCatalog {
         message: ChatMessage,
         components: Components
     ) -> AttachmentViewInjector.Type? {
+        if message.poll != nil {
+            return PollAttachmentViewInjector.self
+        }
+
         let attachmentCounts = message.attachmentCounts
 
         if attachmentCounts.keys.contains(.image) || attachmentCounts.keys.contains(.video) {

Sources/StreamChatUI/ChatMessageList/Attachments/ChatMessageAttachmentPreviewVC.swift

@@ -17,7 +17,7 @@ open class ChatMessageAttachmentPreviewVC: _ViewController, WKNavigationDelegate
         .withoutAutoresizingMaskConstraints
         .withAccessibilityIdentifier(identifier: "webView")
 
-    public private(set) lazy var activityIndicatorView = UIActivityIndicatorView(style: .gray)
+    public private(set) lazy var activityIndicatorView = UIActivityIndicatorView(style: .medium)
         .withAccessibilityIdentifier(identifier: "activityIndicatorView")
 
     private lazy var closeButton = UIBarButtonItem(