Auth/PM-7811 - Refactor User Auto Unlock Key Hydration Process To Remove Race Conditions #8979
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…emove active account listening logic as it introduced race conditions with user key memory retrieval happening before the user auto unlock key was set into memory.
… if there is an active account, then set the user key in memory from the user auto unlock key.
… key in memory if the auto unlock key is set on account switch and background init (must act on all accounts so that account switcher displays unlock status properly).
…to unlock key is set on init
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #8979 +/- ##
==========================================
- Coverage 27.70% 27.70% -0.01%
==========================================
Files 2392 2392
Lines 69356 69368 +12
Branches 12934 12938 +4
==========================================
- Hits 19218 19215 -3
- Misses 48658 48673 +15
Partials 1480 1480 ☔ View full report in Codecov by Sentry. |
|
No New Or Fixed Issues Found |
justindbaur
reviewed
Apr 29, 2024
apps/browser/src/auth/popup/account-switching/services/account-switcher.service.ts
Outdated
Show resolved
Hide resolved
justindbaur
approved these changes
Apr 29, 2024
jlf0dev
approved these changes
Apr 29, 2024
JaredSnider-Bitwarden
deleted the
auth/pm-7811/refactor-user-auto-unlock-key-hydration-process-to-remove-race-conditions
branch
JaredSnider-Bitwarden
added a commit
that referenced
this pull request
Apr 29, 2024
…ove Race Conditions (#8979) * PM-7811 - Refactor UserKeyInitService to UserAutoUnlockKeyService - remove active account listening logic as it introduced race conditions with user key memory retrieval happening before the user auto unlock key was set into memory. * PM-7811 - CLI - (1) Fix deps (2) On CLI init (pre command execution), if there is an active account, then set the user key in memory from the user auto unlock key. * PM-7811 - Browser Extension / desktop - (1) Update deps (2) Sets user key in memory if the auto unlock key is set on account switch and background init (must act on all accounts so that account switcher displays unlock status properly). * PM-7811 - Web - (1) Update deps (2) Sets user key in memory if the auto unlock key is set on init * PM-7811 - Fix account switcher service changes not being necessary.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Type of change
Objective
To resolve PM-7811 which initially presented itself as the CLI not properly unlocking after exporting a session key on a fresh install or after deleting
data.json. During our investigation, we realized there was a cross client race condition with any code that called to check if the user had a user key in memory and theUserKeyInitService'slistener for setting the user key in memory if the user auto unlock key was set. This refactor should eliminate any chances of race conditions and ensure that the user key in memory is always set as early as possible in the client initialization processes.Code changes
UserKeyInitServicetoUserAutoUnlockKeyServiceas it is now purely involved with managing the user auto unlock key.UserAutoUnlockKeyServicedependenciesuserAutoUnlockKeyService.setUserKeyInMemoryIfAutoUserKeySeton Web client init for singular active accountuserAutoUnlockKeyService.setUserKeyInMemoryIfAutoUserKeySeton Desktop client init for n accounts (desktop supports account switching)userAutoUnlockKeyService.setUserKeyInMemoryIfAutoUserKeySeton Browser Extension client init for n accounts (browser extension supports account switching)userAutoUnlockKeyService.setUserKeyInMemoryIfAutoUserKeySeton CLI client init for singular active account which executes pre-command execution.Screenshots
Web
PM-7811.-.Web.-.never.lock.works.mov
CLI
Desktop
PM-7811.-.Desktop.-.never.lock.works.on.init.and.for.account.switch.mov
Browser Extension
PM-7811.-.Browser.Extension.-.never.lock.works.on.init.and.for.account.switch.mov
Before you submit