fix: don't overwrite fields set to empty arrays when default exists #374
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
This commit fixes a bug preventing users to set fields to emtpy
arrays when a default for those fields exist. For example, imagine
we have an `openid-connect` plugin configured via the UI having
the `login_tokens` set to an empty array (note: this field has
a default value of `["id_token"]`:
```
$ http :8001/plugins/$id | jq .config.login_tokens
[]
```
If we do a `deck dump`, the configuration will be reflected
into a local state file:
```
$ deck dump --yes
$ cat kong.yaml | grep login_tokens
login_tokens: []
```
But, if we now run `deck diff` we see that decK will detect
a difference because of the `login_tokens` field's default
value:
```
$ deck diff
updating plugin openid-connect (global) {
"config": {
"anonymous": null,
...
...
"login_redirect_mode": "fragment",
"login_redirect_uri": null,
"login_tokens": [
+ "id_token"
],
"logout_methods": [
"POST",
"DELETE"
],
...
...
}
Summary:
Created: 0
Updated: 1
Deleted: 0
```
This commit corrects this defect by allowing decK to set empty
arrays when default values exist for a given field.
Codecov ReportAll modified lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #374 +/- ##
==========================================
- Coverage 53.06% 53.05% -0.01%
==========================================
Files 69 69
Lines 5201 5200 -1
==========================================
- Hits 2760 2759 -1
Misses 1857 1857
Partials 584 584
Flags with carried forward coverage won't be shown. Click here to find out more.
☔ View full report in Codecov by Sentry. |
pmalek
reviewed
Oct 17, 2023
pmalek
approved these changes
Oct 17, 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.
This commit fixes a bug preventing users to set fields to emtpy arrays when a default for those fields exist. For example, imagine we have an
openid-connectplugin configured via the UI having thelogin_tokensset to an empty array (note: this field has a default value of["id_token"]:If we do a
deck dump, the configuration will be reflected into a local state file:But, if we now run
deck diffwe see that decK will detect a difference because of thelogin_tokensfield's default value:This commit corrects this defect by allowing decK to set empty arrays when default values exist for a given field.