Rollback configuration store from saved object to configuration file #6573

Desvelao · 2024-04-04T12:39:58Z

Description

This pull request rollbacks the configuration stored in a saved object to a configuration file.

Changes:

Rollback:
- Remove ability to manage the API connections from the Server APIs
  - Remove API endpoints
    - POST /hosts/apis/{id}
    - PUT /hosts/apis/{id}
    - DELETE /hosts/apis/{id}
  - Remove methods in ManageHosts
  - Remove form to create or edit the API connection entry
  - Remove buttons to edit or delete the API connection
- Add information about adding a new API connection
  - Enhance information message with message about configuration cache
- Remove task to migrate the configuration file to saved object
- Remove API endpoint to import the configuration file POST /utils/configuration/import
- Remove Encryption service of the backend side
- Replace the store system of the configuration based on a saved object with the configuration file
- Change the cache time of configuration from 60 to 10 to match with the previous system
- Replace the consideration of the administrator user to the previous one based on the administrator API
  connection role
  - Remove API endpoint to get data about the account GET /utils/account
Other enhancements:
- Redefine the validation of plugins settings:
  - Rename the validation methods:
  validate -> validateUIForm
  validateBackend -> validate
  - Reduce the usage of @osd/config-schema package (used in the related API endpoints)
- Remove the transformation of input values to configuration values done by the useForm hook and managed externally
- Minify the references to branding on the default configuration file
- Change the validation for enrollment.dns on App Settings application. Move the validateServerAddress to SettingsValidators and replace its usage in the Deploy new agent guide
- Replace the hard-coded value for the path of the configuration file. It is retrieved from the backend side.
- Refactor the definition of getCustomizationSetting and its usage to get the plugin settings taking into account the hidden values.
- Remove the default values of some customization settings were displayed on App Settings
- Fix a problem the Miscellaneous tab of App Settings application was not accessible from UI
- Remove deprecated createLogFileIfNotExists method
- Add tests for ConfigurationStore service of the backend side

Issues Resolved

#6570

Evidence

Test

rollback-configuraiton-store

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

UI

Test	Chrome	Firefox	Safari
Ensure the Server APIs application does not have the buttons to edit or remove the API application on the Actions column of the table	⚫	⚫	⚫
In the Server APIs application, click on the Add API connection and should display information about modifying the configuration file	⚫	⚫	⚫
Ensure the customization settings are applied when they are defined and the customization is enabled	⚫	⚫	⚫
Go to App Settings application and check it displays the tabs of Configuration and Miscellaneous	⚫	⚫	⚫

Details

⚫ Ensure the Server APIs application does not have the buttons to edit or remove the API application on the Actions column of the table

Chrome - ⚫

Firefox - ⚫

Safari - ⚫

⚫ In the Server APIs application, click on the Add API connection and should display information about modifying the configuration file

Chrome - ⚫

Firefox - ⚫

Safari - ⚫

⚫ Ensure the customization settings are applied when they are defined and the customization is enabled

Chrome - ⚫

Firefox - ⚫

Safari - ⚫

⚫ Go to App Settings application and check it displays the tabs of Configuration and Miscellaneous

Chrome - ⚫

Firefox - ⚫

Safari - ⚫

Backend

Test	Result
With no configuration file, start Wazuh dashboard, the configuration file should be created with the default configuration	⚫
With a defined configuration file, start Wazuh dashboard, and the configuration file should not be replaced by the default content	⚫
Go to App Settings, edit a setting, this should be saved into the configuration file	⚫

Details

⚫ With no configuration file, start Wazuh dashboard, the configuration file should be created with the default configuration

⚫ With a defined configuration file, start Wazuh dashboard, and the configuration file should not be replaced by the default content

⚫ Go to App Settings, edit a setting, this should be saved into the configuration file

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

…tion file - Rollback the store system to configuration file - Change WAZUH_CORE_CONFIGURATION_CACHE_SECONDS from 60 to 10 - Create logic to ensure the configuration file is created else create it with default configuration on start - Remove task to migrate the configuration file to saved object - Enhance the Configuration service to include references to categories and some utility functions - Remove plugin settings: - wazuh_core.instance - wazuh_core.encryption_key

…e to saved object

