-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add tests to jsonrpc, starting w/ opstack
- Loading branch information
Showing
11 changed files
with
3,290 additions
and
45 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| package jsonrpc | ||
|
|
||
| import ( | ||
| "context" | ||
| "log/slog" | ||
| "net/http" | ||
|
|
||
| "github.com/hashicorp/go-retryablehttp" | ||
| ) | ||
|
|
||
| type HTTPClient interface { | ||
| Do(req *retryablehttp.Request) (*http.Response, error) | ||
| } | ||
|
|
||
| func NewHTTPClient(log *slog.Logger) *retryablehttp.Client { | ||
| client := retryablehttp.NewClient() | ||
| client.RetryMax = MaxRetries | ||
| client.Logger = log | ||
| checkRetry := func(ctx context.Context, resp *http.Response, err error) (bool, error) { | ||
| yes, err2 := retryablehttp.DefaultRetryPolicy(ctx, resp, err) | ||
| if yes { | ||
| if resp == nil { | ||
| log.Warn("Retrying request to RPC client", "error", err2) | ||
| } else { | ||
| log.Warn("Retrying request to RPC client", "statusCode", resp.Status, "error", err2) | ||
| } | ||
| } | ||
| return yes, err2 | ||
| } | ||
| client.CheckRetry = checkRetry | ||
| client.Backoff = retryablehttp.LinearJitterBackoff | ||
| client.HTTPClient.Timeout = DefaultRequestTimeout | ||
| return client | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| package jsonrpc_test | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "encoding/json" | ||
| "fmt" | ||
| "io" | ||
| "log" | ||
| "log/slog" | ||
| "net/http" | ||
| "os" | ||
|
|
||
| "github.com/davecgh/go-spew/spew" | ||
| "github.com/duneanalytics/blockchain-ingester/client/jsonrpc" | ||
| jsonrpc_mock "github.com/duneanalytics/blockchain-ingester/mocks/jsonrpc" | ||
| "github.com/duneanalytics/blockchain-ingester/models" | ||
| "github.com/hashicorp/go-retryablehttp" | ||
| ) | ||
|
|
||
| type jsonRPCRequest struct { | ||
| Method string `json:"method"` | ||
| Params []interface{} `json:"params"` | ||
| HTTPHeaders http.Header | ||
| } | ||
|
|
||
| type jsonRPCResponse struct { | ||
| Body io.Reader | ||
| StatusCode int // optional, default to 200 | ||
| ContentType string // optional, default to "application/json" | ||
| } | ||
|
|
||
| type MockedRequest struct { | ||
| Req jsonRPCRequest | ||
| Resp jsonRPCResponse | ||
| } | ||
|
|
||
| func MockHTTPRequests(requests []MockedRequest) *jsonrpc_mock.HTTPClientMock { | ||
| return &jsonrpc_mock.HTTPClientMock{ | ||
| DoFunc: func(req *retryablehttp.Request) (*http.Response, error) { | ||
| if req.Method != http.MethodPost { | ||
| return nil, fmt.Errorf("expected POST method, got %s", req.Method) | ||
| } | ||
| // we use httpretryable.Client, so we can't use req.Body directly | ||
| // we need to read the body and then reset it | ||
|
|
||
| body, err := req.BodyBytes() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| var jsonReq jsonRPCRequest | ||
| if err := json.Unmarshal(body, &jsonReq); err != nil { | ||
| return nil, err | ||
| } | ||
| jsonReqParams := fmt.Sprintf("%+v", jsonReq.Params) | ||
| // looking for a matching request | ||
| for _, r := range requests { | ||
| if r.Req.Method == jsonReq.Method { | ||
| // we do this because reflect.DeepEquals() Comparison fails on map[string]any != map[string]string | ||
| if jsonReqParams != fmt.Sprintf("%+v", r.Req.Params) { | ||
| continue | ||
| } | ||
| // this is a match, validate registered headers | ||
| for k, v := range r.Req.HTTPHeaders { | ||
| if req.Header.Get(k) != v[0] { | ||
| return nil, fmt.Errorf("expected header %s to be %s, got %s", k, v[0], req.Header.Get(k)) | ||
| } | ||
| } | ||
| // all headers match, return the response | ||
| resp := &http.Response{ | ||
| StatusCode: 200, | ||
| Body: io.NopCloser(r.Resp.Body), | ||
| Header: make(http.Header), | ||
| } | ||
| if r.Resp.StatusCode != 0 { | ||
| resp.StatusCode = r.Resp.StatusCode | ||
| } | ||
| resp.Header.Set("Content-Type", "application/json") | ||
| if r.Resp.ContentType != "" { | ||
| resp.Header.Set("Content-Type", r.Resp.ContentType) | ||
| } | ||
| return resp, nil | ||
| } | ||
| } | ||
| if jsonReq.Method == "eth_blockNumber" { | ||
| resp := &http.Response{ | ||
| StatusCode: 200, | ||
| Body: io.NopCloser(bytes.NewReader([]byte(`{"jsonrpc":"2.0","id":1,"result":"0x7a549b"}`))), | ||
| } | ||
| return resp, nil | ||
| } | ||
| return nil, fmt.Errorf("no matching request found, req: %+v", jsonReq) | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| func NewTestLogger() *slog.Logger { | ||
| return slog.New(slog.NewTextHandler(io.Discard, nil)) | ||
| } | ||
|
|
||
| func NewTestRPCClient(httpClient jsonrpc.HTTPClient, stack models.EVMStack) (jsonrpc.BlockchainClient, error) { | ||
| return jsonrpc.NewRPCClient(NewTestLogger(), httpClient, jsonrpc.Config{EVMStack: stack}) | ||
| } | ||
|
|
||
| func readFileForTest(filename string) *bytes.Buffer { | ||
| data, err := os.ReadFile(filename) | ||
| if err != nil { | ||
| log.Panicf("Failed to read file: %v", err) | ||
| } | ||
| return bytes.NewBuffer(data) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| package jsonrpc_test | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
|
|
||
| "github.com/duneanalytics/blockchain-ingester/models" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestOpStackBasic(t *testing.T) { | ||
| getBlockByNumberResponse := readFileForTest("testdata/opstack-eth_getBlockByNumber.json") | ||
| getBlockReceiptsResponse := readFileForTest("testdata/opstack-eth_getBlockReceipts.json") | ||
| debugtraceBlockByNumberResponse := readFileForTest("testdata/opstack-debug_traceBlockByNumber.json") | ||
| blockNumberHex := "0x7a549b" | ||
| blockNumber := int64(8017051) | ||
| httpClientMock := MockHTTPRequests( | ||
| []MockedRequest{ | ||
| { | ||
| Req: jsonRPCRequest{ | ||
| Method: "eth_getBlockByNumber", | ||
| Params: []interface{}{blockNumberHex, true}, | ||
| }, | ||
| Resp: jsonRPCResponse{ | ||
| Body: getBlockByNumberResponse, | ||
| }, | ||
| }, | ||
| { | ||
| Req: jsonRPCRequest{ | ||
| Method: "eth_getBlockReceipts", | ||
| Params: []interface{}{blockNumberHex}, | ||
| }, | ||
| Resp: jsonRPCResponse{ | ||
| Body: getBlockReceiptsResponse, | ||
| }, | ||
| }, | ||
| { | ||
| Req: jsonRPCRequest{ | ||
| Method: "debug_traceBlockByNumber", | ||
| Params: []interface{}{blockNumberHex, map[string]string{"tracer": "callTracer"}}, | ||
| }, | ||
| Resp: jsonRPCResponse{ | ||
| Body: debugtraceBlockByNumberResponse, | ||
| }, | ||
| }, | ||
| }) | ||
|
|
||
| opstack, err := NewTestRPCClient(httpClientMock, models.OpStack) | ||
| require.NoError(t, err) | ||
|
|
||
| block, err := opstack.BlockByNumber(context.Background(), blockNumber) | ||
| require.NoError(t, err) | ||
| require.NotNil(t, block) | ||
| require.Equal(t, blockNumber, block.BlockNumber) | ||
| require.False(t, block.Errored()) | ||
| } |
Oops, something went wrong.