Simplify logic to update poll votes #176

gpunto · 2026-01-09T09:06:46Z

Goal

The logic to update poll votes had some fairly complex logic, but that's unneeded because we know that the only things that we need to compute locally are "own" properties and we can take the other ones (e.g. counts) from the WS event, like we do in similar cases

Implementation

The implementation mirrors what we are already doing in cases like ActivityData.upsertBookmark. So we take the updated poll data and we only compute the own votes.

Testing

Cast/change votes in a poll and verify that it updates correctly.

Checklist

Issue linked (if any)
Tests/docs updated
I have signed the Stream CLA (required for external contributors)

Summary by CodeRabbit

Refactor
- Restructured internal poll voting system architecture to improve code organization and consistency
- Consolidated poll state management logic and unified vote operation handling for enhanced reliability
- Streamlined how poll data flows through vote operations to reduce complexity and potential inconsistencies

_{✏️ Tip: You can customize this high-level summary in your review settings.}

github-actions · 2026-01-09T09:06:57Z

PR checklist ✅

All required conditions are satisfied:

Title length is OK (or ignored by label).
At least one pr: label exists.
Sections ### Goal, ### Implementation, and ### Testing are filled.

🎉 Great job! This PR is ready for review.

sonarqubecloud · 2026-01-09T09:12:17Z

Quality Gate failed

Failed conditions
79.6% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud

github-actions · 2026-01-09T09:12:56Z

SDK Size Comparison 📏

SDK	Before	After	Difference	Status
stream-feeds-android-client	2.43 MB	2.43 MB	0.00 MB	🟢

coderabbitai · 2026-01-09T10:15:50Z

Walkthrough

This PR refactors poll voting operations to simplify local state computation by accepting updated PollData from WebSocket events and propagating it throughout the state management layer, replacing poll ID strings with full PollData objects.

Changes

Cohort / File(s)	Summary
Core Poll Vote Logic `stream-feeds-android-client/src/main/kotlin/io/getstream/feeds/android/client/internal/model/PollOperations.kt`	Simplified `upsertVote` and `removeVote` to accept `updated: PollData` parameter; introduced unified `changeVotes` mechanism; removed local vote count/option tracking logic; delegated ownVotes updates to provided lambda hook.
Repository Layer `stream-feeds-android-client/src/main/kotlin/io/getstream/feeds/android/client/internal/repository/PollsRepository.kt`, `PollsRepositoryImpl.kt`	Updated `castPollVote` and `deletePollVote` return types from `Result<PollVoteData?>` to `Result<Pair<PollVoteData?, PollData?>>` to include updated poll data alongside vote.
State Management - Activity `stream-feeds-android-client/src/main/kotlin/io/getstream/feeds/android/client/internal/state/ActivityImpl.kt`, `ActivityStateImpl.kt`, `ActivityEventHandler.kt`	Updated `onPollVoteUpserted` and `onPollVoteRemoved` signatures from `(vote, pollId)` to `(poll, vote)` with poll-first parameter order; refactored event handling to emit StateUpdateEvent with updated poll objects.
State Management - Activity List `stream-feeds-android-client/src/main/kotlin/io/getstream/feeds/android/client/internal/state/ActivityListStateImpl.kt`, `ActivityListEventHandler.kt`	Changed poll vote handlers from `(pollId: String)` to `(poll: PollData)` parameters; updated internal vote operation calls to pass PollData objects.
State Management - Feed `stream-feeds-android-client/src/main/kotlin/io/getstream/feeds/android/client/internal/state/FeedStateImpl.kt`, `FeedEventHandler.kt`	Transitioned poll vote handlers from `(vote, pollId)` to `(poll, vote)` with PollData objects; updated call sites and public interface signatures.
State Management - Poll List `stream-feeds-android-client/src/main/kotlin/io/getstream/feeds/android/client/internal/state/PollListStateImpl.kt`, `PollListEventHandler.kt`	Refactored `onPollVoteUpserted` and `onPollVoteRemoved` to accept `poll: PollData` instead of `pollId: String`; updated internal vote operation invocations.
State Events & Handlers `stream-feeds-android-client/src/main/kotlin/io/getstream/feeds/android/client/internal/state/event/StateUpdateEvent.kt`, `PollVoteListEventHandler.kt`	Changed `PollVoteCasted`, `PollVoteRemoved`, `PollVoteChanged` data classes from `pollId: String` to `poll: PollData`; updated event handler conditionals.
Network Models `stream-feeds-android-network/src/main/kotlin/io/getstream/feeds/android/network/models/PollVoteResponse.kt`	Added optional `poll: PollResponseData?` field to PollVoteResponse.
Tests `stream-feeds-android-client/src/test/kotlin/io/getstream/feeds/android/client/internal/repository/PollsRepositoryImplTest.kt`, `internal/state/ActivityImplTest.kt`, `ActivityListStateImplTest.kt`, `ActivityStateImplTest.kt`, `FeedStateImplTest.kt`, `PollListStateImplTest.kt`, `event/handler/*Test.kt`	Updated test expectations and assertions to reflect new return types (Pair<PollVoteData?, PollData?>), PollData parameters, and ownVotes behavior; added new test cases for current-user vs. different-user vote scenarios.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Suggested reviewers

