add page flag for CLI queries (cosmos#6824)

* add page flag for CLI queries * fix review suggestions * Fix `page` flag default value * fix offset calc * Apply suggestions from code review Co-authored-by: Aaron Craelius <[email protected]> * fix review suggestions * refactor * fix returning error Co-authored-by: SaReN <[email protected]> Co-authored-by: Aaron Craelius <[email protected]> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
jackywww · Jul 24, 2020 · e906c01 · e906c01
1 parent 1538e65
commit e906c01
Show file tree

Hide file tree

Showing 10 changed files with 74 additions and 22 deletions.
diff --git a/client/flags/flags.go b/client/flags/flags.go
@@ -112,6 +112,7 @@ func AddTxFlagsToCmd(cmd *cobra.Command) {
 
 // AddPaginationFlagsToCmd adds common pagination flags to cmd
 func AddPaginationFlagsToCmd(cmd *cobra.Command, query string) {
+	cmd.Flags().Uint64(FlagPage, 1, fmt.Sprintf("pagination page of %s to query for. This sets offset to a multiple of limit", query))
 	cmd.Flags().String(FlagPageKey, "", fmt.Sprintf("pagination page-key of %s to query for", query))
 	cmd.Flags().Uint64(FlagOffset, 0, fmt.Sprintf("pagination offset of %s to query for", query))
 	cmd.Flags().Uint64(FlagLimit, 100, fmt.Sprintf("pagination limit of %s to query for", query))

diff --git a/client/utils.go b/client/utils.go
@@ -4,6 +4,7 @@ import (
 	"github.com/spf13/pflag"
 
 	"github.com/cosmos/cosmos-sdk/client/flags"
+	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
 	"github.com/cosmos/cosmos-sdk/types/query"
 )
 
@@ -44,16 +45,25 @@ func Paginate(numObjs, page, limit, defLimit int) (start, end int) {
 }
 
 // ReadPageRequest reads and builds the necessary page request flags for pagination.
-func ReadPageRequest(flagSet *pflag.FlagSet) *query.PageRequest {
+func ReadPageRequest(flagSet *pflag.FlagSet) (*query.PageRequest, error) {
 	pageKey, _ := flagSet.GetString(flags.FlagPageKey)
 	offset, _ := flagSet.GetUint64(flags.FlagOffset)
 	limit, _ := flagSet.GetUint64(flags.FlagLimit)
 	countTotal, _ := flagSet.GetBool(flags.FlagCountTotal)
+	page, _ := flagSet.GetUint64(flags.FlagPage)
+
+	if page > 1 && offset > 0 {
+		return nil, sdkerrors.Wrap(sdkerrors.ErrInvalidRequest, "page and offset cannot be used together")
+	}
+
+	if page > 1 {
+		offset = (page - 1) * limit
+	}
 
 	return &query.PageRequest{
 		Key:        []byte(pageKey),
 		Offset:     offset,
 		Limit:      limit,
 		CountTotal: countTotal,
-	}
+	}, nil
 }
diff --git a/x/bank/client/cli/query.go b/x/bank/client/cli/query.go
@@ -72,7 +72,11 @@ Example:
 				return err
 			}
 
-			pageReq := client.ReadPageRequest(cmd.Flags())
+			pageReq, err := client.ReadPageRequest(cmd.Flags())
+			if err != nil {
+				return err
+			}
+
 			if denom == "" {
 				params := types.NewQueryAllBalancesRequest(addr, pageReq)
 

diff --git a/x/distribution/client/cli/query.go b/x/distribution/client/cli/query.go
@@ -191,7 +191,10 @@ $ %s query distribution slashes cosmosvaloper1gghjut3ccd8ay0zduzj64hwre2fxs9ldmq
 				return fmt.Errorf("end-height %s not a valid uint, please input a valid end-height", args[2])
 			}
 
-			pageReq := client.ReadPageRequest(cmd.Flags())
+			pageReq, err := client.ReadPageRequest(cmd.Flags())
+			if err != nil {
+				return err
+			}
 
 			res, err := queryClient.ValidatorSlashes(
 				context.Background(),

diff --git a/x/evidence/client/cli/query.go b/x/evidence/client/cli/query.go
@@ -62,7 +62,12 @@ func QueryEvidenceCmd() func(*cobra.Command, []string) error {
 			return queryEvidence(clientCtx, hash)
 		}
 
-		return queryAllEvidence(clientCtx, client.ReadPageRequest(cmd.Flags()))
+		pageReq, err := client.ReadPageRequest(cmd.Flags())
+		if err != nil {
+			return err
+		}
+
+		return queryAllEvidence(clientCtx, pageReq)
 	}
 }
 

diff --git a/x/gov/client/cli/query.go b/x/gov/client/cli/query.go
@@ -136,7 +136,10 @@ $ %s query gov proposals --page=2 --limit=100
 			}
 			queryClient := types.NewQueryClient(clientCtx)
 
