12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394 |
- # 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 logging
- from typing import TYPE_CHECKING, Tuple
- from twisted.web.server import Request
- from synapse.api.errors import SynapseError
- from synapse.http.server import HttpServer
- from synapse.http.servlet import parse_integer
- from synapse.replication.http._base import ReplicationEndpoint
- from synapse.types import JsonDict
- if TYPE_CHECKING:
- from synapse.server import HomeServer
- logger = logging.getLogger(__name__)
- class ReplicationGetStreamUpdates(ReplicationEndpoint):
- """Fetches stream updates from a server. Used for streams not persisted to
- the database, e.g. typing notifications.
- The API looks like:
- GET /_synapse/replication/get_repl_stream_updates/<stream name>?from_token=0&to_token=10
- 200 OK
- {
- updates: [ ... ],
- upto_token: 10,
- limited: False,
- }
- If there are more rows than can sensibly be returned in one lump, `limited` will be
- set to true, and the caller should call again with a new `from_token`.
- """
- NAME = "get_repl_stream_updates"
- PATH_ARGS = ("stream_name",)
- METHOD = "GET"
- # We don't want to wait for replication streams to catch up, as this gets
- # called in the process of catching replication streams up.
- WAIT_FOR_STREAMS = False
- def __init__(self, hs: "HomeServer"):
- super().__init__(hs)
- self._instance_name = hs.get_instance_name()
- self.streams = hs.get_replication_streams()
- @staticmethod
- async def _serialize_payload( # type: ignore[override]
- stream_name: str, from_token: int, upto_token: int
- ) -> JsonDict:
- return {"from_token": from_token, "upto_token": upto_token}
- async def _handle_request( # type: ignore[override]
- self, request: Request, content: JsonDict, stream_name: str
- ) -> Tuple[int, JsonDict]:
- stream = self.streams.get(stream_name)
- if stream is None:
- raise SynapseError(400, "Unknown stream")
- from_token = parse_integer(request, "from_token", required=True)
- upto_token = parse_integer(request, "upto_token", required=True)
- updates, upto_token, limited = await stream.get_updates_since(
- self._instance_name, from_token, upto_token
- )
- return (
- 200,
- {"updates": updates, "upto_token": upto_token, "limited": limited},
- )
- def register_servlets(hs: "HomeServer", http_server: HttpServer) -> None:
- ReplicationGetStreamUpdates(hs).register(http_server)
|