Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Commit

Permalink
Fix error message when app_service_config_files validation fails (#…
Browse files Browse the repository at this point in the history
…15614)

The second argument of `ConfigError` is a path, passed as an optional
`Iterable[str]` and not a `str`. If a string is passed directly,
Synapse unhelpfully emits "Error in configuration at
a.p.p._.s.e.r.v.i.c.e._.c.o.n.f.i.g._.f.i.l.e.s'" when the config
option has the wrong data type.

Signed-off-by: Sean Quah <seanq@matrix.org>
  • Loading branch information
squahtx committed May 18, 2023
1 parent 41b9def commit e15aa00
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
1 change: 1 addition & 0 deletions changelog.d/15614.bugfix
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix a bug introduced in Synapse 1.82.0 where the error message displayed when validation of the `app_service_config_files` config option fails would be incorrectly formatted.
3 changes: 1 addition & 2 deletions synapse/config/appservice.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,10 @@ def read_config(self, config: JsonDict, **kwargs: Any) -> None:
if not isinstance(self.app_service_config_files, list) or not all(
type(x) is str for x in self.app_service_config_files
):
# type-ignore: this function gets arbitrary json value; we do use this path.
raise ConfigError(
"Expected '%s' to be a list of AS config files:"
% (self.app_service_config_files),
"app_service_config_files",
("app_service_config_files",),
)

self.track_appservice_user_ips = config.get("track_appservice_user_ips", False)
Expand Down

0 comments on commit e15aa00

Please sign in to comment.