…n App Settings application - Display the real path of the configuration file instead of the fixed value on App Settings - Add configuration_file property to the response of GET /api/setup - Refactor the ConfigurationStore services - Minor enhancements typed code

…er APIs - Remove buttons to edit and remove from the table - Change the form to add an API connection by information about editing the configuration file

… backend side - Remove API endpoints and related controllers - POST /hosts/apis/{id} - PUT /hosts/apis/{id} - DELETE /hosts/apis/{id} - Remove methods to manage the API connections in the ManageHosts service

…ue to an error in the backend side - Renamed setting properties: - validate -> validateUIForm - validateBackend -> validate - Adapted the validation on the affected API endpoints - Removed transformation of changed values of useForm hook. This transformation is now done externally.

…n/import

- Enhance the validation of enrollment.dns setting - Replace the validation of the server address input on Deploy new agent guide by the validation of enrollment.dns plugin setting - Remove validateServerAddress method and related tests. Move tests to apply to SettingsValidator

…ization settings on App Settings - Create getSettingValueIfNotSet method for Configuration services to manage the customization settings - Adapt the getCustomizationSetting method of Configuration service to use getSettingValueIfNotSet - Change the parameters of getCustomizationSetting of Configuration service to support multiple settings - Adapt printer to the usage of getCustomizationSettings redefinition - Enhance code typings

…uration file

- Rollback to the consideration of administrator user based on the administrator API connection role - Create logic to check this consideration to the DashboardSecurity services in frontend and backend side - Add getAccountFromJWTAPIDecodedToken method to frontend side - Adapt the WzAuthentication service to use the getAccountFromJWTAPIDecodedToken - Add a constant that defines the ID for the administrator role of the API connection - Remove previous consideration based on the access to the security REST API of the platform - Remove API endpoint `GET /utils/account` and getPluginScopedAccount controller - Remove fetch user account data from the frontend side - Remove fetchAccount method of DashboardSecurity service on the frontend side - Adapt routeDecoratorProtectedAdministrator route decorator - Enhance the message about the administrator missing requirements - Rename administrator_error_message to administrator_requirements related to the consideration of administrator user

…tore in the backend side

…o feat/6570-rollback-plugins-configuration

…in settings

…o feat/6570-rollback-plugins-configuration

…rvice

JuanGarriuz · 2024-04-08T11:24:39Z

Test

rollback-configuration-store

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

UI

Test	Chrome	Firefox	Safari
Ensure the Server APIs application does not have the buttons to edit or remove the API application on the Actions column of the table	🟢	⚫	⚫
In the Server APIs application, click on the Add API connection and should display information about modifying the configuration file	🟢	⚫	⚫
Ensure the customization settings are applied when they are defined and the customization is enabled	🟢	⚫	⚫
Go to App Settings application and check it displays the tabs of Configuration and Miscellaneous	🟢	⚫	⚫

Details

🟢 Ensure the Server APIs application does not have the buttons to edit or remove the API application on the Actions column of the table

Chrome - 🟢

Firefox - ⚫

Safari - ⚫

🟢 In the Server APIs application, click on the Add API connection and should display information about modifying the configuration file

Chrome - 🟢

Firefox - ⚫

Safari - ⚫

🟢 Ensure the customization settings are applied when they are defined and the customization is enabled

Chrome - 🟢

Firefox - ⚫

Safari - ⚫

🟢 Go to App Settings application and check it displays the tabs of Configuration and Miscellaneous

Chrome - 🟢

Firefox - ⚫

Safari - ⚫

Backend

Test	Result
With no configuration file, start Wazuh dashboard, the configuration file should be created with the default configuration	🟢
With a defined configuration file, start Wazuh dashboard, and the configuration file should be replaced by the default content	🟢
Go to App Settings, edit a setting, this should be saved into the configuration file	⚫

Details

🟢 With no configuration file, start Wazuh dashboard, the configuration file should be created with the default configuration

🟢 With a defined configuration file, start Wazuh dashboard, and the configuration file should not be replaced by the default content

🟡 Go to App Settings, edit a setting, this should be saved into the configuration file

🟡 Warning => #6573 (comment)

asteriscos · 2024-04-08T17:25:49Z

UI

