Allow polls to be edited (#1869)

Polls can be edited if they do not have any votes

---------

Co-authored-by: ElementBot <benoitm+elementbot@element.io>

libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/room/MatrixRoom.kt

@@ -176,6 +176,23 @@ interface MatrixRoom : Closeable {
         pollKind: PollKind,
     ): Result<Unit>
 
+    /**
+     * Edit a poll in the room.
+     *
+     * @param pollStartId The event ID of the poll start event.
+     * @param question The question to ask.
+     * @param answers The list of answers.
+     * @param maxSelections The maximum number of answers that can be selected.
+     * @param pollKind The kind of poll to create.
+     */
+    suspend fun editPoll(
+        pollStartId: EventId,
+        question: String,
+        answers: List<String>,
+        maxSelections: Int,
+        pollKind: PollKind,
+    ): Result<Unit>
+
     /**
      * Send a response to a poll.
      *

libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/room/RustMatrixRoom.kt

@@ -477,6 +477,30 @@ class RustMatrixRoom(
         }
     }
 
+    override suspend fun editPoll(
+        pollStartId: EventId,
+        question: String,
+        answers: List<String>,
+        maxSelections: Int,
+        pollKind: PollKind,
+    ): Result<Unit> = withContext(roomDispatcher) {
+        runCatching {
+            val pollStartEvent =
+                innerRoom.getEventTimelineItemByEventId(
+                    eventId = pollStartId.value
+                )
+            pollStartEvent.use {
+                innerRoom.editPoll(
+                    question = question,
+                    answers = answers,
+                    maxSelections = maxSelections.toUByte(),
+                    pollKind = pollKind.toInner(),
+                    editItem = pollStartEvent,
+                )
+            }
+        }
+    }
+
     override suspend fun sendPollResponse(
         pollStartId: EventId,
         answers: List<String>

libraries/matrix/test/src/main/kotlin/io/element/android/libraries/matrix/test/room/FakeMatrixRoom.kt

@@ -103,6 +103,7 @@ class FakeMatrixRoom(
     private var reportContentResult = Result.success(Unit)
     private var sendLocationResult = Result.success(Unit)
     private var createPollResult = Result.success(Unit)
+    private var editPollResult = Result.success(Unit)
     private var sendPollResponseResult = Result.success(Unit)
     private var endPollResult = Result.success(Unit)
     private var progressCallbackValues = emptyList<Pair<Long, Long>>()
@@ -130,8 +131,11 @@ class FakeMatrixRoom(
     private val _sentLocations = mutableListOf<SendLocationInvocation>()
     val sentLocations: List<SendLocationInvocation> = _sentLocations
 
-    private val _createPollInvocations = mutableListOf<CreatePollInvocation>()
-    val createPollInvocations: List<CreatePollInvocation> = _createPollInvocations
+    private val _createPollInvocations = mutableListOf<SavePollInvocation>()
+    val createPollInvocations: List<SavePollInvocation> = _createPollInvocations
+
+    private val _editPollInvocations = mutableListOf<SavePollInvocation>()
+    val editPollInvocations: List<SavePollInvocation> = _editPollInvocations
 
     private val _sendPollResponseInvocations = mutableListOf<SendPollResponseInvocation>()
     val sendPollResponseInvocations: List<SendPollResponseInvocation> = _sendPollResponseInvocations
@@ -375,10 +379,21 @@ class FakeMatrixRoom(
         maxSelections: Int,
         pollKind: PollKind
     ): Result<Unit> = simulateLongTask {
-        _createPollInvocations.add(CreatePollInvocation(question, answers, maxSelections, pollKind))
+        _createPollInvocations.add(SavePollInvocation(question, answers, maxSelections, pollKind))
         return createPollResult
     }
 
+    override suspend fun editPoll(
+        pollStartId: EventId,
+        question: String,
+        answers: List<String>,
+        maxSelections: Int,
+        pollKind: PollKind
+    ): Result<Unit> = simulateLongTask {
+        _editPollInvocations.add(SavePollInvocation(question, answers, maxSelections, pollKind))
+        return editPollResult
+    }
+
     override suspend fun sendPollResponse(
         pollStartId: EventId,
         answers: List<String>
@@ -511,6 +526,10 @@ class FakeMatrixRoom(
         createPollResult = result
     }
 
+    fun givenEditPollResult(result: Result<Unit>) {
+        editPollResult = result
+    }
+
     fun givenSendPollResponseResult(result: Result<Unit>) {
         sendPollResponseResult = result
     }
@@ -544,7 +563,7 @@ data class SendLocationInvocation(
     val assetType: AssetType?,
 )
 
-data class CreatePollInvocation(
+data class SavePollInvocation(
     val question: String,
     val answers: List<String>,
     val maxSelections: Int,

libraries/matrix/test/src/main/kotlin/io/element/android/libraries/matrix/test/room/RoomSummaryFixture.kt

@@ -181,11 +181,12 @@ fun aTimelineItemDebugInfo(
 
 fun aPollContent(
     question: String = "Do you like polls?",
+    answers: List<PollAnswer> = listOf(PollAnswer("1", "Yes"), PollAnswer("2", "No")),
 ) = PollContent(
     question = question,
     kind = PollKind.Disclosed,
     maxSelections = 1u,
-    answers = listOf(PollAnswer("1", "Yes"), PollAnswer("2", "No")),
+    answers = answers,
     votes = mapOf(),
     endTime = null
 )

libraries/ui-strings/src/main/res/values/localazy.xml

@@ -39,9 +39,11 @@
   <string name="action_create">"Create"</string>
   <string name="action_create_a_room">"Create a room"</string>
   <string name="action_decline">"Decline"</string>
+  <string name="action_delete_poll">"Delete Poll"</string>
   <string name="action_disable">"Disable"</string>
   <string name="action_done">"Done"</string>
   <string name="action_edit">"Edit"</string>
+  <string name="action_edit_poll">"Edit poll"</string>
   <string name="action_enable">"Enable"</string>
   <string name="action_end_poll">"End poll"</string>
   <string name="action_enter_pin">"Enter PIN"</string>
@@ -93,7 +95,6 @@
   <string name="action_try_again">"Try again"</string>
   <string name="action_view_source">"View source"</string>
   <string name="action_yes">"Yes"</string>
-  <string name="action_edit_poll">"Edit poll"</string>
   <string name="common_about">"About"</string>
   <string name="common_acceptable_use_policy">"Acceptable use policy"</string>
   <string name="common_advanced_settings">"Advanced settings"</string>