UI: Expose hooks that retrieve the highest alerts for each entity #3275

ChengYanJin · 2021-04-07T14:32:39Z

Component: ui, alerts

Context:
Provide hooks to fetch the highest severity alerts for each entity to display the health.

 useNodesAlert(): Alert?
 useVolumesAlert(): Alert?
 useServiceAlert(): Alert?
 useNetworkAlert(): Alert?
 getNodesCountQuery(): Query // type Query = {cacheKey, queryFn, options} from react-query
 getVolumesCountQuery(): Query // type Query = {cacheKey, queryFn, options} from react-query

Summary:

const nodesAlerts = useHighestSeverityAlerts(getNodesAlertName());
const volumesAlerts = useHighestSeverityAlerts(getVolumesAlertName());
const volumesAlerts = useHighestSeverityAlerts(getNetworksAlertName());
const volumesAlerts = useHighestSeverityAlerts(getServicesAlertName());
const coutNodes = getNodesCountQuery();
const coutVolumes = getVolumesCountQuery();

As discussed with @JBWatenbergScality, we will eventually remove the AlertProvider from Metalk8s UI.

Acceptance criteria:

Closes: #3257

bert-e · 2021-04-07T14:32:41Z

Hello chengyanjin,

My role is to assist you with the merge of this
pull request. Please type @bert-e help to get information
on this process, or consult the user documentation.

Status report is not available.

bert-e · 2021-04-07T14:32:45Z

Waiting for approval

The following approvals are needed before I can proceed with the merge:

the author
one peer

Peer approvals must include at least 1 approval from the following list:

ui/src/services/alertHooks.js

ui/src/containers/AlertProvider.js

ui/src/services/alertHooks.js

Check if the k8s call carry the id_token, othewise listen to the navbarElement AUTHENTICATED event Refs: #3275

Check if the k8s call carry the `id_token`, otherwise listen to the navbarElement AUTHENTICATED_EVENT Refs: #3275

Refs: #3257

Check if the k8s call carry the `id_token`, otherwise listen to the navbarElement AUTHENTICATED_EVENT Refs: #3275

Refs: #3257

JBWatenbergScality · 2021-04-14T20:21:41Z

shell-ui/src/platform/service/k8s.js

+        .then((res) => {
+          return res.items.length;
+        }),
+    options: { refetchInterval: 10000 },


I think it is missing enabled options :

Suggested change

options: { refetchInterval: 10000 },

options: { refetchInterval: 10000, enabled: token },

this will only triggers the query if the token is provided.

Right, I've checked the doc, the enabled is a boolean, so maybe the following one is more correct
options: { refetchInterval: 10000, enabled: token ? true : false },

JS is automatically casting this to a boolean so token ? true : false is strictly equivalent to token. Actually in token ? true : false you are also casting token as a boolean for the ternary condition

For some reason, the tests won't execute by enabled: token. So I have to switch back to enabled: token ? true : false

shell-ui/src/platform/service/k8s.js

JBWatenbergScality

incorrect approval

shell-ui/src/alerts/services/alertHooks.js

shell-ui/src/alerts/services/alertHooks.test.js

JBWatenbergScality · 2021-04-15T08:00:21Z

Cannot find module 'axios' from 'src/platform/service/k8s.js'

Axios is not available in shell-ui. I think we can simply use fetch as it is available in the browser we target

shell-ui/src/platform/service/k8s.js

JBWatenbergScality · 2021-04-15T11:33:35Z

I think you can merge this manually in my branch improvement/shell-ui-alert-provider

JBWatenbergScality · 2021-04-15T15:04:10Z

shell-ui/src/platform/service/k8s.js

+        .then((res) => {
+          return res.items.length;
+        }),
+    options: { refetchInterval: 10000, enabled: token },


not sure about this options to be checked

To disable the query if token is not provided Refs: #3257

Check if the k8s call carry the `id_token`, otherwise listen to the navbarElement AUTHENTICATED_EVENT Refs: #3275

