Skip to content

Commit 386998f

Browse files
seidroid[bot]masih
andauthored
Backport release/v6.8: Drop gRPC names from the query service router and handlers (#4693)
Backport of #4689 to `release/v6.8`. Co-authored-by: Masih H. Derkani <m@derkani.org>
1 parent c0231bb commit 386998f

83 files changed

Lines changed: 181 additions & 182 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎app/app.go‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -593,7 +593,7 @@ func New(
593593
app.StakingKeeper,
594594
app.DistrKeeper,
595595
app.MsgServiceRouter(),
596-
app.GRPCQueryRouter(),
596+
app.QueryServiceRouter(),
597597
wasmDir,
598598
wasmConfig,
599599
supportedFeatures,
@@ -842,7 +842,7 @@ func New(
842842
)
843843

844844
app.mm.RegisterRoutes(app.Router(), app.QueryRouter(), encodingConfig.Amino)
845-
app.configurator = module.NewConfigurator(app.appCodec, app.MsgServiceRouter(), app.GRPCQueryRouter())
845+
app.configurator = module.NewConfigurator(app.appCodec, app.MsgServiceRouter(), app.QueryServiceRouter())
846846
app.mm.RegisterServices(app.configurator)
847847

848848
app.RegisterUpgradeHandlers()
@@ -2431,13 +2431,13 @@ func (app *App) RegisterAPIRoutes(apiSvr *api.Server, apiConfig config.APIConfig
24312431
// Register legacy tx routes.
24322432
authrest.RegisterTxRoutes(clientCtx, apiSvr.Router)
24332433
// Register new tx routes from grpc-gateway.
2434-
authtx.RegisterGRPCGatewayRoutes(clientCtx, apiSvr.GRPCGatewayRouter)
2434+
authtx.RegisterGatewayRoutes(clientCtx, apiSvr.GatewayRouter)
24352435
// Register new tendermint queries routes from grpc-gateway.
2436-
tmservice.RegisterGRPCGatewayRoutes(clientCtx, apiSvr.GRPCGatewayRouter)
2436+
tmservice.RegisterGatewayRoutes(clientCtx, apiSvr.GatewayRouter)
24372437

24382438
// Register legacy and grpc-gateway routes for all modules.
24392439
ModuleBasics.RegisterRESTRoutes(clientCtx, apiSvr.Router)
2440-
ModuleBasics.RegisterGRPCGatewayRoutes(clientCtx, apiSvr.GRPCGatewayRouter)
2440+
ModuleBasics.RegisterGatewayRoutes(clientCtx, apiSvr.GatewayRouter)
24412441

24422442
}
24432443

@@ -2510,8 +2510,8 @@ func (app *App) SnapshotAwareRPCContextProvider() evmrpc.TraceContextProvider {
25102510

25112511
// RegisterTendermintService implements the Application.RegisterLocalServices method.
25122512
func (app *App) RegisterLocalServices(node client.LocalClient, txConfig client.TxConfig) {
2513-
authtx.RegisterTxService(app.GRPCQueryRouter(), node, txConfig, app.Simulate, app.interfaceRegistry)
2514-
tmservice.RegisterTendermintService(app.GRPCQueryRouter(), node, app.interfaceRegistry)
2513+
authtx.RegisterTxService(app.QueryServiceRouter(), node, txConfig, app.Simulate, app.interfaceRegistry)
2514+
tmservice.RegisterTendermintService(app.QueryServiceRouter(), node, app.interfaceRegistry)
25152515
txConfigProvider := func(height int64) client.TxConfig {
25162516
if app.ChainID != "pacific-1" {
25172517
return app.encodingConfig.TxConfig

‎app/apptesting/test_suite.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ func (s *KeeperTestHelper) Setup() {
4040
s.App = app.Setup(s.T(), false, false, false)
4141
s.Ctx = s.App.NewContext(false, tmtypes.Header{Height: 1, ChainID: "sei-test", Time: time.Now().UTC()})
4242
s.QueryHelper = &baseapp.QueryServiceTestHelper{
43-
GRPCQueryRouter: s.App.GRPCQueryRouter(),
44-
Ctx: s.Ctx,
43+
QueryServiceRouter: s.App.QueryServiceRouter(),
44+
Ctx: s.Ctx,
4545
}
4646

4747
s.TestAccs = CreateRandomAccounts(3)

‎sei-cosmos/baseapp/abci.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -441,8 +441,8 @@ func (app *BaseApp) Query(ctx context.Context, req *abci.RequestQuery) (res *abc
441441

442442
// handle gRPC routes first rather than calling splitPath because '/' characters
443443
// are used as part of gRPC paths
444-
if grpcHandler := app.grpcQueryRouter.Route(req.Path); grpcHandler != nil {
445-
resp := app.handleQueryGRPC(ctx, grpcHandler, *req)
444+
if grpcHandler := app.queryServiceRouter.Route(req.Path); grpcHandler != nil {
445+
resp := app.handleQueryService(ctx, grpcHandler, *req)
446446
return &resp, nil
447447
}
448448

@@ -603,7 +603,7 @@ func (app *BaseApp) ApplySnapshotChunk(context context.Context, req *abci.Reques
603603
}
604604
}
605605

606-
func (app *BaseApp) handleQueryGRPC(ctx context.Context, handler GRPCQueryHandler, req abci.RequestQuery) abci.ResponseQuery {
606+
func (app *BaseApp) handleQueryService(ctx context.Context, handler QueryServiceHandler, req abci.RequestQuery) abci.ResponseQuery {
607607
sdkCtx, err := app.CreateQueryContext(req.Height, req.Prove)
608608
if err != nil {
609609
return sdkerrors.QueryResultWithDebug(err, app.trace)

‎sei-cosmos/baseapp/abci_query_metrics.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ var abciStoreQuerySubpaths = map[string]struct{}{
2222
// - Legacy paths use a fixed prefix + registered segment shape.
2323
// - Everything else is "other".
2424
func (app *BaseApp) abciQueryMetricRoute(reqPath string) string {
25-
if app.grpcQueryRouter != nil && app.grpcQueryRouter.Route(reqPath) != nil {
25+
if app.queryServiceRouter != nil && app.queryServiceRouter.Route(reqPath) != nil {
2626
return reqPath
2727
}
2828

‎sei-cosmos/baseapp/abci_query_metrics_test.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ func TestAbciQueryMetricRoute(t *testing.T) {
1616
db := dbm.NewMemDB()
1717
app := NewBaseApp(t.Name(), db, nil, nil, &testutil.TestAppOpts{})
1818

19-
grpcQR := app.GRPCQueryRouter()
19+
grpcQR := app.QueryServiceRouter()
2020
grpcQR.SetInterfaceRegistry(testdata.NewTestInterfaceRegistry())
2121
testdata.RegisterQueryServer(grpcQR, testdata.QueryImpl{})
2222

‎sei-cosmos/baseapp/baseapp.go‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -206,10 +206,10 @@ type appStore struct {
206206
}
207207

208208
type moduleRouter struct {
209-
router sdk.Router // handle any kind of message
210-
queryRouter sdk.QueryRouter // router for redirecting query calls
211-
grpcQueryRouter *GRPCQueryRouter // router for redirecting gRPC query calls
212-
msgServiceRouter *MsgServiceRouter // router for redirecting Msg service messages
209+
router sdk.Router // handle any kind of message
210+
queryRouter sdk.QueryRouter // router for redirecting query calls
211+
queryServiceRouter *QueryServiceRouter // router for redirecting gRPC query calls
212+
msgServiceRouter *MsgServiceRouter // router for redirecting Msg service messages
213213
}
214214

215215
type abciData struct {
@@ -282,10 +282,10 @@ func NewBaseApp(
282282
fauxMerkleMode: false,
283283
},
284284
moduleRouter: moduleRouter{
285-
router: NewRouter(),
286-
queryRouter: NewQueryRouter(),
287-
grpcQueryRouter: NewGRPCQueryRouter(),
288-
msgServiceRouter: NewMsgServiceRouter(),
285+
router: NewRouter(),
286+
queryRouter: NewQueryRouter(),
287+
queryServiceRouter: NewQueryServiceRouter(),
288+
msgServiceRouter: NewMsgServiceRouter(),
289289
},
290290
txDecoder: txDecoder,
291291
TmConfig: tmConfig,

‎sei-cosmos/baseapp/deliver_tx_test.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -323,15 +323,15 @@ func TestQuery(t *testing.T) {
323323
require.Equal(t, value, res.Value)
324324
}
325325

326-
func TestGRPCQuery(t *testing.T) {
327-
grpcQueryOpt := func(bapp *BaseApp) {
326+
func TestQueryServiceRouterQuery(t *testing.T) {
327+
queryServiceOpt := func(bapp *BaseApp) {
328328
testdata.RegisterQueryServer(
329-
bapp.GRPCQueryRouter(),
329+
bapp.QueryServiceRouter(),
330330
testdata.QueryImpl{},
331331
)
332332
}
333333

334-
app := setupBaseApp(t, grpcQueryOpt)
334+
app := setupBaseApp(t, queryServiceOpt)
335335

336336
app.InitChain(&abci.RequestInitChain{})
337337
header := tmproto.Header{Height: app.LastBlockHeight() + 1}

‎sei-cosmos/baseapp/grpcserver.go‎

Lines changed: 0 additions & 4 deletions
This file was deleted.

‎sei-cosmos/baseapp/options.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ func (app *BaseApp) SetSnapshotDirectory(dir string) {
305305
// SetInterfaceRegistry sets the InterfaceRegistry.
306306
func (app *BaseApp) SetInterfaceRegistry(registry types.InterfaceRegistry) {
307307
app.interfaceRegistry = registry
308-
app.grpcQueryRouter.SetInterfaceRegistry(registry)
308+
app.queryServiceRouter.SetInterfaceRegistry(registry)
309309
app.msgServiceRouter.SetInterfaceRegistry(registry)
310310
}
311311

sei-cosmos/baseapp/grpcrouter.go renamed to sei-cosmos/baseapp/query_service_router.go

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ import (
1717

1818
var protoCodec = encoding.GetCodec(proto.Name)
1919

20-
// GRPCQueryRouter routes ABCI Query requests to GRPC handlers
21-
type GRPCQueryRouter struct {
22-
routes map[string]GRPCQueryHandler
20+
// QueryServiceRouter routes ABCI Query requests to protobuf Query service handlers
21+
type QueryServiceRouter struct {
22+
routes map[string]QueryServiceHandler
2323
interfaceRegistry codectypes.InterfaceRegistry
2424
serviceData []serviceData
2525
}
@@ -30,22 +30,22 @@ type serviceData struct {
3030
handler interface{}
3131
}
3232

33-
var _ gogogrpc.Server = &GRPCQueryRouter{}
33+
var _ gogogrpc.Server = &QueryServiceRouter{}
3434

35-
// NewGRPCQueryRouter creates a new GRPCQueryRouter
36-
func NewGRPCQueryRouter() *GRPCQueryRouter {
37-
return &GRPCQueryRouter{
38-
routes: map[string]GRPCQueryHandler{},
35+
// NewQueryServiceRouter creates a new QueryServiceRouter
36+
func NewQueryServiceRouter() *QueryServiceRouter {
37+
return &QueryServiceRouter{
38+
routes: map[string]QueryServiceHandler{},
3939
}
4040
}
4141

42-
// GRPCQueryHandler defines a function type which handles ABCI Query requests
43-
// using gRPC
44-
type GRPCQueryHandler = func(ctx sdk.Context, req abci.RequestQuery) (abci.ResponseQuery, error)
42+
// QueryServiceHandler defines a function type which handles ABCI Query requests
43+
// with a protobuf Query service
44+
type QueryServiceHandler = func(ctx sdk.Context, req abci.RequestQuery) (abci.ResponseQuery, error)
4545

46-
// Route returns the GRPCQueryHandler for a given query route path or nil
46+
// Route returns the QueryServiceHandler for a given query route path or nil
4747
// if not found
48-
func (qrt *GRPCQueryRouter) Route(path string) GRPCQueryHandler {
48+
func (qrt *QueryServiceRouter) Route(path string) QueryServiceHandler {
4949
handler, found := qrt.routes[path]
5050
if !found {
5151
return nil
@@ -58,7 +58,7 @@ func (qrt *GRPCQueryRouter) Route(path string) GRPCQueryHandler {
5858
//
5959
// This functions PANICS:
6060
// - if a protobuf service is registered twice.
61-
func (qrt *GRPCQueryRouter) RegisterService(sd *grpc.ServiceDesc, handler interface{}) {
61+
func (qrt *QueryServiceRouter) RegisterService(sd *grpc.ServiceDesc, handler interface{}) {
6262
// adds a top-level query handler based on the gRPC service name
6363
for _, method := range sd.Methods {
6464
fqName := fmt.Sprintf("/%s/%s", sd.ServiceName, method.MethodName)
@@ -118,9 +118,12 @@ func (qrt *GRPCQueryRouter) RegisterService(sd *grpc.ServiceDesc, handler interf
118118

119119
// SetInterfaceRegistry sets the interface registry for the router. This will
120120
// also register the interface reflection gRPC service.
121-
func (qrt *GRPCQueryRouter) SetInterfaceRegistry(interfaceRegistry codectypes.InterfaceRegistry) {
121+
func (qrt *QueryServiceRouter) SetInterfaceRegistry(interfaceRegistry codectypes.InterfaceRegistry) {
122122
qrt.interfaceRegistry = interfaceRegistry
123123
// Once we have an interface registry, we can register the interface
124124
// registry reflection gRPC service.
125125
reflection.RegisterReflectionServiceServer(qrt, reflection.NewReflectionServiceServer(interfaceRegistry))
126126
}
127+
128+
// QueryServiceRouter returns the QueryServiceRouter of a BaseApp.
129+
func (app *BaseApp) QueryServiceRouter() *QueryServiceRouter { return app.queryServiceRouter }

0 commit comments

Comments
 (0)