Update dependency org.matrix.rustcomponents:sdk-android to v0.2.60 (#3827)

* Update dependency org.matrix.rustcomponents:sdk-android to v0.2.60 * Fix SDK API breaks: - Map new `QueueWedgeError` cases. - Add `MediaUploadOnSendQueue` feature flag enabled on debug and nightly builds: this will by used by `Timeline.send*` media functions fot its new `useSendQueue` parameter. --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Jorge Martín <jorgem@element.io>
2024-11-07 15:25:55 +01:00 · 2024-11-07 15:25:55 +01:00 · a6fedbafbd
commit a6fedbafbd
parent 2386350abb
10 changed files with 61 additions and 16 deletions
--- a/gradle/libs.versions.toml
+++ b/gradle/libs.versions.toml
@ -173,7 +173,7 @@ jsoup = "org.jsoup:jsoup:1.18.1"
 appyx_core = { module = "com.bumble.appyx:core", version.ref = "appyx" }
 molecule-runtime = "app.cash.molecule:molecule-runtime:2.0.0"
 timber = "com.jakewharton.timber:timber:5.0.1"
-matrix_sdk = "org.matrix.rustcomponents:sdk-android:0.2.59"
+matrix_sdk = "org.matrix.rustcomponents:sdk-android:0.2.60"
 matrix_richtexteditor = { module = "io.element.android:wysiwyg", version.ref = "wysiwyg" }
 matrix_richtexteditor_compose = { module = "io.element.android:wysiwyg-compose", version.ref = "wysiwyg" }
 sqldelight-driver-android = { module = "app.cash.sqldelight:android-driver", version.ref = "sqldelight" }
--- a/libraries/featureflag/api/src/main/kotlin/io/element/android/libraries/featureflag/api/FeatureFlags.kt
+++ b/libraries/featureflag/api/src/main/kotlin/io/element/android/libraries/featureflag/api/FeatureFlags.kt
@ -9,6 +9,7 @@ package io.element.android.libraries.featureflag.api

 import io.element.android.appconfig.OnBoardingConfig
 import io.element.android.libraries.core.meta.BuildMeta
+import io.element.android.libraries.core.meta.BuildType

 /**
 * To enable or disable a FeatureFlags, change the `defaultValue` value.
@ -132,4 +133,11 @@ enum class FeatureFlags(
        defaultValue = { false },
        isFinished = false,
    ),
+    MediaUploadOnSendQueue(
+        key = "feature.media_upload_through_send_queue",
+        title = "Media upload through send queue",
+        description = "Experimental support for treating media uploads as regular events, with an improved retry and cancellation implementation.",
+        defaultValue = { buildMeta -> buildMeta.buildType != BuildType.RELEASE },
+        isFinished = false,
+    ),
 }
--- a/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/timeline/item/event/LocalEventSendState.kt
+++ b/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/timeline/item/event/LocalEventSendState.kt
@ -34,6 +34,10 @@ sealed interface LocalEventSendState {
             */
            val users: List<UserId>
        ) : VerifiedUser
