Refactor ruleset management #4174

asteriscos · 2022-05-26T14:57:39Z

Description

This PR refactors the views related to the management of the ruleset:

To use standard / reusable Wazuh tables and flyouts to improve maintainability.
Removes the use of redux on a single ruleset view to determine whether it renders rules, decoders, or CDB lists.
Segregates the module's views in their own module folder to simplify the logic and improve maintainability.
Integrates the rules / decoders details as a flyout in the table view, improving consistency with other table-details behavior in the app.
Fixes redundant API requests in the reusable Wazuh API table component.
Enhances Wazuh API table component with custom action buttons.

Fixes a ruleset view pagination bug when the it parsed the rule id from the redirectRule query param. It could not retrieve the rule details if it was not in the first 500 results

Closes #4105

Screenshots

Table view

Details flyout

Test cases

Summary

All calls to action and navigation elements should be tested in Rules, Decoders, CDB Lists modules. When in doubt, compare the behavior of the feature with any 4.3.x Wazuh version

Tests:

All table features
- Pagination
- Sorting
- Row clicking
- Links within the table rows
- Search input
- Custom action buttons (Manage rule files, Add new rule file, Refresh, Export formatted, etc.)
  - Manage rule / decoder files button should clear previous filters before switching the table
- Custom rules / decoders filter button
Clicking a row in the rules or decoders tables should open a flyout with the details of the selected item.
- In the details flyout information accordion, there are "links" that should close the flyout and filter the property in the background table.
- Clicking a row in the table within the details flyout should replace the information in the flyout with the selected item.
- Clicking the rule / decoder filename in the tables should load the file content view.
Clicking a rule.id in the Events table should load the rules view with an open flyout showing the selected rule information

github-actions · 2022-05-26T15:09:08Z

Jest Test Coverage	%	values
Statements	4.05%	( 1487 / 36690 )
Branches	1.62%	( 463 / 28551 )
Functions	2.97%	( 267 / 8978 )
Lines	4.1%	( 1439 / 35067 )

…azuh/wazuh-kibana-app into refactor/management-rules-4105

AlexRuiz7

Great work so far, however, threre are a few things that need review!

Let's keep up the good work! 💪🏻

public/controllers/management/components/management/cdblists/main-cdblists.tsx

public/controllers/management/components/management/common/constants.ts

public/controllers/management/components/management/ruleset/views/rule-info.tsx

public/controllers/management/components/management/ruleset/main-ruleset.tsx

public/controllers/management/components/management/common/actions-buttons.tsx

public/controllers/management/components/management/decoders/components/decoders-table.tsx

public/controllers/management/components/management/decoders/components/flyout-detail.tsx

public/controllers/management/components/management/decoders/main-decoders.tsx

Mayons95 · 2022-09-07T18:28:09Z

Testing RBAC with the refactor

Read Only User:

Read - Delete:

Read - Write:

I need help checking the needed permissions to create/update a rule.
I try to test it and I got this error:

C.C @asteriscos @AlexRuiz7

asteriscos · 2022-09-08T12:02:08Z

@Mayons95 could you please specify which roles/permissions were used in your tests?

I used a read-only rules test case and this was the outcome.

AlexRuiz7

LGTM!

asteriscos · 2022-09-09T15:48:24Z

RBAC Tests

I tested this roles with each call to action and work as expected. With this we finish RBAC tests in this PR and is ready to merge.

Policies

Cases

