[Security Solution][Data Quality Dashboard][Serverless] add start/end…

… time support for latest_results (elastic#199248) addresses elastic#191053 - Introduce `defaultStartTime` and `defaultEndTime` props across data quality context and panels for fetching latest_results and align them with serverless default time range of last week - Update hooks to handle new time parameters and include them in storage results queries. - Modify server-side helpers and routes to process and filter indices based on the provided time range. - Update related tests to accommodate the new time parameters.
charlie-pichette · Nov 7, 2024 · 1df04ae · 1df04ae
1 parent 9fafb75
commit 1df04ae
Show file tree

Hide file tree

Showing 25 changed files with 642 additions and 58 deletions.
diff --git a/...on/ecs_data_quality_dashboard/impl/data_quality_panel/data_quality_context/index.test.tsx b/...on/ecs_data_quality_dashboard/impl/data_quality_panel/data_quality_context/index.test.tsx
@@ -65,6 +65,8 @@ const ContextWrapper: FC<PropsWithChildren<unknown>> = ({ children }) => (
       },
     ]}
     setSelectedIlmPhaseOptions={jest.fn()}
+    defaultStartTime="now-7d"
+    defaultEndTime="now"
   >
     {children}
   </DataQualityProvider>

diff --git a/...olution/ecs_data_quality_dashboard/impl/data_quality_panel/data_quality_context/index.tsx b/...olution/ecs_data_quality_dashboard/impl/data_quality_panel/data_quality_context/index.tsx
@@ -41,6 +41,8 @@ export interface DataQualityProviderProps {
   ilmPhases: string[];
   selectedIlmPhaseOptions: EuiComboBoxOptionOption[];
   setSelectedIlmPhaseOptions: (options: EuiComboBoxOptionOption[]) => void;
+  defaultStartTime: string;
+  defaultEndTime: string;
 }
 
 const DataQualityContext = React.createContext<DataQualityProviderProps | undefined>(undefined);
@@ -67,6 +69,8 @@ export const DataQualityProvider: React.FC<PropsWithChildren<DataQualityProvider
   ilmPhases,
   selectedIlmPhaseOptions,
   setSelectedIlmPhaseOptions,
+  defaultStartTime,
+  defaultEndTime,
 }) => {
   const value = useMemo(
     () => ({
@@ -90,6 +94,8 @@ export const DataQualityProvider: React.FC<PropsWithChildren<DataQualityProvider
       ilmPhases,
       selectedIlmPhaseOptions,
       setSelectedIlmPhaseOptions,
+      defaultStartTime,
+      defaultEndTime,
     }),
     [
       httpFetch,
@@ -112,6 +118,8 @@ export const DataQualityProvider: React.FC<PropsWithChildren<DataQualityProvider
       ilmPhases,
       selectedIlmPhaseOptions,
       setSelectedIlmPhaseOptions,
+      defaultStartTime,
+      defaultEndTime,
     ]
   );
 

diff --git a/...y_panel/data_quality_details/indices_details/pattern/hooks/use_ilm_explain/index.test.tsx b/...y_panel/data_quality_details/indices_details/pattern/hooks/use_ilm_explain/index.test.tsx
@@ -71,6 +71,8 @@ const ContextWrapper: React.FC<{ children: React.ReactNode; isILMAvailable: bool
       },
     ]}
     setSelectedIlmPhaseOptions={jest.fn()}
+    defaultStartTime={'now-7d'}
+    defaultEndTime={'now'}
   >
     {children}
   </DataQualityProvider>
@@ -159,6 +161,8 @@ describe('useIlmExplain', () => {
               },
             ]}
             setSelectedIlmPhaseOptions={jest.fn()}
+            defaultStartTime={'now-7d'}
+            defaultEndTime={'now'}
           >
             {children}
           </DataQualityProvider>

diff --git a/...quality_panel/data_quality_details/indices_details/pattern/hooks/use_stats/index.test.tsx b/...quality_panel/data_quality_details/indices_details/pattern/hooks/use_stats/index.test.tsx
@@ -69,6 +69,8 @@ const ContextWrapper: FC<PropsWithChildren<unknown>> = ({ children }) => (
       },
     ]}
     setSelectedIlmPhaseOptions={jest.fn()}
+    defaultStartTime={'now-7d'}
+    defaultEndTime={'now'}
   >
     {children}
   </DataQualityProvider>
@@ -119,6 +121,8 @@ const ContextWrapperILMNotAvailable: FC<PropsWithChildren<unknown>> = ({ childre
       },
     ]}
     setSelectedIlmPhaseOptions={jest.fn()}
+    defaultStartTime={'now-7d'}
+    defaultEndTime={'now'}
   >
     {children}
   </DataQualityProvider>

