[PM-18210] Cipher key encryption error handling (#5611)

Co-authored-by: Patrick Honkonen <[email protected]>
Co-authored-by: Patrick Honkonen <[email protected]>

Author: andrebispo5

app/src/main/kotlin/com/x8bit/bitwarden/data/vault/repository/VaultRepositoryImpl.kt

@@ -1103,7 +1103,6 @@ class VaultRepositoryImpl(
                     )
                     .fold(
                         onSuccess = { result ->
-                            // TODO (PM-18210): Display decryption result failures
                             DataState.Loaded(
                                 result.copy(successes = result.successes.sortAlphabetically()),
                             )

app/src/main/kotlin/com/x8bit/bitwarden/data/vault/repository/util/VaultSdkCipherExtensions.kt

@@ -14,8 +14,10 @@ import com.bitwarden.network.model.SyncResponseJson
 import com.bitwarden.network.model.UriMatchTypeJson
 import com.bitwarden.vault.Attachment
 import com.bitwarden.vault.Card
+import com.bitwarden.vault.CardListView
 import com.bitwarden.vault.Cipher
 import com.bitwarden.vault.CipherListView
+import com.bitwarden.vault.CipherListViewType
 import com.bitwarden.vault.CipherPermissions
 import com.bitwarden.vault.CipherRepromptType
 import com.bitwarden.vault.CipherType
@@ -26,6 +28,7 @@ import com.bitwarden.vault.Field
 import com.bitwarden.vault.FieldType
 import com.bitwarden.vault.Identity
 import com.bitwarden.vault.Login
+import com.bitwarden.vault.LoginListView
 import com.bitwarden.vault.LoginUri
 import com.bitwarden.vault.PasswordHistory
 import com.bitwarden.vault.SecureNote
@@ -651,3 +654,54 @@ fun EncryptionContext.toEncryptedNetworkCipher(): CipherJsonRequest =
  */
 fun EncryptionContext.toEncryptedNetworkCipherResponse(): SyncResponseJson.Cipher =
     cipher.toEncryptedNetworkCipherResponse(encryptedFor = encryptedFor)
+
+/**
+ * Converts a Bitwarden SDK [Cipher] object to a corresponding
+ * [CipherListView] object with modified field to represent a decryption error instance.
+ * This allows reuse of existing logic for filtering and grouping ciphers to construct
+ * the sections in the vault list.
+ */
+fun Cipher.toFailureCipherListView(): CipherListView =
+    CipherListView(
+        id = id,
+        organizationId = organizationId,
+        folderId = folderId,
+        collectionIds = collectionIds,
+        key = key,
+        name = name,
+        subtitle = "",
+        type = when (type) {
+            CipherType.LOGIN -> CipherListViewType.Login(
+                v1 = LoginListView(
+                    fido2Credentials = null,
+                    hasFido2 = false,
+                    username = null,
+                    totp = null,
+                    uris = null,
+                ),
+            )
+
+            CipherType.SECURE_NOTE -> CipherListViewType.SecureNote
+            CipherType.CARD -> CipherListViewType.Card(
+                CardListView(
+                    brand = null,
+                ),
+            )
+
+            CipherType.IDENTITY -> CipherListViewType.Identity
+            CipherType.SSH_KEY -> CipherListViewType.SshKey
+        },
+        favorite = favorite,
+        reprompt = reprompt,
+        organizationUseTotp = organizationUseTotp,
+        edit = edit,
+        permissions = permissions,
+        viewPassword = viewPassword,
+        attachments = 0.toUInt(),
+        hasOldAttachments = false,
+        localData = null,
+        creationDate = creationDate,
+        deletedDate = deletedDate,
+        revisionDate = revisionDate,
+        copyableFields = emptyList(),
+    )

app/src/main/kotlin/com/x8bit/bitwarden/ui/vault/feature/itemlisting/VaultItemListingContent.kt

@@ -205,7 +205,7 @@ fun VaultItemListingContent(
                 BitwardenListItem(
                     startIcon = it.iconData,
                     startIconTestTag = it.iconTestTag,
-                    label = it.title,
+                    label = it.title.invoke(),
                     labelTestTag = it.titleTestTag,
                     secondSupportingLabel = it.secondSubtitle,
                     secondSupportingLabelTestTag = it.secondSubtitleTestTag,

app/src/main/kotlin/com/x8bit/bitwarden/ui/vault/feature/itemlisting/VaultItemListingScreen.kt

@@ -319,6 +319,13 @@ fun VaultItemListingScreen(
                 )
             }
         },
+        onShareCipherDecryptionErrorClick = remember(viewModel) {
+            {
+                viewModel.trySendAction(
+                    VaultItemListingsAction.ShareCipherDecryptionErrorClick(it),
+                )
+            }
+        },
     )
 
     val vaultItemListingHandlers = remember(viewModel) {
@@ -350,6 +357,7 @@ private fun VaultItemListingDialogs(
     onDismissUserVerification: () -> Unit,
     onVaultItemTypeSelected: (CreateVaultItemType) -> Unit,
     onTrustPrivilegedAppClick: (selectedCipherId: String?) -> Unit,
+    onShareCipherDecryptionErrorClick: (selectedCipherId: String) -> Unit,
 ) {
     when (dialogState) {
         is VaultItemListingState.DialogState.Error -> BitwardenBasicDialog(
@@ -363,6 +371,20 @@ private fun VaultItemListingDialogs(
             text = dialogState.message(),
         )
 
+        is VaultItemListingState.DialogState.CipherDecryptionError -> {
+            BitwardenTwoButtonDialog(
+                title = dialogState.title(),
+                message = dialogState.message(),
+                confirmButtonText = stringResource(BitwardenString.copy_error_report),
+                dismissButtonText = stringResource(BitwardenString.close),
+                onConfirmClick = {
+                    onShareCipherDecryptionErrorClick(dialogState.selectedCipherId)
+                },
+                onDismissClick = onDismissRequest,
+                onDismissRequest = onDismissRequest,
+            )
+        }
+
         is VaultItemListingState.DialogState.CredentialManagerOperationFail -> BitwardenBasicDialog(
             title = dialogState.title(),
             message = dialogState.message(),

app/src/main/kotlin/com/x8bit/bitwarden/ui/vault/feature/itemlisting/VaultItemListingViewModel.kt

@@ -344,6 +344,10 @@ class VaultItemListingViewModel @Inject constructor(
             }
 
             is VaultItemListingsAction.Internal -> handleInternalAction(action)
+
+            is VaultItemListingsAction.ShareCipherDecryptionErrorClick -> {
+                handleShareCipherDecryptionErrorClick(action)
+            }
         }
     }
 
@@ -635,6 +639,16 @@ class VaultItemListingViewModel @Inject constructor(
         sendEvent(VaultItemListingEvent.ShowShareSheet(action.sendUrl))
     }
 
+    private fun handleShareCipherDecryptionErrorClick(
+        action: VaultItemListingsAction.ShareCipherDecryptionErrorClick,
+    ) {
+        sendEvent(
+            event = VaultItemListingEvent.ShowShareSheet(
+                content = action.selectedCipherId,
+            ),
+        )
+    }
+
     private fun handleRemoveSendPasswordClick(
         action: ListingItemOverflowAction.SendAction.RemovePasswordClick,
     ) {
@@ -929,10 +943,30 @@ class VaultItemListingViewModel @Inject constructor(
                     sendType = itemType.type.toSendItemType(),
                 )
             }
+
+            VaultItemListingState.DisplayItem.ItemType.DecryptionError -> {
+                showCipherDecryptionErrorItemClick(itemId = action.id)
+                return
+            }
         }
+
         sendEvent(event)
     }
 
+    private fun showCipherDecryptionErrorItemClick(itemId: String) {
+        mutableStateFlow.update {
+            it.copy(
+                dialogState = VaultItemListingState.DialogState.CipherDecryptionError(
+                    title = BitwardenString.decryption_error.asText(),
+                    message = BitwardenString
+                        .bitwarden_could_not_decrypt_this_vault_item_description_long
+                        .asText(),
+                    selectedCipherId = itemId,
+                ),
+            )
+        }
+    }
+
     private fun handleItemClickForProviderCreateCredentialRequest(
         action: VaultItemListingsAction.ItemClick,
         createCredentialRequest: CreateCredentialRequest,
@@ -2701,6 +2735,16 @@ data class VaultItemListingState(
             val throwable: Throwable? = null,
         ) : DialogState()
 
+        /**
+         * Represents a dialog indicating that a cipher decryption error occurred.
+         */
+        @Parcelize
+        data class CipherDecryptionError(
+            val title: Text,
+            val message: Text,
+            val selectedCipherId: String,
+        ) : DialogState()
+
         /**
          * Represents a dialog indicating that a CredentialManager operation encountered an error.
          */
@@ -2883,7 +2927,7 @@ data class VaultItemListingState(
      */
     data class DisplayItem(
         val id: String,
-        val title: String,
+        val title: Text,
         val titleTestTag: String,
         val secondSubtitle: String?,
         val secondSubtitleTestTag: String?,
@@ -2912,6 +2956,11 @@ data class VaultItemListingState(
              * Indicates the item type is a vault item.
              */
             data class Vault(val type: CipherType) : ItemType()
+
+            /**
+             * Indicates the item type is a decryption error.
+             */
+            object DecryptionError : ItemType()
         }
     }
 
@@ -3336,6 +3385,13 @@ sealed class VaultItemListingsAction {
      */
     data object LockClick : VaultItemListingsAction()
 
+    /**
+     * Click to share cipher decryption error details.
+     */
+    data class ShareCipherDecryptionErrorClick(
+        val selectedCipherId: String,
+    ) : VaultItemListingsAction()
+
     /**
      * Click the refresh button.
      */