Schedule a user directory rebuild

1 files changed, 40 insertions, 0 deletions

diff --git a/synapse/storage/schema/main/delta/74/02_user_directory_rebuild.sql b/synapse/storage/schema/main/delta/74/02_user_directory_rebuild.sql
new file mode 100644
index 0000000000..8c6da8219b
--- /dev/null
+++ b/synapse/storage/schema/main/delta/74/02_user_directory_rebuild.sql
@@ -0,0 +1,40 @@
+/* Copyright 2023 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.
+ */
+
+-- Rebuild the user directory in light of the fix for leaking the per-room
+-- profiles of remote users to the user directory.
+
+-- First cancel any existing rebuilds if already pending; we'll run from fresh.
+DELETE FROM background_updates WHERE update_name IN (
+    'populate_user_directory_createtables',
+    'populate_user_directory_process_rooms',
+    'populate_user_directory_process_users',
+    'populate_user_directory_process_remote_users',
+    'populate_user_directory_cleanup'
+);
+
+-- Then schedule the steps.
+INSERT INTO background_updates (ordering, update_name, progress_json, depends_on) VALUES
+  -- Set up user directory staging tables.
+  (7402, 'populate_user_directory_createtables', '{}', NULL),
+  -- Run through each room and update the user directory according to who is in it.
+  (7402, 'populate_user_directory_process_rooms', '{}', 'populate_user_directory_createtables'),
+  -- Insert all users into the user directory, if search_all_users is on.
+  (7402, 'populate_user_directory_process_users', '{}', 'populate_user_directory_process_rooms'),
+  -- Insert remote users into the queue for fetching.
+  (7402, 'populate_user_directory_process_remote_users', '{}', 'populate_user_directory_process_users'),
+  -- Clean up user directory staging tables.
+  (7402, 'populate_user_directory_cleanup', '{}', 'populate_user_directory_process_remote_users')
+ON CONFLICT (update_name) DO NOTHING;