Better type safety for alert list API

madirey · madirey · commit d513a43d3cc6 · 2020-02-06T14:59:23.000-05:00
diff --git a/x-pack/plugins/endpoint/public/applications/endpoint/store/alerts/action.ts b/x-pack/plugins/endpoint/public/applications/endpoint/store/alerts/action.ts
@@ -4,7 +4,7 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { AlertListData } from './types';
+import { AlertListData } from '../../types';
 
 interface ServerReturnedAlertsData {
   type: 'serverReturnedAlertsData';
diff --git a/x-pack/plugins/endpoint/public/applications/endpoint/store/alerts/index.ts b/x-pack/plugins/endpoint/public/applications/endpoint/store/alerts/index.ts
@@ -6,4 +6,4 @@
 
 export { alertListReducer } from './reducer';
 export { AlertAction } from './action';
-export * from './types';
+export * from '../../types';
diff --git a/x-pack/plugins/endpoint/public/applications/endpoint/store/alerts/reducer.ts b/x-pack/plugins/endpoint/public/applications/endpoint/store/alerts/reducer.ts
@@ -5,7 +5,7 @@
  */
 
 import { Reducer } from 'redux';
-import { AlertListState } from './types';
+import { AlertListState } from '../../types';
 import { AppAction } from '../action';
 
 const initialState = (): AlertListState => {
@@ -25,7 +25,7 @@ export const alertListReducer: Reducer<AlertListState, AppAction> = (
   if (action.type === 'serverReturnedAlertsData') {
     return {
       ...state,
-      ...action.payload,
+      alerts: action.payload.alerts,
     };
   }
 
diff --git a/x-pack/plugins/endpoint/public/applications/endpoint/store/alerts/selectors.ts b/x-pack/plugins/endpoint/public/applications/endpoint/store/alerts/selectors.ts
@@ -4,6 +4,6 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { AlertListState } from './types';
+import { AlertListState } from '../../types';
 
 export const alertListData = (state: AlertListState) => state.alerts;
diff --git a/x-pack/plugins/endpoint/public/applications/endpoint/store/alerts/types.ts b/x-pack/plugins/endpoint/public/applications/endpoint/store/alerts/types.ts
diff --git a/x-pack/plugins/endpoint/public/applications/endpoint/types.ts b/x-pack/plugins/endpoint/public/applications/endpoint/types.ts
@@ -6,9 +6,9 @@
 
 import { Dispatch, MiddlewareAPI } from 'redux';
 import { CoreStart } from 'kibana/public';
-import { AlertListState } from './store/alerts';
 import { EndpointListState } from './store/endpoint_list';
 import { AppAction } from './store/action';
+import { AlertResultList } from '../../../common/types';
 
 export type MiddlewareFactory = (
   coreStart: CoreStart
@@ -20,3 +20,6 @@ export interface GlobalState {
   readonly endpointList: EndpointListState;
   readonly alertList: AlertListState;
 }
+
+export type AlertListData = AlertResultList;
+export type AlertListState = AlertResultList;
diff --git a/x-pack/plugins/endpoint/server/routes/alerts.ts b/x-pack/plugins/endpoint/server/routes/alerts.ts
@@ -4,18 +4,17 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { IRouter } from 'kibana/server';
-import { RequestHandler } from 'kibana/server';
+import { IRouter, KibanaRequest, RequestHandler } from 'kibana/server';
 import { SearchResponse } from 'elasticsearch';
-import { schema, TypeOf } from '@kbn/config-schema';
+import { schema } from '@kbn/config-schema';
 
 import {
   getPagingProperties,
-  kibanaRequestToAlertListQuery,
+  buildAlertListESQuery,
 } from '../services/endpoint/alert_query_builders';
 
 import { AlertData, AlertResultList } from '../../common/types';
-import { EndpointAppContext } from '../types';
+import { AlertRequestParams, EndpointAppContext } from '../types';
 
 const ALERTS_ROUTE = '/api/endpoint/alerts';
 
@@ -25,14 +24,13 @@ export const reqSchema = schema.object({
 });
 
 export function registerAlertRoutes(router: IRouter, endpointAppContext: EndpointAppContext) {
-  const alertsHandler: RequestHandler<unknown, TypeOf<typeof reqSchema>> = async (
-    ctx,
-    req,
-    res
-  ) => {
+  const alertsHandler: RequestHandler<unknown, AlertRequestParams> = async (ctx, req, res) => {
     try {
-      const queryParams = await getPagingProperties(req, endpointAppContext);
-      const reqBody = await kibanaRequestToAlertListQuery(queryParams, endpointAppContext);
+      const queryParams = await getPagingProperties(
+        req as KibanaRequest<unknown, AlertRequestParams, AlertRequestParams, any>,
+        endpointAppContext
+      );
+      const reqBody = await buildAlertListESQuery(queryParams);
       const response = (await ctx.core.elasticsearch.dataClient.callAsCurrentUser(
         'search',
         reqBody
diff --git a/x-pack/plugins/endpoint/server/services/endpoint/alert_query_builders.test.ts b/x-pack/plugins/endpoint/server/services/endpoint/alert_query_builders.test.ts
@@ -5,20 +5,18 @@
  */
 import { httpServerMock, loggingServiceMock } from 'src/core/server/mocks';
 import { EndpointConfigSchema } from '../../config';
-import { getPagingProperties, kibanaRequestToAlertListQuery } from './alert_query_builders';
+import { getPagingProperties, buildAlertListESQuery } from './alert_query_builders';
 
 describe('test query builder', () => {
   describe('test query builder request processing', () => {
     it('should execute the correct Elasticsearch query for a default request', async () => {
-      const mockRequest = httpServerMock.createKibanaRequest({
-        body: {},
-      });
+      const mockRequest = httpServerMock.createKibanaRequest({});
       const mockCtx = {
         logFactory: loggingServiceMock.create(),
         config: () => Promise.resolve(EndpointConfigSchema.validate({})),
       };
       const queryParams = await getPagingProperties(mockRequest, mockCtx);
-      const query = await kibanaRequestToAlertListQuery(queryParams, mockCtx);
+      const query = await buildAlertListESQuery(queryParams);
 
       expect(query).toEqual({
         body: {
@@ -51,7 +49,7 @@ describe('test query builder', () => {
         config: () => Promise.resolve(EndpointConfigSchema.validate({})),
       };
       const queryParams = await getPagingProperties(mockRequest, mockCtx);
-      const query = await kibanaRequestToAlertListQuery(queryParams, mockCtx);
+      const query = await buildAlertListESQuery(queryParams);
 
       expect(query).toEqual({
         body: {
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
@@ -5,12 +5,11 @@
  */
 import { KibanaRequest } from 'kibana/server';
 import { EndpointAppConstants } from '../../../common/types';
-import { EndpointAppContext } from '../../types';
+import { EndpointAppContext, AlertRequestParams, JSONish } from '../../types';
 
-export const kibanaRequestToAlertListQuery = async (
-  pagingProperties: Record<string, any>,
-  endpointAppContext: EndpointAppContext
-): Promise<Record<string, any>> => {
+export const buildAlertListESQuery = async (
+  pagingProperties: Record<string, number>
+): Promise<JSONish> => {
   const DEFAULT_TOTAL_HITS = 10000;
 
   // Calculate minimum total hits set to indicate there's a next page
@@ -40,9 +39,9 @@ export const kibanaRequestToAlertListQuery = async (
 };
 
 export const getPagingProperties = async (
-  request: KibanaRequest<any, any, any>,
+  request: KibanaRequest<unknown, AlertRequestParams, AlertRequestParams>,
   endpointAppContext: EndpointAppContext
-): Promise<Record<string, any>> => {
+): Promise<Record<string, number>> => {
   const config = await endpointAppContext.config();
   const pagingProperties: { page_size?: number; page_index?: number } = {};
 
diff --git a/x-pack/plugins/endpoint/server/types.ts b/x-pack/plugins/endpoint/server/types.ts
@@ -6,7 +6,25 @@
 import { LoggerFactory } from 'kibana/server';
 import { EndpointConfigType } from './config';
 
+/**
+ * A JSON-like structure.
+ */
+export interface JSONish {
+  [key: string]: number | string | null | undefined | JSONish | JSONish[];
+}
+
+/**
+ * The context for Endpoint apps.
+ */
 export interface EndpointAppContext {
   logFactory: LoggerFactory;
   config(): Promise<EndpointConfigType>;
 }
+
+/**
+ * Request params for alert queries.
+ */
+export interface AlertRequestParams {
+  page_index?: number;
+  page_size?: number;
+}
