Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Split out /batch_send meta events to their own fields (MSC2716) #10777

Merged
merged 7 commits into from
Sep 15, 2021
Merged

Split out /batch_send meta events to their own fields (MSC2716) #10777

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c5453df
Split out /batch_send meta properties to their own fields
MadLittleMods Sep 7, 2021
341b873
Add changelog
MadLittleMods Sep 7, 2021
e8a90e9
Fix linting
MadLittleMods Sep 7, 2021
b411a77
More understandable array slicing and dicing
MadLittleMods Sep 10, 2021
3499f6c
Merge branch 'develop' into madlittlemods/2716-split-out-meta-respons…
MadLittleMods Sep 10, 2021
1a28421
Merge branch 'develop' into madlittlemods/2716-split-out-meta-respons…
MadLittleMods Sep 13, 2021
1b53a6b
Merge branch 'develop' into madlittlemods/2716-split-out-meta-respons…
MadLittleMods Sep 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/10777.misc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Split out [MSC2716](https://github.com/matrix-org/matrix-doc/pull/2716) meta events to their own fields in the `/batch_send` response.
29 changes: 18 additions & 11 deletions synapse/rest/client/room_batch.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@

import logging
import re
from http import HTTPStatus
from typing import TYPE_CHECKING, Awaitable, List, Tuple

from twisted.web.server import Request
Expand Down Expand Up @@ -179,7 +180,7 @@ async def on_POST(

if not requester.app_service:
raise AuthError(
403,
HTTPStatus.FORBIDDEN,
"Only application services can use the /batchsend endpoint",
)

Expand All @@ -192,7 +193,7 @@ async def on_POST(

if prev_events_from_query is None:
raise SynapseError(
400,
HTTPStatus.BAD_REQUEST,
"prev_event query parameter is required when inserting historical messages back in time",
errcode=Codes.MISSING_PARAM,
)
Expand All @@ -213,7 +214,7 @@ async def on_POST(
prev_state_ids = list(prev_state_map.values())
auth_event_ids = prev_state_ids

state_events_at_start = []
state_event_ids_at_start = []
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unrelated to this PR, but this method really needs splitting up. I shouldn't have to scroll through over 200 lines to find out where a variable is used!

Copy link
Contributor Author

@MadLittleMods MadLittleMods Sep 10, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Definitely. I've been holding off on refactors like this while so many PRs have been in flight at the same time 😬

for state_event in body["state_events_at_start"]:
assert_params_in_dict(
state_event, ["type", "origin_server_ts", "content", "sender"]
Expand Down Expand Up @@ -279,7 +280,7 @@ async def on_POST(
)
event_id = event.event_id

state_events_at_start.append(event_id)
state_event_ids_at_start.append(event_id)
auth_event_ids.append(event_id)

events_to_create = body["events"]
Expand Down Expand Up @@ -424,20 +425,26 @@ async def on_POST(
context=context,
)

# Add the base_insertion_event to the bottom of the list we return
if base_insertion_event is not None:
event_ids.append(base_insertion_event.event_id)
insertion_event_id = event_ids.pop(0)
chunk_event_id = event_ids.pop(len(event_ids) - 1)
historical_event_ids = event_ids
MadLittleMods marked this conversation as resolved.
Show resolved Hide resolved

return 200, {
"state_events": state_events_at_start,
"events": event_ids,
response_dict = {
"state_event_ids": state_event_ids_at_start,
"event_ids": historical_event_ids,
"next_chunk_id": insertion_event["content"][
EventContentFields.MSC2716_NEXT_CHUNK_ID
],
"insertion_event_id": insertion_event_id,
"chunk_event_id": chunk_event_id,
}
if base_insertion_event is not None:
response_dict["base_insertion_event_id"] = base_insertion_event.event_id

return HTTPStatus.OK, response_dict
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I started using HTTPStatus because I originally noticed it on this line and wanted to make it consistent in this file


def on_GET(self, request: Request, room_id: str) -> Tuple[int, str]:
return 501, "Not implemented"
return HTTPStatus.NOT_IMPLEMENTED, "Not implemented"

def on_PUT(
self, request: SynapseRequest, room_id: str
Expand Down