From e01ea0edc0754bad5564ebdb3017d400d25e18e0 Mon Sep 17 00:00:00 2001
From: Mathieu Velten <mathieuv@matrix.org>
Date: Fri, 19 May 2023 12:29:05 +0200
Subject: [PATCH] Add test

---
 synapse/handlers/room_list.py                 |  1 +
 synapse/storage/databases/main/room.py        |  8 +-
 .../module_api/test_fetch_public_rooms_cb.py  | 96 +++++++++++++++++++
 3 files changed, 103 insertions(+), 2 deletions(-)
 create mode 100644 tests/module_api/test_fetch_public_rooms_cb.py

diff --git a/synapse/handlers/room_list.py b/synapse/handlers/room_list.py
index 1df739aa1f..2f66f5abb5 100644
--- a/synapse/handlers/room_list.py
+++ b/synapse/handlers/room_list.py
@@ -201,6 +201,7 @@ class RoomListHandler:
                         and new_room["num_joined_members"] <= r["num_joined_members"]
                     ):
                         results.insert(i, new_room)
+                        inserted = True
                         break
                 if not inserted:
                     if forwards:
diff --git a/synapse/storage/databases/main/room.py b/synapse/storage/databases/main/room.py
index d81068fe69..67613ab90e 100644
--- a/synapse/storage/databases/main/room.py
+++ b/synapse/storage/databases/main/room.py
@@ -527,7 +527,7 @@ class RoomWorkerStore(CacheInvalidationWorkerStore):
         )
 
         def build_room_entry(room: JsonDict) -> PublicRoom:
-            return PublicRoom(
+            entry = PublicRoom(
                 room_id=room["room_id"],
                 name=room["name"],
                 topic=room["topic"],
@@ -542,7 +542,11 @@ class RoomWorkerStore(CacheInvalidationWorkerStore):
             )
 
             # Filter out Nones – rather omit the field altogether
-            # return {k: v for k, v in entry.items() if v is not None}
+            for key in list(entry):
+                if entry[key] == None:
+                    del entry[key]
+
+            return entry
 
         return [build_room_entry(r) for r in ret_val]
 
diff --git a/tests/module_api/test_fetch_public_rooms_cb.py b/tests/module_api/test_fetch_public_rooms_cb.py
new file mode 100644
index 0000000000..a62764ab72
--- /dev/null
+++ b/tests/module_api/test_fetch_public_rooms_cb.py
@@ -0,0 +1,96 @@
+# Copyright 2022 The Matrix.org Foundation C.I.C.
+#
+# 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.
+from twisted.test.proto_helpers import MemoryReactor
+
+from http import HTTPStatus
+from typing import (
+    TYPE_CHECKING,
+    Callable,
+    Dict,
+    List,
+    Optional,
+    TypeVar,
+    cast,
+    Iterable,
+)
+
+from synapse.api.errors import SynapseError
+from synapse.rest import admin, login, room
+from synapse.server import HomeServer
+from synapse.types import PublicRoom
+from synapse.util import Clock
+
+from tests.unittest import HomeserverTestCase
+
+
+class FetchPublicRoomsCbTestCase(HomeserverTestCase):
+    servlets = [
+        admin.register_servlets,
+        login.register_servlets,
+        room.register_servlets,
+    ]
+
+    def make_homeserver(self, reactor: MemoryReactor, clock: Clock) -> HomeServer:
+        config = self.default_config()
+        config["allow_public_rooms_without_auth"] = True
+        self.hs = self.setup_test_homeserver(config=config)
+        self.url = b"/_matrix/client/r0/publicRooms"
+
+        return self.hs
+
+    def prepare(
+        self, reactor: MemoryReactor, clock: Clock, homeserver: HomeServer
+    ) -> None:
+        self._store = homeserver.get_datastores().main
+        self._module_api = homeserver.get_module_api()
+
+        async def cb(
+            forwards: bool, limit: Optional[int], last_joined_members: Optional[int]
+        ) -> Iterable[PublicRoom]:
+            return [
+                PublicRoom(
+                    room_id="!test1:test",
+                    num_joined_members=1,
+                    world_readable=True,
+                    guest_can_join=False,
+                ),
+                PublicRoom(
+                    room_id="!test3:test",
+                    num_joined_members=3,
+                    world_readable=True,
+                    guest_can_join=False,
+                )
+            ]
+
+        self._module_api.register_public_rooms_callbacks(fetch_public_rooms=cb)
+
+        user = self.register_user("alice", "pass")
+        token = self.login(user, "pass")
+
+        # Create a room
+        room_id = self.helper.create_room_as(
+            user,
+            is_public=True,
+            extra_content={"visibility": "public"},
+            tok=token,
+        )
+
+        user2 = self.register_user("alice2", "pass")
+        token2 = self.login(user2, "pass")
+        self.helper.join(room_id, user2, tok=token2)
+
+    def test_public_rooms(self) -> None:
+        channel = self.make_request("GET", self.url)
+        print(channel.text_body)
+        self.assertEqual(channel.code, HTTPStatus.OK, channel.result)