-
Notifications
You must be signed in to change notification settings - Fork 609
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Proposal: introducing a nerdctl error package #3393
Open
apostasie
wants to merge
1
commit into
containerd:main
Choose a base branch
from
apostasie:dev-error-package
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
/* | ||
Copyright The containerd Authors. | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
package errs | ||
|
||
import ( | ||
"errors" | ||
|
||
"github.com/containerd/errdefs" | ||
) | ||
|
||
var ( | ||
// ErrSystemIsBroken should wrap all system-level errors (filesystem unexpected conditions, hosed files, misbehaving subsystems) | ||
ErrSystemIsBroken = errors.New("system error") | ||
|
||
// ErrInvalidArgument should wrap all cases where an argument does not match expected syntax, | ||
// or prevents an operation from succeeding because of its value | ||
ErrInvalidArgument = errdefs.ErrInvalidArgument | ||
|
||
// ErrNotFound is the generic error describing that a requested resource could not be found | ||
ErrNotFound = errdefs.ErrNotFound | ||
|
||
// ErrNetworkCondition is meant to wrap network level errors - DNS, TCP, TLS errors | ||
// but NOT http server level errors | ||
ErrNetworkCondition = errors.New("network communication failed") | ||
|
||
// ErrServerIsMisbehaving should wrap all server errors (eg: status code 50x) | ||
// but NOT dns, tcp, or tls errors | ||
ErrServerIsMisbehaving = errors.New("server error") | ||
|
||
// ErrFailedPrecondition should wrap errors encountered when a certain operation cannot be performed because | ||
// a precondition prevents it from completing. For example, removing a volume that is in use. | ||
ErrFailedPrecondition = errors.New("unable to perform the requested operation") | ||
) |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Many of these are already defined in https://github.com/containerd/errdefs/blob/02b65bcc1b50358f7c1cca419c76f538349af784/errors.go#L37
ErrInvalidArgument
,ErrFailedPrecondition
.And
ErrSystemIsBroken
,ErrNetworkCondition
,ErrServerIsMisbehaving
are similar toErrInternal
andErrUnavailable
.Can we reuse the definition in containerd/errdefs?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can alias them if you think it is helpful, but I think it is a bad idea to just use them directly as outlined above.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you think it's a bad idea, maybe just wrap it with %w so it works for both nerdctl's and containerd's definition.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just to clarify: containerd returning errors from errdefs are fine - and may of course be handled and wrapped, and should NOT be removed, or ignored - and none of this proposal will "break" existing code testing for
errdefs.ErrNotFound
.example:
Same applies to any other error - from any third-party lib, or from golang.