-			pageReq := client.ReadPageRequest(cmd.Flags())
+			pageReq, err := client.ReadPageRequest(cmd.Flags())
+			if err != nil {
+				return err
+			}
 
 			res, err := queryClient.Proposals(
 				context.Background(),
@@ -299,7 +302,10 @@ $ %[1]s query gov votes 1 --page=2 --limit=100
 
 			}
 
-			pageReq := client.ReadPageRequest(cmd.Flags())
+			pageReq, err := client.ReadPageRequest(cmd.Flags())
+			if err != nil {
+				return err
+			}
 
 			res, err := queryClient.Votes(
 				context.Background(),
@@ -314,9 +320,6 @@ $ %[1]s query gov votes 1 --page=2 --limit=100
 		},
 	}
 
-	// Deprecated, remove line when removing FlagPage altogether.
-	cmd.Flags().Int(flags.FlagPage, 1, "pagination page of proposals to query for")
-
 	flags.AddPaginationFlagsToCmd(cmd, "votes")
 	flags.AddQueryFlagsToCmd(cmd)
 
@@ -446,7 +449,10 @@ $ %s query gov deposits 1
 				return clientCtx.PrintOutput(dep)
 			}
 
-			pageReq := client.ReadPageRequest(cmd.Flags())
+			pageReq, err := client.ReadPageRequest(cmd.Flags())
+			if err != nil {
+				return err
+			}
 
 			res, err := queryClient.Deposits(
 				context.Background(),

diff --git a/x/ibc/03-connection/client/cli/query.go b/x/ibc/03-connection/client/cli/query.go
@@ -32,8 +32,13 @@ func GetCmdQueryConnections() *cobra.Command {
 
 			queryClient := types.NewQueryClient(clientCtx)
 
+			pageReq, err := client.ReadPageRequest(cmd.Flags())
+			if err != nil {
+				return err
+			}
+
 			req := &types.QueryConnectionsRequest{
-				Pagination: client.ReadPageRequest(cmd.Flags()),
+				Pagination: pageReq,
 			}
 
 			res, err := queryClient.Connections(context.Background(), req)

diff --git a/x/ibc/04-channel/client/cli/query.go b/x/ibc/04-channel/client/cli/query.go
@@ -37,8 +37,13 @@ func GetCmdQueryChannels() *cobra.Command {
 			}
 			queryClient := types.NewQueryClient(clientCtx)
 
+			pageReq, err := client.ReadPageRequest(cmd.Flags())
+			if err != nil {
+				return err
+			}
+
 			req := &types.QueryChannelsRequest{
-				Pagination: client.ReadPageRequest(cmd.Flags()),
+				Pagination: pageReq,
 			}
 
 			res, err := queryClient.Channels(context.Background(), req)
@@ -110,10 +115,14 @@ func GetCmdQueryConnectionChannels() *cobra.Command {
 				return err
 			}
 			queryClient := types.NewQueryClient(clientCtx)
+			pageReq, err := client.ReadPageRequest(cmd.Flags())
+			if err != nil {
+				return err
+			}
 
 			req := &types.QueryConnectionChannelsRequest{
 				Connection: args[0],
-				Pagination: client.ReadPageRequest(cmd.Flags()),
+				Pagination: pageReq,
 			}
 
 			res, err := queryClient.ConnectionChannels(context.Background(), req)
@@ -181,11 +190,15 @@ func GetCmdQueryPacketCommitments() *cobra.Command {
 				return err
 			}
 			queryClient := types.NewQueryClient(clientCtx)
+			pageReq, err := client.ReadPageRequest(cmd.Flags())
+			if err != nil {
+				return err
+			}
 
 			req := &types.QueryPacketCommitmentsRequest{
 				PortID:     args[0],
 				ChannelID:  args[1],
-				Pagination: client.ReadPageRequest(cmd.Flags()),
+				Pagination: pageReq,
 			}
 
 			res, err := queryClient.PacketCommitments(context.Background(), req)

diff --git a/x/slashing/client/cli/query.go b/x/slashing/client/cli/query.go
@@ -93,7 +93,12 @@ $ <appcli> query slashing signing-infos
 
 			queryClient := types.NewQueryClient(clientCtx)
 
-			params := &types.QuerySigningInfosRequest{Pagination: client.ReadPageRequest(cmd.Flags())}
+			pageReq, err := client.ReadPageRequest(cmd.Flags())
+			if err != nil {
+				return err
+			}
+
+			params := &types.QuerySigningInfosRequest{Pagination: pageReq}
 			res, err := queryClient.SigningInfos(context.Background(), params)
 			if err != nil {
 				return err

diff --git a/x/staking/client/cli/query.go b/x/staking/client/cli/query.go
@@ -164,7 +164,7 @@ $ %s query staking unbonding-delegations-from cosmosvaloper1gghjut3ccd8ay0zduzj6
 				return err
 			}
 
-			pageReq := client.ReadPageRequest(cmd.Flags())
+			pageReq, err := client.ReadPageRequest(cmd.Flags())
 			if err != nil {
 				return err
 			}
@@ -219,7 +219,7 @@ $ %s query staking redelegations-from cosmosvaloper1gghjut3ccd8ay0zduzj64hwre2fx
 				return err
 			}
 
-			pageReq := client.ReadPageRequest(cmd.Flags())
+			pageReq, err := client.ReadPageRequest(cmd.Flags())
 			if err != nil {
 				return err
 			}
@@ -327,7 +327,7 @@ $ %s query staking delegations cosmos1gghjut3ccd8ay0zduzj64hwre2fxs9ld75ru9p
 				return err
 			}
 
