[PM-19479] Client-managed Repository traits #213
Merged
Conversation
This file contains hidden or 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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #213 +/- ##
==========================================
- Coverage 71.77% 71.20% -0.58%
==========================================
Files 224 230 +6
Lines 18403 18632 +229
==========================================
+ Hits 13208 13266 +58
- Misses 5195 5366 +171 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Great job, no security vulnerabilities found in this Pull Request |
dani-garcia
force-pushed
the
ps/state-traits
branch
from
5f13cc1 to
778bc50
Compare
dani-garcia
force-pushed
the
ps/state-traits
branch
from
778bc50 to
34daa77
Compare
dani-garcia
changed the title
Implement demo cipher repository
dani-garcia
force-pushed
the
ps/state-traits
branch
from
34daa77 to
9d3ce7f
Compare
# Conflicts: # Cargo.lock # crates/bitwarden-uniffi/Cargo.toml # crates/bitwarden-vault/src/vault_client.rs # crates/bitwarden-wasm-internal/Cargo.toml # crates/bitwarden-wasm-internal/src/client.rs # crates/bitwarden-wasm-internal/src/vault/mod.rs
# Conflicts: # Cargo.lock # crates/bitwarden-wasm-internal/Cargo.toml # crates/bitwarden-wasm-internal/src/client.rs
|
justindbaur
approved these changes
Jun 24, 2025
Comment on lines
+51
to
+59
| /// This code is not meant to be used directly, users of this crate should use the | ||
| /// [crate::register_repository_item] macro to register their types. | ||
| #[doc(hidden)] | ||
| pub mod ___internal { | ||
|
|
||
| // This trait is just to try to discourage users from implementing `RepositoryItem` directly. | ||
| pub trait Internal {} | ||
| } | ||
| pub(crate) use ___internal::Internal; |
dani-garcia
added a commit
that referenced
this pull request
Sep 4, 2025
## 🎟️ Tracking https://bitwarden.atlassian.net/browse/PM-12612 ## 📔 Objective A continuation of #213, this PR implements some simple SDK managed data store based on SQLite (on non-wasm) and IndexedDB (on wasm). Both databases are wrapped in a `Database` trait and conditionally compiled based on platform. Then from each database we can get multiple `Repository` implementations that can be used to read and write data persistently. Each repository is mapped to a separate table in SQLite and Object Store in IndexedDb. Some limitations of the current system: - The database currently needs to be initialized as a separate step to both the SdkClient and the client-managed repositories, I feel like ideally we can do that as part of Client initialization, but that would require us to make initialization async. I've left that for the future. - Currently we don't have any indexes beyond the main key, but both sqlite and indexeddb support adding more. - The current structure doesn't have any migration capabilities, which are required for indexeddb to create the object stores, this PR temporarily adds version numbers to the `register_repository_item` calls, just to get something working, but note that this is removed in #410 and replaced with a better migration system. ## ⏰ 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 --------- Co-authored-by: Andreas Coroiu <[email protected]>
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.
🎟️ Tracking
https://bitwarden.atlassian.net/browse/PM-19479
📔 Objective
Implement a generic trait for accessing the client application's data storage directly. Because we want the store access to be typed, but
bitwarden_coreisn't aware of the models,bitwarden_coreonly implements a generic way to set and retrieve genericimpl Repository<T>instances, somewhat like dependency injection. Then it's up to each team/feature crates to define which models and which stores are available.This feature is created in a new
bitwarden-state, which will be expanded by a separate PR with the addition of SDK-managed state (Sqlite+IndexedDB). At the moment this crate contains:Repositorytrait which will be implemented by the clients (and the SDK in the future), and aRepositoryItemmarker trait which will be used to mark which models are meant to be used with the repositories.StateRegistrywhich stores all the client-managed Repositories, and in the future will also handle the SDK-managed repositories.StateClientsubclient under platform that will be used by the applications to register their Repositories. Both the WASM and UniFFI crates also need some conversion code to implement theRepositorytraits. I've tried to simplify it as much as possible, and hide it behind a macro when that wasn't possible.Some limitations on the current design:
UserKeyDefinition<Record<string, T>>to match the key-value pattern inRepository. This usually matches with what is being used for vault (encrypted ciphers/folders, etc), but it might fall short on other domains, like profile data, or user keys.inventorycrate to keep a global list of all the existing implementations and then validating that they've all been registered, but that doesn't work for WASM. We might be able to use theinventorycrate and just run it in tests though.For some documentation on how to use it, you can check the README: https://github.com/bitwarden/sdk-internal/blob/ps/state-traits/crates/bitwarden-state/README.md
The continuation of this is in #301, which contains SDK managed repository support. The client implementation of both these PRs is in bitwarden/clients#14839
⏰ Reminders before review
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 confirmedissue 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