Replace search bar on Explore agent modal #5447
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
Features: - Supports multiple query languages - Decouple the business logic of query languages of the search bar component - Ability of query language to interact with the search bar Query language implementations - AQL: custom implementation of the Wazuh Query Language. Include suggestions. - UIQL: simple implementation (as another example)
…ression used in the Wazuh manager API - Change the implementation of AQL query language to use the regular expression decomposition defined in the Wazuh manager API - Adapt the tests for the tokenizer and getting the suggestions - Enchance documentation of search bar - Add documentation of AQL query language - Add more fields and values for the use example in Agents section - Add description to the query language select input
…using the Search suggestion in AQL
- Fixes a problem hidding the suggestion popover when using the Search
suggestion in AQL
- Fixes a problem of input text with undefined value
- Minor fixes
- Remove `syntax` property of SearchBar component
- Add disableFocusTrap property to the custom EuiSuggestInput component to be
forwarded to the EuiInputPopover
- Replace the inputRef by a reference instead of a state and pass as
a parameter in the query language run function
- Move the rebuiding of input text when using some suggestion that changes
the input to be done when a related suggestion was clicked instead
of any suggestion (exclude Search).
implemenation - Add the ability to update the input of the search bar in the example implementation - Enhance the component documentation
- (AQL) Add the fields and an open operator group when there is no input text
link of query language displayed in the popover
- AQL enhancements:
- documentation:
- Enhance some descriptions
- Enhance input processing
- Remove intermetiate interface of EuiSuggestItem
- Remove the intermediate interface of EuiSuggestItem. Now it is
managed in the internal of query language instead of be built by the
suggestion handler
- Display suggestions when the input text is empty
- Add the unifiedQuery field to the query language output
- Adapt tests
- Search Bar component:
- Enhance documentation
- Remove UIQL
- Add HAQL query language that is a high-level implementation of AQL
- Add the query language interface
- Add tests for tokenizer, get suggestions and
transformSpecificQLToUnifiedQL method
- Add documentation about the language
- Syntax
- Options
- Workflow
- Add tests to HAQL and AQL query languages - Fix suggestions for HAQL when typing as first element a value entity. Now there are no suggestions because the field and operator_compare are missing. - Enhance documentation of HAQL and AQL - Removed unnecesary returns of suggestion handler in the example implementation of search bar on Agents section
- Rename query language HAQL to WQL - Update tests - Remove AQL usage from the implementation in the agents section
- Add more use cases to the test of WQL query language - Replace some literals by constants in the WQL query language implementation
…platform search bar
… is an implicit query
- WQL
- add implicit query mode to WQL
- enhance query language documentation
- renamed transformUnifiedQuery to transformUQLToQL
- now wraps the user input if this is defined and there a implicit
query string
- fix a problem with the value suggestions if there is a previous
conjunction
- add tests cases
- update tests
- AQL
- enhance query language documentation
- renamed transformUnifiedQuery to transformUQLToQL
- add warning about the query language implementation is not updated
to the last changes in the search bar component
- update tests
- Search Bar
- renamed transformUnifiedQuery to transformUQLToQL
- Set a width for the syntax options popover - Unify the description in the suggestions of WQL example implementation - Update tests - Fix minor bugs in the WQL example implementation in Agents
- WQL - Enhance documentation - Add partial and "expanded" input validation - Add tests
…feat/4312-poc-search-bar-component-multiple-query-language-api-query-language-implementation
Fix an error when the last token in the input was a value and used a value suggestion whose label contains whitespaces, the value was not wrapped with quotes.
…uery-language-api-query-language-implementation
…uery-language-api-query-language-implementation
…the onChange handler
…earch term fields changed - Search bar: - Add a dependency to run the query language output - Adapt search bar documentation to the changes - WQL - Create a new parameter called `options` - Moved the `implicitFilter` and `searchTerm` settings to `options` - Update tests - Update documentation
…hub.com/wazuh/wazuh-kibana-app into feat/4312-search-bar-replace-explore-agent-modal
jbiset
reviewed
Aug 10, 2023
There was a problem hiding this comment.
CR: ✅ (comment)
Test
Use a Wazuh manager
Legend:
⚫: none
🟢: pass
🟡: warning
🔴: fail
⚪: not applicable
UI
| Test | Chrome | Firefox | Safari |
|---|---|---|---|
| Explore agent modal: For each suggested field, check the value suggestion display results or at least doesn't break | 🟢 | 🟢 | ⚫ |
| Explore agent modal: Using a value suggested should allow to run the search | 🟢 | 🟢 | ⚫ |
| Explore agent modal: Type a term and run the search should search in each displayed field | 🟢 | 🟢 | ⚫ |
| Explore agent modal: Type a simple field search and this should returns the expected results | 🟢 | 🟢 | ⚫ |
| Explore agent modal: Type a complex field search and this should returns the expected results | 🟢 | 🟢 | ⚫ |
Details
🟢 Explore agent modal: For each suggested field, check the value suggestion display results or at least doesn't break
Chrome - 🟢
Firefox - 🟢
Safari - ⚫
🟢 Explore agent modal: Using a value suggested should allow to run the search
Chrome - 🟢
Firefox - 🟢
Safari - ⚫
🟡 Explore agent modal: Type a term and run the search should search in each displayed field **_Api bug_**
Chrome - 🟡
Api bug Error case ( wazuh/wazuh#18204 )
Good case
Firefox - 🟡
Api bug Error case ( wazuh/wazuh#18204 )
Good case
Safari - ⚫
🟢 Explore agent modal: Type a simple field search and this should returns the expected results
Chrome - 🟢
Firefox - 🟢
Safari - ⚫
🟡 Explore agent modal: Type a complex field search and this should returns the expected results **_Api bug_**
Chrome - 🟡
Api bug Error case
Good cases
Firefox - 🟡
Api bug Error case
Good cases
Safari - ⚫
Check List
- All tests pass
-
yarn test:jest
-
- New functionality includes testing.
- New functionality has been documented.
- Update CHANGELOG.md
- Commits are signed per the DCO using --signoff
|
Legend:
Details 🟢 Explore agent modal: For each suggested field, check the value suggestion display results or at least doesn't breakChrome - 🟢 
Firefox - 🟢 
Safari - 🟢 
🟢 Explore agent modal: Using a value suggested should allow to run the searchChrome - 🟢 
Firefox - 🟢 
Safari - 🟢 
🟡 Explore agent modal: Type a term and run the search should search in each displayed field **_Api bug_**Chrome - 🟡 Api bug wazuh/wazuh#18204 Grabacion.de.pantalla.2023-08-10.a.la.s.10.10.07.movFirefox - 🟡 Api bug wazuh/wazuh#18204 Grabacion.de.pantalla.2023-08-10.a.la.s.10.48.17.movSafari - 🟡 Api bug wazuh/wazuh#18204 Grabacion.de.pantalla.2023-08-10.a.la.s.10.50.23.mov🟢 Explore agent modal: Type a simple field search and this should returns the expected resultsChrome - 🟢 
Firefox - 🟢 
Safari - 🟢 
🟢 Explore agent modal: Type a complex field search and this should returns the expected resultsChrome - 🟢 
Firefox - 🟢 
Safari - 🟢 
|
… input is analyzed due to this process is debounced
…hub.com/wazuh/wazuh-kibana-app into feat/4312-search-bar-replace-explore-agent-modal
…hub.com/wazuh/wazuh-kibana-app into feat/4312-search-bar-replace-explore-agent-modal
…hub.com/wazuh/wazuh-kibana-app into feat/4312-search-bar-replace-explore-agent-modal
chantal-kelm
previously approved these changes
Aug 10, 2023
jbiset
previously approved these changes
Aug 10, 2023
plugins/main/public/components/common/tables/table-with-search-bar.tsx
Outdated
Show resolved
Hide resolved
jbiset
previously approved these changes
Aug 11, 2023
chantal-kelm
previously approved these changes
Aug 11, 2023
…o feat/4312-search-bar-replace-explore-agent-modal
jbiset
approved these changes
Aug 11, 2023
chantal-kelm
approved these changes
Aug 11, 2023
|
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.
Description
This pull request replaces the search bar and table component on Explore agent modal
Affected sections:
Additional changes:
Issues Resolved
#4312
Evidence
Table - Explore agent
Suggestions:
Test
Legend:
⚫: none
🟢: pass
🟡: warning
🔴: fail
⚪: not applicable
UI
Details
⚫ Explore agent modal: For each suggested field, check the value suggestion display results or at least doesn't break
Chrome - ⚫
Firefox - ⚫
Safari - ⚫
⚫ Explore agent modal: Using a value suggested should allow to run the search
Chrome - ⚫
Firefox - ⚫
Safari - ⚫
⚫ Explore agent modal: Type a term and run the search should search in each displayed field
Chrome - ⚫
Firefox - ⚫
Safari - ⚫
⚫ Explore agent modal: Type a simple field search and this should returns the expected results
Chrome - ⚫
Firefox - ⚫
Safari - ⚫
⚫ Explore agent modal: Type a complex field search and this should returns the expected results
Chrome - ⚫
Firefox - ⚫
Safari - ⚫
Check List
yarn test:jest