fix!: Pass url struct tags by value instead of by reference
#3991
Conversation
This file contains hidden or 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
Signed-off-by: Glenn Lewis <6598971+gmlewis@users.noreply.github.com>
Signed-off-by: Glenn Lewis <6598971+gmlewis@users.noreply.github.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #3991 +/- ##
=======================================
Coverage 93.52% 93.52%
=======================================
Files 207 207
Lines 17593 17593
=======================================
Hits 16454 16454
Misses 938 938
Partials 201 201 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Signed-off-by: Glenn Lewis <6598971+gmlewis@users.noreply.github.com>
gmlewis
added
NeedsReview
Collaborator
Author
|
If any of you have time to review, that would be greatly appreciated. cc: @stevehipwell - @alexandear - @zyfy29 - @Not-Dhananjay-Mishra |
Comment on lines
+295
to
+298
| switch ident.Name { | ||
| // Remove the pointer for primitives in url tags | ||
| case "string", "int", "int64", "float64", "bool": | ||
| return ident.Name, false |
Contributor
There was a problem hiding this comment.
Can we use isBuiltinType helper function?
Suggested change
| switch ident.Name { | |
| // Remove the pointer for primitives in url tags | |
| case "string", "int", "int64", "float64", "bool": | |
| return ident.Name, false | |
| // Remove the pointer for primitives in url tags | |
| if isBuiltinType(ident.Name){ | |
| return ident.Name, false |
Contributor
|
Also, should we update all the struct in this PR? I believe a lot of struct need to be change |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
BREAKING CHANGE: Many
*Optionsstructs now passomitemptyURL struct fields by value instead of by reference.Fixes: #3990.
Relates to: #3984.
Over time, I had allowed and even encouraged pointers to primitive types to be used in the URL struct tags when "omitempty" was provided. This violates the spirit of the purpose of the use of pointers for GitHub resource types as declared in this repo's README.md, and this is the first step to getting back on track to a self-consistent client library.
I apologize for the breakages that this PR causes and for all the contributors whom I wrongly steered during code reviews.
Note that timestamps can still be passed by reference (or by value if using
omitzero).Also note that a new
check-structfield-settingstool is added to this repo that will report (and optionally-fix) any obsolete exceptions listed in the.golangci.ymlfile at the root of the repo.