diff --git a/synapse/events/utils.py b/synapse/events/utils.py
index 6fa631aa1d..84ef69df67 100644
--- a/synapse/events/utils.py
+++ b/synapse/events/utils.py
@@ -1,4 +1,5 @@
# Copyright 2014-2016 OpenMarket Ltd
+# Copyright 2021 The Matrix.org Foundation C.I.C.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
@@ -305,6 +306,7 @@ def format_event_for_client_v2_without_room_id(d: JsonDict) -> JsonDict:
def serialize_event(
e: Union[JsonDict, EventBase],
time_now_ms: int,
+ *,
as_client_event: bool = True,
event_format: Callable[[JsonDict], JsonDict] = format_event_for_client_v1,
token_id: Optional[str] = None,
@@ -392,15 +394,18 @@ class EventClientSerializer:
self,
event: Union[JsonDict, EventBase],
time_now: int,
+ *,
bundle_aggregations: bool = True,
**kwargs: Any,
) -> JsonDict:
"""Serializes a single event.
Args:
- event
+ event: The event being serialized.
time_now: The current time in milliseconds
- bundle_aggregations: Whether to bundle in related events
+ bundle_aggregations: Whether to include the bundled aggregations for this
+ event. Only applies to non-state events. (State events never include
+ bundled aggregations.)
**kwargs: Arguments to pass to `serialize_event`
Returns:
@@ -410,76 +415,109 @@ class EventClientSerializer:
if not isinstance(event, EventBase):
return event
- event_id = event.event_id
serialized_event = serialize_event(event, time_now, **kwargs)
- # If MSC1849 is enabled then we need to look if there are any relations
- # we need to bundle in with the event.
- # Do not bundle relations if the event has been redacted
- if not event.internal_metadata.is_redacted() and (
- self._msc1849_enabled and bundle_aggregations
+ # Check if there are any bundled aggregations to include with the event.
+ #
+ # Do not bundle aggregations if any of the following at true:
+ #
+ # * Support is disabled via the configuration or the caller.
+ # * The event is a state event.
+ # * The event has been redacted.
+ if (
+ self._msc1849_enabled
+ and bundle_aggregations
+ and not event.is_state()
+ and not event.internal_metadata.is_redacted()
):
- annotations = await self.store.get_aggregation_groups_for_event(event_id)
- references = await self.store.get_relations_for_event(
- event_id, RelationTypes.REFERENCE, direction="f"
- )
+ await self._injected_bundled_aggregations(event, time_now, serialized_event)
- if annotations.chunk:
- r = serialized_event["unsigned"].setdefault("m.relations", {})
- r[RelationTypes.ANNOTATION] = annotations.to_dict()
-
- if references.chunk:
- r = serialized_event["unsigned"].setdefault("m.relations", {})
- r[RelationTypes.REFERENCE] = references.to_dict()
-
- edit = None
- if event.type == EventTypes.Message:
- edit = await self.store.get_applicable_edit(event_id)
-
- if edit:
- # If there is an edit replace the content, preserving existing
- # relations.
-
- # Ensure we take copies of the edit content, otherwise we risk modifying
- # the original event.
- edit_content = edit.content.copy()
-
- # Unfreeze the event content if necessary, so that we may modify it below
- edit_content = unfreeze(edit_content)
- serialized_event["content"] = edit_content.get("m.new_content", {})
-
- # Check for existing relations
- relations = event.content.get("m.relates_to")
- if relations:
- # Keep the relations, ensuring we use a dict copy of the original
- serialized_event["content"]["m.relates_to"] = relations.copy()
- else:
- serialized_event["content"].pop("m.relates_to", None)
-
- r = serialized_event["unsigned"].setdefault("m.relations", {})
- r[RelationTypes.REPLACE] = {
- "event_id": edit.event_id,
- "origin_server_ts": edit.origin_server_ts,
- "sender": edit.sender,
- }
+ return serialized_event
- # If this event is the start of a thread, include a summary of the replies.
- if self._msc3440_enabled:
- (
- thread_count,
- latest_thread_event,
- ) = await self.store.get_thread_summary(event_id)
- if latest_thread_event:
- r = serialized_event["unsigned"].setdefault("m.relations", {})
- r[RelationTypes.THREAD] = {
- # Don't bundle aggregations as this could recurse forever.
- "latest_event": await self.serialize_event(
- latest_thread_event, time_now, bundle_aggregations=False
- ),
- "count": thread_count,
- }
+ async def _injected_bundled_aggregations(
+ self, event: EventBase, time_now: int, serialized_event: JsonDict
+ ) -> None:
+ """Potentially injects bundled aggregations into the unsigned portion of the serialized event.
- return serialized_event
+ Args:
+ event: The event being serialized.
+ time_now: The current time in milliseconds
+ serialized_event: The serialized event which may be modified.
+
+ """
+ # Do not bundle aggregations for an event which represents an edit or an
+ # annotation. It does not make sense for them to have related events.
+ relates_to = event.content.get("m.relates_to")
+ if isinstance(relates_to, (dict, frozendict)):
+ relation_type = relates_to.get("rel_type")
+ if relation_type in (RelationTypes.ANNOTATION, RelationTypes.REPLACE):
+ return
+
+ event_id = event.event_id
+
+ # The bundled aggregations to include.
+ aggregations = {}
+
+ annotations = await self.store.get_aggregation_groups_for_event(event_id)
+ if annotations.chunk:
+ aggregations[RelationTypes.ANNOTATION] = annotations.to_dict()
+
+ references = await self.store.get_relations_for_event(
+ event_id, RelationTypes.REFERENCE, direction="f"
+ )
+ if references.chunk:
+ aggregations[RelationTypes.REFERENCE] = references.to_dict()
+
+ edit = None
+ if event.type == EventTypes.Message:
+ edit = await self.store.get_applicable_edit(event_id)
+
+ if edit:
+ # If there is an edit replace the content, preserving existing
+ # relations.
+
+ # Ensure we take copies of the edit content, otherwise we risk modifying
+ # the original event.
+ edit_content = edit.content.copy()
+
+ # Unfreeze the event content if necessary, so that we may modify it below
+ edit_content = unfreeze(edit_content)
+ serialized_event["content"] = edit_content.get("m.new_content", {})
+
+ # Check for existing relations
+ relates_to = event.content.get("m.relates_to")
+ if relates_to:
+ # Keep the relations, ensuring we use a dict copy of the original
+ serialized_event["content"]["m.relates_to"] = relates_to.copy()
+ else:
+ serialized_event["content"].pop("m.relates_to", None)
+
+ aggregations[RelationTypes.REPLACE] = {
+ "event_id": edit.event_id,
+ "origin_server_ts": edit.origin_server_ts,
+ "sender": edit.sender,
+ }
+
+ # If this event is the start of a thread, include a summary of the replies.
+ if self._msc3440_enabled:
+ (
+ thread_count,
+ latest_thread_event,
+ ) = await self.store.get_thread_summary(event_id)
+ if latest_thread_event:
+ aggregations[RelationTypes.THREAD] = {
+ # Don't bundle aggregations as this could recurse forever.
+ "latest_event": await self.serialize_event(
+ latest_thread_event, time_now, bundle_aggregations=False
+ ),
+ "count": thread_count,
+ }
+
+ # If any bundled aggregations were found, include them.
+ if aggregations:
+ serialized_event["unsigned"].setdefault("m.relations", {}).update(
+ aggregations
+ )
async def serialize_events(
self, events: Iterable[Union[JsonDict, EventBase]], time_now: int, **kwargs: Any
|
