fix: Improved handling within ProviderRegistry #560
+256
−5
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
It is incorrect to call `ProviderRegister.set_provider` without a provider AND a domain. A validation check exists for the provider, but none for the domain. In this commit, we introduce that domain validation and introduce tests to capture this expected behavior. Signed-off-by: Matthew Keeler <mkeeler@launchdarkly.com>
If a provider is set for two different domains, it will only be initialized once. However, if a customer were to use a provider as both default and domain specific, it would incorrectly be initialized twice. Signed-off-by: Matthew Keeler <mkeeler@launchdarkly.com>
If a provider is set for two different domains, and then one of them is replaced, it will only be shutdown once. However, if a customer were to use a provider as both default and domain specific, replacing one or the other would incorrectly shutdown both usages. Signed-off-by: Matthew Keeler <mkeeler@launchdarkly.com>
Once a provider has been removed, there is no value in retaining a reference to it in the `_provider_status` dictionary. Instead of explicitly setting the status as `NOT_READY`, we can rely on this being the default status served from the `get_provider_status` method, allowing us to remove the dictionary entry entirely. Signed-off-by: Matthew Keeler <mkeeler@launchdarkly.com>
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #560 +/- ##
==========================================
- Coverage 97.83% 97.74% -0.10%
==========================================
Files 40 41 +1
Lines 1849 1993 +144
==========================================
+ Hits 1809 1948 +139
- Misses 40 45 +5
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
gruebel
reviewed
Jan 12, 2026
Member
gruebel
left a comment
gruebel
left a comment
There was a problem hiding this comment.
overall looks good, but as stated I'm not sure about the shutdown change
Comment on lines
+34
to
+35
| old_provider not in providers.values() | ||
| and old_provider != self._default_provider |
Member
There was a problem hiding this comment.
can you switch the statements, it is faster to check the second one, so if this is false there is not need to check all the providers.
| ): | ||
| self._shutdown_provider(old_provider) | ||
| if provider not in providers.values(): | ||
| if provider not in providers.values() and provider != self._default_provider: |
| if hasattr(provider, "shutdown"): | ||
| provider.shutdown() | ||
| self._provider_status[provider] = ProviderStatus.NOT_READY | ||
| del self._provider_status[provider] |
Member
There was a problem hiding this comment.
not sure about this change, https://openfeature.dev/specification/sections/providers#requirement-252 states
After a provider's shutdown function has terminated, the provider SHOULD revert to its uninitialized state.
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.
This PR
Introduces the following changes to the
ProviderRegistry.All of this functionality is in this single PR, but this can be split into individual PRs if desired. Each commit contains a singular bit of functionality or change, so reviewing individually might be easier.
Assuming we keep the PR as one, I have provided the changelog override necessary for release please.
BEGIN_COMMIT_OVERRIDE
refactor: Delete provider status instead of marking as NOT_READY
fix: Prevent providers from being shutdown multiple times
fix: Prevent providers from being initialized multiple times
fix: Validate domain is present when calling
set_provideron registryEND_COMMIT_OVERRIDE