Implement polls feature (#495)

Co-authored-by: Toomas Vahter <[email protected]>
Co-authored-by: Toomas Vahter <[email protected]>
Co-authored-by: Alexey Alter-Pesotskiy <[email protected]>

Author: 3 people

CHANGELOG.md

@@ -4,6 +4,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 # Upcoming
 
 ### ✅ Added
+- Add support for creating and rendering polls [#495](https://github.com/GetStream/stream-chat-swiftui/pull/495)
 - Use max file size for validating attachments defined in Stream's Dashboard [#490](https://github.com/GetStream/stream-chat-swiftui/pull/490)
 
 # [4.56.0](https://github.com/GetStream/stream-chat-swiftui/releases/tag/4.56.0)

Sources/StreamChatSwiftUI/ChatChannel/ChatChannelDataSource.swift

@@ -161,7 +161,11 @@ class MessageThreadDataSource: ChannelDataSource, ChatMessageControllerDelegate
     weak var delegate: MessagesDataSource?
 
     var messages: LazyCachedMapCollection<ChatMessage> {
-        messageController.replies
+        var replies = messageController.replies
+        if let message = messageController.message, replies.last != message {
+            replies.append(message)
+        }
+        return replies
     }
 
     var hasLoadedAllNextMessages: Bool {
@@ -195,7 +199,7 @@ class MessageThreadDataSource: ChannelDataSource, ChatMessageControllerDelegate
     ) {
         delegate?.dataSource(
             channelDataSource: self,
-            didUpdateMessages: controller.replies,
+            didUpdateMessages: messages,
             changes: changes
         )
     }
@@ -206,7 +210,7 @@ class MessageThreadDataSource: ChannelDataSource, ChatMessageControllerDelegate
     ) {
         delegate?.dataSource(
             channelDataSource: self,
-            didUpdateMessages: controller.replies,
+            didUpdateMessages: messages,
             changes: []
         )
     }

Sources/StreamChatSwiftUI/ChatChannel/ChatChannelViewModel.swift

@@ -177,6 +177,20 @@ open class ChatChannelViewModel: ObservableObject, MessagesDataSource {
             object: nil
         )
 
+        NotificationCenter.default.addObserver(
+            self,
+            selector: #selector(onViewAppear),
+            name: .messageSheetHiddenNotification,
+            object: nil
+        )
+        
+        NotificationCenter.default.addObserver(
+            self,
+            selector: #selector(onViewDissappear),
+            name: .messageSheetShownNotification,
+            object: nil
+        )
+        
         if messageController == nil {
             NotificationCenter.default.addObserver(
                 self,
@@ -378,19 +392,13 @@ open class ChatChannelViewModel: ObservableObject, MessagesDataSource {
             return
         }
 
-        if let message = messageController?.message {
-            var array = Array(messages)
-            array.append(message)
-            self.messages = LazyCachedMapCollection(source: array, map: { $0 })
-        } else {
-            let animationState = shouldAnimate(changes: changes)
-            if animationState == .animated {
-                withAnimation {
-                    self.messages = messages
-                }
-            } else if animationState == .notAnimated {
+        let animationState = shouldAnimate(changes: changes)
+        if animationState == .animated {
+            withAnimation {
                 self.messages = messages
             }
+        } else if animationState == .notAnimated {
+            self.messages = messages
         }
 
         refreshMessageListIfNeeded()
@@ -426,14 +434,14 @@ open class ChatChannelViewModel: ObservableObject, MessagesDataSource {
         )
     }
 
-    public func onViewAppear() {
+    @objc public func onViewAppear() {
         setActive()
         messages = channelDataSource.messages
         firstUnreadMessageId = channelDataSource.firstUnreadMessageId
         checkNameChange()
     }
 
-    public func onViewDissappear() {
+    @objc public func onViewDissappear() {
         isActive = false
     }
 
@@ -801,3 +809,12 @@ enum AnimationChange {
 
 let firstMessageKey = "firstMessage"
 let lastMessageKey = "lastMessage"
+
+extension Notification.Name {
+    /// A notification for notifying when message dismissed a sheet.
+    static let messageSheetHiddenNotification = Notification.Name("messageSheetHiddenNotification")
+    /// A notification for notifying when message view displays a sheet.
+    ///
+    /// When a sheet is presented, the message cell is not reloaded.
+    static let messageSheetShownNotification = Notification.Name("messageSheetShownNotification")
+}

Sources/StreamChatSwiftUI/ChatChannel/Composer/AttachmentPickerView.swift

@@ -8,7 +8,8 @@ import SwiftUI
 
 /// View for the attachment picker.
 public struct AttachmentPickerView<Factory: ViewFactory>: View {
-
+    @EnvironmentObject var viewModel: MessageComposerViewModel
+    
     @Injected(\.colors) private var colors
     @Injected(\.fonts) private var fonts
 
@@ -69,6 +70,7 @@ public struct AttachmentPickerView<Factory: ViewFactory>: View {
                 selected: selectedPickerState,
                 onPickerStateChange: onPickerStateChange
             )
+            .environmentObject(viewModel)
 
             if selectedPickerState == .photos {
                 if let assets = photoLibraryAssets {
@@ -98,6 +100,11 @@ public struct AttachmentPickerView<Factory: ViewFactory>: View {
                     cameraPickerShown: $cameraPickerShown,
                     cameraImageAdded: cameraImageAdded
                 )
+            } else if selectedPickerState == .polls {
+                viewFactory.makeComposerPollView(
+                    channelController: viewModel.channelController,
+                    messageController: viewModel.messageController
+                )
             } else if selectedPickerState == .custom {
                 viewFactory.makeCustomAttachmentView(
                     addedCustomAttachments: addedCustomAttachments,
@@ -119,7 +126,8 @@ public struct AttachmentPickerView<Factory: ViewFactory>: View {
 
 /// View for picking the source of the attachment (photo, files or camera).
 public struct AttachmentSourcePickerView: View {
-
+    @EnvironmentObject var viewModel: MessageComposerViewModel
+    
     @Injected(\.colors) private var colors
     @Injected(\.images) private var images
 
@@ -160,6 +168,16 @@ public struct AttachmentSourcePickerView: View {
                 onTap: onTap
             )
             .accessibilityIdentifier("attachmentPickerCamera")
+            
+            if viewModel.channelController.channel?.config.pollsEnabled == true && viewModel.messageController == nil {
+                AttachmentPickerButton(
+                    icon: images.attachmentPickerPolls,
+                    pickerType: .polls,
+                    isSelected: selected == .polls,
+                    onTap: onTap
+                )
+                .accessibilityIdentifier("attachmentPickerPolls")
+            }
 
             Spacer()
         }

Sources/StreamChatSwiftUI/ChatChannel/Composer/ComposerModels.swift

@@ -10,6 +10,7 @@ public enum AttachmentPickerState {
     case files
     case photos
     case camera
+    case polls
     case custom
 }
 

Sources/StreamChatSwiftUI/ChatChannel/Composer/MessageComposerView.swift

@@ -157,6 +157,7 @@ public struct MessageComposerView<Factory: ViewFactory>: View, KeyboardReadable
                 height: viewModel.overlayShown ? popupSize : 0,
                 popupHeight: popupSize
             )
+            .environmentObject(viewModel)
         }
         .background(
             GeometryReader { proxy in

Sources/StreamChatSwiftUI/ChatChannel/MessageList/MessageView.swift

@@ -41,6 +41,8 @@ public struct MessageView<Factory: ViewFactory>: View {
                     availableWidth: contentWidth,
                     scrolledId: $scrolledId
                 )
+            } else if let poll = message.poll {
+                factory.makePollView(message: message, poll: poll, isFirst: isFirst)
             } else if !message.attachmentCounts.isEmpty {
                 if messageTypeResolver.hasLinkAttachment(message: message) {
                     factory.makeLinkAttachmentView(

Sources/StreamChatSwiftUI/ChatChannel/MessageList/Polls/PollAllOptionsView.swift

@@ -0,0 +1,62 @@
+//
+// Copyright © 2024 Stream.io Inc. All rights reserved.
+//
+
+import StreamChat
+import SwiftUI
+
+struct PollAllOptionsView: View {
+    
+    @Injected(\.colors) var colors
+    @Injected(\.fonts) var fonts
+    
+    @Environment(\.presentationMode) var presentationMode
+    
+    @ObservedObject var viewModel: PollAttachmentViewModel
+    
+    var body: some View {
+        NavigationView {
+            ScrollView {
+                VStack(alignment: .leading, spacing: 32) {
+                    HStack {
+                        Text(viewModel.poll.name)
+                            .bold()
+                        Spacer()
+                    }
+                    .withPollsBackground()
+                    
+                    LazyVStack(spacing: 32) {
+                        ForEach(viewModel.poll.options) { option in
+                            PollOptionView(
+                                viewModel: viewModel,
+                                option: option,
+                                optionFont: fonts.headline,
+                                alternativeStyle: true
+                            )
+                        }
+                    }
+                    .withPollsBackground()
+                }
+                .padding()
+            }
+            .alert(isPresented: $viewModel.errorShown) {
+                Alert.defaultErrorAlert
+            }
+            .toolbar {
+                ToolbarItem(placement: .principal) {
+                    Text(L10n.Message.Polls.Toolbar.optionsTitle)
+                        .bold()
+                }
+                
+                ToolbarItem(placement: .topBarLeading) {
+                    Button {
+                        presentationMode.wrappedValue.dismiss()
+                    } label: {
+                        Image(systemName: "xmark")
+                    }
+                }
+            }
+            .navigationBarTitleDisplayMode(.inline)
+        }
+    }
+}