Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add getHeader SSZ support #734

Open
wants to merge 49 commits into
base: develop
Choose a base branch
from
Open

Add getHeader SSZ support #734

wants to merge 49 commits into from

Conversation

jtraglia
Copy link
Collaborator

@jtraglia jtraglia commented Feb 5, 2025

πŸ“ Summary

This PR adds SSZ support for getHeader endpoint. Please see:

βœ… I have run these commands

  • make lint
  • make test-race
  • go mod tidy

@0xTylerHolmes
Copy link
Contributor

0xTylerHolmes commented Feb 5, 2025

I think they are fine, but two things that caught my attention:

  1. Reusing a request object (it is fine if body == nil)
  2. Double close scenarios (io.Closer specifies that calls to Close after first call is considered undefined; though I think it is fine here)

First thought that addresses both of these and simplifies things a bit is if we define a doRequest function inside get_header that we can use to handle both the SSZ and JSON request attempts:

doRequest := func(accept string) (*http.Response, error) {
                req, err := http.NewRequestWithContext(context.Background(), http.MethodGet, url, nil)
                if err != nil {
                    return nil, err
                }
                // <insert request prep>
                req.Header.Set("Accept", accept)
                return m.httpClientGetHeader.Do(req)
            }

Then we can do something like:

            // ssz attempt
            resp, err := doRequest("application/octet-stream")
            if err != nil {
                …
                return
            }
            // json if relay does not support ssz
            if resp.StatusCode == http.StatusNotAcceptable {
                resp.Body.Close()
                logRelay.Debug("SSZ not accepted, trying JSON")
                resp, err = doRequest("application/json")
                if err != nil {
                    …
		    return
                }
            }
            defer resp.Body.Close()
            // continue rest of execution
            ...

edit: get_header should probably use a context that we pass to the NewRequestWithContext so we can handle timeouts.

server/get_header.go Outdated Show resolved Hide resolved
server/get_header.go Outdated Show resolved Hide resolved
server/get_header.go Outdated Show resolved Hide resolved
server/accept.go Outdated Show resolved Hide resolved
server/accept.go Outdated Show resolved Hide resolved
server/service.go Outdated Show resolved Hide resolved
server/service.go Outdated Show resolved Hide resolved
server/service.go Outdated Show resolved Hide resolved
server/service.go Outdated Show resolved Hide resolved
server/service.go Outdated Show resolved Hide resolved
server/service.go Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants