Address comments - Round 3

elastic · Feb 4, 2020 · 28f7baa · 28f7baa
1 parent 426502c
commit 28f7baa
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 20 deletions.
diff --git a/x-pack/plugins/endpoint/common/types.ts b/x-pack/plugins/endpoint/common/types.ts
@@ -28,14 +28,30 @@ export class EndpointAppConstants {
 }
 
 export interface AlertResultList {
-  /* the alerts restricted by the page size */
+  /**
+   * The alerts restricted by page size.
+   */
   alerts: AlertData[];
-  /* the total number of unique alerts in the index */
+
+  /**
+   * The total number of alerts on the page.
+   */
   total: number;
-  /* the page size requested */
+
+  /**
+   * The size of the requested page.
+   */
   request_page_size: number;
-  /* the page index requested */
+
+  /**
+   * The index of the requested page, starting at 0.
+   */
   request_page_index: number;
+
+  /**
+   * The offset of the requested page, starting at 0.
+   */
+  result_from_index: number;
 }
 
 export interface EndpointResultList {

diff --git a/x-pack/plugins/endpoint/server/routes/alerts.ts b/x-pack/plugins/endpoint/server/routes/alerts.ts
@@ -7,7 +7,7 @@
 import { IRouter } from 'kibana/server';
 import { RequestHandler } from 'kibana/server';
 import { SearchResponse } from 'elasticsearch';
-import { schema } from '@kbn/config-schema';
+import { schema, TypeOf } from '@kbn/config-schema';
 
 import {
   getPagingProperties,
@@ -19,8 +19,17 @@ import { EndpointAppContext } from '../types';
 
 const ALERTS_ROUTE = '/api/endpoint/alerts';
 
+const reqSchema = schema.object({
+  page_size: schema.number({ defaultValue: 10, min: 1, max: 10000 }),
+  page_index: schema.number({ defaultValue: 0, min: 0 }),
+});
+
 export function registerAlertRoutes(router: IRouter, endpointAppContext: EndpointAppContext) {
-  const alertsHandler: RequestHandler<unknown, unknown, unknown> = async (ctx, req, res) => {
+  const alertsHandler: RequestHandler<unknown, TypeOf<typeof reqSchema>> = async (
+    ctx,
+    req,
+    res
+  ) => {
     try {
       const queryParams = await getPagingProperties(req, endpointAppContext);
       const reqBody = await kibanaRequestToAlertListQuery(queryParams, endpointAppContext);
@@ -38,10 +47,7 @@ export function registerAlertRoutes(router: IRouter, endpointAppContext: Endpoin
     {
       path: ALERTS_ROUTE,
       validate: {
-        query: schema.object({
-          page_size: schema.number({ defaultValue: 10, min: 1, max: 10000 }),
-          page_index: schema.number({ defaultValue: 0, min: 0 }),
-        }),
+        query: reqSchema,
       },
       options: { authRequired: true },
     },
@@ -52,10 +58,7 @@ export function registerAlertRoutes(router: IRouter, endpointAppContext: Endpoin
     {
       path: ALERTS_ROUTE,
       validate: {
-        body: schema.object({
-          page_size: schema.number({ defaultValue: 10, min: 1, max: 10000 }),
-          page_index: schema.number({ defaultValue: 0, min: 0 }),
-        }),
+        body: reqSchema,
       },
       options: { authRequired: true },
     },

diff --git a/x-pack/plugins/endpoint/server/services/endpoint/alert_query_builders.ts b/x-pack/plugins/endpoint/server/services/endpoint/alert_query_builders.ts
@@ -54,11 +54,9 @@ export const getPagingProperties = async (
     pagingProperties.page_size = request.body?.page_size;
   }
 
-  const finalParams = {
-    pageSize: pagingProperties.page_size || config.alertResultListDefaultPageSize,
-    pageIndex: pagingProperties.page_index || config.alertResultListDefaultFirstPageIndex,
-  };
+  const pageSize = pagingProperties.page_size || config.alertResultListDefaultPageSize;
+  const pageIndex = pagingProperties.page_index || config.alertResultListDefaultFirstPageIndex;
+  const fromIndex = pageIndex * pageSize;
 
-  finalParams.fromIndex = finalParams.pageIndex * finalParams.pageSize;
-  return finalParams;
+  return { pageSize, pageIndex, fromIndex };
 };