mirror of
https://mau.dev/maunium/synapse.git
synced 2024-12-14 20:33:53 +01:00
23740eaa3d
During the migration the automated script to update the copyright headers accidentally got rid of some of the existing copyright lines. Reinstate them.
113 lines
3.7 KiB
Python
113 lines
3.7 KiB
Python
#
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
#
|
|
# Copyright 2022 The Matrix.org Foundation C.I.C.
|
|
# Copyright (C) 2023 New Vector, Ltd
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero General Public License as
|
|
# published by the Free Software Foundation, either version 3 of the
|
|
# License, or (at your option) any later version.
|
|
#
|
|
# See the GNU Affero General Public License for more details:
|
|
# <https://www.gnu.org/licenses/agpl-3.0.html>.
|
|
#
|
|
# Originally licensed under the Apache License, Version 2.0:
|
|
# <http://www.apache.org/licenses/LICENSE-2.0>.
|
|
#
|
|
# [This file includes modifications made by New Vector Limited]
|
|
#
|
|
#
|
|
|
|
from http import HTTPStatus
|
|
from typing import Tuple
|
|
|
|
from twisted.web.server import Request
|
|
|
|
from synapse.api.errors import Codes
|
|
from synapse.http.server import JsonResource
|
|
from synapse.replication.http import REPLICATION_PREFIX
|
|
from synapse.replication.http._base import ReplicationEndpoint
|
|
from synapse.server import HomeServer
|
|
from synapse.types import JsonDict
|
|
from synapse.util.cancellation import cancellable
|
|
|
|
from tests import unittest
|
|
from tests.http.server._base import test_disconnect
|
|
|
|
|
|
class CancellableReplicationEndpoint(ReplicationEndpoint):
|
|
NAME = "cancellable_sleep"
|
|
PATH_ARGS = ()
|
|
CACHE = False
|
|
|
|
def __init__(self, hs: HomeServer):
|
|
super().__init__(hs)
|
|
self.clock = hs.get_clock()
|
|
|
|
@staticmethod
|
|
async def _serialize_payload() -> JsonDict:
|
|
return {}
|
|
|
|
@cancellable
|
|
async def _handle_request( # type: ignore[override]
|
|
self, request: Request, content: JsonDict
|
|
) -> Tuple[int, JsonDict]:
|
|
await self.clock.sleep(1.0)
|
|
return HTTPStatus.OK, {"result": True}
|
|
|
|
|
|
class UncancellableReplicationEndpoint(ReplicationEndpoint):
|
|
NAME = "uncancellable_sleep"
|
|
PATH_ARGS = ()
|
|
CACHE = False
|
|
WAIT_FOR_STREAMS = False
|
|
|
|
def __init__(self, hs: HomeServer):
|
|
super().__init__(hs)
|
|
self.clock = hs.get_clock()
|
|
|
|
@staticmethod
|
|
async def _serialize_payload() -> JsonDict:
|
|
return {}
|
|
|
|
async def _handle_request( # type: ignore[override]
|
|
self, request: Request, content: JsonDict
|
|
) -> Tuple[int, JsonDict]:
|
|
await self.clock.sleep(1.0)
|
|
return HTTPStatus.OK, {"result": True}
|
|
|
|
|
|
class ReplicationEndpointCancellationTestCase(unittest.HomeserverTestCase):
|
|
"""Tests for `ReplicationEndpoint` cancellation."""
|
|
|
|
def create_test_resource(self) -> JsonResource:
|
|
"""Overrides `HomeserverTestCase.create_test_resource`."""
|
|
resource = JsonResource(self.hs)
|
|
|
|
CancellableReplicationEndpoint(self.hs).register(resource)
|
|
UncancellableReplicationEndpoint(self.hs).register(resource)
|
|
|
|
return resource
|
|
|
|
def test_cancellable_disconnect(self) -> None:
|
|
"""Test that handlers with the `@cancellable` flag can be cancelled."""
|
|
path = f"{REPLICATION_PREFIX}/{CancellableReplicationEndpoint.NAME}/"
|
|
channel = self.make_request("POST", path, await_result=False, content={})
|
|
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."""
|
|
path = f"{REPLICATION_PREFIX}/{UncancellableReplicationEndpoint.NAME}/"
|
|
channel = self.make_request("POST", path, await_result=False, content={})
|
|
test_disconnect(
|
|
self.reactor,
|
|
channel,
|
|
expect_cancellation=False,
|
|
expected_body={"result": True},
|
|
)
|