fix(utils): support record-level default schema values #431
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
|
|
|
|
samugi
force-pushed
the
fix/default-record-values
branch
2 times, most recently
from
f68d1af
to
e1234b7
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #431 +/- ##
==========================================
- Coverage 59.32% 57.92% -1.41%
==========================================
Files 69 69
Lines 4219 4223 +4
==========================================
- Hits 2503 2446 -57
- Misses 1134 1206 +72
+ Partials 582 571 -11
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
GGabriele
approved these changes
Mar 28, 2024
samugi
force-pushed
the
fix/default-record-values
branch
from
e1234b7
to
fa2ff62
Compare
pmalek
reviewed
Apr 3, 2024
Before this change, during the process of filling default configuration
values, if a record existed in the schema with a structure similar to the
following:
```
{
"default": {
"some_field": "record_level_default"
},
"fields": [
{
"some_field": {
"type": "string",
"default": "field_level_default"
}
}
]
}
```
the value `record_level_default` would be ignored and the field set to
the `field_level_default` value. Similarly, in case of no field-level
default, the field would be set to `null`.
This commit modifies the utils/fillConfigRecord logic to assign fields
with record-level default values when available.
Example of default configuration values that were previously ignored:
https://github.com/Kong/kong/blob/8fe14097a17cf904676672fc8cdaabe5e02e4a2d/kong/plugins/opentelemetry/schema.lua#L49
https://github.com/Kong/kong/blob/8fe14097a17cf904676672fc8cdaabe5e02e4a2d/kong/plugins/opentelemetry/schema.lua#L90
samugi
force-pushed
the
fix/default-record-values
branch
from
fa2ff62
to
e544d45
Compare
pmalek
approved these changes
Apr 3, 2024
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.
Before this change, during the process of filling default configuration values, if a record existed in the schema with a structure similar to the following:
the value
record_level_defaultwould be ignored and the field set to thefield_level_defaultvalue. Similarly, in case of no field-level default, the field would be set tonull.This commit modifies the utils/fillConfigRecord logic to assign fields with record-level default values when available.
Example of default configuration values that were previously ignored: https://github.com/Kong/kong/blob/8fe14097a17cf904676672fc8cdaabe5e02e4a2d/kong/plugins/opentelemetry/schema.lua#L49 https://github.com/Kong/kong/blob/8fe14097a17cf904676672fc8cdaabe5e02e4a2d/kong/plugins/opentelemetry/schema.lua#L90
fixes: KAG-4149