continuwuation/continuwuity
8
20
Fork 18
Code Issues 82 Pull requests 8 Projects Releases 17 Packages 1 Activity Actions 1

Improve space (and room!) upgrades #907

Merged
nex merged 8 commits from nex/feat/space-upgrades into main 2025-07-19 18:44:56 +00:00
Conversation 1 Commits 8 Files changed 2 +145 -31
nex commented 2025-07-19 14:47:46 +00:00
Owner
Copy link

This PR does the following:

  • Implements MSC4168 by updating both the parent and child space references
  • Fixes an issue where only state with an empty state key ("") is cloned
  • Adds a helper function that allows the state_accessor service to iterate over all of the state keys for a given event type

This is primarily in preparation for room v12, where some people may desire to upgrade their spaces.
It is important to note that some clients, such as Element Web and possibly Cinny, perform these new steps client-side as well. Given we create & send the events first, this just results in overlapping behaviour, rather than a functional issue, and is safe to ignore.

This PR does the following: - Implements [MSC4168](https://github.com/matrix-org/matrix-spec-proposals/pull/4168) by updating both the parent and child space references - Fixes an issue where only state with an empty state key (`""`) is cloned - Adds a helper function that allows the `state_accessor` service to iterate over all of the state keys for a given event type This is primarily in preparation for room v12, where some people may desire to upgrade their spaces. It is important to note that some clients, such as Element Web and possibly Cinny, perform these new steps client-side as well. Given we create & send the events first, this just results in overlapping behaviour, rather than a functional issue, and is safe to ignore.
nex added this to the 0.5.0 milestone 2025-07-19 14:47:46 +00:00
nex added the
Enhancement
Matrix/Client
Matrix/MSC
 labels 2025-07-19 14:47:46 +00:00
nex added 7 commits 2025-07-19 14:47:46 +00:00
feat(space-upgrades): Copy over space child & parent states
All checks were successful
Release Docker Image / define-variables (push) Successful in 2s
Details
Checks / Prefligit / prefligit (push) Successful in 28s
Details
Checks / Rust / Format (push) Successful in 59s
Details
Checks / Rust / Clippy (push) Successful in 4m5s
Details
Checks / Rust / Cargo Test (push) Successful in 4m36s
Details
Release Docker Image / build-image (linux/amd64, release, linux-amd64, base) (push) Successful in 10m54s
Details
Release Docker Image / build-image (linux/arm64, release, linux-arm64, base) (push) Successful in 21m28s
Details
Release Docker Image / merge (push) Successful in 31s
Details
f7410283cf 
This relies on the room being upgraded referencing
the space itself, but there isn't an easy way to
do it otherwise.
Before this change, only state events with an
empty state key would be cloned.
This allows m.space.child to be cloned appropriately.
fix(space-upgrades): Incorrectly updated parent children events
Some checks failed
Release Docker Image / merge (push) Blocked by required conditions
Details
Release Docker Image / define-variables (push) Successful in 2s
Details
Checks / Prefligit / prefligit (push) Successful in 26s
Details
Checks / Rust / Format (push) Successful in 44s
Details
Checks / Rust / Clippy (push) Successful in 3m41s
Details
Checks / Rust / Cargo Test (push) Successful in 4m10s
Details
Release Docker Image / build-image (linux/amd64, release, linux-amd64, base) (push) Has been cancelled
Details
Release Docker Image / build-image (linux/arm64, release, linux-arm64, base) (push) Has been cancelled
Details
390c1ab18e
feat(space-upgrades): Skip empty state events in room upgrade
Some checks failed
Release Docker Image / build-image (linux/arm64, release, linux-arm64, base) (push) Blocked by required conditions
Details
Release Docker Image / merge (push) Blocked by required conditions
Details
Release Docker Image / define-variables (push) Successful in 3s
Details
Checks / Prefligit / prefligit (push) Successful in 27s
Details
Checks / Rust / Format (push) Successful in 41s
Details
Checks / Rust / Cargo Test (push) Has been cancelled
Details
Checks / Rust / Clippy (push) Has been cancelled
Details
Release Docker Image / build-image (linux/amd64, release, linux-amd64, base) (push) Has been cancelled
Details
e586dcd8f2
fix(space-upgrades): Remove unused helper function
Some checks failed
Release Docker Image / build-image (linux/amd64, release, linux-amd64, base) (push) Blocked by required conditions
Details
Release Docker Image / merge (push) Blocked by required conditions
Details
Checks / Rust / Clippy (push) Waiting to run
Details
Checks / Rust / Cargo Test (push) Waiting to run
Details
Release Docker Image / define-variables (push) Successful in 4s
Details
Checks / Prefligit / prefligit (push) Successful in 21s
Details
Checks / Rust / Format (push) Successful in 45s
Details
Checks / Prefligit / prefligit (pull_request) Successful in 23s
Details
Documentation / Build and Deploy Documentation (pull_request) Successful in 49s
Details
Release Docker Image / build-image (linux/arm64, release, linux-arm64, base) (push) Has been cancelled
Details
b75842ab88
requested reviews from Jade, Owners 2025-07-19 14:47:53 +00:00
nex added 1 commit 2025-07-19 14:51:09 +00:00
feat(space-upgrades): MSC4168: Override space child vias
Some checks failed
Release Docker Image / build-image (linux/arm64, release, linux-arm64, base) (push) Blocked by required conditions
Details
Release Docker Image / merge (push) Blocked by required conditions
Details
Release Docker Image / define-variables (push) Successful in 2s
Details
Checks / Prefligit / prefligit (push) Successful in 35s
Details
Checks / Rust / Format (push) Successful in 53s
Details
Documentation / Build and Deploy Documentation (pull_request) Successful in 49s
Details
Checks / Prefligit / prefligit (pull_request) Successful in 27s
Details
Checks / Rust / Clippy (push) Failing after 3m40s
Details
Release Docker Image / build-image (linux/amd64, release, linux-amd64, base) (push) Has been cancelled
Details
Checks / Rust / Cargo Test (push) Failing after 16m35s
Details
6691b7672b
nex added 1 commit 2025-07-19 14:57:58 +00:00
style(space-upgrades): Remove unused import left over from 6691b7672b
All checks were successful
Release Docker Image / define-variables (push) Successful in 17s
Details
Checks / Prefligit / prefligit (push) Successful in 53s
Details
Checks / Rust / Format (push) Successful in 1m4s
Details
Documentation / Build and Deploy Documentation (pull_request) Successful in 36s
Details
Checks / Prefligit / prefligit (pull_request) Successful in 19s
Details
Checks / Rust / Clippy (push) Successful in 5m22s
Details
Checks / Rust / Cargo Test (push) Successful in 5m46s
Details
Release Docker Image / build-image (linux/amd64, release, linux-amd64, base) (push) Successful in 13m47s
Details
Release Docker Image / build-image (linux/arm64, release, linux-arm64, base) (push) Successful in 14m4s
Details
Release Docker Image / merge (push) Successful in 27s
Details
607caddacf
Jade force-pushed nex/feat/space-upgrades from 607caddacf to c639228f4d 2025-07-19 17:37:54 +00:00 Compare
Jade approved these changes 2025-07-19 18:14:46 +00:00
Jade left a comment
Owner
Copy link

I think it's pretty much good, although I wonder if in future it's worth breaking this out into a separate function outside of the API crate.

I think it's pretty much good, although I wonder if in future it's worth breaking this out into a separate function outside of the API crate.
src/api/client/room/upgrade.rs
@ -297,0 +338,4 @@
&body.room_id
);
// First, drop the space's child event
let state_lock = services.rooms.state.mutex.lock(space_id).await;
Jade commented 2025-07-19 18:12:23 +00:00
Owner
Copy link

