feat(wasm): add feature support for indexedb and sqlite to matrix-sdk-ffi #5245

zzorba · 2025-06-18T14:55:58Z

Expose a choice of session storage in the matrix-sdk-ffi crate. The initial choices are Sqlite (supported on non-Wasm platforms) and IndexedDb (Wasm only). It was agreed though that feature flags make more sense here, and make the code more maintainable.

The existing bundled-sqlite is setup to opt-in sqlite, however several methods for configuring a Sqlite store have been moved onto a sub-builder for organizational reasons.

This PR is stacked on top of https://github.com/matrix-org/matrix-rust-sdk/pull/5211/files, I will rebase it against main when that has landed.

Corresponding PR for complement-crypto: matrix-org/complement-crypto#195

Public API changes documented in changelogs (optional)

Signed-off-by: Daniel Salinas

Hywan · 2025-06-18T15:36:33Z

Waiting on #5211 to be merged before reviewing this one.

zzorba · 2025-06-18T16:28:16Z

Would be nice to get opinions on the new session_store and client_builder changes. Those are wholly new, and structural feedback would be very welcome

poljar · 2025-06-19T15:01:05Z

Can this one be rebased as well?

zzorba · 2025-06-19T22:21:37Z

Yep, rebased it to adopt the Cargo.toml changes. This PR now concerns only the configuration of the session store.

Let me know if a different approach would be preferred here, adding sub-builders seemed more self-documenting than having a large number of 'optional' methods on the main builder, but happy to do it a different way if you prefer.

codecov · 2025-06-19T22:31:33Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.18%. Comparing base (08e1d38) to head (5c93af9).
Report is 22 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #5245   +/-   ##
=======================================
  Coverage   90.18%   90.18%           
=======================================
  Files         334      334           
  Lines      104822   104822           
  Branches   104822   104822           
=======================================
+ Hits        94534    94538    +4     
+ Misses       6236     6232    -4     
  Partials     4052     4052

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

zzorba · 2025-06-20T14:00:56Z

Here is a corresponding complement-crypto PR: matrix-org/complement-crypto#195

The system of platform targets was already quite messy, and becoming even worse as we start preparing for Wasm support. Switch to features instead to make this easier to work with.

Hywan

Thanks for the patches. The general idea is good, but the patches deserve more work.

bindings/matrix-sdk-ffi/CHANGELOG.md

bindings/matrix-sdk-ffi/Cargo.toml

bindings/matrix-sdk-ffi/src/session_store.rs

Hywan · 2025-06-23T09:20:57Z

xtask/src/ci.rs

