osbuild-worker: do not use error in clienterror.Error.Details
#4145
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
schuellerf
force-pushed
the
clienterrors-no-errors
branch
from
5d51cd7
to
6ad8e6e
Compare
schuellerf
force-pushed
the
clienterrors-no-errors
branch
from
6ad8e6e
to
747d7ed
Compare
This is an alternative/complementary fix for PR#4137. It is very simple so should be uncontroverisal. It fixes an issue that @schuellerf discovered, i.e. that when an error interface is passed into clienterrors.Error.Details the details get lost because the json.Marshaler will not know how to handler an error interface. To find the problematic uses of `error` a custom vet checker was build in https://github.com/mvo5/osbuild-cvet. With that the result is: ``` $ go run github.com/mvo5/osbuild-cvet@latest ./... /home/mvogt/devel/osbuild/osbuild-composer/cmd/osbuild-worker/jobimpl-depsolve.go:93:26: do not pass 'error' to WorkerClientError() details, use error.Error() instead /home/mvogt/devel/osbuild/osbuild-composer/cmd/osbuild-worker/jobimpl-osbuild.go:404:31: do not pass 'error' to WorkerClientError() details, use error.Error() instead /home/mvogt/devel/osbuild/osbuild-composer/cmd/osbuild-worker/jobimpl-osbuild.go:519:31: do not pass 'error' to WorkerClientError() details, use error.Error() instead /home/mvogt/devel/osbuild/osbuild-composer/cmd/osbuild-worker/jobimpl-osbuild.go:556:31: do not pass '[]error' to WorkerClientError() details, use []string instead ``` and once this commit is in no more errors. Just like PR#4137 this is not perfect because it will not do a recursive check for the passed argument.
schuellerf
force-pushed
the
clienterrors-no-errors
branch
from
747d7ed
to
b820a29
Compare
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 is an alternative/complementary fix for #4137. It is very simple so should be uncontroversial.
It fixes an issue that @schuellerf discovered, i.e. that when an error interface is passed into clienterrors.Error.Details the details get lost because the json.Marshaler will not know how to handler an error interface.
To find the problematic uses of
errora custom vet checker was build in https://github.com/mvo5/osbuild-cvet. With that the result is:and once this commit is in no more errors.
Just like PR#4137 this is not perfect because it will not do a recursive check for the passed argument.
If we are happy with this approach we should add something like
(and move to the vet to the osbuild org)