PM-31656, PM-31658, PM-31659: Address Archive feature bugs (#6473)

Author: david-livefront

app/src/main/kotlin/com/x8bit/bitwarden/data/platform/repository/AuthenticatorBridgeRepositoryImpl.kt

@@ -90,8 +90,8 @@ class AuthenticatorBridgeRepositoryImpl(
                 // Vault is unlocked, query vault disk source for totp logins:
                 val totpUris = vaultDiskSource
                     .getTotpCiphers(userId = userId)
-                    // Filter out any deleted ciphers.
-                    .filter { it.deletedDate == null }
+                    // Filter out any deleted and archived ciphers.
+                    .filter { it.deletedDate == null && it.archivedDate == null }
                     .mapNotNull {
                         scopedVaultSdkSource
                             .decryptCipher(userId = userId, cipher = it.toEncryptedSdkCipher())

app/src/main/kotlin/com/x8bit/bitwarden/data/vault/manager/CipherManagerImpl.kt

@@ -191,6 +191,10 @@ class CipherManagerImpl(
                     userId = userId,
                     cipher = it.toEncryptedNetworkCipherResponse(),
                 )
+                settingsDiskSource.storeIntroducingArchiveActionCardDismissed(
+                    userId = userId,
+                    isDismissed = true,
+                )
             }
             .fold(
                 onSuccess = { ArchiveCipherResult.Success },

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

@@ -501,7 +501,7 @@ private fun ActionCard(
                         tint = BitwardenTheme.colorScheme.icon.secondary,
                     )
                 },
-                onActionClick = vaultHandlers.archiveClick,
+                onActionClick = { vaultHandlers.actionCardClick(actionCardState) },
                 onDismissClick = { vaultHandlers.dismissActionCardClick(actionCardState) },
                 modifier = modifier,
             )

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

@@ -320,6 +320,7 @@ class VaultViewModel @Inject constructor(
 
             VaultAction.UpgradeToPremiumClick -> handleUpgradeToPremiumClick()
             is VaultAction.DismissActionCardClick -> handleDismissActionCardClick(action)
+            is VaultAction.ActionCardClick -> handleActionCardClick(action)
         }
     }
 
@@ -377,6 +378,15 @@ class VaultViewModel @Inject constructor(
         }
     }
 
