2f98dd3838
This is a breaking GraphQL API change. All numeric values are now encoded as hex strings. The motivation for this change is matching JSON-RPC outputs more closely. Numbers in query parameters are accepted as both decimal integers and hex strings.
410 lines
16 KiB
Go
410 lines
16 KiB
Go
// Copyright 2019 The go-ethereum Authors
|
|
// This file is part of the go-ethereum library.
|
|
//
|
|
// The go-ethereum library is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Lesser General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// The go-ethereum library is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Lesser General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Lesser General Public License
|
|
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
package graphql
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"io"
|
|
"math/big"
|
|
"net/http"
|
|
"strings"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/ethereum/go-ethereum/common"
|
|
"github.com/ethereum/go-ethereum/consensus/ethash"
|
|
"github.com/ethereum/go-ethereum/core"
|
|
"github.com/ethereum/go-ethereum/core/types"
|
|
"github.com/ethereum/go-ethereum/core/vm"
|
|
"github.com/ethereum/go-ethereum/crypto"
|
|
"github.com/ethereum/go-ethereum/eth"
|
|
"github.com/ethereum/go-ethereum/eth/ethconfig"
|
|
"github.com/ethereum/go-ethereum/eth/filters"
|
|
"github.com/ethereum/go-ethereum/node"
|
|
"github.com/ethereum/go-ethereum/params"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestBuildSchema(t *testing.T) {
|
|
ddir := t.TempDir()
|
|
// Copy config
|
|
conf := node.DefaultConfig
|
|
conf.DataDir = ddir
|
|
stack, err := node.New(&conf)
|
|
if err != nil {
|
|
t.Fatalf("could not create new node: %v", err)
|
|
}
|
|
defer stack.Close()
|
|
// Make sure the schema can be parsed and matched up to the object model.
|
|
if _, err := newHandler(stack, nil, nil, []string{}, []string{}); err != nil {
|
|
t.Errorf("Could not construct GraphQL handler: %v", err)
|
|
}
|
|
}
|
|
|
|
// Tests that a graphQL request is successfully handled when graphql is enabled on the specified endpoint
|
|
func TestGraphQLBlockSerialization(t *testing.T) {
|
|
stack := createNode(t)
|
|
defer stack.Close()
|
|
genesis := &core.Genesis{
|
|
Config: params.AllEthashProtocolChanges,
|
|
GasLimit: 11500000,
|
|
Difficulty: big.NewInt(1048576),
|
|
}
|
|
newGQLService(t, stack, genesis, 10, func(i int, gen *core.BlockGen) {})
|
|
// start node
|
|
if err := stack.Start(); err != nil {
|
|
t.Fatalf("could not start node: %v", err)
|
|
}
|
|
|
|
for i, tt := range []struct {
|
|
body string
|
|
want string
|
|
code int
|
|
}{
|
|
{ // Should return latest block
|
|
body: `{"query": "{block{number}}","variables": null}`,
|
|
want: `{"data":{"block":{"number":"0xa"}}}`,
|
|
code: 200,
|
|
},
|
|
{ // Should return info about latest block
|
|
body: `{"query": "{block{number,gasUsed,gasLimit}}","variables": null}`,
|
|
want: `{"data":{"block":{"number":"0xa","gasUsed":"0x0","gasLimit":"0xaf79e0"}}}`,
|
|
code: 200,
|
|
},
|
|
{
|
|
body: `{"query": "{block(number:0){number,gasUsed,gasLimit}}","variables": null}`,
|
|
want: `{"data":{"block":{"number":"0x0","gasUsed":"0x0","gasLimit":"0xaf79e0"}}}`,
|
|
code: 200,
|
|
},
|
|
{
|
|
body: `{"query": "{block(number:-1){number,gasUsed,gasLimit}}","variables": null}`,
|
|
want: `{"data":{"block":null}}`,
|
|
code: 200,
|
|
},
|
|
{
|
|
body: `{"query": "{block(number:-500){number,gasUsed,gasLimit}}","variables": null}`,
|
|
want: `{"data":{"block":null}}`,
|
|
code: 200,
|
|
},
|
|
{
|
|
body: `{"query": "{block(number:\"0\"){number,gasUsed,gasLimit}}","variables": null}`,
|
|
want: `{"data":{"block":{"number":"0x0","gasUsed":"0x0","gasLimit":"0xaf79e0"}}}`,
|
|
code: 200,
|
|
},
|
|
{
|
|
body: `{"query": "{block(number:\"-33\"){number,gasUsed,gasLimit}}","variables": null}`,
|
|
want: `{"data":{"block":null}}`,
|
|
code: 200,
|
|
},
|
|
{
|
|
body: `{"query": "{block(number:\"1337\"){number,gasUsed,gasLimit}}","variables": null}`,
|
|
want: `{"data":{"block":null}}`,
|
|
code: 200,
|
|
},
|
|
{
|
|
body: `{"query": "{block(number:\"0x0\"){number,gasUsed,gasLimit}}","variables": null}`,
|
|
want: `{"data":{"block":{"number":"0x0","gasUsed":"0x0","gasLimit":"0xaf79e0"}}}`,
|
|
//want: `{"errors":[{"message":"strconv.ParseInt: parsing \"0x0\": invalid syntax"}],"data":{}}`,
|
|
code: 200,
|
|
},
|
|
{
|
|
body: `{"query": "{block(number:\"a\"){number,gasUsed,gasLimit}}","variables": null}`,
|
|
want: `{"errors":[{"message":"strconv.ParseInt: parsing \"a\": invalid syntax"}],"data":{}}`,
|
|
code: 400,
|
|
},
|
|
{
|
|
body: `{"query": "{bleh{number}}","variables": null}"`,
|
|
want: `{"errors":[{"message":"Cannot query field \"bleh\" on type \"Query\".","locations":[{"line":1,"column":2}]}]}`,
|
|
code: 400,
|
|
},
|
|
// should return `estimateGas` as decimal
|
|
{
|
|
body: `{"query": "{block{ estimateGas(data:{}) }}"}`,
|
|
want: `{"data":{"block":{"estimateGas":"0xcf08"}}}`,
|
|
code: 200,
|
|
},
|
|
// should return `status` as decimal
|
|
{
|
|
body: `{"query": "{block {number call (data : {from : \"0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b\", to: \"0x6295ee1b4f6dd65047762f924ecd367c17eabf8f\", data :\"0x12a7b914\"}){data status}}}"}`,
|
|
want: `{"data":{"block":{"number":"0xa","call":{"data":"0x","status":"0x1"}}}}`,
|
|
code: 200,
|
|
},
|
|
} {
|
|
resp, err := http.Post(fmt.Sprintf("%s/graphql", stack.HTTPEndpoint()), "application/json", strings.NewReader(tt.body))
|
|
if err != nil {
|
|
t.Fatalf("could not post: %v", err)
|
|
}
|
|
bodyBytes, err := io.ReadAll(resp.Body)
|
|
resp.Body.Close()
|
|
if err != nil {
|
|
t.Fatalf("could not read from response body: %v", err)
|
|
}
|
|
if have := string(bodyBytes); have != tt.want {
|
|
t.Errorf("testcase %d %s,\nhave:\n%v\nwant:\n%v", i, tt.body, have, tt.want)
|
|
}
|
|
if tt.code != resp.StatusCode {
|
|
t.Errorf("testcase %d %s,\nwrong statuscode, have: %v, want: %v", i, tt.body, resp.StatusCode, tt.code)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestGraphQLBlockSerializationEIP2718(t *testing.T) {
|
|
// Account for signing txes
|
|
var (
|
|
key, _ = crypto.HexToECDSA("b71c71a67e1177ad4e901695e1b4b9ee17ae16c6668d313eac2f96dbcda3f291")
|
|
address = crypto.PubkeyToAddress(key.PublicKey)
|
|
funds = big.NewInt(1000000000000000)
|
|
dad = common.HexToAddress("0x0000000000000000000000000000000000000dad")
|
|
)
|
|
stack := createNode(t)
|
|
defer stack.Close()
|
|
genesis := &core.Genesis{
|
|
Config: params.AllEthashProtocolChanges,
|
|
GasLimit: 11500000,
|
|
Difficulty: big.NewInt(1048576),
|
|
Alloc: core.GenesisAlloc{
|
|
address: {Balance: funds},
|
|
// The address 0xdad sloads 0x00 and 0x01
|
|
dad: {
|
|
Code: []byte{byte(vm.PC), byte(vm.PC), byte(vm.SLOAD), byte(vm.SLOAD)},
|
|
Nonce: 0,
|
|
Balance: big.NewInt(0),
|
|
},
|
|
},
|
|
BaseFee: big.NewInt(params.InitialBaseFee),
|
|
}
|
|
signer := types.LatestSigner(genesis.Config)
|
|
newGQLService(t, stack, genesis, 1, func(i int, gen *core.BlockGen) {
|
|
gen.SetCoinbase(common.Address{1})
|
|
tx, _ := types.SignNewTx(key, signer, &types.LegacyTx{
|
|
Nonce: uint64(0),
|
|
To: &dad,
|
|
Value: big.NewInt(100),
|
|
Gas: 50000,
|
|
GasPrice: big.NewInt(params.InitialBaseFee),
|
|
})
|
|
gen.AddTx(tx)
|
|
tx, _ = types.SignNewTx(key, signer, &types.AccessListTx{
|
|
ChainID: genesis.Config.ChainID,
|
|
Nonce: uint64(1),
|
|
To: &dad,
|
|
Gas: 30000,
|
|
GasPrice: big.NewInt(params.InitialBaseFee),
|
|
Value: big.NewInt(50),
|
|
AccessList: types.AccessList{{
|
|
Address: dad,
|
|
StorageKeys: []common.Hash{{0}},
|
|
}},
|
|
})
|
|
gen.AddTx(tx)
|
|
})
|
|
// start node
|
|
if err := stack.Start(); err != nil {
|
|
t.Fatalf("could not start node: %v", err)
|
|
}
|
|
|
|
for i, tt := range []struct {
|
|
body string
|
|
want string
|
|
code int
|
|
}{
|
|
{
|
|
body: `{"query": "{block {number transactions { from { address } to { address } value hash type accessList { address storageKeys } index}}}"}`,
|
|
want: `{"data":{"block":{"number":"0x1","transactions":[{"from":{"address":"0x71562b71999873db5b286df957af199ec94617f7"},"to":{"address":"0x0000000000000000000000000000000000000dad"},"value":"0x64","hash":"0xd864c9d7d37fade6b70164740540c06dd58bb9c3f6b46101908d6339db6a6a7b","type":"0x0","accessList":[],"index":"0x0"},{"from":{"address":"0x71562b71999873db5b286df957af199ec94617f7"},"to":{"address":"0x0000000000000000000000000000000000000dad"},"value":"0x32","hash":"0x19b35f8187b4e15fb59a9af469dca5dfa3cd363c11d372058c12f6482477b474","type":"0x1","accessList":[{"address":"0x0000000000000000000000000000000000000dad","storageKeys":["0x0000000000000000000000000000000000000000000000000000000000000000"]}],"index":"0x1"}]}}}`,
|
|
code: 200,
|
|
},
|
|
} {
|
|
resp, err := http.Post(fmt.Sprintf("%s/graphql", stack.HTTPEndpoint()), "application/json", strings.NewReader(tt.body))
|
|
if err != nil {
|
|
t.Fatalf("could not post: %v", err)
|
|
}
|
|
bodyBytes, err := io.ReadAll(resp.Body)
|
|
resp.Body.Close()
|
|
if err != nil {
|
|
t.Fatalf("could not read from response body: %v", err)
|
|
}
|
|
if have := string(bodyBytes); have != tt.want {
|
|
t.Errorf("testcase %d %s,\nhave:\n%v\nwant:\n%v", i, tt.body, have, tt.want)
|
|
}
|
|
if tt.code != resp.StatusCode {
|
|
t.Errorf("testcase %d %s,\nwrong statuscode, have: %v, want: %v", i, tt.body, resp.StatusCode, tt.code)
|
|
}
|
|
}
|
|
}
|
|
|
|
// Tests that a graphQL request is not handled successfully when graphql is not enabled on the specified endpoint
|
|
func TestGraphQLHTTPOnSamePort_GQLRequest_Unsuccessful(t *testing.T) {
|
|
stack := createNode(t)
|
|
defer stack.Close()
|
|
if err := stack.Start(); err != nil {
|
|
t.Fatalf("could not start node: %v", err)
|
|
}
|
|
body := strings.NewReader(`{"query": "{block{number}}","variables": null}`)
|
|
resp, err := http.Post(fmt.Sprintf("%s/graphql", stack.HTTPEndpoint()), "application/json", body)
|
|
if err != nil {
|
|
t.Fatalf("could not post: %v", err)
|
|
}
|
|
resp.Body.Close()
|
|
// make sure the request is not handled successfully
|
|
assert.Equal(t, http.StatusNotFound, resp.StatusCode)
|
|
}
|
|
|
|
func TestGraphQLConcurrentResolvers(t *testing.T) {
|
|
var (
|
|
key, _ = crypto.GenerateKey()
|
|
addr = crypto.PubkeyToAddress(key.PublicKey)
|
|
dadStr = "0x0000000000000000000000000000000000000dad"
|
|
dad = common.HexToAddress(dadStr)
|
|
genesis = &core.Genesis{
|
|
Config: params.AllEthashProtocolChanges,
|
|
GasLimit: 11500000,
|
|
Difficulty: big.NewInt(1048576),
|
|
Alloc: core.GenesisAlloc{
|
|
addr: {Balance: big.NewInt(params.Ether)},
|
|
dad: {
|
|
// LOG0(0, 0), LOG0(0, 0), RETURN(0, 0)
|
|
Code: common.Hex2Bytes("60006000a060006000a060006000f3"),
|
|
Nonce: 0,
|
|
Balance: big.NewInt(0),
|
|
},
|
|
},
|
|
}
|
|
signer = types.LatestSigner(genesis.Config)
|
|
stack = createNode(t)
|
|
)
|
|
defer stack.Close()
|
|
|
|
var tx *types.Transaction
|
|
handler, chain := newGQLService(t, stack, genesis, 1, func(i int, gen *core.BlockGen) {
|
|
tx, _ = types.SignNewTx(key, signer, &types.LegacyTx{To: &dad, Gas: 100000, GasPrice: big.NewInt(params.InitialBaseFee)})
|
|
gen.AddTx(tx)
|
|
tx, _ = types.SignNewTx(key, signer, &types.LegacyTx{To: &dad, Nonce: 1, Gas: 100000, GasPrice: big.NewInt(params.InitialBaseFee)})
|
|
gen.AddTx(tx)
|
|
tx, _ = types.SignNewTx(key, signer, &types.LegacyTx{To: &dad, Nonce: 2, Gas: 100000, GasPrice: big.NewInt(params.InitialBaseFee)})
|
|
gen.AddTx(tx)
|
|
})
|
|
// start node
|
|
if err := stack.Start(); err != nil {
|
|
t.Fatalf("could not start node: %v", err)
|
|
}
|
|
|
|
for i, tt := range []struct {
|
|
body string
|
|
want string
|
|
}{
|
|
// Multiple txes race to get/set the block hash.
|
|
{
|
|
body: "{block { transactions { logs { account { address } } } } }",
|
|
want: fmt.Sprintf(`{"block":{"transactions":[{"logs":[{"account":{"address":"%s"}},{"account":{"address":"%s"}}]},{"logs":[{"account":{"address":"%s"}},{"account":{"address":"%s"}}]},{"logs":[{"account":{"address":"%s"}},{"account":{"address":"%s"}}]}]}}`, dadStr, dadStr, dadStr, dadStr, dadStr, dadStr),
|
|
},
|
|
// Multiple fields of a tx race to resolve it. Happens in this case
|
|
// because resolving the tx body belonging to a log is delayed.
|
|
{
|
|
body: `{block { logs(filter: {}) { transaction { nonce value gasPrice }}}}`,
|
|
want: `{"block":{"logs":[{"transaction":{"nonce":"0x0","value":"0x0","gasPrice":"0x3b9aca00"}},{"transaction":{"nonce":"0x0","value":"0x0","gasPrice":"0x3b9aca00"}},{"transaction":{"nonce":"0x1","value":"0x0","gasPrice":"0x3b9aca00"}},{"transaction":{"nonce":"0x1","value":"0x0","gasPrice":"0x3b9aca00"}},{"transaction":{"nonce":"0x2","value":"0x0","gasPrice":"0x3b9aca00"}},{"transaction":{"nonce":"0x2","value":"0x0","gasPrice":"0x3b9aca00"}}]}}`,
|
|
},
|
|
// Multiple txes of a block race to set/retrieve receipts of a block.
|
|
{
|
|
body: "{block { transactions { status gasUsed } } }",
|
|
want: `{"block":{"transactions":[{"status":"0x1","gasUsed":"0x5508"},{"status":"0x1","gasUsed":"0x5508"},{"status":"0x1","gasUsed":"0x5508"}]}}`,
|
|
},
|
|
// Multiple fields of block race to resolve header and body.
|
|
{
|
|
body: "{ block { number hash gasLimit ommerCount transactionCount totalDifficulty } }",
|
|
want: fmt.Sprintf(`{"block":{"number":"0x1","hash":"%s","gasLimit":"0xaf79e0","ommerCount":"0x0","transactionCount":"0x3","totalDifficulty":"0x200000"}}`, chain[len(chain)-1].Hash()),
|
|
},
|
|
// Multiple fields of a block race to resolve the header and body.
|
|
{
|
|
body: fmt.Sprintf(`{ transaction(hash: "%s") { block { number hash gasLimit ommerCount transactionCount } } }`, tx.Hash()),
|
|
want: fmt.Sprintf(`{"transaction":{"block":{"number":"0x1","hash":"%s","gasLimit":"0xaf79e0","ommerCount":"0x0","transactionCount":"0x3"}}}`, chain[len(chain)-1].Hash()),
|
|
},
|
|
// Account fields race the resolve the state object.
|
|
{
|
|
body: fmt.Sprintf(`{ block { account(address: "%s") { balance transactionCount code } } }`, dadStr),
|
|
want: `{"block":{"account":{"balance":"0x0","transactionCount":"0x0","code":"0x60006000a060006000a060006000f3"}}}`,
|
|
},
|
|
// Test values for a non-existent account.
|
|
{
|
|
body: fmt.Sprintf(`{ block { account(address: "%s") { balance transactionCount code } } }`, "0x1111111111111111111111111111111111111111"),
|
|
want: `{"block":{"account":{"balance":"0x0","transactionCount":"0x0","code":"0x"}}}`,
|
|
},
|
|
} {
|
|
res := handler.Schema.Exec(context.Background(), tt.body, "", map[string]interface{}{})
|
|
if res.Errors != nil {
|
|
t.Fatalf("failed to execute query for testcase #%d: %v", i, res.Errors)
|
|
}
|
|
have, err := json.Marshal(res.Data)
|
|
if err != nil {
|
|
t.Fatalf("failed to encode graphql response for testcase #%d: %s", i, err)
|
|
}
|
|
if string(have) != tt.want {
|
|
t.Errorf("response unmatch for testcase #%d.\nExpected:\n%s\nGot:\n%s\n", i, tt.want, have)
|
|
}
|
|
}
|
|
}
|
|
|
|
func createNode(t *testing.T) *node.Node {
|
|
stack, err := node.New(&node.Config{
|
|
HTTPHost: "127.0.0.1",
|
|
HTTPPort: 0,
|
|
WSHost: "127.0.0.1",
|
|
WSPort: 0,
|
|
HTTPTimeouts: node.DefaultConfig.HTTPTimeouts,
|
|
})
|
|
if err != nil {
|
|
t.Fatalf("could not create node: %v", err)
|
|
}
|
|
return stack
|
|
}
|
|
|
|
func newGQLService(t *testing.T, stack *node.Node, gspec *core.Genesis, genBlocks int, genfunc func(i int, gen *core.BlockGen)) (*handler, []*types.Block) {
|
|
ethConf := ðconfig.Config{
|
|
Genesis: gspec,
|
|
Ethash: ethash.Config{
|
|
PowMode: ethash.ModeFake,
|
|
},
|
|
NetworkId: 1337,
|
|
TrieCleanCache: 5,
|
|
TrieCleanCacheJournal: "triecache",
|
|
TrieCleanCacheRejournal: 60 * time.Minute,
|
|
TrieDirtyCache: 5,
|
|
TrieTimeout: 60 * time.Minute,
|
|
SnapshotCache: 5,
|
|
}
|
|
ethBackend, err := eth.New(stack, ethConf)
|
|
if err != nil {
|
|
t.Fatalf("could not create eth backend: %v", err)
|
|
}
|
|
// Create some blocks and import them
|
|
chain, _ := core.GenerateChain(params.AllEthashProtocolChanges, ethBackend.BlockChain().Genesis(),
|
|
ethash.NewFaker(), ethBackend.ChainDb(), genBlocks, genfunc)
|
|
_, err = ethBackend.BlockChain().InsertChain(chain)
|
|
if err != nil {
|
|
t.Fatalf("could not create import blocks: %v", err)
|
|
}
|
|
// Set up handler
|
|
filterSystem := filters.NewFilterSystem(ethBackend.APIBackend, filters.Config{})
|
|
handler, err := newHandler(stack, ethBackend.APIBackend, filterSystem, []string{}, []string{})
|
|
if err != nil {
|
|
t.Fatalf("could not create graphql service: %v", err)
|
|
}
|
|
return handler, chain
|
|
}
|