Merge pull request #5345 from vector-im/feature/ons/fix_unstable_prefixes

Support both unstable and stable prefixes

Author: onurays

changelog.d/5340.bugfix

@@ -0,0 +1 @@
+Support both stable and unstable prefixes for Events about Polls and Location

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/events/model/Event.kt

@@ -349,7 +349,7 @@ fun Event.isAttachmentMessage(): Boolean {
             }
 }
 
-fun Event.isPoll(): Boolean = getClearType() == EventType.POLL_START || getClearType() == EventType.POLL_END
+fun Event.isPoll(): Boolean = getClearType() in EventType.POLL_START || getClearType() in EventType.POLL_END
 
 fun Event.isSticker(): Boolean = getClearType() == EventType.STICKER
 
@@ -372,7 +372,7 @@ fun Event.getRelationContent(): RelationDefaultContent? {
  * Returns the poll question or null otherwise
  */
 fun Event.getPollQuestion(): String? =
-        getPollContent()?.pollCreationInfo?.question?.question
+        getPollContent()?.getBestPollCreationInfo()?.question?.getBestQuestion()
 
 /**
  * Returns the relation content for a specific type or null otherwise

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/events/model/EventType.kt

@@ -103,9 +103,9 @@ object EventType {
     const val REACTION = "m.reaction"
 
     // Poll
-    const val POLL_START = "org.matrix.msc3381.poll.start"
-    const val POLL_RESPONSE = "org.matrix.msc3381.poll.response"
-    const val POLL_END = "org.matrix.msc3381.poll.end"
+    val POLL_START = listOf("org.matrix.msc3381.poll.start", "m.poll.start")
+    val POLL_RESPONSE = listOf("org.matrix.msc3381.poll.response", "m.poll.response")
+    val POLL_END = listOf("org.matrix.msc3381.poll.end", "m.poll.end")
 
     // Unwedging
     internal const val DUMMY = "m.dummy"

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/model/message/MessageLocationContent.kt

@@ -39,37 +39,46 @@ data class MessageLocationContent(
          */
         @Json(name = "geo_uri") val geoUri: String,
 
+        @Json(name = "m.relates_to") override val relatesTo: RelationDefaultContent? = null,
+        @Json(name = "m.new_content") override val newContent: Content? = null,
         /**
          * See https://github.com/matrix-org/matrix-doc/blob/matthew/location/proposals/3488-location.md
          */
-        @Json(name = "org.matrix.msc3488.location") val locationInfo: LocationInfo? = null,
-
-        @Json(name = "m.relates_to") override val relatesTo: RelationDefaultContent? = null,
-        @Json(name = "m.new_content") override val newContent: Content? = null,
-
+        @Json(name = "org.matrix.msc3488.location") val unstableLocationInfo: LocationInfo? = null,
+        @Json(name = "m.location") val locationInfo: LocationInfo? = null,
+        /**
+         * Exact time that the data in the event refers to (milliseconds since the UNIX epoch)
+         */
+        @Json(name = "org.matrix.msc3488.ts") val unstableTs: Long? = null,
+        @Json(name = "m.ts") val ts: Long? = null,
+        @Json(name = "org.matrix.msc1767.text") val unstableText: String? = null,
+        @Json(name = "m.text") val text: String? = null,
         /**
          * m.asset defines a generic asset that can be used for location tracking but also in other places like
          * inventories, geofencing, checkins/checkouts etc.
          * It should contain a mandatory namespaced type key defining what particular asset is being referred to.
          * For the purposes of user location tracking m.self should be used in order to avoid duplicating the mxid.
          */
-        @Json(name = "m.asset") val locationAsset: LocationAsset? = null,
+        @Json(name = "org.matrix.msc3488.asset") val unstableLocationAsset: LocationAsset? = null,
+        @Json(name = "m.asset") val locationAsset: LocationAsset? = null
+) : MessageContent {
 
-        /**
-         * Exact time that the data in the event refers to (milliseconds since the UNIX epoch)
-         */
-        @Json(name = "org.matrix.msc3488.ts") val ts: Long? = null,
+    fun getBestLocationInfo() = locationInfo ?: unstableLocationInfo
 
-        @Json(name = "org.matrix.msc1767.text") val text: String? = null
-) : MessageContent {
+    fun getBestTs() = ts ?: unstableTs
+
+    fun getBestText() = text ?: unstableText
+
+    fun getBestLocationAsset() = locationAsset ?: unstableLocationAsset
 
-    fun getBestGeoUri() = locationInfo?.geoUri ?: geoUri
+    fun getBestGeoUri() = getBestLocationInfo()?.geoUri ?: geoUri
 
     /**
      * @return true if the location asset is a user location, not a generic one.
      */
     fun isSelfLocation(): Boolean {
         // Should behave like m.self if locationAsset is null
+        val locationAsset = getBestLocationAsset()
         return locationAsset?.type == null || locationAsset.type == LocationAssetType.SELF
     }
 }

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/model/message/MessagePollContent.kt

