[PM-15050] Track vault registration for CXP export in settings

app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/disk/SettingsDiskSource.kt

@@ -319,4 +319,21 @@ interface SettingsDiskSource {
      * Emits updates that track [getShowImportLoginsSettingBadge] for the given [userId].
      */
     fun getShowImportLoginsSettingBadgeFlow(userId: String): Flow<Boolean?>
+
+    /**
+     * Gets whether or not the given [userId] has registered for export via the credential exchange
+     * protocol.
+     */
+    fun getVaultRegisteredForExport(userId: String): Boolean?
+
+    /**
+     * Stores the given value for whether or not the given [userId] has registered for export via
+     * the credential exchange protocol.
+     */
+    fun storeVaultRegisteredForExport(userId: String, isRegistered: Boolean?)
+
+    /**
+     * Emits updates that track [getVaultRegisteredForExport] for the given [userId].
+     */
+    fun getVaultRegisteredForExportFlow(userId: String): Flow<Boolean?>
 }

app/src/main/java/com/x8bit/bitwarden/data/platform/datasource/disk/SettingsDiskSourceImpl.kt

@@ -37,6 +37,7 @@ private const val SHOW_AUTOFILL_SETTING_BADGE = "showAutofillSettingBadge"
 private const val SHOW_UNLOCK_SETTING_BADGE = "showUnlockSettingBadge"
 private const val SHOW_IMPORT_LOGINS_SETTING_BADGE = "showImportLoginsSettingBadge"
 private const val LAST_SCHEME_CHANGE_INSTANT = "lastDatabaseSchemeChangeInstant"
+private const val IS_VAULT_REGISTERED_FOR_EXPORT = "isVaultRegisteredForExport"
 
 /**
  * Primary implementation of [SettingsDiskSource].
@@ -80,6 +81,9 @@ class SettingsDiskSourceImpl(
     private val mutableScreenCaptureAllowedFlowMap =
         mutableMapOf<String, MutableSharedFlow<Boolean?>>()
 
+    private val mutableVaultRegisteredForExportFlow =
+        mutableMapOf<String, MutableSharedFlow<Boolean?>>()
+
     override var appLanguage: AppLanguage?
         get() = getString(key = APP_LANGUAGE_KEY)
             ?.let { storedValue ->
@@ -181,6 +185,7 @@ class SettingsDiskSourceImpl(
         storeLastSyncTime(userId = userId, lastSyncTime = null)
         storeClearClipboardFrequencySeconds(userId = userId, frequency = null)
         removeWithPrefix(prefix = ACCOUNT_BIOMETRIC_INTEGRITY_VALID_KEY.appendIdentifier(userId))
+        storeVaultRegisteredForExport(userId = userId, isRegistered = null)
 
         // The following are intentionally not cleared so they can be
         // restored after logging out and back in:
@@ -443,6 +448,18 @@ class SettingsDiskSourceImpl(
         getMutableShowImportLoginsSettingBadgeFlow(userId)
             .onSubscription { emit(getShowImportLoginsSettingBadge(userId)) }
 
+    override fun getVaultRegisteredForExport(userId: String): Boolean? =
+        getBoolean(IS_VAULT_REGISTERED_FOR_EXPORT.appendIdentifier(userId))
+
+    override fun storeVaultRegisteredForExport(userId: String, isRegistered: Boolean?) {
+        putBoolean(IS_VAULT_REGISTERED_FOR_EXPORT.appendIdentifier(userId), isRegistered)
+        getMutableVaultRegisteredForExportFlow(userId).tryEmit(isRegistered)
+    }
+
+    override fun getVaultRegisteredForExportFlow(userId: String): Flow<Boolean?> =
+        getMutableVaultRegisteredForExportFlow(userId)
+            .onSubscription { emit(getVaultRegisteredForExport(userId)) }
+
     private fun getMutableLastSyncFlow(
         userId: String,
     ): MutableSharedFlow<Instant?> =
@@ -493,4 +510,10 @@ class SettingsDiskSourceImpl(
         mutableShowImportLoginsSettingBadgeFlowMap.getOrPut(userId) {
             bufferedMutableSharedFlow(replay = 1)
         }
+
+    private fun getMutableVaultRegisteredForExportFlow(
+        userId: String,
+    ): MutableSharedFlow<Boolean?> = mutableVaultRegisteredForExportFlow.getOrPut(userId) {
+        bufferedMutableSharedFlow(replay = 1)
+    }
 }

app/src/main/java/com/x8bit/bitwarden/data/platform/repository/SettingsRepository.kt

@@ -264,4 +264,21 @@ interface SettingsRepository {
      * Record that a user has logged in on this device.
      */
     fun storeUserHasLoggedInValue(userId: String)
