More tests for alert list functionality + cleanup

x-pack/plugins/endpoint/public/applications/endpoint/store/alerts/reducer.ts

@@ -12,7 +12,8 @@ const initialState = (): AlertListState => {
   return {
     alerts: [],
     request_page_size: 10,
-    request_index: 0,
+    request_page_index: 0,
+    result_from_index: 0,
     total: 0,
   };
 };

x-pack/plugins/endpoint/public/applications/endpoint/store/alerts/types.ts

@@ -4,13 +4,7 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { AlertData } from '../../../../../common/types';
+import { AlertResultList } from '../../../../../common/types';
 
-export interface AlertListData {
-  alerts: AlertData[];
-  request_page_size: number;
-  request_index: number;
-  total: number;
-}
-
-export type AlertListState = AlertListData;
+export type AlertListData = AlertResultList;
+export type AlertListState = AlertResultList;

x-pack/plugins/endpoint/server/routes/alerts.test.ts

@@ -20,7 +20,7 @@ import {
 } from '../../../../../src/core/server/mocks';
 import { AlertData, AlertResultList } from '../../common/types';
 import { SearchResponse } from 'elasticsearch';
-import { registerAlertRoutes } from './alerts';
+import { reqSchema, registerAlertRoutes } from './alerts';
 import { EndpointConfigSchema } from '../config';
 import * as data from '../test_data/all_alerts_data.json';
 import * as dataLegacy from '../test_data/all_alerts_data_legacy.json';
