Skip to content

Add tests for downgrading a v12 room to one that doesn't support MSC4289 #794

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Add tests for downgrading a v12 room to one that doesn't support MSC4289 #794

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
69ad30d
Add tests for downgrading a v12 room
anoadragon453 Aug 14, 2025
6d6d964
Remove initialAdditionalUsers in upgrade tests
anoadragon453 Aug 14, 2025
9cd3a7c
fix typo: entitiy
anoadragon453 Aug 14, 2025
2668889
Merge branch 'main' of github.com:matrix-org/complement into anoa/fix…
anoadragon453 Oct 9, 2025
62ba92a
Update tests with new behaviour
anoadragon453 Oct 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
156 changes: 141 additions & 15 deletions tests/v12_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -495,10 +495,9 @@ func TestMSC4289PrivilegedRoomCreators_Upgrades(t *testing.T) {
testCases := []struct {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed from review queue "while the exact power level is worked out."

name string
initialCreator *client.CSAPI
initialAdditionalCreators []string
initialVersion string
initialUserPLs map[string]int
entitiyDoingUpgrade *client.CSAPI
entityDoingUpgrade *client.CSAPI
newAdditionalCreators []string
// assertions
wantAdditionalCreators []string
Expand All @@ -511,7 +510,7 @@ func TestMSC4289PrivilegedRoomCreators_Upgrades(t *testing.T) {
initialUserPLs: map[string]int{
bob.UserID: 100,
},
entitiyDoingUpgrade: bob,
entityDoingUpgrade: bob,
wantAdditionalCreators: []string{},
wantNewUsersMap: map[string]int64{},
},
Expand All @@ -523,7 +522,7 @@ func TestMSC4289PrivilegedRoomCreators_Upgrades(t *testing.T) {
bob.UserID: 100,
charlie.UserID: 100,
},
entitiyDoingUpgrade: bob,
entityDoingUpgrade: bob,
wantAdditionalCreators: []string{},
wantNewUsersMap: map[string]int64{
charlie.UserID: 100,
Expand All @@ -536,7 +535,7 @@ func TestMSC4289PrivilegedRoomCreators_Upgrades(t *testing.T) {
initialUserPLs: map[string]int{
bob.UserID: 150, // bob has enough permission to upgrade
},
entitiyDoingUpgrade: bob,
entityDoingUpgrade: bob,
newAdditionalCreators: []string{charlie.UserID},
wantAdditionalCreators: []string{charlie.UserID},
wantNewUsersMap: map[string]int64{},
Expand All @@ -549,7 +548,7 @@ func TestMSC4289PrivilegedRoomCreators_Upgrades(t *testing.T) {
bob.UserID: 150, // bob has enough permission to upgrade
charlie.UserID: 50, // gets removed as he will become an additional creator
},
entitiyDoingUpgrade: bob,
entityDoingUpgrade: bob,
newAdditionalCreators: []string{charlie.UserID},
wantAdditionalCreators: []string{charlie.UserID},
wantNewUsersMap: map[string]int64{},
Expand All @@ -562,7 +561,7 @@ func TestMSC4289PrivilegedRoomCreators_Upgrades(t *testing.T) {
alice.UserID: 100,
bob.UserID: 100,
},
entitiyDoingUpgrade: alice,
entityDoingUpgrade: alice,
newAdditionalCreators: []string{bob.UserID},
wantAdditionalCreators: []string{bob.UserID},
wantNewUsersMap: map[string]int64{}, // both alice and bob are removed as they are now creators.
Expand All @@ -576,7 +575,7 @@ func TestMSC4289PrivilegedRoomCreators_Upgrades(t *testing.T) {
bob.UserID: 100,
charlie.UserID: 50,
},
entitiyDoingUpgrade: alice,
entityDoingUpgrade: alice,
newAdditionalCreators: []string{bob.UserID},
wantAdditionalCreators: []string{bob.UserID},
wantNewUsersMap: map[string]int64{
Expand All @@ -590,10 +589,6 @@ func TestMSC4289PrivilegedRoomCreators_Upgrades(t *testing.T) {
"room_version": tc.initialVersion,
"preset": "public_chat",
}
if tc.initialAdditionalCreators != nil {
must.Equal(t, tc.initialVersion, roomVersion12, "can only set additional_creators on v12")
createBody["additional_creators"] = tc.initialAdditionalCreators
}
roomID := tc.initialCreator.MustCreateRoom(t, createBody)
alice.JoinRoom(t, roomID, []spec.ServerName{"hs1"})
bob.JoinRoom(t, roomID, []spec.ServerName{"hs1"})
Expand All @@ -611,10 +606,10 @@ func TestMSC4289PrivilegedRoomCreators_Upgrades(t *testing.T) {
if tc.newAdditionalCreators != nil {
upgradeBody["additional_creators"] = tc.newAdditionalCreators
}
res := tc.entitiyDoingUpgrade.MustDo(t, "POST", []string{"_matrix", "client", "v3", "rooms", roomID, "upgrade"}, client.WithJSONBody(t, upgradeBody))
res := tc.entityDoingUpgrade.MustDo(t, "POST", []string{"_matrix", "client", "v3", "rooms", roomID, "upgrade"}, client.WithJSONBody(t, upgradeBody))
newRoomID := must.ParseJSON(t, res.Body).Get("replacement_room").Str
// New Create event assertions
createContent := tc.entitiyDoingUpgrade.MustGetStateEventContent(t, newRoomID, spec.MRoomCreate, "")
createContent := tc.entityDoingUpgrade.MustGetStateEventContent(t, newRoomID, spec.MRoomCreate, "")
createAssertions := []match.JSON{
match.JSONKeyEqual("room_version", roomVersion12),
}
Expand All @@ -629,7 +624,7 @@ func TestMSC4289PrivilegedRoomCreators_Upgrades(t *testing.T) {
t, createContent, createAssertions...,
)
// New PL assertions
plContent := tc.entitiyDoingUpgrade.MustGetStateEventContent(t, newRoomID, spec.MRoomPowerLevels, "")
plContent := tc.entityDoingUpgrade.MustGetStateEventContent(t, newRoomID, spec.MRoomPowerLevels, "")
if tc.wantNewUsersMap != nil {
plContent.Get("users").ForEach(func(key, v gjson.Result) bool {
gotVal := v.Int()
Expand All @@ -652,6 +647,137 @@ func TestMSC4289PrivilegedRoomCreators_Upgrades(t *testing.T) {
}
}

func TestMSC4289PrivilegedRoomCreators_Downgrades(t *testing.T) {
deployment := complement.Deploy(t, 1)
defer deployment.Destroy(t)
alice := deployment.Register(t, "hs1", helpers.RegistrationOpts{
LocalpartSuffix: "alice",
})
bob := deployment.Register(t, "hs1", helpers.RegistrationOpts{
LocalpartSuffix: "bob",
})
charlie := deployment.Register(t, "hs1", helpers.RegistrationOpts{
LocalpartSuffix: "charlie",
})

max_canonicaljson_power_level := int64(math.Pow(2, 53) - 1)

testCases := []struct {
name string
initialCreator *client.CSAPI
initialAdditionalCreators []string
newVersion string
initialPLs map[string]any
entityDoingUpgrade *client.CSAPI
// assertions
wantNewUsersMap map[string]int64
}{
{
name: "upgrading a room from v12 to v11 sets the old room's creator to the max canonicaljson power level in the new room",
initialCreator: alice,
newVersion: "11",
initialPLs: map[string]any{},
entityDoingUpgrade: alice,
wantNewUsersMap: map[string]int64{
// Max canonicaljson power level.
alice.UserID: max_canonicaljson_power_level,
},
},
{
name: "upgrading a room from v12 to v11 keeps the additional_creator users as admins of the new room. existing users remain the same",
initialCreator: alice,
initialAdditionalCreators: []string{
bob.UserID,
},
newVersion: "11",
initialPLs: map[string]any{
"users": map[string]int64{
charlie.UserID: 30,
},
},
entityDoingUpgrade: alice,
wantNewUsersMap: map[string]int64{
alice.UserID: max_canonicaljson_power_level,
bob.UserID: max_canonicaljson_power_level,
charlie.UserID: 30, // charlie is not a creator
},
},
{
name: "upgrading a room from v12 to v11 sets any user who wasn't a creator, but had max canonicaljson power level in the old room, to just below the max canonicaljson power level in the new room",
initialCreator: alice,
newVersion: "11",
initialPLs: map[string]any{
"users": map[string]int64{
bob.UserID: 30,
charlie.UserID: max_canonicaljson_power_level,
},
},
entityDoingUpgrade: alice,
wantNewUsersMap: map[string]int64{
// Neither bob or charlie are creators.
alice.UserID: max_canonicaljson_power_level,
bob.UserID: 30,
// charlie's power level was reduced just below max canonicaljson int.
charlie.UserID: max_canonicaljson_power_level - 1,
},
},
}

for _, tc := range testCases {
createBody := map[string]interface{}{
"room_version": roomVersion12,
"preset": "public_chat",
}
if tc.initialAdditionalCreators != nil {
createBody["creation_content"] = map[string]any{
"additional_creators": tc.initialAdditionalCreators,
}
}
roomID := tc.initialCreator.MustCreateRoom(t, createBody)
alice.JoinRoom(t, roomID, []spec.ServerName{"hs1"})
bob.JoinRoom(t, roomID, []spec.ServerName{"hs1"})
tc.initialCreator.SendEventSynced(t, roomID, b.Event{
Type: spec.MRoomPowerLevels,
StateKey: b.Ptr(""),
Content: tc.initialPLs,
})
upgradeBody := map[string]any{
"new_version": tc.newVersion,
}
res := tc.entityDoingUpgrade.MustDo(t, "POST", []string{"_matrix", "client", "v3", "rooms", roomID, "upgrade"}, client.WithJSONBody(t, upgradeBody))
newRoomID := must.ParseJSON(t, res.Body).Get("replacement_room").Str
// New Create event assertions
createContent := tc.entityDoingUpgrade.MustGetStateEventContent(t, newRoomID, spec.MRoomCreate, "")
createAssertions := []match.JSON{
match.JSONKeyEqual("room_version", tc.newVersion),
}
must.MatchGJSON(
t, createContent, createAssertions...,
)
// New PL assertions
plContent := tc.entityDoingUpgrade.MustGetStateEventContent(t, newRoomID, spec.MRoomPowerLevels, "")
if tc.wantNewUsersMap != nil {
plContent.Get("users").ForEach(func(key, v gjson.Result) bool {
gotVal := v.Int()
wantVal, ok := tc.wantNewUsersMap[key.Str]
if !ok {
ct.Errorf(t, "%s: upgraded room PL content, user %s has PL %v but want it missing", tc.name, key.Str, gotVal)
return true
}
if gotVal != wantVal {
ct.Errorf(t, "%s: upgraded room PL content, user %s has PL %v want %v", tc.name, key.Str, gotVal, wantVal)
}
delete(tc.wantNewUsersMap, key.Str)
return true
})
if len(tc.wantNewUsersMap) > 0 {
ct.Fatalf(t, "%s: upgraded room PL content missed these users %v", tc.name, tc.wantNewUsersMap)
}
}
t.Logf("OK: %v", tc.name)
}
}

// Test that the room ID is in fact the hash of the create event.
func TestMSC4291RoomIDAsHashOfCreateEvent(t *testing.T) {
deployment := complement.Deploy(t, 1)
Expand Down
Loading