config: Use reflection #1480
Open
config: Use reflection #1480
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
Our previous approach of playing whack-a-mole did not seem to work very well. This just replaces everything via reflection, with two notable exceptions: 1. Some top-level fields in Configuration are meta-fields and not meant to be replaced by anything. 2. Since subpackages support Range, we need to expand them before calling replace() on them. This approach won't scale very well if we add sub-fields to structs that shouldn't support string replacement or if we add top-level fields to Configuration that need replacement (we will need to update this code). One approach for dealing with both of these things would be to use struct tags to explicitly mark fields as non-replaceable and handle these exceptions in the reflection code by just skipping over them. That's more complicated than I intend for this change, so I'm going to punt on that for now, but we should consider it if this new code doesn't hold up to the test of time. Signed-off-by: Jon Johnson <[email protected]>
Yeah, I think if we want to go the recursive reflection route, we'll need the struct tag piece sooner or later. |
luhring
reviewed
Sep 6, 2024
| ) | ||
|
|
||
| // replace takes the given T and recursively walks it, replacing any strings it encounters inside structs, maps, slices, etc with the given replacer. | ||
| func replace[T any](r *strings.Replacer, in T) T { |
There was a problem hiding this comment.
A test focused on this function would be nifty
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.
Our previous approach of playing whack-a-mole did not seem to work very well. This just replaces everything via reflection, with two notable exceptions:
This approach won't scale very well if we add sub-fields to structs that shouldn't support string replacement or if we add top-level fields to Configuration that need replacement (we will need to update this code).
One approach for dealing with both of these things would be to use struct tags to explicitly mark fields as non-replaceable and handle these exceptions in the reflection code by just skipping over them. That's more complicated than I intend for this change, so I'm going to punt on that for now, but we should consider it if this new code doesn't hold up to the test of time.