Error handling basics
- Raphael ‘kena’ Poss (Deactivated)
- Stan Rosenberg
Error Types
We prefer the use of the CockroachDB errors library at github.com/cockroachdb/errors. This is a superset of Go's own errors and pkg/errors.
errors.New()for errors with simple static stringserrors.Newf()for formatted error stringserrors.AssertionFailedf()for assertion / internal errors that reflect a likely implementation bug by the CRL team and should be louder than usualAdd context on return paths using
errors.Wrap()/errors.Wrapf()Add user-directed hints with errors.WithHint()
See the doc README on the errors package for more
When returning errors, consider the following to determine the best choice:
Is this a simple error that needs no extra information? If so,
errors.Newshould suffice.Do the clients need to detect and handle this error? If so, you should use a custom type, and implement the
Error()method.Are you propagating an error returned by a downstream function? If so, check the RFC on error handling
If the client needs to detect the error, and you have created a simple error using errors.New, use a var for the error.
Bad | Good |
|---|---|
// package foo
func Open() error {
return errors.New("could not open")
}
// package bar
if err := foo.Open(); err != nil {
if err.Error() == "could not open" {
// handle
} else {
panic("unknown error")
}
}
| // package foo
var ErrCouldNotOpen = errors.New("could not open")
func Open() error {
return ErrCouldNotOpen
}
// package bar
if err := foo.Open(); err != nil {
if errors.Is(err, foo.ErrCouldNotOpen) {
// handle
} else {
return errors.Wrap(err, "unknown error")
}
} |
If you have an error that clients may need to detect, and you would like to add more information to it (e.g., it is not a static string), then you should use a custom type.
Bad | Good |
|---|---|
func open(file string) error {
return fmt.Errorf("file %q not found", file)
}
func use() error {
if err := open(); err != nil {
if strings.Contains(err.Error(), "not found") {
// handle
} else {
panic("unknown error")
}
}
} | type errNotFound struct {
file string
}
func (e errNotFound) Error() string {
return fmt.Sprintf("file %q not found", e.file)
}
func open(file string) error {
return errNotFound{file: file}
}
func use() error {
if err := open(); err != nil {
var nfErr errNotFound
if errors.As(err, &nfErr) {
// handle
} else {
return errors.Wrap(err, "opening file")
}
}
} |
Error Wrapping
There are three main options for propagating errors if a call fails:
Return the original error if there is no additional context to add and you want to maintain the original error type.
Add context using
errors.Wrapso that the error message provides more context anderrors.Unwrapcan be used to extract the original error. Prefer this tofmt.Errorf("some message %w").If you pass an error through a channel from one goroutine to another, use
errors.WithStackon both ends to identify this flow.Use
errors.Newfif the callers do not need to detect or handle that specific error case.Use
errors.Handleorerrors.NewAssertionErrorWithWrappedErrfto hide the original cause.
It is recommended to add context where possible so that instead of a vague error such as "connection refused", you get more useful errors such as "call service foo: connection refused".
When adding context to returned errors, keep the context succinct by avoiding phrases like "failed to", which state the obvious and pile up as the error percolates up through the stack:
Bad | Good |
|---|---|
s, err := store.New()
if err != nil {
return errors.Newf(
"failed to create new store: %s", err)
} | s, err := store.New()
if err != nil {
return errors.Wrap(
"new store", err)
} |
failed to x: failed to y: failed to create new store: the error
| x: y: new store: the error
|
However once the error is sent to another system, it should be clear the message is an error (e.g. an err tag or "Failed" prefix in logs).
See also Don't just check errors, handle them gracefully — but be mindful that Go has evolved since this article was written, and use errors.Is() and errors.As() where applicable.
Handle Type Assertion Failures
The single return value form of a type assertion will panic on an incorrect type. Therefore, always use the "comma ok" idiom.
Bad | Good |
|---|---|
t := i.(string) | t, ok := i.(string)
if !ok {
// handle the error gracefully
} |
Don't Panic
Code running in production must avoid panics. Panics are a major source of cascading failures. If an error occurs, the function must return an error and allow the caller to decide how to handle it.
Bad | Good |
|---|---|
func foo(bar string) {
if len(bar) == 0 {
panic("bar must not be empty")
}
// ...
}
func main() {
if len(os.Args) != 2 {
fmt.Println("USAGE: foo <bar>")
os.Exit(1)
}
foo(os.Args[1])
} | func foo(bar string) error {
if len(bar) == 0
return errors.New("bar must not be empty")
}
// ...
return nil
}
func main() {
if len(os.Args) != 2 {
fmt.Println("USAGE: foo <bar>")
os.Exit(1)
}
if err := foo(os.Args[1]); err != nil {
panic(err)
}
} |
Panic/recover is, in most cases, not an error handling strategy. A program must panic only when something irrecoverable happens such as a nil dereference.
An exception to this is program initialization: bad things at program startup that should abort the program may cause panic.
var _statusTemplate = template.Must(template.New("name").Parse("_statusHTML"))Another exception is when a package is purely functional and has no side effects. For example, parts of SQL planning in CockroachDB uses panic propagation for error handling in that case.
Even in tests, prefer t.Fatal or t.FailNow over panics to ensure that the test is marked as failed.
Bad | Good |
|---|---|
// func TestFoo(t *testing.T)
f, err := ioutil.TempFile("", "test")
if err != nil {
panic("failed to set up test")
} | // func TestFoo(t *testing.T)
f, err := ioutil.TempFile("", "test")
if err != nil {
t.Fatal("failed to set up test")
} |
Related content
Copyright (C) Cockroach Labs.
Attention: This documentation is provided on an "as is" basis, without warranties or conditions of any kind, either express or implied, including, without limitation, any warranties or conditions of title, non-infringement, merchantability, or fitness for a particular purpose.