Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Removed request_key from the SyncConfig (moved outside as its own function parameter) #17201

Merged
merged 8 commits into from
May 16, 2024
Merged

Removed request_key from the SyncConfig (moved outside as its own function parameter) #17201

merged 8 commits into from
May 16, 2024

Conversation

MadLittleMods
Copy link
Contributor

@MadLittleMods MadLittleMods commented May 15, 2024 •
edited
Loading

Removed request_key from the SyncConfig (moved outside as its own function parameter) so it doesn't have to flow into _generate_sync_entry_for_xxx methods. This way we can separate the concerns of caching from generating the response and reuse the _generate_sync_entry_for_xxx functions as we see fit. Plus caching doesn't really have anything to do with the config of sync.

Split from #17167

Spawning from #17167 (comment)

Pull Request Checklist

  • Pull request is based on the develop branch
  • Pull request includes a changelog file. 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.
  • Code style is correct
    (run the linters)

@MadLittleMods
Refactor to be able to return different sync responses (SyncVersion)
be5a96f 
Split upon request: #17167 (comment)

Split from #17167
where we will add `SyncVersion.E2EE_SYNC` and a new type of
sync response.
@MadLittleMods
Add changelog
d9b0669
@MadLittleMods
Update docstrings
5d6efb0
@MadLittleMods
Move sync cache request_key outside of the config
562105a 
Removed `request_key` from the `SyncConfig` (moved outside as its own function
parameter) so it doesn't have to flow into `_generate_sync_entry_for_xxx`
methods. This way we can separate the concerns of caching from generating the
response and reuse the `_generate_sync_entry_for_xxx` functions as we see fit
in this new usage. Plus caching doesn't really have anything to do with the
config of sync.

Split from #17167

Spawning from #17167 (comment)
@MadLittleMods
Add changelog
1403d2d
@MadLittleMods MadLittleMods mentioned this pull request May 15, 2024
Merged
3 tasks
@MadLittleMods MadLittleMods marked this pull request as ready for review May 15, 2024 21:17
@MadLittleMods MadLittleMods requested a review from a team as a code owner May 15, 2024 21:17
Base automatically changed from madlittlemods/split-out-syncversion to develop May 16, 2024 10:36
@MadLittleMods
Merge branch 'develop' into madlittlemods/split-out-sync-request-key
1daf242 
Conflicts:
	synapse/handlers/sync.py
	synapse/rest/client/sync.py
	tests/events/test_presence_router.py
	tests/handlers/test_sync.py
@MadLittleMods
Fix missing test from bad conflict
2942a76
@MadLittleMods
Add in changes
644af19
@MadLittleMods MadLittleMods merged commit 28a948f into develop May 16, 2024
38 checks passed
@MadLittleMods MadLittleMods deleted the madlittlemods/split-out-sync-request-key branch May 16, 2024 16:54
@MadLittleMods
Copy link
Contributor Author

Thanks for the review @erikjohnston 🐯

yingziwu added a commit to yingziwu/synapse that referenced this pull request Jun 7, 2024
@yingziwu
Merge tag 'v1.108.0' into develop
bff6843 
No significant changes since 1.108.0rc1.

- Add a feature that allows clients to query the configured federation whitelist. Disabled by default. ([\#16848](element-hq/synapse#16848), [\#17199](element-hq/synapse#17199))
- Add the ability to allow numeric user IDs with a specific prefix when in the CAS flow. Contributed by Aurélien Grimpard. ([\#17098](element-hq/synapse#17098))

- Fix bug where push rules would be empty in `/sync` for some accounts. Introduced in v1.93.0. ([\#17142](element-hq/synapse#17142))
- Add support for optional whitespace around the Federation API's `Authorization` header's parameter commas. ([\#17145](element-hq/synapse#17145))
- Fix bug where disabling room publication prevented public rooms being created on workers. ([\#17177](element-hq/synapse#17177), [\#17184](element-hq/synapse#17184))

- Document [`/v1/make_knock`](https://spec.matrix.org/v1.10/server-server-api/#get_matrixfederationv1make_knockroomiduserid) and [`/v1/send_knock/`](https://spec.matrix.org/v1.10/server-server-api/#put_matrixfederationv1send_knockroomideventid) federation endpoints as worker-compatible. ([\#17058](element-hq/synapse#17058))
- Update User Admin API with note about prefixing OIDC external_id providers. ([\#17139](element-hq/synapse#17139))
- Clarify the state of the created room when using the `autocreate_auto_join_room_preset` config option. ([\#17150](element-hq/synapse#17150))
- Update the Admin FAQ with the current libjemalloc version for latest Debian stable. Additionally update the name of the "push_rules" stream in the Workers documentation. ([\#17171](element-hq/synapse#17171))

- Add note to reflect that [MSC3886](matrix-org/matrix-spec-proposals#3886) is closed but will remain supported for some time. ([\#17151](element-hq/synapse#17151))
- Update dependency PyO3 to 0.21. ([\#17162](element-hq/synapse#17162))
- Fixes linter errors found in PR #17147. ([\#17166](element-hq/synapse#17166))
- Bump black from 24.2.0 to 24.4.2. ([\#17170](element-hq/synapse#17170))
- Cache literal sync filter validation for performance. ([\#17186](element-hq/synapse#17186))
- Improve performance by fixing a reactor pause. ([\#17192](element-hq/synapse#17192))
- Route `/make_knock` and `/send_knock` federation APIs to the federation reader worker in Complement test runs. ([\#17195](element-hq/synapse#17195))
- Prepare sync handler to be able to return different sync responses (`SyncVersion`). ([\#17200](element-hq/synapse#17200))
- Organize the sync cache key parameter outside of the sync config (separate concerns). ([\#17201](element-hq/synapse#17201))
- Refactor `SyncResultBuilder` assembly to its own function. ([\#17202](element-hq/synapse#17202))
- Rename to be obvious: `joined_rooms` -> `joined_room_ids`. ([\#17203](element-hq/synapse#17203), [\#17208](element-hq/synapse#17208))
- Add a short pause when rate-limiting a request. ([\#17210](element-hq/synapse#17210))

* Bump cryptography from 42.0.5 to 42.0.7. ([\#17180](element-hq/synapse#17180))
* Bump gitpython from 3.1.41 to 3.1.43. ([\#17181](element-hq/synapse#17181))
* Bump immutabledict from 4.1.0 to 4.2.0. ([\#17179](element-hq/synapse#17179))
* Bump sentry-sdk from 1.40.3 to 2.1.1. ([\#17178](element-hq/synapse#17178))
* Bump serde from 1.0.200 to 1.0.201. ([\#17183](element-hq/synapse#17183))
* Bump serde_json from 1.0.116 to 1.0.117. ([\#17182](element-hq/synapse#17182))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@erikjohnston erikjohnston erikjohnston approved these changes

Assignees
No one assigned
Labels
A-Sync
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@MadLittleMods @erikjohnston