-			pageReq := client.ReadPageRequest(cmd.Flags())
+			pageReq, err := client.ReadPageRequest(cmd.Flags())
 			if err != nil {
 				return err
 			}
@@ -382,7 +382,7 @@ $ %s query staking delegations-to cosmosvaloper1gghjut3ccd8ay0zduzj64hwre2fxs9ld
 				return err
 			}
 
-			pageReq := client.ReadPageRequest(cmd.Flags())
+			pageReq, err := client.ReadPageRequest(cmd.Flags())
 			if err != nil {
 				return err
 			}
@@ -491,7 +491,7 @@ $ %s query staking unbonding-delegations cosmos1gghjut3ccd8ay0zduzj64hwre2fxs9ld
 				return err
 			}
 
-			pageReq := client.ReadPageRequest(cmd.Flags())
+			pageReq, err := client.ReadPageRequest(cmd.Flags())
 			if err != nil {
 				return err
 			}
@@ -606,7 +606,7 @@ $ %s query staking redelegation cosmos1gghjut3ccd8ay0zduzj64hwre2fxs9ld75ru9p
 				return err
 			}
 
-			pageReq := client.ReadPageRequest(cmd.Flags())
+			pageReq, err := client.ReadPageRequest(cmd.Flags())
 			if err != nil {
 				return err
 			}