[Asset management] Osquery app bug squashing (#102406)

* only display healthy agents to query * updated toasts to clear on update * null checking aggBuckets * properly display expired actions * clear the error toasts on success * review comments Co-authored-by: Kibana Machine <[email protected]>
elastic · Jun 24, 2021 · ad11ec8 · ad11ec8
1 parent 8505975
commit ad11ec8
Show file tree

Hide file tree

Showing 20 changed files with 186 additions and 112 deletions.
diff --git a/x-pack/plugins/osquery/public/action_results/action_results_summary.tsx b/x-pack/plugins/osquery/public/action_results/action_results_summary.tsx
@@ -36,6 +36,7 @@ const StyledEuiCard = styled(EuiCard)`
 
 interface ActionResultsSummaryProps {
   actionId: string;
+  expirationDate: Date;
   agentIds?: string[];
   isLive?: boolean;
 }
@@ -48,6 +49,7 @@ const renderErrorMessage = (error: string) => (
 
 const ActionResultsSummaryComponent: React.FC<ActionResultsSummaryProps> = ({
   actionId,
+  expirationDate,
   agentIds,
   isLive,
 }) => {
@@ -56,6 +58,7 @@ const ActionResultsSummaryComponent: React.FC<ActionResultsSummaryProps> = ({
   const [pageIndex, setPageIndex] = useState(0);
   // @ts-expect-error update types
   const [pageSize, setPageSize] = useState(50);
+  const expired = useMemo(() => expirationDate < new Date(), [expirationDate]);
   const {
     // @ts-expect-error update types
     data: { aggregations, edges },
@@ -66,7 +69,7 @@ const ActionResultsSummaryComponent: React.FC<ActionResultsSummaryProps> = ({
     limit: pageSize,
     direction: Direction.asc,
     sortField: '@timestamp',
-    isLive,
+    isLive: !expired && isLive,
   });
 
   const { data: logsResults } = useAllResults({
@@ -79,7 +82,7 @@ const ActionResultsSummaryComponent: React.FC<ActionResultsSummaryProps> = ({
         direction: Direction.asc,
       },
     ],
-    isLive,
+    isLive: !expired && isLive,
   });
 
   const notRespondedCount = useMemo(() => {
@@ -108,9 +111,13 @@ const ActionResultsSummaryComponent: React.FC<ActionResultsSummaryProps> = ({
         description: aggregations.successful,
       },
       {
-        title: i18n.translate('xpack.osquery.liveQueryActionResults.summary.pendingLabelText', {
-          defaultMessage: 'Not yet responded',
-        }),
+        title: expired
+          ? i18n.translate('xpack.osquery.liveQueryActionResults.summary.expiredLabelText', {
+              defaultMessage: 'Expired',
+            })
+          : i18n.translate('xpack.osquery.liveQueryActionResults.summary.pendingLabelText', {
+              defaultMessage: 'Not yet responded',
+            }),
         description: notRespondedCount,
       },
       {
@@ -124,7 +131,7 @@ const ActionResultsSummaryComponent: React.FC<ActionResultsSummaryProps> = ({
         ),
       },
     ],
-    [agentIds, aggregations.failed, aggregations.successful, notRespondedCount]
+    [agentIds, aggregations.failed, aggregations.successful, notRespondedCount, expired]
   );
 
   const renderAgentIdColumn = useCallback(
@@ -158,23 +165,30 @@ const ActionResultsSummaryComponent: React.FC<ActionResultsSummaryProps> = ({
     [logsResults]
   );
 
-  const renderStatusColumn = useCallback((_, item) => {
-    if (!item.fields.completed_at) {
-      return i18n.translate('xpack.osquery.liveQueryActionResults.table.pendingStatusText', {
-        defaultMessage: 'pending',
-      });
-    }
+  const renderStatusColumn = useCallback(
+    (_, item) => {
+      if (!item.fields.completed_at) {
+        return expired
+          ? i18n.translate('xpack.osquery.liveQueryActionResults.table.expiredStatusText', {
+              defaultMessage: 'expired',
+            })
+          : i18n.translate('xpack.osquery.liveQueryActionResults.table.pendingStatusText', {
+              defaultMessage: 'pending',
+            });
+      }
 
-    if (item.fields['error.keyword']) {
-      return i18n.translate('xpack.osquery.liveQueryActionResults.table.errorStatusText', {
-        defaultMessage: 'error',
-      });
-    }
+      if (item.fields['error.keyword']) {
+        return i18n.translate('xpack.osquery.liveQueryActionResults.table.errorStatusText', {
+          defaultMessage: 'error',
+        });
+      }
 
-    return i18n.translate('xpack.osquery.liveQueryActionResults.table.successStatusText', {
-      defaultMessage: 'success',
-    });
-  }, []);
+      return i18n.translate('xpack.osquery.liveQueryActionResults.table.successStatusText', {
+        defaultMessage: 'success',
+      });
+    },
+    [expired]
+  );
 
   const columns = useMemo(
     () => [
@@ -227,7 +241,7 @@ const ActionResultsSummaryComponent: React.FC<ActionResultsSummaryProps> = ({
       <EuiFlexGroup>
         <EuiFlexItem grow={false}>
           <StyledEuiCard title="" description="" textAlign="left">
-            {notRespondedCount ? <EuiProgress size="xs" position="absolute" /> : null}
+            {!expired && notRespondedCount ? <EuiProgress size="xs" position="absolute" /> : null}
             <EuiDescriptionList
               compressed
               textStyle="reverse"

diff --git a/x-pack/plugins/osquery/public/action_results/use_action_results.ts b/x-pack/plugins/osquery/public/action_results/use_action_results.ts
@@ -23,6 +23,7 @@ import { ESTermQuery } from '../../common/typed_json';
 import { queryClient } from '../query_client';
 
 import { generateTablePaginationOptions, getInspectResponse, InspectResponse } from './helpers';
+import { useErrorToast } from '../common/hooks/use_error_toast';
 
 export interface ResultsArgs {
   results: ResultEdges;
@@ -56,10 +57,8 @@ export const useActionResults = ({
   skip = false,
   isLive = false,
 }: UseActionResults) => {
-  const {
-    data,
-    notifications: { toasts },
-  } = useKibana().services;
+  const { data } = useKibana().services;
+  const setErrorToast = useErrorToast();
 
   return useQuery(
     ['actionResults', { actionId }],
@@ -103,9 +102,9 @@ export const useActionResults = ({
         aggregations: {
           totalResponded,
           // @ts-expect-error update types
-          successful: aggsBuckets.find((bucket) => bucket.key === 'success')?.doc_count ?? 0,
+          successful: aggsBuckets?.find((bucket) => bucket.key === 'success')?.doc_count ?? 0,
           // @ts-expect-error update types
-          failed: aggsBuckets.find((bucket) => bucket.key === 'error')?.doc_count ?? 0,
+          failed: aggsBuckets?.find((bucket) => bucket.key === 'error')?.doc_count ?? 0,
         },
         inspect: getInspectResponse(responseData, {} as InspectResponse),
       };
@@ -124,8 +123,9 @@ export const useActionResults = ({
       refetchInterval: isLive ? 1000 : false,
       keepPreviousData: true,
       enabled: !skip && !!agentIds?.length,
+      onSuccess: () => setErrorToast(),
       onError: (error: Error) =>
-        toasts.addError(error, {
+        setErrorToast(error, {
           title: i18n.translate('xpack.osquery.action_results.fetchError', {
             defaultMessage: 'Error while fetching action results',
           }),

diff --git a/x-pack/plugins/osquery/public/actions/use_action_details.ts b/x-pack/plugins/osquery/public/actions/use_action_details.ts
@@ -18,6 +18,7 @@ import {
 import { ESTermQuery } from '../../common/typed_json';
 
 import { getInspectResponse, InspectResponse } from './helpers';
+import { useErrorToast } from '../common/hooks/use_error_toast';
 
 export interface ActionDetailsArgs {
   actionDetails: Record<string, string>;
@@ -33,10 +34,8 @@ interface UseActionDetails {
 }
 
 export const useActionDetails = ({ actionId, filterQuery, skip = false }: UseActionDetails) => {
-  const {
-    data,
-    notifications: { toasts },
-  } = useKibana().services;
+  const { data } = useKibana().services;
+  const setErrorToast = useErrorToast();
 
   return useQuery(
     ['actionDetails', { actionId, filterQuery }],
@@ -61,8 +60,9 @@ export const useActionDetails = ({ actionId, filterQuery, skip = false }: UseAct
     },
     {
       enabled: !skip,
+      onSuccess: () => setErrorToast(),
       onError: (error: Error) =>
-        toasts.addError(error, {
+        setErrorToast(error, {
           title: i18n.translate('xpack.osquery.action_details.fetchError', {
             defaultMessage: 'Error while fetching action details',
           }),

diff --git a/x-pack/plugins/osquery/public/actions/use_all_actions.ts b/x-pack/plugins/osquery/public/actions/use_all_actions.ts
@@ -21,6 +21,7 @@ import {
 import { ESTermQuery } from '../../common/typed_json';
 
 import { generateTablePaginationOptions, getInspectResponse, InspectResponse } from './helpers';
+import { useErrorToast } from '../common/hooks/use_error_toast';
 
 export interface ActionsArgs {
   actions: ActionEdges;
@@ -48,10 +49,8 @@ export const useAllActions = ({
   filterQuery,
   skip = false,
 }: UseAllActions) => {
-  const {
-    data,
-    notifications: { toasts },
-  } = useKibana().services;
+  const { data } = useKibana().services;
+  const setErrorToast = useErrorToast();
 
   return useQuery(
     ['actions', { activePage, direction, limit, sortField }],
@@ -82,8 +81,9 @@ export const useAllActions = ({
     {
       keepPreviousData: true,
       enabled: !skip,
+      onSuccess: () => setErrorToast(),
       onError: (error: Error) =>
-        toasts.addError(error, {
+        setErrorToast(error, {
           title: i18n.translate('xpack.osquery.all_actions.fetchError', {
             defaultMessage: 'Error while fetching actions',
           }),

diff --git a/x-pack/plugins/osquery/public/agent_policies/use_agent_policies.ts b/x-pack/plugins/osquery/public/agent_policies/use_agent_policies.ts
@@ -14,12 +14,11 @@ import {
   GetAgentPoliciesResponse,
   GetAgentPoliciesResponseItem,
 } from '../../../fleet/common';
+import { useErrorToast } from '../common/hooks/use_error_toast';
 
 export const useAgentPolicies = () => {
-  const {
-    http,
-    notifications: { toasts },
-  } = useKibana().services;
+  const { http } = useKibana().services;
+  const setErrorToast = useErrorToast();
 
   return useQuery<GetAgentPoliciesResponse, unknown, GetAgentPoliciesResponseItem[]>(
     ['agentPolicies'],
@@ -34,8 +33,9 @@ export const useAgentPolicies = () => {
       placeholderData: [],
       keepPreviousData: true,
       select: (response) => response.items,
+      onSuccess: () => setErrorToast(),
       onError: (error) =>
-        toasts.addError(error as Error, {
+        setErrorToast(error as Error, {
           title: i18n.translate('xpack.osquery.agent_policies.fetchError', {
             defaultMessage: 'Error while fetching agent policies',
           }),

diff --git a/x-pack/plugins/osquery/public/agent_policies/use_agent_policy.ts b/x-pack/plugins/osquery/public/agent_policies/use_agent_policy.ts
@@ -10,17 +10,16 @@ import { useQuery } from 'react-query';
 import { i18n } from '@kbn/i18n';
 import { useKibana } from '../common/lib/kibana';
 import { agentPolicyRouteService } from '../../../fleet/common';
+import { useErrorToast } from '../common/hooks/use_error_toast';
 
 interface UseAgentPolicy {
   policyId: string;
   skip?: boolean;
 }
 
 export const useAgentPolicy = ({ policyId, skip }: UseAgentPolicy) => {
-  const {
-    http,
-    notifications: { toasts },
-  } = useKibana().services;
+  const { http } = useKibana().services;
+  const setErrorToast = useErrorToast();
 
   return useQuery(
     ['agentPolicy', { policyId }],
@@ -29,8 +28,9 @@ export const useAgentPolicy = ({ policyId, skip }: UseAgentPolicy) => {
       enabled: !skip,
       keepPreviousData: true,
       select: (response) => response.item,
+      onSuccess: () => setErrorToast(),
       onError: (error: Error) =>
-        toasts.addError(error, {
+        setErrorToast(error, {
           title: i18n.translate('xpack.osquery.agent_policy_details.fetchError', {
             defaultMessage: 'Error while fetching agent policy details',
           }),

diff --git a/x-pack/plugins/osquery/public/agents/use_agent_groups.ts b/x-pack/plugins/osquery/public/agents/use_agent_groups.ts
@@ -18,17 +18,16 @@ import {
 
 import { generateTablePaginationOptions, processAggregations } from './helpers';
 import { Overlap, Group } from './types';
+import { useErrorToast } from '../common/hooks/use_error_toast';
 
 interface UseAgentGroups {
   osqueryPolicies: string[];
   osqueryPoliciesLoading: boolean;
 }
 
 export const useAgentGroups = ({ osqueryPolicies, osqueryPoliciesLoading }: UseAgentGroups) => {
-  const {
-    data,
-    notifications: { toasts },
-  } = useKibana().services;
+  const { data } = useKibana().services;
+  const setErrorToast = useErrorToast();
 
   const { agentPoliciesLoading, agentPolicyById } = useAgentPolicies(osqueryPolicies);
   const [platforms, setPlatforms] = useState<Group[]>([]);
@@ -100,8 +99,9 @@ export const useAgentGroups = ({ osqueryPolicies, osqueryPoliciesLoading }: UseA
     },
     {
       enabled: !osqueryPoliciesLoading && !agentPoliciesLoading,
+      onSuccess: () => setErrorToast(),
       onError: (error) =>
-        toasts.addError(error as Error, {
+        setErrorToast(error as Error, {
           title: i18n.translate('xpack.osquery.agent_groups.fetchError', {
             defaultMessage: 'Error while fetching agent groups',
           }),

diff --git a/x-pack/plugins/osquery/public/agents/use_agent_policies.ts b/x-pack/plugins/osquery/public/agents/use_agent_policies.ts
@@ -10,20 +10,20 @@ import { useQueries, UseQueryResult } from 'react-query';
 import { i18n } from '@kbn/i18n';
 import { useKibana } from '../common/lib/kibana';
 import { agentPolicyRouteService, GetOneAgentPolicyResponse } from '../../../fleet/common';
+import { useErrorToast } from '../common/hooks/use_error_toast';
 
 export const useAgentPolicies = (policyIds: string[] = []) => {
-  const {
-    http,
-    notifications: { toasts },
-  } = useKibana().services;
+  const { http } = useKibana().services;
+  const setErrorToast = useErrorToast();
 
   const agentResponse = useQueries(
     policyIds.map((policyId) => ({
       queryKey: ['agentPolicy', policyId],
       queryFn: () => http.get(agentPolicyRouteService.getInfoPath(policyId)),
       enabled: policyIds.length > 0,
+      onSuccess: () => setErrorToast(),
       onError: (error) =>
-        toasts.addError(error as Error, {
+        setErrorToast(error as Error, {
           title: i18n.translate('xpack.osquery.action_policy_details.fetchError', {
             defaultMessage: 'Error while fetching policy details',
           }),

diff --git a/x-pack/plugins/osquery/public/agents/use_agent_status.ts b/x-pack/plugins/osquery/public/agents/use_agent_status.ts
@@ -9,6 +9,7 @@ import { i18n } from '@kbn/i18n';
 import { useQuery } from 'react-query';
 
 import { GetAgentStatusResponse, agentRouteService } from '../../../fleet/common';
+import { useErrorToast } from '../common/hooks/use_error_toast';
 import { useKibana } from '../common/lib/kibana';
 
 interface UseAgentStatus {
@@ -17,10 +18,8 @@ interface UseAgentStatus {
 }
 
 export const useAgentStatus = ({ policyId, skip }: UseAgentStatus) => {
-  const {
-    http,
-    notifications: { toasts },
-  } = useKibana().services;
+  const { http } = useKibana().services;
+  const setErrorToast = useErrorToast();
 
   return useQuery<GetAgentStatusResponse, unknown, GetAgentStatusResponse['results']>(
     ['agentStatus', policyId],
@@ -38,8 +37,9 @@ export const useAgentStatus = ({ policyId, skip }: UseAgentStatus) => {
     {
       enabled: !skip,
       select: (response) => response.results,
+      onSuccess: () => setErrorToast(),
       onError: (error) =>
-        toasts.addError(error as Error, {
+        setErrorToast(error as Error, {
           title: i18n.translate('xpack.osquery.agent_status.fetchError', {
             defaultMessage: 'Error while fetching agent status',
           }),