Expose whether a room is a space in the Admin API

changelog.d/11934.feature

@@ -0,0 +1 @@
+Expose the `type` property of a room in the _List Room_ and _Room Details_ API.

synapse/storage/databases/main/room.py

@@ -12,7 +12,7 @@
 # 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.
-
+import json
 import logging
 from abc import abstractmethod
 from enum import Enum
@@ -162,16 +162,18 @@ def get_room_with_stats_txn(
             txn: LoggingTransaction, room_id: str
         ) -> Optional[Dict[str, Any]]:
             sql = """
-                SELECT room_id, state.name, state.canonical_alias, curr.joined_members,
+                SELECT rooms.room_id, state.name, state.canonical_alias, curr.joined_members,
                   curr.local_users_in_room AS joined_local_members, rooms.room_version AS version,
                   rooms.creator, state.encryption, state.is_federatable AS federatable,
                   rooms.is_public AS public, state.join_rules, state.guest_access,
                   state.history_visibility, curr.current_state_events AS state_events,
-                  state.avatar, state.topic
+                  state.avatar, state.topic, json.json
                 FROM rooms
+                INNER JOIN event_json json USING (room_id)
+                INNER JOIN state_events events USING (event_id)
                 LEFT JOIN room_stats_state state USING (room_id)
                 LEFT JOIN room_stats_current curr USING (room_id)
-                WHERE room_id = ?
+                WHERE rooms.room_id = ? AND events.type = 'm.room.create'
                 """
             txn.execute(sql, [room_id])
             # Catch error if sql returns empty result to return "None" instead of an error
@@ -182,12 +184,23 @@ def get_room_with_stats_txn(
 
             res["federatable"] = bool(res["federatable"])
             res["public"] = bool(res["public"])
+            res["type"] = self._get_type_from_event_json(res["json"])
+            del res["json"]
             return res
 
         return await self.db_pool.runInteraction(
             "get_room_with_stats", get_room_with_stats_txn, room_id
         )
 
+    def _get_type_from_event_json(self, event_json_str: Optional[str]) -> Optional[str]:
+        type_ = None
+        if event_json_str:
+            event_json = json.loads(event_json_str)
+            content = event_json.get("content")
+            if content:
+                type_ = content.get("type")
+        return type_
+
     async def get_public_room_ids(self) -> List[str]:
         return await self.db_pool.simple_select_onecol(
             table="rooms",
@@ -540,23 +553,31 @@ async def get_rooms_paginate(
             # Flip the boolean
             order_by_asc = not order_by_asc
 
+        if where_statement:
+            info_where_statement = where_statement + " AND events.type='m.room.create'"
+        else:
+            info_where_statement = "WHERE events.type='m.room.create'"
+
         # Create one query for getting the limited number of events that the user asked
         # for, and another query for getting the total number of events that could be
         # returned. Thus allowing us to see if there are more events to paginate through
         info_sql = """
             SELECT state.room_id, state.name, state.canonical_alias, curr.joined_members,
               curr.local_users_in_room, rooms.room_version, rooms.creator,
               state.encryption, state.is_federatable, rooms.is_public, state.join_rules,
-              state.guest_access, state.history_visibility, curr.current_state_events
+              state.guest_access, state.history_visibility, curr.current_state_events,
+              json.json
             FROM room_stats_state state
             INNER JOIN room_stats_current curr USING (room_id)
             INNER JOIN rooms USING (room_id)
+            INNER JOIN event_json json USING (room_id)
+            INNER JOIN state_events events USING (event_id)
             {where}
             ORDER BY {order_by} {direction}, state.room_id {direction}
             LIMIT ?
             OFFSET ?
         """.format(
-            where=where_statement,
+            where=info_where_statement,
             order_by=order_by_column,
             direction="ASC" if order_by_asc else "DESC",
         )
@@ -597,6 +618,7 @@ def _get_rooms_paginate_txn(
                         "guest_access": room[11],
                         "history_visibility": room[12],
                         "state_events": room[13],
+                        "type": self._get_type_from_event_json(room[14]),
                     }
                 )