[PM-12612] SDK-Managed Repository support #301

dani-garcia · 2025-06-09T08:57:52Z

🎟️ 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 [PM-22589] Implement basic db migrations for indexeddb #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

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

github-actions · 2025-06-09T09:02:43Z

Checkmarx One – Scan Summary & Details – 2067932c-bcde-46d5-a75f-7a0b4d5a50a3

Great job! No new security vulnerabilities introduced in this pull request

codecov · 2025-06-09T09:13:19Z

Codecov Report

❌ Patch coverage is 48.51852% with 139 lines in your changes missing coverage. Please review.
✅ Project coverage is 76.75%. Comparing base (03d02e6) to head (0fded01).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
crates/bitwarden-state/src/registry.rs	14.28%	24 Missing ⚠️
crates/bitwarden-state/src/sdk_managed/mod.rs	0.00%	23 Missing ⚠️
crates/bitwarden-state/src/sdk_managed/sqlite.rs	80.67%	23 Missing ⚠️
crates/bitwarden-wasm-internal/src/platform/mod.rs	0.00%	23 Missing ⚠️
crates/bitwarden-uniffi/src/platform/mod.rs	0.00%	20 Missing ⚠️
crates/bitwarden-core/src/platform/state_client.rs	0.00%	18 Missing ⚠️
...tes/bitwarden-threading/src/thread_bound_runner.rs	0.00%	5 Missing ⚠️
crates/bitwarden-state/src/repository.rs	91.17%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #301      +/-   ##
==========================================
- Coverage   77.03%   76.75%   -0.28%     
==========================================
  Files         268      270       +2     
  Lines       25399    25664     +265     
==========================================
+ Hits        19565    19698     +133     
- Misses       5834     5966     +132

☔ 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.

## 🎟️ 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

# Conflicts: # Cargo.lock # crates/bitwarden-state/Cargo.toml # crates/bitwarden-state/src/registry.rs # crates/bitwarden-state/src/repository.rs # crates/bitwarden-vault/src/cipher/cipher.rs # Conflicts: # crates/bitwarden-vault/src/vault_client.rs # Conflicts: # Cargo.lock # crates/bitwarden-state/Cargo.toml Use bundled sqlite to solve compile issues Update readme Don't stringify the data in indexeddb Remove the comment Update readme

…es (#329) ## 🎟️ Tracking  ## 📔 Objective  ## ⏰ 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

sonarqubecloud · 2025-06-26T14:46:48Z

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

# Conflicts: # Cargo.lock # crates/bitwarden-core/src/platform/state_client.rs # crates/bitwarden-state/src/registry.rs # crates/bitwarden-state/src/repository.rs # crates/bitwarden-wasm-internal/src/platform/mod.rs

…ompile time, use indexeddb db name

Copilot

Pull Request Overview

This PR implements SDK-managed repository support with platform-specific database backends, allowing the SDK to handle data persistence internally rather than relying on client implementations.

Key changes:

Adds database abstraction layer with SQLite support for native platforms and IndexedDB for WebAssembly
Introduces repository registration system with compile-time name validation
Updates platform-specific bindings (UniFFI/WASM) to support SDK-managed state initialization

Reviewed Changes

Copilot reviewed 15 out of 16 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
`crates/bitwarden-state/src/sdk_managed/sqlite.rs`	SQLite database implementation with repository operations
`crates/bitwarden-state/src/sdk_managed/indexed_db.rs`	IndexedDB implementation for WebAssembly platforms
`crates/bitwarden-state/src/sdk_managed/mod.rs`	Database trait definition and common error handling
`crates/bitwarden-state/src/repository.rs`	Repository item registration system with name validation
`crates/bitwarden-state/src/registry.rs`	State registry with database initialization support
`crates/bitwarden-uniffi/src/platform/mod.rs`	UniFFI bindings for SDK-managed state
`crates/bitwarden-wasm-internal/src/platform/mod.rs`	WASM bindings for SDK-managed state
`crates/bitwarden-threading/src/thread_bound_runner.rs`	Manual Clone implementation removing generic bounds

Copilot · 2025-09-02T15:07:55Z

crates/bitwarden-state/src/sdk_managed/sqlite.rs

+        mut db: rusqlite::Connection,
+        registrations: &[RepositoryItemData],
+    ) -> Result<Self, DatabaseError> {
+        // Set WAL mode for better concurrency


The WAL mode setting should be documented with a comment explaining why this specific journal mode is chosen and its benefits for this use case.

Copilot · 2025-09-02T15:07:55Z

crates/bitwarden-state/src/sdk_managed/sqlite.rs

+    sdk_managed::{Database, DatabaseConfiguration, DatabaseError},
+};
+
+// TODO: Use connection pooling with r2d2 and r2d2_sqlite?


This TODO comment indicates a performance concern. Consider creating a tracking issue for connection pooling implementation to ensure this optimization is not forgotten.

crates/bitwarden-state/src/sdk_managed/indexed_db.rs

crates/bitwarden-state/src/repository.rs

coroiu

Just a small comment

crates/bitwarden-threading/src/thread_bound_runner.rs

… exclusive

coroiu

Let's goo

