From dd2d66b0c9f3ff734314fcddb7f90f3225ddb555 Mon Sep 17 00:00:00 2001 From: Patrick Cloke Date: Wed, 8 Jun 2022 09:00:35 -0400 Subject: [PATCH] Move the (unstable) `dir` parameter for /relations behind an experimental flag. (#12984) MSC3715 defines this parameter, but the unstable version of it should be behind an experimental flag. --- changelog.d/12984.misc | 1 + synapse/config/experimental.py | 3 +++ synapse/rest/client/relations.py | 13 ++++++++++--- tests/rest/client/test_relations.py | 1 + 4 files changed, 15 insertions(+), 3 deletions(-) create mode 100644 changelog.d/12984.misc diff --git a/changelog.d/12984.misc b/changelog.d/12984.misc new file mode 100644 index 000000000..a90201718 --- /dev/null +++ b/changelog.d/12984.misc @@ -0,0 +1 @@ +Move [MSC3715](https://github.com/matrix-org/matrix-spec-proposals/pull/3715) behind an experimental config flag. diff --git a/synapse/config/experimental.py b/synapse/config/experimental.py index f2dfd49b0..0a285dba3 100644 --- a/synapse/config/experimental.py +++ b/synapse/config/experimental.py @@ -84,3 +84,6 @@ class ExperimentalConfig(Config): # MSC3772: A push rule for mutual relations. self.msc3772_enabled: bool = experimental.get("msc3772_enabled", False) + + # MSC3715: dir param on /relations. + self.msc3715_enabled: bool = experimental.get("msc3715_enabled", False) diff --git a/synapse/rest/client/relations.py b/synapse/rest/client/relations.py index 3cae6d2b5..ce9708001 100644 --- a/synapse/rest/client/relations.py +++ b/synapse/rest/client/relations.py @@ -43,6 +43,7 @@ class RelationPaginationServlet(RestServlet): self.auth = hs.get_auth() self.store = hs.get_datastores().main self._relations_handler = hs.get_relations_handler() + self._msc3715_enabled = hs.config.experimental.msc3715_enabled async def on_GET( self, @@ -55,9 +56,15 @@ class RelationPaginationServlet(RestServlet): requester = await self.auth.get_user_by_req(request, allow_guest=True) limit = parse_integer(request, "limit", default=5) - direction = parse_string( - request, "org.matrix.msc3715.dir", default="b", allowed_values=["f", "b"] - ) + if self._msc3715_enabled: + direction = parse_string( + request, + "org.matrix.msc3715.dir", + default="b", + allowed_values=["f", "b"], + ) + else: + direction = "b" from_token_str = parse_string(request, "from") to_token_str = parse_string(request, "to") diff --git a/tests/rest/client/test_relations.py b/tests/rest/client/test_relations.py index 62e4db23e..aa8490654 100644 --- a/tests/rest/client/test_relations.py +++ b/tests/rest/client/test_relations.py @@ -728,6 +728,7 @@ class RelationsTestCase(BaseRelationsTestCase): class RelationPaginationTestCase(BaseRelationsTestCase): + @unittest.override_config({"experimental_features": {"msc3715_enabled": True}}) def test_basic_paginate_relations(self) -> None: """Tests that calling pagination API correctly the latest relations.""" channel = self._send_relation(RelationTypes.ANNOTATION, "m.reaction", "a")