From fb5e393f4082e0c48189405acf660a117bf5ea5c Mon Sep 17 00:00:00 2001 From: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> Date: Wed, 3 Aug 2022 22:09:04 +0200 Subject: [PATCH 1/5] Fix worker doc for `synapse.app.frontend_proxy` --- docs/workers.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/workers.md b/docs/workers.md index 6969c424d8cd..080aee9cd704 100644 --- a/docs/workers.md +++ b/docs/workers.md @@ -589,7 +589,7 @@ regular expressions: ^/_matrix/client/(r0|v3|unstable)/keys/upload -If `use_presence` is False in the homeserver config, it can also handle REST +If `use_presence` is set to `false` in the homeserver config, it can also handle REST endpoints matching the following regular expressions: ^/_matrix/client/(api/v1|r0|v3|unstable)/presence/[^/]+/status @@ -597,7 +597,7 @@ endpoints matching the following regular expressions: This "stub" presence handler will pass through `GET` request but make the `PUT` effectively a no-op. -It will proxy any requests it cannot handle to the main synapse instance. It +It will proxy not cached requests to the main synapse instance. It must therefore be configured with the location of the main instance, via the `worker_main_http_uri` setting in the `frontend_proxy` worker configuration file. For example: From eaa25d88ce06b8d75eee47c10a78b5b8b910272f Mon Sep 17 00:00:00 2001 From: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> Date: Wed, 3 Aug 2022 22:13:36 +0200 Subject: [PATCH 2/5] newsfile --- changelog.d/13451.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/13451.doc diff --git a/changelog.d/13451.doc b/changelog.d/13451.doc new file mode 100644 index 000000000000..7b0272aa72ea --- /dev/null +++ b/changelog.d/13451.doc @@ -0,0 +1 @@ +Corrects misleading wording in worker documentation for `synapse.app.frontend_proxy`. From 12877da13c6215ee22277ce8f0db1c5c5778b2fc Mon Sep 17 00:00:00 2001 From: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> Date: Thu, 4 Aug 2022 14:07:30 +0200 Subject: [PATCH 3/5] Apply suggestions from code review Co-authored-by: David Robertson --- docs/workers.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/workers.md b/docs/workers.md index 080aee9cd704..3fdba09e5c57 100644 --- a/docs/workers.md +++ b/docs/workers.md @@ -589,8 +589,8 @@ regular expressions: ^/_matrix/client/(r0|v3|unstable)/keys/upload -If `use_presence` is set to `false` in the homeserver config, it can also handle REST -endpoints matching the following regular expressions: +If `use_presence` is set to `false` in the homeserver config, the frontend proxy can also handle REST +endpoints matching the following regular expression: ^/_matrix/client/(api/v1|r0|v3|unstable)/presence/[^/]+/status From f7297abff15b56554635ab82587ed1abe321d7a1 Mon Sep 17 00:00:00 2001 From: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> Date: Tue, 9 Aug 2022 08:51:56 +0200 Subject: [PATCH 4/5] Change wording from `not cached` to `uncached` --- docs/workers.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/workers.md b/docs/workers.md index 3fdba09e5c57..cd341862d6c1 100644 --- a/docs/workers.md +++ b/docs/workers.md @@ -597,7 +597,7 @@ endpoints matching the following regular expression: This "stub" presence handler will pass through `GET` request but make the `PUT` effectively a no-op. -It will proxy not cached requests to the main synapse instance. It +It will proxy uncached requests to the main synapse instance. It must therefore be configured with the location of the main instance, via the `worker_main_http_uri` setting in the `frontend_proxy` worker configuration file. For example: From 78501b3e6bfeb2a934b828c34f10ad8dcc58657c Mon Sep 17 00:00:00 2001 From: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> Date: Tue, 9 Aug 2022 08:53:06 +0200 Subject: [PATCH 5/5] update newsfile Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> --- changelog.d/13451.doc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelog.d/13451.doc b/changelog.d/13451.doc index 7b0272aa72ea..b50685bda73c 100644 --- a/changelog.d/13451.doc +++ b/changelog.d/13451.doc @@ -1 +1 @@ -Corrects misleading wording in worker documentation for `synapse.app.frontend_proxy`. +Correct misleading wording in worker documentation for `synapse.app.frontend_proxy`.