mirror of
https://github.com/coder/coder.git
synced 2025-07-03 16:13:58 +00:00
feat: workspace filter query supported in backend (#2232)
* feat: add support for template in workspace filter * feat: Implement workspace search filter to support names * Use new query param parser for pagination fields * Remove excessive calls, use filters on a single query Co-authored-by: Garrett <garrett@coder.com>
This commit is contained in:
Steven Masley
GitHub
105
coderd/httpapi/queryparams.go
Normal file
105
coderd/httpapi/queryparams.go
Normal file
@ -0,0 +1,105 @@
|
||||
package httpapi
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"net/url"
|
||||
"strconv"
|
||||
"strings"
|
||||
|
||||
"github.com/google/uuid"
|
||||
|
||||
"golang.org/x/xerrors"
|
||||
)
|
||||
|
||||
// QueryParamParser is a helper for parsing all query params and gathering all
|
||||
// errors in 1 sweep. This means all invalid fields are returned at once,
|
||||
// rather than only returning the first error
|
||||
type QueryParamParser struct {
|
||||
// Errors is the set of errors to return via the API. If the length
|
||||
// of this set is 0, there are no errors!.
|
||||
Errors []Error
|
||||
}
|
||||
|
||||
func NewQueryParamParser() *QueryParamParser {
|
||||
return &QueryParamParser{
|
||||
Errors: []Error{},
|
||||
}
|
||||
}
|
||||
|
||||
func (p *QueryParamParser) Int(vals url.Values, def int, queryParam string) int {
|
||||
v, err := parseQueryParam(vals, 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) UUIDorMe(vals url.Values, def uuid.UUID, me uuid.UUID, queryParam string) uuid.UUID {
|
||||
if vals.Get(queryParam) == "me" {
|
||||
return me
|
||||
}
|
||||
return p.UUID(vals, def, queryParam)
|
||||
}
|
||||
|
||||
func (p *QueryParamParser) UUID(vals url.Values, def uuid.UUID, queryParam string) uuid.UUID {
|
||||
v, err := parseQueryParam(vals, uuid.Parse, def, queryParam)
|
||||
if err != nil {
|
||||
p.Errors = append(p.Errors, Error{
|
||||
Field: queryParam,
|
||||
Detail: fmt.Sprintf("Query param %q must be a valid uuid", queryParam),
|
||||
})
|
||||
}
|
||||
return v
|
||||
}
|
||||
|
||||
func (p *QueryParamParser) UUIDs(vals url.Values, def []uuid.UUID, queryParam string) []uuid.UUID {
|
||||
v, err := parseQueryParam(vals, func(v string) ([]uuid.UUID, error) {
|
||||
var badValues []string
|
||||
strs := strings.Split(v, ",")
|
||||
ids := make([]uuid.UUID, 0, len(strs))
|
||||
for _, s := range strs {
|
||||
id, err := uuid.Parse(strings.TrimSpace(s))
|
||||
if err != nil {
|
||||
badValues = append(badValues, v)
|
||||
continue
|
||||
}
|
||||
ids = append(ids, id)
|
||||
}
|
||||
|
||||
if len(badValues) > 0 {
|
||||
return []uuid.UUID{}, xerrors.Errorf("%s", strings.Join(badValues, ","))
|
||||
}
|
||||
return ids, nil
|
||||
}, def, queryParam)
|
||||
if err != nil {
|
||||
p.Errors = append(p.Errors, Error{
|
||||
Field: queryParam,
|
||||
Detail: fmt.Sprintf("Query param %q has invalid uuids: %q", queryParam, err.Error()),
|
||||
})
|
||||
}
|
||||
return v
|
||||
}
|
||||
|
||||
func (p *QueryParamParser) String(vals url.Values, def string, queryParam string) string {
|
||||
v, err := parseQueryParam(vals, func(v string) (string, error) {
|
||||
return v, nil
|
||||
}, def, queryParam)
|
||||
if err != nil {
|
||||
p.Errors = append(p.Errors, Error{
|
||||
Field: queryParam,
|
||||
Detail: fmt.Sprintf("Query param %q must be a valid string", queryParam),
|
||||
})
|
||||
}
|
||||
return v
|
||||
}
|
||||
|
||||
func parseQueryParam[T any](vals url.Values, parse func(v string) (T, error), def T, queryParam string) (T, error) {
|
||||
if !vals.Has(queryParam) || vals.Get(queryParam) == "" {
|
||||
return def, nil
|
||||
}
|
||||
str := vals.Get(queryParam)
|
||||
return parse(str)
|
||||
}
|
||||
201
coderd/httpapi/queryparams_test.go
Normal file
201
coderd/httpapi/queryparams_test.go
Normal file
@ -0,0 +1,201 @@
|
||||
package httpapi_test
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"net/http"
|
||||
"net/url"
|
||||
"testing"
|
||||
|
||||
"github.com/google/uuid"
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"github.com/coder/coder/coderd/httpapi"
|
||||
)
|
||||
|
||||
type queryParamTestCase[T any] struct {
|
||||
QueryParam string
|
||||
// No set does not set the query param, rather than setting the empty value
|
||||
NoSet bool
|
||||
Value string
|
||||
Default T
|
||||
Expected T
|
||||
ExpectedErrorContains string
|
||||
Parse func(r *http.Request, def T, queryParam string) T
|
||||
}
|
||||
|
||||
func TestParseQueryParams(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
t.Run("UUID", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
me := uuid.New()
|
||||
expParams := []queryParamTestCase[uuid.UUID]{
|
||||
{
|
||||
QueryParam: "valid_id",
|
||||
Value: "afe39fbf-0f52-4a62-b0cc-58670145d773",
|
||||
Expected: uuid.MustParse("afe39fbf-0f52-4a62-b0cc-58670145d773"),
|
||||
},
|
||||
{
|
||||
QueryParam: "me",
|
||||
Value: "me",
|
||||
Expected: me,
|
||||
},
|
||||
{
|
||||
QueryParam: "invalid_id",
|
||||
Value: "bogus",
|
||||
ExpectedErrorContains: "must be a valid uuid",
|
||||
},
|
||||
{
|
||||
QueryParam: "long_id",
|
||||
Value: "afe39fbf-0f52-4a62-b0cc-58670145d773-123",
|
||||
ExpectedErrorContains: "must be a valid uuid",
|
||||
},
|
||||
{
|
||||
QueryParam: "no_value",
|
||||
NoSet: true,
|
||||
Default: uuid.MustParse("11111111-1111-1111-1111-111111111111"),
|
||||
Expected: uuid.MustParse("11111111-1111-1111-1111-111111111111"),
|
||||
},
|
||||
{
|
||||
QueryParam: "empty",
|
||||
Value: "",
|
||||
Expected: uuid.Nil,
|
||||
},
|
||||
}
|
||||
|
||||
parser := httpapi.NewQueryParamParser()
|
||||
testQueryParams(t, expParams, parser, func(vals url.Values, def uuid.UUID, queryParam string) uuid.UUID {
|
||||
return parser.UUIDorMe(vals, def, me, queryParam)
|
||||
})
|
||||
})
|
||||
|
||||
t.Run("String", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
expParams := []queryParamTestCase[string]{
|
||||
{
|
||||
QueryParam: "valid_string",
|
||||
Value: "random",
|
||||
Expected: "random",
|
||||
},
|
||||
{
|
||||
QueryParam: "empty",
|
||||
Value: "",
|
||||
Expected: "",
|
||||
},
|
||||
{
|
||||
QueryParam: "no_value",
|
||||
NoSet: true,
|
||||
Default: "default",
|
||||
Expected: "default",
|
||||
},
|
||||
}
|
||||
|
||||
parser := httpapi.NewQueryParamParser()
|
||||
testQueryParams(t, expParams, parser, parser.String)
|
||||
})
|
||||
|
||||
t.Run("Int", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
expParams := []queryParamTestCase[int]{
|
||||
{
|
||||
QueryParam: "valid_integer",
|
||||
Value: "100",
|
||||
Expected: 100,
|
||||
},
|
||||
{
|
||||
QueryParam: "empty",
|
||||
Value: "",
|
||||
Expected: 0,
|
||||
},
|
||||
{
|
||||
QueryParam: "no_value",
|
||||
NoSet: true,
|
||||
Default: 5,
|
||||
Expected: 5,
|
||||
},
|
||||
{
|
||||
QueryParam: "negative",
|
||||
Value: "-10",
|
||||
Expected: -10,
|
||||
Default: 5,
|
||||
},
|
||||
{
|
||||
QueryParam: "invalid_integer",
|
||||
Value: "bogus",
|
||||
Expected: 0,
|
||||
ExpectedErrorContains: "must be a valid integer",
|
||||
},
|
||||
}
|
||||
|
||||
parser := httpapi.NewQueryParamParser()
|
||||
testQueryParams(t, expParams, parser, parser.Int)
|
||||
})
|
||||
|
||||
t.Run("UUIDs", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
expParams := []queryParamTestCase[[]uuid.UUID]{
|
||||
{
|
||||
QueryParam: "valid_ids_with_spaces",
|
||||
Value: "6c8ef17d-5dd8-4b92-bac9-41944f90f237, 65fb05f3-12c8-4a0a-801f-40439cf9e681 , 01b94888-1eab-4bbf-aed0-dc7a8010da97",
|
||||
Expected: []uuid.UUID{
|
||||
uuid.MustParse("6c8ef17d-5dd8-4b92-bac9-41944f90f237"),
|
||||
uuid.MustParse("65fb05f3-12c8-4a0a-801f-40439cf9e681"),
|
||||
uuid.MustParse("01b94888-1eab-4bbf-aed0-dc7a8010da97"),
|
||||
},
|
||||
},
|
||||
{
|
||||
QueryParam: "empty",
|
||||
Value: "",
|
||||
Default: []uuid.UUID{},
|
||||
Expected: []uuid.UUID{},
|
||||
},
|
||||
{
|
||||
QueryParam: "no_value",
|
||||
NoSet: true,
|
||||
Default: []uuid.UUID{},
|
||||
Expected: []uuid.UUID{},
|
||||
},
|
||||
{
|
||||
QueryParam: "default",
|
||||
NoSet: true,
|
||||
Default: []uuid.UUID{uuid.Nil},
|
||||
Expected: []uuid.UUID{uuid.Nil},
|
||||
},
|
||||
{
|
||||
QueryParam: "invalid_id_in_set",
|
||||
Value: "6c8ef17d-5dd8-4b92-bac9-41944f90f237,bogus",
|
||||
Expected: []uuid.UUID{},
|
||||
Default: []uuid.UUID{},
|
||||
ExpectedErrorContains: "bogus",
|
||||
},
|
||||
}
|
||||
|
||||
parser := httpapi.NewQueryParamParser()
|
||||
testQueryParams(t, expParams, parser, parser.UUIDs)
|
||||
})
|
||||
}
|
||||
|
||||
func testQueryParams[T any](t *testing.T, testCases []queryParamTestCase[T], parser *httpapi.QueryParamParser, parse func(vals url.Values, def T, queryParam string) T) {
|
||||
v := url.Values{}
|
||||
for _, c := range testCases {
|
||||
if c.NoSet {
|
||||
continue
|
||||
}
|
||||
v.Set(c.QueryParam, c.Value)
|
||||
}
|
||||
|
||||
for _, c := range testCases {
|
||||
// !! Do not run these in parallel !!
|
||||
t.Run(c.QueryParam, func(t *testing.T) {
|
||||
v := parse(v, c.Default, c.QueryParam)
|
||||
require.Equal(t, c.Expected, v, fmt.Sprintf("param=%q value=%q", c.QueryParam, c.Value))
|
||||
if c.ExpectedErrorContains != "" {
|
||||
errors := parser.Errors
|
||||
require.True(t, len(errors) > 0, "error exist")
|
||||
last := errors[len(errors)-1]
|
||||
require.True(t, last.Field == c.QueryParam, fmt.Sprintf("query param %q did not fail", c.QueryParam))
|
||||
require.Contains(t, last.Detail, c.ExpectedErrorContains, "correct error")
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user