Fix redirecting to the webclient for non-HTTP(S) web_client_location. (…

…#11783) To not change the behaviour during the deprecation period. Follow-up to #11774.
matrix-org · Jan 20, 2022 · d090996 · d090996
1 parent 121b9e2
commit d090996
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/changelog.d/11783.misc b/changelog.d/11783.misc
@@ -0,0 +1 @@
+Deprecate support for `webclient` listeners and non-HTTP(S) `web_client_location` configuration.
diff --git a/synapse/app/homeserver.py b/synapse/app/homeserver.py
@@ -131,11 +131,18 @@ def _listener_http(
         resources.update(self._module_web_resources)
         self._module_web_resources_consumed = True
 
-        # try to find something useful to redirect '/' to
+        # Try to find something useful to serve at '/':
+        #
+        # 1. Redirect to the web client if it is an HTTP(S) URL.
+        # 2. Redirect to the web client served via Synapse.
+        # 3. Redirect to the static "Synapse is running" page.
+        # 4. Do not redirect and use a blank resource.
         if self.config.server.web_client_location_is_redirect:
             root_resource: Resource = RootOptionsRedirectResource(
                 self.config.server.web_client_location
             )
+        elif WEB_CLIENT_PREFIX in resources:
+            root_resource = RootOptionsRedirectResource(WEB_CLIENT_PREFIX)
         elif STATIC_PREFIX in resources:
             root_resource = RootOptionsRedirectResource(STATIC_PREFIX)
         else:
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Deprecate support for `webclient` listeners and non-HTTP(S) `web_client_location` configuration.