grpc

Documentation

Index

• func ErrorResponseEncoder(encoder kitgrpc.EncodeResponseFunc, errorEncoder EncodeErrorResponseFunc) kitgrpc.EncodeResponseFunc
• func IsGRPCError(err error) bool
• func ServerOptions(options []grpc.ServerOption) grpc.ServerOption
• type EncodeErrorResponseFunc
  • func NewDefaultStatusErrorResponseEncoder() EncodeErrorResponseFunc
  • func NewStatusErrorResponseEncoder(statusConverter StatusConverter) EncodeErrorResponseFunc
• type ErrorMatcher
• type ErrorMatcherFunc
  • func (fn ErrorMatcherFunc) MatchError(err error) bool
• type ServerFactory
  • func NewServerFactory(options ...grpc.ServerOption) ServerFactory
• type StatusCodeConverter
• type StatusCodeMatcher
  • func NewStatusCodeMatcher(code codes.Code, matcher ErrorMatcher) StatusCodeMatcher
• type StatusConverter
  • func NewDefaultStatusConverter() StatusConverter
  • func NewStatusConverter(config StatusConverterConfig) StatusConverter
• type StatusConverterConfig
• type StatusMatcher

Examples

• NewStatusConverter

Functions

func ErrorResponseEncoder

func ErrorResponseEncoder(
	encoder kitgrpc.EncodeResponseFunc,
	errorEncoder EncodeErrorResponseFunc,
) kitgrpc.EncodeResponseFunc

ErrorResponseEncoder encodes the passed response object to a gRPC response or error.

func IsGRPCError

func IsGRPCError(err error) bool

IsGRPCError checks if an error is already encoded as a gRPC status.

func ServerOptions

func ServerOptions(options []grpc.ServerOption) grpc.ServerOption

ServerOptions collects a list of ServerOptions into a single option. Useful to avoid variadic hells when passing lists of options around.

Types

type EncodeErrorResponseFunc

type EncodeErrorResponseFunc func(context.Context, error) error

EncodeErrorResponseFunc transforms the passed error to a gRPC code error. It's designed to be used in gRPC servers, for server-side endpoints.

func NewDefaultStatusErrorResponseEncoder

func NewDefaultStatusErrorResponseEncoder() EncodeErrorResponseFunc

NewDefaultStatusErrorResponseEncoder returns an error response encoder that encodes errors as gRPC Status errors.

The returned encoder encodes every error as Internal error.

func NewStatusErrorResponseEncoder

func NewStatusErrorResponseEncoder(statusConverter StatusConverter) EncodeErrorResponseFunc

NewStatusErrorResponseEncoder returns an error response encoder that encodes errors as gRPC Status errors.

type ErrorMatcher

type ErrorMatcher interface {
	// MatchError evaluates the predefined set of conditions for err.
	MatchError(err error) bool
}

ErrorMatcher checks if an error matches a predefined set of conditions.

type ErrorMatcherFunc

type ErrorMatcherFunc func(err error) bool

ErrorMatcherFunc turns a plain function into an ErrorMatcher if it's definition matches the interface.

func (ErrorMatcherFunc) MatchError

func (fn ErrorMatcherFunc) MatchError(err error) bool

MatchError calls the underlying function to check if err matches a certain condition.

type ServerFactory

type ServerFactory interface {
	// NewServer constructs a new server, which wraps the provided endpoint and implements the grpc.Handler interface.
	NewServer(
		e endpoint.Endpoint,
		dec grpc.DecodeRequestFunc,
		enc grpc.EncodeResponseFunc,
		options ...grpc.ServerOption,
	) *grpc.Server
}

ServerFactory constructs a new server, which wraps the provided endpoint and implements the grpc.Handler interface.

func NewServerFactory

func NewServerFactory(options ...grpc.ServerOption) ServerFactory

NewServerFactory returns a new ServerFactory.

type StatusCodeConverter

type StatusCodeConverter interface {
	// NewStatusWithCode creates a new gRPC code with a code from an error.
	NewStatusWithCode(ctx context.Context, code codes.Code, err error) *status.Status
}

StatusCodeConverter creates a new gRPC code with a code from an error.

type StatusCodeMatcher

type StatusCodeMatcher interface {
	ErrorMatcher

	// Code returns the gRPC code code.
	Code() codes.Code
}

StatusCodeMatcher matches an error and returns the appropriate code code for it.

func NewStatusCodeMatcher

func NewStatusCodeMatcher(code codes.Code, matcher ErrorMatcher) StatusCodeMatcher

NewStatusCodeMatcher returns a new StatusCodeMatcher.

type StatusConverter

type StatusConverter interface {
	// NewStatus creates a new gRPC Status from an error.
	NewStatus(ctx context.Context, err error) *status.Status
}

StatusConverter creates a new gRPC Status from an error.

func NewDefaultStatusConverter

func NewDefaultStatusConverter() StatusConverter

NewDefaultStatusConverter returns a new StatusConverter implementation with default configuration.

func NewStatusConverter

func NewStatusConverter(config StatusConverterConfig) StatusConverter

NewStatusConverter returns a new StatusConverter implementation.

Example

statusConverter := NewStatusConverter(StatusConverterConfig{
	Matchers: []StatusMatcher{
		NewStatusCodeMatcher(codes.NotFound, ErrorMatcherFunc(func(err error) bool {
			return err.Error() == "not found"
		})),
	},
})

err := errors.New("not found")

s := statusConverter.NewStatus(context.Background(), err)

fmt.Println(s.Code(), s.Message())

Output:

NotFound not found

type StatusConverterConfig

type StatusConverterConfig struct {
	// Matchers are used to match errors and create gRPC statuses.
	// If no matchers match the error (or no matchers are configured) a fallback code is created/returned.
	//
	// If a matcher also implements StatusConverter it is used instead of the builtin StatusConverter
	// for creating the code.
	//
	// If a matchers also implements StatusCodeMatcher
	// the builtin StatusCodeConverter is used for creating the code.
	Matchers []StatusMatcher

	// Status converters used for converting errors to gRPC statuses.
	StatusConverter     StatusConverter
	StatusCodeConverter StatusCodeConverter
}

StatusConverterConfig configures the StatusConverter implementation.

type StatusMatcher

type StatusMatcher interface {
	ErrorMatcher
}

StatusMatcher matches an error. It is an alias to the ErrorMatcher interface.