Out of sync error versioning #4869
Merged
Conversation
This file contains hidden or 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
zebot
added
the
ok-to-test
pcapriotti
force-pushed
the
out-of-sync-error-versioning
branch
from
e377eee to
2df261e
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces versioning for the MLS "out of sync" error functionality to ensure backward compatibility with older API versions. The out-of-sync check is disabled for API versions below V13, preventing breaking changes for clients using older API versions.
Key changes:
- Adds a new
EnableOutOfSyncChecktype to control whether out-of-sync checks are performed - Introduces
APIVersioncombinator to pass API version information to handlers - Updates MLS message and commit bundle handlers to conditionally apply out-of-sync checks based on API version
- Extends federation API to include
enableOutOfSyncCheckfield for cross-backend compatibility
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
libs/wire-api/src/Wire/API/MLS/OutOfSync.hs |
New module defining EnableOutOfSyncCheck data type with default value DisableOutOfSyncCheck |
libs/wire-api/src/Wire/API/VersionInfo.hs |
Adds APIVersion servant combinator and getVersionHeader helper function for extracting version from requests |
libs/wire-api/src/Wire/API/Routes/SpecialiseToVersion.hs |
Extends version specialization to support APIVersion combinator |
libs/wire-api/src/Wire/API/Routes/Public/Galley/MLS.hs |
Adds APIVersion to MLS message and commit bundle API routes |
libs/wire-api-federation/src/Wire/API/Federation/API/Galley.hs |
Adds optional enableOutOfSyncCheck field to MLSMessageSendRequest for federation support |
services/galley/src/Galley/API/MLS/Message.hs |
Implements version-based logic with enableOutOfSyncCheckFromVersion function and updates handlers to accept version parameter |
services/galley/src/Galley/API/MLS/OutOfSync.hs |
Modifies checkConversationOutOfSync to respect EnableOutOfSyncCheck input |
services/galley/src/Galley/API/Federation.hs |
Updates federation handlers to propagate enableOutOfSyncCheck from incoming requests using default when not provided |
services/galley/test/integration/API/MLS.hs |
Updates test utilities to set enableOutOfSyncCheck = Nothing for federated message send requests |
services/galley/test/integration/API/MLS/Util.hs |
Updates test helper to include enableOutOfSyncCheck field |
integration/test/Test/Channels.hs |
Adds comprehensive test coverage for version-based behavior in both local and federated scenarios |
libs/wire-api/wire-api.cabal |
Registers new Wire.API.MLS.OutOfSync module |
changelog.d/3-bug-fixes/out-of-sync-error-versioning |
Documents the bug fix for older backends |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
battermann
approved these changes
Nov 21, 2025
Co-authored-by: Copilot <[email protected]>
blackheaven
approved these changes
Nov 24, 2025
This was referenced Nov 26, 2025
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.
https://wearezeta.atlassian.net/browse/WPB-21877
Checklist
changelog.d