R4R: generalize query response with height

.pending/improvements/sdk/4573-adds-height-in-

@@ -0,0 +1 @@
+#4573 adds height in response for validator endpoints

client/rpc/block.go

@@ -131,7 +131,7 @@ func BlockRequestHandlerFn(cliCtx context.CLIContext) http.HandlerFunc {
  rest.WriteErrorResponse(w, http.StatusInternalServerError, err.Error())
  return
  }
- rest.PostProcessResponse(w, cliCtx, output)
+ rest.PostProcessResponse(w, cliCtx, output, 0)
  }
 }
 
@@ -144,6 +144,6 @@ func LatestBlockRequestHandlerFn(cliCtx context.CLIContext) http.HandlerFunc {
  return
  }
 
- rest.PostProcessResponse(w, cliCtx, output)
+ rest.PostProcessResponse(w, cliCtx, output, 0)
  }
 }

client/rpc/status.go

@@ -78,7 +78,7 @@ func NodeInfoRequestHandlerFn(cliCtx context.CLIContext) http.HandlerFunc {
  }
 
  nodeInfo := status.NodeInfo
- rest.PostProcessResponse(w, cliCtx, nodeInfo)
+ rest.PostProcessResponse(w, cliCtx, nodeInfo, 0)
  }
 }
 

client/rpc/validators.go

@@ -176,7 +176,7 @@ func ValidatorSetRequestHandlerFn(cliCtx context.CLIContext) http.HandlerFunc {
  rest.WriteErrorResponse(w, http.StatusInternalServerError, err.Error())
  return
  }
- rest.PostProcessResponse(w, cliCtx, output)
+ rest.PostProcessResponse(w, cliCtx, output, 0)
  }
 }
 
@@ -189,6 +189,6 @@ func LatestValidatorSetRequestHandlerFn(cliCtx context.CLIContext) http.HandlerF
  return
  }
 
- rest.PostProcessResponse(w, cliCtx, output)
+ rest.PostProcessResponse(w, cliCtx, output, 0)
  }
 }

types/rest/rest.go

