armadaerrors

Documentation

Overview

Package armadaerrors contains generic errors that should be returned by code handling gRPC requests. gRPC interceptors will look for the error types defined in this file and automatically set the gRPC status and return code correctly.

If multiple errors occur in some function (e.g., if multiple queues already exists), that function should return an error of type multierror.Error from package github.com/hashicorp/go-multierror that encapsulates those individual errors.

Index

• Variables
• func CodeFromError(err error) codes.Code
• func IsNetworkError(err error) bool
• func IsRetryablePostgresError(err error) bool
• func StreamServerInterceptor() grpc.StreamServerInterceptor
• func UnaryServerInterceptor() grpc.UnaryServerInterceptor
• type ErrAlreadyExists
  • func (err *ErrAlreadyExists) Error() (s string)
• type ErrInvalidArgument
  • func (err *ErrInvalidArgument) Error() string
• type ErrMaxRetriesExceeded
  • func (e *ErrMaxRetriesExceeded) Error() string
  • func (e *ErrMaxRetriesExceeded) Unwrap() error
• type ErrNoPermission
  • func (err *ErrNoPermission) Error() (s string)
• type ErrNotFound
  • func (err *ErrNotFound) Error() (s string)

Variables

var NATS_CONNECTION_ERRORS = []error{
	nats.ErrConnectionClosed,
	nats.ErrConnectionDraining,
	nats.ErrDrainTimeout,
	nats.ErrConnectionReconnecting,
	nats.ErrTimeout,
	nats.ErrBadTimeout,
	nats.ErrNoServers,
	nats.ErrDisconnected,
}

var PULSAR_CONNECTION_ERRORS = []pulsar.Result{
	pulsar.TimeoutError,
	pulsar.LookupError,
	pulsar.ConnectError,
	pulsar.ReadError,
	pulsar.NotConnectedError,
	pulsar.TooManyLookupRequestException,
	pulsar.ServiceUnitNotReady,
	pulsar.ProducerQueueIsFull,
}

Functions

func CodeFromError

func CodeFromError(err error) codes.Code

CodeFromError maps error types to gRPC return codes. Uses errors.As to look through the chain of errors, as opposed to just considering the topmost error in the chain.

func IsNetworkError

func IsNetworkError(err error) bool

IsNetworkError returns true if err is a network-related error. If err is an error chain, this function returns true if any error in the chain is a network error.

For details, see https://stackoverflow.com/questions/22761562/portable-way-to-detect-different-kinds-of-network-error

func IsRetryablePostgresError

func IsRetryablePostgresError(err error) bool

func StreamServerInterceptor

func StreamServerInterceptor() grpc.StreamServerInterceptor

StreamServerInterceptor returns an interceptor that extracts the cause of an error chain and returns it as a gRPC status error.

func UnaryServerInterceptor

func UnaryServerInterceptor() grpc.UnaryServerInterceptor

UnaryServerInterceptor returns an interceptor that extracts the cause of an error chain and returns it as a gRPC status error.

To log the full error chain and return only the cause to the user, insert this interceptor before the logging interceptor.

Types

type ErrAlreadyExists

type ErrAlreadyExists struct {
	Type    string // Resource type, e.g., "queue" or "user"
	Value   string // Resource name, e.g., "Bob"
	Message string // An optional message to include in the error message
}

ErrAlreadyExists is a generic error to be returned whenever some resource already exists. Type and Message are optional and are omitted from the error message if not provided.

func (*ErrAlreadyExists) Error

func (err *ErrAlreadyExists) Error() (s string)

type ErrInvalidArgument

type ErrInvalidArgument struct {
	Name    string      // Name of the field referred to, e.g., "priorityFactor"
	Value   interface{} // The invalid value that was provided
	Message string      // An optional message to include with the error message, e.g., explaining why the value is invalid
}

ErrInvalidArgument is a generic error to be returned on invalid argument. Message is optional and is omitted from the error message if not provided.

func (*ErrInvalidArgument) Error

func (err *ErrInvalidArgument) Error() string

type ErrMaxRetriesExceeded

type ErrMaxRetriesExceeded struct {
	Message   string
	LastError error
}

ErrMaxRetriesExceeded is an error that indicates we have retried an operation so many times that we have given up The internal error should contain the last error before giving up

func (*ErrMaxRetriesExceeded) Error

func (e *ErrMaxRetriesExceeded) Error() string

func (*ErrMaxRetriesExceeded) Unwrap

func (e *ErrMaxRetriesExceeded) Unwrap() error

type ErrNoPermission

type ErrNoPermission struct {
	// Principal that attempted the action
	Principal string
	// The missing permission
	Permission string
	// The attempted action
	Action string
	// Optional message included with the error message
	Message string
}

ErrNoPermission represents an error that occurs when a client tries to perform some action through the gRPC API for which it does not have permissions.

It may be necessary populate the Action field by recovering this error at the gRPC endpoint (using errors.As) and updating the field in-place.

func (*ErrNoPermission) Error

func (err *ErrNoPermission) Error() (s string)

type ErrNotFound

type ErrNotFound struct {
	Type    string
	Value   string
	Message string
}

ErrNotFound is a generic error to be returned whenever some resource isn't found. Type and Message are optional and are omitted from the error message if not provided.

See ErrAlreadyExists for more info.

func (*ErrNotFound) Error

func (err *ErrNotFound) Error() (s string)