-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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.
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
Creating a shared component for the Risk Engine's countdown text #203212
Creating a shared component for the Risk Engine's countdown text #203212
Conversation
Pinging @elastic/security-entity-analytics (Team:Entity Analytics) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The code looks to me.
I noticed that useRiskEngineStatus
is called in two places. Does the API call get cached, or do we make two different API calls?
Does it make sense to share riskEngineStatus
between the component and the hook to prevent it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks for the hard work 🚀
Yes, it was a separate nested API call, which seems unnecessary since we’re already fetching the engine status at a |
…github.com/abhishekbhatia1710/kibana into ea-task-ui-countDown-text-shared-component
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
@elasticmachine merge upstream |
merge conflict between base and head |
…n-text-shared-component
Starting backport for target branches: 8.x https://github.com/elastic/kibana/actions/runs/12373182459 |
💚 Build Succeeded
Metrics [docs]Async chunks
History
|
…stic#203212) ## Summary The countdown text for the Risk Engine did not update without a page refresh. ![Screenshot 2024-12-05 at 2 50 43 PM](https://github.com/user-attachments/assets/9f8ea7ce-1a5d-4c56-8198-199acc75fb49) This pull request includes changes to the `use_risk_engine_status.ts` and `schedule_risk_engine_callout.tsx` files to enhance the functionality and code quality. The most important changes include the addition of a countdown timer, refactoring of existing code, and improvements to the import statements. Enhancements and new functionality: * Added `useRiskEngineCountdownTime` hook to provide a countdown timer for the risk engine status. Refactoring and code quality improvements: * Refactored the `ScheduleRiskEngineCallout` component to use the new `useRiskEngineCountdownTime` hook, simplifying the code by creating a shared hook and removing the `useMemo` logic for countdown text. * Improved import statements by adding `useMemo` and `moment` in `use_risk_engine_status.ts` and removing unused imports in `schedule_risk_engine_callout.tsx`. ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The `release_note:breaking` label should be applied in these situations. - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) (cherry picked from commit 5c260a4)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
…n text (#203212) (#204565) # Backport This will backport the following commits from `main` to `8.x`: - [Creating a shared component for the Risk Engine's countdown text (#203212)](#203212) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Abhishek Bhatia","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-12-17T12:38:53Z","message":"Creating a shared component for the Risk Engine's countdown text (#203212)\n\n## Summary\n\nThe countdown text for the Risk Engine did not update without a page\nrefresh.\n\n![Screenshot 2024-12-05 at 2 50\n43 PM](https://github.com/user-attachments/assets/9f8ea7ce-1a5d-4c56-8198-199acc75fb49)\n\nThis pull request includes changes to the `use_risk_engine_status.ts`\nand `schedule_risk_engine_callout.tsx` files to enhance the\nfunctionality and code quality. The most important changes include the\naddition of a countdown timer, refactoring of existing code, and\nimprovements to the import statements.\n\nEnhancements and new functionality:\n\n* Added `useRiskEngineCountdownTime` hook to provide a countdown timer\nfor the risk engine status.\n\nRefactoring and code quality improvements:\n\n* Refactored the `ScheduleRiskEngineCallout` component to use the new\n`useRiskEngineCountdownTime` hook, simplifying the code by creating a\nshared hook and removing the `useMemo` logic for countdown text.\n* Improved import statements by adding `useMemo` and `moment` in\n`use_risk_engine_status.ts` and removing unused imports in\n`schedule_risk_engine_callout.tsx`.\n\n\n### Checklist\n\nCheck the PR satisfies following conditions. \n\n\nReviewers should verify this PR satisfies this list as well.\n\n- [x] [Unit or functional\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\nwere updated or added to match the most common scenarios\n- [ ] If a plugin configuration key changed, check if it needs to be\nallowlisted in the cloud and added to the [docker\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\n- [ ] This was checked for breaking HTTP API changes, and any breaking\nchanges have been approved by the breaking-change committee. The\n`release_note:breaking` label should be applied in these situations.\n- [ ] [Flaky Test\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was\nused on any tests changed\n- [ ] The PR description includes the appropriate Release Notes section,\nand the correct `release_note:*` label is applied per the\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"5c260a45ee0f787a5f5d07feb20f9630c1e1e716","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["bug","release_note:fix","v9.0.0","Team:Entity Analytics","backport:version","8.18 candidate","v8.18.0"],"title":"Creating a shared component for the Risk Engine's countdown text","number":203212,"url":"https://github.com/elastic/kibana/pull/203212","mergeCommit":{"message":"Creating a shared component for the Risk Engine's countdown text (#203212)\n\n## Summary\n\nThe countdown text for the Risk Engine did not update without a page\nrefresh.\n\n![Screenshot 2024-12-05 at 2 50\n43 PM](https://github.com/user-attachments/assets/9f8ea7ce-1a5d-4c56-8198-199acc75fb49)\n\nThis pull request includes changes to the `use_risk_engine_status.ts`\nand `schedule_risk_engine_callout.tsx` files to enhance the\nfunctionality and code quality. The most important changes include the\naddition of a countdown timer, refactoring of existing code, and\nimprovements to the import statements.\n\nEnhancements and new functionality:\n\n* Added `useRiskEngineCountdownTime` hook to provide a countdown timer\nfor the risk engine status.\n\nRefactoring and code quality improvements:\n\n* Refactored the `ScheduleRiskEngineCallout` component to use the new\n`useRiskEngineCountdownTime` hook, simplifying the code by creating a\nshared hook and removing the `useMemo` logic for countdown text.\n* Improved import statements by adding `useMemo` and `moment` in\n`use_risk_engine_status.ts` and removing unused imports in\n`schedule_risk_engine_callout.tsx`.\n\n\n### Checklist\n\nCheck the PR satisfies following conditions. \n\n\nReviewers should verify this PR satisfies this list as well.\n\n- [x] [Unit or functional\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\nwere updated or added to match the most common scenarios\n- [ ] If a plugin configuration key changed, check if it needs to be\nallowlisted in the cloud and added to the [docker\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\n- [ ] This was checked for breaking HTTP API changes, and any breaking\nchanges have been approved by the breaking-change committee. The\n`release_note:breaking` label should be applied in these situations.\n- [ ] [Flaky Test\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was\nused on any tests changed\n- [ ] The PR description includes the appropriate Release Notes section,\nand the correct `release_note:*` label is applied per the\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"5c260a45ee0f787a5f5d07feb20f9630c1e1e716"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/203212","number":203212,"mergeCommit":{"message":"Creating a shared component for the Risk Engine's countdown text (#203212)\n\n## Summary\n\nThe countdown text for the Risk Engine did not update without a page\nrefresh.\n\n![Screenshot 2024-12-05 at 2 50\n43 PM](https://github.com/user-attachments/assets/9f8ea7ce-1a5d-4c56-8198-199acc75fb49)\n\nThis pull request includes changes to the `use_risk_engine_status.ts`\nand `schedule_risk_engine_callout.tsx` files to enhance the\nfunctionality and code quality. The most important changes include the\naddition of a countdown timer, refactoring of existing code, and\nimprovements to the import statements.\n\nEnhancements and new functionality:\n\n* Added `useRiskEngineCountdownTime` hook to provide a countdown timer\nfor the risk engine status.\n\nRefactoring and code quality improvements:\n\n* Refactored the `ScheduleRiskEngineCallout` component to use the new\n`useRiskEngineCountdownTime` hook, simplifying the code by creating a\nshared hook and removing the `useMemo` logic for countdown text.\n* Improved import statements by adding `useMemo` and `moment` in\n`use_risk_engine_status.ts` and removing unused imports in\n`schedule_risk_engine_callout.tsx`.\n\n\n### Checklist\n\nCheck the PR satisfies following conditions. \n\n\nReviewers should verify this PR satisfies this list as well.\n\n- [x] [Unit or functional\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\nwere updated or added to match the most common scenarios\n- [ ] If a plugin configuration key changed, check if it needs to be\nallowlisted in the cloud and added to the [docker\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\n- [ ] This was checked for breaking HTTP API changes, and any breaking\nchanges have been approved by the breaking-change committee. The\n`release_note:breaking` label should be applied in these situations.\n- [ ] [Flaky Test\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was\nused on any tests changed\n- [ ] The PR description includes the appropriate Release Notes section,\nand the correct `release_note:*` label is applied per the\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"5c260a45ee0f787a5f5d07feb20f9630c1e1e716"}},{"branch":"8.x","label":"v8.18.0","branchLabelMappingKey":"^v8.18.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Abhishek Bhatia <[email protected]>
…stic#203212) ## Summary The countdown text for the Risk Engine did not update without a page refresh. ![Screenshot 2024-12-05 at 2 50 43 PM](https://github.com/user-attachments/assets/9f8ea7ce-1a5d-4c56-8198-199acc75fb49) This pull request includes changes to the `use_risk_engine_status.ts` and `schedule_risk_engine_callout.tsx` files to enhance the functionality and code quality. The most important changes include the addition of a countdown timer, refactoring of existing code, and improvements to the import statements. Enhancements and new functionality: * Added `useRiskEngineCountdownTime` hook to provide a countdown timer for the risk engine status. Refactoring and code quality improvements: * Refactored the `ScheduleRiskEngineCallout` component to use the new `useRiskEngineCountdownTime` hook, simplifying the code by creating a shared hook and removing the `useMemo` logic for countdown text. * Improved import statements by adding `useMemo` and `moment` in `use_risk_engine_status.ts` and removing unused imports in `schedule_risk_engine_callout.tsx`. ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The `release_note:breaking` label should be applied in these situations. - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
Summary
The countdown text for the Risk Engine did not update without a page refresh.
This pull request includes changes to the
use_risk_engine_status.ts
andschedule_risk_engine_callout.tsx
files to enhance the functionality and code quality. The most important changes include the addition of a countdown timer, refactoring of existing code, and improvements to the import statements.Enhancements and new functionality:
useRiskEngineCountdownTime
hook to provide a countdown timer for the risk engine status.Refactoring and code quality improvements:
ScheduleRiskEngineCallout
component to use the newuseRiskEngineCountdownTime
hook, simplifying the code by creating a shared hook and removing theuseMemo
logic for countdown text.useMemo
andmoment
inuse_risk_engine_status.ts
and removing unused imports inschedule_risk_engine_callout.tsx
.Checklist
Check the PR satisfies following conditions.
Reviewers should verify this PR satisfies this list as well.
release_note:breaking
label should be applied in these situations.release_note:*
label is applied per the guidelines