Introduce update_user_directory_on

synapse/app/generic_worker.py

@@ -126,6 +126,11 @@
 
 logger = logging.getLogger("synapse.app.generic_worker")
 
+DIRECTORY_UPDATE_WARNING = """
+The user directory worker is not allowed to perform user directory updates per the config.
+Please add or edit ``update_user_directory_on: "{0}"`` in the config'
+"""
+
 
 class KeyUploadServlet(RestServlet):
     """An implementation of the `KeyUploadServlet` that responds to read only
@@ -459,12 +464,7 @@ def start(config_options: List[str]) -> None:
 
     if config.worker.worker_app == "synapse.app.user_dir":
         if not config.worker.update_user_directory:
-            sys.stderr.write(
-                "\nThe user directory worker is not allowed to perform user directory updates per the config."
-                "\nPlease add or edit "
-                f'``update_user_directory_on: "{config.worker.worker_name}"`` in the config\n'
-            )
-            sys.exit(1)
+            logger.warning(DIRECTORY_UPDATE_WARNING.format(config.worker.worker_name))
 
     synapse.events.USE_FROZEN_DICTS = config.server.use_frozen_dicts
     synapse.util.caches.TRACK_MEMORY_USAGE = config.caches.track_memory_usage

synapse/config/workers.py

@@ -15,7 +15,7 @@
 
 import argparse
 import logging
-from typing import List, Optional, Union
+from typing import List, Union
 
 import attr
 
@@ -44,10 +44,9 @@
 """
 
 USER_UPDATE_DIRECTORY_DEPRECATION_WARNING = """
-Synapse now uses 'update_user_directory_on' over 'update_user_directory',
-you have set 'update_user_directory', and while synapse will work in a backwards
-compatible manner, it is suggested to change this value to use
-'update_user_directory_on' instead.
+The 'update_user_directory' configuration setting is now deprecated,
+and replaced with 'update_user_directory_on'.  See the sample configuration
+file for details of 'update_user_directory_on'.
 """
 
 
@@ -302,46 +301,36 @@ def read_config(self, config, **kwargs):
         # No effort is made to ensure only a single instance of these tasks is
         # running.
         background_tasks_instance = config.get("run_background_tasks_on") or "master"
-        self.run_background_tasks = (
-            self.worker_name is None and background_tasks_instance == "master"
-        ) or self.worker_name == background_tasks_instance
+        self.run_background_tasks = self.instance_name == background_tasks_instance
 
         # update_user_directory_on controls which worker is responsible for updating the user directory.
-        # None means that the main process should handle this, so does the absence of the config key.
+        # None means that the main process should handle this, as does the absence of the config key.
         #
         # Note that due to backwards compatibility, we must also test for update_user_directory, and apply it if
         # update_user_directory_on is not defined at the same time.
-        self.update_user_directory: bool
 
-        uud_result: bool
-        is_master_process = self.worker_name is None
+        if "update_user_directory" in config:
+            # Backwards compatibility case
+            logger.warning(USER_UPDATE_DIRECTORY_DEPRECATION_WARNING)
 
-        if "update_user_directory_on" in config:
-            update_user_directory_on: Optional[str] = config["update_user_directory_on"]
-
-            if update_user_directory_on is None:
-                uud_result = is_master_process
+            if config["update_user_directory"]:
+                # Main process should update
+                update_user_directory_on = "master"
             else:
-                uud_result = self.worker_name == update_user_directory_on
-
+                # user directory worker should update
+                update_user_directory_on = (
+                    self.instance_name
+                    if self.worker_app == "synapse.app.user_dir"
+                    else ""
+                )
         else:
-            if "update_user_directory" in config:
-                # Backwards compatibility case
-                logger.warning(USER_UPDATE_DIRECTORY_DEPRECATION_WARNING)
-
-                update_user_directory: bool = config["update_user_directory"]
-
-                if update_user_directory:
-                    # Main process should update
-                    uud_result = is_master_process
-                else:
-                    # user directory worker should update
-                    uud_result = self.worker_app == "synapse.app.user_dir"
-            else:
-                # Both values are undefined, assume None for update_user_directory_on
-                uud_result = is_master_process
+            update_user_directory_on = (
+                config.get("update_user_directory_on") or "master"
+            )
 
-        self.update_user_directory = uud_result
+        self.update_user_directory: bool = (
+            self.instance_name == update_user_directory_on
+        )
 
     def generate_config_section(self, config_dir_path, server_name, **kwargs):
         return """\

tests/handlers/test_user_directory.py

@@ -56,6 +56,7 @@ class UserDirectoryTestCase(unittest.HomeserverTestCase):
 
     def make_homeserver(self, reactor: MemoryReactor, clock: Clock) -> HomeServer:
         config = self.default_config()
+        # Always process user directory updates on this main homeserver process.
         config["update_user_directory_on"] = None
 
         self.appservice = ApplicationService(

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_on": "",
+        "update_user_directory_on": "(non-existent worker)",
         "caches": {"global_factor": 1},
         "listeners": [{"port": 0, "type": "http"}],
     }