SM-805: Put ApiConfigurations & EncryptionSettings in Client behind RwLock & Arc #70
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
coltonhurst
changed the title
|
Closing this since we're exploring other solutions. |
dani-garcia
added a commit
that referenced
this pull request
Jun 13, 2024
## 📔 Objective We're having some deadlock problems with the Passkey API by calling certain SDK functions on the `passkey-rs` callbacks. These issues are caused because we're holding a reference to the RwLock during the execution of the Passkey operation and so calling into the SDK from inside that will deadlock. To solve it we can't just use a lock at the client level, and so we need to move to using interior mutability, I've revived an old PR (#70) where we started doing that. This PR is split into two commits, for ease of review: - [Remove all the muts and locks for uniffi](c56add5): This removes the use of RwLock in bitwarden-uniffi and the `&mut` references used in the bitwarden Client API. Note that this alone won't compile. - [Make client internally mutable](f61d104): Implements RwLocks in Client to make it internally mutable. Some notes of what the change entails: - I had to wrap `EncryptionSettings` in a `RwLock<Arc<>>` to get the API working, this is quite unfortunate as it forces us to clone `EncryptionSettings` to modify it when calling `set_org_keys`. We can't wrap the `org_keys` in a `RwLock` as we will get lifetime issues in `get_key`. I think the best solution for this will be the work on creating a Crypto store that only returns opaque key references, so we might want to prioritize that. - I extracted `external_client` from `ApiConfigurations`, as it's never mutated and it allows us to keep the same API for `get_http_client` I hate that `Mutex` and `RwLock` return a Result in case they are poisoned, that's never our case and it makes their usage so cumbersome 😢 Note: I've tried to change the smallest amount of code to make the change, so the secrets manager APIs (and bitwarden-json) are still mutable. If we're okay with these changes I can go back to update those in a separate PR. ## ⏰ 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
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
Make client functions immutable
Code changes
Screenshots
Before you submit