Test	Chrome	Firefox	Safari
Ensure the Server APIs application does not have the buttons to edit or remove the API application on the Actions column of the table	🟢	⚫	⚫
In the Server APIs application, click on the Add API connection and should display information about modifying the configuration file	🟢	⚫	⚫
Ensure the customization settings are applied when they are defined and the customization is enabled	🟢	⚫	⚫
Go to App Settings application and check it displays the tabs of Configuration and Miscellaneous	🟢	⚫	⚫

Details

🟢 Ensure the Server APIs application does not have the buttons to edit or remove the API application on the Actions column of the table

Chrome - 🟢

Firefox - ⚫

Safari - ⚫

🟢 In the Server APIs application, click on the Add API connection and should display information about modifying the configuration file

Chrome - 🟢

Firefox - ⚫

Safari - ⚫

🟢 Ensure the customization settings are applied when they are defined and the customization is enabled

Chrome - 🟢

Firefox - ⚫

Safari - ⚫

🟢 Go to App Settings application and check it displays the tabs of Configuration and Miscellaneous

Chrome - 🟢

Firefox - ⚫

Safari - ⚫

Backend

Test	Result
With no configuration file, start Wazuh dashboard, the configuration file should be created with the default configuration	🟢
With a defined configuration file, start Wazuh dashboard, and the configuration file should be replaced by the default content	🟢
Go to App Settings, edit a setting, this should be saved into the configuration file	🟢

Details

🟢 With no configuration file, start Wazuh dashboard, the configuration file should be created with the default configuration

🟢 With a defined configuration file, start Wazuh dashboard, and the configuration file should be replaced by the default content

🟢 Go to App Settings, edit a setting, this should be saved into the configuration file

JuanGarriuz · 2024-04-09T07:53:27Z

When I removed the custom logo quickly, the console got an error related with API

…n/clear - Remove API endpoint POST /utils/configuration/clear - Remove route controller

… period of time - Add plugin setting category: API_CONNECTION (related to hosts setting) - Replace the category of hosts plugin setting - Refactor the setting.store.file interface: - Remove configurable - Add configurableManaged and defaultBlock - Adapt the plugin settings defitions with these changes - Remove the configuration block related to the API connections from the ConfigurationStore service to the plugin setting definition through the defaultBlock - Enhance logging on ManageHosts

github-actions · 2024-04-09T12:22:08Z

Wazuh Core plugin code coverage (Jest) test	%	values
Statements	45.37%	( 397 / 875 )
Branches	41.31%	( 157 / 380 )
Functions	43.83%	( 135 / 308 )
Lines	45.61%	( 395 / 866 )

github-actions · 2024-04-09T12:22:18Z

Wazuh Check Updates plugin code coverage (Jest) test	%	values
Statements	76.44%	( 172 / 225 )
Branches	58.65%	( 61 / 104 )
Functions	61.7%	( 29 / 47 )
Lines	76.44%	( 172 / 225 )

Desvelao · 2024-04-09T12:24:32Z

Changes

Fixed a problem clearing the values for the customization logo settings
More: Rollback the system to save the configuration to configuration file #6570 (comment)

github-actions · 2024-04-09T12:26:43Z

Main plugin code coverage (Jest) test	%	values
Statements	10.81%	( 3750 / 34669 )
Branches	7.27%	( 1653 / 22713 )
Functions	10.52%	( 870 / 8263 )
Lines	10.96%	( 3644 / 33226 )

asteriscos

CR: ✔️
Test: ✔️

Desvelao added 19 commits April 2, 2024 11:13

remove(configuration): remove the migration task of configuration fil…

0015485

…e to saved object

rollback(configuration): remove references to plugin settings defition

8fbbfce

rollback(configuration): remove enhanceConfiguration from frontend side

eebfb94

fix(configuration): replace logger methods for noop

0352d9d

remove: unused constant PLUGIN_PLATFORM_BASE_INSTALLATION_PATH

ea180bc

rollback(configuration): remove management of API connections on Serv…

f183e98

…er APIs - Remove buttons to edit and remove from the table - Change the form to add an API connection by information about editing the configuration file

rollback(configuration): remove management of API connection from the…

82327ff

