coder/coderd/pagination.go

package coderd

import (
	"net/http"
	"strconv"

	"github.com/google/uuid"

	"github.com/coder/coder/coderd/httpapi"
	"github.com/coder/coder/codersdk"
)

// 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
		}
	}
	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
		}
	}

	return codersdk.Pagination{
		AfterID: afterID,
		Limit:   limit,
		Offset:  offset,
	}, true
}