* Refactored implementation of wazuh table * Refactored action buttons * Partial commit ruleset views segregation * Added searchbar input custom filter buttons * Added Custom Field Filter to table & removed redux from action buttons * Segregated file tables * set showingFiles locally * Fixed details flyout * Segregate views * Removed redux from ruleset editor * refactored Decoders section * delete obsolete decoder-info * Fixed decoder flyout * Added decoder info.tsx * Remove unused files * Set CDBList views * Dynamically build table custom action buttons * Deleted hardcoded export csv filename * Fix CDB List row click handler * Fixed suggestions and custom actions responsive styles * columns configuration fix * wzApiTable optimization + obsolete redux cleaning * Implemented Wazuh flyouts * Convert to typescript * Extracted tables components * Fix mapStateToProps to null * Removed ruleset redux files * Removed Add CDB List button in ruleset and decoders views * Fix missing updateListContent * Added external reload to the tables * Fixed redirectRule url cleaning * Fix onClose modal preventDefault * Fix reload props * Fix onClick modal preventDefault * Clean code comments * Added error handling to tables columns * removed deprecated code * Fixed file description and objects destructuring * Refactored class components to functional * Changed file view state handling * Refactored implementation of wazuh table * Refactored action buttons * Partial commit ruleset views segregation * Added searchbar input custom filter buttons * Added Custom Field Filter to table & removed redux from action buttons * Segregated file tables * set showingFiles locally * Fixed details flyout * Segregate views * Removed redux from ruleset editor * refactored Decoders section * delete obsolete decoder-info * Fixed decoder flyout * Added decoder info.tsx * Remove unused files * Set CDBList views * Dynamically build table custom action buttons * Deleted hardcoded export csv filename * Fix CDB List row click handler * Fixed suggestions and custom actions responsive styles * columns configuration fix * wzApiTable optimization + obsolete redux cleaning * Implemented Wazuh flyouts * Convert to typescript * Extracted tables components * Fix mapStateToProps to null * Removed ruleset redux files * Removed Add CDB List button in ruleset and decoders views * Fix missing updateListContent * Added external reload to the tables * Fixed redirectRule url cleaning * Fix onClose modal preventDefault * Fix reload props * Fix onClick modal preventDefault * Clean code comments * Added error handling to tables columns * removed deprecated code * Fixed file description and objects destructuring * Refactored class components to functional * Changed file view state handling * Remove unused imports * Fixed ResourcesHandler * Added interfaces and fixed comments * Add section contants * Code styling * Replaced string for constants Co-authored-by: Alex Ruiz Becerra <alejandro.ruiz.becerra@wazuh.com> (cherry picked from commit 5db8ae0)

