fix: correct plugins config comparison #93
Merged
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 with the way Plugins config are compared: when unsorted nested arrays are present, `reflect.DeepEqual` considers the equal unsorted arrays as unequal, triggering the plugin update and showing misleading diffs. This commit is introducing a few helper functions to recursively sort arrays within the Kong Plugins configs.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #93 +/- ##
==========================================
+ Coverage 41.02% 41.16% +0.14%
==========================================
Files 74 74
Lines 10760 10795 +35
==========================================
+ Hits 4414 4444 +30
- Misses 5886 5890 +4
- Partials 460 461 +1 ☔ View full report in Codecov by Sentry. |
pmalek
reviewed
May 23, 2024
pkg/state/types.go
Outdated
Comment on lines
558
to
575
| // Helper function to sort a slice of interface{} | ||
| func sortInterfaceSlice(slice []interface{}) []interface{} { | ||
| // Convert []interface{} to []string for sorting | ||
| strSlice := make([]string, len(slice)) | ||
| for i, v := range slice { | ||
| strSlice[i] = fmt.Sprintf("%v", v) | ||
| } | ||
|
|
||
| sort.Strings(strSlice) | ||
|
|
||
| // Convert back to []interface{} | ||
| sortedSlice := make([]interface{}, len(strSlice)) | ||
| for i, v := range strSlice { | ||
| sortedSlice[i] = v | ||
| } | ||
|
|
||
| return sortedSlice | ||
| } |
There was a problem hiding this comment.
How about using a type that can be sorted and thus not allocating unnecessarily?
Something like this: d7c9b78
WDYT?
There was a problem hiding this comment.
Looks like a nice improvement!
There was a problem hiding this comment.
Pushed it directly to this PR: d7c9b78.
PTAL
Tieske
approved these changes
May 27, 2024
GGabriele
added a commit
to Kong/deck
that referenced
this pull request
May 27, 2024
GGabriele
added a commit
to Kong/deck
that referenced
this pull request
May 27, 2024
GGabriele
added a commit
to Kong/deck
that referenced
this pull request
May 27, 2024
GGabriele
added a commit
to Kong/deck
that referenced
this pull request
May 27, 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.
This commit fixes a bug with the way Plugins config are compared: when unsorted nested arrays are present,
reflect.DeepEqualconsiders the equal unsorted arrays as unequal, triggering the plugin update and showing misleading diffs.This commit is introducing a few helper functions to recursively sort arrays within the Kong Plugins configs.
Summary
SUMMARY_GOES_HERE
Full changelog
Issues resolved
Fix #XXX
Documentation
Testing