Adds Polls UI Components + Introducing View Container Builder

[nuno-vieira]

🔗 Issue Links

Resolves https://stream-io.atlassian.net/browse/PBE-4287

🎯 Goal

Adds Poll UIKit components and introduces the new View Container Builder.

📝 Summary

This is the final PR that groups the following PRs:

• Add PollAttachmentView + ViewContainerBuilder #3374
• Add PollResultsVC #3381
• Comments + Suggestions + Anonymous Polls + LLC Fixes #3398
• Add Poll Creation Flow #3433

Additionally:

• Adds PollAllOptionsListVC component
• It fixes a bug where the poll.latestAnswers and poll.ownVotes were impacting each other, causing the "Add a comment" button to disappear when adding a regular vote. (There was an attempt to fix this here but it did not fix 100%)
• Removes the layout {} and constraints {} from ViewContainerBuilder since adding constraints before the view hierarchy is not possible
• Adds padding() helper to ViewContainerBuilder

Features Missing:
- The only thing missing, which will be out of scope for now, is the limit of 10 options for each Poll in the message list, plus the additional view to see all the votes.

🛠 Implementation

Below is the summary of all the components added.

PollAttachmentView

graph LR
    PollAttachmentView --> headerView
    headerView --> titleLabel & subtitleLabel
    PollAttachmentView --> PollAttachmentOptionListView
    PollAttachmentOptionListView --> PollAttachmentOptionListItemView
    PollAttachmentView --> footerView
    footerView --> ViewResultsButton & EndPollButton

Loading

PollResultsVC

graph LR
    PollResultsVC --> PollResultsTableHeaderView
    PollResultsVC --> PollResultsSectionHeaderView
    PollResultsVC --> PollResultsVoteItemCell
    PollResultsVoteItemCell --> PollResultsVoteItemView
    PollResultsVC --> PollResultsSectionFooterView

Loading

PollResultsVoteListVC

graph LR
    PollResultsVoteListVC --> PollResultsSectionHeaderView
    PollResultsVoteListVC--> PollResultsVoteItemCell
    PollResultsVoteItemCell --> PollResultsVoteItemView

Loading

PollCommentListVC

graph LR
    PollCommentListVC --> PollCommentListSectionHeaderView
    PollCommentListVC  --> PollCommentListItemCell
    PollCommentListItemCell --> PollCommentListItemView --> PollResultsVoteItemView
    PollCommentListVC  --> PollCommentListTableFooterView

Loading

PollCreationVC

graph LR
    PollCreationVC --> PollCreationSectionHeaderView
    PollCreationVC  --> PollCreationNameCell --> PollCreationTextFieldView
    PollCreationVC  --> PollCreationOptionCell --> PollCreationTextFieldView
    PollCreationVC  --> PollCreationFeatureCell --> PollCreationFeatureSwitchView
    PollCreationVC  --> PollCreationMultipleVotesFeatureCell --> PollCreationFeatureSwitchView

Loading

PollAllOptionsListVC

graph LR
    PollAllOptionsListVC -->PollAllOptionsListItemCell

Loading

🎨 Showcase

Quick demo of the main features:

Simulator.Screen.Recording.-.iPhone.15.Pro.17.4.-.2024-09-26.at.23.21.54.mov

🧪 Manual Testing Notes

Poll Creation View

Things to test:

• When typing the poll's name or adding an option, pressing "next" should go to the next textfield
• Sorting the options
• When typing an option, it should create a new one next
• Backspacing an empty option, should delete it
• Duplicate Options is not allowed
• Enabling / Disabling features
• Error Validation: Creating a Poll with Errors should not be possible. The send button should be disabled in case there are errors.

Message Poll Attachment View

Things to test:

• The poll's subtitle should say "Select One", "Select One or More" or "Select up to X" depending on the multiple votes configuration
• Multiple votes should not be allowed in case only one vote per user is required
• Suggesting an option should add a new option to the list
• Adding a comment should update buttons to include "View Comments" and remove the "Add comment" button in case the poll is not anonymous
• Ending a vote should close the Poll, and if there is only one winner, the bar should be green

Poll Comments

Things to test:

• Updating a comment
• Loading multiple comments

Poll Results

Things to test:

• Loading multiple votes

Channel List Message Previews (When last message is a poll)

Things to test:

• When the current user created a poll
• When another user created a poll
• When the current user voted a poll
• When another user voted a poll

Quoting a Poll

Things to test:

• When quoting a poll, the quoted message should show a Poll icon and the poll's name

☑️ Contributor Checklist

• I have signed the Stream CLA (required)
• This change should be manually QAed
• Changelog is updated with client-facing changes
• Changelog is updated with new localization keys
• New code is covered by unit tests
• Comparison screenshots added for visual changes
• Affected documentation updated (docusaurus, tutorial, CMS)

[Stream-SDK-Bot]

SDK Size

title	develop	branch	diff	status
StreamChat	6.85 MB	6.9 MB	+51 KB	🟢
StreamChatUI	4.42 MB	4.89 MB	+490 KB	🟢

[Stream-SDK-Bot]

SDK Performance

target	metric	benchmark	branch	performance	status
MessageList	Hitches total duration	10 ms	6.68 ms	33.2% 🔼	🟢
	Duration	2.6 s	2.56 s	1.54% 🔼	🟢
	Hitch time ratio	4 ms per s	2.61 ms per s	34.75% 🔼	🟢
	Frame rate	75 fps	78.29 fps	4.39% 🔼	🟢
	Number of hitches	1	0.8	20.0% 🔼	🟢
ChannelList	Hitches total duration	12.5 ms	20.03 ms	-60.24% 🔽	🔴
	Duration	2.6 s	2.54 s	2.31% 🔼	🟢
	Hitch time ratio	5 ms per s	7.9 ms per s	-58.0% 🔽	🔴
	Frame rate	72 fps	74.23 fps	3.1% 🔼	🟢
	Number of hitches	1.2	1.6	-33.33% 🔽	🔴

[github-actions]

	1 Warning
⚠️	Big PR

Generated by 🚫 Danger

[Stream-SDK-Bot]

SDK Size

title	develop	branch	diff	status
StreamChat	6.85 MB	6.9 MB	+51 KB	🟢
StreamChatUI	4.42 MB	4.95 MB	+546 KB	🟢

[martinmitrevski]

Couple of questions:

• Did you test if everything works well in SwiftUI with this branch?
• Why not include the polls docs in this PR?

[martinmitrevski]

That weird yeetd-normal.pkg file appeared again, please remove it. Other than that, looks good to me.

[sonarqubecloud]

Quality Gate passed

Issues
161 New issues
0 Accepted issues

Measures
0 Security Hotspots
84.2% Coverage on New Code
0.1% Duplication on New Code

See analysis details on SonarCloud