Return JSON errors instead of HTML errors for unknown resources.

changelog.d/11602.bugfix

@@ -0,0 +1 @@
+Fix a long-standing bug that some unknown endpoints would return HTML 404 errors instead of JSON 400 errors.

synapse/http/server.py

@@ -530,7 +530,7 @@ class RootRedirect(resource.Resource):
  """Redirects the root '/' path to another path."""
 
  def __init__(self, path: str):
- resource.Resource.__init__(self)
+ super().__init__()
  self.url = path
 
  def render_GET(self, request: Request) -> bytes:
@@ -539,7 +539,7 @@ def render_GET(self, request: Request) -> bytes:
  def getChild(self, name: str, request: Request) -> resource.Resource:
  if len(name) == 0:
  return self # select ourselves as the child to render
- return resource.Resource.getChild(self, name, request)
+ return super().getChild(name, request)
 
 
 class OptionsResource(resource.Resource):
@@ -556,7 +556,18 @@ def render_OPTIONS(self, request: Request) -> bytes:
  def getChildWithDefault(self, path: str, request: Request) -> resource.Resource:
  if request.method == b"OPTIONS":
  return self # select ourselves as the child to render
- return resource.Resource.getChildWithDefault(self, path, request)
+ return super().getChildWithDefault(path, request)
+
+
+class MissingResource(resource.Resource):
+ """Similar to resource.NoResource, but returns a JSON error with proper CORS headers."""
+
+ def render(self, request: SynapseRequest) -> int:
+ return_json_error(failure.Failure(UnrecognizedRequestError()), request)
+ return NOT_DONE_YET
+
+ def getChild(self, name: str, request: Request) -> resource.Resource:
+ return self
 
 
 class RootOptionsRedirectResource(OptionsResource, RootRedirect):

synapse/util/httpresourcetree.py

@@ -15,7 +15,9 @@
 import logging
 from typing import Dict
 
-from twisted.web.resource import NoResource, Resource
+from twisted.web.resource import Resource
+
+from synapse.http.server import MissingResource
 
 logger = logging.getLogger(__name__)
 
@@ -49,7 +51,7 @@ def create_resource_tree(
  for path_seg in full_path.split(b"/")[1:-1]:
  if path_seg not in last_resource.listNames():
  # resource doesn't exist, so make a "dummy resource"
- child_resource: Resource = NoResource()
+ child_resource: Resource = MissingResource()
  last_resource.putChild(path_seg, child_resource)
  res_id = _resource_id(last_resource, path_seg)
  resource_mappings[res_id] = child_resource