NotificationsYou must be signed in to change notification settings
Fork1k
Star11.1k

fix: add support for spaces in search & enable searching by display name in templates#19552

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.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

rafrdz merged 4 commits intomainfromrafrdz/templates-search

Sep 8, 2025

Merged

fix: add support for spaces in search & enable searching by display name in templates#19552

rafrdz merged 4 commits intomainfromrafrdz/templates-search

Sep 8, 2025

+121 −18

Conversation

Copy link

rafrdz commentedAug 26, 2025•
edited
Loading

Summary

In this pull request we're updating search to support queries with spaces in addition to thefield:value pattern that is currently supported.

Additionally templates search now defaults todisplay_name (sincedisplay_name is optional the search will fallback toname) when searching without thefield:value pattern

Closes:#14384

Downsides with searching on`name` and`display_name`

Because thename field cannot include spaces, we end up in a situation where including a space in the query will result in no results since the query searches on bothname ANDdisplay_name. In the following example, we can see the results of searching by bothname anddisplay_name on these templates:

Name	Display Name
docker	Docker Template
faketemplate	A Fake Template
azure	Fake Azure Template
anotherfake	Another Fake Template
azurefake	Another Fake Fake Azure Template

name-and-display-name.mov

Proposal: Search on`display_name` by default and allow for`name` using the`field:value` pattern

If we removename from the default template search, we're now able to search with spaces on templatedisplay_names. Sincedisplay_names are what users see in the templates list they might expect the search to work this way.

Below is an example ofname being removed from the default template search.

display-name.mov

With this approach users would still be able to search on template names by specifyingexact_name:foo.

Testing

Added additional test cases to ensure spaces were handled as expected in combination withfield:value patterns.

feat: support spaces in search and search by display name in templates

5ae74a0

github-actionsbot assignedrafrdz

Aug 26, 2025

rafrdz commented

Aug 26, 2025

View reviewed changes

coderd/searchquery/search.go OutdatedShow resolvedHide resolved

rafrdz requested a review fromEmyrk

August 26, 2025 14:33

Run make gen golden files

caee61c

rafrdz changed the title~~fix: support spaces in search and search by display name in templates~~fix: add support for spaces in search and enable searching by display name in templates

Aug 26, 2025

rafrdz changed the title~~fix: add support for spaces in search and enable searching by display name in templates~~fix: add support for spaces in search & enable searching by display name in templates

Aug 26, 2025

rafrdz mentioned this pull request

Aug 26, 2025

cannot search template name with spaces#14384

Closed

Copy link

Member

matifali commentedAug 26, 2025•
edited
Loading

Can we fallback to thename for Templates, whendisplay_name is empty?

Copy link

Author

rafrdz commentedAug 26, 2025

Can we fallback to the name for Templatesdisplay_name is empty, as it's optional?

To make sure I'm following would you like to search ondisplay_name by default and fallback toname ifdisplay_name is empty?

That can be done. Since we would now support spaces in the search queries we'd probably need to update thename query to filter out any spaces sincename cannot have any spaces 🤔

Copy link

Member

matifali commentedAug 26, 2025

To make sure I'm following would you like to search on display_name by default and fallback to name if display_name is empty?

Yes

search on display_name, default to name if display_name is empty

8c780dc

Copy link

Author

rafrdz commentedAug 26, 2025

To make sure I'm following would you like to search on display_name by default and fallback to name if display_name is empty?
Yes

Sounds good! Defaulting todisplay_name and falling back toname (with spaces removed from query) in8c780dc

Copy link

Member

matifali commentedAug 27, 2025

Nor directly related but is it possible to stop showingdeprecated:false in the search nar?

Can it be a hidden default filter that's always true. If someone wants deprecated templates they can set it todeprecated:true

Copy link

Author

rafrdz commentedAug 27, 2025

Nor directly related but is it possible to stop showingdeprecated:false in the search nar?
Can it be a hidden default filter that's always true. If someone wants deprecated templates they can set it todeprecated:true

We could remove that from the frontend as the default query and update the query to always returndeprecated:false unless a user specifically asked fordeprecated:true. The frontend already has a "Deprecated templates" filter that setsdeprecated:true.

Should we make a new issue for this work?