From c5969b346d2694fea32ddd063ce40fec41028b57 Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Mon, 9 May 2022 11:09:19 +0100 Subject: [PATCH] Don't error on unknown receipt types (#12670) Fixes #12669 --- changelog.d/12670.feature | 1 + synapse/rest/client/read_marker.py | 25 ++++++++++++++----------- 2 files changed, 15 insertions(+), 11 deletions(-) create mode 100644 changelog.d/12670.feature diff --git a/changelog.d/12670.feature b/changelog.d/12670.feature new file mode 100644 index 000000000..cd5c45029 --- /dev/null +++ b/changelog.d/12670.feature @@ -0,0 +1 @@ +Implement [changes](https://github.com/matrix-org/matrix-spec-proposals/pull/2285/commits/4a77139249c2e830aec3c7d6bd5501a514d1cc27) to [MSC2285 (hidden read receipts)](https://github.com/matrix-org/matrix-spec-proposals/pull/2285). Contributed by @SimonBrandner. diff --git a/synapse/rest/client/read_marker.py b/synapse/rest/client/read_marker.py index 1583e903c..3644705e6 100644 --- a/synapse/rest/client/read_marker.py +++ b/synapse/rest/client/read_marker.py @@ -16,7 +16,6 @@ import logging from typing import TYPE_CHECKING, Tuple from synapse.api.constants import ReceiptTypes -from synapse.api.errors import SynapseError from synapse.http.server import HttpServer from synapse.http.servlet import RestServlet, parse_json_object_from_request from synapse.http.site import SynapseRequest @@ -50,17 +49,21 @@ class ReadMarkerRestServlet(RestServlet): body = parse_json_object_from_request(request) - valid_receipt_types = {ReceiptTypes.READ, ReceiptTypes.FULLY_READ} - if self.config.experimental.msc2285_enabled: - valid_receipt_types.add(ReceiptTypes.READ_PRIVATE) + valid_receipt_types = { + ReceiptTypes.READ, + ReceiptTypes.FULLY_READ, + ReceiptTypes.READ_PRIVATE, + } - if set(body.keys()) > valid_receipt_types: - raise SynapseError( - 400, - "Receipt type must be 'm.read', 'org.matrix.msc2285.read.private' or 'm.fully_read'" - if self.config.experimental.msc2285_enabled - else "Receipt type must be 'm.read' or 'm.fully_read'", - ) + unrecognized_types = set(body.keys()) - valid_receipt_types + if unrecognized_types: + # It's fine if there are unrecognized receipt types, but let's log + # it to help debug clients that have typoed the receipt type. + # + # We specifically *don't* error here, as a) it stops us processing + # the valid receipts, and b) we need to be extensible on receipt + # types. + logger.info("Ignoring unrecognized receipt types: %s", unrecognized_types) read_event_id = body.get(ReceiptTypes.READ, None) if read_event_id: