mirror of
https://mau.dev/maunium/synapse.git
synced 2024-11-14 14:01:59 +01:00
9d8e380d2e
Both `RestServlet`s and `BaseFederationServlet`s register their handlers with `HttpServer.register_paths` / `JsonResource.register_paths`. Update `JsonResource` to respect the `@cancellable` flag on handlers registered in this way. Although `ReplicationEndpoint` also registers itself using `register_paths`, it does not pass the handler method that would have the `@cancellable` flag directly, and so needs separate handling. Signed-off-by: Sean Quah <seanq@element.io>
136 lines
4.6 KiB
Python
136 lines
4.6 KiB
Python
# Copyright 2020 The Matrix.org Foundation C.I.C.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
import json
|
|
from http import HTTPStatus
|
|
from io import BytesIO
|
|
from typing import Tuple
|
|
from unittest.mock import Mock
|
|
|
|
from synapse.api.errors import Codes, SynapseError
|
|
from synapse.http.server import cancellable
|
|
from synapse.http.servlet import (
|
|
RestServlet,
|
|
parse_json_object_from_request,
|
|
parse_json_value_from_request,
|
|
)
|
|
from synapse.http.site import SynapseRequest
|
|
from synapse.rest.client._base import client_patterns
|
|
from synapse.server import HomeServer
|
|
from synapse.types import JsonDict
|
|
|
|
from tests import unittest
|
|
from tests.http.server._base import EndpointCancellationTestHelperMixin
|
|
|
|
|
|
def make_request(content):
|
|
"""Make an object that acts enough like a request."""
|
|
request = Mock(spec=["content"])
|
|
|
|
if isinstance(content, dict):
|
|
content = json.dumps(content).encode("utf8")
|
|
|
|
request.content = BytesIO(content)
|
|
return request
|
|
|
|
|
|
class TestServletUtils(unittest.TestCase):
|
|
def test_parse_json_value(self):
|
|
"""Basic tests for parse_json_value_from_request."""
|
|
# Test round-tripping.
|
|
obj = {"foo": 1}
|
|
result = parse_json_value_from_request(make_request(obj))
|
|
self.assertEqual(result, obj)
|
|
|
|
# Results don't have to be objects.
|
|
result = parse_json_value_from_request(make_request(b'["foo"]'))
|
|
self.assertEqual(result, ["foo"])
|
|
|
|
# Test empty.
|
|
with self.assertRaises(SynapseError):
|
|
parse_json_value_from_request(make_request(b""))
|
|
|
|
result = parse_json_value_from_request(make_request(b""), allow_empty_body=True)
|
|
self.assertIsNone(result)
|
|
|
|
# Invalid UTF-8.
|
|
with self.assertRaises(SynapseError):
|
|
parse_json_value_from_request(make_request(b"\xFF\x00"))
|
|
|
|
# Invalid JSON.
|
|
with self.assertRaises(SynapseError):
|
|
parse_json_value_from_request(make_request(b"foo"))
|
|
|
|
with self.assertRaises(SynapseError):
|
|
parse_json_value_from_request(make_request(b'{"foo": Infinity}'))
|
|
|
|
def test_parse_json_object(self):
|
|
"""Basic tests for parse_json_object_from_request."""
|
|
# Test empty.
|
|
result = parse_json_object_from_request(
|
|
make_request(b""), allow_empty_body=True
|
|
)
|
|
self.assertEqual(result, {})
|
|
|
|
# Test not an object
|
|
with self.assertRaises(SynapseError):
|
|
parse_json_object_from_request(make_request(b'["foo"]'))
|
|
|
|
|
|
class CancellableRestServlet(RestServlet):
|
|
"""A `RestServlet` with a mix of cancellable and uncancellable handlers."""
|
|
|
|
PATTERNS = client_patterns("/sleep$")
|
|
|
|
def __init__(self, hs: HomeServer):
|
|
super().__init__()
|
|
self.clock = hs.get_clock()
|
|
|
|
@cancellable
|
|
async def on_GET(self, request: SynapseRequest) -> Tuple[int, JsonDict]:
|
|
await self.clock.sleep(1.0)
|
|
return HTTPStatus.OK, {"result": True}
|
|
|
|
async def on_POST(self, request: SynapseRequest) -> Tuple[int, JsonDict]:
|
|
await self.clock.sleep(1.0)
|
|
return HTTPStatus.OK, {"result": True}
|
|
|
|
|
|
class TestRestServletCancellation(
|
|
unittest.HomeserverTestCase, EndpointCancellationTestHelperMixin
|
|
):
|
|
"""Tests for `RestServlet` cancellation."""
|
|
|
|
servlets = [
|
|
lambda hs, http_server: CancellableRestServlet(hs).register(http_server)
|
|
]
|
|
|
|
def test_cancellable_disconnect(self) -> None:
|
|
"""Test that handlers with the `@cancellable` flag can be cancelled."""
|
|
channel = self.make_request("GET", "/sleep", await_result=False)
|
|
self._test_disconnect(
|
|
self.reactor,
|
|
channel,
|
|
expect_cancellation=True,
|
|
expected_body={"error": "Request cancelled", "errcode": Codes.UNKNOWN},
|
|
)
|
|
|
|
def test_uncancellable_disconnect(self) -> None:
|
|
"""Test that handlers without the `@cancellable` flag cannot be cancelled."""
|
|
channel = self.make_request("POST", "/sleep", await_result=False)
|
|
self._test_disconnect(
|
|
self.reactor,
|
|
channel,
|
|
expect_cancellation=False,
|
|
expected_body={"result": True},
|
|
)
|