107
vendor/github.com/grpc-ecosystem/go-grpc-middleware/recovery/DOC.md
generated
vendored
107
vendor/github.com/grpc-ecosystem/go-grpc-middleware/recovery/DOC.md
generated
vendored
@@ -1,107 +0,0 @@
|
||||
# grpc_recovery
|
||||
`import "github.com/grpc-ecosystem/go-grpc-middleware/recovery"`
|
||||
|
||||
* [Overview](#pkg-overview)
|
||||
* [Imported Packages](#pkg-imports)
|
||||
* [Index](#pkg-index)
|
||||
* [Examples](#pkg-examples)
|
||||
|
||||
## <a name="pkg-overview">Overview</a>
|
||||
`grpc_recovery` are intereceptors that recover from gRPC handler panics.
|
||||
|
||||
### Server Side Recovery Middleware
|
||||
By default a panic will be converted into a gRPC error with `code.Internal`.
|
||||
|
||||
Handling can be customised by providing an alternate recovery function.
|
||||
|
||||
Please see examples for simple examples of use.
|
||||
|
||||
#### Example:
|
||||
|
||||
<details>
|
||||
<summary>Click to expand code.</summary>
|
||||
|
||||
```go
|
||||
package grpc_recovery_test
|
||||
|
||||
import (
|
||||
"github.com/grpc-ecosystem/go-grpc-middleware"
|
||||
"github.com/grpc-ecosystem/go-grpc-middleware/recovery"
|
||||
"google.golang.org/grpc"
|
||||
)
|
||||
|
||||
var (
|
||||
customFunc grpc_recovery.RecoveryHandlerFunc
|
||||
)
|
||||
|
||||
// Initialization shows an initialization sequence with a custom recovery handler func.
|
||||
func Example_initialization() {
|
||||
// Shared options for the logger, with a custom gRPC code to log level function.
|
||||
opts := []grpc_recovery.Option{
|
||||
grpc_recovery.WithRecoveryHandler(customFunc),
|
||||
}
|
||||
// Create a server. Recovery handlers should typically be last in the chain so that other middleware
|
||||
// (e.g. logging) can operate on the recovered state instead of being directly affected by any panic
|
||||
_ = grpc.NewServer(
|
||||
grpc_middleware.WithUnaryServerChain(
|
||||
grpc_recovery.UnaryServerInterceptor(opts...),
|
||||
),
|
||||
grpc_middleware.WithStreamServerChain(
|
||||
grpc_recovery.StreamServerInterceptor(opts...),
|
||||
),
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
## <a name="pkg-imports">Imported Packages</a>
|
||||
|
||||
- [golang.org/x/net/context](https://godoc.org/golang.org/x/net/context)
|
||||
- [google.golang.org/grpc](https://godoc.org/google.golang.org/grpc)
|
||||
- [google.golang.org/grpc/codes](https://godoc.org/google.golang.org/grpc/codes)
|
||||
|
||||
## <a name="pkg-index">Index</a>
|
||||
* [func StreamServerInterceptor(opts ...Option) grpc.StreamServerInterceptor](#StreamServerInterceptor)
|
||||
* [func UnaryServerInterceptor(opts ...Option) grpc.UnaryServerInterceptor](#UnaryServerInterceptor)
|
||||
* [type Option](#Option)
|
||||
* [func WithRecoveryHandler(f RecoveryHandlerFunc) Option](#WithRecoveryHandler)
|
||||
* [type RecoveryHandlerFunc](#RecoveryHandlerFunc)
|
||||
|
||||
#### <a name="pkg-examples">Examples</a>
|
||||
* [Package (Initialization)](#example__initialization)
|
||||
|
||||
#### <a name="pkg-files">Package files</a>
|
||||
[doc.go](./doc.go) [interceptors.go](./interceptors.go) [options.go](./options.go)
|
||||
|
||||
## <a name="StreamServerInterceptor">func</a> [StreamServerInterceptor](./interceptors.go#L30)
|
||||
``` go
|
||||
func StreamServerInterceptor(opts ...Option) grpc.StreamServerInterceptor
|
||||
```
|
||||
StreamServerInterceptor returns a new streaming server interceptor for panic recovery.
|
||||
|
||||
## <a name="UnaryServerInterceptor">func</a> [UnaryServerInterceptor](./interceptors.go#L16)
|
||||
``` go
|
||||
func UnaryServerInterceptor(opts ...Option) grpc.UnaryServerInterceptor
|
||||
```
|
||||
UnaryServerInterceptor returns a new unary server interceptor for panic recovery.
|
||||
|
||||
## <a name="Option">type</a> [Option](./options.go#L25)
|
||||
``` go
|
||||
type Option func(*options)
|
||||
```
|
||||
|
||||
### <a name="WithRecoveryHandler">func</a> [WithRecoveryHandler](./options.go#L28)
|
||||
``` go
|
||||
func WithRecoveryHandler(f RecoveryHandlerFunc) Option
|
||||
```
|
||||
WithRecoveryHandler customizes the function for recovering from a panic.
|
||||
|
||||
## <a name="RecoveryHandlerFunc">type</a> [RecoveryHandlerFunc](./interceptors.go#L13)
|
||||
``` go
|
||||
type RecoveryHandlerFunc func(p interface{}) (err error)
|
||||
```
|
||||
RecoveryHandlerFunc is a function that recovers from the panic `p` by returning an `error`.
|
||||
|
||||
- - -
|
||||
Generated by [godoc2ghmd](https://github.com/GandalfUK/godoc2ghmd)
|
||||
15
vendor/github.com/grpc-ecosystem/go-grpc-middleware/recovery/interceptors.go
generated
vendored
15
vendor/github.com/grpc-ecosystem/go-grpc-middleware/recovery/interceptors.go
generated
vendored
@@ -4,7 +4,8 @@
|
||||
package grpc_recovery
|
||||
|
||||
import (
|
||||
"golang.org/x/net/context"
|
||||
"context"
|
||||
|
||||
"google.golang.org/grpc"
|
||||
"google.golang.org/grpc/codes"
|
||||
)
|
||||
@@ -12,13 +13,17 @@ import (
|
||||
// RecoveryHandlerFunc is a function that recovers from the panic `p` by returning an `error`.
|
||||
type RecoveryHandlerFunc func(p interface{}) (err error)
|
||||
|
||||
// RecoveryHandlerFuncContext is a function that recovers from the panic `p` by returning an `error`.
|
||||
// The context can be used to extract request scoped metadata and context values.
|
||||
type RecoveryHandlerFuncContext func(ctx context.Context, p interface{}) (err error)
|
||||
|
||||
// UnaryServerInterceptor returns a new unary server interceptor for panic recovery.
|
||||
func UnaryServerInterceptor(opts ...Option) grpc.UnaryServerInterceptor {
|
||||
o := evaluateOptions(opts)
|
||||
return func(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (_ interface{}, err error) {
|
||||
defer func() {
|
||||
if r := recover(); r != nil {
|
||||
err = recoverFrom(r, o.recoveryHandlerFunc)
|
||||
err = recoverFrom(ctx, r, o.recoveryHandlerFunc)
|
||||
}
|
||||
}()
|
||||
|
||||
@@ -32,7 +37,7 @@ func StreamServerInterceptor(opts ...Option) grpc.StreamServerInterceptor {
|
||||
return func(srv interface{}, stream grpc.ServerStream, info *grpc.StreamServerInfo, handler grpc.StreamHandler) (err error) {
|
||||
defer func() {
|
||||
if r := recover(); r != nil {
|
||||
err = recoverFrom(r, o.recoveryHandlerFunc)
|
||||
err = recoverFrom(stream.Context(), r, o.recoveryHandlerFunc)
|
||||
}
|
||||
}()
|
||||
|
||||
@@ -40,9 +45,9 @@ func StreamServerInterceptor(opts ...Option) grpc.StreamServerInterceptor {
|
||||
}
|
||||
}
|
||||
|
||||
func recoverFrom(p interface{}, r RecoveryHandlerFunc) error {
|
||||
func recoverFrom(ctx context.Context, p interface{}, r RecoveryHandlerFuncContext) error {
|
||||
if r == nil {
|
||||
return grpc.Errorf(codes.Internal, "%s", p)
|
||||
}
|
||||
return r(p)
|
||||
return r(ctx, p)
|
||||
}
|
||||
|
||||
13
vendor/github.com/grpc-ecosystem/go-grpc-middleware/recovery/options.go
generated
vendored
13
vendor/github.com/grpc-ecosystem/go-grpc-middleware/recovery/options.go
generated
vendored
@@ -3,6 +3,8 @@
|
||||
|
||||
package grpc_recovery
|
||||
|
||||
import "context"
|
||||
|
||||
var (
|
||||
defaultOptions = &options{
|
||||
recoveryHandlerFunc: nil,
|
||||
@@ -10,7 +12,7 @@ var (
|
||||
)
|
||||
|
||||
type options struct {
|
||||
recoveryHandlerFunc RecoveryHandlerFunc
|
||||
recoveryHandlerFunc RecoveryHandlerFuncContext
|
||||
}
|
||||
|
||||
func evaluateOptions(opts []Option) *options {
|
||||
@@ -26,6 +28,15 @@ type Option func(*options)
|
||||
|
||||
// WithRecoveryHandler customizes the function for recovering from a panic.
|
||||
func WithRecoveryHandler(f RecoveryHandlerFunc) Option {
|
||||
return func(o *options) {
|
||||
o.recoveryHandlerFunc = RecoveryHandlerFuncContext(func(ctx context.Context, p interface{}) error {
|
||||
return f(p)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// WithRecoveryHandlerContext customizes the function for recovering from a panic.
|
||||
func WithRecoveryHandlerContext(f RecoveryHandlerFuncContext) Option {
|
||||
return func(o *options) {
|
||||
o.recoveryHandlerFunc = f
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user