aleksandar-apostolov
VelikovPetar

Poem

🐰 A poll vote once tangled with complex math,
Now flows with events on a cleaner path,
PollData leads where pollId did roam,
State updates dance in a unified home,
Simpler logic, less computation to weigh—
The rabbit hops faster this voting day! 🗳️✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 21.25% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The PR title 'Simplify logic to update poll votes' clearly and concisely summarizes the main change—refactoring complex poll vote update logic into a simpler approach.
Description check	✅ Passed	The PR description includes all required sections from the template: Goal (linked to AND-931), Implementation (mirrors ActivityData.upsertBookmark pattern), Testing (manual verification instructions), and completed Checklist items.
Linked Issues check	✅ Passed	The PR successfully implements AND-931's objectives: simplifies PollData.upsertVote by removing complex local computation logic, relies on WS events for external data like vote counts, and computes only 'own' properties locally following the ActivityData.upsertBookmark pattern.
Out of Scope Changes check	✅ Passed	All code changes are directly aligned with AND-931's scope: refactoring poll vote update logic, updating related method signatures to pass PollData objects, and corresponding test updates. No unrelated changes are present.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

📝 Generate docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (3)

stream-feeds-android-client/src/test/kotlin/io/getstream/feeds/android/client/internal/state/ActivityStateImplTest.kt (1)

390-400: LGTM!

Good coverage for the non-matching poll scenario on vote removal.

Minor naming observation: The new test method names (e.g., onPollVoteUpserted...) omit the on prefix pattern used elsewhere in this file (e.g., on onPollUpdated, then...). This is a minor inconsistency that doesn't affect functionality.
stream-feeds-android-client/src/test/kotlin/io/getstream/feeds/android/client/internal/state/FeedStateImplTest.kt (1)
902-910: Consider removing unused helper function.

The pollWithVote helper function appears to be unused in the current test file. If it's no longer needed after the refactoring, consider removing it to reduce dead code.
♻️ Suggested removal
-    private fun pollWithVote(pollId: String, vote: PollVoteData): PollData =
-        pollData(
-            pollId,
-            "Test Poll",
-            voteCount = 1,
-            ownVotes = listOf(vote),
-            latestVotesByOption = mapOf(vote.optionId to listOf(vote)),
-            voteCountsByOption = mapOf(vote.optionId to 1),
-        )
stream-feeds-android-client/src/main/kotlin/io/getstream/feeds/android/client/internal/state/PollListStateImpl.kt (1)
131-145: Consider enriching KDoc parameter descriptions.

The parameter descriptions @param poll The poll. are minimal. Consider adding context about the poll's role.
📝 Suggested documentation improvement
     /**
      * Called when a poll vote is added or updated.
      *
-     * @param poll The poll.
+     * @param poll The updated poll data from the WebSocket event.
      * @param vote The vote that was added or updated.
      */
     fun onPollVoteUpserted(poll: PollData, vote: PollVoteData)

     /**
      * Called when a poll vote is removed.
      *
-     * @param poll The poll.
+     * @param poll The updated poll data from the WebSocket event.
      * @param vote The vote that was removed.
      */
     fun onPollVoteRemoved(poll: PollData, vote: PollVoteData)

