feat(ffi): Add ability to configure indexedb instead of sqlite for wasm platforms by zzorba · Pull Request #5181 · matrix-org/matrix-rust-sdk

zzorba · 2025-06-05T15:46:09Z

Introduces SqliteSessionBuilder and IndexedDbSessionBuilder to allow for a choice of session store. Non-wasm platforms will only support sqlite, while Wasm platforms will support indexedb. In order to maintain a compatible-ffi, these restrictions are handled at runtime rather than compile time.

We also conditionally remove things related to network features (proxy, ssl validation, etc), that are not available on wasm platforms.

Public API changes documented in changelogs (optional)

Signed-off-by: Daniel Salinas

jplatte · 2025-06-05T15:49:53Z

PR title should probably make it clear that this is about the FFI crate :)

The challenge is to maintain a compatible -ffi API, despite the fact that both cannot be used on both platforms. Approach is to use runtime panics here to stop usage if it is being misused.

codecov · 2025-06-05T16:12:04Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.86%. Comparing base (34d3cd4) to head (43911b8).
Report is 134 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5181      +/-   ##
==========================================
- Coverage   85.87%   85.86%   -0.02%     
==========================================
  Files         338      338              
  Lines       37070    37070              
==========================================
- Hits        31834    31830       -4     
- Misses       5236     5240       +4

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

Hywan

Thanks for the patch.

First off, I believe you should split all the modifications from the Cargo.toml file into its own patch.

Second, I think you can simplify things by introducing a type alias SessionConfig. We don't want to expose SQLite or IndexedDb directly, we want to hide that from the consumer/user. See my suggestions.

What do you think?

Hywan · 2025-06-06T13:29:34Z


 [lib]
-crate-type = ["cdylib", "staticlib"]
+crate-type = ["cdylib", "staticlib", "lib"]


I'm not sure it's related to what the patch says it does. Can you split this in another patch please?

Yeah this seems weird, what's the idea with this?

The uniffi bindings generator requires the library to be built as a "lib" so it can be included in a second generated-rust library that is fed through. But I will break that out into a second PR.

Hywan · 2025-06-06T13:30:23Z

+[target.'cfg(target_family = "wasm")'.dependencies.matrix-sdk]
+workspace = true
+features = [
+    "anyhow",
+    "e2e-encryption",
+    "experimental-widgets",
+    "markdown",
+    "rustls-tls",
+    "socks",
+    "indexeddb",
+    "uniffi",
+]


All the changes in Cargo.toml just be in a dedicated patch.

Opened up #5211 which is nearly merged. I will rebase this branch with those changes (and other feedback) once it lands.

Hywan · 2025-06-06T13:33:33Z

