Show loading and failure feedback when updating user status

features/preferences/impl/src/main/kotlin/io/element/android/features/preferences/impl/root/PreferencesRootView.kt

@@ -9,9 +9,12 @@
 package io.element.android.features.preferences.impl.root
 
 import androidx.compose.foundation.clickable
+import androidx.compose.foundation.layout.Box
+import androidx.compose.foundation.layout.BoxScope
 import androidx.compose.foundation.layout.ColumnScope
 import androidx.compose.foundation.layout.fillMaxWidth
 import androidx.compose.foundation.layout.padding
+import androidx.compose.foundation.layout.statusBarsPadding
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.remember
 import androidx.compose.ui.Alignment
@@ -26,7 +29,10 @@ import io.element.android.features.preferences.impl.R
 import io.element.android.features.preferences.impl.user.UserPreferences
 import io.element.android.features.preferences.impl.userstatus.UserStatusState
 import io.element.android.features.preferences.impl.userstatus.UserStatusView
+import io.element.android.libraries.architecture.AsyncAction
 import io.element.android.libraries.architecture.coverage.ExcludeFromCoverage
+import io.element.android.libraries.designsystem.components.async.AsyncActionIndicator
+import io.element.android.libraries.designsystem.components.async.AsyncIndicator
 import io.element.android.libraries.designsystem.components.avatar.AvatarSize
 import io.element.android.libraries.designsystem.components.list.ListItemContent
 import io.element.android.libraries.designsystem.components.preferences.PreferencePage
