api: fix a panic and tweak some exported types #16237
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 PR - fixes a panic in GetItems when looking up a variable that does not exist. - deprecates GetItems in favor of GetVariableItems which avoids returning a pointer to a map - deprecates ErrVariableNotFound in favor of ErrVariablePathNotFound which is an actual error type - does some minor code cleanup to make linters happier
shoenig
force-pushed
the
api-vars-fixes
branch
from
698c41d to
7827354
Compare
shoenig
commented
Feb 21, 2023
| @@ -12,8 +12,16 @@ import ( | |||
| ) | |||
|
|
|||
| const ( | |||
| ErrVariableNotFound = "variable not found" | |||
| ErrVariableMissingItems = "variable missing Items field" | |||
There was a problem hiding this comment.
note: ErrVariableMissingItems wasn't used so ... should be safe to just remove?
There was a problem hiding this comment.
I checked in CT's nomad_var_get.go and nomad_var_list.go and found no consumers either. Technically breaking backcompat but I seriously doubt there are any real consumers.
tgross
reviewed
Feb 21, 2023
| @@ -12,8 +12,16 @@ import ( | |||
| ) | |||
|
|
|||
| const ( | |||
| ErrVariableNotFound = "variable not found" | |||
| ErrVariableMissingItems = "variable missing Items field" | |||
There was a problem hiding this comment.
I checked in CT's nomad_var_get.go and nomad_var_list.go and found no consumers either. Technically breaking backcompat but I seriously doubt there are any real consumers.
Comment on lines
+191
to
+192
| // todo(shoenig): seems like this could just return a *Variable instead of taking | ||
| // in a **Variable and modifying it? |
There was a problem hiding this comment.
I went back to look at the original PR for this and don't see any discussion of it. Maybe @angrycub will remember why we did this?
schmichael
approved these changes
Feb 21, 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 PR
GetItemswhen looking up a variable that does not existGetItemsin favor ofGetVariableItemswhich avoids returning a pointer to amapErrVariableNotFoundin favor ofErrVariablePathNotFoundwhich is an actualerrortypeErrVariableMissingItemsFixes #16236
Fixes #16235
Fixes #16234
No backport - we don't tag the api module anyway