@@ -31,5 +31,9 @@ data class MessagePollContent(
         @Json(name = "body") override val body: String = "",
         @Json(name = "m.relates_to") override val relatesTo: RelationDefaultContent? = null,
         @Json(name = "m.new_content") override val newContent: Content? = null,
-        @Json(name = "org.matrix.msc3381.poll.start") val pollCreationInfo: PollCreationInfo? = null
-) : MessageContent
+        @Json(name = "org.matrix.msc3381.poll.start") val unstablePollCreationInfo: PollCreationInfo? = null,
+        @Json(name = "m.poll.start") val pollCreationInfo: PollCreationInfo? = null
+) : MessageContent {
+
+    fun getBestPollCreationInfo() = pollCreationInfo ?: unstablePollCreationInfo
+}

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/model/message/MessagePollResponseContent.kt

@@ -31,5 +31,9 @@ data class MessagePollResponseContent(
         @Json(name = "body") override val body: String = "",
         @Json(name = "m.relates_to") override val relatesTo: RelationDefaultContent? = null,
         @Json(name = "m.new_content") override val newContent: Content? = null,
-        @Json(name = "org.matrix.msc3381.poll.response") val response: PollResponse? = null
-) : MessageContent
+        @Json(name = "org.matrix.msc3381.poll.response") val unstableResponse: PollResponse? = null,
+        @Json(name = "m.response") val response: PollResponse? = null
+) : MessageContent {
+
+    fun getBestResponse() = response ?: unstableResponse
+}

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/model/message/PollAnswer.kt

@@ -22,5 +22,9 @@ import com.squareup.moshi.JsonClass
 @JsonClass(generateAdapter = true)
 data class PollAnswer(
         @Json(name = "id") val id: String? = null,
-        @Json(name = "org.matrix.msc1767.text") val answer: String? = null
-)
+        @Json(name = "org.matrix.msc1767.text") val unstableAnswer: String? = null,
+        @Json(name = "m.text") val answer: String? = null
+) {
+
+    fun getBestAnswer() = answer ?: unstableAnswer
+}

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/model/message/PollCreationInfo.kt

@@ -21,8 +21,8 @@ import com.squareup.moshi.JsonClass
 
 @JsonClass(generateAdapter = true)
 data class PollCreationInfo(
-    @Json(name = "question") val question: PollQuestion? = null,
-    @Json(name = "kind") val kind: PollType? = PollType.DISCLOSED,
-    @Json(name = "max_selections") val maxSelections: Int = 1,
-    @Json(name = "answers") val answers: List<PollAnswer>? = null
+        @Json(name = "question") val question: PollQuestion? = null,
+        @Json(name = "kind") val kind: PollType? = PollType.DISCLOSED_UNSTABLE,
+        @Json(name = "max_selections") val maxSelections: Int = 1,
+        @Json(name = "answers") val answers: List<PollAnswer>? = null
 )

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/model/message/PollQuestion.kt

@@ -21,5 +21,9 @@ import com.squareup.moshi.JsonClass
 
 @JsonClass(generateAdapter = true)
 data class PollQuestion(
-        @Json(name = "org.matrix.msc1767.text") val question: String? = null
-)
+        @Json(name = "org.matrix.msc1767.text") val unstableQuestion: String? = null,
+        @Json(name = "m.text") val question: String? = null
+) {
+
+    fun getBestQuestion() = question ?: unstableQuestion
+}

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/model/message/PollType.kt

@@ -25,11 +25,17 @@ enum class PollType {
      * Voters should see results as soon as they have voted.
      */
     @Json(name = "org.matrix.msc3381.poll.disclosed")
+    DISCLOSED_UNSTABLE,
+
+    @Json(name = "m.poll.disclosed")
     DISCLOSED,
 
     /**
      * Results should be only revealed when the poll is ended.
      */
     @Json(name = "org.matrix.msc3381.poll.undisclosed")
+    UNDISCLOSED_UNSTABLE,
+
+    @Json(name = "m.poll.undisclosed")
     UNDISCLOSED
 }