README
¶
grpc-errors
grpc-errors is a middleware providing better error handling to resolve errors easily.
Example
package main
import (
"context"
"net"
"github.com/creasty/apperrors"
"github.com/grpc-ecosystem/go-grpc-middleware"
"github.com/izumin5210/grpc-errors"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
)
const (
CodeOK int = iota
CodeInvalidArgument
CodeNotFound
CodeYourCustomError
CodeNotWrapped
CodeUnknown
)
var grpcCodeByYourCode = map[int]codes.Code{
CodeOK: codes.OK,
CodeInvalidArgument: codes.InvalidArgument,
CodeNotFound: codes.NotFound,
}
func main() {
lis, err := net.Listen("tcp", "api.example.com:80")
if err != nil {
panic(err)
}
s := grpc.NewServer(
grpc_middleware.WithStreamServerChain(
grpcerrors.StreamServerInterceptor(
grpcerrors.WithNotWrappedErrorHandler(func(err error) error {
return apperrors.WithStatusCode(err, CodeNotWrapped)
}),
grpcerrors.WithReportableErrorHandler(func(err *apperrors.Error) error {
switch err.StatusCode {
case CodeYourCustomError:
// Report your custom errors
case CodeNotWrapped:
// Report not wrapped errors
default:
// Report errors
}
return err
}),
grpcerrors.WithStatusCodeMapper(grpcCodeByYourCode),
),
),
grpc_middleware.WithUnaryServerChain(
grpcerrors.UnaryServerInterceptor(
// Write your error handlers for an unary server
),
),
)
// Register server implementations
s.Serve(lis)
}
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func StreamServerInterceptor ¶
func StreamServerInterceptor(funcs ...ErrorHandlerFunc) grpc.StreamServerInterceptor
StreamServerInterceptor returns a new streaming server interceptor to handle errors
func UnaryServerInterceptor ¶
func UnaryServerInterceptor(funcs ...ErrorHandlerFunc) grpc.UnaryServerInterceptor
UnaryServerInterceptor returns a new unary server interceptor to handle errors
Types ¶
type AppErrorHandlerFunc ¶
AppErrorHandlerFunc is a function that called by interceptors when specified application erorrs are detected.
type ErrorHandlerFunc ¶
ErrorHandlerFunc is a function that called by interceptors when specified erorrs are detected.
func WithNotWrappedErrorHandler ¶
func WithNotWrappedErrorHandler(f ErrorHandlerFunc) ErrorHandlerFunc
WithNotWrappedErrorHandler returns a new error handler function for handling not wrapped errors.
func WithReportableErrorHandler ¶
func WithReportableErrorHandler(f AppErrorHandlerFunc) ErrorHandlerFunc
WithReportableErrorHandler returns a new error handler function for handling errors annotated with the reportability.
func WithStatusCodeMapper ¶
func WithStatusCodeMapper(m map[int]codes.Code) ErrorHandlerFunc
WithStatusCodeMapper returns a new error handler function for mapping status codes to gRPC's one.
Source Files
Directories