MSC4222: Adding `state_after` to `/sync` by erikjohnston · Pull Request #4222 · matrix-org/matrix-spec-proposals

erikjohnston · 2024-10-29T14:56:54Z

This is to allow clients to opt-in to a change of the sync v2 API that allows them to correctly track the state of the room.

Rendered

Implementations:

Server - Add experimental support for MSC4222 element-hq/synapse#17888
Client - Support MSC4222 state_after matrix-js-sdk#4487

FCP tickyboxes

MSC checklist

proposals/4222-sync-v2-state-after.md

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>

proposals/4222-sync-v2-state-after.md

turt2live · 2025-04-01T05:59:13Z

A team member has request SCT review on this MSC for the following points:

To understand it doesn't handle where state gets deleted, and if so how to fix, if we indeed want to.
And depending on that, finalise how it should look spec-wise.

mscbot · 2025-07-13T12:29:29Z

The final comment period, with a disposition to merge, as per the review above, is now complete.

Co-authored-by: Alexey Rusakov <Kitsune-Ral@users.sf.net>

zecakeh · 2025-08-03T08:48:30Z

Spec PR: matrix-org/matrix-spec#2187

uhoreg · 2025-08-06T19:50:14Z

Merged! 🎉

*This PR was originally only to enable [MSC4222](matrix-org/matrix-spec-proposals#4222) Complement tests (`/sync` `state_after`) but after merging the [fix PR](#19463), we discovered that while the tests pass locally, [fail in CI](#19460 (comment)). To unblock the RC, we decided to revert the fix PR (see #19474 (comment) for more info). To better ensure tests actually pass in CI, we're re-introducing the fix here in the same PR that we enable the tests in.* --- Fix `/sync` missing membership in `state_after`. This applies to any scenario where the first membership has a different `sender` compared to the `state_key` and then the second membership has the same `sender`/`state_key`. Like someone inviting another person and then them joining. Or someone being kicked and then they leave. This bug has been present since the MSC4222 implementation was introduced into the codebase (#17888). --- Fix #19455 Fix element-hq/customer-success#656 I have a feeling, this might also fix these issues (will close and see how people report back): Fix #18182 Fix #19478 ### Testing strategy Complement tests: matrix-org/complement#842 We will need #19460 to merge in order to enable the Complement tests in Synapse but this PR should be merged first so they pass in the first place. I've tested locally that the Complement tests pass with this fix. ### Dev notes [MSC4222](matrix-org/matrix-spec-proposals#4222) has already been merged into the spec and is already part of Matrix v1.16 but we haven't [stabilized support in Synapse yet](#19414). --- In the same ballpark: - #19455 - #17050 - #17430 - #16940 - #18182 - #18793 - #19478 --- Docker builds preferring remote image over the local image we just built, #19460 (comment) `containerd` image store (storage driver, driver type) -> #19475 ### Todo - [x] Wait for #19463 to merge so the Complement tests all pass - [x] Wait for #19475 to merge ### Pull Request Checklist  * [x] Pull request is based on the develop branch * [x] Pull request includes a [changelog file](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#changelog). The entry should: - Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from `EventStore` to `EventWorkerStore`.". - Use markdown where necessary, mostly for `code blocks`. - End with either a period (.) or an exclamation mark (!). - Start with a capital letter. - Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry. * [x] [Code style](https://element-hq.github.io/synapse/latest/code_style.html) is correct (run the [linters](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#run-the-linters)) --------- Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> Co-authored-by: Andrew Ferrazzutti <andrewf@element.io>

This PR contains the following updates: | Package | Update | Change | |---|---|---| | [element-hq/synapse](https://github.com/element-hq/synapse) | minor | `v1.148.0` → `v1.149.0` | --- ### Release Notes <details> <summary>element-hq/synapse (element-hq/synapse)</summary> ### [`v1.149.0`](https://github.com/element-hq/synapse/releases/tag/v1.149.0) [Compare Source](element-hq/synapse@v1.148.0...v1.149.0) ### Synapse 1.149.0 (2026-03-10) No significant changes since 1.149.0rc1. ### Synapse 1.149.0rc1 (2026-03-03) #### Features - Add experimental support for [MSC4388: Secure out-of-band channel for sign in with QR](matrix-org/matrix-spec-proposals#4388). ([#19127](element-hq/synapse#19127)) - Add stable support for [MSC4380](matrix-org/matrix-spec-proposals#4380) invite blocking. ([#19431](element-hq/synapse#19431)) #### Bugfixes - Fix the 'Login as a user' Admin API not checking if the user exists before issuing an access token. ([#18518](element-hq/synapse#18518)) - Fix `/sync` missing membership event in `state_after` (experimental [MSC4222](matrix-org/matrix-spec-proposals#4222) implementation) in some scenarios. ([#19460](element-hq/synapse#19460)) #### Internal Changes - Add log to explain when and why we freeze objects in the garbage collector. ([#19440](element-hq/synapse#19440)) - Better instrument `JoinRoomAliasServlet` with tracing. ([#19461](element-hq/synapse#19461)) - Fix Complement CI not running against the code from our PRs. ([#19475](element-hq/synapse#19475)) - Log `docker system info` in CI so we have a plain record of how GitHub runners evolve over time. ([#19480](element-hq/synapse#19480)) - Rename the `test_disconnect` test helper so that pytest doesn't see it as a test. ([#19486](element-hq/synapse#19486)) - Add a log line when we delete devices. Contributed by [@bradtgmurray](https://github.com/bradtgmurray) @ Beeper. ([#19496](element-hq/synapse#19496)) - Pre-allocate the buffer based on the expected `Content-Length` with the Rust HTTP client. ([#19498](element-hq/synapse#19498)) - Cancel long-running sync requests if the client has gone away. ([#19499](element-hq/synapse#19499)) - Try and reduce reactor tick times when under heavy load. ([#19507](element-hq/synapse#19507)) - Simplify Rust HTTP client response streaming and limiting. ([#19510](element-hq/synapse#19510)) - Replace deprecated collection import locations with current locations. ([#19515](element-hq/synapse#19515)) - Bump most locked Python dependencies to their latest versions. ([#19519](element-hq/synapse#19519)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://gitea.alexlebens.dev/alexlebens/infrastructure/pulls/4580 Co-authored-by: Renovate Bot <renovate-bot@alexlebens.net> Co-committed-by: Renovate Bot <renovate-bot@alexlebens.net>

erikjohnston force-pushed the erikj/sync_v2_state_after branch 3 times, most recently from 36f8310 to 87fb070 Compare October 29, 2024 15:08

First draft of MSC4222

55e34c9

erikjohnston force-pushed the erikj/sync_v2_state_after branch from 87fb070 to 55e34c9 Compare October 29, 2024 15:12

erikjohnston marked this pull request as ready for review October 29, 2024 15:12

turt2live reviewed Oct 29, 2024

View reviewed changes

proposals/4222-sync-v2-state-after.md Show resolved Hide resolved

turt2live reviewed Oct 29, 2024

View reviewed changes

proposals/4222-sync-v2-state-after.md Show resolved Hide resolved

toger5 reviewed Oct 29, 2024

View reviewed changes

proposals/4222-sync-v2-state-after.md Outdated Show resolved Hide resolved

Fix indentation

4d40237

Gnuxie reviewed Oct 29, 2024

View reviewed changes

proposals/4222-sync-v2-state-after.md Show resolved Hide resolved

Fix json

fd626e6

dbkr mentioned this pull request Oct 31, 2024

Support MSC4222 state_after matrix-org/matrix-js-sdk#4487

Merged

4 tasks

richvdh reviewed Nov 1, 2024

View reviewed changes

proposals/4222-sync-v2-state-after.md Outdated Show resolved Hide resolved

Include msc number in unstable prefixes

666a5aa

anoadragon453 reviewed Nov 5, 2024

View reviewed changes

proposals/4222-sync-v2-state-after.md Outdated Show resolved Hide resolved

proposals/4222-sync-v2-state-after.md Outdated Show resolved Hide resolved

hughns and others added 2 commits November 6, 2024 15:33

Update proposals/4222-sync-v2-state-after.md

052600f

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>

Update proposals/4222-sync-v2-state-after.md

fbcf1fc

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>

t3chguy mentioned this pull request Nov 12, 2024

Only feed state events to widgets if we believe they update the state element-hq/element-web#28422

Closed

richvdh mentioned this pull request Feb 18, 2025

/sync API does not tell clients when the server's view of state changes outside the timeline matrix-org/matrix-spec#1209

Closed

tulir reviewed Mar 8, 2025

View reviewed changes

proposals/4222-sync-v2-state-after.md Outdated Show resolved Hide resolved

richvdh mentioned this pull request Mar 26, 2025

Show an error screen when the homeserver is missing MSC4140 support element-hq/element-call#3040

Open

anoadragon453 moved this to Needs idea feedback / initial review in Spec Core Team Workflow Mar 27, 2025

anoadragon453 added this to Spec Core Team Workflow Mar 27, 2025

mscbot added finished-final-comment-period and removed disposition-merge final-comment-period This MSC has entered a final comment period in interest to approval, postpone, or delete in 5 days. labels Jul 13, 2025

Update proposals/4222-sync-v2-state-after.md

32eaa21

Co-authored-by: Alexey Rusakov <Kitsune-Ral@users.sf.net>

turt2live merged commit 6e3e162 into main Jul 14, 2025
1 check passed

turt2live added spec-pr-missing Proposal has been implemented and is being used in the wild but hasn't yet been added to the spec and removed finished-final-comment-period labels Jul 14, 2025

turt2live moved this from In FCP to Requires spec writing in Spec Core Team Workflow Jul 14, 2025

zecakeh mentioned this pull request Aug 3, 2025

client-api: Add unstable support for state_after in sync_events::v3 ruma/ruma#2179

Merged

tulir added spec-pr-in-review A proposal which has been PR'd against the spec and is in review and removed spec-pr-missing Proposal has been implemented and is being used in the wild but hasn't yet been added to the spec labels Aug 3, 2025

tulir moved this from Requires spec writing to Requires spec PR review in Spec Core Team Workflow Aug 3, 2025

uhoreg added merged A proposal whose PR has merged into the spec! and removed spec-pr-in-review A proposal which has been PR'd against the spec and is in review labels Aug 6, 2025

dbkr mentioned this pull request Aug 8, 2025

Leave event missing from state_after element-hq/synapse#18793

Open

MadLittleMods mentioned this pull request Aug 8, 2025

/sync and /members do not return "current state" element-hq/synapse#16940

Open

turt2live moved this from Requires spec PR review to Merged in Spec Core Team Workflow Sep 2, 2025

zecakeh mentioned this pull request Sep 12, 2025

Implement Matrix 1.16 changes ruma/ruma#2215

Closed

31 tasks

Maypul mentioned this pull request Sep 15, 2025

Element Web is getting Token is not active after migration to MAS element-hq/synapse#18916

Closed

Maypul mentioned this pull request Sep 22, 2025

Element Web is getting 'Token is not active' after migration to MAS element-hq/element-web#30834

Closed

This was referenced Jan 29, 2026

TI-M on Matrix v1.16 gematik/api-ti-messenger#340

Open

Support Matrix 1.16 element-hq/synapse#19414

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MSC4222: Adding `state_after` to `/sync`#4222

MSC4222: Adding `state_after` to `/sync`#4222
turt2live merged 11 commits intomainfrom
erikj/sync_v2_state_after

erikjohnston commented Oct 29, 2024 •

edited by turt2live

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

turt2live commented Apr 1, 2025

Uh oh!

mscbot commented Jul 13, 2025

Uh oh!

Uh oh!

zecakeh commented Aug 3, 2025

Uh oh!

uhoreg commented Aug 6, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

17 participants

Conversation

erikjohnston commented Oct 29, 2024 • edited by turt2live Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

turt2live commented Apr 1, 2025

Uh oh!

mscbot commented Jul 13, 2025

Uh oh!

Uh oh!

zecakeh commented Aug 3, 2025

Uh oh!

uhoreg commented Aug 6, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

17 participants

erikjohnston commented Oct 29, 2024 •

edited by turt2live

Loading