Merge pull request #4574 from element-hq/feature/fga/advanced_settings_moderation_and_safety

change (preferences) : new moderation and safety settings

Author: ganfra

features/joinroom/impl/build.gradle.kts

@@ -35,6 +35,7 @@ dependencies {
     implementation(projects.features.invite.api)
     implementation(projects.features.roomdirectory.api)
     implementation(projects.services.analytics.api)
+    implementation(projects.libraries.preferences.api)
 
     testImplementation(libs.test.junit)
     testImplementation(libs.coroutines.test)
@@ -46,5 +47,6 @@ dependencies {
     testImplementation(projects.libraries.matrix.test)
     testImplementation(projects.tests.testutils)
     testImplementation(libs.androidx.compose.ui.test.junit)
+    testImplementation(projects.libraries.preferences.test)
     testReleaseImplementation(libs.androidx.compose.ui.test.manifest)
 }

features/joinroom/impl/src/main/kotlin/io/element/android/features/joinroom/impl/JoinRoomPresenter.kt

@@ -52,6 +52,7 @@ import io.element.android.libraries.matrix.api.room.join.JoinRoom
 import io.element.android.libraries.matrix.api.room.join.JoinRule
 import io.element.android.libraries.matrix.api.room.preview.RoomPreviewInfo
 import io.element.android.libraries.matrix.ui.model.toInviteSender
+import io.element.android.libraries.preferences.api.store.AppPreferencesStore
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.launch
 import java.util.Optional
@@ -69,6 +70,7 @@ class JoinRoomPresenter @AssistedInject constructor(
     private val forgetRoom: ForgetRoom,
     private val acceptDeclineInvitePresenter: Presenter<AcceptDeclineInviteState>,
     private val buildMeta: BuildMeta,
+    private val appPreferencesStore: AppPreferencesStore,
     private val seenInvitesStore: SeenInvitesStore,
 ) : Presenter<JoinRoomState> {
     interface Factory {
@@ -94,6 +96,9 @@ class JoinRoomPresenter @AssistedInject constructor(
         val forgetRoomAction: MutableState<AsyncAction<Unit>> = remember { mutableStateOf(AsyncAction.Uninitialized) }
         var knockMessage by rememberSaveable { mutableStateOf("") }
         var isDismissingContent by remember { mutableStateOf(false) }
+        val hideInviteAvatars by remember {
+            appPreferencesStore.getHideInviteAvatarsFlow()
+        }.collectAsState(initial = false)
         val contentState by produceState<ContentState>(
             initialValue = ContentState.Loading,
             key1 = roomInfo,
@@ -202,6 +207,7 @@ class JoinRoomPresenter @AssistedInject constructor(
             cancelKnockAction = cancelKnockAction.value,
             applicationName = buildMeta.applicationName,
             knockMessage = knockMessage,
+            hideInviteAvatars = hideInviteAvatars,
             eventSink = ::handleEvents
         )
     }

features/joinroom/impl/src/main/kotlin/io/element/android/features/joinroom/impl/JoinRoomState.kt

@@ -31,6 +31,7 @@ data class JoinRoomState(
     val cancelKnockAction: AsyncAction<Unit>,
     private val applicationName: String,
     val knockMessage: String,
+    val hideInviteAvatars: Boolean,
     val eventSink: (JoinRoomEvents) -> Unit
 ) {
     val isJoinActionUnauthorized = joinAction is AsyncAction.Failure && joinAction.error is JoinRoomFailures.UnauthorizedJoin
@@ -57,6 +58,8 @@ data class JoinRoomState(
         }
         else -> JoinAuthorisationStatus.None
     }
+
+    val hideAvatarsImages = hideInviteAvatars && joinAuthorisationStatus is JoinAuthorisationStatus.IsInvited
 }
 
 @Immutable

features/joinroom/impl/src/main/kotlin/io/element/android/features/joinroom/impl/JoinRoomStateProvider.kt

@@ -171,6 +171,7 @@ fun aJoinRoomState(
     forgetAction: AsyncAction<Unit> = AsyncAction.Uninitialized,
     cancelKnockAction: AsyncAction<Unit> = AsyncAction.Uninitialized,
     knockMessage: String = "",
+    hideInviteAvatars: Boolean = false,
     eventSink: (JoinRoomEvents) -> Unit = {}
 ) = JoinRoomState(
     roomIdOrAlias = roomIdOrAlias,
@@ -182,6 +183,7 @@ fun aJoinRoomState(
     forgetAction = forgetAction,
     applicationName = "AppName",
     knockMessage = knockMessage,
+    hideInviteAvatars = hideInviteAvatars,
     eventSink = eventSink
 )
 

features/joinroom/impl/src/main/kotlin/io/element/android/features/joinroom/impl/JoinRoomView.kt

@@ -97,6 +97,7 @@ fun JoinRoomView(
                     roomIdOrAlias = state.roomIdOrAlias,
                     contentState = state.contentState,
                     knockMessage = state.knockMessage,
+                    hideAvatarsImages = state.hideAvatarsImages,
                     onKnockMessageUpdate = { state.eventSink(JoinRoomEvents.UpdateKnockMessage(it)) },
                 )
             },
@@ -371,6 +372,7 @@ private fun JoinRoomContent(
     roomIdOrAlias: RoomIdOrAlias,
     contentState: ContentState,
     knockMessage: String,
+    hideAvatarsImages: Boolean,
     onKnockMessageUpdate: (String) -> Unit,
     modifier: Modifier = Modifier,
 ) {
@@ -385,13 +387,14 @@ private fun JoinRoomContent(
                         Column(horizontalAlignment = Alignment.CenterHorizontally) {
                             val inviteSender = (contentState.joinAuthorisationStatus as? JoinAuthorisationStatus.IsInvited)?.inviteSender
                             if (inviteSender != null) {
-                                InviteSenderView(inviteSender = inviteSender)
+                                InviteSenderView(inviteSender = inviteSender, hideAvatarImage = hideAvatarsImages)
                                 Spacer(modifier = Modifier.height(32.dp))
                             }
                             DefaultLoadedContent(
                                 modifier = Modifier.verticalScroll(rememberScrollState()),
                                 contentState = contentState,
                                 knockMessage = knockMessage,
+                                hideAvatarImage = hideAvatarsImages,
                                 onKnockMessageUpdate = onKnockMessageUpdate
                             )
                         }
@@ -474,13 +477,14 @@ private fun IsKnockedLoadedContent(modifier: Modifier = Modifier) {
 private fun DefaultLoadedContent(
     contentState: ContentState.Loaded,
     knockMessage: String,
+    hideAvatarImage: Boolean,
     onKnockMessageUpdate: (String) -> Unit,
     modifier: Modifier = Modifier,
 ) {
     RoomPreviewOrganism(
         modifier = modifier,
         avatar = {
-            Avatar(contentState.avatarData(AvatarSize.RoomHeader))
+            Avatar(contentState.avatarData(AvatarSize.RoomHeader), hideImage = hideAvatarImage)
         },
         title = {
             if (contentState.name != null) {

features/joinroom/impl/src/main/kotlin/io/element/android/features/joinroom/impl/di/JoinRoomModule.kt

@@ -22,6 +22,7 @@ import io.element.android.libraries.matrix.api.MatrixClient
 import io.element.android.libraries.matrix.api.core.RoomId
 import io.element.android.libraries.matrix.api.core.RoomIdOrAlias
 import io.element.android.libraries.matrix.api.room.join.JoinRoom
+import io.element.android.libraries.preferences.api.store.AppPreferencesStore
 import java.util.Optional
 
 @Module
@@ -36,6 +37,7 @@ object JoinRoomModule {
         forgetRoom: ForgetRoom,
         acceptDeclineInvitePresenter: Presenter<AcceptDeclineInviteState>,
         buildMeta: BuildMeta,
+        appPreferencesStore: AppPreferencesStore,
         seenInvitesStore: SeenInvitesStore,
     ): JoinRoomPresenter.Factory {
         return object : JoinRoomPresenter.Factory {
@@ -59,6 +61,7 @@ object JoinRoomModule {
                     cancelKnockRoom = cancelKnockRoom,
                     acceptDeclineInvitePresenter = acceptDeclineInvitePresenter,
                     buildMeta = buildMeta,
+                    appPreferencesStore = appPreferencesStore,
                     seenInvitesStore = seenInvitesStore,
                 )
             }

features/joinroom/impl/src/test/kotlin/io/element/android/features/joinroom/impl/JoinRoomPresenterTest.kt

@@ -47,6 +47,8 @@ import io.element.android.libraries.matrix.test.room.aRoomPreviewInfo
 import io.element.android.libraries.matrix.test.room.aRoomSummary
 import io.element.android.libraries.matrix.test.room.join.FakeJoinRoom
 import io.element.android.libraries.matrix.ui.model.toInviteSender
+import io.element.android.libraries.preferences.api.store.AppPreferencesStore
+import io.element.android.libraries.preferences.test.InMemoryAppPreferencesStore
 import io.element.android.tests.testutils.WarmUpRule
 import io.element.android.tests.testutils.lambda.any
 import io.element.android.tests.testutils.lambda.assert
@@ -768,6 +770,7 @@ class JoinRoomPresenterTest {
         forgetRoom: ForgetRoom = FakeForgetRoom(),
         buildMeta: BuildMeta = aBuildMeta(applicationName = "AppName"),
         acceptDeclineInvitePresenter: Presenter<AcceptDeclineInviteState> = Presenter { anAcceptDeclineInviteState() },
+        appPreferencesStore: AppPreferencesStore = InMemoryAppPreferencesStore(),
         seenInvitesStore: SeenInvitesStore = InMemorySeenInvitesStore(),
     ): JoinRoomPresenter {
         return JoinRoomPresenter(
@@ -783,6 +786,7 @@ class JoinRoomPresenterTest {
             forgetRoom = forgetRoom,
             buildMeta = buildMeta,
             acceptDeclineInvitePresenter = acceptDeclineInvitePresenter,
+            appPreferencesStore = appPreferencesStore,
             seenInvitesStore = seenInvitesStore,
         )
     }

features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/timeline/protection/TimelineProtectionPresenter.kt

@@ -16,33 +16,40 @@ import androidx.compose.runtime.remember
 import androidx.compose.runtime.setValue
 import io.element.android.libraries.architecture.Presenter
 import io.element.android.libraries.matrix.api.core.EventId
+import io.element.android.libraries.matrix.api.media.MediaPreviewValue
+import io.element.android.libraries.matrix.api.media.isPreviewEnabled
+import io.element.android.libraries.matrix.api.room.MatrixRoom
 import io.element.android.libraries.preferences.api.store.AppPreferencesStore
 import kotlinx.collections.immutable.toImmutableSet
 import javax.inject.Inject
 
 class TimelineProtectionPresenter @Inject constructor(
     private val appPreferencesStore: AppPreferencesStore,
+    private val room: MatrixRoom,
 ) : Presenter<TimelineProtectionState> {
+    private val allowedEvents = mutableStateOf<Set<EventId>>(setOf())
+
     @Composable
     override fun present(): TimelineProtectionState {
-        val hideMediaContent by remember {
-            appPreferencesStore.doesHideImagesAndVideosFlow()
-        }.collectAsState(initial = false)
-        var allowedEvents by remember { mutableStateOf<Set<EventId>>(setOf()) }
-        val protectionState by remember(hideMediaContent) {
+        val mediaPreviewValue = remember {
+            appPreferencesStore.getTimelineMediaPreviewValueFlow()
+        }.collectAsState(initial = MediaPreviewValue.On)
+        val roomInfo = room.roomInfoFlow.collectAsState()
+        val protectionState by remember {
             derivedStateOf {
-                if (hideMediaContent) {
-                    ProtectionState.RenderOnly(eventIds = allowedEvents.toImmutableSet())
-                } else {
+                val isPreviewEnabled = mediaPreviewValue.value.isPreviewEnabled(roomInfo.value.joinRule)
+                if (isPreviewEnabled) {
                     ProtectionState.RenderAll
+                } else {
+                    ProtectionState.RenderOnly(eventIds = allowedEvents.value.toImmutableSet())
                 }
             }
         }
 
         fun handleEvent(event: TimelineProtectionEvent) {
             when (event) {
                 is TimelineProtectionEvent.ShowContent -> {
-                    allowedEvents = allowedEvents + setOfNotNull(event.eventId)
+                    allowedEvents.value = allowedEvents.value + setOfNotNull(event.eventId)
                 }
             }
         }

features/messages/impl/src/test/kotlin/io/element/android/features/messages/impl/timeline/protection/TimelineProtectionPresenterTest.kt

@@ -8,7 +8,12 @@
 package io.element.android.features.messages.impl.timeline.protection
 
 import com.google.common.truth.Truth.assertThat
+import io.element.android.libraries.matrix.api.media.MediaPreviewValue
+import io.element.android.libraries.matrix.api.room.MatrixRoom
+import io.element.android.libraries.matrix.api.room.join.JoinRule
 import io.element.android.libraries.matrix.test.AN_EVENT_ID
+import io.element.android.libraries.matrix.test.room.FakeMatrixRoom
+import io.element.android.libraries.matrix.test.room.aRoomInfo
 import io.element.android.libraries.preferences.api.store.AppPreferencesStore
 import io.element.android.libraries.preferences.test.InMemoryAppPreferencesStore
 import io.element.android.tests.testutils.WarmUpRule
@@ -32,8 +37,8 @@ class TimelineProtectionPresenterTest {
     }
 
     @Test
-    fun `present - protected`() = runTest {
-        val appPreferencesStore = InMemoryAppPreferencesStore(hideImagesAndVideos = true)
+    fun `present - media preview value off`() = runTest {
+        val appPreferencesStore = InMemoryAppPreferencesStore(timelineMediaPreviewValue = MediaPreviewValue.Off)
         val presenter = createPresenter(appPreferencesStore)
         presenter.test {
             skipItems(1)
@@ -47,9 +52,42 @@ class TimelineProtectionPresenterTest {
         }
     }
 
+    @Test
+    fun `present - media preview value private in public room`() = runTest {
+        val appPreferencesStore = InMemoryAppPreferencesStore(timelineMediaPreviewValue = MediaPreviewValue.Private)
+        val room = FakeMatrixRoom(initialRoomInfo = aRoomInfo(joinRule = JoinRule.Public))
+        val presenter = createPresenter(appPreferencesStore, room)
+        presenter.test {
+            skipItems(1)
+            val initialState = awaitItem()
+            assertThat(initialState.protectionState).isEqualTo(ProtectionState.RenderOnly(persistentSetOf()))
+            // ShowContent with null should have no effect.
+            initialState.eventSink(TimelineProtectionEvent.ShowContent(eventId = null))
+            initialState.eventSink(TimelineProtectionEvent.ShowContent(eventId = AN_EVENT_ID))
+            val finalState = awaitItem()
+            assertThat(finalState.protectionState).isEqualTo(ProtectionState.RenderOnly(persistentSetOf(AN_EVENT_ID)))
+        }
+    }
+
+    @Test
+    fun `present - media preview value private in non public room`() = runTest {
+        val appPreferencesStore = InMemoryAppPreferencesStore(timelineMediaPreviewValue = MediaPreviewValue.Private)
+        val room = FakeMatrixRoom(initialRoomInfo = aRoomInfo(joinRule = JoinRule.Invite))
+        val presenter = createPresenter(appPreferencesStore, room)
+        presenter.test {
+            val initialState = awaitItem()
+            assertThat(initialState.protectionState).isEqualTo(ProtectionState.RenderAll)
+            // ShowContent with null should have no effect.
+            initialState.eventSink(TimelineProtectionEvent.ShowContent(eventId = null))
+            initialState.eventSink(TimelineProtectionEvent.ShowContent(eventId = AN_EVENT_ID))
+        }
+    }
+
     private fun createPresenter(
         appPreferencesStore: AppPreferencesStore = InMemoryAppPreferencesStore(),
+        room: MatrixRoom = FakeMatrixRoom(),
     ) = TimelineProtectionPresenter(
         appPreferencesStore = appPreferencesStore,
+        room = room,
     )
 }

features/preferences/impl/src/main/kotlin/io/element/android/features/preferences/impl/advanced/AdvancedSettingsEvents.kt

@@ -8,6 +8,7 @@
 package io.element.android.features.preferences.impl.advanced
 
 import io.element.android.compound.theme.Theme
+import io.element.android.libraries.matrix.api.media.MediaPreviewValue
 
 sealed interface AdvancedSettingsEvents {
     data class SetDeveloperModeEnabled(val enabled: Boolean) : AdvancedSettingsEvents
@@ -16,4 +17,6 @@ sealed interface AdvancedSettingsEvents {
     data object ChangeTheme : AdvancedSettingsEvents
     data object CancelChangeTheme : AdvancedSettingsEvents
     data class SetTheme(val theme: Theme) : AdvancedSettingsEvents
+    data class SetTimelineMediaPreviewValue(val value: MediaPreviewValue) : AdvancedSettingsEvents
+    data class SetHideInviteAvatars(val value: Boolean) : AdvancedSettingsEvents
 }