ChengYanJin requested a review from JBWatenbergScality April 7, 2021 14:32

ChengYanJin changed the title ~~UI: Expose hooks that retrieve the highest alerts for each entity or alertname~~ UI: Expose hooks that retrieve the highest alerts for each entity Apr 7, 2021

ChengYanJin force-pushed the improvement/3257-hooks-to-export-the-health-of-the-entities branch 3 times, most recently from 98932fd to 8847337 Compare April 8, 2021 07:30

ChengYanJin marked this pull request as ready for review April 8, 2021 07:36

ChengYanJin requested a review from a team as a code owner April 8, 2021 07:36

ChengYanJin force-pushed the improvement/3257-hooks-to-export-the-health-of-the-entities branch 2 times, most recently from abefd0d to 223c978 Compare April 8, 2021 07:57

JBWatenbergScality reviewed Apr 8, 2021

View reviewed changes

ui/src/services/alertHooks.js Outdated Show resolved Hide resolved

ui/src/containers/AlertProvider.js Outdated Show resolved Hide resolved

ui/src/services/alertHooks.js Outdated Show resolved Hide resolved

ui/src/services/alertHooks.js Outdated Show resolved Hide resolved

ChengYanJin force-pushed the improvement/3257-hooks-to-export-the-health-of-the-entities branch 6 times, most recently from b32f9c6 to 1940c5f Compare April 14, 2021 10:19

ChengYanJin changed the base branch from development/2.9 to improvement/shell-ui-alert-provider April 14, 2021 10:20

ChengYanJin added a commit that referenced this pull request Apr 14, 2021

shell-ui: Add k8s service

c35493f

Check if the k8s call carry the id_token, othewise listen to the navbarElement AUTHENTICATED event Refs: #3275

ChengYanJin force-pushed the improvement/3257-hooks-to-export-the-health-of-the-entities branch from 1940c5f to c35493f Compare April 14, 2021 10:22

ChengYanJin added a commit that referenced this pull request Apr 14, 2021

shell-ui: Add k8s service

92ec079

Check if the k8s call carry the `id_token`, otherwise listen to the navbarElement AUTHENTICATED_EVENT Refs: #3275

ChengYanJin force-pushed the improvement/3257-hooks-to-export-the-health-of-the-entities branch from c35493f to 92ec079 Compare April 14, 2021 10:25

JBWatenbergScality force-pushed the improvement/shell-ui-alert-provider branch from 0625ea3 to 741b8fb Compare April 14, 2021 19:07

ChengYanJin added a commit that referenced this pull request Apr 14, 2021

shell-ui: Add k8s service

f926b2b

Check if the k8s call carry the `id_token`, otherwise listen to the navbarElement AUTHENTICATED_EVENT Refs: #3275

ChengYanJin force-pushed the improvement/3257-hooks-to-export-the-health-of-the-entities branch from 92ec079 to bcfa1a0 Compare April 14, 2021 19:33

ChengYanJin added 3 commits April 14, 2021 21:35

shell-ui: Add alerthook and expose in library

2b76502

Refs: #3257

shell-ui: Add k8s service

347d76e

Check if the k8s call carry the `id_token`, otherwise listen to the navbarElement AUTHENTICATED_EVENT Refs: #3275

shell-ui: Add test for getNodesCount

1878730

Refs: #3257

ChengYanJin force-pushed the improvement/3257-hooks-to-export-the-health-of-the-entities branch from bcfa1a0 to 1878730 Compare April 14, 2021 19:36

JBWatenbergScality previously approved these changes Apr 14, 2021

View reviewed changes

JBWatenbergScality reviewed Apr 14, 2021

View reviewed changes

shell-ui/src/alerts/services/alertHooks.js Show resolved Hide resolved

JBWatenbergScality reviewed Apr 14, 2021

View reviewed changes

shell-ui/src/alerts/services/alertHooks.test.js Outdated Show resolved Hide resolved

JBWatenbergScality reviewed Apr 15, 2021

View reviewed changes

