[AND-420] Expose ChatClient.deletePoll operation. (#5696)

VelikovPetar · web-flow · commit cd5562b5d842 · 2025-04-15T16:22:02.000+02:00
* [AND-420] Expose ChatClient.deletePoll operation.

* [AND-420] Apply spotless.

* [AND-420] Add test for handling PollDeletedEvent.

* [AND-420] Update CHANGELOG.md.

* [AND-420] Remove PollRepository and use MessageRepository to handle poll-related operations.

---------

Co-authored-by: PetarVelikov &lt;petar.velikov@getstream.io&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,6 +18,7 @@
 
 ### ✅ Added
 - Add `lastReadMessageId` field to `MessageReadEvent` and `NotificationMarkReadEvent`. [#5710](https://github.com/GetStream/stream-chat-android/pull/5710)
+- Add `ChatClient.deletePoll(String)` method to delete a Poll by its ID. [#5696](https://github.com/GetStream/stream-chat-android/pull/5696)
 
 ### ⚠️ Changed
 
diff --git a/stream-chat-android-client-test/src/main/java/io/getstream/chat/android/client/test/Mother.kt b/stream-chat-android-client-test/src/main/java/io/getstream/chat/android/client/test/Mother.kt
@@ -38,6 +38,7 @@ import io.getstream.chat.android.client.events.NotificationMarkUnreadEvent
 import io.getstream.chat.android.client.events.NotificationMessageNewEvent
 import io.getstream.chat.android.client.events.NotificationMutesUpdatedEvent
 import io.getstream.chat.android.client.events.NotificationRemovedFromChannelEvent
+import io.getstream.chat.android.client.events.PollDeletedEvent
 import io.getstream.chat.android.client.events.ReactionNewEvent
 import io.getstream.chat.android.client.events.TypingStartEvent
 import io.getstream.chat.android.client.events.TypingStopEvent
@@ -51,6 +52,7 @@ import io.getstream.chat.android.models.FilterObject
 import io.getstream.chat.android.models.Member
 import io.getstream.chat.android.models.Message
 import io.getstream.chat.android.models.NeutralFilterObject
+import io.getstream.chat.android.models.Poll
 import io.getstream.chat.android.models.Reaction
 import io.getstream.chat.android.models.User
 import io.getstream.chat.android.models.querysort.QuerySortByField
@@ -62,6 +64,7 @@ import io.getstream.chat.android.randomDate
 import io.getstream.chat.android.randomInt
 import io.getstream.chat.android.randomMember
 import io.getstream.chat.android.randomMessage
+import io.getstream.chat.android.randomPoll
 import io.getstream.chat.android.randomReaction
 import io.getstream.chat.android.randomString
 import io.getstream.chat.android.randomUser
@@ -630,3 +633,22 @@ public fun randomChannelUserBannedEvent(
         channelLastMessageAt = channelLastMessageAt,
     )
 }
+
+public fun randomPollDeletedEvent(
+    createdAt: Date = randomDate(),
+    cid: String = randomCID(),
+    poll: Poll = randomPoll(),
+    channelLastMessageAt: Date = randomDate(),
+): PollDeletedEvent {
+    val (type, id) = cid.cidToTypeAndId()
+    return PollDeletedEvent(
+        type = EventType.POLL_DELETED,
+        createdAt = createdAt,
+        rawCreatedAt = streamFormatter.format(createdAt),
+        cid = cid,
+        channelType = type,
+        channelId = id,
+        poll = poll,
+        channelLastMessageAt = channelLastMessageAt,
+    )
+}
diff --git a/stream-chat-android-client/api/stream-chat-android-client.api b/stream-chat-android-client/api/stream-chat-android-client.api
@@ -50,6 +50,7 @@ public final class io/getstream/chat/android/client/ChatClient {
 	public final fun deleteMessage (Ljava/lang/String;)Lio/getstream/result/call/Call;
 	public final fun deleteMessage (Ljava/lang/String;Z)Lio/getstream/result/call/Call;
 	public static synthetic fun deleteMessage$default (Lio/getstream/chat/android/client/ChatClient;Ljava/lang/String;ZILjava/lang/Object;)Lio/getstream/result/call/Call;
+	public final fun deletePoll (Ljava/lang/String;)Lio/getstream/result/call/Call;
 	public final fun deleteReaction (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)Lio/getstream/result/call/Call;
 	public static synthetic fun deleteReaction$default (Lio/getstream/chat/android/client/ChatClient;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;ILjava/lang/Object;)Lio/getstream/result/call/Call;
 	public final fun devToken (Ljava/lang/String;)Ljava/lang/String;
@@ -2744,6 +2745,7 @@ public abstract interface class io/getstream/chat/android/client/persistance/rep
 	public abstract fun deleteChannelMessages (Ljava/lang/String;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public abstract fun deleteChannelMessagesBefore (Ljava/lang/String;Ljava/util/Date;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public abstract fun deleteDraftMessage (Lio/getstream/chat/android/models/DraftMessage;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public abstract fun deletePoll (Ljava/lang/String;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public abstract fun evictMessage (Ljava/lang/String;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public abstract fun evictMessages (Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public abstract fun insertDraftMessage (Lio/getstream/chat/android/models/DraftMessage;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
diff --git a/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/ChatClient.kt b/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/ChatClient.kt
@@ -1614,6 +1614,17 @@ internal constructor(
         return api.closePoll(pollId)
     }
 
+    /**
+     * Deletes a poll.
+     *
+     * @param pollId The ID of the poll to delete.
+     * @return Executable async [Call] responsible for deleting a poll.
+     */
+    @CheckResult
+    public fun deletePoll(pollId: String): Call<Unit> {
+        return api.deletePoll(pollId)
+    }
+
     /**
      * Retrieves the file attachments from the given channel.
      *
diff --git a/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api/ChatApi.kt b/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api/ChatApi.kt
@@ -542,6 +542,9 @@ internal interface ChatApi {
     @CheckResult
     fun closePoll(pollId: String): Call<Poll>
 
+    @CheckResult
+    fun deletePoll(pollId: String): Call<Unit>
+
     fun warmUp()
 
     fun releaseConnection()
diff --git a/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api2/MoshiChatApi.kt b/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api2/MoshiChatApi.kt
@@ -1435,6 +1435,10 @@ constructor(
         ).mapDomain { it.poll.toDomain() }
     }
 
+    override fun deletePoll(pollId: String): Call<Unit> {
+        return pollsApi.deletePoll(pollId).toUnitCall()
+    }
+
     override fun warmUp() {
         generalApi.warmUp().enqueue()
     }
diff --git a/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api2/endpoint/PollsApi.kt b/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api2/endpoint/PollsApi.kt
@@ -21,6 +21,7 @@ import io.getstream.chat.android.client.api2.model.requests.PollRequest
 import io.getstream.chat.android.client.api2.model.requests.PollUpdateRequest
 import io.getstream.chat.android.client.api2.model.requests.PollVoteRequest
 import io.getstream.chat.android.client.api2.model.requests.SuggestPollOptionRequest
+import io.getstream.chat.android.client.api2.model.response.CompletableResponse
 import io.getstream.chat.android.client.api2.model.response.PollResponse
 import io.getstream.chat.android.client.api2.model.response.PollVoteResponse
 import io.getstream.chat.android.client.api2.model.response.SuggestPollOptionResponse
@@ -103,4 +104,12 @@ internal interface PollsApi {
         @Path("poll_id") pollId: String,
         @Body pollUpdateRequest: PollUpdateRequest,
     ): RetrofitCall<PollResponse>
+
+    /**
+     * Deletes a poll.
+     *
+     * @param pollId The ID of the poll to delete.
+     */
+    @DELETE("/polls/{poll_id}")
+    fun deletePoll(@Path("poll_id") pollId: String): RetrofitCall<CompletableResponse>
 }
diff --git a/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api2/model/dto/PollsDtos.kt b/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api2/model/dto/PollsDtos.kt
@@ -92,7 +92,7 @@ internal data class DownstreamPollDto(
     val latest_votes_by_option: Map<String, List<DownstreamVoteDto>>?,
     val latest_answers: List<DownstreamVoteDto>?,
     val created_at: Date,
-    val created_by: DownstreamUserDto,
+    val created_by: DownstreamUserDto?,
     val created_by_id: String,
     val own_votes: List<DownstreamVoteDto>,
     val updated_at: Date,
diff --git a/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/persistance/repository/MessageRepository.kt b/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/persistance/repository/MessageRepository.kt
@@ -160,6 +160,13 @@ public interface MessageRepository {
      */
     public suspend fun evictMessage(messageId: String)
 
+    /**
+     * Deletes a Poll by its ID.
+     *
+     * @param pollId The ID of the Poll to delete.
+     */
+    public suspend fun deletePoll(pollId: String)
+
     /**
      * Clear messages of this repository.
      */
diff --git a/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/persistance/repository/noop/NoOpMessageRepository.kt b/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/persistance/repository/noop/NoOpMessageRepository.kt
@@ -44,6 +44,7 @@ internal object NoOpMessageRepository : MessageRepository {
     override suspend fun insertDraftMessage(message: DraftMessage) { /* No-Op */ }
     override suspend fun evictMessages() { /* No-Op */ }
     override suspend fun evictMessage(messageId: String) { /* No-Op */ }
+    override suspend fun deletePoll(pollId: String) { /* No-Op */ }
 
     override suspend fun clear() { /* No-Op */ }
     override suspend fun selectMessagesForChannel(
diff --git a/stream-chat-android-client/src/test/java/io/getstream/chat/android/client/ChatClientPollsApiTests.kt b/stream-chat-android-client/src/test/java/io/getstream/chat/android/client/ChatClientPollsApiTests.kt
@@ -219,4 +219,29 @@ internal class ChatClientPollsApiTests : BaseChatClientTest() {
         // then
         verifyNetworkError(result, errorCode)
     }
+
+    @Test
+    fun deletePollSuccess() = runTest {
+        // given
+        val pollId = randomString()
+        whenever(api.deletePoll(any()))
+            .thenReturn(RetroSuccess(Unit).toRetrofitCall())
+        // when
+        val result = chatClient.deletePoll(pollId).await()
+        // then
+        verifySuccess(result, Unit)
+    }
+
+    @Test
+    fun deletePollError() = runTest {
+        // given
+        val pollId = randomString()
+        val errorCode = positiveRandomInt()
+        whenever(api.deletePoll(any()))
+            .thenReturn(RetroError<Unit>(errorCode).toRetrofitCall())
+        // when
+        val result = chatClient.deletePoll(pollId).await()
+        // then
+        verifyNetworkError(result, errorCode)
+    }
 }
diff --git a/stream-chat-android-client/src/test/java/io/getstream/chat/android/client/api2/MoshiChatApiTest.kt b/stream-chat-android-client/src/test/java/io/getstream/chat/android/client/api2/MoshiChatApiTest.kt
@@ -2051,6 +2051,23 @@ internal class MoshiChatApiTest {
         verify(api, times(1)).createPoll(expectedBody)
     }
 
+    @ParameterizedTest
+    @MethodSource("io.getstream.chat.android.client.api2.MoshiChatApiTestArguments#deletePollInput")
+    fun testDeletePoll(call: RetrofitCall<CompletableResponse>, expected: KClass<*>) = runTest {
+        // given
+        val api = mock<PollsApi>()
+        whenever(api.deletePoll(any())).doReturn(call)
+        val sut = Fixture()
+            .withPollsApi(api)
+            .get()
+        // when
+        val pollId = randomString()
+        val result = sut.deletePoll(pollId).await()
+        // then
+        result `should be instance of` expected
+        verify(api, times(1)).deletePoll(pollId)
+    }
+
     @Test
     fun testWarmUp() = runTest {
         // given
diff --git a/stream-chat-android-client/src/test/java/io/getstream/chat/android/client/api2/MoshiChatApiTestArguments.kt b/stream-chat-android-client/src/test/java/io/getstream/chat/android/client/api2/MoshiChatApiTestArguments.kt
@@ -463,6 +463,9 @@ internal object MoshiChatApiTestArguments {
     @JvmStatic
     fun createPollInput() = pollResponseArguments()
 
+    @JvmStatic
+    fun deletePollInput() = completableResponseArguments()
+
     @JvmStatic
     fun suggestPollOptionInput() = listOf(
         Arguments.of(
diff --git a/stream-chat-android-offline/api/stream-chat-android-offline.api b/stream-chat-android-offline/api/stream-chat-android-offline.api
@@ -107,6 +107,7 @@ public final class io/getstream/chat/android/offline/repository/domain/message/i
 
 public final class io/getstream/chat/android/offline/repository/domain/message/internal/PollDao_Impl : io/getstream/chat/android/offline/repository/domain/message/internal/PollDao {
 	public fun <init> (Landroidx/room/RoomDatabase;)V
+	public fun deletePoll (Ljava/lang/String;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public fun getPoll (Ljava/lang/String;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public static fun getRequiredConverters ()Ljava/util/List;
 	public fun insertPolls (Ljava/util/List;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
diff --git a/stream-chat-android-offline/src/main/java/io/getstream/chat/android/offline/repository/domain/message/internal/DatabaseMessageRepository.kt b/stream-chat-android-offline/src/main/java/io/getstream/chat/android/offline/repository/domain/message/internal/DatabaseMessageRepository.kt
@@ -223,6 +223,10 @@ internal class DatabaseMessageRepository(
         replyMessageCache.evictAll()
     }
 
+    override suspend fun deletePoll(pollId: String) {
+        pollDao.deletePoll(pollId)
+    }
+
     override suspend fun clear() {
         messageCache.evictAll()
         replyMessageCache.evictAll()
diff --git a/stream-chat-android-offline/src/main/java/io/getstream/chat/android/offline/repository/domain/message/internal/PollDao.kt b/stream-chat-android-offline/src/main/java/io/getstream/chat/android/offline/repository/domain/message/internal/PollDao.kt
@@ -28,4 +28,7 @@ internal interface PollDao {
 
     @Query("SELECT * From $POLL_ENTITY_TABLE_NAME  WHERE id = :pollId")
     suspend fun getPoll(pollId: String): PollEntity?
+
+    @Query("DELETE FROM $POLL_ENTITY_TABLE_NAME WHERE id = :pollId")
+    suspend fun deletePoll(pollId: String)
 }
diff --git a/stream-chat-android-offline/src/test/java/io/getstream/chat/android/offline/repository/MessageRepositoryTests.kt b/stream-chat-android-offline/src/test/java/io/getstream/chat/android/offline/repository/MessageRepositoryTests.kt
@@ -17,7 +17,6 @@
 package io.getstream.chat.android.offline.repository
 
 import io.getstream.chat.android.client.api.models.Pagination
-import io.getstream.chat.android.client.persistance.repository.MessageRepository
 import io.getstream.chat.android.client.query.pagination.AnyChannelPaginationRequest
 import io.getstream.chat.android.offline.randomMessageEntity
 import io.getstream.chat.android.offline.repository.domain.message.internal.DatabaseMessageRepository
@@ -43,7 +42,6 @@ internal class MessageRepositoryTests {
     private val messageDao: MessageDao = mock()
     private val replyMessageDao: ReplyMessageDao = mock()
     private val pollDao: PollDao = mock()
-    private lateinit var sut: MessageRepository
 
     @Test
     fun `when selecting messages for channel, correct messages should be requested to DAO`() = runTest {
@@ -98,4 +96,22 @@ internal class MessageRepositoryTests {
             verify(messageDao).messagesForChannelEqualOrOlderThan(cid, requestLessThan.messageLimit, createdAt)
         }
     }
+
+    @Test
+    fun `when calling deletePoll, then deletePoll from PollDao is called`() = runTest {
+        // given
+        val repository = DatabaseMessageRepository(
+            this,
+            messageDao,
+            replyMessageDao,
+            pollDao,
+            ::randomUser,
+            randomUser(id = "currentUserId"),
+        )
+        val pollId = randomString()
+        // when
+        repository.deletePoll(pollId)
+        // then
+        verify(pollDao).deletePoll(pollId)
+    }
 }
diff --git a/stream-chat-android-state/src/main/java/io/getstream/chat/android/state/event/handler/internal/EventBatchUpdate.kt b/stream-chat-android-state/src/main/java/io/getstream/chat/android/state/event/handler/internal/EventBatchUpdate.kt
@@ -125,6 +125,15 @@ internal class EventBatchUpdate private constructor(
             .forEach { addMessage(it.copy(poll = poll)) }
     }
 
+    /**
+     * Removes the [Poll] from the [Message]s in the cache.
+     */
+    fun deletePoll(poll: Poll) {
+        messageMap.values
+            .filter { it.poll?.id == poll.id }
+            .forEach { addMessage(it.copy(poll = null)) }
+    }
+
     suspend fun execute() {
         // actually insert the data
         currentUserId?.let { userMap -= it }
diff --git a/stream-chat-android-state/src/main/java/io/getstream/chat/android/state/event/handler/internal/EventHandlerSequential.kt b/stream-chat-android-state/src/main/java/io/getstream/chat/android/state/event/handler/internal/EventHandlerSequential.kt
@@ -728,12 +728,12 @@ internal class EventHandlerSequential(
                     repos.insertCurrentUser(event.user)
                 }
                 is PollClosedEvent -> batch.addPoll(event.processPoll(batch::getPoll))
-                is PollDeletedEvent -> batch.addPoll(event.poll)
                 is PollUpdatedEvent -> batch.addPoll(event.processPoll(batch::getPoll))
                 is VoteCastedEvent -> batch.addPoll(event.processPoll(currentUserId, batch::getPoll))
                 is VoteChangedEvent -> batch.addPoll(event.processPoll(currentUserId, batch::getPoll))
                 is VoteRemovedEvent -> batch.addPoll(event.processPoll(batch::getPoll))
                 is AnswerCastedEvent -> batch.addPoll(event.processPoll(batch::getPoll))
+                is PollDeletedEvent -> batch.deletePoll(event.poll)
                 else -> Unit
             }
         }
@@ -776,6 +776,9 @@ internal class EventHandlerSequential(
                 is NotificationRemovedFromChannelEvent -> {
                     repos.evictChannel(event.cid)
                 }
+                is PollDeletedEvent -> {
+                    repos.deletePoll(event.poll.id)
+                }
                 else -> Unit // Ignore other events
             }
         }
diff --git a/stream-chat-android-state/src/main/java/io/getstream/chat/android/state/plugin/logic/channel/internal/ChannelLogic.kt b/stream-chat-android-state/src/main/java/io/getstream/chat/android/state/plugin/logic/channel/internal/ChannelLogic.kt
@@ -626,8 +626,8 @@ internal class ChannelLogic(
                         )
                     }
                     is PollClosedEvent -> channelStateLogic.upsertPoll(event.processPoll(channelStateLogic::getPoll))
-                    is PollDeletedEvent -> channelStateLogic.upsertPoll(event.poll)
                     is PollUpdatedEvent -> channelStateLogic.upsertPoll(event.processPoll(channelStateLogic::getPoll))
+                    is PollDeletedEvent -> channelStateLogic.deletePoll(event.poll)
                     is VoteCastedEvent ->
                         channelStateLogic.upsertPoll(event.processPoll(currentUserId, channelStateLogic::getPoll))
                     is VoteChangedEvent ->
diff --git a/stream-chat-android-state/src/main/java/io/getstream/chat/android/state/plugin/logic/channel/internal/ChannelStateLogic.kt b/stream-chat-android-state/src/main/java/io/getstream/chat/android/state/plugin/logic/channel/internal/ChannelStateLogic.kt
@@ -787,6 +787,25 @@ internal class ChannelStateLogic(
         }
     }
 
+    /**
+     * Deletes the given Poll from the state.
+     *
+     * @param poll The Poll to be deleted.
+     */
+    fun deletePoll(poll: Poll) {
+        // remove poll
+        polls.remove(poll.id)
+        // remove poll from each message linked to the poll
+        messageIdsWithPoll[poll.id]?.forEach { messageId ->
+            val message = mutableState.getMessageById(messageId)
+            if (message != null) {
+                mutableState.upsertMessage(message.copy(poll = null))
+            }
+        }
+        // remove the pollId and messageId from the poll map
+        messageIdsWithPoll.remove(poll.id)
+    }
+
     fun getPoll(pollId: String): Poll? = polls[pollId]
 
     private companion object {
diff --git a/stream-chat-android-state/src/test/java/io/getstream/chat/android/state/channel/controller/WhenHandleEvent.kt b/stream-chat-android-state/src/test/java/io/getstream/chat/android/state/channel/controller/WhenHandleEvent.kt
diff --git a/stream-chat-android-state/src/test/java/io/getstream/chat/android/state/channel/controller/attachment/UploadAttachmentsIntegrationTests.kt b/stream-chat-android-state/src/test/java/io/getstream/chat/android/state/channel/controller/attachment/UploadAttachmentsIntegrationTests.kt
diff --git a/stream-chat-android-state/src/test/java/io/getstream/chat/android/state/event/handler/internal/EventHandlerSequentialTest.kt b/stream-chat-android-state/src/test/java/io/getstream/chat/android/state/event/handler/internal/EventHandlerSequentialTest.kt
diff --git a/stream-chat-android-state/src/test/java/io/getstream/chat/android/state/plugin/logic/channel/internal/ChannelStateLogicTest.kt b/stream-chat-android-state/src/test/java/io/getstream/chat/android/state/plugin/logic/channel/internal/ChannelStateLogicTest.kt

Original file line number	Diff line number	Diff line change
`@@ -1435,6 +1435,10 @@ constructor(`
`1435`	`1435`	`).mapDomain { it.poll.toDomain() }`
`1436`	`1436`	`}`
`1437`	`1437`
	`1438`	`+ override fun deletePoll(pollId: String): Call<Unit> {`
	`1439`	`+ return pollsApi.deletePoll(pollId).toUnitCall()`
	`1440`	`+ }`
	`1441`	`+`
`1438`	`1442`	`override fun warmUp() {`
`1439`	`1443`	`generalApi.warmUp().enqueue()`
`1440`	`1444`	`}`