fix: correctly ingest entity defaults with maps values #244
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
The current implementation of the `fillConfigRecord` function works as follows: - navigate the entity structure - for each field, check whether it's set or not - if it's already set, move onto the next field - if it's not set, check the entity schema and set a default if that's defined This works well in most cases, except for plugins fields being maps. For such fields, this simple check may not be enough since the field may be composed of several sub-fields possibly having their own default values. This means that moving onto the next field when the current map field is set may results into its inner sub-fields not being set with default values. In decK, where this function is heavily used, this issue results in misleading deployment diffs. This commit expands the check logic to also verify that all default values are set, even those of maps fields.
pmalek
approved these changes
Dec 7, 2022
|
Thanks for the nice description on this one! 🙇 |
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.
The current implementation of the
fillConfigRecordfunction works as follows:This works well in most cases, except for plugins fields being maps. For such fields, this simple check may not be enough since the field may be composed of several sub-fields possibly having their own default values. This means that moving onto the next field when the current map field is set may results into its inner sub-fields not being set with default values.
In decK, where this function is heavily used, this issue results in misleading deployment diffs.
This commit expands the check logic to also verify that all default values are set, even those of maps fields.