tinygrpc

README

tinygrpc

A collection of tiny tools for gRPC server development in Go.

For more advanced features, go-grpc-middleware could be a better option.

Depends on

• grpc
• logrus

Installation

go get -u github.com/unsafe9/tinygrpc

Documentation

Index

• Constants
• func ExtractAuthMetadata(ctx context.Context, mdKey, schema string) (string, error)
• func GracefulStop(grpcServer *grpc.Server, hook func(os.Signal)) chan struct{}
• func LogrusKeySortingFunc(keys []string)
• func StreamServerAuthHandler(authProvider AuthProvider) grpc.StreamServerInterceptor
• func StreamServerContextInjector(injector ContextInjector) grpc.StreamServerInterceptor
• func StreamServerErrorDeterminer(determiner ErrorDeterminer) grpc.StreamServerInterceptor
• func StreamServerLogger(logger *logrus.Logger, determiner LogLevelDeterminer, ...) grpc.StreamServerInterceptor
• func StreamServerRecoveryHandler(recoveryHandler RecoveryHandler) grpc.StreamServerInterceptor
• func StreamServerSelector(interceptor grpc.StreamServerInterceptor, matcher SelectorMatcher) grpc.StreamServerInterceptor
• func UnaryServerAuthHandler(authProvider AuthProvider) grpc.UnaryServerInterceptor
• func UnaryServerContextInjector(injector ContextInjector) grpc.UnaryServerInterceptor
• func UnaryServerErrorDeterminer(determiner ErrorDeterminer) grpc.UnaryServerInterceptor
• func UnaryServerLogger(logger *logrus.Logger, determiner LogLevelDeterminer) grpc.UnaryServerInterceptor
• func UnaryServerRecoveryHandler(recoveryHandler RecoveryHandler) grpc.UnaryServerInterceptor
• func UnaryServerSelector(interceptor grpc.UnaryServerInterceptor, matcher SelectorMatcher) grpc.UnaryServerInterceptor
• type AuthProvider
• type AuthProviderFunc
  • func (f AuthProviderFunc) VerifyAuth(c *CallContext) (context.Context, error)
• type CallContext
  • func (c *CallContext) Context() context.Context
• type CallType
• type ContextInjector
• type ErrorDeterminer
• type LogLevelDeterminer
• type MultiAuthProvider
  • func (p *MultiAuthProvider) VerifyAuth(c *CallContext) (context.Context, error)
• type PanicWrapper
  • func (p PanicWrapper) Error() string
• type RecoveryHandler
• type SelectorMatcher

Constants

const (
	CallTypeUnary = CallType(iota)
	CallTypeClientStream
	CallTypeServerStream
	CallTypeBidiStream
)

Functions

func ExtractAuthMetadata

func ExtractAuthMetadata(ctx context.Context, mdKey, schema string) (string, error)

func GracefulStop

func GracefulStop(grpcServer *grpc.Server, hook func(os.Signal)) chan struct{}

func LogrusKeySortingFunc

func LogrusKeySortingFunc(keys []string)

func StreamServerAuthHandler

func StreamServerAuthHandler(authProvider AuthProvider) grpc.StreamServerInterceptor

func StreamServerContextInjector

func StreamServerContextInjector(injector ContextInjector) grpc.StreamServerInterceptor

func StreamServerErrorDeterminer

func StreamServerErrorDeterminer(determiner ErrorDeterminer) grpc.StreamServerInterceptor

func StreamServerLogger

func StreamServerLogger(logger *logrus.Logger, determiner LogLevelDeterminer, payloadLevel logrus.Level) grpc.StreamServerInterceptor

func StreamServerRecoveryHandler

func StreamServerRecoveryHandler(recoveryHandler RecoveryHandler) grpc.StreamServerInterceptor

func StreamServerSelector

func StreamServerSelector(interceptor grpc.StreamServerInterceptor, matcher SelectorMatcher) grpc.StreamServerInterceptor

func UnaryServerAuthHandler

func UnaryServerAuthHandler(authProvider AuthProvider) grpc.UnaryServerInterceptor

func UnaryServerContextInjector

func UnaryServerContextInjector(injector ContextInjector) grpc.UnaryServerInterceptor

func UnaryServerErrorDeterminer

func UnaryServerErrorDeterminer(determiner ErrorDeterminer) grpc.UnaryServerInterceptor

func UnaryServerLogger

func UnaryServerLogger(logger *logrus.Logger, determiner LogLevelDeterminer) grpc.UnaryServerInterceptor

func UnaryServerRecoveryHandler

func UnaryServerRecoveryHandler(recoveryHandler RecoveryHandler) grpc.UnaryServerInterceptor

func UnaryServerSelector

func UnaryServerSelector(interceptor grpc.UnaryServerInterceptor, matcher SelectorMatcher) grpc.UnaryServerInterceptor

Types

type AuthProvider

type AuthProvider interface {
	VerifyAuth(c *CallContext) (context.Context, error)
}

type AuthProviderFunc

type AuthProviderFunc func(c *CallContext) (context.Context, error)

func (AuthProviderFunc) VerifyAuth

func (f AuthProviderFunc) VerifyAuth(c *CallContext) (context.Context, error)

type CallContext

type CallContext struct {
	Server     any
	FullMethod string
	CallType   CallType
	// contains filtered or unexported fields
}

func (*CallContext) Context

func (c *CallContext) Context() context.Context

type CallType

type CallType int

type ContextInjector

type ContextInjector func(c *CallContext) context.Context

type ErrorDeterminer

type ErrorDeterminer func(c *CallContext, err error) error

type LogLevelDeterminer

type LogLevelDeterminer func(c *CallContext, err error) logrus.Level

type MultiAuthProvider

type MultiAuthProvider struct {
	// Providers is a list of auth providers to be chained
	Providers []AuthProvider

	// AllowUnauthenticated allows the process to pass without authentication
	//  if all providers fail.
	AllowUnauthenticated bool

	// EvaluateAll ensures that all providers in the chain are evaluated,
	//  injecting combined contexts from all successful providers, even if one succeeds early.
	EvaluateAll bool

	// RequireAll requires all providers to succeed, otherwise it will return an error.
	RequireAll bool
}

func (*MultiAuthProvider) VerifyAuth

func (p *MultiAuthProvider) VerifyAuth(c *CallContext) (context.Context, error)

type PanicWrapper

type PanicWrapper struct {
	Panic any
	Stack []byte
}

func (PanicWrapper) Error

func (p PanicWrapper) Error() string

type RecoveryHandler

type RecoveryHandler func(c *CallContext, p *PanicWrapper) error

type SelectorMatcher

type SelectorMatcher func(c *CallContext) bool