123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138 |
- # -*- coding: utf-8 -*-
- # Copyright 2018 New Vector Ltd
- #
- # 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 synapse.api.room_versions import KNOWN_ROOM_VERSIONS
- from synapse.events import make_event_from_dict
- from synapse.events.snapshot import EventContext
- from synapse.http.servlet import parse_json_object_from_request
- from synapse.replication.http._base import ReplicationEndpoint
- from synapse.types import Requester, UserID
- from synapse.util.metrics import Measure
- logger = logging.getLogger(__name__)
- class ReplicationSendEventRestServlet(ReplicationEndpoint):
- """Handles events newly created on workers, including persisting and
- notifying.
- The API looks like:
- POST /_synapse/replication/send_event/:event_id/:txn_id
- {
- "event": { .. serialized event .. },
- "room_version": .., // "1", "2", "3", etc: the version of the room
- // containing the event
- "event_format_version": .., // 1,2,3 etc: the event format version
- "internal_metadata": { .. serialized internal_metadata .. },
- "rejected_reason": .., // The event.rejected_reason field
- "context": { .. serialized event context .. },
- "requester": { .. serialized requester .. },
- "ratelimit": true,
- "extra_users": [],
- }
- 200 OK
- { "stream_id": 12345, "event_id": "$abcdef..." }
- The returned event ID may not match the sent event if it was deduplicated.
- """
- NAME = "send_event"
- PATH_ARGS = ("event_id",)
- def __init__(self, hs):
- super().__init__(hs)
- self.event_creation_handler = hs.get_event_creation_handler()
- self.store = hs.get_datastore()
- self.storage = hs.get_storage()
- self.clock = hs.get_clock()
- @staticmethod
- async def _serialize_payload(
- event_id, store, event, context, requester, ratelimit, extra_users
- ):
- """
- Args:
- event_id (str)
- store (DataStore)
- requester (Requester)
- event (FrozenEvent)
- context (EventContext)
- ratelimit (bool)
- extra_users (list(UserID)): Any extra users to notify about event
- """
- serialized_context = await context.serialize(event, store)
- payload = {
- "event": event.get_pdu_json(),
- "room_version": event.room_version.identifier,
- "event_format_version": event.format_version,
- "internal_metadata": event.internal_metadata.get_dict(),
- "rejected_reason": event.rejected_reason,
- "context": serialized_context,
- "requester": requester.serialize(),
- "ratelimit": ratelimit,
- "extra_users": [u.to_string() for u in extra_users],
- }
- return payload
- async def _handle_request(self, request, event_id):
- with Measure(self.clock, "repl_send_event_parse"):
- content = parse_json_object_from_request(request)
- event_dict = content["event"]
- room_ver = KNOWN_ROOM_VERSIONS[content["room_version"]]
- internal_metadata = content["internal_metadata"]
- rejected_reason = content["rejected_reason"]
- event = make_event_from_dict(
- event_dict, room_ver, internal_metadata, rejected_reason
- )
- requester = Requester.deserialize(self.store, content["requester"])
- context = EventContext.deserialize(self.storage, content["context"])
- ratelimit = content["ratelimit"]
- extra_users = [UserID.from_string(u) for u in content["extra_users"]]
- request.requester = requester
- logger.info(
- "Got event to send with ID: %s into room: %s", event.event_id, event.room_id
- )
- event = await self.event_creation_handler.persist_and_notify_client_event(
- requester, event, context, ratelimit=ratelimit, extra_users=extra_users
- )
- return (
- 200,
- {
- "stream_id": event.internal_metadata.stream_ordering,
- "event_id": event.event_id,
- },
- )
- def register_servlets(hs, http_server):
- ReplicationSendEventRestServlet(hs).register(http_server)
|