+    private fun handleActionCardClick(action: VaultAction.ActionCardClick) {
+        when (action.actionCard) {
+            VaultState.ActionCardState.IntroducingArchive -> {
+                settingsRepository.dismissIntroducingArchiveActionCard()
+                sendEvent(VaultEvent.NavigateToItemListing(VaultItemListingType.Archive))
+            }
+        }
+    }
+
     private fun handleSelectAddItemType() {
         // If policy is enable for any organization, exclude the card option
         val excludedOptions = persistentListOfNotNull(
@@ -572,7 +582,18 @@ class VaultViewModel @Inject constructor(
     }
 
     private fun handleArchiveClick() {
-        sendEvent(VaultEvent.NavigateToItemListing(VaultItemListingType.Archive))
+        val archivedItemsCount = (state.viewState as? VaultState.ViewState.Content)
+            ?.archivedItemsCount
+            ?: 0
+        if (state.isPremium || archivedItemsCount > 0) {
+            // We still navigate even if the user does not have premium, since they have previously
+            // archived ciphers to view.
+            sendEvent(VaultEvent.NavigateToItemListing(VaultItemListingType.Archive))
+        } else {
+            mutableStateFlow.update {
+                it.copy(dialog = VaultState.DialogState.ArchiveRequiresPremium)
+            }
+        }
     }
 
     private fun handleTrashClick() {
@@ -2189,6 +2210,13 @@ sealed class VaultAction {
         val actionCard: VaultState.ActionCardState,
     ) : VaultAction()
 
+    /**
+     * User clicked the primary button on an action card.
+     */
+    data class ActionCardClick(
+        val actionCard: VaultState.ActionCardState,
+    ) : VaultAction()
+
     /**
      * Models actions that the [VaultViewModel] itself might send.
      */

app/src/main/kotlin/com/x8bit/bitwarden/ui/vault/feature/vault/handlers/VaultHandlers.kt

@@ -52,6 +52,7 @@ data class VaultHandlers(
     val onDismissThirdPartyAutofillDialogClick: () -> Unit,
     val upgradeToPremiumClick: () -> Unit,
     val dismissActionCardClick: (VaultState.ActionCardState) -> Unit,
+    val actionCardClick: (VaultState.ActionCardState) -> Unit,
 ) {
     @Suppress("UndocumentedPublicClass")
     companion object {
@@ -151,6 +152,7 @@ data class VaultHandlers(
                 dismissActionCardClick = {
                     viewModel.trySendAction(VaultAction.DismissActionCardClick(it))
                 },
+                actionCardClick = { viewModel.trySendAction(VaultAction.ActionCardClick(it)) },
             )
     }
 }

app/src/main/kotlin/com/x8bit/bitwarden/ui/vault/feature/vault/util/VaultDataExtensions.kt

@@ -132,6 +132,9 @@ fun VaultData.toViewState(
             noFolderItems.size < NO_FOLDER_ITEM_THRESHOLD
         val totpItems = activeCipherViews.filter { it.login?.totp != null }
         val cardCount = activeCipherViews.count { it.type is CipherListViewType.Card }
+        val archiveCount = allCipherViews.count {
+            it.archivedDate != null && it.deletedDate == null
+        }
         VaultState.ViewState.Content(
             itemTypesCount = itemTypesCount,
             totpItemsCount = if (isPremium) {
@@ -215,15 +218,13 @@ fun VaultData.toViewState(
                     )
                 },
             trashItemsCount = allCipherViews.count { it.deletedDate != null },
-            archivedItemsCount = allCipherViews
-                .count { it.archivedDate != null && it.deletedDate == null }
-                .takeIf { isPremium },
+            archivedItemsCount = archiveCount.takeIf { isPremium || archiveCount > 0 },
             archiveEnabled = isArchiveEnabled,
-            archiveEndIcon = BitwardenDrawable.ic_locked.takeUnless { isPremium },
+            archiveEndIcon = BitwardenDrawable.ic_locked.takeIf { !isPremium && archiveCount == 0 },
             archiveSubText = BitwardenString
                 .premium_subscription_required
                 .asText()
-                .takeUnless { isPremium },
+                .takeIf { !isPremium && archiveCount == 0 },
             showCardGroup = cardCount != 0 || restrictItemTypesPolicyOrgIds.isEmpty(),
         )
     }

app/src/test/kotlin/com/x8bit/bitwarden/data/platform/datasource/disk/util/FakeSettingsDiskSource.kt

@@ -491,6 +491,13 @@ class FakeSettingsDiskSource(
         return storedAppResumeScreenData[userId]?.let { Json.decodeFromStringOrNull(it) }
     }
 
+    /**
+     * Asserts that the stored introducing archive action card dismissed matches the [expected] one.
+     */
+    fun assertIntroducingArchiveActionCardDismissed(userId: String, expected: Boolean?) {
+        assertEquals(expected, storedIntroducingArchiveActionCardDismissed[userId])
+    }
+
     /**
      * Asserts that the stored last sync time matches the [expected] one.
      */

app/src/test/kotlin/com/x8bit/bitwarden/data/platform/repository/AuthenticatorBridgeRepositoryTest.kt

@@ -238,7 +238,7 @@ class AuthenticatorBridgeRepositoryTest {
 
     @Test
     @Suppress("MaxLineLength")
-    fun `getSharedAccounts should unlock and re-lock vault for both users and filter out deleted ciphers`() =
+    fun `getSharedAccounts should unlock and re-lock vault for both users and filter out archived and deleted ciphers`() =
         runTest {
             assertEquals(
                 BOTH_ACCOUNT_SUCCESS,
@@ -499,20 +499,31 @@ private val USER_STATE_JSON = UserStateJson(
 private val USER_1_TOTP_CIPHER = mockk<SyncResponseJson.Cipher> {
     every { login?.totp } returns "encryptedTotp1"
     every { login?.username } returns "username"
+    every { archivedDate } returns null
     every { deletedDate } returns null
     every { name } returns "cipher1"
 }
 
 private val USER_1_DELETED_TOTP_CIPHER = mockk<SyncResponseJson.Cipher> {
     every { login?.totp } returns "encryptedTotp1Deleted"
     every { login?.username } returns "username"
+    every { archivedDate } returns null
     every { deletedDate } returns ZonedDateTime.parse("2023-10-27T12:00:00Z")
     every { name } returns "cipher1"
 }
 
+private val USER_1_ARCHIVED_TOTP_CIPHER = mockk<SyncResponseJson.Cipher> {
+    every { login?.totp } returns "encryptedTotp1Deleted"
+    every { login?.username } returns "username"
+    every { archivedDate } returns ZonedDateTime.parse("2023-10-27T12:00:00Z")
+    every { deletedDate } returns null
+    every { name } returns "cipher1"
+}
+
 private val USER_2_TOTP_CIPHER = mockk<SyncResponseJson.Cipher> {
     every { login?.totp } returns "encryptedTotp2"
     every { login?.username } returns "username"
+    every { archivedDate } returns null
     every { deletedDate } returns null
     every { name } returns "cipher2"
 }
@@ -553,6 +564,7 @@ private val USER_2_SHARED_ACCOUNT = SharedAccountData.Account(
 private val USER_1_CIPHERS = listOf(
     USER_1_TOTP_CIPHER,
     USER_1_DELETED_TOTP_CIPHER,
+    USER_1_ARCHIVED_TOTP_CIPHER,
 )
 
 private val USER_2_CIPHERS = listOf(

app/src/test/kotlin/com/x8bit/bitwarden/data/vault/manager/CipherManagerTest.kt

@@ -744,6 +744,10 @@ class CipherManagerTest {
                 cipher = createMockSdkCipher(number = 1, clock = clock),
             )
             val cipherView = createMockCipherView(number = 1)
+            fakeSettingsDiskSource.storeIntroducingArchiveActionCardDismissed(
+                userId = userId,
+                isDismissed = null,
+            )
             coEvery {
                 vaultSdkSource.encryptCipher(userId = userId, cipherView = cipherView)
             } returns encryptionContext.asSuccess()
@@ -770,6 +774,10 @@ class CipherManagerTest {
                 cipherView = cipherView,
             )
 
+            fakeSettingsDiskSource.assertIntroducingArchiveActionCardDismissed(
+                userId = userId,
+                expected = true,
+            )
             assertEquals(ArchiveCipherResult.Success, result)
         }
 

app/src/test/kotlin/com/x8bit/bitwarden/ui/vault/feature/vault/VaultScreenTest.kt

@@ -1527,7 +1527,11 @@ class VaultScreenTest : BitwardenComposeTest() {
             .performClick()
 
         verify(exactly = 1) {
-            viewModel.trySendAction(VaultAction.ArchiveClick)
+            viewModel.trySendAction(
+                VaultAction.ActionCardClick(
+                    actionCard = VaultState.ActionCardState.IntroducingArchive,
+                ),
+            )
         }
     }