mirrors/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2024-12-14 11:57:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Reorganize account data, receipts and presence request regexps in generic_worker docs (#17954)
Some checks are pending
Build docker images / build (push) Waiting to run
Details
Deploy the documentation / Calculate variables for GitHub Pages deployment (push) Waiting to run
Details
Deploy the documentation / GitHub Pages (push) Blocked by required conditions
Details
Build release artifacts / Build wheels on macos-13 for x86_64 (push) Waiting to run
Details
Build release artifacts / Calculate list of debian distros (push) Waiting to run
Details
Build release artifacts / Build .deb packages (push) Blocked by required conditions
Details
Build release artifacts / Build wheels on ubuntu-22.04 for aarch64 (push) Waiting to run
Details
Build release artifacts / Build wheels on ubuntu-22.04 for x86_64 (push) Waiting to run
Details
Build release artifacts / Build sdist (push) Waiting to run
Details
Build release artifacts / Attach assets to release (push) Blocked by required conditions
Details
Tests / changes (push) Waiting to run
Details
Tests / check-sampleconfig (push) Blocked by required conditions
Details
Tests / check-schema-delta (push) Blocked by required conditions
Details
Tests / check-lockfile (push) Waiting to run
Details
Tests / lint (push) Blocked by required conditions
Details
Tests / Typechecking (push) Blocked by required conditions
Details
Tests / lint-crlf (push) Waiting to run
Details
Tests / lint-newsfile (push) Waiting to run
Details
Tests / lint-pydantic (push) Blocked by required conditions
Details
Tests / lint-clippy (push) Blocked by required conditions
Details
Tests / lint-clippy-nightly (push) Blocked by required conditions
Details
Tests / lint-rustfmt (push) Blocked by required conditions
Details
Tests / lint-readme (push) Blocked by required conditions
Details
Tests / linting-done (push) Blocked by required conditions
Details
Tests / calculate-test-jobs (push) Blocked by required conditions
Details
Tests / trial (push) Blocked by required conditions
Details
Tests / cargo-bench (push) Blocked by required conditions
Details
Tests / tests-done (push) Blocked by required conditions
Details
Tests / trial-olddeps (push) Blocked by required conditions
Details
Tests / trial-pypy (all, pypy-3.9) (push) Blocked by required conditions
Details
Tests / sytest (push) Blocked by required conditions
Details
Tests / export-data (push) Blocked by required conditions
Details
Tests / portdb (11, 3.9) (push) Blocked by required conditions
Details
Tests / portdb (17, 3.13) (push) Blocked by required conditions
Details
Tests / complement (monolith, Postgres) (push) Blocked by required conditions
Details
Tests / complement (monolith, SQLite) (push) Blocked by required conditions
Details
Tests / complement (workers, Postgres) (push) Blocked by required conditions
Details
Tests / cargo-test (push) Blocked by required conditions
Details

Browse source 
POST requests for account data, receipts and presence require the worker
to be configured as a stream writer. The regular expressions in the
default list don't assume any HTTP method, so if the worker is not a
stream writer, the request fails.

The stream writer section of the documentation lists the same regexps as
the one I'm removing, so people configuring stream writers can still
configure their routing properly.

More context:
https://github.com/element-hq/synapse/issues/17243#issuecomment-2493621645
This commit is contained in:
Rafał Hirsch 2024-12-09 17:30:03 +01:00 committed by GitHub
parent 790ce14e46
commit adce8a0111
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 8 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog.d/17954.doc Normal file
View file

@ -0,0 +1 @@
Update `synapse.app.generic_worker` documentation to only recommend `GET` requests for stream writer routes by default, unless the worker is also configured as a stream writer. Contributed by @evoL.

18
docs/workers.md
View file

@ -273,17 +273,6 @@ information.
^/_matrix/client/(api/v1|r0|v3|unstable)/knock/ ^/_matrix/client/(api/v1|r0|v3|unstable)/knock/
^/_matrix/client/(api/v1|r0|v3|unstable)/profile/ ^/_matrix/client/(api/v1|r0|v3|unstable)/profile/
# Account data requests
^/_matrix/client/(r0|v3|unstable)/.*/tags
^/_matrix/client/(r0|v3|unstable)/.*/account_data
# Receipts requests
^/_matrix/client/(r0|v3|unstable)/rooms/.*/receipt
^/_matrix/client/(r0|v3|unstable)/rooms/.*/read_markers
# Presence requests
^/_matrix/client/(api/v1|r0|v3|unstable)/presence/
# User directory search requests # User directory search requests
^/_matrix/client/(r0|v3|unstable)/user_directory/search$ ^/_matrix/client/(r0|v3|unstable)/user_directory/search$
@ -292,6 +281,13 @@ Additionally, the following REST endpoints can be handled for GET requests:
^/_matrix/client/(api/v1|r0|v3|unstable)/pushrules/ ^/_matrix/client/(api/v1|r0|v3|unstable)/pushrules/
^/_matrix/client/unstable/org.matrix.msc4140/delayed_events ^/_matrix/client/unstable/org.matrix.msc4140/delayed_events
# Account data requests
^/_matrix/client/(r0|v3|unstable)/.*/tags
^/_matrix/client/(r0|v3|unstable)/.*/account_data
# Presence requests
^/_matrix/client/(api/v1|r0|v3|unstable)/presence/
Pagination requests can also be handled, but all requests for a given Pagination requests can also be handled, but all requests for a given
room must be routed to the same instance. Additionally, care must be taken to room must be routed to the same instance. Additionally, care must be taken to
ensure that the purge history admin API is not used while pagination requests ensure that the purge history admin API is not used while pagination requests