|
| 1 | +# Copyright 2022 The Matrix.org Foundation C.I.C. |
| 2 | +# |
| 3 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +# you may not use this file except in compliance with the License. |
| 5 | +# You may obtain a copy of the License at |
| 6 | +# |
| 7 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +# |
| 9 | +# Unless required by applicable law or agreed to in writing, software |
| 10 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +# See the License for the specific language governing permissions and |
| 13 | +# limitations under the License. |
| 14 | + |
| 15 | +import logging |
| 16 | +from typing import TYPE_CHECKING, List, Tuple |
| 17 | + |
| 18 | +from twisted.web.server import Request |
| 19 | + |
| 20 | +from synapse.api.room_versions import KNOWN_ROOM_VERSIONS |
| 21 | +from synapse.events import EventBase, make_event_from_dict |
| 22 | +from synapse.events.snapshot import EventContext |
| 23 | +from synapse.http.server import HttpServer |
| 24 | +from synapse.http.servlet import parse_json_object_from_request |
| 25 | +from synapse.replication.http._base import ReplicationEndpoint |
| 26 | +from synapse.types import JsonDict, Requester |
| 27 | +from synapse.util.metrics import Measure |
| 28 | + |
| 29 | +if TYPE_CHECKING: |
| 30 | + from synapse.server import HomeServer |
| 31 | + from synapse.storage.databases.main import DataStore |
| 32 | + |
| 33 | +logger = logging.getLogger(__name__) |
| 34 | + |
| 35 | + |
| 36 | +class ReplicationSendEventsRestServlet(ReplicationEndpoint): |
| 37 | + """Handles batches of newly created events on workers, including persisting and |
| 38 | + notifying. |
| 39 | +
|
| 40 | + The API looks like: |
| 41 | +
|
| 42 | + POST /_synapse/replication/send_events/:txn_id |
| 43 | +
|
| 44 | + { |
| 45 | + "events": [{ |
| 46 | + "event": { .. serialized event .. }, |
| 47 | + "room_version": .., // "1", "2", "3", etc: the version of the room |
| 48 | + // containing the event |
| 49 | + "event_format_version": .., // 1,2,3 etc: the event format version |
| 50 | + "internal_metadata": { .. serialized internal_metadata .. }, |
| 51 | + "outlier": true|false, |
| 52 | + "rejected_reason": .., // The event.rejected_reason field |
| 53 | + "context": { .. serialized event context .. }, |
| 54 | + "requester": { .. serialized requester .. }, |
| 55 | + "ratelimit": true, |
| 56 | + }] |
| 57 | + } |
| 58 | +
|
| 59 | + 200 OK |
| 60 | +
|
| 61 | + { "stream_id": 12345, "event_id": "$abcdef..." } |
| 62 | +
|
| 63 | + Responds with a 409 when a `PartialStateConflictError` is raised due to an event |
| 64 | + context that needs to be recomputed due to the un-partial stating of a room. |
| 65 | +
|
| 66 | + """ |
| 67 | + |
| 68 | + NAME = "send_events" |
| 69 | + PATH_ARGS = () |
| 70 | + |
| 71 | + def __init__(self, hs: "HomeServer"): |
| 72 | + super().__init__(hs) |
| 73 | + |
| 74 | + self.event_creation_handler = hs.get_event_creation_handler() |
| 75 | + self.store = hs.get_datastores().main |
| 76 | + self._storage_controllers = hs.get_storage_controllers() |
| 77 | + self.clock = hs.get_clock() |
| 78 | + |
| 79 | + @staticmethod |
| 80 | + async def _serialize_payload( # type: ignore[override] |
| 81 | + store: "DataStore", |
| 82 | + events_and_ctx: List[Tuple[EventBase, EventContext]], |
| 83 | + requester: Requester, |
| 84 | + ratelimit: bool, |
| 85 | + ) -> JsonDict: |
| 86 | + """ |
| 87 | + Args: |
| 88 | + store |
| 89 | + requester |
| 90 | + events_and_ctx |
| 91 | + ratelimit |
| 92 | + """ |
| 93 | + serialized_events = [] |
| 94 | + |
| 95 | + for event, context in events_and_ctx: |
| 96 | + serialized_context = await context.serialize(event, store) |
| 97 | + serialized_event = { |
| 98 | + "event": event.get_pdu_json(), |
| 99 | + "room_version": event.room_version.identifier, |
| 100 | + "event_format_version": event.format_version, |
| 101 | + "internal_metadata": event.internal_metadata.get_dict(), |
| 102 | + "outlier": event.internal_metadata.is_outlier(), |
| 103 | + "rejected_reason": event.rejected_reason, |
| 104 | + "context": serialized_context, |
| 105 | + "requester": requester.serialize(), |
| 106 | + "ratelimit": ratelimit, |
| 107 | + } |
| 108 | + serialized_events.append(serialized_event) |
| 109 | + |
| 110 | + payload = {"events": serialized_events} |
| 111 | + |
| 112 | + return payload |
| 113 | + |
| 114 | + async def _handle_request( # type: ignore[override] |
| 115 | + self, request: Request |
| 116 | + ) -> Tuple[int, JsonDict]: |
| 117 | + with Measure(self.clock, "repl_send_events_parse"): |
| 118 | + payload = parse_json_object_from_request(request) |
| 119 | + events_and_ctx = [] |
| 120 | + events = payload["events"] |
| 121 | + |
| 122 | + for event_payload in events: |
| 123 | + event_dict = event_payload["event"] |
| 124 | + room_ver = KNOWN_ROOM_VERSIONS[event_payload["room_version"]] |
| 125 | + internal_metadata = event_payload["internal_metadata"] |
| 126 | + rejected_reason = event_payload["rejected_reason"] |
| 127 | + |
| 128 | + event = make_event_from_dict( |
| 129 | + event_dict, room_ver, internal_metadata, rejected_reason |
| 130 | + ) |
| 131 | + event.internal_metadata.outlier = event_payload["outlier"] |
| 132 | + |
| 133 | + requester = Requester.deserialize( |
| 134 | + self.store, event_payload["requester"] |
| 135 | + ) |
| 136 | + context = EventContext.deserialize( |
| 137 | + self._storage_controllers, event_payload["context"] |
| 138 | + ) |
| 139 | + |
| 140 | + ratelimit = event_payload["ratelimit"] |
| 141 | + events_and_ctx.append((event, context)) |
| 142 | + |
| 143 | + logger.info( |
| 144 | + "Got batch of events to send, last ID of batch is: %s, sending into room: %s", |
| 145 | + event.event_id, |
| 146 | + event.room_id, |
| 147 | + ) |
| 148 | + |
| 149 | + last_event = ( |
| 150 | + await self.event_creation_handler.persist_and_notify_batched_events( |
| 151 | + requester, events_and_ctx, ratelimit |
| 152 | + ) |
| 153 | + ) |
| 154 | + |
| 155 | + return ( |
| 156 | + 200, |
| 157 | + { |
| 158 | + "stream_id": last_event.internal_metadata.stream_ordering, |
| 159 | + "event_id": last_event.event_id, |
| 160 | + }, |
| 161 | + ) |
| 162 | + |
| 163 | + |
| 164 | +def register_servlets(hs: "HomeServer", http_server: HttpServer) -> None: |
| 165 | + ReplicationSendEventsRestServlet(hs).register(http_server) |
0 commit comments