@@ -72,7 +72,7 @@ describe('test alerts route', () => {
     expect(routeConfig.options).toEqual({ authRequired: true });
     expect(mockResponse.ok).toBeCalled();
     const alertResultList = mockResponse.ok.mock.calls[0][0]?.body as AlertResultList;
-    expect(alertResultList.total).toEqual(132);
+    expect(alertResultList.total).toEqual(21);
     expect(alertResultList.request_page_index).toEqual(0);
     expect(alertResultList.result_from_index).toEqual(0);
     expect(alertResultList.request_page_size).toEqual(10);
@@ -103,7 +103,7 @@ describe('test alerts route', () => {
     expect(routeConfig.options).toEqual({ authRequired: true });
     expect(mockResponse.ok).toBeCalled();
     const alertResultList = mockResponse.ok.mock.calls[0][0]?.body as AlertResultList;
-    expect(alertResultList.total).toEqual(132);
+    expect(alertResultList.total).toEqual(21);
     expect(alertResultList.request_page_index).toEqual(0);
     expect(alertResultList.result_from_index).toEqual(0);
     expect(alertResultList.request_page_size).toEqual(10);
@@ -113,13 +113,11 @@ describe('test alerts route', () => {
     const mockRequest = httpServerMock.createKibanaRequest({
       method: 'post',
       body: {
-        page_size: 20,
-        page_index: 2,
+        page_size: 6,
+        page_index: 3,
       },
     });
-    mockScopedClient.callAsCurrentUser.mockImplementationOnce(() =>
-      Promise.resolve((data as unknown) as SearchResponse<AlertData>)
-    );
+    mockScopedClient.callAsCurrentUser.mockImplementationOnce(() => Promise.resolve(data));
     [routeConfig, routeHandler] = routerMock.post.mock.calls.find(([{ path }]) =>
       path.startsWith('/api/endpoint/alerts')
     )!;
@@ -140,24 +138,21 @@ describe('test alerts route', () => {
     expect(routeConfig.options).toEqual({ authRequired: true });
     expect(mockResponse.ok).toBeCalled();
     const alertResultList = mockResponse.ok.mock.calls[0][0]?.body as AlertResultList;
-    expect(alertResultList.alerts.length).toEqual(20);
-    expect(alertResultList.total).toEqual(132);
-    expect(alertResultList.request_page_index).toEqual(2);
-    expect(alertResultList.result_from_index).toEqual(40);
-    expect(alertResultList.request_page_size).toEqual(20);
+    expect(alertResultList.total).toEqual(21);
+    expect(alertResultList.request_page_index).toEqual(3);
+    expect(alertResultList.result_from_index).toEqual(18);
+    expect(alertResultList.request_page_size).toEqual(6);
   });
 
   it('should return alert results according to pagination params -- GET', async () => {
     const mockRequest = httpServerMock.createKibanaRequest({
       path: '/api/endpoint/alerts',
       query: {
-        page_size: 20,
+        page_size: 3,
         page_index: 2,
       },
     });
-    mockScopedClient.callAsCurrentUser.mockImplementationOnce(() =>
-      Promise.resolve((data as unknown) as SearchResponse<AlertData>)
-    );
+    mockScopedClient.callAsCurrentUser.mockImplementationOnce(() => Promise.resolve(data));
     [routeConfig, routeHandler] = routerMock.get.mock.calls.find(([{ path }]) =>
       path.startsWith('/api/endpoint/alerts')
     )!;
@@ -178,11 +173,19 @@ describe('test alerts route', () => {
     expect(routeConfig.options).toEqual({ authRequired: true });
     expect(mockResponse.ok).toBeCalled();
     const alertResultList = mockResponse.ok.mock.calls[0][0]?.body as AlertResultList;
-    expect(alertResultList.alerts.length).toEqual(20);
-    expect(alertResultList.total).toEqual(132);
+    expect(alertResultList.total).toEqual(21);
     expect(alertResultList.request_page_index).toEqual(2);
-    expect(alertResultList.result_from_index).toEqual(40);
-    expect(alertResultList.request_page_size).toEqual(20);
+    expect(alertResultList.result_from_index).toEqual(6);
+    expect(alertResultList.request_page_size).toEqual(3);
+  });
+
+  it('should correctly validate params', async () => {
+    const validate = () => {
+      reqSchema.validate({
+        page_size: 'abc',
+        page_index: 0,
+      });
+    };
+    expect(validate).toThrow();
   });
-  // TODO: add tests for track_total_hits
 });

x-pack/plugins/endpoint/server/routes/alerts.ts

@@ -19,7 +19,7 @@ import { EndpointAppContext } from '../types';
 
 const ALERTS_ROUTE = '/api/endpoint/alerts';
 
-const reqSchema = schema.object({
+export const reqSchema = schema.object({
   page_size: schema.number({ defaultValue: 10, min: 1, max: 10000 }),
   page_index: schema.number({ defaultValue: 0, min: 0 }),
 });

x-pack/plugins/endpoint/server/services/endpoint/alert_query_builders.test.ts

@@ -3,13 +3,13 @@
  * or more contributor license agreements. Licensed under the Elastic License;
  * you may not use this file except in compliance with the Elastic License.
  */
-import { httpServerMock, loggingServiceMock } from '../../../../../../src/core/server/mocks';
+import { httpServerMock, loggingServiceMock } from 'src/core/server/mocks';
 import { EndpointConfigSchema } from '../../config';
 import { getPagingProperties, kibanaRequestToAlertListQuery } from './alert_query_builders';
 
 describe('test query builder', () => {
   describe('test query builder request processing', () => {
-    it('test default query params for all alerts when no params or body is provided', async () => {
+    it('should execute the correct Elasticsearch query for a default request', async () => {
       const mockRequest = httpServerMock.createKibanaRequest({
         body: {},
       });
@@ -39,6 +39,38 @@ describe('test query builder', () => {
         index: 'my-index',
       } as Record<string, any>);
     });
-    // TODO: add tests for calculating track_total_hits
+    it('should adjust track_total_hits for deep pagination', async () => {
+      const mockRequest = httpServerMock.createKibanaRequest({
+        query: {
+          page_index: 10,
+          page_size: 1000,
+        },
+      });
+      const mockCtx = {
+        logFactory: loggingServiceMock.create(),
+        config: () => Promise.resolve(EndpointConfigSchema.validate({})),
+      };
+      const queryParams = await getPagingProperties(mockRequest, mockCtx);
+      const query = await kibanaRequestToAlertListQuery(queryParams, mockCtx);
+
+      expect(query).toEqual({
+        body: {
+          query: {
+            match_all: {},
+          },
+          sort: [
+            {
+              '@timestamp': {
+                order: 'desc',
+              },
+            },
+          ],
+          track_total_hits: 12000,
+        },
+        from: 10000,
+        size: 1000,
+        index: 'my-index',
+      } as Record<string, any>);
+    });
   });
 });