aucoalesce - Fix yaml.v3 upgrade issues #170
Open
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
andrewkroh
added a commit
to andrewkroh/beats
that referenced
this pull request
Nov 8, 2024
andrewkroh
changed the title
andrewkroh
added a commit
to andrewkroh/beats
that referenced
this pull request
Nov 8, 2024
andrewkroh
added a commit
to andrewkroh/beats
that referenced
this pull request
Nov 8, 2024
This test passes under v2.5.0, but fails under v2.6.0.
The yaml.Unmarshaler interface changed between yaml.v2 and yaml.v3. But our implementations were not updated during the upgrade process. This adds compile time checks to ensure that yaml.Unmarshaler is implemented.
Under yaml.v3 the anchors with objects do not perform a deep merge. https://yaml.org/type/merge.html > Keys in mapping nodes earlier in the sequence override keys specified in later mapping nodes. Given the following, it was previously expected that the second entry would merge to create {object: {primary: foo, secondary: bar}}, but that does not happen under v3. - &my_macro object: primary: foo - <<: *my_macro object: secondary: bar To address this, instead of using objects this change flattens the structure The changes to normalizations.yaml were aided by https://gist.github.com/andrewkroh/e7212a1ff033a0227f7c8d3fa7df8973.
Ensure that all fields in normalizition.yaml are defined in a struct to avoid typos.
andrewkroh
force-pushed
the
bugfix/normalizations-yaml-v3
branch
from
1f9d4d9
to
52e8126
Compare
💚 Build Succeeded
History |
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.
This PR addresses #169 to fix bugs introduced during the upgrade from
yaml.v2toyaml.v3.Add failing test case: A test case has been added to highlight a regression where a test passes under
yaml.v2but fails underyaml.v3.Update
yaml.v3Unmarshaler implementation: Theyaml.Unmarshalerinterface changed betweenyaml.v2andyaml.v3, but the implementation was not updated accordingly. This commit ensures that theyaml.Unmarshalerinterface is correctly implemented and adds compile-time checks to ensure proper interface adherence.Flatten keys in
normalizations.yamlto avoid deep merge issues: Underyaml.v3, anchors with objects do not perform a deep merge as expected in previous versions. To address this, the structure innormalizations.yamlhas been flattened, replacing the object-based merging with a flatter structure. This ensures the expected behavior where keys in later nodes override keys from earlier ones. The flattening ofnormalizations.yamlwas aided by https://gist.github.com/andrewkroh/e7212a1ff033a0227f7c8d3fa7df8973 (white space changes were manually reverted).Enable strict YAML decoding: This change enforces strict decoding of
normalizations.yamlto ensure all fields are explicitly defined in the corresponding struct. This helps catch potential typos or undefined fields.