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.

Sign up for GitHub

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

Backport of fix: stale querystring parameter value as boolean into release/1.3.x #15653

Merged
merged 9 commits into from
Jan 3, 2023
Merged

Backport of fix: stale querystring parameter value as boolean into release/1.3.x #15653

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c0c1f5e
backport of commit af36e5211bc10952afae105d3d13c908751bd19c
dttung2905 Dec 21, 2022
ad823ea
backport of commit 62018ee913ceeec20898f3eeb311f934689b0615
dttung2905 Dec 21, 2022
3def99b
backport of commit 4ed12c970750da796c5fbf00189fbd2cab9c5748
dttung2905 Dec 22, 2022
ee3ed7e
backport of commit b4141e78e5caf23417b092625ae7258a9c453278
dttung2905 Dec 22, 2022
c5d6e0d
backport of commit 4daf080609584e1534523dad8334b191f8ed2923
dttung2905 Dec 22, 2022
61fd1e0
backport of commit 9776b92920e194eee688f95b9eb519b32366ea50
dttung2905 Dec 22, 2022
4baa46e
backport of commit f00ed4133a095168434b9200fc4d7e3ada5541c6
dttung2905 Dec 22, 2022
93f682b
backport of commit 5a50a71ab69af9f3f1f9d6f5bae91267b4cd11a3
dttung2905 Dec 23, 2022
111fda8
backport of commit 70c9b3676bbda25388d64eccdf2fb433ccef404a
dttung2905 Dec 24, 2022
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
3 changes: 3 additions & 0 deletions .changelog/15605.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:bug
api: Fix stale querystring parameter value as boolean
```
14 changes: 10 additions & 4 deletions command/agent/http.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -760,10 +760,16 @@ func parseWait(resp http.ResponseWriter, req *http.Request, b *structs.QueryOpti
}

// parseConsistency is used to parse the ?stale query params.
func parseConsistency(req *http.Request, b *structs.QueryOptions) {
func parseConsistency(resp http.ResponseWriter, req *http.Request, b *structs.QueryOptions) {
query := req.URL.Query()
if _, ok := query["stale"]; ok {
b.AllowStale = true
if staleVal, ok := query["stale"]; ok {
staleQuery, err := strconv.ParseBool(staleVal[0])
if err != nil {
resp.WriteHeader(400)
resp.Write([]byte(fmt.Sprintf("Expect `true` or `false` for `stale` query string parameter, got %s", staleVal[0])))
}

b.AllowStale = staleQuery || staleVal[0] == ""
}
}

Expand Down Expand Up @@ -861,7 +867,7 @@ func (s *HTTPServer) parseToken(req *http.Request, token *string) {
func (s *HTTPServer) parse(resp http.ResponseWriter, req *http.Request, r *string, b *structs.QueryOptions) bool {
s.parseRegion(req, r)
s.parseToken(req, &b.AuthToken)
parseConsistency(req, b)
parseConsistency(resp, req, b)
parsePrefix(req, b)
parseNamespace(req, &b.Namespace)
parsePagination(req, b)
Expand Down
43 changes: 26 additions & 17 deletions command/agent/http_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import (
"github.com/hashicorp/nomad/nomad/structs"
"github.com/hashicorp/nomad/nomad/structs/config"
"github.com/hashicorp/nomad/testutil"
"github.com/shoenig/test/must"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
Expand Down Expand Up @@ -476,29 +477,37 @@ func TestParseWait_InvalidIndex(t *testing.T) {
func TestParseConsistency(t *testing.T) {
ci.Parallel(t)
var b structs.QueryOptions
var resp *httptest.ResponseRecorder

req, err := http.NewRequest("GET",
"/v1/catalog/nodes?stale", nil)
if err != nil {
t.Fatalf("err: %v", err)
testCases := [2]string{"/v1/catalog/nodes?stale", "/v1/catalog/nodes?stale=true"}
for _, urlPath := range testCases {
req, err := http.NewRequest("GET", urlPath, nil)
must.NoError(t, err)
resp = httptest.NewRecorder()
parseConsistency(resp, req, &b)
must.True(t, b.AllowStale)
}

parseConsistency(req, &b)
if !b.AllowStale {
t.Fatalf("Bad: %v", b)
}
req, err := http.NewRequest("GET", "/v1/catalog/nodes?stale=false", nil)
must.NoError(t, err)
resp = httptest.NewRecorder()
parseConsistency(resp, req, &b)
must.False(t, b.AllowStale)

req, err = http.NewRequest("GET", "/v1/catalog/nodes?stale=random", nil)
must.NoError(t, err)
resp = httptest.NewRecorder()
parseConsistency(resp, req, &b)
must.False(t, b.AllowStale)
must.EqOp(t, 400, resp.Code)

b = structs.QueryOptions{}
req, err = http.NewRequest("GET",
"/v1/catalog/nodes?consistent", nil)
if err != nil {
t.Fatalf("err: %v", err)
}
req, err = http.NewRequest("GET", "/v1/catalog/nodes?consistent", nil)
must.NoError(t, err)

parseConsistency(req, &b)
if b.AllowStale {
t.Fatalf("Bad: %v", b)
}
resp = httptest.NewRecorder()
parseConsistency(resp, req, &b)
must.False(t, b.AllowStale)
}

func TestParseRegion(t *testing.T) {
Expand Down