mirror of
https://git.anonymousland.org/anonymousland/synapse.git
synced 2025-05-13 16:22:17 -04:00
Populate rooms.creator field for easy lookup (#10697)
Part of https://github.com/matrix-org/synapse/pull/10566 - Fill in creator whenever we insert into the rooms table - Add background update to backfill any missing creator values
This commit is contained in:
Eric Eastwood
GitHub
parent
e059094119
commit
dc75fb7f05
6 changed files with 213 additions and 4 deletions
|
|
@ -19,9 +19,10 @@ from abc import abstractmethod
|
|||
from enum import Enum
|
||||
from typing import Any, Dict, List, Optional, Tuple
|
||||
|
||||
from synapse.api.constants import EventTypes, JoinRules
|
||||
from synapse.api.constants import EventContentFields, EventTypes, JoinRules
|
||||
from synapse.api.errors import StoreError
|
||||
from synapse.api.room_versions import RoomVersion, RoomVersions
|
||||
from synapse.events import EventBase
|
||||
from synapse.storage._base import SQLBaseStore, db_to_json
|
||||
from synapse.storage.database import DatabasePool, LoggingTransaction
|
||||
from synapse.storage.databases.main.search import SearchStore
|
||||
|
|
@ -1013,6 +1014,7 @@ class _BackgroundUpdates:
|
|||
ADD_ROOMS_ROOM_VERSION_COLUMN = "add_rooms_room_version_column"
|
||||
POPULATE_ROOM_DEPTH_MIN_DEPTH2 = "populate_room_depth_min_depth2"
|
||||
REPLACE_ROOM_DEPTH_MIN_DEPTH = "replace_room_depth_min_depth"
|
||||
POPULATE_ROOMS_CREATOR_COLUMN = "populate_rooms_creator_column"
|
||||
|
||||
|
||||
_REPLACE_ROOM_DEPTH_SQL_COMMANDS = (
|
||||
|
|
@ -1054,6 +1056,11 @@ class RoomBackgroundUpdateStore(SQLBaseStore):
|
|||
self._background_replace_room_depth_min_depth,
|
||||
)
|
||||
|
||||
self.db_pool.updates.register_background_update_handler(
|
||||
_BackgroundUpdates.POPULATE_ROOMS_CREATOR_COLUMN,
|
||||
self._background_populate_rooms_creator_column,
|
||||
)
|
||||
|
||||
async def _background_insert_retention(self, progress, batch_size):
|
||||
"""Retrieves a list of all rooms within a range and inserts an entry for each of
|
||||
them into the room_retention table.
|
||||
|
|
@ -1273,7 +1280,7 @@ class RoomBackgroundUpdateStore(SQLBaseStore):
|
|||
keyvalues={"room_id": room_id},
|
||||
retcol="MAX(stream_ordering)",
|
||||
allow_none=True,
|
||||
desc="upsert_room_on_join",
|
||||
desc="has_auth_chain_index_fallback",
|
||||
)
|
||||
|
||||
return max_ordering is None
|
||||
|
|
@ -1343,6 +1350,65 @@ class RoomBackgroundUpdateStore(SQLBaseStore):
|
|||
|
||||
return 0
|
||||
|
||||
async def _background_populate_rooms_creator_column(
|
||||
self, progress: dict, batch_size: int
|
||||
):
|
||||
"""Background update to go and add creator information to `rooms`
|
||||
table from `current_state_events` table.
|
||||
"""
|
||||
|
||||
last_room_id = progress.get("room_id", "")
|
||||
|
||||
def _background_populate_rooms_creator_column_txn(txn: LoggingTransaction):
|
||||
sql = """
|
||||
SELECT room_id, json FROM event_json
|
||||
INNER JOIN rooms AS room USING (room_id)
|
||||
INNER JOIN current_state_events AS state_event USING (room_id, event_id)
|
||||
WHERE room_id > ? AND (room.creator IS NULL OR room.creator = '') AND state_event.type = 'm.room.create' AND state_event.state_key = ''
|
||||
ORDER BY room_id
|
||||
LIMIT ?
|
||||
"""
|
||||
|
||||
txn.execute(sql, (last_room_id, batch_size))
|
||||
room_id_to_create_event_results = txn.fetchall()
|
||||
|
||||
new_last_room_id = ""
|
||||
for room_id, event_json in room_id_to_create_event_results:
|
||||
event_dict = db_to_json(event_json)
|
||||
|
||||
creator = event_dict.get("content").get(EventContentFields.ROOM_CREATOR)
|
||||
|
||||
self.db_pool.simple_update_txn(
|
||||
txn,
|
||||
table="rooms",
|
||||
keyvalues={"room_id": room_id},
|
||||
updatevalues={"creator": creator},
|
||||
)
|
||||
new_last_room_id = room_id
|
||||
|
||||
if new_last_room_id == "":
|
||||
return True
|
||||
|
||||
self.db_pool.updates._background_update_progress_txn(
|
||||
txn,
|
||||
_BackgroundUpdates.POPULATE_ROOMS_CREATOR_COLUMN,
|
||||
{"room_id": new_last_room_id},
|
||||
)
|
||||
|
||||
return False
|
||||
|
||||
end = await self.db_pool.runInteraction(
|
||||
"_background_populate_rooms_creator_column",
|
||||
_background_populate_rooms_creator_column_txn,
|
||||
)
|
||||
|
||||
if end:
|
||||
await self.db_pool.updates._end_background_update(
|
||||
_BackgroundUpdates.POPULATE_ROOMS_CREATOR_COLUMN
|
||||
)
|
||||
|
||||
return batch_size
|
||||
|
||||
|
||||
class RoomStore(RoomBackgroundUpdateStore, RoomWorkerStore, SearchStore):
|
||||
def __init__(self, database: DatabasePool, db_conn, hs):
|
||||
|
|
@ -1350,7 +1416,9 @@ class RoomStore(RoomBackgroundUpdateStore, RoomWorkerStore, SearchStore):
|
|||
|
||||
self.config = hs.config
|
||||
|
||||
async def upsert_room_on_join(self, room_id: str, room_version: RoomVersion):
|
||||
async def upsert_room_on_join(
|
||||
self, room_id: str, room_version: RoomVersion, auth_events: List[EventBase]
|
||||
):
|
||||
"""Ensure that the room is stored in the table
|
||||
|
||||
Called when we join a room over federation, and overwrites any room version
|
||||
|
|
@ -1361,6 +1429,24 @@ class RoomStore(RoomBackgroundUpdateStore, RoomWorkerStore, SearchStore):
|
|||
# mark the room as having an auth chain cover index.
|
||||
has_auth_chain_index = await self.has_auth_chain_index(room_id)
|
||||
|
||||
create_event = None
|
||||
for e in auth_events:
|
||||
if (e.type, e.state_key) == (EventTypes.Create, ""):
|
||||
create_event = e
|
||||
break
|
||||
|
||||
if create_event is None:
|
||||
# If the state doesn't have a create event then the room is
|
||||
# invalid, and it would fail auth checks anyway.
|
||||
raise StoreError(400, "No create event in state")
|
||||
|
||||
room_creator = create_event.content.get(EventContentFields.ROOM_CREATOR)
|
||||
|
||||
if not isinstance(room_creator, str):
|
||||
# If the create event does not have a creator then the room is
|
||||
# invalid, and it would fail auth checks anyway.
|
||||
raise StoreError(400, "No creator defined on the create event")
|
||||
|
||||
await self.db_pool.simple_upsert(
|
||||
desc="upsert_room_on_join",
|
||||
table="rooms",
|
||||
|
|
@ -1368,7 +1454,7 @@ class RoomStore(RoomBackgroundUpdateStore, RoomWorkerStore, SearchStore):
|
|||
values={"room_version": room_version.identifier},
|
||||
insertion_values={
|
||||
"is_public": False,
|
||||
"creator": "",
|
||||
"creator": room_creator,
|
||||
"has_auth_chain_index": has_auth_chain_index,
|
||||
},
|
||||
# rooms has a unique constraint on room_id, so no need to lock when doing an
|
||||
|
|
@ -1396,6 +1482,9 @@ class RoomStore(RoomBackgroundUpdateStore, RoomWorkerStore, SearchStore):
|
|||
insertion_values={
|
||||
"room_version": room_version.identifier,
|
||||
"is_public": False,
|
||||
# We don't worry about setting the `creator` here because
|
||||
# we don't process any messages in a room while a user is
|
||||
# invited (only after the join).
|
||||
"creator": "",
|
||||
"has_auth_chain_index": has_auth_chain_index,
|
||||
},
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue