synapse-product/synapse/federation/persistence.py

66 lines
2.3 KiB
Python
Raw Normal View History

2016-01-06 23:26:29 -05:00
# Copyright 2014-2016 OpenMarket Ltd
2014-08-12 10:10:52 -04:00
#
# 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.
2014-08-12 10:10:52 -04:00
""" This module contains all the persistence actions done by the federation
package.
These actions are mostly only used by the :py:mod:`.replication` module.
"""
2018-07-09 02:09:20 -04:00
import logging
from typing import Optional, Tuple
2018-07-09 02:09:20 -04:00
from synapse.federation.units import Transaction
from synapse.logging.utils import log_function
from synapse.types import JsonDict
2014-08-12 10:10:52 -04:00
logger = logging.getLogger(__name__)
2020-09-04 06:54:56 -04:00
class TransactionActions:
"""Defines persistence actions that relate to handling Transactions."""
2014-08-12 10:10:52 -04:00
def __init__(self, datastore):
self.store = datastore
@log_function
async def have_responded(
self, origin: str, transaction: Transaction
) -> Optional[Tuple[int, JsonDict]]:
"""Have we already responded to a transaction with the same id and
2014-08-12 10:10:52 -04:00
origin?
Returns:
`None` if we have not previously responded to this transaction or a
2-tuple of `(int, dict)` representing the response code and response body.
2014-08-12 10:10:52 -04:00
"""
transaction_id = transaction.transaction_id # type: ignore
if not transaction_id:
raise RuntimeError("Cannot persist a transaction with no transaction_id")
2014-08-12 10:10:52 -04:00
return await self.store.get_received_txn_response(transaction_id, origin)
2014-08-12 10:10:52 -04:00
@log_function
async def set_response(
self, origin: str, transaction: Transaction, code: int, response: JsonDict
) -> None:
"""Persist how we responded to a transaction."""
transaction_id = transaction.transaction_id # type: ignore
if not transaction_id:
raise RuntimeError("Cannot persist a transaction with no transaction_id")
2014-08-12 10:10:52 -04:00
await self.store.set_received_txn_response(
transaction_id, origin, code, response
2014-08-12 10:10:52 -04:00
)