[PM-22591] Unify client repository initialization #484
+245
−205
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
|
Great job! No new security vulnerabilities introduced in this pull request |
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #484 +/- ##
==========================================
- Coverage 78.04% 77.98% -0.06%
==========================================
Files 287 287
Lines 27651 27672 +21
==========================================
Hits 21579 21579
- Misses 6072 6093 +21 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
coroiu
approved these changes
Oct 8, 2025
Comment on lines
+45
to
+55
| ```rust | ||
| macro_rules! create_client_managed_repositories { | ||
| ($container_name:ident, $macro:ident) => { | ||
| $macro! { | ||
| $container_name; | ||
| // List any SDK-managed repositories here. The format is: | ||
| // <fully qualified path to the item>, <item type idenfier>, <field name>, <name of the repository implementation> | ||
| ::bitwarden_vault::Cipher, Cipher, cipher, CipherRepository; | ||
| ::bitwarden_vault::Folder, Folder, folder, FolderRepository; | ||
| } | ||
| }; |
There was a problem hiding this comment.
praise: Nice idea! Using macros do define the repositories in a place where we're not actually able to depend on them 👍
|
bw-ghapp bot
pushed a commit
to bitwarden/sdk-swift
that referenced
this pull request
Oct 8, 2025
…client repository initialization (bitwarden/sdk-internal#484)
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-22591
📔 Objective
Currently, all app crates (wasm, uniffi) need to declare all the client managed repositories that they allow clients to implement. This means that all the crates need to be updated when adding more repositories, which adds more steps to implementations and can lead to things being out of sync. This PR unifies the declaration of client managed repositories so that there's only one place where they are defined.
While I was at it, I've changed slightly the way we register the repositories. Rather than provide one function for each (
register_cipher_repository/register_folder_repository) I provide a single function that takes an object that contains all the repos. This is easier to generate and should make it easier to know if any of the repos are missing (you should get a compile error). I left the previous ones for backwards-compatSadly both wasm and uniffi have a lot of compile time type shenanigans and macros which don't make this easy, so this solution contains multiple parts:
bitwarden_wasmandbitwarden_uniffiwe already have a macro that creates the repository implementations based on a type. This has been expanded to take multiple types and also create theRepositoriesstruct which is just a grouping of all of them. Now, instead of manually calling these macros manually for each type, they instead get passed to thebitwarden_pm::create_client_managed_repositories!macro.bitwarden_pm::create_client_managed_repositories!macro's only purpose is to call the passed macro repeatedly with all the types that need to be created. This is the only way I found to lazily define the types inbitwarden-pmso that they would be usable in macros in the other crates. The definition is fairly repetitive with the types, because we don't have easy ways to change the case of identifiers or merge them together. We could use thepastecrate to avoid the repetition but didn't seem worth it at the momentNote that in the past we placed the sdk-managed definitions in a shared
bitwarden-state-migrationscrate, but now that we have the newbitwarden-pmcrate as a shared crate focused on password manager functionality I don't thinkbitwarden-state-migrationsis needed. Instead this PR moves the sdk-managed definitions tobitwarden-pm(next to the new client managed repositories macro) and deletes thebitwarden-state-migrationscrate.⏰ 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