diff --git a/...ta_quality_panel/hooks/use_results_rollup/hooks/use_stored_pattern_results/index.test.tsx b/...ta_quality_panel/hooks/use_results_rollup/hooks/use_stored_pattern_results/index.test.tsx
@@ -11,6 +11,10 @@ import { notificationServiceMock } from '@kbn/core-notifications-browser-mocks';
 import { getHistoricalResultStub } from '../../../../stub/get_historical_result_stub';
 import { useStoredPatternResults } from '.';
 
+const startTime = 'now-7d';
+const endTime = 'now';
+const isILMAvailable = true;
+
 describe('useStoredPatternResults', () => {
   const httpFetch = jest.fn();
   const mockToasts = notificationServiceMock.createStartContract().toasts;
@@ -21,7 +25,16 @@ describe('useStoredPatternResults', () => {
 
   describe('when patterns are empty', () => {
     it('should return an empty array and not call getStorageResults', () => {
-      const { result } = renderHook(() => useStoredPatternResults([], mockToasts, httpFetch));
+      const { result } = renderHook(() =>
+        useStoredPatternResults({
+          patterns: [],
+          toasts: mockToasts,
+          httpFetch,
+          isILMAvailable,
+          startTime,
+          endTime,
+        })
+      );
 
       expect(result.current).toEqual([]);
       expect(httpFetch).not.toHaveBeenCalled();
@@ -45,7 +58,14 @@ describe('useStoredPatternResults', () => {
       });
 
       const { result, waitFor } = renderHook(() =>
-        useStoredPatternResults(patterns, mockToasts, httpFetch)
+        useStoredPatternResults({
+          patterns,
+          toasts: mockToasts,
+          httpFetch,
+          isILMAvailable,
+          startTime,
+          endTime,
+        })
       );
 
       await waitFor(() => result.current.length > 0);
@@ -104,5 +124,63 @@ describe('useStoredPatternResults', () => {
         },
       ]);
     });
+
+    describe('when isILMAvailable is false', () => {
+      it('should call getStorageResults with startDate and endDate', async () => {
+        const patterns = ['pattern1-*', 'pattern2-*'];
+
+        httpFetch.mockImplementation((path: string) => {
+          if (path === '/internal/ecs_data_quality_dashboard/results_latest/pattern1-*') {
+            return Promise.resolve([getHistoricalResultStub('pattern1-index1')]);
+          }
+
+          if (path === '/internal/ecs_data_quality_dashboard/results_latest/pattern2-*') {
+            return Promise.resolve([getHistoricalResultStub('pattern2-index1')]);
+          }
+
+          return Promise.reject(new Error('Invalid path'));
+        });
+
+        const { result, waitFor } = renderHook(() =>
+          useStoredPatternResults({
+            patterns,
+            toasts: mockToasts,
+            httpFetch,
+            isILMAvailable: false,
+            startTime,
+            endTime,
+          })
+        );
+
+        await waitFor(() => result.current.length > 0);
+
+        expect(httpFetch).toHaveBeenCalledTimes(2);
+
+        expect(httpFetch).toHaveBeenCalledWith(
+          '/internal/ecs_data_quality_dashboard/results_latest/pattern1-*',
+          {
+            method: 'GET',
+            signal: expect.any(AbortSignal),
+            version: '1',
+            query: {
+              startDate: startTime,
+              endDate: endTime,
+            },
+          }
+        );
+        expect(httpFetch).toHaveBeenCalledWith(
+          '/internal/ecs_data_quality_dashboard/results_latest/pattern2-*',
+          {
+            method: 'GET',
+            signal: expect.any(AbortSignal),
+            version: '1',
+            query: {
+              startDate: startTime,
+              endDate: endTime,
+            },
+          }
+        );
+      });
+    });
   });
 });
diff --git a/...pl/data_quality_panel/hooks/use_results_rollup/hooks/use_stored_pattern_results/index.tsx b/...pl/data_quality_panel/hooks/use_results_rollup/hooks/use_stored_pattern_results/index.tsx
@@ -10,13 +10,34 @@ import { HttpHandler } from '@kbn/core-http-browser';
 import { isEmpty } from 'lodash/fp';
 
 import { DataQualityCheckResult } from '../../../../types';
-import { formatResultFromStorage, getStorageResults } from '../../utils/storage';
+import {
+  GetStorageResultsOpts,
+  formatResultFromStorage,
+  getStorageResults,
+} from '../../utils/storage';
 
-export const useStoredPatternResults = (
-  patterns: string[],
-  toasts: IToasts,
-  httpFetch: HttpHandler
-) => {
+export interface UseStoredPatternResultsOpts {
+  patterns: string[];
+  toasts: IToasts;
+  httpFetch: HttpHandler;
+  isILMAvailable: boolean;
+  startTime: string;
+  endTime: string;
+}
+
+export type UseStoredPatternResultsReturnValue = Array<{
+  pattern: string;
+  results: Record<string, DataQualityCheckResult>;
+}>;
+
+export const useStoredPatternResults = ({
+  patterns,
+  toasts,
+  httpFetch,
+  isILMAvailable,
+  startTime,
+  endTime,
+}: UseStoredPatternResultsOpts): UseStoredPatternResultsReturnValue => {
   const [storedPatternResults, setStoredPatternResults] = useState<
     Array<{ pattern: string; results: Record<string, DataQualityCheckResult> }>
   >([]);
@@ -28,17 +49,29 @@ export const useStoredPatternResults = (
 
     const abortController = new AbortController();
     const fetchStoredPatternResults = async () => {
-      const requests = patterns.map((pattern) =>
-        getStorageResults({ pattern, httpFetch, abortController, toasts }).then((results = []) => ({
+      const requests = patterns.map(async (pattern) => {
+        const getStorageResultsOpts: GetStorageResultsOpts = {
+          pattern,
+          httpFetch,
+          abortController,
+          toasts,
+        };
+
+        if (!isILMAvailable) {
+          getStorageResultsOpts.startTime = startTime;
+          getStorageResultsOpts.endTime = endTime;
+        }
+
+        return getStorageResults(getStorageResultsOpts).then((results) => ({
           pattern,
           results: Object.fromEntries(
             results.map((storageResult) => [
               storageResult.indexName,
               formatResultFromStorage({ storageResult, pattern }),
             ])
           ),
-        }))
-      );
+        }));
+      });
 
       const patternResults = await Promise.all(requests);
       if (patternResults?.length) {
@@ -47,7 +80,7 @@ export const useStoredPatternResults = (
     };
 
     fetchStoredPatternResults();
-  }, [httpFetch, patterns, toasts]);
+  }, [endTime, httpFetch, isILMAvailable, patterns, startTime, toasts]);
 
   return storedPatternResults;
 };
diff --git a/...cs_data_quality_dashboard/impl/data_quality_panel/hooks/use_results_rollup/index.test.tsx b/...cs_data_quality_dashboard/impl/data_quality_panel/hooks/use_results_rollup/index.test.tsx
@@ -35,6 +35,8 @@ describe('useResultsRollup', () => {
 
   const patterns = ['auditbeat-*', 'packetbeat-*'];
   const isILMAvailable = true;
+  const startTime = 'now-7d';
+  const endTime = 'now';
 
   const useStoredPatternResultsMock = useStoredPatternResults as jest.Mock;
 
@@ -52,6 +54,8 @@ describe('useResultsRollup', () => {
           patterns,
           isILMAvailable,
           telemetryEvents: mockTelemetryEvents,
+          startTime,
+          endTime,
         })
       );
 
@@ -94,10 +98,19 @@ describe('useResultsRollup', () => {
           patterns: ['auditbeat-*'],
           isILMAvailable,
           telemetryEvents: mockTelemetryEvents,
+          startTime,
+          endTime,
         })
       );
 
-      expect(useStoredPatternResultsMock).toHaveBeenCalledWith(['auditbeat-*'], toasts, httpFetch);
+      expect(useStoredPatternResultsMock).toHaveBeenCalledWith({
+        patterns: ['auditbeat-*'],
+        toasts,
+        httpFetch,
+        isILMAvailable,
+        startTime,
+        endTime,
+      });
 
       expect(result.current.patternRollups).toEqual({
         'auditbeat-*': {
@@ -119,6 +132,8 @@ describe('useResultsRollup', () => {
           patterns,
           isILMAvailable,
           telemetryEvents: mockTelemetryEvents,
+          startTime,
+          endTime,
         })
       );
 
@@ -144,6 +159,8 @@ describe('useResultsRollup', () => {
           patterns,
           isILMAvailable,
           telemetryEvents: mockTelemetryEvents,
+          startTime,
+          endTime,
         })
       );
 
@@ -180,6 +197,8 @@ describe('useResultsRollup', () => {
             patterns,
             isILMAvailable,
             telemetryEvents: mockTelemetryEvents,
+            startTime,
+            endTime,
           })
         );
 
@@ -369,6 +388,8 @@ describe('useResultsRollup', () => {
               patterns,
               isILMAvailable: false,
               telemetryEvents: mockTelemetryEvents,
+              startTime,
+              endTime,
             })
           );
 
@@ -532,6 +553,8 @@ describe('useResultsRollup', () => {
             patterns,
             isILMAvailable,
             telemetryEvents: mockTelemetryEvents,
+            startTime,
+            endTime,
           })
         );
 
@@ -592,6 +615,8 @@ describe('useResultsRollup', () => {
               patterns,
               isILMAvailable,
               telemetryEvents: mockTelemetryEvents,
+              startTime,
+              endTime,
             })
           );
 
@@ -654,6 +679,8 @@ describe('useResultsRollup', () => {
             patterns: ['packetbeat-*', 'auditbeat-*'],
             isILMAvailable,
             telemetryEvents: mockTelemetryEvents,
+            startTime,
+            endTime,
           })
         );