-    pub fn username(self: Arc<Self>, username: String) -> Arc<Self> {
+#[derive(Clone, uniffi::Object)]
+pub struct IndexedDbSessionBuilder {
+    #[cfg_attr(not(target_family = "wasm"), allow(unused))]


We don't use IndexedDb outside Wasm, all fields can be present.

Hywan · 2025-06-06T13:34:38Z

+#[derive(Clone)]
+pub enum ClientSessionConfig {
+    /// Setup the client to use the SQLite store.
+    #[cfg_attr(target_family = "wasm", allow(unused))]
+    Sqlite(SqliteSessionBuilder),
+
+    /// Setup the client to use the IndexedDB store.
+    #[cfg_attr(not(target_family = "wasm"), allow(unused))]
+    IndexedDb(IndexedDbSessionBuilder),
+}


I think you can remove all this, and add:

Suggested change

#[derive(Clone)]

pub enum ClientSessionConfig {

/// Setup the client to use the SQLite store.

#[cfg_attr(target_family = "wasm", allow(unused))]

Sqlite(SqliteSessionBuilder),

/// Setup the client to use the IndexedDB store.

#[cfg_attr(not(target_family = "wasm"), allow(unused))]

IndexedDb(IndexedDbSessionBuilder),

}

#[cfg(target_family = "wasm")]

pub type SessionConfig = IndexedDbSessionBuilder;

#[cfg(not(target_family = "wasm"))]

pub type SessionConfig = SqliteSessionBuilder;

Hywan · 2025-06-06T13:37:29Z

+
+#[derive(Clone, uniffi::Object)]
+pub struct ClientBuilder {
+    session: Option<ClientSessionConfig>,


Then…

Suggested change

session: Option<ClientSessionConfig>,

session: Option<SessionConfig>

Hywan · 2025-06-06T13:39:32Z

+    pub fn session_sqlite(self: Arc<Self>, config: Arc<SqliteSessionBuilder>) -> Arc<Self> {
        let mut builder = unwrap_or_clone_arc(self);
-        builder.homeserver_cfg = Some(HomeserverConfig::ServerName(server_name));
+        builder.session = Some(ClientSessionConfig::Sqlite(config.as_ref().clone()));
        Arc::new(builder)
    }

-    pub fn homeserver_url(self: Arc<Self>, url: String) -> Arc<Self> {
+    pub fn session_indexeddb(self: Arc<Self>, config: Arc<IndexedDbSessionBuilder>) -> Arc<Self> {
        let mut builder = unwrap_or_clone_arc(self);
-        builder.homeserver_cfg = Some(HomeserverConfig::Url(url));
+        builder.session = Some(ClientSessionConfig::IndexedDb(config.as_ref().clone()));
        Arc::new(builder)
    }


And finally…

Suggested change

pub fn session_sqlite(self: Arc<Self>, config: Arc<SqliteSessionBuilder>) -> Arc<Self> {

let mut builder = unwrap_or_clone_arc(self);

builder.homeserver_cfg = Some(HomeserverConfig::ServerName(server_name));

builder.session = Some(ClientSessionConfig::Sqlite(config.as_ref().clone()));

Arc::new(builder)

}

pub fn homeserver_url(self: Arc<Self>, url: String) -> Arc<Self> {

pub fn session_indexeddb(self: Arc<Self>, config: Arc<IndexedDbSessionBuilder>) -> Arc<Self> {

let mut builder = unwrap_or_clone_arc(self);

builder.homeserver_cfg = Some(HomeserverConfig::Url(url));

builder.session = Some(ClientSessionConfig::IndexedDb(config.as_ref().clone()));

Arc::new(builder)

}

pub fn session(self: Arc<Self>, config: Arc<SessionConfig>) -> Arc<Self> {

let mut builder = unwrap_or_clone_arc(self);

builder.session = Some(config);

Arc::new(builder)

}

Co-authored-by: Ivan Enderlin <ivan@mnt.io> Signed-off-by: Daniel Salinas <zzorba@users.noreply.github.com>

Conditionalize uniffi exports when this flag is not present

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

Going to close this in favor of #5211 and #5245

zzorba requested a review from a team as a code owner June 5, 2025 15:46

zzorba requested review from Hywan and removed request for a team June 5, 2025 15:46

zzorba changed the title ~~Add ability to configure indexedb instead of sqlite for wasm platforms~~ feat(wasm): Add ability to configure indexedb instead of sqlite for wasm platforms Jun 5, 2025

zzorba force-pushed the wasm_client_builder_session branch from a1e186e to 3d39cdd Compare June 5, 2025 15:46

Add ability to configure indexedb instead of sqlite for wasm platforms

9ace356

The challenge is to maintain a compatible -ffi API, despite the fact that both cannot be used on both platforms. Approach is to use runtime panics here to stop usage if it is being misused.

zzorba force-pushed the wasm_client_builder_session branch from 3d39cdd to 9ace356 Compare June 5, 2025 15:57

zzorba changed the title ~~feat(wasm): Add ability to configure indexedb instead of sqlite for wasm platforms~~ feat(wasm): Add ability to configure indexedb instead of sqlite for wasm platforms in ffi crate Jun 5, 2025

Hywan self-assigned this Jun 5, 2025

Hywan changed the title ~~feat(wasm): Add ability to configure indexedb instead of sqlite for wasm platforms in ffi crate~~ feat(ffi): Add ability to configure indexedb instead of sqlite for wasm platforms Jun 6, 2025

Hywan requested changes Jun 6, 2025

View reviewed changes

zzorba and others added 3 commits June 9, 2025 09:04

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

8196842

Co-authored-by: Ivan Enderlin <ivan@mnt.io> Signed-off-by: Daniel Salinas <zzorba@users.noreply.github.com>

ClientSessionConfig should not be public

b810233

Remove js flag in favor of cross-platform-api flag

43911b8

Conditionalize uniffi exports when this flag is not present

zzorba closed this Jun 18, 2025

	session: Option<ClientSessionConfig>,
	session: Option<SessionConfig>

Uh oh!

Conversation

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

Uh oh!

Uh oh!

jplatte commented Jun 5, 2025

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

Hywan left a comment

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!

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!

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

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

zzorba commented Jun 5, 2025 •

edited

Loading

codecov Bot commented Jun 5, 2025 •

edited

Loading

zzorba commented Jun 18, 2025 •

edited

Loading