fix: Allow better comment handling in XrayTracingTemplateModifier #4940
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
mndeveci
reviewed
Mar 29, 2023
Comment on lines
13
to
15
| import ruamel.yaml | ||
| from ruamel.yaml import YAML | ||
| from ruamel.yaml.comments import CommentedMap |
There was a problem hiding this comment.
- I like that you put imports under class so that they won't be loaded once the module is imported. But this module has only this class, which means this will be imported whenever the class is used. Should we move the imports to the top into others?
- Line 13 imports entire
ruamel.yamlbut then next lines imports individual elements fromruamel.yamlagain. Shouldn't we use one way or the other (either import everything or import only used stuff one by one)?
There was a problem hiding this comment.
I just copied what was done in the application insights template modifier. I assumed it was done for a reason that way.
I moved the imports to the beginning of the file and updated references.
hnnasit
approved these changes
Mar 29, 2023
| if self.template.get(self.GLOBALS): | ||
| template_globals = self.template.get(self.GLOBALS) | ||
|
|
||
| function_gloabls = template_globals.get(self.FUNCTION, {}) |
There was a problem hiding this comment.
nit: typo in variable name
There was a problem hiding this comment.
Thanks. Updated in the latest revision
hawflau
approved these changes
Mar 29, 2023
mndeveci
approved these changes
Mar 29, 2023
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.
Which issue(s) does this change fix?
#4860
Why is this change necessary?
Fixes a bug in which the XrayTracingTemplateModifier was duplicating Globals.
How does it address the issue?
Reworks the XrayTracingTemplateModifier to be closer to the ApplicationInsights in using ruamel to parse and keep comments.
What side effects does this change have?
None. But I did remove unnecessary code and tests that we no longer needed.
Mandatory Checklist
PRs will only be reviewed after checklist is complete
make prpassesmake update-reproducible-reqsif dependencies were changedBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.