feat(sdk): Spaces #5509

stefanceriu · 2025-08-08T11:29:39Z

This series of patches introduces a top level UI oriented interface for interacting with spaces.

The SpaceService offers:

a method for retrieving one's top level joined_spaces and a subscribe_to_joined_spaces stream that automatically updates based on client activity
- to do so the service builds a graph from all the m.space.parent and m.space.children state events it knows about, removing cycles and then only keeping parent spaces
a SpaceRoomList that can be used to interact with the rooms hierarchy endpoint and retrieve rooms referencing a certain parent
- the room list is responsible for holding the pagination state as well as listening to client activity and automatically publishing room state updates through its subscribe_to_room_updates publisher (e.g. when joining one of the rooms)

Ongoing:

convert the publishers to use vector diffs
add documentation with examples

codecov · 2025-08-08T12:17:08Z

Codecov Report

❌ Patch coverage is 90.93407% with 66 lines in your changes missing coverage. Please review.
✅ Project coverage is 88.61%. Comparing base (eefa9ff) to head (e8325fe).
⚠️ Report is 16 commits behind head on main.
✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
...x-sdk-base/src/response_processors/state_events.rs	29.62%	0 Missing and 19 partials ⚠️
crates/matrix-sdk-ui/src/spaces/mod.rs	94.55%	16 Missing ⚠️
crates/matrix-sdk-ui/src/spaces/room_list.rs	91.75%	13 Missing and 3 partials ⚠️
crates/matrix-sdk-ui/src/spaces/graph.rs	94.82%	4 Missing and 2 partials ⚠️
crates/matrix-sdk/src/test_utils/mocks/mod.rs	91.48%	4 Missing ⚠️
crates/matrix-sdk-ui/src/spaces/room.rs	91.89%	0 Missing and 3 partials ⚠️
crates/matrix-sdk/src/room/mod.rs	50.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5509      +/-   ##
==========================================
+ Coverage   88.57%   88.61%   +0.04%     
==========================================
  Files         340      344       +4     
  Lines       93690    94389     +699     
  Branches    93690    94389     +699     
==========================================
+ Hits        82989    83646     +657     
- Misses       6568     6602      +34     
- Partials     4133     4141       +8

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

codspeed-hq · 2025-08-08T12:18:18Z

CodSpeed Performance Report

Merging #5509 will not alter performance

_{Comparing stefan/spaces (e8325fe) with main (9601624)}

Summary

✅ 31 untouched benchmarks

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

Hywan

First fast review. Keep going!

crates/matrix-sdk-ui/src/spaces/mod.rs

crates/matrix-sdk-ui/src/spaces/room.rs

crates/matrix-sdk-ui/src/spaces/room_list.rs

crates/matrix-sdk-ui/src/spaces/mod.rs

Hywan · 2025-08-11T14:59:32Z

crates/matrix-sdk-ui/src/spaces/mod.rs

+        let handle = tokio::spawn(async move {
+            pin_mut!(all_room_updates_receiver);
+
+            loop {
+                match all_room_updates_receiver.recv().await {
+                    Ok(_) => {
+                        let new_spaces = Self::joined_spaces_for(&client_clone);
+                        if new_spaces != joined_spaces_clone.get() {
+                            joined_spaces_clone.set(new_spaces);
+                        }
+                    }
+                    Err(err) => {
+                        error!("error when listening to room updates: {err}");
+                    }
+                }
+            }
+        });


Be careful to use AbortOnDrop here, we don't want the task to be detached.

Oh, isn't manually aborting it in Drop for SpaceService enough? 🤔

pixlwave

This is only a review on the FFI layer, but looks great!. Can't wait to see it land 🔭

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

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

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

pixlwave · 2025-08-15T16:29:20Z

Something weird is going on with the latest version, all of my joined_spaces have a children_count of 0.

There's a branch here if you want to test the updates with diffing:
https://github.com/element-hq/element-x-ios/tree/doug/sdk-space-service

stefanceriu · 2025-08-18T10:46:13Z

Something weird is going on with the latest version, all of my joined_spaces have a children_count of 0.

There's a branch here if you want to test the updates with diffing: https://github.com/element-hq/element-x-ios/tree/doug/sdk-space-service

Went ahead and fixed the remaining issues with VectorDiffs, seems fine now on your branch. Thanks for testing!

…d `sync_events` to the `EventFactory`

…provides reactive interfaces to its rooms and pagination state

…::joined_spaces` and its reactive counterpart

…states change i.e. they get joined or left.

…ted uniffi version - automatic Arc inference was introduced in 0.27 and complement is using 0.25

…d comments

…state events in the sliding sync required state as they're both required to build a full view of the space room hierarchy

…tions to correctly detect all the edges and be able to remove any cycles. - cycle removing is done through DFS and keeping a list of visited nodes

…ceServiceRoomList::paginate`

…ption methods so it can be retained on the client side

…alls so only the direct children are fetche