@@ -3,6 +3,7 @@
 package rest
 
 import (
+ "encoding/json"
  "errors"
  "fmt"
  "io/ioutil"
@@ -222,9 +223,17 @@ func ParseQueryHeightOrReturnBadRequest(w http.ResponseWriter, cliCtx context.CL
 }
 
 // PostProcessResponse performs post processing for a REST response.
-func PostProcessResponse(w http.ResponseWriter, cliCtx context.CLIContext, response interface{}) {
+// If the height is greater than zero it will be injected into the body of
+// the response.An internal server error is written to the response if the
+// height is negative or an encoding/decoding error occurs.
+func PostProcessResponse(w http.ResponseWriter, cliCtx context.CLIContext, response interface{}, height int64) {
  var output []byte
 
+ if height < 0 {
+ WriteErrorResponse(w, http.StatusInternalServerError, fmt.Errorf("negative height").Error())
+ return
+ }
+
  switch response.(type) {
  case []byte:
  output = response.([]byte)
@@ -236,6 +245,32 @@ func PostProcessResponse(w http.ResponseWriter, cliCtx context.CLIContext, respo
  } else {
  output, err = cliCtx.Codec.MarshalJSON(response)
  }
+
+ if err != nil {
+ WriteErrorResponse(w, http.StatusInternalServerError, err.Error())
+ return
+ }
+ }
+
+ // inject the height into the response by:
+ // - decoding into a map
+ // - adding the height to the map
+ // - encoding using standard JSON library
+ if height > 0 {
+ m := make(map[string]interface{})
+ err := json.Unmarshal(output, &m)
+ if err != nil {
+ WriteErrorResponse(w, http.StatusInternalServerError, err.Error())
+ return
+ }
+
+ m["height"] = height
+
+ if cliCtx.Indent {
+ output, err = json.MarshalIndent(m, "", " ")
+ } else {
+ output, err = json.Marshal(m)
+ }
  if err != nil {
  WriteErrorResponse(w, http.StatusInternalServerError, err.Error())
  return

types/rest/rest_test.go

@@ -3,15 +3,22 @@
 package rest
 
 import (
+ "encoding/json"
+ "fmt"
  "io"
+ "io/ioutil"
  "net/http"
  "net/http/httptest"
+ "strconv"
  "testing"
 
- "github.com/cosmos/cosmos-sdk/client/context"
  "github.com/stretchr/testify/require"
+ "github.com/tendermint/tendermint/crypto/secp256k1"
 
+ "github.com/cosmos/cosmos-sdk/client/context"
+ "github.com/cosmos/cosmos-sdk/codec"
  "github.com/cosmos/cosmos-sdk/types"
+ authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
 )
 
 type mockResponseWriter struct{}
@@ -138,6 +145,93 @@ func TestParseQueryHeight(t *testing.T) {
  }
 }
 
+func TestProcessPostResponse(t *testing.T) {
+ // setup
+ ctx := context.NewCLIContext()
+ height := int64(194423)
+
+ privKey := secp256k1.GenPrivKey()
+ pubKey := privKey.PubKey()
+ addr := types.AccAddress(pubKey.Address())
+ coins := types.NewCoins(types.NewCoin("atom", types.NewInt(100)), types.NewCoin("tree", types.NewInt(125)))
+ accNumber := uint64(104)
+ sequence := uint64(32)
+
+ acc := authtypes.NewBaseAccount(addr, coins, pubKey, accNumber, sequence)
+ cdc := codec.New()
+ authtypes.RegisterBaseAccount(cdc)
+ ctx = ctx.WithCodec(cdc)
+
+ // setup expected json responses with zero height
+ jsonNoHeight, err := cdc.MarshalJSON(acc)
+ require.Nil(t, err)
+ require.NotNil(t, jsonNoHeight)
+ jsonIndentNoHeight, err := cdc.MarshalJSONIndent(acc, "", " ")
+ require.Nil(t, err)
+ require.NotNil(t, jsonIndentNoHeight)
+
+ // decode into map to order alphabetically
+ m := make(map[string]interface{})
+ err = json.Unmarshal(jsonNoHeight, &m)
+ require.Nil(t, err)
+ jsonMap, err := json.Marshal(m)
+ require.Nil(t, err)
+ jsonWithHeight := append(append([]byte(`{"height":`), []byte(strconv.Itoa(int(height))+",")...), jsonMap[1:]...)
+ jsonIndentMap, err := json.MarshalIndent(m, "", " ")
+ jsonIndentWithHeight := append(append([]byte(`{`+"\n "+` "height": `), []byte(strconv.Itoa(int(height))+",")...), jsonIndentMap[1:]...)
+
+ // check that negative height writes an error
+ w := httptest.NewRecorder()
+ PostProcessResponse(w, ctx, acc, -1)
+ require.Equal(t, http.StatusInternalServerError, w.Code)
+
+ // check that zero height returns expected response
+ runPostProcessResponse(t, ctx, acc, jsonNoHeight, 0, false)
+ // chcek zero height with indent
+ runPostProcessResponse(t, ctx, acc, jsonIndentNoHeight, 0, true)
+ // check that height returns expected response
+ runPostProcessResponse(t, ctx, acc, jsonWithHeight, height, false)
+ // check height with indent
+ runPostProcessResponse(t, ctx, acc, jsonIndentWithHeight, height, true)
+}
+
+// asserts that ResponseRecorder returns the expected code and body
+// runs PostProcessResponse on the objects regular interface and on
+// the marshalled struct.
+func runPostProcessResponse(t *testing.T, ctx context.CLIContext, obj interface{},
+ expectedBody []byte, height int64, indent bool,
+) {
+ if indent {
+ ctx.Indent = indent
+ }
+
+ // test using regular struct
+ w := httptest.NewRecorder()
+ PostProcessResponse(w, ctx, obj, height)
+ require.Equal(t, http.StatusOK, w.Code, w.Body)
+ resp := w.Result()
+ body, err := ioutil.ReadAll(resp.Body)
+ require.Nil(t, err)
+ require.Equal(t, expectedBody, body)
+
+ var marshalled []byte
+ if indent {
+ marshalled, err = ctx.Codec.MarshalJSONIndent(obj, "", " ")
+ } else {
+ marshalled, err = ctx.Codec.MarshalJSON(obj)
+ }
+ require.Nil(t, err)
+
+ // test using marshalled struct
+ w = httptest.NewRecorder()
+ PostProcessResponse(w, ctx, marshalled, height)
+ require.Equal(t, http.StatusOK, w.Code, w.Body)
+ resp = w.Result()
+ body, err = ioutil.ReadAll(resp.Body)
+ require.Nil(t, err)
+ require.Equal(t, expectedBody, body)
+}
+
 func mustNewRequest(t *testing.T, method, url string, body io.Reader) *http.Request {
  req, err := http.NewRequest(method, url, body)
  require.NoError(t, err)

x/auth/client/rest/broadcast.go

@@ -48,6 +48,6 @@ func BroadcastTxRequest(cliCtx context.CLIContext) http.HandlerFunc {
  return
  }
 
- rest.PostProcessResponse(w, cliCtx, res)
+ rest.PostProcessResponse(w, cliCtx, res, 0)
  }
 }

x/auth/client/rest/encode.go

@@ -45,6 +45,6 @@ func EncodeTxRequestHandlerFn(cliCtx context.CLIContext) http.HandlerFunc {
  txBytesBase64 := base64.StdEncoding.EncodeToString(txBytes)
 
  response := EncodeResp{Tx: txBytesBase64}
- rest.PostProcessResponse(w, cliCtx, response)
+ rest.PostProcessResponse(w, cliCtx, response, 0)
  }
 }

x/auth/client/rest/query.go

@@ -14,13 +14,6 @@ import (
  "github.com/cosmos/cosmos-sdk/x/auth/types"
 )
 
-// AccountWithHeight wraps the embedded Account with the height it was queried
-// at.
-type AccountWithHeight struct {
- types.Account `json:"account"`
- Height int64 `json:"height"`
-}
-
 // query accountREST Handler
 func QueryAccountRequestHandlerFn(storeName string, cliCtx context.CLIContext) http.HandlerFunc {
 
@@ -42,7 +35,7 @@ func QueryAccountRequestHandlerFn(storeName string, cliCtx context.CLIContext) h
  accGetter := types.NewAccountRetriever(cliCtx)
  // the query will return empty account if there is no data
  if err := accGetter.EnsureExists(addr); err != nil {
- rest.PostProcessResponse(w, cliCtx, types.BaseAccount{})
+ rest.PostProcessResponse(w, cliCtx, types.BaseAccount{}, cliCtx.Height)
  return
  }
 
@@ -52,7 +45,7 @@ func QueryAccountRequestHandlerFn(storeName string, cliCtx context.CLIContext) h
  return
  }
 
- rest.PostProcessResponse(w, cliCtx, AccountWithHeight{account, cliCtx.Height})
+ rest.PostProcessResponse(w, cliCtx, account, cliCtx.Height)
  }
 }
 
