Replace search bar on Agents #5452

Desvelao · 2023-05-17T09:45:40Z

Description

This pull request replaces the search bar and table component on Agents.

It depends on #5442

Additional changes:

Remove unused code

Issues Resolved

#4312

Evidence

Table - Agents
Suggestions:

field	get distinct values	searchable	searchable term
dateAdd	GET /agents?distinct=true&limit=30&select={field}&sort=+{field}&q={currentValue}	✅
id	GET /agents?distinct=true&limit=30&select={field}&sort=+{field}&q={currentValue}	✅	✅
ip	GET /agents?distinct=true&limit=30&select={field}&sort=+{field}&q={currentValue}	✅	✅
group	GET /agents?distinct=true&limit=30&select={field}&sort=+{field}&q={currentValue}	✅	✅
group_config_status	GET /agents?distinct=true&limit=30&select={field}&sort=+{field}&q={currentValue}	✅	✅
laskKeepAlive	GET /agents?distinct=true&limit=30&select={field}&sort=+{field}&q={currentValue}	✅	✅
manager	GET /agents?distinct=true&limit=30&select={field}&sort=+{field}&q={currentValue}	✅	✅
name	GET /agents?distinct=true&limit=30&select={field}&sort=+{field}&q={currentValue}	✅	✅
node_name	GET /agents?distinct=true&limit=30&select={field}&sort=+{field}&q={currentValue}	✅	✅
os.name	GET /agents?distinct=true&limit=30&select={field}&sort=+{field}&q={currentValue}	✅	✅
os.platform	GET /agents?distinct=true&limit=30&select={field}&sort=+{field}&q={currentValue}	✅	✅
os.version	GET /agents?distinct=true&limit=30&select={field}&sort=+{field}&q={currentValue}	✅	✅
status	active,disconnected,pending,neved_connected	✅	✅
version	GET /agents?distinct=true&limit=30&select={field}&sort=+{field}&q={currentValue}	✅	✅

Test

Use a Wazuh manager

Legend:
⚫: none
🟢: pass
🟡: warning
🔴: fail
⚪: not applicable

UI

Test	Chrome	Firefox	Safari
Agents: For each suggested field, check the value suggestion display results or at least doesn't break	⚫	⚫	⚫
Agents: Using a value suggested should allow to run the search	⚫	⚫	⚫
Agents: Type a term and run the search should search in each displayed field	⚫	⚫	⚫
Agents: Type a simple field search and this should returns the expected results	⚫	⚫	⚫
Agents: Type a complex field search and this should returns the expected results	⚫	⚫	⚫
Agents: Clicking on the Refresh button should refresh the data	⚫	⚫	⚫
Agents: Clicking on the Export formatted button should refresh export the data to CSV	⚫	⚫	⚫
Agents: Enable or disable some visible fields, the table should render the visible fields	⚫	⚫	⚫
Agents: Enable or disable some visible fields, type a search term and check the query is searching in the visible fields	⚫	⚫	⚫
Agents: Clicking on the status KPI from the Status panel should add a filter to the search bar, the table should filters the data	⚫	⚫	⚫
Agents: Clicking on the status KPI from the Details panel should add a filter to the search bar, the table should filters the data	⚫	⚫	⚫
Modules directory: Clicking on the status KPI from should redirect to the Agents section adding a filter to the search bar, the table should filters the data	⚫	⚫	⚫

Details

⚫ Agents: For each suggested field, check the value suggestion display results or at least doesn't break

Chrome - ⚫

Firefox - ⚫

Safari - ⚫

⚫ Agents: Using a value suggested should allow to run the search

Chrome - ⚫

Firefox - ⚫

Safari - ⚫

⚫ Agents: Type a term and run the search should search in each displayed field

Chrome - ⚫

Firefox - ⚫

Safari - ⚫

⚫ Agents: Type a simple field search and this should returns the expected results

Chrome - ⚫

Firefox - ⚫

Safari - ⚫

⚫ Agents: Type a complex field search and this should returns the expected results

Chrome - ⚫

Firefox - ⚫

Safari - ⚫

⚫ Agents: Clicking on the Refresh button should refresh the data

Chrome - ⚫

Firefox - ⚫

Safari - ⚫

⚫ Agents: Clicking on the Export formatted button should refresh export the data to CSV

Chrome - ⚫

Firefox - ⚫

Safari - ⚫

⚫ Agents: Enable or disable some visible fields, the table should render the visible fields

Chrome - ⚫

Firefox - ⚫

Safari - ⚫

⚫ Agents: Enable or disable some visible fields, type a search term and check the query is searching in the visible fields

Chrome - ⚫

Firefox - ⚫

Safari - ⚫

⚫ Agents: Clicking on the status KPI from the Status panel should add a filter to the search bar, the table should filters the data

Chrome - ⚫

Firefox - ⚫

Safari - ⚫

⚫ Agents: Clicking on the status KPI from the Details panel should add a filter to the search bar, the table should filters the data

Chrome - ⚫

Firefox - ⚫

Safari - ⚫

⚫ Modules directory: Clicking on the status KPI from should redirect to the Agents section adding a filter to the search bar, the table should filters the data

Chrome - ⚫

Firefox - ⚫

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

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

… WQL

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

…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-agents

…g the suggestions

…hub.com/wazuh/wazuh-kibana-app into feat/4312-search-bar-replace-agents

asteriscos · 2023-08-10T11:47:20Z

Test

Legend:
⚫: none
🟢: pass
🟡: warning
🔴: fail
⚪: not applicable

Test	Chrome	Firefox	Safari
Agents: For each suggested field, check the value suggestion display results or at least doesn't break	🟢	🟢	⚫
Agents: Using a value suggested should allow to run the search	🟢	🟢	⚫
Agents: Type a term and run the search should search in each displayed field	🟢	🟢	⚫
Agents: Type a simple field search and this should returns the expected results	🟢	🟢	⚫
Agents: Type a complex field search and this should returns the expected results	🟢	🟢	⚫
Agents: Clicking on the Refresh button should refresh the data	🟢	🟢	⚫
Agents: Clicking on the Export formatted button should refresh export the data to CSV	🟢	🟢	⚫
Agents: Enable or disable some visible fields, the table should render the visible fields	🟢	🟢	⚫
Agents: Enable or disable some visible fields, type a search term and check the query is searching in the visible fields	🟢	🟢	⚫
Agents: Clicking on the status KPI from the Status panel should add a filter to the search bar, the table should filters the data	🟢	🟢	⚫
Agents: Clicking on the status KPI from the Details panel should add a filter to the search bar, the table should filters the data	🟢	🟢	⚫
Modules directory: Clicking on the status KPI from should redirect to the Agents section adding a filter to the search bar, the table should filters the data	🟢	🟢	⚫

Details

🟢 Agents: For each suggested field, check the value suggestion display results or at least doesn't break

Chrome - 🟢

Firefox - 🟢

Safari - ⚫

🟢 Agents: Using a value suggested should allow to run the search

Chrome - 🟢

Firefox - 🟢

Safari - ⚫

🟢 Agents: Type a term and run the search should search in each displayed field

Chrome - 🟢

Firefox - 🟢

Safari - ⚫

🟢 Agents: Type a simple field search and this should returns the expected results

Chrome - 🟢

Firefox - 🟢

Safari - ⚫

🟢 Agents: Type a complex field search and this should returns the expected results

Chrome - 🟢

Firefox - 🟢

Safari - ⚫

🟢 Agents: Clicking on the Refresh button should refresh the data

Chrome - 🟢

Firefox - 🟢

Safari - ⚫

🟢 Agents: Clicking on the Export formatted button should refresh export the data to CSV

Chrome - 🟢

Firefox - 🟢

Safari - ⚫

🟢 Agents: Enable or disable some visible fields, the table should render the visible fields

Chrome - 🟢

Firefox - 🟢

Safari - ⚫

🟢 Agents: Enable or disable some visible fields, type a search term and check the query is searching in the visible fields

Chrome - 🟢

Firefox - 🟢

Safari - ⚫

🟢 Agents: Clicking on the status KPI from the Status panel should add a filter to the search bar, the table should filters the data

Chrome - 🟢

Firefox - 🟢

Safari - ⚫

🟢 Agents: Clicking on the status KPI from the Details panel should add a filter to the search bar, the table should filters the data

Chrome - 🟢

Firefox - 🟢

Safari - ⚫

🟢 Modules directory: Clicking on the status KPI from should redirect to the Agents section adding a filter to the search bar, the table should filters the data

Chrome - 🟢

Firefox - 🟢

Safari - ⚫

… input is analyzed due to this process is debounced

…hub.com/wazuh/wazuh-kibana-app into feat/4312-search-bar-replace-agents

Tostti · 2023-08-10T13:03:52Z

⚫: none
🟢: pass
🟡: warning
🔴: fail
⚪: not applicable

UI

Test	Chrome	Firefox	Safari
Agents: For each suggested field, check the value suggestion display results or at least doesn't break	🟢	🟢	⚫
Agents: Using a value suggested should allow to run the search	🟢	🟢	⚫
Agents: Type a term and run the search should search in each displayed field	🟢	🟢	⚫
Agents: Type a simple field search and this should returns the expected results	🟢	🟢	⚫
Agents: Type a complex field search and this should returns the expected results	🟢	🟢	⚫
Agents: Clicking on the Refresh button should refresh the data	🟢	🟢	⚫
Agents: Clicking on the Export formatted button should refresh export the data to CSV	🟢	🟢	⚫
Agents: Enable or disable some visible fields, the table should render the visible fields	🟢	🟢	⚫
Agents: Enable or disable some visible fields, type a search term and check the query is searching in the visible fields	🟢	🟢	⚫
Agents: Clicking on the status KPI from the Status panel should add a filter to the search bar, the table should filters the data	🟢	🟢	⚫
Agents: Clicking on the status KPI from the Details panel should add a filter to the search bar, the table should filters the data	🟢	🟢	⚫
Modules directory: Clicking on the status KPI from should redirect to the Agents section adding a filter to the search bar, the table should filters the data	🟢	🟢	⚫

Details

🟢 Agents: For each suggested field, check the value suggestion display results or at least doesn't break

Chrome - 🟢

Firefox - 🟢

Safari - ⚫

🟢 Agents: Using a value suggested should allow to run the search

Chrome - 🟢

Firefox - 🟢

Safari - ⚫

🟢 Agents: Type a term and run the search should search in each displayed field

Chrome - 🟢

Firefox - 🟢

Safari - ⚫

🟢 Agents: Type a simple field search and this should returns the expected results

Chrome - 🟢

Firefox - 🟢

Safari - ⚫

🟢 Agents: Type a complex field search and this should returns the expected results

Chrome - 🟢

Firefox - 🟢

Safari - ⚫

🟢 Agents: Clicking on the Refresh button should refresh the data

Chrome - 🟢

Firefox - 🟢

Safari - ⚫

🟢 Agents: Clicking on the Export formatted button should refresh export the data to CSV

Chrome - 🟢

Firefox - 🟢

Safari - ⚫

🟢 Agents: Enable or disable some visible fields, the table should render the visible fields

Chrome - 🟢

Firefox - 🟢

Safari - ⚫

🟢 Agents: Enable or disable some visible fields, type a search term and check the query is searching in the visible fields

Chrome - 🟢

Firefox - 🟢

Safari - ⚫

🟢 Agents: Clicking on the status KPI from the Status panel should add a filter to the search bar, the table should filters the data

Chrome - 🟢

Firefox - 🟢

Safari - ⚫

🟢 Agents: Clicking on the status KPI from the Details panel should add a filter to the search bar, the table should filters the data

Chrome - 🟢

Firefox - 🟢

Safari - ⚫

🟢 Modules directory: Clicking on the status KPI from should redirect to the Agents section adding a filter to the search bar, the table should filters the data

Chrome - 🟢

Firefox - 🟢

Safari - ⚫

Tostti

TEST:✔️
CR:✔️

LGTM

…hub.com/wazuh/wazuh-kibana-app into feat/4312-search-bar-replace-agents

…o feat/4312-search-bar-replace-agents

github-actions · 2023-08-11T14:06:26Z

Code coverage (Jest)	%	values
Statements	11.47%	( 3959 / 34491 )
Branches	7.57%	( 1775 / 23429 )
Functions	10.86%	( 896 / 8246 )
Lines	11.66%	( 3847 / 32982 )

Desvelao and others added 30 commits February 16, 2023 12:50

feat(search-bar): add the ability to update the input of example

83c05cf

implemenation - Add the ability to update the input of the search bar in the example implementation - Enhance the component documentation

feat(search-bar): add initial suggestions to AQL

0b0b451

- (AQL) Add the fields and an open operator group when there is no input text

feat(search-bar): add target and rel attributes to the documentation

ab8a555

link of query language displayed in the popover

feat(search-bar): Rename HAQL query language to WQL

22676d4

- Rename query language HAQL to WQL - Update tests - Remove AQL usage from the implementation in the agents section

feat(search-bar): Add more use cases to the tests of WQL query language

459a932

- Add more use cases to the test of WQL query language - Replace some literals by constants in the WQL query language implementation

feat(search-bar): enhance the documenation of query languages

315932a

feat(search-bar): Add a popover title to replicate similar UI to the …

4303a1a

…platform search bar

feat(search-bar): wrap the user input with group operators when there…

5e1485c

… is an implicit query

feat(search-bar): set the width of the syntax options popover

1eaf944

feat(search-bar): unify suggestion descriptions in WQL

d9abea0

- 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

feat(search-bar): add enhancements to WQL

c221f97

- WQL - Enhance documentation - Add partial and "expanded" input validation - Add tests

Merge branch '4.5' of https://github.com/wazuh/wazuh-kibana-app into …

8123d6e

…feat/4312-poc-search-bar-component-multiple-query-language-api-query-language-implementation