This lock should probably be an explicit scope. conduwuit::utils::with_lock::WithLock then mutex.with_lock(|state_lock| {, instead of using drop - from the code style guide.

This lock should probably be an explicit scope. `conduwuit::utils::with_lock::WithLock` then `mutex.with_lock(|state_lock| {`, instead of using drop - from the code style guide.
nex commented 2025-07-19 18:53:06 +00:00
Author
Owner
Copy link

(resolved with no changes because the desired system isn't compatible with the mutex in question)

(resolved with no changes because the desired system isn't compatible with the mutex in question)
nex marked this conversation as resolved
src/api/client/room/upgrade.rs
@ -297,0 +367,4 @@
PduBuilder {
event_type: StateEventType::SpaceChild.into(),
content: to_raw_value(&SpaceChildEventContent {
via: vec![sender_user.server_name().to_owned()],
Jade commented 2025-07-19 17:40:57 +00:00
Owner
Copy link

Shouldn't via be multiple servers? Although IG we would be the only server in the room, so not much we can do other than update later.

Shouldn't via be multiple servers? Although IG we would be the only server in the room, so not much we can do other than update later.
nex commented 2025-07-19 18:15:19 +00:00
Author
Owner
Copy link

MSC explicitly states only the sender server should be included

MSC explicitly states only the sender server should be included
Jade marked this conversation as resolved
nex merged commit c639228f4d into main 2025-07-19 18:44:56 +00:00
nex deleted branch nex/feat/space-upgrades 2025-07-19 18:44:56 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Jade
Labels
Clear labels   
Bug

Something isn't working as intended

  
Cherry-picking

Commits picked from other conduit projects

  
Database

This requires or includes changes to the database

  
Dependencies

Something dependency related

  
Difficulty
Easy
Low difficulty to implement - touches few parts of the codebase, low complexity

  
Difficulty
Hard
High difficulty to implement - touches many parts of the codebase, high complexity

  
Difficulty
Medium
Medium difficulty to implement - touches more parts of the codebase, higher complexity

  
Documentation

Improvements or additions to documentation

  
Enhancement

New feature or request

  
Good first issue

Good for newcomers

  
Help wanted

Additional eyes and keyboards are required for this one

  
Inherited

Issues that have been inhereted from the project pre-fork

  
Matrix/Administration

Features pertaining to homeserver administration

  
Matrix/Appservices

Features pertaining to the appservice API

  
Matrix/Auth

Features pertaining to authentication

  
Matrix/Client

Features pertaining to client-to-server interactions

  
Matrix/Core

   
Matrix/Federation

Features pertaining to server-to-server interactions

  
Matrix/MSC

Features pertaining to unstable matrix features

  
Matrix/Media

Features pertaining to media interactions

  
Meta

Related to housekeeping, maintenance, or other repo-meta.

  
Meta/Packaging

Packaging

  
Priority
Blocking
This issue is blocking the next release

  
Priority
High
This issue is very important

  
Priority
Low
This issue is of a rather low priority

  
Security

This item is related to general security

  
Status
Confirmed

  
Status
Duplicate
This issue or pull request already exists

  
Status
Invalid
This issue doesn't seem right

  
Status
Needs Investigation
This issue needs further investigation

  
Wont fix

This will not be worked on

  
old/ci/cd

Ci/CD

Archived

  
old/rust

Pull requests that update Rust code

Archived

No labels
Bug
Cherry-picking
Database
Dependencies
Difficulty
Easy
Difficulty
Hard
Difficulty
Medium
Documentation
Enhancement
Good first issue
Help wanted
Inherited
Matrix/Administration
Matrix/Appservices
Matrix/Auth
Matrix/Client
Matrix/Core
Matrix/Federation
Matrix/MSC
Matrix/Media
Meta
Meta/Packaging
Priority
Blocking
Priority
High
Priority
Low
Security
Status
Confirmed
Status
Duplicate
Status
Invalid
Status
Needs Investigation
Wont fix
old/ci/cd
old/rust
Milestone
Clear milestone
No items
No milestone
0.5.0
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: continuwuation/continuwuity#907
No description provided.
Delete branch "nex/feat/space-upgrades"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?