2018-02-05 12:22:16 -05:00
|
|
|
# -*- 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.
|
|
|
|
|
2018-07-09 02:09:20 -04:00
|
|
|
import logging
|
|
|
|
|
2018-02-05 12:22:16 -05:00
|
|
|
from twisted.internet import defer
|
|
|
|
|
2019-01-24 06:14:07 -05:00
|
|
|
from synapse.events import event_type_from_format_version
|
2018-02-05 12:22:16 -05:00
|
|
|
from synapse.events.snapshot import EventContext
|
2018-07-31 08:53:54 -04:00
|
|
|
from synapse.http.servlet import parse_json_object_from_request
|
|
|
|
from synapse.replication.http._base import ReplicationEndpoint
|
2018-07-09 02:09:20 -04:00
|
|
|
from synapse.types import Requester, UserID
|
2018-02-05 12:22:16 -05:00
|
|
|
from synapse.util.metrics import Measure
|
|
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
|
|
|
2018-07-31 08:53:54 -04:00
|
|
|
class ReplicationSendEventRestServlet(ReplicationEndpoint):
|
2018-02-05 12:22:16 -05:00
|
|
|
"""Handles events newly created on workers, including persisting and
|
|
|
|
notifying.
|
|
|
|
|
|
|
|
The API looks like:
|
|
|
|
|
2018-07-31 08:53:54 -04:00
|
|
|
POST /_synapse/replication/send_event/:event_id/:txn_id
|
2018-02-05 12:22:16 -05:00
|
|
|
|
|
|
|
{
|
|
|
|
"event": { .. serialized event .. },
|
|
|
|
"internal_metadata": { .. serialized internal_metadata .. },
|
|
|
|
"rejected_reason": .., // The event.rejected_reason field
|
|
|
|
"context": { .. serialized event context .. },
|
|
|
|
"requester": { .. serialized requester .. },
|
2018-03-01 05:08:28 -05:00
|
|
|
"ratelimit": true,
|
|
|
|
"extra_users": [],
|
2018-02-05 12:22:16 -05:00
|
|
|
}
|
|
|
|
"""
|
2018-07-31 08:53:54 -04:00
|
|
|
NAME = "send_event"
|
|
|
|
PATH_ARGS = ("event_id",)
|
2018-02-05 12:22:16 -05:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
2018-07-31 08:53:54 -04:00
|
|
|
super(ReplicationSendEventRestServlet, self).__init__(hs)
|
2018-02-05 12:22:16 -05:00
|
|
|
|
|
|
|
self.event_creation_handler = hs.get_event_creation_handler()
|
|
|
|
self.store = hs.get_datastore()
|
|
|
|
self.clock = hs.get_clock()
|
|
|
|
|
2018-07-31 08:53:54 -04:00
|
|
|
@staticmethod
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
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 = yield context.serialize(event, store)
|
|
|
|
|
|
|
|
payload = {
|
|
|
|
"event": event.get_pdu_json(),
|
2019-01-24 06:14:07 -05:00
|
|
|
"event_format_version": event.format_version,
|
2018-07-31 08:53:54 -04:00
|
|
|
"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],
|
|
|
|
}
|
2018-03-01 06:20:34 -05:00
|
|
|
|
2018-07-31 08:53:54 -04:00
|
|
|
defer.returnValue(payload)
|
2018-04-12 07:08:59 -04:00
|
|
|
|
2018-02-05 12:22:16 -05:00
|
|
|
@defer.inlineCallbacks
|
2018-07-31 08:53:54 -04:00
|
|
|
def _handle_request(self, request, event_id):
|
2018-02-05 12:22:16 -05:00
|
|
|
with Measure(self.clock, "repl_send_event_parse"):
|
|
|
|
content = parse_json_object_from_request(request)
|
|
|
|
|
|
|
|
event_dict = content["event"]
|
2019-01-24 06:14:07 -05:00
|
|
|
format_ver = content["event_format_version"]
|
2018-02-05 12:22:16 -05:00
|
|
|
internal_metadata = content["internal_metadata"]
|
|
|
|
rejected_reason = content["rejected_reason"]
|
2019-01-24 06:14:07 -05:00
|
|
|
|
|
|
|
EventType = event_type_from_format_version(format_ver)
|
|
|
|
event = EventType(event_dict, internal_metadata, rejected_reason)
|
2018-02-05 12:22:16 -05:00
|
|
|
|
|
|
|
requester = Requester.deserialize(self.store, content["requester"])
|
2018-02-15 08:53:18 -05:00
|
|
|
context = yield EventContext.deserialize(self.store, content["context"])
|
2018-02-05 12:22:16 -05:00
|
|
|
|
2018-03-01 05:08:28 -05:00
|
|
|
ratelimit = content["ratelimit"]
|
2018-03-01 12:39:58 -05:00
|
|
|
extra_users = [UserID.from_string(u) for u in content["extra_users"]]
|
2018-03-01 05:08:28 -05:00
|
|
|
|
2018-02-05 12:22:16 -05:00
|
|
|
if requester.user:
|
|
|
|
request.authenticated_entity = requester.user.to_string()
|
|
|
|
|
|
|
|
logger.info(
|
|
|
|
"Got event to send with ID: %s into room: %s",
|
|
|
|
event.event_id, event.room_id,
|
|
|
|
)
|
|
|
|
|
2018-02-15 11:30:10 -05:00
|
|
|
yield self.event_creation_handler.persist_and_notify_client_event(
|
2018-02-05 12:22:16 -05:00
|
|
|
requester, event, context,
|
2018-03-01 05:08:28 -05:00
|
|
|
ratelimit=ratelimit,
|
|
|
|
extra_users=extra_users,
|
2018-02-05 12:22:16 -05:00
|
|
|
)
|
|
|
|
|
|
|
|
defer.returnValue((200, {}))
|
|
|
|
|
|
|
|
|
|
|
|
def register_servlets(hs, http_server):
|
|
|
|
ReplicationSendEventRestServlet(hs).register(http_server)
|