Extract common services from main plugin

[asteriscos]

Description

Historically the main Wazuh dashboard plugin contains many common services needed for the different modules to work. We are in the process of segregating the different modules into decoupled plugins, so we need a common service provider for all of them. Therefore we need to evaluate which services are common to the modules and extract them from main plugin into a common service provider plugin.

Objective

• Data persistence model redesign wazuh#22887

Tasks

The steps that have to be completed in order to close the issue.

• Identify and make a list of the services to extract Extract common services from main plugin #6959 (comment)
• Extract the services into a common provider
  • Add frontend http client #7000
  • Add frontend serverSecurity service #7026
  • Add frontend state service #7037
• Implement the common provider in each module

Functional requirements

• We must user the mechanisms provided in the life cycle of OpenSearch plugins to expose them, so other plugins can make use of them.

[Desvelao]

Analysis

Frontend side:

Common services:

Service	File
App state	plugins/main/public/react-services/app-state.js
GenericRequest	plugins/main/public/react-services/generic-request.js
NavigationService	plugins/main/public/react-services/navigation-service.tsx
PatternHandler	plugins/main/public/react-services/pattern-handler.js
WzRequest	plugins/main/public/react-services/wz-request.ts
WzUserPermissions	plugins/main/public/react-services/wz-user-permissions.ts
SavedObject	plugins/main/public/react-services/saved-objects.js
ApiCheck	plugins/main/public/react-services/wz-api-check.js
AgentSupportModule	plugins/main/public/react-services/wz-agents.ts
WzAuthentication	plugins/main/public/react-services/wz-authentication.ts
exportCsv	plugins/main/public/react-services/wz-csv.js

Others:

Service	File
useSearchBar
WzSearchBar
useDataSource
WzDiscover
WzFlyoutDiscover
useForm
InputForm
TableWzAPI
DataSource

Port services

Frontend

Type	Service	Old services	Description
service	http	WzRequest, GenericRequest, ApiCheck, WzAuthentication	Client to run API requests to the backend side
service	serverSecurity	WzUserPermissions, WzButtonPermissions, WzElementPermissions	Manage the server security
service	state	AppState	Manage the shared state

[Desvelao]

Frontend - http

The http provides a custom mechanim to do an API request to the backend side.

This defines a request interceptor that disables the requests when core.http returns a response with status code 401, avoiding a problem in the login flow (with SAML).

The request interceptor is used in the clients:

• generic
• server

Generic

This client provides a method to run the request that injects some properties related to an index pattern and selected server API host in the headers of the API request that could be used for some backend endpoints

Server

This client provides:

• some methods to communicate with the Wazuh server API
• manage authentication with Wazuh server API
• store the login data

[Desvelao]

Frontend - serverSecurity

The serverSecurity service manages the security related to the Wazuh server.

• Permissions

Expose hooks, HOCs and UI elements related to the user permissions.

[Desvelao]

Frontend - state

The state service manages the shared state of the Wazuh plugins and it is a HUB of state containers. Features:

• Extensible
• Register state containers
• Ability to get, set, remove data and subscribe to changes of state containers

The state containers provides a mechanism to manage a specific state. For example, some data is stored in cookies, others could be managed in-memory, local storage, session storage.

Others plugins can register new state containers.

The service creates hooks and HOCs that are exposed through the plugin lifecycle.