@@ -231,7 +231,7 @@ fn check_clippy() -> Result<()> {
        "rustup run {NIGHTLY} cargo clippy --workspace --all-targets
            --exclude matrix-sdk-crypto --exclude xtask
            --no-default-features
-            --features native-tls,sso-login,testing
+            --features native-tls,sso-login,sqlite,testing


The same patch is mixing two things. Proof is your commit message contains “and”.

Please split this patch into two.

By the way, this change should be a fixup of the patch introducing the sqlite feature.

It is not mixing two different things, it is adding support for indexedb which requires parameterizing the sqlite configuration. I do not believe these are separable changes.

Hywan · 2025-06-23T09:22:05Z

bindings/matrix-sdk-ffi/src/session_store.rs

@@ -55,15 +55,15 @@ mod sqlite_session_store {
        /// capable of handling multiple users, however it is valid to use the
        /// same path for both stores on a single session.
        #[uniffi::constructor]
-        pub fn new(data_path: String, cache_path: String) -> Self {
-            Self {
+        pub fn new(data_path: String, cache_path: String) -> Arc<Self> {


Why?

It should be a fixup patch.

I don't know what that means. What is a fixup patch?

A fixup patch is a patch that is “melt”/“merged” with another one so that we end up with a single patch, see https://git-scm.com/docs/git-rebase.

The contributing guide also explains it: https://github.com/matrix-org/matrix-rust-sdk/blob/main/CONTRIBUTING.md#addressing-review-comments-using-fixup-commits.

Hywan · 2025-06-23T09:22:18Z

bindings/matrix-sdk-ffi/src/session_store.rs

+    use std::sync::Arc;
+
+    use super::SessionStoreResult;
+    use crate::{client_builder::ClientBuildError, helpers::unwrap_or_clone_arc};
+


A fixup patch.

Co-authored-by: Ivan Enderlin <[email protected]> Signed-off-by: Daniel Salinas <[email protected]>

bindings/matrix-sdk-ffi/CHANGELOG.md

bindings/matrix-sdk-ffi/src/session_store.rs

zzorba changed the title ~~Wasm indexedb and sqlite~~ feat(wasm): add feature support for indexedb and sqlite to matrix-sdk-ffi Jun 18, 2025

zzorba mentioned this pull request Jun 18, 2025

feat(ffi): Add ability to configure indexedb instead of sqlite for wasm platforms #5181

Closed

1 task

zzorba marked this pull request as ready for review June 18, 2025 15:14

zzorba requested a review from a team as a code owner June 18, 2025 15:14

zzorba requested review from poljar and removed request for a team June 18, 2025 15:14

zzorba force-pushed the wasm_indexedb_and_sqlite branch from eacaec7 to f431d9a Compare June 19, 2025 22:17

zzorba mentioned this pull request Jun 20, 2025

Use new SqliteSessionBuilder for go matrix-org/complement-crypto#195

Open

zzorba force-pushed the wasm_indexedb_and_sqlite branch from 7ac8f7c to 474eb29 Compare June 20, 2025 14:12

Daniel Salinas and others added 9 commits June 20, 2025 10:14

Change matrix-sdk-ffi to rely on features over platform targets

1ea1398

The system of platform targets was already quite messy, and becoming even worse as we start preparing for Wasm support. Switch to features instead to make this easier to work with.

Set up feature flags for new indexeddb and sqlite choices

bd2de9c

Add support for indexeddb and sqlite session choice

6c5cfeb

fix capitlizations

a148409

fix some bad merges

629b610

Add sqlite to the ci task, refactor code to make cfg clearer

5dc20db

Cargo fmt

4cde428

Make constructor return Arc properly

15ea884

Add indexeddb includes

fe98e31

zzorba force-pushed the wasm_indexedb_and_sqlite branch from 474eb29 to fe98e31 Compare June 20, 2025 14:15

Hywan requested changes Jun 23, 2025

View reviewed changes

Hywan self-assigned this Jun 23, 2025

Hywan removed the request for review from poljar June 23, 2025 09:34

zzorba and others added 2 commits June 23, 2025 10:30

Update bindings/matrix-sdk-ffi/CHANGELOG.md

ebebe34

Co-authored-by: Ivan Enderlin <[email protected]> Signed-off-by: Daniel Salinas <[email protected]>

Update bindings/matrix-sdk-ffi/Cargo.toml

fc92feb

Co-authored-by: Ivan Enderlin <[email protected]> Signed-off-by: Daniel Salinas <[email protected]>

zzorba and others added 6 commits June 23, 2025 10:34

Update bindings/matrix-sdk-ffi/Cargo.toml

4543b1b

Co-authored-by: Ivan Enderlin <[email protected]> Signed-off-by: Daniel Salinas <[email protected]>

Update bindings/matrix-sdk-ffi/src/session_store.rs

69538a5

Co-authored-by: Ivan Enderlin <[email protected]> Signed-off-by: Daniel Salinas <[email protected]>

Code review feedback

7987cc2

Rename builder

1d844de

Adjust language in the README

ce33b96

Make it an xor

90048a8

Hywan reviewed Jun 24, 2025

View reviewed changes

Use Self instead

5c93af9

feat(wasm): add feature support for indexedb and sqlite to matrix-sdk-ffi #5245

Are you sure you want to change the base?

feat(wasm): add feature support for indexedb and sqlite to matrix-sdk-ffi #5245

Conversation

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

Uh oh!

Uh oh!

Hywan commented Jun 18, 2025

Uh oh!

zzorba commented Jun 18, 2025

Uh oh!

poljar commented Jun 19, 2025

Uh oh!

zzorba commented Jun 19, 2025

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

zzorba commented Jun 20, 2025

Uh oh!

Hywan 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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

zzorba commented Jun 18, 2025 •

edited

Loading

codecov bot commented Jun 19, 2025 •

edited

Loading

Hywan left a comment •

edited

Loading