feat(search-bar): rename previousField and previousOperatorCompare in…

cdbbb6d

… WQL

fix(tests): update snapshot

c300fa3

fix(search-bar): fix documentation link for WQL

ef85c54

fix(search-bar): remove example usage of SearchBar component in Agents

17053c0

fix(search-bar): fix an error using the value suggestions in WQL

cfbf19b

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.

Merge branch '4.5' into feat/4312-poc-search-bar-component-multiple-q…

b4359ce

…uery-language-api-query-language-implementation

Merge branch '4.5' into feat/4312-poc-search-bar-component-multiple-q…

8438cd8

…uery-language-api-query-language-implementation

feat(search-bar): add search function suggestion when the input is empty

57d11d6

fix(search-bar): ensure the query language output changed to trigger …

ce4bc92

…the onChange handler

feat(search-bar): enhance the validation of value token in WQL

a3c3681

Desvelao requested a review from a team as a code owner August 9, 2023 09:41

Desvelao added 6 commits August 9, 2023 11:52

Merge branch 'feat/4312-search-bar-replace-tablewzapi' of https://git…

fccb941

…hub.com/wazuh/wazuh-kibana-app into feat/4312-search-bar-replace-agents

changelog: add entry

c245533

fix(wql): add whitespace before closing grouping operator ) when usin…

9e121ad

…g the suggestions

feat(search-bar): add a debounce time to update the search bar state

8ed6ae4

fix(search-bar): fix prop type error related to EuiSuggestItem

a2abff5

Merge branch 'feat/4312-search-bar-replace-tablewzapi' of https://git…

b51b935

…hub.com/wazuh/wazuh-kibana-app into feat/4312-search-bar-replace-agents

asteriscos self-requested a review August 10, 2023 11:45

Desvelao added 4 commits August 10, 2023 14:08

fix(search-bar-wql): problem related to execute the search before the…

99aa426

… input is analyzed due to this process is debounced

Merge branch 'feat/4312-search-bar-replace-tablewzapi' of https://git…

cbaded2

…hub.com/wazuh/wazuh-kibana-app into feat/4312-search-bar-replace-agents

fix(search-bar-wql): remove unnued parameter in function

4ff2653

Merge branch 'feat/4312-search-bar-replace-tablewzapi' of https://git…

dbefd01

…hub.com/wazuh/wazuh-kibana-app into feat/4312-search-bar-replace-agents

Tostti self-requested a review August 10, 2023 13:03

Tostti previously approved these changes Aug 10, 2023

View reviewed changes

Desvelao added 3 commits August 10, 2023 16:07

fix(search-bar): fix tests

a320b78

fix(search-bar): suggestions in Modules > Vulenerabilities > Inventory

df8a8d3

Merge branch 'feat/4312-search-bar-replace-tablewzapi' of https://git…

80b4e66

…hub.com/wazuh/wazuh-kibana-app into feat/4312-search-bar-replace-agents

Desvelao dismissed Tostti’s stale review via 80b4e66 August 10, 2023 14:32

Tostti previously approved these changes Aug 10, 2023

View reviewed changes

asteriscos previously approved these changes Aug 10, 2023

View reviewed changes

Merge branch '4.6.0' of https://github.com/wazuh/wazuh-kibana-app int…

fc7a56a

…o feat/4312-search-bar-replace-agents

Desvelao dismissed stale reviews from asteriscos and Tostti via fc7a56a August 11, 2023 13:58

changelog: add entry

168cfbd

Tostti approved these changes Aug 11, 2023

View reviewed changes

Desvelao merged commit 0ecdcb0 into 4.6.0 Aug 11, 2023
2 checks passed

Desvelao deleted the feat/4312-search-bar-replace-agents branch August 11, 2023 14:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace search bar on Agents #5452

Replace search bar on Agents #5452

Desvelao commented May 17, 2023 •

edited

Loading

asteriscos commented Aug 10, 2023 •

edited

Loading

Tostti commented Aug 10, 2023 •

edited

Loading

Tostti left a comment

github-actions bot commented Aug 11, 2023

Replace search bar on Agents #5452

Replace search bar on Agents #5452

Conversation

Desvelao commented May 17, 2023 • edited Loading

Description

Issues Resolved

Evidence

Test

UI

Check List

asteriscos commented Aug 10, 2023 • edited Loading

Test

Tostti commented Aug 10, 2023 • edited Loading

UI

Tostti left a comment

Choose a reason for hiding this comment

github-actions bot commented Aug 11, 2023

Desvelao commented May 17, 2023 •

edited

Loading

asteriscos commented Aug 10, 2023 •

edited

Loading

Tostti commented Aug 10, 2023 •

edited

Loading