@@ -79,7 +72,7 @@ func QueryTxsByTagsRequestHandlerFn(cliCtx context.CLIContext) http.HandlerFunc
  }
 
  if len(r.Form) == 0 {
- rest.PostProcessResponse(w, cliCtx, txs)
+ rest.PostProcessResponse(w, cliCtx, txs, cliCtx.Height)
  return
  }
 
@@ -95,7 +88,7 @@ func QueryTxsByTagsRequestHandlerFn(cliCtx context.CLIContext) http.HandlerFunc
  return
  }
 
- rest.PostProcessResponse(w, cliCtx, searchResult)
+ rest.PostProcessResponse(w, cliCtx, searchResult, cliCtx.Height)
  }
 }
 
@@ -125,6 +118,6 @@ func QueryTxRequestHandlerFn(cliCtx context.CLIContext) http.HandlerFunc {
  rest.WriteErrorResponse(w, http.StatusNotFound, fmt.Sprintf("no transaction found with hash %s", hashHexStr))
  }
 
- rest.PostProcessResponse(w, cliCtx, output)
+ rest.PostProcessResponse(w, cliCtx, output, cliCtx.Height)
  }
 }

x/bank/client/rest/query.go

@@ -37,18 +37,18 @@ func QueryBalancesRequestHandlerFn(cliCtx context.CLIContext) http.HandlerFunc {
  return
  }
 
- res, _, err := cliCtx.QueryWithData("custom/bank/balances", bz)
+ res, height, err := cliCtx.QueryWithData("custom/bank/balances", bz)
  if err != nil {
  rest.WriteErrorResponse(w, http.StatusInternalServerError, err.Error())
  return
  }
 
  // the query will return empty if there is no data for this account
  if len(res) == 0 {
- rest.PostProcessResponse(w, cliCtx, sdk.Coins{})
+ rest.PostProcessResponse(w, cliCtx, sdk.Coins{}, height)
  return
  }
 
- rest.PostProcessResponse(w, cliCtx, res)
+ rest.PostProcessResponse(w, cliCtx, res, height)
  }
 }