feat: add some grpc utils #403
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| package grpcserver | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/formancehq/go-libs/v3/logging" | ||
| "github.com/formancehq/go-libs/v3/serverport" | ||
| "go.uber.org/fx" | ||
| "google.golang.org/grpc" | ||
| ) | ||
|
|
||
| const serverPortDiscr = "grpc" | ||
|
|
||
| func ContextWithServerInfo(ctx context.Context) context.Context { | ||
| return serverport.ContextWithServerInfo(ctx, serverPortDiscr) | ||
| } | ||
|
|
||
| func startServer(ctx context.Context, s *serverport.Server, serverOptions []grpc.ServerOption, setupOptions []func(*grpc.Server)) (func(ctx context.Context) error, error) { | ||
|
|
||
| if err := s.Listen(ctx); err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| grpcServer := grpc.NewServer(serverOptions...) | ||
| for _, option := range setupOptions { | ||
| option(grpcServer) | ||
| } | ||
| go func() { | ||
| if err := grpcServer.Serve(s.Listener); err != nil { | ||
| logging.FromContext(ctx).Errorf("failed to serve: %v", err) | ||
| } | ||
| }() | ||
|
|
||
| return func(ctx context.Context) error { | ||
| grpcServer.GracefulStop() | ||
|
|
||
| return nil | ||
| }, nil | ||
| } | ||
|
|
||
| func Address(ctx context.Context) string { | ||
| return serverport.Address(ctx, serverPortDiscr) | ||
| } | ||
|
|
||
| type ServerOptions struct { | ||
| serverPortOptions []serverport.ServerOpts | ||
| grpcServerOpts []grpc.ServerOption | ||
| grpcSetupOpts []func(server *grpc.Server) | ||
| } | ||
|
|
||
| type ServerOptionModifier func(server *ServerOptions) | ||
|
|
||
| func WithServerPortOptions(opts ...serverport.ServerOpts) ServerOptionModifier { | ||
| return func(serverOptions *ServerOptions) { | ||
| serverOptions.serverPortOptions = append(serverOptions.serverPortOptions, opts...) | ||
| } | ||
| } | ||
|
|
||
| func WithGRPCServerOptions(opts ...grpc.ServerOption) ServerOptionModifier { | ||
| return func(serverOptions *ServerOptions) { | ||
| serverOptions.grpcServerOpts = append(serverOptions.grpcServerOpts, opts...) | ||
| } | ||
| } | ||
|
|
||
| func WithGRPCSetupOptions(opts ...func(server *grpc.Server)) ServerOptionModifier { | ||
| return func(serverOptions *ServerOptions) { | ||
| serverOptions.grpcSetupOpts = append(serverOptions.grpcSetupOpts, opts...) | ||
| } | ||
| } | ||
|
|
||
| func NewHook(serverOptionsModifiers ...ServerOptionModifier) fx.Hook { | ||
| var ( | ||
| close func(ctx context.Context) error | ||
| err error | ||
| ) | ||
|
|
||
| options := &ServerOptions{} | ||
| for _, option := range serverOptionsModifiers { | ||
| option(options) | ||
| } | ||
|
|
||
| server := serverport.NewServer(serverPortDiscr, options.serverPortOptions...) | ||
|
|
||
| return fx.Hook{ | ||
| OnStart: func(ctx context.Context) error { | ||
| logging.FromContext(ctx).Infof("starting GRPC server") | ||
| close, err = startServer( | ||
| ctx, | ||
| server, | ||
| options.grpcServerOpts, | ||
| options.grpcSetupOpts, | ||
| ) | ||
| return err | ||
| }, | ||
| OnStop: func(ctx context.Context) error { | ||
| if close == nil { | ||
| return nil | ||
| } | ||
| logging.FromContext(ctx).Infof("Stop GRPC server") | ||
| defer func() { | ||
| logging.FromContext(ctx).Infof("GRPC server stopped") | ||
| }() | ||
| return close(ctx) | ||
| }, | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Surface serving errors – align behaviour with the HTTP implementation
grpcServer.Servecan exit immediately (e.g. port already in use, TLS mis‑configuration).In the HTTP starter we
panicon such unrecoverable conditions, but here we only log, allowing the application to keep running in a half‑initialised state.go func() { - if err := grpcServer.Serve(s.Listener); err != nil { - logging.FromContext(ctx).Errorf("failed to serve: %v", err) + if err := grpcServer.Serve(s.Listener); err != nil && !errors.Is(err, grpc.ErrServerStopped) { + panic(fmt.Errorf("GRPC server failed to serve: %w", err)) } }()Doing so keeps both stacks consistent and fails fast when the port cannot be bound.
(Requires the
errorsandfmtimports.)📝 Committable suggestion