Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add frontend state service #7037

Merged
merged 40 commits into from
Jan 7, 2025
Merged

Add frontend state service #7037

merged 40 commits into from
Jan 7, 2025

Conversation

Desvelao
Copy link
Member

@Desvelao Desvelao commented Sep 30, 2024 •
edited
Loading

Description

This pull request adds a state service to the wazuh-core plugin and expose it in the plugin lifecycle methods.

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.

The state services is based on AppState old service:

AppState state Description
getClusterInfo server_host_cluster_info > get
setClusterInfo server_host_cluster_info > set
getCurrentApi server_host > get
setCurrentApi server_host > set
removeCurrentAPI server_host > remove
getCurrentPattern data_source_alerts > get
setCurrentPattern data_source_alerts > set
removeCurrentPattern data_source_alerts > remove

Issues Resolved

#6959

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

@Desvelao
feat(state): create state core service
c289b6b 
- Create state service based on AppState from main plugin
- Create state containers
  - server_host
  - server_host_cluster_info
  - data_source_alerts
- Add documentation for state service
@Desvelao Desvelao self-assigned this Sep 30, 2024
@Desvelao Desvelao linked an issue Sep 30, 2024 that may be closed by this pull request
Extract common services from main plugin #6959
Closed
6 tasks
@Desvelao Desvelao mentioned this pull request Sep 30, 2024
Closed
6 tasks
@Desvelao
chore: remove unused methods and no-effect functions
4328609 
- Remove unused methods:
  - AppState.setCreatedAt
  - AppState.getCreatedAt
  - AppState.getAPISelector
  - AppState.getPatternSelector
  - AppState.setPatternSelector (no-effect)

- Remove usage of AppState.setPatternSelector because this has no
  effect in the current application
@Desvelao
feat(state): add tests
bf5a9ab
@Desvelao
feat(state): wrap the subscrition handler to allow they can unsubscri…
f2e54f6 
…bed when the plugin stops

- Remove console.log
- Dispatch new values when remove from the state containers
@yenienserrano yenienserrano self-requested a review November 21, 2024 21:17
guidomodarelli
guidomodarelli reviewed Nov 22, 2024
View reviewed changes
plugins/wazuh-core/public/services/state/containers/server-host-cluster-info.ts Outdated Show resolved Hide resolved
plugins/wazuh-core/public/services/state/containers/server-host-cluster-info.ts Outdated Show resolved Hide resolved
plugins/wazuh-core/public/services/state/containers/data-source-alerts.ts Outdated Show resolved Hide resolved
plugins/wazuh-core/public/services/state/containers/server-host-cluster-info.ts Outdated Show resolved Hide resolved
plugins/wazuh-core/public/services/state/containers/data-source-alerts.ts Outdated Show resolved Hide resolved
plugins/wazuh-core/public/services/state/containers/server-host.ts Outdated Show resolved Hide resolved
plugins/wazuh-core/public/services/state/containers/server-host-cluster-info.ts Outdated Show resolved Hide resolved
plugins/wazuh-core/public/services/state/containers/data-source-alerts.ts Outdated Show resolved Hide resolved
plugins/wazuh-core/public/services/state/README.md Outdated Show resolved Hide resolved
plugins/wazuh-core/public/services/state/types.ts Outdated Show resolved Hide resolved
@Desvelao Desvelao marked this pull request as ready for review November 28, 2024 13:17
yenienserrano
yenienserrano requested changes Dec 17, 2024
View reviewed changes
Copy link
Member

@yenienserrano yenienserrano left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Test: 🔴

The application is not working for me

image

image

image

@github-actions GitHub Actions
Copy link
Contributor

Wazuh Engine plugin code coverage (Jest) test % values
Statements 8.63% ( 64 / 741 )
Branches 7.94% ( 22 / 277 )
Functions 1.87% ( 7 / 373 )
Lines 9.1% ( 64 / 703 )

@github-actions GitHub Actions
Copy link
Contributor

Wazuh Fleet plugin code coverage (Jest) test % values
Statements 4.68% ( 9 / 192 )
Branches 16.66% ( 7 / 42 )
Functions 1.11% ( 1 / 90 )
Lines 4.76% ( 9 / 189 )

@github-actions GitHub Actions
Copy link
Contributor

Main plugin code coverage (Jest) test % values
Statements 13.42% ( 4021 / 29957 )
Branches 8.98% ( 1746 / 19439 )
Functions 12.96% ( 941 / 7259 )
Lines 13.59% ( 3920 / 28838 )

@chantal-kelm chantal-kelm self-requested a review December 23, 2024 14:46
@JuanGarriuz JuanGarriuz self-requested a review December 23, 2024 15:46
chantal-kelm
chantal-kelm previously approved these changes Dec 23, 2024
View reviewed changes
Copy link
Member

@chantal-kelm chantal-kelm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CR: ✅
TEST: ✅

Captura de pantalla 2024-12-23 a la(s) 1 41 11 p  m

JuanGarriuz
JuanGarriuz previously approved these changes Dec 26, 2024
View reviewed changes
Copy link
Member

@JuanGarriuz JuanGarriuz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Test 🟢

image

CR 🟢

@Desvelao
Merge branch 'master' of https://github.com/wazuh/wazuh-kibana-app in…
ce72e83 
…to enhancement/6959-extract-common-services-frontend-state
@Desvelao Desvelao dismissed stale reviews from JuanGarriuz and chantal-kelm via ce72e83 January 7, 2025 08:54
@Desvelao
Copy link
Member Author

Desvelao commented Jan 7, 2025

Changes

  • Updated development branch with latest changes

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jan 7, 2025

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 )

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jan 7, 2025

Wazuh Core plugin code coverage (Jest) test % values
Statements 28.93% ( 640 / 2212 )
Branches 29.8% ( 335 / 1124 )
Functions 27.3% ( 163 / 597 )
Lines 29.06% ( 635 / 2185 )

guidomodarelli
guidomodarelli approved these changes Jan 7, 2025
View reviewed changes
Copy link
Contributor

@guidomodarelli guidomodarelli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🟢

yenienserrano
yenienserrano approved these changes Jan 7, 2025
View reviewed changes
Copy link
Member

@yenienserrano yenienserrano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
image

@Desvelao Desvelao merged commit 4aa5ab8 into master Jan 7, 2025
5 checks passed
@Desvelao Desvelao deleted the enhancement/6959-extract-common-services-frontend-state branch January 7, 2025 14:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@yenienserrano yenienserrano yenienserrano approved these changes

@guidomodarelli guidomodarelli guidomodarelli approved these changes

@JuanGarriuz JuanGarriuz Awaiting requested review from JuanGarriuz

@chantal-kelm chantal-kelm Awaiting requested review from chantal-kelm

Assignees

@Desvelao Desvelao

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Extract common services from main plugin
5 participants
@Desvelao @guidomodarelli @yenienserrano @chantal-kelm @JuanGarriuz