[PR #4618] [MERGED] PM-15804, PM-17130: Add logic to monitor when the screen on state to ensure the vault locks properly #5079

Closed
opened 2025-11-26 23:53:43 -06:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/bitwarden/android/pull/4618
Author: @david-livefront
Created: 1/23/2025
Status: Merged
Merged: 1/23/2025
Merged by: @david-livefront

Base: release/2025.01-rc14Head: PM-17130-cherry-pick-vault-lock-timeout


📝 Commits (1)

  • d80fe2f PM-17130: Add logic to monitor when the screen on state to ensure the vault locks properly

📊 Changes

3 files changed (+131 additions, -12 deletions)

View changed files

📝 app/src/main/java/com/x8bit/bitwarden/data/vault/manager/VaultLockManagerImpl.kt (+62 -12)
📝 app/src/main/java/com/x8bit/bitwarden/data/vault/manager/di/VaultManagerModule.kt (+4 -0)
📝 app/src/test/java/com/x8bit/bitwarden/data/vault/manager/VaultLockManagerTest.kt (+65 -0)

📄 Description

🎟️ Tracking

PM-17130
PM-15804

📔 Objective

This PR adds a broadcast receiver to the VaultLockManager in order to ensure that we lock the vault at the soonest possible moment.

There seems to be an issue in the way delay works inside a coroutine scope when the screen is off. The delay will take significantly longer to complete and cause the vault to not lock when it is supposed to. This new solution restarts the delay with an appropriate remaining time when the screen is turned back on to ensure we lock the vault correctly.

Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation 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/4618 **Author:** [@david-livefront](https://github.com/david-livefront) **Created:** 1/23/2025 **Status:** ✅ Merged **Merged:** 1/23/2025 **Merged by:** [@david-livefront](https://github.com/david-livefront) **Base:** `release/2025.01-rc14` ← **Head:** `PM-17130-cherry-pick-vault-lock-timeout` --- ### 📝 Commits (1) - [`d80fe2f`](https://github.com/bitwarden/android/commit/d80fe2fc47bd426c7ed4515253978c37b7a5f948) PM-17130: Add logic to monitor when the screen on state to ensure the vault locks properly ### 📊 Changes **3 files changed** (+131 additions, -12 deletions) <details> <summary>View changed files</summary> 📝 `app/src/main/java/com/x8bit/bitwarden/data/vault/manager/VaultLockManagerImpl.kt` (+62 -12) 📝 `app/src/main/java/com/x8bit/bitwarden/data/vault/manager/di/VaultManagerModule.kt` (+4 -0) 📝 `app/src/test/java/com/x8bit/bitwarden/data/vault/manager/VaultLockManagerTest.kt` (+65 -0) </details> ### 📄 Description ## 🎟️ Tracking [PM-17130](https://bitwarden.atlassian.net/browse/PM-17130) [PM-15804](https://bitwarden.atlassian.net/browse/PM-15804) ## 📔 Objective This PR adds a broadcast receiver to the `VaultLockManager` in order to ensure that we lock the vault at the soonest possible moment. There seems to be an issue in the way `delay` works inside a coroutine scope when the screen is off. The `delay` will take significantly longer to complete and cause the vault to not lock when it is supposed to. This new solution restarts the delay with an appropriate remaining time when the screen is turned back on to ensure we lock the vault correctly. ## ⏰ Reminders before review - Contributor guidelines followed - All formatters and local linters executed and passed - Written new unit and / or integration tests where applicable - Used internationalization (i18n) for all UI strings - CI builds passed - Communicated to DevOps any deployment requirements - Updated any necessary documentation 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-17130]: https://bitwarden.atlassian.net/browse/PM-17130?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ [PM-15804]: https://bitwarden.atlassian.net/browse/PM-15804?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-26 23:53:43 -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#5079