mirror of
https://mau.dev/maunium/synapse.git
synced 2024-10-01 01:36:05 -04:00
7d52ce7d4b
I thought ruff check would also format, but it doesn't. This runs ruff format in CI and dev scripts. The first commit is just a run of `ruff format .` in the root directory.
112 lines
3.0 KiB
Python
112 lines
3.0 KiB
Python
#
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
#
|
|
# Copyright 2014-2016 OpenMarket Ltd
|
|
# Copyright (C) 2023 New Vector, Ltd
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero General Public License as
|
|
# published by the Free Software Foundation, either version 3 of the
|
|
# License, or (at your option) any later version.
|
|
#
|
|
# See the GNU Affero General Public License for more details:
|
|
# <https://www.gnu.org/licenses/agpl-3.0.html>.
|
|
#
|
|
# Originally licensed under the Apache License, Version 2.0:
|
|
# <http://www.apache.org/licenses/LICENSE-2.0>.
|
|
#
|
|
# [This file includes modifications made by New Vector Limited]
|
|
#
|
|
#
|
|
|
|
"""Defines the JSON structure of the protocol units used by the server to
|
|
server protocol.
|
|
"""
|
|
|
|
import logging
|
|
from typing import List, Optional
|
|
|
|
import attr
|
|
|
|
from synapse.types import JsonDict
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
@attr.s(slots=True, frozen=True, auto_attribs=True)
|
|
class Edu:
|
|
"""An Edu represents a piece of data sent from one homeserver to another.
|
|
|
|
In comparison to Pdus, Edus are not persisted for a long time on disk, are
|
|
not meaningful beyond a given pair of homeservers, and don't have an
|
|
internal ID or previous references graph.
|
|
"""
|
|
|
|
edu_type: str
|
|
content: dict
|
|
origin: str
|
|
destination: str
|
|
|
|
def get_dict(self) -> JsonDict:
|
|
return {
|
|
"edu_type": self.edu_type,
|
|
"content": self.content,
|
|
}
|
|
|
|
def get_internal_dict(self) -> JsonDict:
|
|
return {
|
|
"edu_type": self.edu_type,
|
|
"content": self.content,
|
|
"origin": self.origin,
|
|
"destination": self.destination,
|
|
}
|
|
|
|
def get_context(self) -> str:
|
|
return getattr(self, "content", {}).get("org.matrix.opentracing_context", "{}")
|
|
|
|
def strip_context(self) -> None:
|
|
getattr(self, "content", {})["org.matrix.opentracing_context"] = "{}"
|
|
|
|
|
|
def _none_to_list(edus: Optional[List[JsonDict]]) -> List[JsonDict]:
|
|
if edus is None:
|
|
return []
|
|
return edus
|
|
|
|
|
|
@attr.s(slots=True, frozen=True, auto_attribs=True)
|
|
class Transaction:
|
|
"""A transaction is a list of Pdus and Edus to be sent to a remote home
|
|
server with some extra metadata.
|
|
|
|
Example transaction::
|
|
|
|
{
|
|
"origin": "foo",
|
|
"prev_ids": ["abc", "def"],
|
|
"pdus": [
|
|
...
|
|
],
|
|
}
|
|
|
|
"""
|
|
|
|
# Required keys.
|
|
transaction_id: str
|
|
origin: str
|
|
destination: str
|
|
origin_server_ts: int
|
|
pdus: List[JsonDict] = attr.ib(factory=list, converter=_none_to_list)
|
|
edus: List[JsonDict] = attr.ib(factory=list, converter=_none_to_list)
|
|
|
|
def get_dict(self) -> JsonDict:
|
|
"""A JSON-ready dictionary of valid keys which aren't internal."""
|
|
result = {
|
|
"origin": self.origin,
|
|
"origin_server_ts": self.origin_server_ts,
|
|
"pdus": self.pdus,
|
|
}
|
|
if self.edus:
|
|
result["edus"] = self.edus
|
|
return result
|