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

Don't re-use empty body on retry #255

Merged
merged 4 commits into from
Jan 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion goshopify.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ package goshopify
import (
"bytes"
"encoding/json"
"errors"
"fmt"
"io"
"io/ioutil"
Expand Down Expand Up @@ -347,8 +348,19 @@ func (c *Client) doGetHeaders(req *http.Request, v interface{}) (http.Header, er
c.attempts = 0
c.logRequest(req)

// copy request body so it can be re-used
var body []byte
if req.Body != nil {
body, err = ioutil.ReadAll(req.Body)
defer req.Body.Close()
if err != nil {
return nil, err
}
}

for {
c.attempts++
req.Body = ioutil.NopCloser(bytes.NewBuffer(body))
oliver006 marked this conversation as resolved.
Show resolved Hide resolved
resp, err = c.Client.Do(req)
c.logResponse(resp)
if err != nil {
Expand Down Expand Up @@ -443,7 +455,10 @@ func (c *Client) logBody(body *io.ReadCloser, format string) {
if body == nil {
return
}
b, _ := ioutil.ReadAll(*body)
b, err := ioutil.ReadAll(*body)
if err != nil && !errors.Is(err, io.EOF) {
return
}
if len(b) > 0 {
c.log.Debugf(format, string(b))
}
Expand Down
62 changes: 60 additions & 2 deletions goshopify_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,10 @@ var (
// errReader can be used to simulate a failed call to response.Body.Read
type errReader struct{}

var testErr = errors.New("test-error")

func (errReader) Read([]byte) (int, error) {
return 0, errors.New("test-error")
return 0, testErr
}

func (errReader) Close() error {
Expand Down Expand Up @@ -350,6 +352,24 @@ func TestDo(t *testing.T) {
}
}

func TestDoErrBody(t *testing.T) {
shopUrl := "https://fooshop.myshopify.com"
httpmock.RegisterResponder("GET", shopUrl, httpmock.NewStringResponder(200, ""))

req, err := http.NewRequest("GET", shopUrl, errReader{})
if err != nil {
t.Error("error creating request: ", err)
}

err = client.Do(req, nil)
if err == nil {
t.Errorf("Do(): expected error test-error, actual nil")
}
if !errors.Is(err, testErr) {
t.Errorf("Do(): expected ResponseDecodingError, actual %#v", err)
}
}

func TestRetry(t *testing.T) {
setup()
defer teardown()
Expand Down Expand Up @@ -462,6 +482,44 @@ func TestRetry(t *testing.T) {
}
}

func TestRetryPost(t *testing.T) {
u := "foo/1"
responder := func(req *http.Request) (*http.Response, error) {
resp := httpmock.NewStringResponse(http.StatusTooManyRequests, `{"errors":"Exceeded 2 calls per second for api client. Reduce request rates to resume uninterrupted service."}`)
resp.Header.Add("Retry-After", "2.0")
body, err := ioutil.ReadAll(req.Body)
if err != nil {
return nil, err
}
if len(body) == 0 {
return nil, errors.New("empty body")
}
return resp, nil
}
expected := RateLimitError{
RetryAfter: 2,
ResponseError: ResponseError{
Status: 429,
Message: "Exceeded 2 calls per second for api client. Reduce request rates to resume uninterrupted service.",
},
}

testClient := NewClient(app, "fooshop", "abcd", WithRetry(2))
httpmock.ActivateNonDefault(testClient.Client)
shopUrl := fmt.Sprintf("https://fooshop.myshopify.com/%v", u)
httpmock.RegisterResponder("POST", shopUrl, responder)

testBody := []byte(`{"foo": "bar"}`)
req, err := testClient.NewRequest("POST", u, testBody, nil)
if err != nil {
t.Errorf("TestRetryPost(): errored %s", err)
}
err = testClient.Do(req, nil)
if !reflect.DeepEqual(err, expected) {
t.Errorf("Do(): expected error %#v, actual %#v", expected, err)
}
}

func TestClientDoAutoApiVersion(t *testing.T) {
u := "foo/1"
responder := func(req *http.Request) (*http.Response, error) {
Expand Down Expand Up @@ -736,7 +794,7 @@ func TestCheckResponseError(t *testing.T) {
},
{
&http.Response{StatusCode: 400, Body: errReader{}},
errors.New("test-error"),
testErr,
},
{
httpmock.NewStringResponse(422, `{"error": "Unprocessable Entity - ok"}`),
Expand Down