+
+        data class InvalidMimeType(val mimeType: String) : Failed
+
+        data object MissingMediaContent : Failed
    }

    data class Sent(
--- a/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/RustMatrixClient.kt
+++ b/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/RustMatrixClient.kt
@ -12,6 +12,7 @@ import io.element.android.libraries.androidutils.file.safeDelete
 import io.element.android.libraries.core.bool.orFalse
 import io.element.android.libraries.core.coroutine.CoroutineDispatchers
 import io.element.android.libraries.core.coroutine.childScope
+import io.element.android.libraries.featureflag.api.FeatureFlagService
 import io.element.android.libraries.matrix.api.MatrixClient
 import io.element.android.libraries.matrix.api.core.DeviceId
 import io.element.android.libraries.matrix.api.core.ProgressCallback
@ -125,6 +126,7 @@ class RustMatrixClient(
    baseCacheDirectory: File,
    clock: SystemClock,
    timelineEventTypeFilterFactory: TimelineEventTypeFilterFactory,
+    featureFlagService: FeatureFlagService,
 ) : MatrixClient {
    override val sessionId: UserId = UserId(client.userId())
    override val deviceId: DeviceId = DeviceId(client.deviceId())
@ -188,6 +190,7 @@ class RustMatrixClient(
        roomContentForwarder = RoomContentForwarder(innerRoomListService),
        roomSyncSubscriber = roomSyncSubscriber,
        timelineEventTypeFilterFactory = timelineEventTypeFilterFactory,
+        featureFlagService = featureFlagService,
    )

    override val mediaLoader: MatrixMediaLoader = RustMediaLoader(
--- a/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/RustMatrixClientFactory.kt
+++ b/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/RustMatrixClientFactory.kt
@ -82,6 +82,7 @@ class RustMatrixClientFactory @Inject constructor(
            baseCacheDirectory = cacheDirectory,
            clock = clock,
            timelineEventTypeFilterFactory = timelineEventTypeFilterFactory,
+            featureFlagService = featureFlagService,
        ).also {
            Timber.tag(it.toString()).d("Creating Client with access token '$anonymizedAccessToken' and refresh token '$anonymizedRefreshToken'")
        }
--- a/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/room/RustMatrixRoom.kt
+++ b/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/room/RustMatrixRoom.kt
@ -10,6 +10,7 @@ package io.element.android.libraries.matrix.impl.room
 import io.element.android.libraries.core.coroutine.CoroutineDispatchers
 import io.element.android.libraries.core.coroutine.childScope
 import io.element.android.libraries.core.extensions.mapFailure
+import io.element.android.libraries.featureflag.api.FeatureFlagService
 import io.element.android.libraries.matrix.api.core.DeviceId
 import io.element.android.libraries.matrix.api.core.EventId
 import io.element.android.libraries.matrix.api.core.ProgressCallback
@ -103,6 +104,7 @@ class RustMatrixRoom(
    private val roomContentForwarder: RoomContentForwarder,
    private val roomSyncSubscriber: RoomSyncSubscriber,
    private val matrixRoomInfoMapper: MatrixRoomInfoMapper,
+    private val featureFlagService: FeatureFlagService,
 ) : MatrixRoom {
    override val roomId = RoomId(innerRoom.id())

@ -700,6 +702,7 @@ class RustMatrixRoom(
            dispatcher = roomDispatcher,
            roomContentForwarder = roomContentForwarder,
            onNewSyncedEvent = onNewSyncedEvent,
+            featureFlagsService = featureFlagService,
        )
    }
 }
--- a/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/room/RustRoomFactory.kt
+++ b/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/room/RustRoomFactory.kt
@ -10,6 +10,7 @@ package io.element.android.libraries.matrix.impl.room
 import androidx.collection.lruCache
 import io.element.android.appconfig.TimelineConfig
 import io.element.android.libraries.core.coroutine.CoroutineDispatchers
+import io.element.android.libraries.featureflag.api.FeatureFlagService
 import io.element.android.libraries.matrix.api.core.DeviceId
 import io.element.android.libraries.matrix.api.core.RoomId
 import io.element.android.libraries.matrix.api.core.SessionId
@ -49,6 +50,7 @@ class RustRoomFactory(
    private val innerRoomListService: InnerRoomListService,
    private val roomSyncSubscriber: RoomSyncSubscriber,
    private val timelineEventTypeFilterFactory: TimelineEventTypeFilterFactory,
+    private val featureFlagService: FeatureFlagService,
 ) {
    @OptIn(ExperimentalCoroutinesApi::class)
    private val dispatcher = dispatchers.io.limitedParallelism(1)
@ -117,6 +119,7 @@ class RustRoomFactory(
                roomContentForwarder = roomContentForwarder,
                roomSyncSubscriber = roomSyncSubscriber,
                matrixRoomInfoMapper = matrixRoomInfoMapper,
+                featureFlagService = featureFlagService,
            )
        }
    }
--- a/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/timeline/RustTimeline.kt
+++ b/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/timeline/RustTimeline.kt
@ -7,6 +7,8 @@

 package io.element.android.libraries.matrix.impl.timeline

+import io.element.android.libraries.featureflag.api.FeatureFlagService
+import io.element.android.libraries.featureflag.api.FeatureFlags
 import io.element.android.libraries.matrix.api.core.EventId
 import io.element.android.libraries.matrix.api.core.ProgressCallback
 import io.element.android.libraries.matrix.api.core.RoomId
@ -85,6 +87,7 @@ class RustTimeline(
    private val coroutineScope: CoroutineScope,
    private val dispatcher: CoroutineDispatcher,
    private val roomContentForwarder: RoomContentForwarder,
+    private val featureFlagsService: FeatureFlagService,
    onNewSyncedEvent: () -> Unit,
 ) : Timeline {
    private val initLatch = CompletableDeferred<Unit>()
@ -330,6 +333,7 @@ class RustTimeline(
        formattedCaption: String?,
        progressCallback: ProgressCallback?,
    ): Result<MediaUploadHandler> {
+        val useSendQueue = featureFlagsService.isFeatureEnabled(FeatureFlags.MediaUploadOnSendQueue)
        return sendAttachment(listOfNotNull(file, thumbnailFile)) {
            inner.sendImage(
                url = file.path,
@ -339,7 +343,7 @@ class RustTimeline(
                formattedCaption = formattedCaption?.let {
                    FormattedBody(body = it, format = MessageFormat.Html)
                },
-                storeInCache = true,
+                useSendQueue = useSendQueue,
                progressWatcher = progressCallback?.toProgressWatcher()
            )
        }
@ -353,6 +357,7 @@ class RustTimeline(
        formattedCaption: String?,
        progressCallback: ProgressCallback?,
    ): Result<MediaUploadHandler> {
+        val useSendQueue = featureFlagsService.isFeatureEnabled(FeatureFlags.MediaUploadOnSendQueue)
        return sendAttachment(listOfNotNull(file, thumbnailFile)) {
            inner.sendVideo(
                url = file.path,
@ -362,13 +367,14 @@ class RustTimeline(
                formattedCaption = formattedCaption?.let {
                    FormattedBody(body = it, format = MessageFormat.Html)
                },
-                storeInCache = true,
+                useSendQueue = useSendQueue,
                progressWatcher = progressCallback?.toProgressWatcher()
            )
        }
    }

    override suspend fun sendAudio(file: File, audioInfo: AudioInfo, progressCallback: ProgressCallback?): Result<MediaUploadHandler> {
+        val useSendQueue = featureFlagsService.isFeatureEnabled(FeatureFlags.MediaUploadOnSendQueue)
        return sendAttachment(listOf(file)) {
            inner.sendAudio(
                url = file.path,
@ -376,15 +382,21 @@ class RustTimeline(
                // Maybe allow a caption in the future?
                caption = null,
                formattedCaption = null,
-                storeInCache = true,
+                useSendQueue = useSendQueue,
                progressWatcher = progressCallback?.toProgressWatcher()
            )
        }
    }

    override suspend fun sendFile(file: File, fileInfo: FileInfo, progressCallback: ProgressCallback?): Result<MediaUploadHandler> {
+        val useSendQueue = featureFlagsService.isFeatureEnabled(FeatureFlags.MediaUploadOnSendQueue)
        return sendAttachment(listOf(file)) {
-            inner.sendFile(file.path, fileInfo.map(), false, progressCallback?.toProgressWatcher())
+            inner.sendFile(
+                url = file.path,
+                fileInfo = fileInfo.map(),
+                useSendQueue = useSendQueue,
+                progressWatcher = progressCallback?.toProgressWatcher(),
+            )
        }
    }

@ -491,17 +503,20 @@ class RustTimeline(
        audioInfo: AudioInfo,
        waveform: List<Float>,
        progressCallback: ProgressCallback?,
-    ): Result<MediaUploadHandler> = sendAttachment(listOf(file)) {
-        inner.sendVoiceMessage(
-            url = file.path,
-            audioInfo = audioInfo.map(),
-            waveform = waveform.toMSC3246range(),
-            // Maybe allow a caption in the future?
-            caption = null,
-            formattedCaption = null,
-            storeInCache = true,
-            progressWatcher = progressCallback?.toProgressWatcher(),
-        )
+    ): Result<MediaUploadHandler> {
+        val useSendQueue = featureFlagsService.isFeatureEnabled(FeatureFlags.MediaUploadOnSendQueue)
+        return sendAttachment(listOf(file)) {
+            inner.sendVoiceMessage(
+                url = file.path,
+                audioInfo = audioInfo.map(),
+                waveform = waveform.toMSC3246range(),
+                // Maybe allow a caption in the future?
+                caption = null,
+                formattedCaption = null,
+                useSendQueue = useSendQueue,
+                progressWatcher = progressCallback?.toProgressWatcher(),
+            )
+        }
    }

    private fun sendAttachment(files: List<File>, handle: () -> SendAttachmentJoinHandle): Result<MediaUploadHandler> {
--- a/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/timeline/item/event/EventTimelineItemMapper.kt
+++ b/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/timeline/item/event/EventTimelineItemMapper.kt
@ -100,6 +100,12 @@ fun RustEventSendState?.map(): LocalEventSendState? {
                        LocalEventSendState.Failed.Unknown(queueWedgeError.msg)
                    }
                }
+                is QueueWedgeError.InvalidMimeType -> {
+                    LocalEventSendState.Failed.InvalidMimeType(queueWedgeError.mimeType)
+                }
+                is QueueWedgeError.MissingMediaContent -> {
+                    LocalEventSendState.Failed.MissingMediaContent
+                }
            }
        }
        is RustEventSendState.Sent -> LocalEventSendState.Sent(EventId(eventId))
--- a/libraries/matrix/impl/src/test/kotlin/io/element/android/libraries/matrix/impl/RustMatrixClientTest.kt
+++ b/libraries/matrix/impl/src/test/kotlin/io/element/android/libraries/matrix/impl/RustMatrixClientTest.kt
@ -8,6 +8,7 @@
 package io.element.android.libraries.matrix.impl

 import com.google.common.truth.Truth.assertThat
+import io.element.android.libraries.featureflag.test.FakeFeatureFlagService
 import io.element.android.libraries.matrix.impl.fixtures.fakes.FakeRustClient
 import io.element.android.libraries.matrix.impl.fixtures.fakes.FakeRustSyncService
 import io.element.android.libraries.matrix.impl.room.FakeTimelineEventTypeFilterFactory
@ -46,5 +47,6 @@ class RustMatrixClientTest {
        baseCacheDirectory = File(""),
        clock = FakeSystemClock(),
        timelineEventTypeFilterFactory = FakeTimelineEventTypeFilterFactory(),
+        featureFlagService = FakeFeatureFlagService(),
    )
 }