… backend side - Remove API endpoints and related controllers - POST /hosts/apis/{id} - PUT /hosts/apis/{id} - DELETE /hosts/apis/{id} - Remove methods to manage the API connections in the ManageHosts service

fix: fix innaccesible view of Miscellaneous tab on App Settings

8308756

rollback(configuration): clear entry on configuration file

c363354

rollback(configuration): remove API endpoint POST /utils/configuratio…

d0947e9

…n/import

feat(configuration): enhance validation of plugin settings

38d05c8

clean: import of non-existent method

30b8ae0

rollback(configuration): remove import configuration from file

09e40e4

fix(configuration): minimize the references to branding on the config…

4fd06a2

…uration file

Desvelao self-assigned this Apr 4, 2024

Desvelao linked an issue Apr 4, 2024 that may be closed by this pull request

Rollback the system to save the configuration to configuration file #6570

Closed

15 tasks

Desvelao added 9 commits April 5, 2024 11:03

changelog: adapt some entries related to rollback the configuartion s…

87ce49c

…tore in the backend side

test: fix reporting tests

21ad74f

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

7abbbdf

…o feat/6570-rollback-plugins-configuration

tests: fix of core plugin

c812fba

rollback: remove encryption service

3285237

tests: fix tests

6763d12

tests: remove references to deprecated validateBackend method of plug…

7edf984

…in settings

tests(configuration-store): add tests

ccde82e

Desvelao added 5 commits April 8, 2024 11:06

remove: deprecated createLogFileIfNotExists method

e181033

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

6dd6765

…o feat/6570-rollback-plugins-configuration

fix: comment

a94811a

fix(configuration-store): dirname of configuration file

6965f89

rollback(configuration-store): rename logger of ConfigurationStore se…

7df5a55

…rvice

Desvelao marked this pull request as ready for review April 8, 2024 10:59

asteriscos self-requested a review April 8, 2024 11:09

JuanGarriuz self-requested a review April 8, 2024 11:18

asteriscos previously approved these changes Apr 9, 2024

View reviewed changes

Desvelao added 2 commits April 9, 2024 13:45

rollback(configuration): remove API endpoint POST /utils/configuratio…

4c16459

…n/clear - Remove API endpoint POST /utils/configuration/clear - Remove route controller

Desvelao dismissed asteriscos’s stale review via e85b63b April 9, 2024 12:10

tests(configuration-store): adapt to latest changes

b6f7bfb

Desvelao requested a review from asteriscos April 9, 2024 12:24

asteriscos approved these changes Apr 9, 2024

View reviewed changes

JuanGarriuz approved these changes Apr 9, 2024

View reviewed changes

asteriscos merged commit 5efc20f into 4.9.0 Apr 9, 2024
4 checks passed

asteriscos deleted the feat/6570-rollback-plugins-configuration branch April 9, 2024 13:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rollback configuration store from saved object to configuration file #6573

Rollback configuration store from saved object to configuration file #6573

Desvelao commented Apr 4, 2024 •

edited

JuanGarriuz commented Apr 8, 2024 •

edited

asteriscos commented Apr 8, 2024 •

edited

JuanGarriuz commented Apr 9, 2024

github-actions bot commented Apr 9, 2024

github-actions bot commented Apr 9, 2024

Desvelao commented Apr 9, 2024

github-actions bot commented Apr 9, 2024

asteriscos left a comment

Rollback configuration store from saved object to configuration file #6573

Rollback configuration store from saved object to configuration file #6573

Conversation

Desvelao commented Apr 4, 2024 • edited

Description

Issues Resolved

Evidence

Test

rollback-configuraiton-store

UI

Backend

Check List

JuanGarriuz commented Apr 8, 2024 • edited

Test

rollback-configuration-store

UI

Backend

asteriscos commented Apr 8, 2024 • edited

UI

Backend

JuanGarriuz commented Apr 9, 2024

github-actions bot commented Apr 9, 2024

github-actions bot commented Apr 9, 2024

Desvelao commented Apr 9, 2024

Changes

github-actions bot commented Apr 9, 2024

asteriscos left a comment

Choose a reason for hiding this comment

Desvelao commented Apr 4, 2024 •

edited

JuanGarriuz commented Apr 8, 2024 •

edited

asteriscos commented Apr 8, 2024 •

edited