Skip to content
Snippets Groups Projects
Unverified Commit a64c2992 authored by Andrew Morgan's avatar Andrew Morgan Committed by GitHub
Browse files

Pass a dict, instead of None, to modules if a None config is specified in the...

Pass a dict, instead of None, to modules if a None config is specified in the homeserver config (#9229)

If a Synapse module's config block were empty in YAML, thus being translated to a `Nonetype` in Python, then some modules could fail as that None ends up getting passed to their `parse_config` method. Modules are expected to accept a `dict` instead.

This PR ensures that if the user does end up specifying an empty config block (such as what [the default oidc config in the sample config](https://github.com/matrix-org/synapse/blob/5310808d3bebd17275355ecd474bc013e8c7462d/docs/sample_config.yaml#L1816-L1845) states) then `None` is not passed to the module. An empty dict is passed instead.

This code assumes that no existing modules are relying on receiving a `None` config block, but I'd really hope that they aren't.
parent 1baab203
No related branches found
No related tags found
No related merge requests found
Fix a bug where `None` was passed to Synapse modules instead of an empty dictionary if an empty module `config` block was provided in the homeserver config.
\ No newline at end of file
...@@ -49,7 +49,8 @@ def load_module(provider: dict, config_path: Iterable[str]) -> Tuple[Type, Any]: ...@@ -49,7 +49,8 @@ def load_module(provider: dict, config_path: Iterable[str]) -> Tuple[Type, Any]:
module = importlib.import_module(module) module = importlib.import_module(module)
provider_class = getattr(module, clz) provider_class = getattr(module, clz)
module_config = provider.get("config") # Load the module config. If None, pass an empty dictionary instead
module_config = provider.get("config") or {}
try: try:
provider_config = provider_class.parse_config(module_config) provider_config = provider_class.parse_config(module_config)
except jsonschema.ValidationError as e: except jsonschema.ValidationError as e:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment