Introduce update_user_directory_on

changelog.d/11450.feature

@@ -0,0 +1 @@
+Introduce `worker_to_update_user_directory` config variable.

docker/configure_workers_and_start.py

@@ -50,7 +50,7 @@
         "endpoint_patterns": [
             "^/_matrix/client/(api/v1|r0|v3|unstable)/user_directory/search$"
         ],
-        "shared_extra_conf": {"update_user_directory": False},
+        "shared_extra_conf": {"worker_to_update_user_directory": "user_dir"},
         "worker_extra_conf": "",
     },
     "media_repository": {

docs/sample_config.yaml

@@ -142,6 +142,14 @@ presence:
 #
 #limit_profile_requests_to_users_who_share_rooms: true
 
+# User Directory Updates
+#
+# If specified, a worker with that name will be the only one able to update
+# the user directory. Important for querying shared rooms. If the worker is
+# specified, but not running, the user directory may become outdated.
+# Defaults to null, meaning the main process will handle this.
+#worker_to_update_user_directory: null
+
 # Uncomment to prevent a user's profile data from being retrieved and
 # displayed in a room until they have joined it. By default, a user's
 # profile data is included in an invite event, regardless of the values

docs/workers.md

@@ -374,7 +374,7 @@ the shared configuration would include:
 run_background_tasks_on: background_worker
 ```
 
-You might also wish to investigate the `update_user_directory` and
+You might also wish to investigate the `worker_to_update_user_directory` and
 `media_instance_running_background_jobs` settings.
 
 ### `synapse.app.pusher`
@@ -467,9 +467,10 @@ the following regular expressions:
 
     ^/_matrix/client/(api/v1|r0|v3|unstable)/user_directory/search$
 
-When using this worker you must also set `update_user_directory: False` in the
-shared configuration file to stop the main synapse running background
-jobs related to updating the user directory.
+When using this worker you must also set `worker_to_update_user_directory` in the
+shared configuration file to the user directory worker's name to stop the main 
+synapse running background jobs related to updating the user directory, and give
+the user directory worker the exclusive right to update it instead.
 
 ### `synapse.app.frontend_proxy`
 

synapse/app/admin_cmd.py

@@ -211,7 +211,7 @@ def start(config_options: List[str]) -> None:
         config.logging.no_redirect_stdio = True
 
     # Explicitly disable background processes
-    config.server.update_user_directory = False
+    config.server.worker_to_update_user_directory = ""
     config.worker.run_background_tasks = False
     config.worker.start_pushers = False
     config.worker.pusher_shard_config.instances = []

synapse/app/generic_worker.py

@@ -458,21 +458,16 @@ def start(config_options: List[str]) -> None:
         config.appservice.notify_appservices = False
 
     if config.worker.worker_app == "synapse.app.user_dir":
-        if config.server.update_user_directory:
+        if config.worker.worker_name != config.server.worker_to_update_user_directory:
             sys.stderr.write(
-                "\nThe update_user_directory must be disabled in the main synapse process"
-                "\nbefore they can be run in a separate worker."
-                "\nPlease add ``update_user_directory: false`` to the main config"
-                "\n"
+                "\nThe worker_to_update_user_directory config variable must point to this worker's name"
+                "\nto give this worker exclusive access to run it. (It is currently pointed at "
+                f"{config.server.worker_to_update_user_directory!r})"
+                "\nPlease add or edit "
+                f'``worker_to_update_user_directory: "{config.worker.worker_name}"`` in the main config\n'
             )
             sys.exit(1)
 
-        # Force the pushers to start since they will be disabled in the main config
-        config.server.update_user_directory = True
-    else:
-        # For other worker types we force this to off.
-        config.server.update_user_directory = False
-
     synapse.events.USE_FROZEN_DICTS = config.server.use_frozen_dicts
     synapse.util.caches.TRACK_MEMORY_USAGE = config.caches.track_memory_usage
 

synapse/config/server.py

@@ -321,9 +321,11 @@ def read_config(self, config, **kwargs):
                 self.presence_router_config,
             ) = load_module(presence_router_config, ("presence", "presence_router"))
 
-        # Whether to update the user directory or not. This should be set to
-        # false only if we are updating the user directory in a worker
-        self.update_user_directory = config.get("update_user_directory", True)
+        # Which worker is responsible for updating the user directory,
+        # None means the main process handles this.
+        self.worker_to_update_user_directory = config.get(
+            "worker_to_update_user_directory", None
+        )
 
         # whether to enable the media repository endpoints. This should be set
         # to false if the media repository is running as a separate endpoint;
@@ -859,6 +861,14 @@ def generate_config_section(
         #
         #limit_profile_requests_to_users_who_share_rooms: true
 
+        # User Directory Updates
+        #
+        # If specified, a worker with that name will be the only one able to update
+        # the user directory. Important for querying shared rooms. If the worker is
+        # specified, but not running, the user directory may become outdated.
+        # Defaults to null, meaning the main process will handle this.
+        #worker_to_update_user_directory: null
+
         # Uncomment to prevent a user's profile data from being retrieved and
         # displayed in a room until they have joined it. By default, a user's
         # profile data is included in an invite event, regardless of the values

synapse/handlers/user_directory.py

@@ -60,7 +60,7 @@ def __init__(self, hs: "HomeServer"):
         self.clock = hs.get_clock()
         self.notifier = hs.get_notifier()
         self.is_mine_id = hs.is_mine_id
-        self.update_user_directory = hs.config.server.update_user_directory
+        self.update_user_directory = hs.should_update_user_directory()
         self.search_all_users = hs.config.userdirectory.user_directory_search_all_users
         self.spam_checker = hs.get_spam_checker()
         # The current position in the current_state_delta stream

synapse/rest/client/shared_rooms.py

@@ -42,19 +42,11 @@ def __init__(self, hs: "HomeServer"):
         super().__init__()
         self.auth = hs.get_auth()
         self.store = hs.get_datastore()
-        self.user_directory_active = hs.config.server.update_user_directory
 
     async def on_GET(
         self, request: SynapseRequest, user_id: str
     ) -> Tuple[int, JsonDict]:
 
-        if not self.user_directory_active:
-            raise SynapseError(
-                code=400,
-                msg="The user directory is disabled on this server. Cannot determine shared rooms.",
-                errcode=Codes.FORBIDDEN,
-            )
-
         UserID.from_string(user_id)
 
         requester = await self.auth.get_user_by_req(request)

synapse/server.py

@@ -834,6 +834,16 @@ def should_send_federation(self) -> bool:
         "Should this server be sending federation traffic directly?"
         return self.config.worker.send_federation
 
+    def should_update_user_directory(self) -> bool:
+        "Should this process be updating the user directory?"
+        if self.config.worker.worker_app is None:  # we're the main process
+            return self.config.server.worker_to_update_user_directory is None
+        else:
+            return (
+                self.config.server.worker_to_update_user_directory
+                == self.config.worker.worker_name
+            )
+
     @cache_in_self
     def get_request_ratelimiter(self) -> RequestRatelimiter:
         return RequestRatelimiter(

tests/handlers/test_user_directory.py

@@ -56,7 +56,7 @@ class UserDirectoryTestCase(unittest.HomeserverTestCase):
 
     def make_homeserver(self, reactor: MemoryReactor, clock: Clock) -> HomeServer:
         config = self.default_config()
-        config["update_user_directory"] = True
+        config["worker_to_update_user_directory"] = None
 
         self.appservice = ApplicationService(
             token="i_am_an_app_service",
@@ -1014,7 +1014,7 @@ class TestUserDirSearchDisabled(unittest.HomeserverTestCase):
 
     def make_homeserver(self, reactor: MemoryReactor, clock: Clock) -> HomeServer:
         config = self.default_config()
-        config["update_user_directory"] = True
+        config["worker_to_update_user_directory"] = None
         hs = self.setup_test_homeserver(config=config)
 
         self.config = hs.config

tests/rest/client/test_shared_rooms.py

@@ -32,7 +32,7 @@ class UserSharedRoomsTest(unittest.HomeserverTestCase):
 
     def make_homeserver(self, reactor, clock):
         config = self.default_config()
-        config["update_user_directory"] = True
+        config["worker_to_update_user_directory"] = None
         return self.setup_test_homeserver(config=config)
 
     def prepare(self, reactor, clock, hs):

tests/utils.py

@@ -169,7 +169,7 @@ def default_config(name, parse=False):
         "default_room_version": DEFAULT_ROOM_VERSION,
         # disable user directory updates, because they get done in the
         # background, which upsets the test runner.
-        "update_user_directory": False,
+        "worker_to_update_user_directory": "B. F. Bugleberry",
         "caches": {"global_factor": 1},
         "listeners": [{"port": 0, "type": "http"}],
     }