📜 Review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 48fba31 and ef90003.

📒 Files selected for processing (26)

stream-feeds-android-client/src/main/kotlin/io/getstream/feeds/android/client/internal/model/PollOperations.kt
stream-feeds-android-client/src/main/kotlin/io/getstream/feeds/android/client/internal/repository/PollsRepository.kt
stream-feeds-android-client/src/main/kotlin/io/getstream/feeds/android/client/internal/repository/PollsRepositoryImpl.kt
stream-feeds-android-client/src/main/kotlin/io/getstream/feeds/android/client/internal/state/ActivityImpl.kt
stream-feeds-android-client/src/main/kotlin/io/getstream/feeds/android/client/internal/state/ActivityListStateImpl.kt
stream-feeds-android-client/src/main/kotlin/io/getstream/feeds/android/client/internal/state/ActivityStateImpl.kt
stream-feeds-android-client/src/main/kotlin/io/getstream/feeds/android/client/internal/state/FeedStateImpl.kt
stream-feeds-android-client/src/main/kotlin/io/getstream/feeds/android/client/internal/state/PollListStateImpl.kt
stream-feeds-android-client/src/main/kotlin/io/getstream/feeds/android/client/internal/state/event/StateUpdateEvent.kt
stream-feeds-android-client/src/main/kotlin/io/getstream/feeds/android/client/internal/state/event/handler/ActivityEventHandler.kt
stream-feeds-android-client/src/main/kotlin/io/getstream/feeds/android/client/internal/state/event/handler/ActivityListEventHandler.kt
stream-feeds-android-client/src/main/kotlin/io/getstream/feeds/android/client/internal/state/event/handler/FeedEventHandler.kt
stream-feeds-android-client/src/main/kotlin/io/getstream/feeds/android/client/internal/state/event/handler/PollListEventHandler.kt
stream-feeds-android-client/src/main/kotlin/io/getstream/feeds/android/client/internal/state/event/handler/PollVoteListEventHandler.kt
stream-feeds-android-client/src/test/kotlin/io/getstream/feeds/android/client/internal/repository/PollsRepositoryImplTest.kt
stream-feeds-android-client/src/test/kotlin/io/getstream/feeds/android/client/internal/state/ActivityImplTest.kt
stream-feeds-android-client/src/test/kotlin/io/getstream/feeds/android/client/internal/state/ActivityListStateImplTest.kt
stream-feeds-android-client/src/test/kotlin/io/getstream/feeds/android/client/internal/state/ActivityStateImplTest.kt
stream-feeds-android-client/src/test/kotlin/io/getstream/feeds/android/client/internal/state/FeedStateImplTest.kt
stream-feeds-android-client/src/test/kotlin/io/getstream/feeds/android/client/internal/state/PollListStateImplTest.kt
stream-feeds-android-client/src/test/kotlin/io/getstream/feeds/android/client/internal/state/event/handler/ActivityEventHandlerTest.kt
stream-feeds-android-client/src/test/kotlin/io/getstream/feeds/android/client/internal/state/event/handler/ActivityListEventHandlerTest.kt
stream-feeds-android-client/src/test/kotlin/io/getstream/feeds/android/client/internal/state/event/handler/FeedEventHandlerTest.kt
stream-feeds-android-client/src/test/kotlin/io/getstream/feeds/android/client/internal/state/event/handler/PollListEventHandlerTest.kt
stream-feeds-android-client/src/test/kotlin/io/getstream/feeds/android/client/internal/state/event/handler/PollVoteListEventHandlerTest.kt
stream-feeds-android-network/src/main/kotlin/io/getstream/feeds/android/network/models/PollVoteResponse.kt

🧰 Additional context used

📓 Path-based instructions (6)

**/*.{kt,kts}