@@ -73,72 +79,88 @@ fun PreferencesRootView(
 ) {
     val snackbarHostState = rememberSnackbarHostState(snackbarMessage = state.snackbarMessage)
 
-    // Include pref from other modules
-    PreferencePage(
-        modifier = modifier,
-        onBackClick = onBackClick,
-        title = stringResource(id = CommonStrings.common_settings),
-        snackbarHost = { SnackbarHost(snackbarHostState) }
-    ) {
-        UserPreferences(
-            modifier = Modifier.clickable {
-                onOpenUserProfile(state.myUser)
-            },
-            matrixUser = state.myUser,
-        )
-        if (state.isMultiAccountEnabled) {
-            MultiAccountSection(
-                state = state,
-                onAddAccountClick = onAddAccountClick,
+    Box(modifier = modifier) {
+        // Include pref from other modules
+        PreferencePage(
+            onBackClick = onBackClick,
+            title = stringResource(id = CommonStrings.common_settings),
+            snackbarHost = { SnackbarHost(snackbarHostState) }
+        ) {
+            UserPreferences(
+                modifier = Modifier.clickable {
+                    onOpenUserProfile(state.myUser)
+                },
+                matrixUser = state.myUser,
             )
-        }
-        if (state.userStatusState != null) {
-            UserStatusSection(
-                userStatusState = state.userStatusState,
-                emojiPickerRenderer = emojiPickerRenderer,
-                showTopDivider = !state.isMultiAccountEnabled,
-            )
-        }
-        // 'Account' section
-        ManageAccountSection(
-            state = state,
-            onManageAccountClick = onManageAccountClick,
-            onLinkNewDeviceClick = onLinkNewDeviceClick,
-            onOpenBlockedUsers = onOpenBlockedUsers
-        )
-        // 'Manage my app' section
-        ManageAppSection(
-            state = state,
-            onOpenNotificationSettings = onOpenNotificationSettings,
-            onOpenLockScreenSettings = onOpenLockScreenSettings,
-            onSecureBackupClick = onSecureBackupClick,
-        )
-
-        // General section
-        GeneralSection(
-            state = state,
-            onOpenAbout = onOpenAbout,
-            onOpenAnalytics = onOpenAnalytics,
-            onOpenRageShake = onOpenRageShake,
-            onOpenAdvancedSettings = onOpenAdvancedSettings,
-            onOpenDeveloperSettings = onOpenDeveloperSettings,
-            onOpenLabs = onOpenLabs,
-            onSignOutClick = onSignOutClick,
-            onDeactivateClick = onDeactivateClick,
-        )
-        // Version
-        Footer(
-            version = state.version,
-            deviceId = state.deviceId,
-            onClick = if (!state.showDeveloperSettings) {
-                { state.eventSink(PreferencesRootEvent.OnVersionInfoClick) }
-            } else {
-                null
+            if (state.isMultiAccountEnabled) {
+                MultiAccountSection(
+                    state = state,
+                    onAddAccountClick = onAddAccountClick,
+                )
             }
-        )
+            if (state.userStatusState != null) {
+                UserStatusSection(
+                    userStatusState = state.userStatusState,
+                    emojiPickerRenderer = emojiPickerRenderer,
+                    showTopDivider = !state.isMultiAccountEnabled,
+                )
+            }
+            // 'Account' section
+            ManageAccountSection(
+                state = state,
+                onManageAccountClick = onManageAccountClick,
+                onLinkNewDeviceClick = onLinkNewDeviceClick,
+                onOpenBlockedUsers = onOpenBlockedUsers
+            )
+            // 'Manage my app' section
+            ManageAppSection(
+                state = state,
+                onOpenNotificationSettings = onOpenNotificationSettings,
+                onOpenLockScreenSettings = onOpenLockScreenSettings,
+                onSecureBackupClick = onSecureBackupClick,
+            )
+
+            // General section
+            GeneralSection(
+                state = state,
+                onOpenAbout = onOpenAbout,
+                onOpenAnalytics = onOpenAnalytics,
+                onOpenRageShake = onOpenRageShake,
+                onOpenAdvancedSettings = onOpenAdvancedSettings,
+                onOpenDeveloperSettings = onOpenDeveloperSettings,
+                onOpenLabs = onOpenLabs,
+                onSignOutClick = onSignOutClick,
+                onDeactivateClick = onDeactivateClick,
+            )
+            // Version
+            Footer(
+                version = state.version,
+                deviceId = state.deviceId,
+                onClick = if (!state.showDeveloperSettings) {
+                    { state.eventSink(PreferencesRootEvent.OnVersionInfoClick) }
+                } else {
+                    null
+                }
+            )
+        }
+        state.userStatusState?.let {
+            UserStatusUpdateIndicator(it.updateStatusAction)
+        }
     }
 }
 
+@Composable
+private fun BoxScope.UserStatusUpdateIndicator(updateStatusAction: AsyncAction<Unit>) {
+    AsyncActionIndicator(
+        asyncAction = updateStatusAction,
+        modifier = Modifier
+            .align(Alignment.TopCenter)
+            .statusBarsPadding(),
+        loading = { AsyncIndicator.Loading(text = stringResource(CommonStrings.common_saving)) },
+        failure = { _ -> AsyncIndicator.Failure(text = stringResource(CommonStrings.common_failed)) },
+    )
+}
+
 @Composable
 private fun ColumnScope.UserStatusSection(
     userStatusState: UserStatusState,

features/preferences/impl/src/main/kotlin/io/element/android/features/preferences/impl/userstatus/UserStatusPresenter.kt

@@ -18,7 +18,9 @@ import androidx.compose.runtime.remember
 import androidx.compose.runtime.rememberCoroutineScope
 import androidx.compose.runtime.setValue
 import dev.zacsweers.metro.Inject
+import io.element.android.libraries.architecture.AsyncAction
 import io.element.android.libraries.architecture.Presenter
+import io.element.android.libraries.architecture.runUpdatingState
 import io.element.android.libraries.emoji.api.picker.EmojiPickerPresenter
 import io.element.android.libraries.emoji.api.recentemojis.EmptyGetRecentEmojis
 import io.element.android.libraries.matrix.api.MatrixClient
@@ -38,6 +40,7 @@ class UserStatusPresenter(
         var isEmojiPickerVisible by remember { mutableStateOf(false) }
         val customTextFieldState = rememberTextFieldState()
         val coroutineScope = rememberCoroutineScope()
+        val updateStatusAction = remember { mutableStateOf<AsyncAction<Unit>>(AsyncAction.Uninitialized) }
 
         fun handleEvent(event: UserStatusEvent) {
             when (event) {
@@ -47,11 +50,15 @@ class UserStatusPresenter(
                 UserStatusEvent.CancelCustomInput -> pickerState = UserStatusPickerState.Hidden
                 is UserStatusEvent.SetStatus -> {
                     pickerState = UserStatusPickerState.Hidden
-                    coroutineScope.launch { matrixClient.setUserStatus(event.status) }
+                    coroutineScope.launch {
+                        updateStatusAction.runUpdatingState { matrixClient.setUserStatus(event.status) }
+                    }
                 }
                 UserStatusEvent.ClearStatus -> {
                     pickerState = UserStatusPickerState.Hidden
-                    coroutineScope.launch { matrixClient.clearUserStatus() }
+                    coroutineScope.launch {
+                        updateStatusAction.runUpdatingState { matrixClient.clearUserStatus() }
+                    }
                 }
                 UserStatusEvent.OpenCustomInput -> {
                     val raw = userProfile.rawStatus
@@ -93,6 +100,7 @@ class UserStatusPresenter(
             displayedStatus = userProfile.displayedStatus,
             rawStatus = userProfile.rawStatus,
             pickerState = effectivePickerState,
+            updateStatusAction = updateStatusAction.value,
             eventSink = ::handleEvent,
         )
     }

features/preferences/impl/src/main/kotlin/io/element/android/features/preferences/impl/userstatus/UserStatusState.kt

@@ -11,6 +11,7 @@ import androidx.annotation.StringRes
 import androidx.compose.foundation.text.input.TextFieldState
 import androidx.compose.runtime.Immutable
 import io.element.android.features.preferences.impl.R
+import io.element.android.libraries.architecture.AsyncAction
 import io.element.android.libraries.emoji.api.picker.EmojiPickerState
 import io.element.android.libraries.matrix.api.user.DisplayedStatus
 import io.element.android.libraries.matrix.api.user.UserStatus
@@ -19,6 +20,7 @@ data class UserStatusState(
     val displayedStatus: DisplayedStatus?,
     val rawStatus: UserStatus?,
     val pickerState: UserStatusPickerState,
+    val updateStatusAction: AsyncAction<Unit>,
     val eventSink: (UserStatusEvent) -> Unit,
 )
 

features/preferences/impl/src/main/kotlin/io/element/android/features/preferences/impl/userstatus/UserStatusStateProvider.kt

@@ -9,6 +9,7 @@ package io.element.android.features.preferences.impl.userstatus
 
 import androidx.compose.foundation.text.input.TextFieldState
 import androidx.compose.ui.tooling.preview.PreviewParameterProvider
+import io.element.android.libraries.architecture.AsyncAction
 import io.element.android.libraries.matrix.api.user.DisplayedStatus
 import io.element.android.libraries.matrix.api.user.UserStatus
 
@@ -44,10 +45,12 @@ fun aUserStatusState(
     displayedStatus: DisplayedStatus? = null,
     rawStatus: UserStatus? = null,
     pickerState: UserStatusPickerState = UserStatusPickerState.Hidden,
+    updateStatusAction: AsyncAction<Unit> = AsyncAction.Uninitialized,
     eventSink: (UserStatusEvent) -> Unit = {},
 ) = UserStatusState(
     displayedStatus = displayedStatus,
     rawStatus = rawStatus,
     pickerState = pickerState,
+    updateStatusAction = updateStatusAction,
     eventSink = eventSink,
 )

features/preferences/impl/src/test/kotlin/io/element/android/features/preferences/impl/userstatus/UserStatusPresenterTest.kt

@@ -8,9 +8,11 @@
 package io.element.android.features.preferences.impl.userstatus
 
 import com.google.common.truth.Truth.assertThat
+import io.element.android.libraries.architecture.AsyncAction
 import io.element.android.libraries.emoji.test.fakeEmojiPickerPresenterFactory
 import io.element.android.libraries.matrix.api.user.DisplayedStatus
 import io.element.android.libraries.matrix.api.user.UserStatus
+import io.element.android.libraries.matrix.test.AN_EXCEPTION
 import io.element.android.libraries.matrix.test.FakeMatrixClient
 import io.element.android.tests.testutils.test
 import kotlinx.coroutines.test.runTest
@@ -61,6 +63,24 @@ class UserStatusPresenterTest {
             val newState = awaitItem()
             assertThat(newState.pickerState).isEqualTo(UserStatusPickerState.Hidden)
             assertThat(newState.displayedStatus).isEqualTo(DisplayedStatus.UserSet(status))
+            assertThat(newState.updateStatusAction).isInstanceOf(AsyncAction.Success::class.java)
+            assertThat(client.setUserStatusCalled).isTrue()
+        }
+    }
+
+    @Test
+    fun `Set event failure surfaces a Failure action`() = runTest {
+        val client = FakeMatrixClient().apply {
+            setUserStatusResult = Result.failure(AN_EXCEPTION)
+        }
+        createPresenter(client).test {
+            val status = UserStatus(emoji = "💬", text = "In a meeting")
+            awaitItem().eventSink(UserStatusEvent.SetStatus(status))
+            val newState = awaitItem()
+            assertThat(newState.pickerState).isEqualTo(UserStatusPickerState.Hidden)
+            // On failure the SDK does not emit a new profile, so nothing is displayed.
+            assertThat(newState.displayedStatus).isNull()
+            assertThat(newState.updateStatusAction).isInstanceOf(AsyncAction.Failure::class.java)
             assertThat(client.setUserStatusCalled).isTrue()
         }
     }
@@ -121,6 +141,25 @@ class UserStatusPresenterTest {
             val clearedState = awaitItem()
             assertThat(clearedState.pickerState).isEqualTo(UserStatusPickerState.Hidden)
             assertThat(clearedState.displayedStatus).isNull()
+            assertThat(clearedState.updateStatusAction).isInstanceOf(AsyncAction.Success::class.java)
+            assertThat(client.clearUserStatusCalled).isTrue()
+        }
+    }
+
+    @Test
+    fun `Clear event failure surfaces a Failure action`() = runTest {
+        val client = FakeMatrixClient().apply {
+            clearUserStatusResult = Result.failure(AN_EXCEPTION)
+        }
+        createPresenter(client).test {
+            val status = UserStatus(emoji = "☕", text = "Be right back")
+            awaitItem().eventSink(UserStatusEvent.SetStatus(status))
+            awaitItem().eventSink(UserStatusEvent.ClearStatus)
+            val clearedState = awaitItem()
+            assertThat(clearedState.pickerState).isEqualTo(UserStatusPickerState.Hidden)
+            // Clear failed, so the previously set status is still displayed.
+            assertThat(clearedState.displayedStatus).isEqualTo(DisplayedStatus.UserSet(status))
+            assertThat(clearedState.updateStatusAction).isInstanceOf(AsyncAction.Failure::class.java)
             assertThat(client.clearUserStatusCalled).isTrue()
         }
     }