Skip to content

grpc_client: check SERVING status in Ping #377

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alliasgher wants to merge 2 commits into
base: main
Choose a base branch
from
Open

grpc_client: check SERVING status in Ping #377

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd79efb
grpc_client: check SERVING status in Ping
alliasgher Apr 14, 2026
da445f6
grpc_stdio, plugin_test: migrate from deprecated github.com/golang/pr…
alliasgher Apr 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ module github.com/hashicorp/go-plugin
go 1.24

require (
github.com/golang/protobuf v1.5.4
github.com/hashicorp/go-hclog v1.6.3
github.com/hashicorp/yamux v0.1.2
github.com/jhump/protoreflect v1.17.0
Expand All @@ -15,6 +14,7 @@ require (
require (
github.com/bufbuild/protocompile v0.14.1 // indirect
github.com/fatih/color v1.13.0 // indirect
github.com/golang/protobuf v1.5.4 // indirect
github.com/mattn/go-colorable v0.1.12 // indirect
github.com/mattn/go-isatty v0.0.17 // indirect
golang.org/x/net v0.38.0 // indirect
Expand Down
11 changes: 9 additions & 2 deletions grpc_client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,16 @@ func (c *GRPCClient) Dispense(name string) (interface{}, error) {
// ClientProtocol impl.
func (c *GRPCClient) Ping() error {
client := grpc_health_v1.NewHealthClient(c.Conn)
_, err := client.Check(context.Background(), &grpc_health_v1.HealthCheckRequest{
resp, err := client.Check(context.Background(), &grpc_health_v1.HealthCheckRequest{
Service: GRPCServiceName,
})
if err != nil {
return err
}

if resp.Status != grpc_health_v1.HealthCheckResponse_SERVING {
return fmt.Errorf("plugin %q health check returned non-SERVING status: %s", GRPCServiceName, resp.Status)
}

return err
return nil
}
6 changes: 3 additions & 3 deletions grpc_stdio.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (
"context"
"io"

empty "github.com/golang/protobuf/ptypes/empty"
"google.golang.org/protobuf/types/known/emptypb"
hclog "github.com/hashicorp/go-hclog"
"github.com/hashicorp/go-plugin/internal/plugin"
"google.golang.org/grpc"
Expand Down Expand Up @@ -49,7 +49,7 @@ func newGRPCStdioServer(log hclog.Logger, srcOut, srcErr io.Reader) *grpcStdioSe

// StreamStdio streams our stdout/err as the response.
func (s *grpcStdioServer) StreamStdio(
_ *empty.Empty,
_ *emptypb.Empty,
srv plugin.GRPCStdio_StreamStdioServer,
) error {
// Share the same data value between runs. Sending this over the wire
Expand Down Expand Up @@ -101,7 +101,7 @@ func newGRPCStdioClient(
client := plugin.NewGRPCStdioClient(conn)

// Connect immediately to the endpoint
stdioClient, err := client.StreamStdio(ctx, &empty.Empty{})
stdioClient, err := client.StreamStdio(ctx, &emptypb.Empty{})

// If we get an Unavailable or Unimplemented error, this means that the plugin isn't
// updated and linking to the latest version of go-plugin that supports
Expand Down
10 changes: 5 additions & 5 deletions plugin_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import (
"testing"
"time"

"github.com/golang/protobuf/ptypes/empty"
"google.golang.org/protobuf/types/known/emptypb"
"github.com/hashicorp/go-hclog"
grpctest "github.com/hashicorp/go-plugin/test/grpc"
"google.golang.org/grpc"
Expand Down Expand Up @@ -285,14 +285,14 @@ func (s *testGRPCServer) Bidirectional(ctx context.Context, req *grpctest.Bidire
func (s *testGRPCServer) PrintStdio(
ctx context.Context,
req *grpctest.PrintStdioRequest,
) (*empty.Empty, error) {
) (*emptypb.Empty, error) {
s.Impl.PrintStdio(req.Stdout, req.Stderr)
return &empty.Empty{}, nil
return &emptypb.Empty{}, nil
}

func (s *testGRPCServer) Panic(ctx context.Context, req *grpctest.PanicRequest) (*empty.Empty, error) {
func (s *testGRPCServer) Panic(ctx context.Context, req *grpctest.PanicRequest) (*emptypb.Empty, error) {
err := s.Impl.Panic(req.Message)
return &empty.Empty{}, err
return &emptypb.Empty{}, err
}

type pingPongServer struct {
Expand Down