macltok

public

Star0

Fork 0

Watch0

36 commits 3 branches 0 tags 0 releases3.0 MiB

Commit `dc609022bb53`

tarball

atagen <boss@atagen.co>2026-10-22 09:31 UTC

7 files changed+65-72

engine: share the room key while the user types, on a forked sdk

The public-only warm-up could only sync members, leaving /keys/claim and the room key share on the send path, which is the slow federated half. A matrix-rust-sdk fork exposing Room::prepare_encryption runs the send queue's own prep early, inside its per-room share dedup, so a send after a warm-up is just the PUT. The patch points at a sibling checkout until the fork has a git URL.

Modified file: Cargo.lock−20 deletions@@ -1999,8 +1999,6 @@ dependencies = [
 [[package]]
 name = "matrix-sdk"
 version = "0.18.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7083d580527511ac5d9369e03b9f2b20902e76949f1b3964051f978e4d3756ae"
 dependencies = [
  "anymap2",
  "aquamarine",
@@ -2063,8 +2061,6 @@ dependencies = [
 [[package]]
 name = "matrix-sdk-base"
 version = "0.18.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e09a917eb1f7643d9d9a06b2f131e2ceb39df6910a7b830dac18bfd6db37a1f5"
 dependencies = [
  "as_variant",
  "assert_matches",
@@ -2094,8 +2090,6 @@ dependencies = [
 [[package]]
 name = "matrix-sdk-common"
 version = "0.18.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2b9d1e0fee0f090180ef9457034adc547e80de9e6e3eb2e63aaac68a8476f836"
 dependencies = [
  "eyeball-im",
  "futures-core",
@@ -2118,8 +2112,6 @@ dependencies = [
 [[package]]
 name = "matrix-sdk-crypto"
 version = "0.18.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c54afd2a326f51c13a6ad44ec86315a688fffeb3f1e287fb343e0e1836a3bdaf"
 dependencies = [
  "aes",
  "aquamarine",
@@ -2160,8 +2152,6 @@ dependencies = [
 [[package]]
 name = "matrix-sdk-indexeddb"
 version = "0.18.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "fef37395fffb7c916f7109ab0d16d8ca599403dd8164d08c0d966176b66ede47"
 dependencies = [
  "async-trait",
  "base64",
@@ -2193,8 +2183,6 @@ dependencies = [
 [[package]]
 name = "matrix-sdk-sqlite"
 version = "0.18.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a49133429271005745f8d5a05362d2ba6567274777250236799927ca30dc0670"
 dependencies = [
  "as_variant",
  "async-trait",
@@ -2221,8 +2209,6 @@ dependencies = [
 [[package]]
 name = "matrix-sdk-store-encryption"
 version = "0.18.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2f48f304e553fb6200b1d7d1f77a88fd182076d4b25624e9dbfa42d6a37de35e"
 dependencies = [
  "base64",
  "blake3",
@@ -2243,8 +2229,6 @@ dependencies = [
 [[package]]
 name = "matrix-sdk-test"
 version = "0.18.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8023d4315fff35598c2d4a955920c1273c6aaab4dcd9ed405238a882581649bf"
 dependencies = [
  "as_variant",
  "ctor",
@@ -2267,8 +2251,6 @@ dependencies = [
 [[package]]
 name = "matrix-sdk-test-macros"
 version = "0.18.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d97d6a0e5b1401c530b3c5d18cb98257d255d396bacf3903beda6718a2f4c4c5"
 dependencies = [
  "quote",
  "syn 2.0.119",
@@ -2277,8 +2259,6 @@ dependencies = [
 [[package]]
 name = "matrix-sdk-ui"
 version = "0.18.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6d1f2b8a8cf57164d7cee4eb61c0b9f074b2e11d766a9391b7db0b9f2cbd83d8"
 dependencies = [
  "as_variant",
  "async-rx",

Modified file: Cargo.toml+12 additions@@ -76,3 +76,15 @@ unsafe_code = "forbid"
 
 [lints.clippy]
 all = "warn"
+
+[patch.crates-io]
+matrix-sdk = { path = "../matrix-rust-sdk/crates/matrix-sdk" }
+matrix-sdk-base = { path = "../matrix-rust-sdk/crates/matrix-sdk-base" }
+matrix-sdk-common = { path = "../matrix-rust-sdk/crates/matrix-sdk-common" }
+matrix-sdk-crypto = { path = "../matrix-rust-sdk/crates/matrix-sdk-crypto" }
+matrix-sdk-indexeddb = { path = "../matrix-rust-sdk/crates/matrix-sdk-indexeddb" }
+matrix-sdk-sqlite = { path = "../matrix-rust-sdk/crates/matrix-sdk-sqlite" }
+matrix-sdk-store-encryption = { path = "../matrix-rust-sdk/crates/matrix-sdk-store-encryption" }
+matrix-sdk-test = { path = "../matrix-rust-sdk/testing/matrix-sdk-test" }
+matrix-sdk-test-macros = { path = "../matrix-rust-sdk/testing/matrix-sdk-test-macros" }
+matrix-sdk-ui = { path = "../matrix-rust-sdk/crates/matrix-sdk-ui" }

Modified file: docs/design-decisions.md+31 additions−27 deletions@@ -124,30 +124,18 @@ cancels it
 the sdk does all its key work on the send path, in the room's send queue before
 the `/send` itself. members synced, a `/keys/query` for anyone untracked or
 dirty, then a `/keys/claim` and the room key sent to every device. over a slow
-federation that's a minute of nothing. `prepare_to_send` does what the public
-api lets us of that, ahead of time, which comes down to syncing the members if
-they aren't. the sdk dedups that with its own sync, and it marks every member
-tracked and dirty, so the sdk's background outgoing requests run the
-`/keys/query` long before the send would have. that's what moves the query off
-the send path. we don't ask `request_user_identity` for anyone, since that's
-an out of band query that never marks a user tracked or up to date
-(matrix-sdk-crypto `identities/manager.rs` ~804-817), federated traffic the
-send path would redo anyway. a synced room costs nothing, so there's no
-cooldown. one warm-up per room at a time, a second ask joins it. opening a room
-or starting to type runs one too, unless `EngineConfig::prepare_to_send` is
-off. it's on because malice asked, not because anyone decided
-
-that's the leftovers of turning down a matrix-sdk fork. the `/keys/claim` and
-the room key share, the slow federated half, stay on the send path. the
-background `/keys/query` runs when the sdk next sends its outgoing requests,
-after a sync response, and `send_outgoing_requests` is crate private, so a send
-straight after a warm-up can still find the members dirty and query them itself.
-and we can't join the dedup the sdk wraps its own prep in
-
-the hook upstream is the todo above `preshare_room_key` at matrix-sdk
-`room/mod.rs` ~2392, asking for exactly this. it's still private on main and in
-0.19.1 as of 2026-09-26. once upstream makes it public, or a fork becomes
-acceptable, `prepare_to_send` should just call it and most of this goes
+federation that's a minute of nothing. `prepare_to_send` runs all of it ahead
+of time through the fork's `Room::prepare_encryption`, the same function the
+send queue calls. the share sits behind the sdk's per-room dedup, so a send
+landing mid-warm-up waits for it rather than sharing again, and a send after it
+finds nothing left to do but the `/send`. a room whose encryption isn't known
+yet gets asked, which the send would have done anyway. one warm-up per room at
+a time, a second ask joins it. opening a room or starting to type runs one too,
+unless `EngineConfig::prepare_to_send` is off. it's on because malice asked,
+not because anyone decided
+
+the session rotates after 100 messages or a week, and sharing isn't a message,
+so a warm-up is only wasted on a room left idle about that long
 
 ## mutations
 
@@ -302,9 +290,7 @@ keyed by `CsrfToken` (matrix-sdk 0.18, `authentication/oauth/mod.rs` around
 `finish_login` on a fresh client answers `InvalidState`. doing the code grant
 ourselves would copy some 250 lines of the sdk's private oauth behaviour and
 drift from it every upgrade. patching the sdk to export and import that data is
-small, but it means carrying a matrix-sdk fork, which we won't for now. upstream
-exposing export and import of pending authorization data, or a fork becoming
-acceptable, reopens this
+small, and since we carry a fork now that's the way to do it. not built yet
 
 ## room lists, spaces and profiles
 
@@ -359,6 +345,24 @@ most. a diff for a timeline with no reset is a divergence too, so a wrapper
 that swallowed the reset still heals. anything a late subscriber needs, failures
 included, lives in the state rather than only in an update
 
+## the sdk fork
+
+we build against a fork of matrix-rust-sdk, branch `macltok`, cut from the
+matrix-sdk 0.18.0 tag. turned down on 2026-09-26, taken up on 2026-10-22 once
+it was holding back features every peer client has. every workspace that builds
+macltok needs the same `[patch.crates-io]` block, since patches don't reach
+dependents, and it keeps macltok off crates.io until upstream takes the patches.
+a vendored copy of macltok should drop its own block, cargo ignores it there
+and says so on every build
+
+it carries visibility and config changes, each small enough to be an upstream
+pr, and nothing that changes how the sdk behaves. if that stops being true,
+especially in the timeline or the send queue, it's time to drop matrix-sdk and
+matrix-sdk-ui for our own layer over matrix-sdk-base and matrix-sdk-crypto,
+which keep their public sans-io apis
+
+- `Room::prepare_encryption`, the send path's encryption prep made public
+
 ## public model
 
 owned ruma ids and typed data wherever there's a stable shape, `Raw` where

Modified file: harness/web/Cargo.lock−16 deletions@@ -1905,8 +1905,6 @@ dependencies = [
 [[package]]
 name = "matrix-sdk"
 version = "0.18.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7083d580527511ac5d9369e03b9f2b20902e76949f1b3964051f978e4d3756ae"
 dependencies = [
  "anymap2",
  "aquamarine",
@@ -1966,8 +1964,6 @@ dependencies = [
 [[package]]
 name = "matrix-sdk-base"
 version = "0.18.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e09a917eb1f7643d9d9a06b2f131e2ceb39df6910a7b830dac18bfd6db37a1f5"
 dependencies = [
  "as_variant",
  "async-trait",
@@ -1993,8 +1989,6 @@ dependencies = [
 [[package]]
 name = "matrix-sdk-common"
 version = "0.18.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2b9d1e0fee0f090180ef9457034adc547e80de9e6e3eb2e63aaac68a8476f836"
 dependencies = [
  "eyeball-im",
  "futures-core",
@@ -2017,8 +2011,6 @@ dependencies = [
 [[package]]
 name = "matrix-sdk-crypto"
 version = "0.18.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c54afd2a326f51c13a6ad44ec86315a688fffeb3f1e287fb343e0e1836a3bdaf"
 dependencies = [
  "aes",
  "aquamarine",
@@ -2058,8 +2050,6 @@ dependencies = [
 [[package]]
 name = "matrix-sdk-indexeddb"
 version = "0.18.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "fef37395fffb7c916f7109ab0d16d8ca599403dd8164d08c0d966176b66ede47"
 dependencies = [
  "async-trait",
  "base64",
@@ -2091,8 +2081,6 @@ dependencies = [
 [[package]]
 name = "matrix-sdk-sqlite"
 version = "0.18.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a49133429271005745f8d5a05362d2ba6567274777250236799927ca30dc0670"
 dependencies = [
  "as_variant",
  "async-trait",
@@ -2119,8 +2107,6 @@ dependencies = [
 [[package]]
 name = "matrix-sdk-store-encryption"
 version = "0.18.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2f48f304e553fb6200b1d7d1f77a88fd182076d4b25624e9dbfa42d6a37de35e"
 dependencies = [
  "base64",
  "blake3",
@@ -2141,8 +2127,6 @@ dependencies = [
 [[package]]
 name = "matrix-sdk-ui"
 version = "0.18.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6d1f2b8a8cf57164d7cee4eb61c0b9f074b2e11d766a9391b7db0b9f2cbd83d8"
 dependencies = [
  "as_variant",
  "async-rx",

Modified file: harness/web/Cargo.toml+10 additions@@ -45,3 +45,13 @@ lto = true
 codegen-units = 1
 panic = "abort"
 strip = true
+
+[patch.crates-io]
+matrix-sdk = { path = "../../../matrix-rust-sdk/crates/matrix-sdk" }
+matrix-sdk-base = { path = "../../../matrix-rust-sdk/crates/matrix-sdk-base" }
+matrix-sdk-common = { path = "../../../matrix-rust-sdk/crates/matrix-sdk-common" }
+matrix-sdk-crypto = { path = "../../../matrix-rust-sdk/crates/matrix-sdk-crypto" }
+matrix-sdk-indexeddb = { path = "../../../matrix-rust-sdk/crates/matrix-sdk-indexeddb" }
+matrix-sdk-sqlite = { path = "../../../matrix-rust-sdk/crates/matrix-sdk-sqlite" }
+matrix-sdk-store-encryption = { path = "../../../matrix-rust-sdk/crates/matrix-sdk-store-encryption" }
+matrix-sdk-ui = { path = "../../../matrix-rust-sdk/crates/matrix-sdk-ui" }

Modified file: src/engine/prepare.rs+5 additions−9 deletions@@ -33,15 +33,11 @@ impl Preparations {
     }
 }
 
-/// the part of the sdk's pre-send encryption work it lets us reach. syncing the members
-/// has the sdk track them all, and its own background `/keys/query` then catches up
-/// their devices. the one time key claim and the room key share stay on the send path
+/// the sdk's own pre-send work, run early. a send landing mid-share waits on the
+/// sdk's per-room share lock instead of starting another (forked sdk, see design-decisions)
 async fn prepare(client: Client, room_id: OwnedRoomId) -> Result<(), Error> {
     let room = client.get_room(&room_id).ok_or_else(Error::room_unknown)?;
-    if room.encryption_state().is_encrypted() && !room.are_members_synced() {
-        room.sync_members()
-            .await
-            .map_err(|source| Error::from_sdk("syncing room members failed", source))?;
-    }
-    Ok(())
+    room.prepare_encryption()
+        .await
+        .map_err(|source| Error::from_sdk("preparing room encryption failed", source))
 }

Modified file: tests/prepare.rs+7 additions@@ -45,6 +45,13 @@ async fn prepare_twice(encrypted: bool, member_syncs: u64) {
         .expect(member_syncs)
         .mount()
         .await;
+    let encryption = server.mock_room_state_encryption();
+    if encrypted {
+        encryption.encrypted().mount().await;
+    } else {
+        encryption.plain().mount().await;
+    }
+    server.mock_query_keys().ok().mount().await;
     let config = EngineConfig::default()
         .with_initial_history_limit(0)
         .with_prepare_to_send(false);

macltok

Commit dc609022bb53

Commit `dc609022bb53`