sonarqubecloud · 2025-09-04T09:45:40Z

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

dani-garcia mentioned this pull request Jun 9, 2025

[PM-19479] Client-managed Repository traits #213

Merged

dani-garcia force-pushed the ps/state-impl branch from a753607 to 5b9dd03 Compare June 9, 2025 10:47

Base automatically changed from ps/state-traits to main June 24, 2025 08:51

dani-garcia force-pushed the ps/state-impl branch from 8602563 to 5e9d57a Compare June 24, 2025 09:04

coroiu and others added 2 commits June 26, 2025 13:21

Merge branch 'main' into ps/state-impl

d3b903c

dani-garcia mentioned this pull request Jun 30, 2025

[PM-23189] Add ClientManagedTokens trait #337

Merged

dani-garcia added 3 commits August 25, 2025 14:18

Merge branch 'main' into ps/state-impl

50d1fa0

# Conflicts: # Cargo.lock # crates/bitwarden-core/src/platform/state_client.rs # crates/bitwarden-state/src/registry.rs # crates/bitwarden-state/src/repository.rs # crates/bitwarden-wasm-internal/src/platform/mod.rs

Split database init from client managed repo for now

934625a

Update dependency

4717df8

dani-garcia mentioned this pull request Aug 25, 2025

[PM-22589] Implement basic db migrations for indexeddb #410

Open

Remove versioning

1275e70

dani-garcia requested a review from coroiu August 26, 2025 10:42

dani-garcia marked this pull request as ready for review August 26, 2025 10:42

dani-garcia requested a review from a team as a code owner August 26, 2025 10:42

coroiu requested a review from Copilot September 2, 2025 12:12

This comment was marked as outdated.

Sign in to view

dani-garcia added 3 commits September 2, 2025 16:29

Replace sqlite table placeholder with format, validate the names at c…

84c36e0

…ompile time, use indexeddb db name

Merge branch 'main' into ps/state-impl

1ddf518

Remove unnecessary params macro

269c2d3

dani-garcia requested a review from Copilot September 2, 2025 14:37

This comment was marked as outdated.

Sign in to view

dani-garcia added 2 commits September 2, 2025 16:58

Fix comment and add quotes to sqlite

a563563

Add explicit validation

e82dd8f

dani-garcia requested a review from Copilot September 2, 2025 15:04

Copilot AI reviewed Sep 2, 2025

View reviewed changes

Expand validate comment

76b9f2d

coroiu reviewed Sep 3, 2025

View reviewed changes

crates/bitwarden-threading/src/thread_bound_runner.rs Show resolved Hide resolved

dani-garcia added 3 commits September 3, 2025 14:28

Add clone comment and document that client/sdk state are not mutually…

a763767

… exclusive

Merge branch 'main' into ps/state-impl

d88761a

More doc updates

6d9a095

dani-garcia requested a review from coroiu September 3, 2025 14:01

Merge branch 'main' into ps/state-impl

463ceff

coroiu approved these changes Sep 4, 2025

View reviewed changes

Merge branch 'main' into ps/state-impl

0fded01

dani-garcia merged commit 8a7175f into main Sep 4, 2025
50 checks passed

dani-garcia deleted the ps/state-impl branch September 4, 2025 09:52

This was referenced Sep 4, 2025

Update SDK to 1.0.0-2944-8447df0c bitwarden/android#5830

Merged

Updating SDK to 730c5b9 (1.0.0-2282-5658d61) bitwarden/ios#1925

Merged

Update SDK to 1.0.0-2970-5658d61f bitwarden/android#5859

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[PM-12612] SDK-Managed Repository support #301

[PM-12612] SDK-Managed Repository support #301

Uh oh!

dani-garcia commented Jun 9, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jun 9, 2025 •

edited

Loading

Uh oh!

codecov bot commented Jun 9, 2025 •

edited

Loading

Uh oh!

sonarqubecloud bot commented Jun 26, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Sep 2, 2025

Uh oh!

Copilot AI Sep 2, 2025

Uh oh!

Uh oh!

Uh oh!

coroiu left a comment

Uh oh!

Uh oh!

coroiu left a comment •

edited

Loading

Uh oh!

sonarqubecloud bot commented Sep 4, 2025

Uh oh!

Uh oh!

Uh oh!

[PM-12612] SDK-Managed Repository support #301

[PM-12612] SDK-Managed Repository support #301

Uh oh!

Conversation

dani-garcia commented Jun 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎟️ Tracking

📔 Objective

⏰ Reminders before review

🦮 Reviewer guidelines

Uh oh!

github-actions bot commented Jun 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Great job! No new security vulnerabilities introduced in this pull request

Uh oh!

codecov bot commented Jun 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

sonarqubecloud bot commented Jun 26, 2025

Quality Gate passed

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 2, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

coroiu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coroiu left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Sep 4, 2025

Quality Gate passed

Uh oh!

Uh oh!

Uh oh!

dani-garcia commented Jun 9, 2025 •

edited

Loading

github-actions bot commented Jun 9, 2025 •

edited

Loading

codecov bot commented Jun 9, 2025 •

edited

Loading

coroiu left a comment •

edited

Loading