OpenCloud
/
MatrixSynapse
mirror of https://github.com/matrix-org/synapse
1
0
Fork 0
Code Issues Releases Wiki Activity

Add more better comments

pull/10419/head
Eric Eastwood 2021-07-07 16:22:30 -05:00
parent dfad8a880d
commit 7d850dbeca
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
synapse/rest/client/v1/room.py
View File

@ -358,17 +358,18 @@ class RoomBatchSendEventRestServlet(TransactionRestServlet):
return depth return depth
def _create_insertion_event_dict(self, sender: str, origin_server_ts: int): def _create_insertion_event_dict(self, sender: str, origin_server_ts: int):
""" """Creates an event dict for an "insertion" event with the proper fields
Creates an event dict for an "insertion" event with the proper fields
and a random chunk ID. and a random chunk ID.
Args: Args:
sender: The event author MXID sender: The event author MXID
origin_server_ts: Timestamp when the event was sent origin_server_ts: Timestamp when the event was sent
Returns: Returns:
Tuple of event ID and stream ordering position Tuple of event ID and stream ordering position
""" """
next_chunk_id = random_string(64) next_chunk_id = random_string(8)
insertion_event = { insertion_event = {
"type": EventTypes.MSC2716_INSERTION, "type": EventTypes.MSC2716_INSERTION,
"sender": sender, "sender": sender,
@ -493,8 +494,13 @@ class RoomBatchSendEventRestServlet(TransactionRestServlet):
if chunk_id_from_query: if chunk_id_from_query:
# TODO: Verify the chunk_id_from_query corresponds to an insertion event # TODO: Verify the chunk_id_from_query corresponds to an insertion event
pass pass
# Otherwise, create an insertion event to be based off of and connect # Otherwise, create an insertion event to act as a starting point.
# to as a starting point. #
# We don't always have an insertion event to start hanging more history
# off of (ideally there would be one in the main DAG, but that's not the
# case if we're wanting to add history to e.g. existing rooms without
# an insertion event), in which case we just create a new insertion event
# that can then get pointed to by a "marker" event later.
else: else:
base_insertion_event = self._create_insertion_event_dict( base_insertion_event = self._create_insertion_event_dict(
sender=requester.user.to_string(), sender=requester.user.to_string(),