From 808bbf33a4e7c395cc5f2dc71164396ed370676e Mon Sep 17 00:00:00 2001 From: Valere Date: Thu, 25 Apr 2024 10:10:08 +0200 Subject: [PATCH] Expected UTDs due to membership support --- .../event/TimelineItemEncryptedView.kt | 37 +++++++++++++++---- gradle/libs.versions.toml | 2 +- .../api/timeline/item/event/EventContent.kt | 3 +- .../api/timeline/item/event/UtdCause.kt | 22 +++++++++++ .../matrix/impl/analytics/UtdTracker.kt | 8 +++- .../item/event/TimelineEventContentMapper.kt | 11 +++++- 6 files changed, 70 insertions(+), 13 deletions(-) create mode 100644 libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/timeline/item/event/UtdCause.kt diff --git a/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/timeline/components/event/TimelineItemEncryptedView.kt b/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/timeline/components/event/TimelineItemEncryptedView.kt index 1b67fce85d..039188b3aa 100644 --- a/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/timeline/components/event/TimelineItemEncryptedView.kt +++ b/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/timeline/components/event/TimelineItemEncryptedView.kt @@ -16,6 +16,7 @@ package io.element.android.features.messages.impl.timeline.components.event +import androidx.compose.foundation.layout.Column import androidx.compose.runtime.Composable import androidx.compose.ui.Modifier import androidx.compose.ui.res.stringResource @@ -25,6 +26,7 @@ import io.element.android.libraries.designsystem.icons.CompoundDrawables import io.element.android.libraries.designsystem.preview.ElementPreview import io.element.android.libraries.designsystem.preview.PreviewsDayNight import io.element.android.libraries.matrix.api.timeline.item.event.UnableToDecryptContent +import io.element.android.libraries.matrix.api.timeline.item.event.UtdCause import io.element.android.libraries.ui.strings.CommonStrings @Composable @@ -33,10 +35,17 @@ fun TimelineItemEncryptedView( onContentLayoutChanged: (ContentAvoidingLayoutData) -> Unit, modifier: Modifier = Modifier ) { + var text = stringResource(id = CommonStrings.common_waiting_for_decryption_key) + var iconId = CompoundDrawables.ic_compound_time + if (content.data is UnableToDecryptContent.Data.MegolmV1AesSha2 && + content.data.utdCause == UtdCause.Membership) { + text = stringResource(id = CommonStrings.common_unable_to_decrypt_no_access) + iconId = CompoundDrawables.ic_compound_block + } TimelineItemInformativeView( - text = stringResource(id = CommonStrings.common_waiting_for_decryption_key), + text = text, iconDescription = stringResource(id = CommonStrings.dialog_title_warning), - iconResourceId = CompoundDrawables.ic_compound_time, + iconResourceId = iconId, onContentLayoutChanged = onContentLayoutChanged, modifier = modifier ) @@ -45,10 +54,22 @@ fun TimelineItemEncryptedView( @PreviewsDayNight @Composable internal fun TimelineItemEncryptedViewPreview() = ElementPreview { - TimelineItemEncryptedView( - content = TimelineItemEncryptedContent( - data = UnableToDecryptContent.Data.Unknown - ), - onContentLayoutChanged = {}, - ) + Column { + TimelineItemEncryptedView( + content = TimelineItemEncryptedContent( + data = UnableToDecryptContent.Data.Unknown + ), + onContentLayoutChanged = {}, + ) + + TimelineItemEncryptedView( + content = TimelineItemEncryptedContent( + data = UnableToDecryptContent.Data.MegolmV1AesSha2( + sessionId = "sessionId", + utdCause = UtdCause.Membership + ) + ), + onContentLayoutChanged = {}, + ) + } } diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index 3f877b3e05..090a65d9f4 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -179,7 +179,7 @@ posthog = "com.posthog:posthog-android:3.1.18" sentry = "io.sentry:sentry-android:7.8.0" # Note: only 0.19.0 will compile properly # main branch can be tested replacing the version with main-SNAPSHOT -matrix_analytics_events = "com.github.matrix-org:matrix-analytics-events:0.15.0" +matrix_analytics_events = "com.github.matrix-org:matrix-analytics-events:0.20.0" # Emojibase matrix_emojibase_bindings = "io.element.android:emojibase-bindings:1.1.3" diff --git a/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/timeline/item/event/EventContent.kt b/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/timeline/item/event/EventContent.kt index 9020a4c853..c0aac298a8 100644 --- a/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/timeline/item/event/EventContent.kt +++ b/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/timeline/item/event/EventContent.kt @@ -63,7 +63,8 @@ data class UnableToDecryptContent( ) : Data data class MegolmV1AesSha2( - val sessionId: String + val sessionId: String, + val utdCause: UtdCause ) : Data data object Unknown : Data diff --git a/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/timeline/item/event/UtdCause.kt b/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/timeline/item/event/UtdCause.kt new file mode 100644 index 0000000000..46e4d62249 --- /dev/null +++ b/libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/timeline/item/event/UtdCause.kt @@ -0,0 +1,22 @@ +/* + * Copyright (c) 2024 New Vector Ltd + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package io.element.android.libraries.matrix.api.timeline.item.event + +enum class UtdCause { + Unknown, + Membership, +} diff --git a/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/analytics/UtdTracker.kt b/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/analytics/UtdTracker.kt index 578782d6c2..e8f09d1686 100644 --- a/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/analytics/UtdTracker.kt +++ b/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/analytics/UtdTracker.kt @@ -21,6 +21,7 @@ import io.element.android.services.analytics.api.AnalyticsService import org.matrix.rustcomponents.sdk.UnableToDecryptDelegate import org.matrix.rustcomponents.sdk.UnableToDecryptInfo import timber.log.Timber +import uniffi.matrix_sdk_crypto.UtdCause import javax.inject.Inject class UtdTracker @Inject constructor( @@ -28,6 +29,10 @@ class UtdTracker @Inject constructor( ) : UnableToDecryptDelegate { override fun onUtd(info: UnableToDecryptInfo) { Timber.d("onUtd for event ${info.eventId}, timeToDecryptMs: ${info.timeToDecryptMs}") + val name = when (info.cause) { + UtdCause.UNKNOWN -> Error.Name.OlmKeysNotSentError + UtdCause.MEMBERSHIP -> Error.Name.ExpectedDueToMembership + } val event = Error( context = null, // Keep cryptoModule for compatibility. @@ -35,8 +40,7 @@ class UtdTracker @Inject constructor( cryptoSDK = Error.CryptoSDK.Rust, timeToDecryptMillis = info.timeToDecryptMs?.toInt() ?: -1, domain = Error.Domain.E2EE, - // TODO get a more specific error name from `info` - name = Error.Name.OlmKeysNotSentError, + name = name, ) analyticsService.capture(event) } diff --git a/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/timeline/item/event/TimelineEventContentMapper.kt b/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/timeline/item/event/TimelineEventContentMapper.kt index 4e9ff6b98b..14ea994d38 100644 --- a/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/timeline/item/event/TimelineEventContentMapper.kt +++ b/libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/timeline/item/event/TimelineEventContentMapper.kt @@ -31,6 +31,7 @@ import io.element.android.libraries.matrix.api.timeline.item.event.StateContent import io.element.android.libraries.matrix.api.timeline.item.event.StickerContent import io.element.android.libraries.matrix.api.timeline.item.event.UnableToDecryptContent import io.element.android.libraries.matrix.api.timeline.item.event.UnknownContent +import io.element.android.libraries.matrix.api.timeline.item.event.UtdCause import io.element.android.libraries.matrix.impl.media.map import io.element.android.libraries.matrix.impl.poll.map import kotlinx.collections.immutable.toImmutableList @@ -41,6 +42,7 @@ import org.matrix.rustcomponents.sdk.use import org.matrix.rustcomponents.sdk.EncryptedMessage as RustEncryptedMessage import org.matrix.rustcomponents.sdk.MembershipChange as RustMembershipChange import org.matrix.rustcomponents.sdk.OtherState as RustOtherState +import uniffi.matrix_sdk_crypto.UtdCause as RustUtdCause class TimelineEventContentMapper(private val eventMessageMapper: EventMessageMapper = EventMessageMapper()) { fun map(content: TimelineItemContent): EventContent { @@ -148,6 +150,13 @@ private fun RustMembershipChange.map(): MembershipChange { } } +private fun RustUtdCause.map(): UtdCause { + return when (this) { + RustUtdCause.MEMBERSHIP -> UtdCause.Membership + RustUtdCause.UNKNOWN -> UtdCause.Unknown + } +} + // TODO extract state events? private fun RustOtherState.map(): OtherState { return when (this) { @@ -177,7 +186,7 @@ private fun RustOtherState.map(): OtherState { private fun RustEncryptedMessage.map(): UnableToDecryptContent.Data { return when (this) { - is RustEncryptedMessage.MegolmV1AesSha2 -> UnableToDecryptContent.Data.MegolmV1AesSha2(sessionId) + is RustEncryptedMessage.MegolmV1AesSha2 -> UnableToDecryptContent.Data.MegolmV1AesSha2(sessionId, cause.map()) is RustEncryptedMessage.OlmV1Curve25519AesSha2 -> UnableToDecryptContent.Data.OlmV1Curve25519AesSha2(senderKey) RustEncryptedMessage.Unknown -> UnableToDecryptContent.Data.Unknown }