|
| 1 | +// |
| 2 | +// DISCLAIMER |
| 3 | +// |
| 4 | +// Copyright 2018 ArangoDB GmbH, Cologne, Germany |
| 5 | +// |
| 6 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 7 | +// you may not use this file except in compliance with the License. |
| 8 | +// You may obtain a copy of the License at |
| 9 | +// |
| 10 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 11 | +// |
| 12 | +// Unless required by applicable law or agreed to in writing, software |
| 13 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 14 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 15 | +// See the License for the specific language governing permissions and |
| 16 | +// limitations under the License. |
| 17 | +// |
| 18 | +// Copyright holder is ArangoDB GmbH, Cologne, Germany |
| 19 | +// |
| 20 | +// Author Ewout Prangsma |
| 21 | +// |
| 22 | + |
| 23 | +package errors |
| 24 | + |
| 25 | +import ( |
| 26 | + "context" |
| 27 | + "fmt" |
| 28 | + "io" |
| 29 | + "net" |
| 30 | + "net/url" |
| 31 | + "os" |
| 32 | + "syscall" |
| 33 | + |
| 34 | + driver "github.com/arangodb/go-driver" |
| 35 | + errs "github.com/pkg/errors" |
| 36 | +) |
| 37 | + |
| 38 | +var ( |
| 39 | + Cause = errs.Cause |
| 40 | + New = errs.New |
| 41 | + WithStack = errs.WithStack |
| 42 | + Wrap = errs.Wrap |
| 43 | + Wrapf = errs.Wrapf |
| 44 | +) |
| 45 | + |
| 46 | +// WithMessage annotates err with a new message. |
| 47 | +// The messages of given error is hidden. |
| 48 | +// If err is nil, WithMessage returns nil. |
| 49 | +func WithMessage(err error, message string) error { |
| 50 | + if err == nil { |
| 51 | + return nil |
| 52 | + } |
| 53 | + return &withMessage{ |
| 54 | + cause: err, |
| 55 | + msg: message, |
| 56 | + } |
| 57 | +} |
| 58 | + |
| 59 | +type withMessage struct { |
| 60 | + cause error |
| 61 | + msg string |
| 62 | +} |
| 63 | + |
| 64 | +func (w *withMessage) Error() string { return w.msg } |
| 65 | +func (w *withMessage) Cause() error { return w.cause } |
| 66 | + |
| 67 | +func (w *withMessage) Format(s fmt.State, verb rune) { |
| 68 | + switch verb { |
| 69 | + case 'v': |
| 70 | + if s.Flag('+') { |
| 71 | + fmt.Fprintf(s, "%+v\n", w.Cause()) |
| 72 | + io.WriteString(s, w.msg) |
| 73 | + return |
| 74 | + } |
| 75 | + fallthrough |
| 76 | + case 's', 'q': |
| 77 | + io.WriteString(s, w.Error()) |
| 78 | + } |
| 79 | +} |
| 80 | + |
| 81 | +type timeout interface { |
| 82 | + Timeout() bool |
| 83 | +} |
| 84 | + |
| 85 | +// IsTimeout returns true if the given error is caused by a timeout error. |
| 86 | +func IsTimeout(err error) bool { |
| 87 | + if err == nil { |
| 88 | + return false |
| 89 | + } |
| 90 | + if t, ok := errs.Cause(err).(timeout); ok { |
| 91 | + return t.Timeout() |
| 92 | + } |
| 93 | + return false |
| 94 | +} |
| 95 | + |
| 96 | +type temporary interface { |
| 97 | + Temporary() bool |
| 98 | +} |
| 99 | + |
| 100 | +// IsTemporary returns true if the given error is caused by a temporary error. |
| 101 | +func IsTemporary(err error) bool { |
| 102 | + if err == nil { |
| 103 | + return false |
| 104 | + } |
| 105 | + if t, ok := errs.Cause(err).(temporary); ok { |
| 106 | + return t.Temporary() |
| 107 | + } |
| 108 | + return false |
| 109 | +} |
| 110 | + |
| 111 | +// IsEOF returns true if the given error is caused by an EOF error. |
| 112 | +func IsEOF(err error) bool { |
| 113 | + err = errs.Cause(err) |
| 114 | + if err == io.EOF { |
| 115 | + return true |
| 116 | + } |
| 117 | + if ok, err := libCause(err); ok { |
| 118 | + return IsEOF(err) |
| 119 | + } |
| 120 | + return false |
| 121 | +} |
| 122 | + |
| 123 | +// IsConnectionRefused returns true if the given error is caused by an "connection refused" error. |
| 124 | +func IsConnectionRefused(err error) bool { |
| 125 | + err = errs.Cause(err) |
| 126 | + if err, ok := err.(syscall.Errno); ok { |
| 127 | + return err == syscall.ECONNREFUSED |
| 128 | + } |
| 129 | + if ok, err := libCause(err); ok { |
| 130 | + return IsConnectionRefused(err) |
| 131 | + } |
| 132 | + return false |
| 133 | +} |
| 134 | + |
| 135 | +// IsConnectionReset returns true if the given error is caused by an "connection reset by peer" error. |
| 136 | +func IsConnectionReset(err error) bool { |
| 137 | + err = errs.Cause(err) |
| 138 | + if err, ok := err.(syscall.Errno); ok { |
| 139 | + return err == syscall.ECONNRESET |
| 140 | + } |
| 141 | + if ok, err := libCause(err); ok { |
| 142 | + return IsConnectionReset(err) |
| 143 | + } |
| 144 | + return false |
| 145 | +} |
| 146 | + |
| 147 | +// IsContextCanceled returns true if the given error is caused by a context cancelation. |
| 148 | +func IsContextCanceled(err error) bool { |
| 149 | + err = errs.Cause(err) |
| 150 | + if err == context.Canceled { |
| 151 | + return true |
| 152 | + } |
| 153 | + if ok, err := libCause(err); ok { |
| 154 | + return IsContextCanceled(err) |
| 155 | + } |
| 156 | + return false |
| 157 | +} |
| 158 | + |
| 159 | +// IsContextDeadlineExpired returns true if the given error is caused by a context deadline expiration. |
| 160 | +func IsContextDeadlineExpired(err error) bool { |
| 161 | + err = errs.Cause(err) |
| 162 | + if err == context.DeadlineExceeded { |
| 163 | + return true |
| 164 | + } |
| 165 | + if ok, err := libCause(err); ok { |
| 166 | + return IsContextDeadlineExpired(err) |
| 167 | + } |
| 168 | + return false |
| 169 | +} |
| 170 | + |
| 171 | +// IsContextCanceledOrExpired returns true if the given error is caused by a context cancelation |
| 172 | +// or deadline expiration. |
| 173 | +func IsContextCanceledOrExpired(err error) bool { |
| 174 | + err = errs.Cause(err) |
| 175 | + if err == context.Canceled || err == context.DeadlineExceeded { |
| 176 | + return true |
| 177 | + } |
| 178 | + if ok, err := libCause(err); ok { |
| 179 | + return IsContextCanceledOrExpired(err) |
| 180 | + } |
| 181 | + return false |
| 182 | +} |
| 183 | + |
| 184 | +// libCause returns the Cause of well known go library errors. |
| 185 | +func libCause(err error) (bool, error) { |
| 186 | + original := err |
| 187 | + for { |
| 188 | + switch e := err.(type) { |
| 189 | + case *driver.ResponseError: |
| 190 | + err = e.Err |
| 191 | + case *net.DNSConfigError: |
| 192 | + err = e.Err |
| 193 | + case *net.OpError: |
| 194 | + err = e.Err |
| 195 | + case *os.SyscallError: |
| 196 | + err = e.Err |
| 197 | + case *url.Error: |
| 198 | + err = e.Err |
| 199 | + default: |
| 200 | + return err != original, err |
| 201 | + } |
| 202 | + } |
| 203 | +} |
0 commit comments