Rename capability

Author: Johennes

changelog.d/18196.feature

@@ -1 +1 @@
-Add `leave_without_forget` capability as per [MSC4267](https://github.com/matrix-org/matrix-spec-proposals/pull/4267).
+Add `forget_forced_upon_leave` capability as per [MSC4267](https://github.com/matrix-org/matrix-spec-proposals/pull/4267).

synapse/rest/client/capabilities.py

@@ -110,8 +110,8 @@ async def on_GET(self, request: SynapseRequest) -> Tuple[int, JsonDict]:
                 ] = disallowed
 
         if self.config.experimental.msc4267_enabled:
-            response["capabilities"]["org.matrix.msc4267.leave_without_forget"] = {
-                "enabled": not self.config.room.forget_on_leave,
+            response["capabilities"]["org.matrix.msc4267.forget_forced_upon_leave"] = {
+                "enabled": self.config.room.forget_on_leave,
             }
 
         return HTTPStatus.OK, response

tests/rest/client/test_capabilities.py

@@ -271,8 +271,8 @@ def test_get_get_token_login_fields_when_enabled(self) -> None:
             "forget_rooms_on_leave": True,
         }
     )
-    def test_get_leave_without_forget_with_auto_forget(self) -> None:
-        # Server auto-forgets on /leave, expect disabled client capability
+    def test_get_forget_forced_upon_leave_with_auto_forget(self) -> None:
+        # Server auto-forgets on /leave, expect enabled client capability
         access_token = self.get_success(
             self.auth_handler.create_access_token_for_user_id(
                 self.user, device_id=None, valid_until_ms=None
@@ -281,8 +281,8 @@ def test_get_leave_without_forget_with_auto_forget(self) -> None:
         channel = self.make_request("GET", self.url, access_token=access_token)
         capabilities = channel.json_body["capabilities"]
         self.assertEqual(channel.code, HTTPStatus.OK)
-        self.assertFalse(
-            capabilities["org.matrix.msc4267.leave_without_forget"]["enabled"]
+        self.assertTrue(
+            capabilities["org.matrix.msc4267.forget_forced_upon_leave"]["enabled"]
         )
 
     @override_config(
@@ -291,7 +291,7 @@ def test_get_leave_without_forget_with_auto_forget(self) -> None:
             "forget_rooms_on_leave": False,
         }
     )
-    def test_get_leave_without_forget_without_auto_forget(self) -> None:
+    def test_get_forget_forced_upon_leave_without_auto_forget(self) -> None:
         # Server doesn't auto-forget on /leave, expect disabled client capability
         access_token = self.get_success(
             self.auth_handler.create_access_token_for_user_id(
@@ -301,6 +301,6 @@ def test_get_leave_without_forget_without_auto_forget(self) -> None:
         channel = self.make_request("GET", self.url, access_token=access_token)
         capabilities = channel.json_body["capabilities"]
         self.assertEqual(channel.code, HTTPStatus.OK)
-        self.assertTrue(
-            capabilities["org.matrix.msc4267.leave_without_forget"]["enabled"]
+        self.assertFalse(
+            capabilities["org.matrix.msc4267.forget_forced_upon_leave"]["enabled"]
         )