[Global Search] Add multiword type handling in global search #196087
Merged
Conversation
This file contains 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
kowalczyk-krzysztof
added
bug
|
Pinging @elastic/appex-sharedux (Team:SharedUX) |
sebelga
reviewed
Oct 15, 2024
There was a problem hiding this comment.
Tested locally and works as expected, great job! 👍
While testing I realized that we don't allow spaces between the type: and the type.
So this does not work type: canvas workpad.
Do you think it would be possible to first strip any space after type: and the fist letter before doing the conversion to string?
| } | ||
|
|
||
| const typesPattern = multiWordTypes.join('|'); | ||
| const canvasWorkpadRegex = new RegExp(`(type:|types:)(\\s*[^"']*?)\\b(${typesPattern})\\b`, 'gi'); |
There was a problem hiding this comment.
nit: can we use a generic name, e.g. termReplaceRegex?
There was a problem hiding this comment.
Oops, thanks for noticing this. This variable name is something I used initially, before I made this solution more generic. I'll change that.
| it('converts multiword searchable types to phrases so they get picked up as types', () => { | ||
| const mockSearchableMultiwordTypes = ['canvas-workpad', 'enterprise search']; | ||
| const searchParams = parseSearchParams( | ||
| 'type:canvas workpad types:canvas-workpad hello type:enterprise search type:not multiword', |
There was a problem hiding this comment.
Can we add type:"canvas workpad" to the list so we make sure it handles types with existing quotes?
Also by doing so, I realized that we pass twice the same types in the array, could we avoid dedupes when returning the array? (I know it's not part of fixing the issue but we could use the momentum 😊). Thanks 👍
There was a problem hiding this comment.
Right, I didn't think about checking for already existing quotes. It should work but I'll cover it in the test.
As for deduping, I wasn't really sure if this is what we want (although it's makes logical sense) but sure, I'll add that.
Sure, I'll add that |
kowalczyk-krzysztof
force-pushed
the
fix/multiword-types
branch
from
ca793db to
9f7cafd
Compare
💚 Build Succeeded
Metrics [docs]Page load bundle
History
|
sebelga
approved these changes
Oct 16, 2024
|
Starting backport for target branches: 8.x https://github.com/elastic/kibana/actions/runs/11365648381 |
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Oct 16, 2024
…#196087) ## Summary This PR improves the UX of global search by allowing users to search for types that consist of multiple words without having to turn them into phrases (wrapping them in quotes). For example: The following query: ``` hello type:canvas workpad type:enterprise search world tag:new ``` Will get mapped to: ``` hello type:"canvas workpad" type:"enterprise search" world tag:new ``` Which will result in following `Query` object: ```json { "term": "hello world", "filters": { "tags": ["new"] "types": ["canvas workpad", "enterprise search"], }, } ``` Fixes: elastic#176877 ### Checklist - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios (cherry picked from commit 3d28d17)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
kibanamachine
added a commit
that referenced
this pull request
Oct 16, 2024
…196087) (#196545) # Backport This will backport the following commits from `main` to `8.x`: - [[Global Search] Add multiword type handling in global search (#196087)](#196087) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Krzysztof Kowalczyk","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-10-16T12:29:03Z","message":"[Global Search] Add multiword type handling in global search (#196087)\n\n## Summary\r\n\r\nThis PR improves the UX of global search by allowing users to search for\r\ntypes that consist of multiple words without having to turn them into\r\nphrases (wrapping them in quotes).\r\n\r\nFor example: \r\n\r\nThe following query:\r\n```\r\nhello type:canvas workpad type:enterprise search world tag:new\r\n```\r\nWill get mapped to:\r\n```\r\nhello type:\"canvas workpad\" type:\"enterprise search\" world tag:new\r\n```\r\nWhich will result in following `Query` object:\r\n```json\r\n{\r\n \"term\": \"hello world\",\r\n \"filters\": {\r\n \"tags\": [\"new\"]\r\n \"types\": [\"canvas workpad\", \"enterprise search\"],\r\n },\r\n}\r\n```\r\n\r\nFixes: #176877\r\n\r\n### Checklist\r\n- [x] [Unit or functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere updated or added to match the most common scenarios","sha":"3d28d173a94dc9856fe43cbff8d88ac4e2d42a17","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["bug","release_note:skip","v9.0.0","Team:SharedUX","backport:prev-minor"],"title":"[Global Search] Add multiword type handling in global search","number":196087,"url":"https://github.com/elastic/kibana/pull/196087","mergeCommit":{"message":"[Global Search] Add multiword type handling in global search (#196087)\n\n## Summary\r\n\r\nThis PR improves the UX of global search by allowing users to search for\r\ntypes that consist of multiple words without having to turn them into\r\nphrases (wrapping them in quotes).\r\n\r\nFor example: \r\n\r\nThe following query:\r\n```\r\nhello type:canvas workpad type:enterprise search world tag:new\r\n```\r\nWill get mapped to:\r\n```\r\nhello type:\"canvas workpad\" type:\"enterprise search\" world tag:new\r\n```\r\nWhich will result in following `Query` object:\r\n```json\r\n{\r\n \"term\": \"hello world\",\r\n \"filters\": {\r\n \"tags\": [\"new\"]\r\n \"types\": [\"canvas workpad\", \"enterprise search\"],\r\n },\r\n}\r\n```\r\n\r\nFixes: #176877\r\n\r\n### Checklist\r\n- [x] [Unit or functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere updated or added to match the most common scenarios","sha":"3d28d173a94dc9856fe43cbff8d88ac4e2d42a17"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/196087","number":196087,"mergeCommit":{"message":"[Global Search] Add multiword type handling in global search (#196087)\n\n## Summary\r\n\r\nThis PR improves the UX of global search by allowing users to search for\r\ntypes that consist of multiple words without having to turn them into\r\nphrases (wrapping them in quotes).\r\n\r\nFor example: \r\n\r\nThe following query:\r\n```\r\nhello type:canvas workpad type:enterprise search world tag:new\r\n```\r\nWill get mapped to:\r\n```\r\nhello type:\"canvas workpad\" type:\"enterprise search\" world tag:new\r\n```\r\nWhich will result in following `Query` object:\r\n```json\r\n{\r\n \"term\": \"hello world\",\r\n \"filters\": {\r\n \"tags\": [\"new\"]\r\n \"types\": [\"canvas workpad\", \"enterprise search\"],\r\n },\r\n}\r\n```\r\n\r\nFixes: #176877\r\n\r\n### Checklist\r\n- [x] [Unit or functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere updated or added to match the most common scenarios","sha":"3d28d173a94dc9856fe43cbff8d88ac4e2d42a17"}}]}] BACKPORT--> Co-authored-by: Krzysztof Kowalczyk <[email protected]>
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.
Summary
This PR improves the UX of global search by allowing users to search for types that consist of multiple words without having to turn them into phrases (wrapping them in quotes).
For example:
The following query:
Will get mapped to:
Which will result in following
Queryobject:{ "term": "hello world", "filters": { "tags": ["new"] "types": ["canvas workpad", "enterprise search"], }, }Fixes: #176877
Checklist