fix(sync): handle wildcard state keys in sliding sync required_state #1379

Merged
Jade merged 2 commits from wizzeh/continuwuity:fix/sync-wildcard-state-keys into main 2026-02-15 15:36:35 +00:00
Contributor

This pull request fixes a bug in the sliding sync implementation where sending a wildcard state key for an event type would stop all subsequent event types from being sent. The break; in the original code was probably intended to handle cases where a state key includes a wildcard and then some more state keys. In such a case we can stop at the wildcard. However by breaking we exit out of the entire loop and don't process all the event types.

Pull request checklist:

  • This pull request targets the main branch, and the branch is named something other than
    main.
  • I have written an appropriate pull request title and my description is clear.
  • I understand I am responsible for the contents of this pull request.
  • I have followed the contributing guidelines:
<!-- In order to help reviewers know what your pull request does at a glance, you should ensure that 1. Your PR title is a short, single sentence describing what you changed 2. You have described in more detail what you have changed, why you have changed it, what the intended effect is, and why you think this will be beneficial to the project. If you have made any potentially strange/questionable design choices, but didn't feel they'd benefit from code comments, please don't mention them here - after opening your pull request, go to "files changed", and click on the "+" symbol in the line number gutter, and attach comments to the lines that you think would benefit from some clarification. --> This pull request fixes a bug in the sliding sync implementation where sending a wildcard state key for an event type would stop all subsequent event types from being sent. The break; in the original code was probably intended to handle cases where a state key includes a wildcard and then some more state keys. In such a case we can stop at the wildcard. However by breaking we exit out of the entire loop and don't process all the event types. <!-- Example: This pull request allows us to warp through time and space ten times faster than before by double-inverting the warp drive with hyperheated jump fluid, both making the drive faster and more efficient. This resolves the common issue where we have to wait more than 10 milliseconds to engage, use, and disengage the warp drive when travelling between galaxies. --> <!-- Closes: #... --> <!-- Fixes: #... --> <!-- Uncomment the above line(s) if your pull request fixes an issue or closes another pull request by superseding it. Replace `#...` with the issue/pr number, such as `#123`. --> **Pull request checklist:** <!-- You need to complete these before your PR can be considered. If you aren't sure about some, feel free to ask for clarification in #dev:continuwuity.org. --> - [x] This pull request targets the `main` branch, and the branch is named something other than `main`. - [x] I have written an appropriate pull request title and my description is clear. - [x] I understand I am responsible for the contents of this pull request. - I have followed the [contributing guidelines][c1]: - [x] My contribution follows the [code style][c2], if applicable. - [x] I ran [pre-commit checks][c1pc] before opening/drafting this pull request. - [x] I have [tested my contribution][c1t] (or proof-read it for documentation-only changes) myself, if applicable. This includes ensuring code compiles. - [x] My commit messages follow the [commit message format][c1cm] and are descriptive. - [ ] I have written a [news fragment][n1] for this PR, if applicable<!--(can be done after hitting open!)-->. <!-- Notes on these requirements: - While not required, we encourage you to sign your commits with GPG or SSH to attest the authenticity of your changes. - While we allow LLM-assisted contributions, we do not appreciate contributions that are low quality, which is typical of machine-generated contributions that have not had a lot of love and care from a human. Please do not open a PR if all you have done is asked ChatGPT to tidy up the codebase with a +-100,000 diff. - In the case of code style violations, reviewers may leave review comments/change requests indicating what the ideal change would look like. For example, a reviewer may suggest you lower a log level, or use `match` instead of `if/else` etc. - In the case of code style violations, pre-commit check failures, minor things like typos/spelling errors, and in some cases commit format violations, reviewers may modify your branch directly, typically by making changes and adding a commit. Particularly in the latter case, a reviewer may rebase your commits to squash "spammy" ones (like "fix", "fix", "actually fix"), and reword commit messages that don't satisfy the format. - Pull requests MUST pass the `Checks` CI workflows to be capable of being merged. This can only be bypassed in exceptional circumstances. If your CI flakes, let us know in matrix:r/dev:continuwuity.org. - Pull requests have to be based on the latest `main` commit before being merged. If the main branch changes while you're making your changes, you should make sure you rebase on main before opening a PR. Your branch will be rebased on main before it is merged if it has fallen behind. - We typically only do fast-forward merges, so your entire commit log will be included. Once in main, it's difficult to get out cleanly, so put on your best dress, smile for the cameras! --> [c1]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md [c2]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/docs/development/code_style.mdx [c1pc]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#pre-commit-checks [c1t]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#running-tests-locally [c1cm]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#commit-messages [n1]: https://towncrier.readthedocs.io/en/stable/tutorial.html#creating-news-fragments
@ -685,8 +685,15 @@ async fn collect_required_state(
required_state_request: &BTreeSet<TypeStateKey>,
) -> Vec<Raw<AnySyncStateEvent>> {
let mut required_state = Vec::new();
let mut wildcard_types: BTreeSet<&StateEventType> = BTreeSet::new();
Owner

this can be a hashset, since no ordering properties are required

this can be a hashset, since no ordering properties are required
ginger added this to the 0.5.5 milestone 2026-02-15 15:08:20 +00:00
Jade force-pushed fix/sync-wildcard-state-keys from 2238a78e05
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 3m6s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 11m58s
to 60a3abe752
Some checks failed
Release Docker Image / Build linux-amd64 (release) (push) Waiting to run
Release Docker Image / Build linux-arm64 (release) (push) Waiting to run
Release Docker Image / Create Multi-arch Release Manifest (push) Blocked by required conditions
Release Docker Image / Build linux-amd64 (max-perf) (push) Blocked by required conditions
Release Docker Image / Build linux-arm64 (max-perf) (push) Blocked by required conditions
Release Docker Image / Create Max-Perf Manifest (push) Blocked by required conditions
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 2m30s
Documentation / Build and Deploy Documentation (push) Successful in 59s
Checks / Prek / Pre-commit & Formatting (push) Successful in 2m36s
Checks / Prek / Clippy and Cargo Tests (push) Has been cancelled
Checks / Prek / Clippy and Cargo Tests (pull_request) Failing after 1h0m0s
2026-02-15 15:35:52 +00:00
Compare
Jade merged commit 60a3abe752 into main 2026-02-15 15:36:35 +00:00
Contributor

Thank you for the fix! @wizzeh
Sorry for introducing a bug haha.

Thank you for the fix! @wizzeh Sorry for introducing a bug haha.
Owner

@titaniumtown wrote in #1379 (comment):

Thank you for the fix! @wizzeh Sorry for introducing a bug haha.

I was actually the one that introduced the bug in my fixup comment 😭 it wasn't your fault

@titaniumtown wrote in https://forgejo.ellis.link/continuwuation/continuwuity/pulls/1379#issuecomment-24222: > Thank you for the fix! @wizzeh Sorry for introducing a bug haha. I was actually the one that introduced the bug in my fixup comment 😭 it wasn't your fault
Contributor

Oh! hahaha

Oh! hahaha
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
4 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
continuwuation/continuwuity!1379
No description provided.