shell-ui/src/platform/service/k8s.js Outdated Show resolved Hide resolved

JBWatenbergScality reviewed Apr 15, 2021

View reviewed changes

shell-ui/src/platform/service/k8s.js Outdated Show resolved Hide resolved

ChengYanJin force-pushed the improvement/3257-hooks-to-export-the-health-of-the-entities branch 2 times, most recently from d90bd0e to d6a94e3 Compare April 15, 2021 08:21

JBWatenbergScality approved these changes Apr 15, 2021

View reviewed changes

JBWatenbergScality reviewed Apr 15, 2021

View reviewed changes

ChengYanJin force-pushed the improvement/3257-hooks-to-export-the-health-of-the-entities branch from d6a94e3 to 586e812 Compare April 15, 2021 15:45

shell-ui: Add enabled option in query object

586e812

To disable the query if token is not provided Refs: #3257

ChengYanJin merged commit 01f46e6 into improvement/shell-ui-alert-provider Apr 15, 2021

ChengYanJin deleted the improvement/3257-hooks-to-export-the-health-of-the-entities branch April 15, 2021 19:11

ChengYanJin mentioned this pull request Apr 15, 2021

UI: Implements hooks to retrieve the health of entities(Volume/Node/Service/Network) #3257

Closed

6 tasks

JBWatenbergScality pushed a commit that referenced this pull request Apr 16, 2021

shell-ui: Add k8s service

10880d2

Check if the k8s call carry the `id_token`, otherwise listen to the navbarElement AUTHENTICATED_EVENT Refs: #3275

JBWatenbergScality pushed a commit that referenced this pull request Apr 16, 2021

shell-ui: Add k8s service

4226680

Check if the k8s call carry the `id_token`, otherwise listen to the navbarElement AUTHENTICATED_EVENT Refs: #3275

ChengYanJin added a commit that referenced this pull request Apr 20, 2021

shell-ui: Add k8s service

a33ef1c

Check if the k8s call carry the `id_token`, otherwise listen to the navbarElement AUTHENTICATED_EVENT Refs: #3275

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

UI: Expose hooks that retrieve the highest alerts for each entity #3275

UI: Expose hooks that retrieve the highest alerts for each entity #3275

ChengYanJin commented Apr 7, 2021 •

edited

Loading

bert-e commented Apr 7, 2021

bert-e commented Apr 7, 2021

JBWatenbergScality Apr 14, 2021

ChengYanJin Apr 15, 2021

JBWatenbergScality Apr 15, 2021

ChengYanJin Apr 15, 2021 •

edited

Loading

JBWatenbergScality left a comment •

edited

Loading

JBWatenbergScality commented Apr 15, 2021

JBWatenbergScality commented Apr 15, 2021

JBWatenbergScality Apr 15, 2021

	options: { refetchInterval: 10000 },
	options: { refetchInterval: 10000, enabled: token },

UI: Expose hooks that retrieve the highest alerts for each entity #3275

UI: Expose hooks that retrieve the highest alerts for each entity #3275

Conversation

ChengYanJin commented Apr 7, 2021 • edited Loading

bert-e commented Apr 7, 2021

Hello chengyanjin,

bert-e commented Apr 7, 2021

Waiting for approval

JBWatenbergScality Apr 14, 2021

Choose a reason for hiding this comment

ChengYanJin Apr 15, 2021

Choose a reason for hiding this comment

JBWatenbergScality Apr 15, 2021

Choose a reason for hiding this comment

ChengYanJin Apr 15, 2021 • edited Loading

Choose a reason for hiding this comment

JBWatenbergScality left a comment • edited Loading

Choose a reason for hiding this comment

JBWatenbergScality commented Apr 15, 2021

JBWatenbergScality commented Apr 15, 2021

JBWatenbergScality Apr 15, 2021

Choose a reason for hiding this comment

ChengYanJin commented Apr 7, 2021 •

edited

Loading

ChengYanJin Apr 15, 2021 •

edited

Loading

JBWatenbergScality left a comment •

edited

Loading