Try to modify MSC4311 test to meet new proposal by turt2live · Pull Request #796 · matrix-org/complement

turt2live · 2025-08-15T01:32:41Z

Update MSC4311 tests to conform to the spec.

~~"I have no idea what I'm doing" disclaimer goes here~~ taken over by @MadLittleMods

For ~~element-hq/synapse#18822~~ element-hq/synapse#19723

Dev notes

COMPLEMENT_DIR=../complement ./scripts-dev/complement.sh -run TestMSC4311StrippedStateClientAPI

COMPLEMENT_DIR=../complement ./scripts-dev/complement.sh -run TestMSC4311FullEventsOnStrippedStateFederation

kegsay · 2025-08-15T07:18:34Z

-				must.MatchGJSON(t, ev,
-					match.JSONKeyPresent("origin_server_ts"),
-				)
+	srv.Mux().HandleFunc("/_matrix/federation/v2/invite/{roomID}/{eventID}", srv.ValidFederationRequest(t, func(fr *fclient.FederationRequest, pathParams map[string]string) util.JSONResponse {


You should be able to alternatively use:

srv := federation.NewServer(t, deployment, federation.HandleInviteRequests(func(p gomatrixserverlib.PDU) { // checks here }), federation.HandleKeyRequests(), federation.HandleMakeSendJoinRequests(), federation.HandleTransactionRequests(nil, nil), )

I went down this route but the problem is that federation.HandleInviteRequests(...) doesn't allow you to inspect the invite_room_state yet. It would have to be updated to pass in the full invite request to the callback.

And gomatrixserverlib needs to be updated to handle the new world where invite_room_state can be stripped state or full PDUs.

We could have an infallible InviteV2Request.StrippedInviteRoomState() that would give a view of stripped state regardless of whether we were passed stripped or full PDU's (we can derive stripped state from the full PDU's). And then a fallible InviteV2Request.FullInviteRoomState() that would return an error if the homeserver didn't pass us full PDUs.

We would also need to update IRoomVersion to add new fields like CreateEventRequiredInInviteRoomState and ~~FullPDUInviteRoomState~~ (full PDU's can happen in any room version) so we can conditionally apply this behavior. Or maybe the flags could be combined as MSC4311InviteRoomState

If any of the events are not a PDU, not for the room ID specified, or fail signature checks, or the m.room.create event is missing, the receiving server MAY respond to invites with a 400 M_MISSING_PARAM standard Matrix error (new to the endpoint). For invites to room version 12+ rooms, servers SHOULD rather than MAY respond to such requests with 400 M_MISSING_PARAM.

-- matrix-org/matrix-spec-proposals#4311

MadLittleMods · 2026-05-01T23:12:37Z

+			match.JSONArrayEach("invite_room_state", func(event gjson.Result) error {
+				// Each event should have extra fields `origin_server_ts` that indicate we're
+				// seeing a full PDU and not just a "stripped state event"
+				return should.MatchGJSON(event, match.JSONKeyPresent("origin_server_ts"))
+			}),


This currently fails in Synapse because it just pulls invite_room_state from the the unsigned part of the PDU which will be the stripped state client version, see synapse/federation/federation_client.py#L1361

Example flawed /_matrix/federation/v2/invite/{roomID}/{eventID} request body from Synapse

{ "event": { "auth_events": [ "$3-FVPb1HO_ZyxolbnthZ8qTVEMXyZ6px4qUdrL0exII", "$hRMnmEtlMElF2pqbd23ccVSfAIUq-Dqo9kxORAbs2Pk", "$luBrxrHgZcSqpdm5UMAXtGKxCvmOwGAHJrZ0iMeWrdw" ], "content": { "membership": "invite" }, "depth": 6, "hashes": { "sha256": "xBOaaPtS1jAtu/qsWiBIXFZqDdOm6zI8R+RVgXfhm00" }, "origin_server_ts": 1777676386564, "prev_events": [ "$VoTAQZqsV4zWnRi3Uh9n42ioJ4J74UvwMoZuHNiHWU4" ], "room_id": "!gvlLh8tsK9LSCdF8y56dVfErfUiw7lZnLQ8JTB_kih4", "sender": "@user-1-alice:hs1", "signatures": { "hs1": { "ed25519:a_NKNg": "xS/15iTHLn3I65oaTdVRMFBrs+ASbKp9Lm9GM8oLoKlD3ZUwtuBP2pyN/tdUXgraKnRNDU1b3PLxpXYzsLGkCQ" } }, "state_key": "@bob:host.docker.internal:44453", "type": "m.room.member", "unsigned": { "age": 11, "invite_room_state": [ { "auth_events": [], "content": { "room_version": "12" }, "depth": 1, "hashes": { "sha256": "vVkUaUxHUum571Kj4D0vo85iS2dssrPpILSm3XnELpc" }, "origin_server_ts": 1777676385521, "prev_events": [], "sender": "@user-1-alice:hs1", "signatures": { "hs1": { "ed25519:a_NKNg": "m7pf3WIpaGZEgTR85+L+ewSY88eBXJSGecOXXJmLudEFq4mGxR4MBw6/x9+xMTz4byo+z0a+0h4IcvvSyYhiAA" } }, "state_key": "", "type": "m.room.create", "unsigned": { "age_ts": 1777676385521 } }, { "content": { "join_rule": "public" }, "sender": "@user-1-alice:hs1", "state_key": "", "type": "m.room.join_rules" }, { "content": { "displayname": "user-1-alice", "membership": "join" }, "sender": "@user-1-alice:hs1", "state_key": "@user-1-alice:hs1", "type": "m.room.member" } ] } }, "invite_room_state": [ { "auth_events": [], "content": { "room_version": "12" }, "depth": 1, "hashes": { "sha256": "vVkUaUxHUum571Kj4D0vo85iS2dssrPpILSm3XnELpc" }, "origin_server_ts": 1777676385521, "prev_events": [], "sender": "@user-1-alice:hs1", "signatures": { "hs1": { "ed25519:a_NKNg": "m7pf3WIpaGZEgTR85+L+ewSY88eBXJSGecOXXJmLudEFq4mGxR4MBw6/x9+xMTz4byo+z0a+0h4IcvvSyYhiAA" } }, "state_key": "", "type": "m.room.create", "unsigned": { "age_ts": 1777676385521 } }, { "content": { "join_rule": "public" }, "sender": "@user-1-alice:hs1", "state_key": "", "type": "m.room.join_rules" }, { "content": { "displayname": "user-1-alice", "membership": "join" }, "sender": "@user-1-alice:hs1", "state_key": "@user-1-alice:hs1", "type": "m.room.member" } ], "room_version": "12" }

Test passes with Synapse with the changes from element-hq/synapse#19723 ✅

COMPLEMENT_DIR=../complement ./scripts-dev/complement.sh -run TestMSC4311FullEventsOnStrippedStateFederation

MadLittleMods · 2026-05-02T01:52:09Z

+		var roomVersion gomatrixserverlib.RoomVersion
+		if err := json.Unmarshal([]byte(rawRoomVersion), &roomVersion); err != nil {
+			t.Fatalf("failed to parse room version: %s", err)


Better way to get a gomatrixserverlib.RoomVersion from a room version string?

But it doesn't seem possible to see. For example, Synapse strips it out when trying to view events, https://github.com/element-hq/synapse/blob/6100f6e4f7fb0c72f1ae2802683ebc811c0e3a77/synapse/events/utils.py#L590-L596

MadLittleMods · 2026-05-26T22:41:43Z

+		// TODO: Test events not full PDU's
+
+		// TODO: Test events not from the same room
+
+		// TODO: Test invalid signatures/hashes


Something for future PRs

MadLittleMods · 2026-05-26T22:42:20Z

+// > error (new to the endpoint). For invites to room version 12+ rooms, servers
+// > SHOULD rather than MAY respond to such requests with `400 M_MISSING_PARAM`.
+func TestMSC4311RejectInvalidStrippedStateFederation(t *testing.T) {
+	runtime.SkipIf(t, runtime.Synapse)  // FIXME: Run these tests after 2027-06-01


Also cross-linked this in the Synapse codebase (see element-hq/synapse#19723)

Try to modify MSC4311 test to meet new proposal

e5a5a87

This was referenced Aug 15, 2025

Use PDUs for stripped state over federation element-hq/synapse#18822

Closed

MSC4311: Ensuring the create event is available on invites matrix-org/matrix-spec-proposals#4311

Merged

kegsay reviewed Aug 15, 2025

View reviewed changes

Merge branch 'main' into travis/msc4311-v2

d98aae0

This was referenced Apr 23, 2026

Room version 12 tests #791

Merged

MSC4311: Use full PDU's in stripped state (like invite_room_state) over federation and always include m.room.create event element-hq/synapse#19723

Draft

MadLittleMods added 2 commits April 30, 2026 17:57

Merge branch 'main' into travis/msc4311-v2

1faef0d

More robust test

35dcccf

MadLittleMods reviewed May 1, 2026

View reviewed changes

Comment thread tests/v12_test.go Outdated

MadLittleMods added 2 commits May 1, 2026 19:04

Add TODO about testing knock_room_state

96b8d49

Fix raw bytes being encoded as event instead of actual JSON

795a951

MadLittleMods reviewed May 2, 2026

View reviewed changes

MadLittleMods mentioned this pull request May 4, 2026

4311 stripped state create event #871

Draft

1 task

MadLittleMods reviewed May 4, 2026

View reviewed changes

Comment thread tests/v12_test.go

MadLittleMods added 14 commits May 4, 2026 14:18

Use more specific type

47474a0

WIP: Add TestMSC4311CreateEventInStrippedStateClientApi

25ced8b

Use more robust MustSyncUntil

3256657

WIP: Add test for invite_room_state in client API

cabb542

But it doesn't seem possible to see. For example, Synapse strips it out when trying to view events, https://github.com/element-hq/synapse/blob/6100f6e4f7fb0c72f1ae2802683ebc811c0e3a77/synapse/events/utils.py#L590-L596

Remove invite_room_state client test

7171d67

Remove stray parallel

18d6da2

Better casing

5d61d01

Merge branch 'main' into travis/msc4311-v2

9f29477

Add client knock_state test

633c1a2

Add knock_room_state test (MustKnockRoom not implemented)

55df04e

Implement srv.MustKnockRoom

92cdd79

We're doing the TODO now

2523631

Split up tests

b4ab892

Add TestMSC4311RejectInvalidStrippedStateFederation

07c60fc

MadLittleMods reviewed May 26, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Try to modify MSC4311 test to meet new proposal#796

Try to modify MSC4311 test to meet new proposal#796
turt2live wants to merge 20 commits into
mainfrom
travis/msc4311-v2

turt2live commented Aug 15, 2025 •

edited by MadLittleMods

Loading

Uh oh!

kegsay Aug 15, 2025

Uh oh!

MadLittleMods May 1, 2026 •

edited

Loading

Uh oh!

MadLittleMods May 1, 2026 •

edited

Loading

Uh oh!

MadLittleMods May 2, 2026 •

edited

Loading

Uh oh!

Uh oh!

MadLittleMods May 2, 2026

Uh oh!

Uh oh!

MadLittleMods May 26, 2026

Uh oh!

MadLittleMods May 26, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

turt2live commented Aug 15, 2025 • edited by MadLittleMods Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Dev notes

Uh oh!

kegsay Aug 15, 2025

Choose a reason for hiding this comment

Uh oh!

MadLittleMods May 1, 2026 • 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!

MadLittleMods May 1, 2026 • 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!

MadLittleMods May 2, 2026 • 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!

MadLittleMods May 2, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

MadLittleMods May 26, 2026

Choose a reason for hiding this comment

Uh oh!

MadLittleMods May 26, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

turt2live commented Aug 15, 2025 •

edited by MadLittleMods

Loading

MadLittleMods May 1, 2026 •

edited

Loading

MadLittleMods May 1, 2026 •

edited

Loading

MadLittleMods May 2, 2026 •

edited

Loading