Introduce RootConfig.validate_config() which can be subclassed in HomeServerConfig to do cross-config class validation
#19027
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MadLittleMods
commented
Oct 7, 2025
MadLittleMods
commented
Oct 8, 2025
| obj.invoke_all("read_arguments", config_args) | ||
|
|
||
| return obj | ||
| return cls.load_config(description, argv_options) |
There was a problem hiding this comment.
This change makes it so we go through the normal load_config(...) code path instead of inventing yet another way to load config.
It also means we can settle on calling validate_config(...) in one place as everything flows to load_config_with_parser(...) now.
MadLittleMods
commented
Oct 8, 2025
MadLittleMods
commented
Oct 8, 2025
MadLittleMods
commented
Oct 8, 2025
MadLittleMods
commented
Oct 8, 2025
| "spam and abuse. If you would like to allow public registration, please consider adding email, " | ||
| "captcha, or token-based verification. Otherwise this check can be removed by setting the " | ||
| "`enable_registration_without_verification` config option to `true`." | ||
| ) |
There was a problem hiding this comment.
The only real change is that this has moved from a place that only runs for the main Synapse instance to everything including workers.
But I assume that's fine. We want the same warning for workers as we wouldn't want open registration there either.
MadLittleMods
changed the title
setup to load_or_generate_configRootConfig.validate_config() which can be subclassed in HomeServerConfig to do cross-config class validation
anoadragon453
approved these changes
Oct 9, 2025
Co-authored-by: Andrew Morgan <[email protected]>
…github.com:element-hq/synapse into madlittlemods/relocate-snowflake-config-validation
…alidation Conflicts: synapse/app/homeserver.py tests/config/test_registration_config.py
MadLittleMods
deleted the
madlittlemods/relocate-snowflake-config-validation
branch
|
Thanks for the review @anoadragon453 🦋 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduce
RootConfig.validate_config()which can be subclassed inHomeServerConfigto do cross-config class validation. This means we can move the open registration config validation fromsetup()toHomeServerConfig.validate_config()(much more sane).Spawning from looking at this area of code in #19015
Dev notes
Open registration validation introduced in matrix-org/synapse#12091
Pull Request Checklist
EventStoretoEventWorkerStore.".code blocks.