-
Notifications
You must be signed in to change notification settings - Fork 882
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Refactor dynamic config Client and Collection #3271
Merged
Merged
Conversation
This file contains 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
yiminc
reviewed
Aug 26, 2022
yiminc
approved these changes
Aug 27, 2022
Comment on lines
-41
to
-56
// dynamic config for tests | ||
testGetPropertyKey = "testGetPropertyKey" | ||
testCaseInsensitivePropertyKey = "testCaseInsensitivePropertyKey" | ||
testGetIntPropertyKey = "testGetIntPropertyKey" | ||
testGetFloat64PropertyKey = "testGetFloat64PropertyKey" | ||
testGetDurationPropertyKey = "testGetDurationPropertyKey" | ||
testGetBoolPropertyKey = "testGetBoolPropertyKey" | ||
testGetStringPropertyKey = "testGetStringPropertyKey" | ||
testGetMapPropertyKey = "testGetMapPropertyKey" | ||
testGetIntPropertyFilteredByNamespaceKey = "testGetIntPropertyFilteredByNamespaceKey" | ||
testGetDurationPropertyFilteredByNamespaceKey = "testGetDurationPropertyFilteredByNamespaceKey" | ||
testGetIntPropertyFilteredByTaskQueueInfoKey = "testGetIntPropertyFilteredByTaskQueueInfoKey" | ||
testGetDurationPropertyFilteredByTaskQueueInfoKey = "testGetDurationPropertyFilteredByTaskQueueInfoKey" | ||
testGetDurationPropertyStructuredDefaults = "testGetDurationPropertyStructuredDefaults" | ||
testGetBoolPropertyFilteredByNamespaceIDKey = "testGetBoolPropertyFilteredByNamespaceIDKey" | ||
testGetBoolPropertyFilteredByTaskQueueInfoKey = "testGetBoolPropertyFilteredByTaskQueueInfoKey" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
After seeing what the changes look like in other repos, and more discussion, changing the interface name back to Client to avoid unnecessary source level churn |
dnr
changed the title
Change dynamic config Client to Source
Refactor dynamic config Client and Collection
Aug 30, 2022
yiminc
approved these changes
Aug 31, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What and why?
This is a large refactor of dynamic config. Conceptually think about like this:
At the top, the
Collection
interface is what's used by the server. That doesn't change at all.Below that,
Collection
was implemented in terms ofClient
.Client
mixed two concerns: getting values from an external source, and filtering constrained value sets. In practice, this had a few problems:Collection
only uses a few types of sets.The fix is to change
Client
to a lower-level interface, which is only responsible for getting values from a source.Collection
is reimplemented on top of the newClient
, with the filtering and type conversion logic consolidated, which greatly simplifies it.The new
Client
interface returns constrained values, but with a more type-friendly and allocation-friendly style: constraints are represented as a plain struct, and can be compared easily. (Note that we can still add new constraint types without breaking source-compatibility, though alternative implementations will need to be changed to support those new constraints.)The file based client is compatible with existing dynamic config yaml files: more logic to convert the yaml structure to the new constrained value structure was added to
fileBasedClient
.Benchmark results:
before:
after:
How did you test it?
converted unit tests to use new interfaces, existing integration tests
Potential risks
it's a big rewrite, there could be new bugs