[revert after element-hq#19723] maybe fix for rest.client.sliding_sync/test_rooms_invites.SlidingSyncRoomsInvitesTestCase to use 'stripped state' to compare against responses instead of fleshing out a full PDU

Author: jason-famedly

tests/rest/client/sliding_sync/test_rooms_invites.py

@@ -21,7 +21,7 @@
 from synapse.api.constants import EventTypes, HistoryVisibility
 from synapse.rest.client import login, room, sync
 from synapse.server import HomeServer
-from synapse.types import UserID
+from synapse.types import JsonDict, UserID
 from synapse.util.clock import Clock
 
 from tests.rest.client.sliding_sync.test_sliding_sync import SlidingSyncBase
@@ -66,14 +66,39 @@ def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
         self.storage_controllers = hs.get_storage_controllers()
 
         super().prepare(reactor, clock, hs)
+        self.room_version = hs.config.server.default_room_version
+
+    def assertHasSubset(
+        self,
+        container: list[JsonDict],
+        contains_these: list[JsonDict],
+    ) -> None:
+        assert contains_these, "`contains_these` was empty"
+        assert container, "`container` was empty"
+
+        for dict_to_search_for in contains_these:
+            for container_entry in container:
+                # The <= operator is a subset comparison operator when used on
+                # 'set-like' containers
+                if dict_to_search_for.items() <= container_entry.items():
+                    # The searched for item was found, move on. Break will skip the
+                    # else statement below
+                    break
+            else:
+                # Searching the 'container' for this subset yielded nothing, that is
+                # an error.
+                raise AssertionError(
+                    "The searched for dict was not present in the container:\n\n"
+                    f"Searched for {dict_to_search_for}\n\nContainer: {container}"
+                )
 
     def test_rooms_invite_shared_history_initial_sync(self) -> None:
         """
         Test that `rooms` we are invited to have some stripped `invite_state` during an
         initial sync.
 
         This is an `invite` room so we should only have `stripped_state` (no `timeline`)
-        but we also shouldn't see any timeline events because the history visiblity is
+        but we also shouldn't see any timeline events because the history visibility is
         `shared` and we haven't joined the room yet.
         """
         user1_id = self.register_user("user1", "pass")
@@ -85,7 +110,7 @@ def test_rooms_invite_shared_history_initial_sync(self) -> None:
 
         room_id1 = self.helper.create_room_as(user2_id, tok=user2_tok)
         # Ensure we're testing with a room with `shared` history visibility which means
-        # history visible until you actually join the room.
+        # history won't be visible until you actually join the room.
         history_visibility_response = self.helper.get_state(
             room_id1, EventTypes.RoomHistoryVisibility, tok=user2_tok
         )
@@ -138,12 +163,15 @@ def test_rooms_invite_shared_history_initial_sync(self) -> None:
             response_body["rooms"][room_id1],
         )
         # We should have some `stripped_state` so the potential joiner can identify the
-        # room (we don't care about the order).
-        self.assertCountEqual(
+        # room (we don't care about the order). The exception is the creation event
+        # which is a full PDU format from room v12 and newer
+        self.assertHasSubset(
             response_body["rooms"][room_id1]["invite_state"],
             [
                 {
-                    "content": {"creator": user2_id, "room_version": "10"},
+                    "content": {
+                        "room_version": self.room_version.identifier,
+                    },
                     "sender": user2_id,
                     "state_key": "",
                     "type": "m.room.create",
@@ -167,7 +195,6 @@ def test_rooms_invite_shared_history_initial_sync(self) -> None:
                     "type": "m.room.member",
                 },
             ],
-            response_body["rooms"][room_id1]["invite_state"],
         )
 
     def test_rooms_invite_shared_history_incremental_sync(self) -> None:
@@ -248,12 +275,15 @@ def test_rooms_invite_shared_history_incremental_sync(self) -> None:
             response_body["rooms"][room_id1],
         )
         # We should have some `stripped_state` so the potential joiner can identify the
-        # room (we don't care about the order).
-        self.assertCountEqual(
+        # room (we don't care about the order). The exception is the creation event
+        # which is a full PDU format from room v12 and newer
+        self.assertHasSubset(
             response_body["rooms"][room_id1]["invite_state"],
             [
                 {
-                    "content": {"creator": user2_id, "room_version": "10"},
+                    "content": {
+                        "room_version": self.room_version.identifier,
+                    },
                     "sender": user2_id,
                     "state_key": "",
                     "type": "m.room.create",
@@ -277,7 +307,6 @@ def test_rooms_invite_shared_history_incremental_sync(self) -> None:
                     "type": "m.room.member",
                 },
             ],
-            response_body["rooms"][room_id1]["invite_state"],
         )
 
     def test_rooms_invite_world_readable_history_initial_sync(self) -> None:
@@ -369,12 +398,15 @@ def test_rooms_invite_world_readable_history_initial_sync(self) -> None:
             response_body["rooms"][room_id1],
         )
         # We should have some `stripped_state` so the potential joiner can identify the
-        # room (we don't care about the order).
-        self.assertCountEqual(
+        # room (we don't care about the order). The exception is the creation event
+        # which is a full PDU format from room v12 and newer
+        self.assertHasSubset(
             response_body["rooms"][room_id1]["invite_state"],
             [
                 {
-                    "content": {"creator": user2_id, "room_version": "10"},
+                    "content": {
+                        "room_version": self.room_version.identifier,
+                    },
                     "sender": user2_id,
                     "state_key": "",
                     "type": "m.room.create",
@@ -398,7 +430,6 @@ def test_rooms_invite_world_readable_history_initial_sync(self) -> None:
                     "type": "m.room.member",
                 },
             ],
-            response_body["rooms"][room_id1]["invite_state"],
         )
 
     def test_rooms_invite_world_readable_history_incremental_sync(self) -> None:
@@ -495,12 +526,15 @@ def test_rooms_invite_world_readable_history_incremental_sync(self) -> None:
             response_body["rooms"][room_id1],
         )
         # We should have some `stripped_state` so the potential joiner can identify the
-        # room (we don't care about the order).
-        self.assertCountEqual(
+        # room (we don't care about the order). The exception is the creation event
+        # which is a full PDU format from room v12 and newer
+        self.assertHasSubset(
             response_body["rooms"][room_id1]["invite_state"],
             [
                 {
-                    "content": {"creator": user2_id, "room_version": "10"},
+                    "content": {
+                        "room_version": self.room_version.identifier,
+                    },
                     "sender": user2_id,
                     "state_key": "",
                     "type": "m.room.create",
@@ -524,5 +558,4 @@ def test_rooms_invite_world_readable_history_incremental_sync(self) -> None:
                     "type": "m.room.member",
                 },
             ],
-            response_body["rooms"][room_id1]["invite_state"],
         )