Move oidc.load_metadata() startup into _base.start()
#19056
Draft
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 13, 2025
Comment on lines
+628
to
+636
| # Load the OIDC provider metadatas, if OIDC is enabled. | ||
| if hs.config.oidc.oidc_enabled: | ||
| oidc = hs.get_oidc_handler() | ||
| # Loading the provider metadata also ensures the provider config is valid. | ||
| # | ||
| # FIXME: It feels a bit strange to validate and block on startup as one of these | ||
| # OIDC providers could be temporarily unavailable and cause Synapse to be unable | ||
| # to start. | ||
| await oidc.load_metadata() |
There was a problem hiding this comment.
Previously, this lived in synapse/app/homeserver.py -> setup() which is only for the SynapseHomeServer (main Synapse instance).
This has now moved to _base.start() which means it will run on workers and the main Synapse instance.
I can't really tell if this should be only be run on the main instance or not. Kinda feels like we should validate the provider config on any Synapse instance. This will cause every instance to contact the providers to fetch the metadata.
MadLittleMods
commented
Oct 13, 2025
| handle_startup_exception(e) | ||
|
|
||
| async def _start_when_reactor_running() -> None: | ||
| # TODO: Feels like this should be moved somewhere else. |
There was a problem hiding this comment.
It's possible that the correct conclusion is that this belongs only on the main Synapse instance (see #19056 (comment)). In that case, this PR should just remove this TODO with some context on why.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Move
oidc.load_metadata()startup into_base.start().Dev notes
oidc.load_metadata()introduced in matrix-org/synapse#7256Pull Request Checklist
EventStoretoEventWorkerStore.".code blocks.