…` responses and `SpaceServiceRoomList` instances

…tead automatically setup a client subscription when requesting the joined services subscription

…d components on both the UI and the FFI crates

…ned spaces and space room list subscriptions

stefanceriu force-pushed the stefan/spaces branch 2 times, most recently from 655477a to f52ebdb Compare August 8, 2025 12:02

pixlwave reviewed Aug 8, 2025

View reviewed changes

bindings/matrix-sdk-ffi/src/spaces.rs Outdated Show resolved Hide resolved

stefanceriu force-pushed the stefan/spaces branch 3 times, most recently from eab6c0c to 0b14496 Compare August 11, 2025 13:07

Hywan reviewed Aug 11, 2025

View reviewed changes

stefanceriu force-pushed the stefan/spaces branch 2 times, most recently from 5024faa to a2a4ef8 Compare August 11, 2025 16:14

pixlwave reviewed Aug 11, 2025

View reviewed changes

stefanceriu force-pushed the stefan/spaces branch 5 times, most recently from aff6435 to 8dc94da Compare August 12, 2025 13:06

pixlwave mentioned this pull request Aug 12, 2025

Add SpaceRoomCell & Space…ProxyProtocols and use them on the SpaceListScreen. element-hq/element-x-ios#4404

Merged

stefanceriu force-pushed the stefan/spaces branch from 8dc94da to 2e0ed68 Compare August 13, 2025 06:46

bnjbvr changed the title ~~Spaces~~ feat(sdk): Spaces Aug 14, 2025

stefanceriu force-pushed the stefan/spaces branch 2 times, most recently from cde1a3d to e761648 Compare August 14, 2025 14:57

stefanceriu force-pushed the stefan/spaces branch from e761648 to 6f0c641 Compare August 18, 2025 07:45

stefanceriu added 5 commits August 18, 2025 13:50

chore(spaces): setup a simple space service and some unit tests

84209fd

chore(spaces): move space specific test fixtures from test_event an…

7ff3034

…d `sync_events` to the `EventFactory`

chore(spaces): introduce a SpaceServiceRoom

1970b49

feat(spaces): introduce a SpaceRoomList that allows pagination and …

417d376

…provides reactive interfaces to its rooms and pagination state

feat(spaces): add a reactive version of the joined_spaces method

6d8961d

stefanceriu added 18 commits August 18, 2025 14:02

change(spaces): return only top level joined rooms from `SpaceService…

304e282

…::joined_spaces` and its reactive counterpart

feat(spaces): have the SpaceRoomList publish updates as known room …

c9d46de

…states change i.e. they get joined or left.

fix(spaces): fix complement-crypto failures because of using an outda…

bdc7d83

…ted uniffi version - automatic Arc inference was introduced in 0.27 and complement is using 0.25

fix(spaces): use wasm compatible executor spawn and JoinHandle

90059a2

fix(room): fix event types in matrix_sdk::Room::parent_spaces metho…

beae1f9

…d comments

change(room_list): request both m.space.parent and m.space.child …

d6f0126

…state events in the sliding sync required state as they're both required to build a full view of the space room hierarchy

chore(spaces): build a graph from joined spaces parent and child rela…

b41157e

…tions to correctly detect all the edges and be able to remove any cycles. - cycle removing is done through DFS and keeping a list of visited nodes

feat(ffi): expose SpaceService::subscribe_to_joined_spaces and `Spa…

36867e7

…ceServiceRoomList::paginate`

fix(spaces): return the TaskHandle from the FFI space service subscri…

76c51f8

…ption methods so it can be retained on the client side

feat(spaces): expose the number of children each space room has

7c12725

change(spaces): put a limit of 1 on the max depth of the /hierarchy c…

004df0f

…alls so only the direct children are fetche

fix(spaces): filter out the current parent space from the `/hierarchy…

1ac356a

…` responses and `SpaceServiceRoomList` instances

change(spaces): make the SpaceService constructor non-async and ins…

9168c30

…tead automatically setup a client subscription when requesting the joined services subscription

chore(spaces): converge on single naming scheme for all spaces relate…

511c975

…d components on both the UI and the FFI crates

chore(spaces): add changelog

b13fb14

change(spaces): publish VectorDiffs instead of a full vectors for joi…

5e546f6

…ned spaces and space room list subscriptions

chore(spaces): ignore room list change updates if empty

571daa7

docs(spaces): add documentation, comments and examples

e8325fe

stefanceriu force-pushed the stefan/spaces branch from 3d541e6 to e8325fe Compare August 19, 2025 07:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(sdk): Spaces #5509

feat(sdk): Spaces #5509

stefanceriu commented Aug 8, 2025 •

edited

Loading

Uh oh!

codecov bot commented Aug 8, 2025 •

edited

Loading

Uh oh!

codspeed-hq bot commented Aug 8, 2025 •

edited

Loading

Uh oh!

Uh oh!

Hywan left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Hywan Aug 11, 2025

Uh oh!

stefanceriu Aug 11, 2025

Uh oh!

pixlwave left a comment •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pixlwave commented Aug 15, 2025

Uh oh!

stefanceriu commented Aug 18, 2025

Uh oh!

Uh oh!

feat(sdk): Spaces #5509

Are you sure you want to change the base?

feat(sdk): Spaces #5509

Conversation

stefanceriu commented Aug 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

codspeed-hq bot commented Aug 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #5509 will not alter performance

Summary

Uh oh!

Uh oh!

Hywan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Hywan Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

stefanceriu Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

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

pixlwave commented Aug 15, 2025

Uh oh!

stefanceriu commented Aug 18, 2025

Uh oh!

Uh oh!

stefanceriu commented Aug 8, 2025 •

edited

Loading

codecov bot commented Aug 8, 2025 •

edited

Loading

codspeed-hq bot commented Aug 8, 2025 •

edited

Loading

pixlwave left a comment •

edited

Loading