[PR #5112] [MERGED] PM-20552: Ensure userState does not emit while the active user is unlocking #5492

Closed
opened 2025-11-27 00:05:30 -06:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/bitwarden/android/pull/5112
Author: @david-livefront
Created: 4/28/2025
Status: Merged
Merged: 4/29/2025
Merged by: @david-livefront

Base: mainHead: PM-20552-tde-race-condition


📝 Commits (1)

  • eb3b60f PM-20552: Ensure userState does not emit while the active user is unlocking

📊 Changes

5 files changed (+74 additions, -18 deletions)

View changed files

📝 app/src/main/java/com/x8bit/bitwarden/data/auth/repository/AuthRepositoryImpl.kt (+6 -2)
📝 app/src/main/java/com/x8bit/bitwarden/data/vault/manager/VaultLockManager.kt (+6 -0)
📝 app/src/main/java/com/x8bit/bitwarden/data/vault/manager/VaultLockManagerImpl.kt (+30 -5)
📝 app/src/test/java/com/x8bit/bitwarden/data/auth/repository/AuthRepositoryTest.kt (+2 -0)
📝 app/src/test/java/com/x8bit/bitwarden/data/vault/manager/VaultLockManagerTest.kt (+30 -11)

📄 Description

🎟️ Tracking

PM-20552

📔 Objective

This PR Fixes a TDE bug caused by a race condition that occurs when logging in.

When logging in with TDE and trusting the device, 3 distinct flags will be set that can cause the userState to emit and the RootNavScreen to change it's target destination:

  • shouldTrustDevice
  • isTdeLoginComplete
  • isVaultUnlocked

We want these 3 properties to all update together as a single transaction in order to ensure the app does not navigate prematurely. This premature navigation can cause the user to be logged-out or cancel the trusted device process. To fix this, I am ensuring that the userState does not emit while the active user is unlocking their vault and as soon as the entire process is complete, it updates at that time. The other thing I have done is make the unlockVault function non-cancellable.

Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/bitwarden/android/pull/5112 **Author:** [@david-livefront](https://github.com/david-livefront) **Created:** 4/28/2025 **Status:** ✅ Merged **Merged:** 4/29/2025 **Merged by:** [@david-livefront](https://github.com/david-livefront) **Base:** `main` ← **Head:** `PM-20552-tde-race-condition` --- ### 📝 Commits (1) - [`eb3b60f`](https://github.com/bitwarden/android/commit/eb3b60f868b17bce78ac6453a5492890ca7ec9ed) PM-20552: Ensure userState does not emit while the active user is unlocking ### 📊 Changes **5 files changed** (+74 additions, -18 deletions) <details> <summary>View changed files</summary> 📝 `app/src/main/java/com/x8bit/bitwarden/data/auth/repository/AuthRepositoryImpl.kt` (+6 -2) 📝 `app/src/main/java/com/x8bit/bitwarden/data/vault/manager/VaultLockManager.kt` (+6 -0) 📝 `app/src/main/java/com/x8bit/bitwarden/data/vault/manager/VaultLockManagerImpl.kt` (+30 -5) 📝 `app/src/test/java/com/x8bit/bitwarden/data/auth/repository/AuthRepositoryTest.kt` (+2 -0) 📝 `app/src/test/java/com/x8bit/bitwarden/data/vault/manager/VaultLockManagerTest.kt` (+30 -11) </details> ### 📄 Description ## 🎟️ Tracking [PM-20552](https://bitwarden.atlassian.net/browse/PM-20966) ## 📔 Objective This PR Fixes a TDE bug caused by a race condition that occurs when logging in. When logging in with TDE and trusting the device, 3 distinct flags will be set that can cause the `userState` to emit and the `RootNavScreen` to change it's target destination: * `shouldTrustDevice` * `isTdeLoginComplete` * `isVaultUnlocked` We want these 3 properties to all update together as a single transaction in order to ensure the app does not navigate prematurely. This premature navigation can cause the user to be logged-out or cancel the trusted device process. To fix this, I am ensuring that the userState does not emit while the active user is unlocking their vault and as soon as the entire process is complete, it updates at that time. The other thing I have done is make the `unlockVault` function non-cancellable. ## ⏰ Reminders before review - Contributor guidelines followed - All formatters and local linters executed and passed - Written new unit and / or integration tests where applicable - Protected functional changes with optionality (feature flags) - Used internationalization (i18n) for all UI strings - CI builds passed - Communicated to DevOps any deployment requirements - Updated any necessary documentation (Confluence, contributing docs) or informed the documentation team ## 🦮 Reviewer guidelines <!-- Suggested interactions but feel free to use (or not) as you desire! --> - 👍 (`:+1:`) or similar for great changes - 📝 (`:memo:`) or ℹ️ (`:information_source:`) for notes or general info - ❓ (`:question:`) for questions - 🤔 (`:thinking:`) or 💭 (`:thought_balloon:`) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion - 🎨 (`:art:`) for suggestions / improvements - ❌ (`:x:`) or ⚠️ (`:warning:`) for more significant problems or concerns needing attention - 🌱 (`:seedling:`) or ♻️ (`:recycle:`) for future improvements or indications of technical debt - ⛏ (`:pick:`) for minor or nitpick changes [PM-20552]: https://bitwarden.atlassian.net/browse/PM-20552?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2025-11-27 00:05:30 -06:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/android#5492