Move specific Synapse config out of RootConfig

changelog.d/18410.misc

@@ -0,0 +1 @@
+Move specific Synapse config out of `RootConfig`.

synapse/config/_base.py

@@ -101,28 +101,6 @@
         parent_e = parent_e.__cause__
 
 
-# We split these messages out to allow packages to override with package
-# specific instructions.
-MISSING_REPORT_STATS_CONFIG_INSTRUCTIONS = """\
-Please opt in or out of reporting homeserver usage statistics, by setting
-the `report_stats` key in your config file to either True or False.
-"""
-
-MISSING_REPORT_STATS_SPIEL = """\
-We would really appreciate it if you could help our project out by reporting
-homeserver usage statistics from your homeserver. Your homeserver's server name,
-along with very basic aggregate data (e.g. number of users) will be reported. But
-it helps us to track the growth of the Matrix community, and helps us to make Matrix
-a success, as well as to convince other networks that they should peer with us.
-
-Thank you.
-"""
-
-MISSING_SERVER_NAME = """\
-Missing mandatory `server_name` config option.
-"""
-
-
 CONFIG_FILE_HEADER = """\
 # Configuration file for Synapse.
 #
@@ -774,7 +752,7 @@
             if config_args.report_stats is None:
                 parser.error(
                     "Please specify either --report-stats=yes or --report-stats=no\n\n"
                     + MISSING_REPORT_STATS_SPIEL
                 )
 
             (config_path,) = config_files
@@ -929,13 +907,6 @@
 
         specified_config.update(yaml_config)
 
-    if "server_name" not in specified_config:
-        raise ConfigError(MISSING_SERVER_NAME)
-
-    if "report_stats" not in specified_config:
-        raise ConfigError(
-            MISSING_REPORT_STATS_CONFIG_INSTRUCTIONS + "\n" + MISSING_REPORT_STATS_SPIEL
-        )
     return specified_config
 
 

synapse/config/metrics.py

@@ -29,6 +29,21 @@
 
 from ._base import Config, ConfigError
 
+MISSING_REPORT_STATS_CONFIG_INSTRUCTIONS = """\
+Please opt in or out of reporting homeserver usage statistics, by setting
+the `report_stats` key in your config file to either True or False.
+"""
+
+MISSING_REPORT_STATS_SPIEL = """\
+We would really appreciate it if you could help our project out by reporting
+homeserver usage statistics from your homeserver. Your homeserver's server name,
+along with very basic aggregate data (e.g. number of users) will be reported. But
+it helps us to track the growth of the Matrix community, and helps us to make Matrix
+a success, as well as to convince other networks that they should peer with us.
+
+Thank you.
+"""
+
 
 @attr.s
 class MetricsFlags:
@@ -50,7 +65,17 @@ class MetricsConfig(Config):
     def read_config(self, config: JsonDict, **kwargs: Any) -> None:
         self.enable_metrics = config.get("enable_metrics", False)
 
-        self.report_stats = config.get("report_stats", None)
+        report_stats = config.get("report_stats", None)
+
+        if report_stats is None:
+            raise ConfigError(
+                MISSING_REPORT_STATS_CONFIG_INSTRUCTIONS
+                + "\n"
+                + MISSING_REPORT_STATS_SPIEL,
+                ("report_stats",),
+            )
+
+        self.report_stats = report_stats
         self.report_stats_endpoint = config.get(
             "report_stats_endpoint", "https://matrix.org/report-usage-stats/push"
         )

synapse/config/server.py

@@ -49,6 +49,11 @@
 Please see https://element-hq.github.io/synapse/latest/upgrade.html#direct-tcp-replication-is-no-longer-supported-migrate-to-redis
 """
 
+
+MISSING_SERVER_NAME = """\
+Missing mandatory `server_name` config option.
+"""
+
 # by default, we attempt to listen on both '::' *and* '0.0.0.0' because some OSes
 # (Windows, macOS, other BSD/Linux where net.ipv6.bindv6only is set) will only listen
 # on IPv6 when '::' is set.
@@ -295,9 +300,14 @@ class ServerConfig(Config):
     section = "server"
 
     def read_config(self, config: JsonDict, **kwargs: Any) -> None:
-        self.server_name = config["server_name"]
         self.server_context = config.get("server_context", None)
 
+        server_name = config.get("server_name")
+        if server_name is None:
+            raise ConfigError(MISSING_SERVER_NAME, ("server_name",))
+
+        self.server_name = server_name
+
         try:
             parse_and_validate_server_name(self.server_name)
         except ValueError as e: