fails

Documentation

Index

• Variables
• type Classifier
• type ClassifierFunc
  • func (f ClassifierFunc) Classify(err error) bool
• type ClassifierGroup
  • func (cg ClassifierGroup) Classify(err error) bool

Variables

var AttemptedTLSWithNonTLSBackend = ClassifierFunc(func(err error) bool {
	switch err.(type) {
	case tls.RecordHeaderError, *tls.RecordHeaderError:
		return true
	default:
		return false
	}
})

var ConnectionResetOnRead = ClassifierFunc(func(err error) bool {
	ne, ok := err.(*net.OpError)
	return ok && ne.Op == "read" && ne.Err.Error() == "read: connection reset by peer"
})

var ContextCancelled = ClassifierFunc(func(err error) bool {
	return err == context.Canceled
})

var Dial = ClassifierFunc(func(err error) bool {
	ne, ok := err.(*net.OpError)
	return ok && ne.Op == "dial"
})

var ExpiredOrNotYetValidCertFailure = ClassifierFunc(func(err error) bool {
	switch x509err := err.(type) {
	case x509.CertificateInvalidError:
		return x509err.Reason == x509.Expired
	case *x509.CertificateInvalidError:
		return x509err.Reason == x509.Expired
	default:
		return false
	}
})

var FailableClassifiers = ClassifierGroup{
	RetriableClassifiers,
	ConnectionResetOnRead,
}

var HostnameMismatch = ClassifierFunc(func(err error) bool {
	switch err.(type) {
	case x509.HostnameError, *x509.HostnameError:
		return true
	default:
		return false
	}
})

var IdempotentRequestEOF = ClassifierFunc(func(err error) bool {
	return err == IdempotentRequestEOFError
})

var IdempotentRequestEOFError = errors.New("EOF (via idempotent request)")

var PrunableClassifiers = RetriableClassifiers

var RemoteFailedCertCheck = ClassifierFunc(func(err error) bool {
	return err != nil && (err.Error() == "readLoopPeekFailLocked: remote error: tls: bad certificate" || err.Error() == "remote error: tls: bad certificate")
})

var RemoteHandshakeFailure = ClassifierFunc(func(err error) bool {
	return err != nil && err.Error() == "remote error: tls: handshake failure"
})

var RemoteHandshakeTimeout = ClassifierFunc(func(err error) bool {
	return err != nil && err.Error() == "net/http: TLS handshake timeout"
})

var RetriableClassifiers = ClassifierGroup{
	Dial,
	AttemptedTLSWithNonTLSBackend,
	HostnameMismatch,
	RemoteFailedCertCheck,
	RemoteHandshakeFailure,
	RemoteHandshakeTimeout,
	UntrustedCert,
	ExpiredOrNotYetValidCertFailure,
	IdempotentRequestEOF,
}

RetriableClassifiers include backend errors that are safe to retry

Backend errors are only safe to retry if we can be certain that they have occurred before any http request data has been sent from gorouter to the backend application.

Otherwise, there’s risk of a mutating non-idempotent request (e.g. send payment) being silently retried without the client knowing.

var UntrustedCert = ClassifierFunc(func(err error) bool {
	switch err.(type) {
	case x509.UnknownAuthorityError, *x509.UnknownAuthorityError:
		return true
	default:
		return false
	}
})

Types

type Classifier

type Classifier interface {
	Classify(err error) bool
}

type ClassifierFunc

type ClassifierFunc func(err error) bool

func (ClassifierFunc) Classify

func (f ClassifierFunc) Classify(err error) bool

type ClassifierGroup

type ClassifierGroup []Classifier

func (ClassifierGroup) Classify

func (cg ClassifierGroup) Classify(err error) bool

Classify returns true on errors that are retryable