Refactor ruleset management (#4174) * Refactored implementation of wazuh table * Refactored action buttons * Partial commit ruleset views segregation * Added searchbar input custom filter buttons * Added Custom Field Filter to table & removed redux from action buttons * Segregated file tables * set showingFiles locally * Fixed details flyout * Segregate views * Removed redux from ruleset editor * refactored Decoders section * delete obsolete decoder-info * Fixed decoder flyout * Added decoder info.tsx * Remove unused files * Set CDBList views * Dynamically build table custom action buttons * Deleted hardcoded export csv filename * Fix CDB List row click handler * Fixed suggestions and custom actions responsive styles * columns configuration fix * wzApiTable optimization + obsolete redux cleaning * Implemented Wazuh flyouts * Convert to typescript * Extracted tables components * Fix mapStateToProps to null * Removed ruleset redux files * Removed Add CDB List button in ruleset and decoders views * Fix missing updateListContent * Added external reload to the tables * Fixed redirectRule url cleaning * Fix onClose modal preventDefault * Fix reload props * Fix onClick modal preventDefault * Clean code comments * Added error handling to tables columns * removed deprecated code * Fixed file description and objects destructuring * Refactored class components to functional * Changed file view state handling * Refactored implementation of wazuh table * Refactored action buttons * Partial commit ruleset views segregation * Added searchbar input custom filter buttons * Added Custom Field Filter to table & removed redux from action buttons * Segregated file tables * set showingFiles locally * Fixed details flyout * Segregate views * Removed redux from ruleset editor * refactored Decoders section * delete obsolete decoder-info * Fixed decoder flyout * Added decoder info.tsx * Remove unused files * Set CDBList views * Dynamically build table custom action buttons * Deleted hardcoded export csv filename * Fix CDB List row click handler * Fixed suggestions and custom actions responsive styles * columns configuration fix * wzApiTable optimization + obsolete redux cleaning * Implemented Wazuh flyouts * Convert to typescript * Extracted tables components * Fix mapStateToProps to null * Removed ruleset redux files * Removed Add CDB List button in ruleset and decoders views * Fix missing updateListContent * Added external reload to the tables * Fixed redirectRule url cleaning * Fix onClose modal preventDefault * Fix reload props * Fix onClick modal preventDefault * Clean code comments * Added error handling to tables columns * removed deprecated code * Fixed file description and objects destructuring * Refactored class components to functional * Changed file view state handling * Remove unused imports * Fixed ResourcesHandler * Added interfaces and fixed comments * Add section contants * Code styling * Replaced string for constants Co-authored-by: Alex Ruiz Becerra <alejandro.ruiz.becerra@wazuh.com> (cherry picked from commit 5db8ae0) Co-authored-by: Federico Rodriguez <federico.rodriguez@wazuh.com>

Refactored implementation of wazuh table

2f87445

asteriscos self-assigned this May 26, 2022

asteriscos added 6 commits May 27, 2022 18:56

Refactored action buttons

1d07dec

Partial commit ruleset views segregation

8aa84f2

Added searchbar input custom filter buttons

ccc99e0

Added Custom Field Filter to table & removed redux from action buttons

49da44c

Segregated file tables

1e45afd

set showingFiles locally

7a5f031

AlexRuiz7 linked an issue Jun 1, 2022 that may be closed by this pull request

TypeError in Management/Rules #4105

Closed

asteriscos added 5 commits June 15, 2022 15:51

Fixed details flyout

3f2d38b

Segregate views

25d0ec9

Removed redux from ruleset editor

16e6f8e

refactored Decoders section

bc0ec81

delete obsolete decoder-info

4a50e2d

Desvelao changed the base branch from 4.3-7.10 to 4.4-7.10 June 24, 2022 08:56

Desvelao added backport 4.4-7.16 labels Jun 24, 2022

asteriscos added 12 commits June 27, 2022 10:32

Fixed decoder flyout

779308c

Added decoder info.tsx

ca705f8

Remove unused files

491ec09

Set CDBList views

64822e4

Dynamically build table custom action buttons

c6df6b9

Deleted hardcoded export csv filename

b8b5579

Fix CDB List row click handler

097b45d

Fixed suggestions and custom actions responsive styles

0ce3da1

columns configuration fix

c1856de

wzApiTable optimization + obsolete redux cleaning

e5e7d11

Implemented Wazuh flyouts

82aa3af

Convert to typescript

ca83b38

asteriscos and others added 4 commits September 5, 2022 12:23

Changed file view state handling

ebb4581

Merge branch 'refactor/management-rules-4105' of https://github.com/w…

4d2621e

…azuh/wazuh-kibana-app into refactor/management-rules-4105

Remove unused imports

472e6e6

Fixed ResourcesHandler

842cfb3

AlexRuiz7 changed the base branch from 4.4-7.10 to 4.4-7.10-test September 5, 2022 15:03

asteriscos changed the base branch from 4.4-7.10-test to 4.4-7.10 September 5, 2022 15:06

AlexRuiz7 suggested changes Sep 7, 2022

View reviewed changes

AlexRuiz7 changed the title ~~Refactor management/rules~~ Refactor ruleset management Sep 7, 2022

Added interfaces and fixed comments

61d1527

Mayons95 mentioned this pull request Sep 7, 2022

Manual - Test Plan Design for Release 4.4.0 #4451

Closed

4 tasks

Add section contants

8af9d99

Code styling

fec6c9e

AlexRuiz7 approved these changes Sep 8, 2022

View reviewed changes

Replaced string for constants

99b6152

AlexRuiz7 approved these changes Sep 9, 2022

View reviewed changes

asteriscos merged commit 5db8ae0 into 4.4-7.10 Sep 9, 2022

asteriscos deleted the refactor/management-rules-4105 branch September 9, 2022 16:01

github-actions bot mentioned this pull request Sep 9, 2022

[Backport 4.4-7.16] Refactor ruleset management #4486

Merged

github-actions bot mentioned this pull request Sep 9, 2022

[Backport 4.4-1.2-wzd] Refactor ruleset management #4487

Merged

AlexRuiz7 mentioned this pull request Oct 18, 2022

Wrong behavior from the Flyout component in Wazuh Dashboard 2.x #4597

Closed

11 tasks

Mayons95 mentioned this pull request Nov 18, 2022

Release 4.4.0 - Alpha 1 - Kibana UI regression testing #4895

Closed

7 tasks

Mayons95 mentioned this pull request Dec 7, 2022

Test the plugin in Wazuh Dashboard #4740

Closed

1 task

Desvelao mentioned this pull request Dec 20, 2022

Fix vulnerabilities in dependencies #5014

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor ruleset management #4174

Refactor ruleset management #4174

asteriscos commented May 26, 2022 •

edited by AlexRuiz7

Loading

github-actions bot commented May 26, 2022

AlexRuiz7 left a comment

Mayons95 commented Sep 7, 2022 •

edited

Loading

asteriscos commented Sep 8, 2022

AlexRuiz7 left a comment

asteriscos commented Sep 9, 2022

Refactor ruleset management #4174

Refactor ruleset management #4174

Conversation

asteriscos commented May 26, 2022 • edited by AlexRuiz7 Loading

Description

Screenshots

Table view

Details flyout

Test cases

Summary

Tests:

github-actions bot commented May 26, 2022

AlexRuiz7 left a comment

Choose a reason for hiding this comment

Mayons95 commented Sep 7, 2022 • edited Loading

asteriscos commented Sep 8, 2022

AlexRuiz7 left a comment

Choose a reason for hiding this comment

asteriscos commented Sep 9, 2022

RBAC Tests

Policies

Cases

asteriscos commented May 26, 2022 •

edited by AlexRuiz7

Loading

Mayons95 commented Sep 7, 2022 •

edited

Loading