[api]fix JsonRPC api response id type doesn't match request type (#4168)

Author: millken

api/web3server.go

@@ -243,8 +243,19 @@ func (svr *web3Handler) handleWeb3Req(ctx context.Context, web3Req *gjson.Result
 	} else {
 		log.Logger("api").Debug("web3Debug", zap.String("response", fmt.Sprintf("%+v", res)))
 	}
+	var id any
+	reqID := web3Req.Get("id")
+	switch reqID.Type {
+	case gjson.String:
+		id = reqID.String()
+	case gjson.Number:
+		id = reqID.Int()
+	default:
+		id = 0
+		res, err = nil, errors.New("invalid id type")
+	}
 	size, err1 = writer.Write(&web3Response{
-		id:     int(web3Req.Get("id").Int()),
+		id:     id,
 		result: res,
 		err:    err,
 	})

api/web3server_marshal.go

@@ -24,7 +24,7 @@ const (
 
 type (
 	web3Response struct {
-		id     int
+		id     any
 		result interface{}
 		err    error
 	}
@@ -95,7 +95,7 @@ func (obj *web3Response) MarshalJSON() ([]byte, error) {
 	if obj.err == nil {
 		return json.Marshal(&struct {
 			Jsonrpc string      `json:"jsonrpc"`
-			ID      int         `json:"id"`
+			ID      any         `json:"id"`
 			Result  interface{} `json:"result"`
 		}{
 			Jsonrpc: "2.0",
@@ -117,7 +117,7 @@ func (obj *web3Response) MarshalJSON() ([]byte, error) {
 
 	return json.Marshal(&struct {
 		Jsonrpc string     `json:"jsonrpc"`
-		ID      int        `json:"id"`
+		ID      any        `json:"id"`
 		Error   errMessage `json:"error"`
 	}{
 		Jsonrpc: "2.0",

api/web3server_test.go

@@ -1266,3 +1266,37 @@ func TestDebugTraceCall(t *testing.T) {
 	require.Empty(rlt.Revert)
 	require.Equal(0, len(rlt.StructLogs))
 }
+
+func TestResponseIDMatchTypeWithRequest(t *testing.T) {
+	require := require.New(t)
+	ctrl := gomock.NewController(t)
+	defer ctrl.Finish()
+	core := mock_apicoreservice.NewMockCoreService(ctrl)
+	core.EXPECT().TipHeight().Return(uint64(1)).AnyTimes()
+	core.EXPECT().Track(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).Return().AnyTimes()
+	svr := newHTTPHandler(NewWeb3Handler(core, "", _defaultBatchRequestLimit))
+	getServerResp := func(svr *hTTPHandler, req *http.Request) *httptest.ResponseRecorder {
+		req.Header.Set("Content-Type", "application/json")
+		resp := httptest.NewRecorder()
+		svr.ServeHTTP(resp, req)
+		return resp
+	}
+	tests := []struct {
+		req string
+		sub string
+	}{
+		{`{"jsonrpc":"2.0","method":"eth_blockNumber","id":1}`, `"id":1`},
+		{`{"jsonrpc":"2.0","method":"eth_blockNumber","id":"1"}`, `"id":"1"`},
+		{`{"jsonrpc":"2.0","method":"eth_blockNumber","id":"0x32"}`, `"id":"0x32"`},
+		{`{"jsonrpc":"2.0","method":"eth_blockNumber","id":[]}`, `error`},
+		{`{"jsonrpc":"2.0","method":"eth_blockNumber","id":[1]}`, `error`},
+		{`{"jsonrpc":"2.0","method":"eth_blockNumber","id":0x32}`, `error`},
+		{`{"jsonrpc":"2.0","method":"eth_blockNumber","id":{1}}`, `error`},
+	}
+	for _, tt := range tests {
+		request, _ := http.NewRequest(http.MethodPost, "http://url.com", strings.NewReader(tt.req))
+		response := getServerResp(svr, request)
+		bodyBytes, _ := io.ReadAll(response.Body)
+		require.Contains(string(bodyBytes), tt.sub)
+	}
+}