Use new query param parser for pagination fields

Emyrk · Emyrk · commit 70f430462461 · 2022-06-09T22:02:21.000-05:00
diff --git a/coderd/httpapi/queryparams.go b/coderd/httpapi/queryparams.go
@@ -3,6 +3,7 @@ package httpapi
 import (
 	"fmt"
 	"net/http"
+	"strconv"
 	"strings"
 
 	"github.com/google/uuid"
@@ -29,6 +30,17 @@ func (p QueryParamParser) ValidationErrors() []Error {
 	return p.errors
 }
 
+func (p *QueryParamParser) ParseInteger(r *http.Request, def int, queryParam string) int {
+	v, err := parse(r, strconv.Atoi, def, queryParam)
+	if err != nil {
+		p.errors = append(p.errors, Error{
+			Field:  queryParam,
+			Detail: fmt.Sprintf("Query param %q must be a valid integer (%s)", queryParam, err.Error()),
+		})
+	}
+	return v
+}
+
 func (p *QueryParamParser) ParseUUIDorMe(r *http.Request, def uuid.UUID, me uuid.UUID, queryParam string) uuid.UUID {
 	if r.URL.Query().Get(queryParam) == "me" {
 		return me
diff --git a/coderd/pagination.go b/coderd/pagination.go
@@ -2,7 +2,6 @@ package coderd
 
 import (
 	"net/http"
-	"strconv"
 
 	"github.com/google/uuid"
 
@@ -13,53 +12,20 @@ import (
 // parsePagination extracts pagination query params from the http request.
 // If an error is encountered, the error is written to w and ok is set to false.
 func parsePagination(w http.ResponseWriter, r *http.Request) (p codersdk.Pagination, ok bool) {
-	var (
-		afterID = uuid.Nil
-		limit   = -1 // Default to no limit and return all results.
-		offset  = 0
-	)
-
-	var err error
-	if s := r.URL.Query().Get("after_id"); s != "" {
-		afterID, err = uuid.Parse(r.URL.Query().Get("after_id"))
-		if err != nil {
-			httpapi.Write(w, http.StatusBadRequest, httpapi.Response{
-				Message: "Query param 'after_id' must be a valid UUID.",
-				Validations: []httpapi.Error{
-					{Field: "after_id", Detail: err.Error()},
-				},
-			})
-			return p, false
-		}
-	}
-	if s := r.URL.Query().Get("limit"); s != "" {
-		limit, err = strconv.Atoi(s)
-		if err != nil {
-			httpapi.Write(w, http.StatusBadRequest, httpapi.Response{
-				Message: "Query param 'limit' must be a valid integer.",
-				Validations: []httpapi.Error{
-					{Field: "limit", Detail: err.Error()},
-				},
-			})
-			return p, false
-		}
+	parser := httpapi.NewQueryParamParser()
+	params := codersdk.Pagination{
+		AfterID: parser.ParseUUID(r, uuid.Nil, "after_id"),
+		// Limit default to "-1" which returns all results
+		Limit:  parser.ParseInteger(r, -1, "limit"),
+		Offset: parser.ParseInteger(r, 0, "offset"),
 	}
-	if s := r.URL.Query().Get("offset"); s != "" {
-		offset, err = strconv.Atoi(s)
-		if err != nil {
-			httpapi.Write(w, http.StatusBadRequest, httpapi.Response{
-				Message: "Query param 'offset' must be a valid integer.",
-				Validations: []httpapi.Error{
-					{Field: "offset", Detail: err.Error()},
-				},
-			})
-			return p, false
-		}
+	if len(parser.ValidationErrors()) > 0 {
+		httpapi.Write(w, http.StatusBadRequest, httpapi.Response{
+			Message:     "Query parameters have invalid values.",
+			Validations: parser.ValidationErrors(),
+		})
+		return params, false
 	}
 
-	return codersdk.Pagination{
-		AfterID: afterID,
-		Limit:   limit,
-		Offset:  offset,
-	}, true
+	return params, true
 }
diff --git a/coderd/workspaces.go b/coderd/workspaces.go
@@ -141,7 +141,7 @@ func (api *API) workspaces(rw http.ResponseWriter, r *http.Request) {
 	}
 	if len(parser.ValidationErrors()) > 0 {
 		httpapi.Write(rw, http.StatusBadRequest, httpapi.Response{
-			Message:     fmt.Sprintf("Query parameters have invalid values"),
+			Message:     "Query parameters have invalid values.",
 			Validations: parser.ValidationErrors(),
 		})
 		return

Original file line number	Diff line number	Diff line change
`@@ -141,7 +141,7 @@ func (api API) workspaces(rw http.ResponseWriter, r http.Request) {`
`141`	`141`	`}`
`142`	`142`	`if len(parser.ValidationErrors()) > 0 {`
`143`	`143`	`httpapi.Write(rw, http.StatusBadRequest, httpapi.Response{`
`144`		`- Message: fmt.Sprintf("Query parameters have invalid values"),`
	`144`	`+ Message: "Query parameters have invalid values.",`
`145`	`145`	`Validations: parser.ValidationErrors(),`
`146`	`146`	`})`
`147`	`147`	`return`