+
+    /**
+     * Returns true if the given [userId] has previously registered for export via the credential
+     * exchange protocol.
+     */
+    fun isVaultRegisteredForExport(userId: String): Boolean
+
+    /**
+     * Stores that the given [userId] has previously registered for export via the credential
+     * exchange protocol.
+     */
+    fun storeVaultRegisteredForExport(userId: String, isRegistered: Boolean)
+
+    /**
+     * Gets updates for the [isVaultRegisteredForExport] value for the given [userId].
+     */
+    fun getVaultRegisteredForExportFlow(userId: String): StateFlow<Boolean>
 }

app/src/main/java/com/x8bit/bitwarden/data/platform/repository/SettingsRepositoryImpl.kt

@@ -556,6 +556,27 @@ class SettingsRepositoryImpl(
         settingsDiskSource.storeUseHasLoggedInPreviously(userId)
     }
 
+    override fun isVaultRegisteredForExport(userId: String): Boolean {
+        return settingsDiskSource.getVaultRegisteredForExport(userId) == true
+    }
+
+    override fun storeVaultRegisteredForExport(userId: String, isRegistered: Boolean) {
+        settingsDiskSource.storeVaultRegisteredForExport(userId, isRegistered)
+    }
+
+    override fun getVaultRegisteredForExportFlow(userId: String): StateFlow<Boolean> {
+        return settingsDiskSource
+            .getVaultRegisteredForExportFlow(userId)
+            .map { it ?: false }
+            .stateIn(
+                scope = unconfinedScope,
+                started = SharingStarted.Eagerly,
+                initialValue = settingsDiskSource
+                    .getVaultRegisteredForExport(userId)
+                    ?: false,
+            )
+    }
+
     /**
      * If there isn't already one generated, generate a symmetric sync key that would be used
      * for communicating via IPC.

app/src/test/java/com/x8bit/bitwarden/data/platform/datasource/disk/SettingsDiskSourceTest.kt

@@ -1208,4 +1208,38 @@ class SettingsDiskSourceTest {
             assertFalse(awaitItem() ?: true)
         }
     }
+
+    @Test
+    fun `getVaultRegisteredForExport should pull from SharedPreferences`() {
+        val mockUserId = "mockUserId"
+        val vaultRegisteredForExportKey =
+            "bwPreferencesStorage:isVaultRegisteredForExport_$mockUserId"
+        fakeSharedPreferences.edit {
+            putBoolean(vaultRegisteredForExportKey, true)
+        }
+        assertTrue(settingsDiskSource.getVaultRegisteredForExport(userId = mockUserId)!!)
+    }
+
+    @Test
+    fun `storeVaultRegisteredForExport should update SharedPreferences`() {
+        val mockUserId = "mockUserId"
+        val vaultRegisteredForExportKey =
+            "bwPreferencesStorage:isVaultRegisteredForExport_$mockUserId"
+        settingsDiskSource.storeVaultRegisteredForExport(mockUserId, true)
+        assertTrue(fakeSharedPreferences.getBoolean(vaultRegisteredForExportKey, false))
+    }
+
+    @Test
+    fun `storeVaultRegisteredForExport should update the flow value`() = runTest {
+        val mockUserId = "mockUserId"
+        settingsDiskSource.getVaultRegisteredForExportFlow(mockUserId).test {
+            // The initial values of the Flow are in sync
+            assertFalse(awaitItem() ?: false)
+            settingsDiskSource.storeVaultRegisteredForExport(mockUserId, true)
+            assertTrue(awaitItem() ?: false)
+            // Update the value to false
+            settingsDiskSource.storeVaultRegisteredForExport(mockUserId, false)
+            assertFalse(awaitItem() ?: true)
+        }
+    }
 }

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

@@ -68,6 +68,7 @@ class FakeSettingsDiskSource : SettingsDiskSource {
     private val userShowUnlockBadge = mutableMapOf<String, Boolean?>()
     private val userShowImportLoginsBadge = mutableMapOf<String, Boolean?>()
     private var storedLastDatabaseSchemeChangeInstant: Instant? = null
+    private val vaultRegisteredForExport = mutableMapOf<String, Boolean?>()
 
     private val mutableShowAutoFillSettingBadgeFlowMap =
         mutableMapOf<String, MutableSharedFlow<Boolean?>>()
@@ -78,6 +79,9 @@ class FakeSettingsDiskSource : SettingsDiskSource {
     private val mutableShowImportLoginsSettingBadgeFlowMap =
         mutableMapOf<String, MutableSharedFlow<Boolean?>>()
 
+    private val mutableVaultRegisteredForExportFlowMap =
+        mutableMapOf<String, MutableSharedFlow<Boolean?>>()
+
     override var appLanguage: AppLanguage? = null
 
     override var appTheme: AppTheme
@@ -142,7 +146,9 @@ class FakeSettingsDiskSource : SettingsDiskSource {
 
     override var lastDatabaseSchemeChangeInstant: Instant?
         get() = storedLastDatabaseSchemeChangeInstant
-        set(value) { storedLastDatabaseSchemeChangeInstant = value }
+        set(value) {
+            storedLastDatabaseSchemeChangeInstant = value
+        }
 
     override val lastDatabaseSchemeChangeInstantFlow: Flow<Instant?>
         get() = mutableLastDatabaseSchemeChangeInstant.onSubscription {
@@ -176,6 +182,7 @@ class FakeSettingsDiskSource : SettingsDiskSource {
         mutableVaultTimeoutActionsFlowMap.remove(userId)
         mutableVaultTimeoutInMinutesFlowMap.remove(userId)
         mutableLastSyncCallFlowMap.remove(userId)
+        mutableVaultRegisteredForExportFlowMap.remove(userId)
     }
 
     override fun getLastSyncTime(userId: String): Instant? = storedLastSyncTime[userId]
@@ -348,6 +355,19 @@ class FakeSettingsDiskSource : SettingsDiskSource {
             emit(getShowImportLoginsSettingBadge(userId = userId))
         }
 
+    override fun getVaultRegisteredForExport(userId: String): Boolean =
+        vaultRegisteredForExport[userId] ?: false
+
+    override fun storeVaultRegisteredForExport(userId: String, registered: Boolean?) {
+        vaultRegisteredForExport[userId] = registered
+        getMutableVaultRegisteredForExportFlow(userId = userId).tryEmit(registered)
+    }
+
+    override fun getVaultRegisteredForExportFlow(userId: String): Flow<Boolean?> =
+        getMutableVaultRegisteredForExportFlow(userId = userId).onSubscription {
+            emit(getVaultRegisteredForExport(userId = userId))
+        }
+
     //region Private helper functions
     private fun getMutableScreenCaptureAllowedFlow(userId: String): MutableSharedFlow<Boolean?> {
         return mutableScreenCaptureAllowedFlowMap.getOrPut(userId) {
@@ -400,5 +420,12 @@ class FakeSettingsDiskSource : SettingsDiskSource {
         bufferedMutableSharedFlow(replay = 1)
     }
 
+    private fun getMutableVaultRegisteredForExportFlow(
+        userId: String,
+    ): MutableSharedFlow<Boolean?> =
+        mutableVaultRegisteredForExportFlowMap.getOrPut(userId) {
+            bufferedMutableSharedFlow(replay = 1)
+        }
+
     //endregion Private helper functions
 }

app/src/test/java/com/x8bit/bitwarden/data/platform/repository/SettingsRepositoryTest.kt

@@ -1184,18 +1184,59 @@ class SettingsRepositoryTest {
             assertFalse(awaitItem())
         }
     }
+
+    @Test
+    fun `isVaultRegisteredForExport should return false if no value exists`() {
+        assertFalse(settingsRepository.isVaultRegisteredForExport(userId = "userId"))
+    }
+
+    @Test
+    fun `isVaultRegisteredForExport should return true if it exists`() {
+        val userId = "userId"
+        fakeSettingsDiskSource.storeVaultRegisteredForExport(userId = userId, registered = true)
+        assertTrue(settingsRepository.isVaultRegisteredForExport(userId = userId))
+    }
+
+    @Test
+    fun `storeVaultRegisteredForExport should store value of true to disk`() {
+        val userId = "userId"
+        settingsRepository.storeVaultRegisteredForExport(userId = userId, isRegistered = true)
+        assertTrue(fakeSettingsDiskSource.getVaultRegisteredForExport(userId = userId))
+    }
+
+    @Test
+    fun `getVaultRegisteredForExportFlow should react to changes in SettingsDiskSource`() =
+        runTest {
+            fakeAuthDiskSource.userState = MOCK_USER_STATE
+            settingsRepository
+                .getVaultRegisteredForExportFlow(userId = USER_ID)
+                .test {
+                    assertFalse(awaitItem())
+                    fakeSettingsDiskSource.storeVaultRegisteredForExport(
+                        userId = USER_ID,
+                        registered = true,
+                    )
+                    assertTrue(awaitItem())
+                    fakeSettingsDiskSource.storeVaultRegisteredForExport(
+                        userId = USER_ID,
+                        registered = false,
+                    )
+                    assertFalse(awaitItem())
+                }
+        }
 }
 
 private const val USER_ID: String = "userId"
 private const val AUTHENTICATION_SYNC_KEY = "authSyncKey"
 
-private val MOCK_TRUSTED_DEVICE_USER_DECRYPTION_OPTIONS = TrustedDeviceUserDecryptionOptionsJson(
-    encryptedPrivateKey = null,
-    encryptedUserKey = null,
-    hasAdminApproval = false,
-    hasLoginApprovingDevice = false,
-    hasManageResetPasswordPermission = false,
-)
+private val MOCK_TRUSTED_DEVICE_USER_DECRYPTION_OPTIONS =
+    TrustedDeviceUserDecryptionOptionsJson(
+        encryptedPrivateKey = null,
+        encryptedUserKey = null,
+        hasAdminApproval = false,
+        hasLoginApprovingDevice = false,
+        hasManageResetPasswordPermission = false,
+    )
 
 private val MOCK_USER_DECRYPTION_OPTIONS: UserDecryptionOptionsJson = UserDecryptionOptionsJson(
     hasMasterPassword = false,