Fix TestDeviceListUpdates flakes, again
#610
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When a homeserver (Synapse) performs a partial state join to a room, it may emit `device_lists.changed` entries for users it thinks are in the room, despite the room not appearing in the /sync response yet. This is questionable behaviour, but not forbidden by the spec. Once the homeserver is fully joined to the room, it may emit another round of `device_lists.changed` entries for users it knows are definitely in the room. These extra entries were causing test cases to advance prematurely and randomly fail. To fix the tests, we explicitly check for join events alongside the `device_lists.changed` entries produced by joins. In effect, we ensure that homeservers are fully joined to the test rooms before continuing the rest of the tests. For consistency, we also check for leave events alongside `device_lists.left` enrties.
DMRobertson
approved these changes
Feb 14, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When a homeserver (Synapse) performs a partial state join to a room, it
may emit
device_lists.changedentries for users it thinks are in theroom, despite the room not appearing in the /sync response yet. This is
questionable behaviour, but not forbidden by the spec. Once the
homeserver is fully joined to the room, it may emit another round of
device_lists.changedentries for users it knows are definitely in theroom.
These extra entries were causing test cases to advance prematurely and
randomly fail. To fix the tests, we explicitly check for join events
alongside the
device_lists.changedentries produced by joins. Ineffect, we ensure that homeservers are fully joined to the test rooms
before continuing the rest of the tests.
For consistency, we also check for leave events alongside
device_lists.leftentries.Fixes matrix-org/synapse#14103.