Add proper support for Any in gRPC queries (cosmos#6594)

* Add proper gRPC Any support via AnyUnpacker

* Wire up grpc query router AnyUnpacker

Author: aaronc

baseapp/baseapp.go

@@ -5,7 +5,6 @@ import (
 	"reflect"
 	"strings"
 
-	"github.com/gogo/protobuf/grpc"
 	"github.com/gogo/protobuf/proto"
 
 	abci "github.com/tendermint/tendermint/abci/types"
@@ -292,7 +291,7 @@ func (app *BaseApp) Router() sdk.Router {
 func (app *BaseApp) QueryRouter() sdk.QueryRouter { return app.queryRouter }
 
 // GRPCQueryRouter returns the GRPCQueryRouter of a BaseApp.
-func (app *BaseApp) GRPCQueryRouter() grpc.Server { return app.grpcQueryRouter }
+func (app *BaseApp) GRPCQueryRouter() *GRPCQueryRouter { return app.grpcQueryRouter }
 
 // Seal seals a BaseApp. It prohibits any further modifications to a BaseApp.
 func (app *BaseApp) Seal() { app.sealed = true }

baseapp/grpcrouter.go

@@ -3,6 +3,8 @@ package baseapp
 import (
 	"fmt"
 
+	"github.com/cosmos/cosmos-sdk/codec/types"
+
 	gogogrpc "github.com/gogo/protobuf/grpc"
 	abci "github.com/tendermint/tendermint/abci/types"
 	"google.golang.org/grpc"
@@ -16,7 +18,8 @@ var protoCodec = encoding.GetCodec(proto.Name)
 
 // GRPCQueryRouter routes ABCI Query requests to GRPC handlers
 type GRPCQueryRouter struct {
-	routes map[string]GRPCQueryHandler
+	routes      map[string]GRPCQueryHandler
+	anyUnpacker types.AnyUnpacker
 }
 
 var _ gogogrpc.Server
@@ -54,7 +57,14 @@ func (qrt *GRPCQueryRouter) RegisterService(sd *grpc.ServiceDesc, handler interf
 			// call the method handler from the service description with the handler object,
 			// a wrapped sdk.Context with proto-unmarshaled data from the ABCI request data
 			res, err := methodHandler(handler, sdk.WrapSDKContext(ctx), func(i interface{}) error {
-				return protoCodec.Unmarshal(req.Data, i)
+				err := protoCodec.Unmarshal(req.Data, i)
+				if err != nil {
+					return err
+				}
+				if qrt.anyUnpacker != nil {
+					return types.UnpackInterfaces(i, qrt.anyUnpacker)
+				}
+				return nil
 			}, nil)
 			if err != nil {
 				return abci.ResponseQuery{}, err
@@ -74,3 +84,13 @@ func (qrt *GRPCQueryRouter) RegisterService(sd *grpc.ServiceDesc, handler interf
 		}
 	}
 }
+
+// AnyUnpacker returns the AnyUnpacker for the router
+func (qrt *GRPCQueryRouter) AnyUnpacker() types.AnyUnpacker {
+	return qrt.anyUnpacker
+}
+
+// SetAnyUnpacker sets the AnyUnpacker for the router
+func (qrt *GRPCQueryRouter) SetAnyUnpacker(anyUnpacker types.AnyUnpacker) {
+	qrt.anyUnpacker = anyUnpacker
+}

baseapp/grpcrouter_helpers.go

@@ -4,6 +4,8 @@ import (
 	gocontext "context"
 	"fmt"
 
+	"github.com/cosmos/cosmos-sdk/codec/types"
+
 	gogogrpc "github.com/gogo/protobuf/grpc"
 	abci "github.com/tendermint/tendermint/abci/types"
 	"google.golang.org/grpc"
@@ -22,8 +24,10 @@ type QueryServiceTestHelper struct {
 
 // NewQueryServerTestHelper creates a new QueryServiceTestHelper that wraps
 // the provided sdk.Context
-func NewQueryServerTestHelper(ctx sdk.Context) *QueryServiceTestHelper {
-	return &QueryServiceTestHelper{GRPCQueryRouter: NewGRPCQueryRouter(), ctx: ctx}
+func NewQueryServerTestHelper(ctx sdk.Context, anyUnpacker types.AnyUnpacker) *QueryServiceTestHelper {
+	qrt := NewGRPCQueryRouter()
+	qrt.SetAnyUnpacker(anyUnpacker)
+	return &QueryServiceTestHelper{GRPCQueryRouter: qrt, ctx: ctx}
 }
 
 // Invoke implements the grpc ClientConn.Invoke method
@@ -36,12 +40,22 @@ func (q *QueryServiceTestHelper) Invoke(_ gocontext.Context, method string, args
 	if err != nil {
 		return err
 	}
+
 	res, err := querier(q.ctx, abci.RequestQuery{Data: reqBz})
+	if err != nil {
+		return err
+	}
 
+	err = protoCodec.Unmarshal(res.Value, reply)
 	if err != nil {
 		return err
 	}
-	return protoCodec.Unmarshal(res.Value, reply)
+
+	if q.anyUnpacker != nil {
+		return types.UnpackInterfaces(reply, q.anyUnpacker)
+	}
+
+	return nil
 }
 
 // NewStream implements the grpc ClientConn.NewStream method

baseapp/grpcrouter_test.go

@@ -4,6 +4,8 @@ import (
 	"context"
 	"testing"
 
+	"github.com/cosmos/cosmos-sdk/codec/types"
+
 	"github.com/stretchr/testify/require"
 
 	"github.com/cosmos/cosmos-sdk/codec/testdata"
@@ -12,6 +14,8 @@ import (
 
 func TestGRPCRouter(t *testing.T) {
 	qr := NewGRPCQueryRouter()
+	interfaceRegistry := testdata.NewTestInterfaceRegistry()
+	qr.SetAnyUnpacker(interfaceRegistry)
 	testdata.RegisterTestServiceServer(qr, testdata.TestServiceImpl{})
 	helper := &QueryServiceTestHelper{
 		GRPCQueryRouter: qr,
@@ -32,4 +36,12 @@ func TestGRPCRouter(t *testing.T) {
 	require.Nil(t, err)
 	require.NotNil(t, res)
 	require.Equal(t, "Hello Foo!", res2.Greeting)
+
+	spot := &testdata.Dog{Name: "Spot", Size_: "big"}
+	any, err := types.NewAnyWithValue(spot)
+	require.NoError(t, err)
+	res3, err := client.TestAny(context.Background(), &testdata.TestAnyRequest{AnyAnimal: any})
+	require.NoError(t, err)
+	require.NotNil(t, res3)
+	require.Equal(t, spot, res3.HasAnimal.Animal.GetCachedValue())
 }

client/context.go

@@ -7,6 +7,8 @@ import (
 	"io"
 	"os"
 
+	codectypes "github.com/cosmos/cosmos-sdk/codec/types"
+
 	"github.com/pkg/errors"
 	"github.com/spf13/viper"
 	yaml "gopkg.in/yaml.v2"
@@ -25,29 +27,30 @@ import (
 // Context implements a typical context created in SDK modules for transaction
 // handling and queries.
 type Context struct {
-	FromAddress      sdk.AccAddress
-	Client           rpcclient.Client
-	ChainID          string
-	JSONMarshaler    codec.JSONMarshaler
-	Input            io.Reader
-	Keyring          keyring.Keyring
-	Output           io.Writer
-	OutputFormat     string
-	Height           int64
-	HomeDir          string
-	From             string
-	BroadcastMode    string
-	FromName         string
-	TrustNode        bool
-	UseLedger        bool
-	Simulate         bool
-	GenerateOnly     bool
-	Offline          bool
-	SkipConfirm      bool
-	TxGenerator      TxGenerator
-	AccountRetriever AccountRetriever
-	NodeURI          string
-	Verifier         tmlite.Verifier
+	FromAddress       sdk.AccAddress
+	Client            rpcclient.Client
+	ChainID           string
+	JSONMarshaler     codec.JSONMarshaler
+	InterfaceRegistry codectypes.InterfaceRegistry
+	Input             io.Reader
+	Keyring           keyring.Keyring
+	Output            io.Writer
+	OutputFormat      string
+	Height            int64
+	HomeDir           string
+	From              string
+	BroadcastMode     string
+	FromName          string
+	TrustNode         bool
+	UseLedger         bool
+	Simulate          bool
+	GenerateOnly      bool
+	Offline           bool
+	SkipConfirm       bool
+	TxGenerator       TxGenerator
+	AccountRetriever  AccountRetriever
+	NodeURI           string
+	Verifier          tmlite.Verifier
 
 	// TODO: Deprecated (remove).
 	Codec *codec.Codec
@@ -328,6 +331,12 @@ func (ctx Context) WithAccountRetriever(retriever AccountRetriever) Context {
 	return ctx
 }
 
+// WithInterfaceRegistry returns the context with an updated InterfaceRegistry
+func (ctx Context) WithInterfaceRegistry(interfaceRegistry codectypes.InterfaceRegistry) Context {
+	ctx.InterfaceRegistry = interfaceRegistry
+	return ctx
+}
+
 // PrintOutput outputs toPrint to the ctx.Output based on ctx.OutputFormat which is
 // either text or json. If text, toPrint will be YAML encoded. Otherwise, toPrint
 // will be JSON encoded using ctx.JSONMarshaler. An error is returned upon failure.

client/grpc_query.go

@@ -4,6 +4,7 @@ import (
 	gocontext "context"
 	"fmt"
 
+	"github.com/cosmos/cosmos-sdk/codec/types"
 	gogogrpc "github.com/gogo/protobuf/grpc"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/encoding"
@@ -24,7 +25,17 @@ func (ctx Context) Invoke(_ gocontext.Context, method string, args, reply interf
 	if err != nil {
 		return err
 	}
-	return protoCodec.Unmarshal(resBz, reply)
+
+	err = protoCodec.Unmarshal(resBz, reply)
+	if err != nil {
+		return err
+	}
+
+	if ctx.InterfaceRegistry != nil {
+		return types.UnpackInterfaces(reply, ctx.InterfaceRegistry)
+	}
+
+	return nil
 }
 
 // NewStream implements the grpc ClientConn.NewStream method