chore: support multiple key:value search query params #12690
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Emyrk
commented
Mar 20, 2024
Comment on lines
+209
to
+214
| if err != nil { | ||
| p.Errors = append(p.Errors, codersdk.ValidationError{ | ||
| Field: queryParam, | ||
| Detail: fmt.Sprintf("Query param %q must be a valid string: %s", queryParam, err.Error()), | ||
| }) | ||
| } |
There was a problem hiding this comment.
This should never throw an error in practice, but it felt weird ignoring the error.
Comment on lines
-166
to
-176
| for k := range searchValues { | ||
| if len(searchValues[k]) > 1 { | ||
| return nil, []codersdk.ValidationError{ | ||
| { | ||
| Field: "q", | ||
| Detail: fmt.Sprintf("Query parameter %q provided more than once, found %d times", k, len(searchValues[k])), | ||
| }, | ||
| } | ||
| } | ||
| } | ||
|
|
There was a problem hiding this comment.
This is now enforced by the parser function. So the parser can decide on a query param basis if more than 1 value is allowed.
All default behavior remains as the underlying parsers require 1 value.
This was referenced Mar 20, 2024
GitHub does this in their label search. Including this for an upcoming feature where the csv format is a bit unwieldy.
061909b to
3fe88c4
Compare
This stack of pull requests is managed by Graphite. Learn more about stacking. |
johnstcn
approved these changes
Mar 21, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
GitHub does this in their label search. Including this for an upcoming feature where the csv format is a bit unwieldy.
supporting: #10661
Previously we enforced each key to only be used once, I changed this to be decided in the parse function, later in the process. This works better because the parser has more context.
What this does
It allows syntax like this to search for 2 ids:
The old error is still there for params that do not support it.
Future work
We have things like
name:<workspace_name>. It would be nice to allow this syntax there too. Currently we get this error: