[PM-19479] Client-managed Repository traits

[dani-garcia]

🎟️ 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_core isn't aware of the models, bitwarden_core only implements a generic way to set and retrieve generic impl 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:

• A Repository trait which will be implemented by the clients (and the SDK in the future), and a RepositoryItem marker trait which will be used to mark which models are meant to be used with the repositories.
• A StateRegistry which stores all the client-managed Repositories, and in the future will also handle the SDK-managed repositories.
• A new StateClient subclient 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 the Repository traits. 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:

• The current integration with web clients requires the State Provider definition to be UserKeyDefinition<Record<string, T>> to match the key-value pattern in Repository. 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.
• There's no great way of ensuring that all the client-managed Repositories have been registered, other than keeping a list. I've tried to use the inventory crate 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 the inventory crate 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

• 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

• 👍 (:+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

[codecov]

Codecov Report

Attention: Patch coverage is 25.32751% with 171 lines in your changes missing coverage. Please review.

Project coverage is 71.20%. Comparing base (c3e3dac) to head (ec504d4).

Files with missing lines	Patch %	Lines
...bitwarden-wasm-internal/src/platform/repository.rs	0.00%	67 Missing ⚠️
crates/bitwarden-uniffi/src/platform/repository.rs	0.00%	45 Missing ⚠️
crates/bitwarden-wasm-internal/src/platform/mod.rs	0.00%	13 Missing ⚠️
crates/bitwarden-core/src/platform/state_client.rs	0.00%	12 Missing ⚠️
crates/bitwarden-state/src/registry.rs	82.35%	12 Missing ⚠️
crates/bitwarden-uniffi/src/platform/mod.rs	0.00%	11 Missing ⚠️
...tes/bitwarden-core/src/platform/platform_client.rs	0.00%	5 Missing ⚠️
crates/bitwarden-state/src/repository.rs	0.00%	3 Missing ⚠️
crates/bitwarden-wasm-internal/src/client.rs	0.00%	3 Missing ⚠️

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[github-actions]

Checkmarx One – Scan Summary & Details – 44c027d0-aaa6-41a3-a170-d51d32fbbd1c

Great job, no security vulnerabilities found in this Pull Request

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[nick-livefront]

Vault ✅