[ML] Improving client side error handling

x-pack/plugins/ml/common/types/data_frame_analytics.ts

@@ -4,11 +4,12 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { CustomHttpResponseOptions, ResponseError } from 'kibana/server';
+import Boom from 'boom';
+import { EsErrorBody } from '../util/errors';
 
 export interface DeleteDataFrameAnalyticsWithIndexStatus {
   success: boolean;
-  error?: CustomHttpResponseOptions<ResponseError>;
+  error?: EsErrorBody | Boom;
 }
 
 export type IndexName = string;

x-pack/plugins/ml/common/util/errors/errors.test.ts

@@ -0,0 +1,99 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import Boom from 'boom';
+
+import { extractErrorMessage, MLHttpFetchError, MLResponseError, EsErrorBody } from './index';
+
+describe('ML - error message utils', () => {
+  describe('extractErrorMessage', () => {
+    test('returns just the error message', () => {
+      const testMsg = 'Saved object [index-pattern/indexpattern] not found';
+
+      // bad error, return empty string
+      const badError = {} as any;
+      expect(extractErrorMessage(badError)).toBe('');
+
+      // raw es error
+      const esErrorMsg: EsErrorBody = {
+        error: {
+          root_cause: [
+            {
+              type: 'type',
+              reason: 'reason',
+            },
+          ],
+          type: 'type',
+          reason: testMsg,
+        },
+        status: 404,
+      };
+      expect(extractErrorMessage(esErrorMsg)).toBe(testMsg);
+
+      // error is basic string
+      const stringMessage = testMsg;
+      expect(extractErrorMessage(stringMessage)).toBe(testMsg);
+
+      // kibana error without attributes
+      const bodyWithoutAttributes: MLHttpFetchError<MLResponseError> = {
+        name: 'name',
+        req: {} as Request,
+        request: {} as Request,
+        message: 'Something else',
+        body: {
+          statusCode: 404,
+          error: 'error',
+          message: testMsg,
+        },
+      };
+      expect(extractErrorMessage(bodyWithoutAttributes)).toBe(testMsg);
+
+      // kibana error with attributes
+      const bodyWithAttributes: MLHttpFetchError<MLResponseError> = {
+        name: 'name',
+        req: {} as Request,
+        request: {} as Request,
+        message: 'Something else',
+        body: {
+          statusCode: 404,
+          error: 'error',
+          message: 'Something else',
+          attributes: {
+            body: {
+              status: 404,
+              error: {
+                reason: testMsg,
+                type: 'type',
+                root_cause: [{ type: 'type', reason: 'reason' }],
+              },
+            },
+          },
+        },
+      };
+      expect(extractErrorMessage(bodyWithAttributes)).toBe(testMsg);
+
+      // boom error
+      const boomError: Boom<any> = {
+        message: '',
+        reformat: () => '',
+        name: '',
+        data: [],
+        isBoom: true,
+        isServer: false,
+        output: {
+          statusCode: 404,
+          payload: {
+            statusCode: 404,
+            error: testMsg,
+            message: testMsg,
+          },
+          headers: {},
+        },
+      };
+      expect(extractErrorMessage(boomError)).toBe(testMsg);
+    });
+  });
+});

x-pack/plugins/ml/common/util/errors/index.ts

@@ -0,0 +1,20 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+export { MLRequestFailure } from './request_error';
+export { extractErrorMessage, extractErrorProperties } from './process_errors';
+export {
+  ErrorType,
+  EsErrorBody,
+  EsErrorRootCause,
+  MLErrorObject,
+  MLHttpFetchError,
+  MLResponseError,
+  isBoomError,
+  isErrorString,
+  isEsErrorBody,
+  isMLResponseError,
+} from './types';