fix: use replaced_with to check for deprecated fields #472
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
In schemas, shorthand_fields that are deprecated will use "replaced_with" going forward to convey the new fields that would be used in place of the old ones. Earlier, "translate_backwards" was used for the same. This change ensures that both of the above mentioned fields can be used to find the new path that leads to the new values for comparison purposes. This will help tools like deck to show diff between syncs.
1 task
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #472 +/- ##
==========================================
- Coverage 59.93% 54.04% -5.90%
==========================================
Files 71 71
Lines 4463 5599 +1136
==========================================
+ Hits 2675 3026 +351
- Misses 1169 1954 +785
Partials 619 619
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
samugi
reviewed
Oct 17, 2024
kong/utils.go
Outdated
Comment on lines
455
to
464
| var replacePath gjson.Result | ||
| replacedWith := value.Get(fname + ".deprecation.replaced_with") | ||
| if replacedWith.IsArray() { | ||
| for _, item := range replacedWith.Array() { | ||
| if pathArray := item.Get("path"); pathArray.Exists() && pathArray.IsArray() { | ||
| replacePath = pathArray | ||
| break | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
looks like we don't need to run any of this code if backwardTranslation.Exists() so we could execute this conditionally to backwardTranslation not existing.
I think we may also simplify and just reassign backwardTranslation = pathArray here if the item is found, so we wouldn't need the replacePath variable.
samugi
approved these changes
Oct 18, 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.
In schemas, shorthand_fields that are deprecated
will use "replaced_with" going forward to convey the new fields that would be used in place of the old ones. Earlier, "translate_backwards" was used for the same.
This change ensures that both of the above mentioned fields can be used to find the new path that leads to the new values for comparison purposes. This will help tools like deck to show diff between syncs.
Fixes deck #1440
Corresponding PR: Kong/kong#13768