[ML] Transforms - Updated: Add ability to delete dest index & index p…

…attern when deleting transform job (#68896)

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

@@ -0,0 +1,78 @@
+/*
+ * 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 {
+  BoomResponse,
+  extractErrorMessage,
+  MLCustomHttpResponseOptions,
+  MLResponseError,
+} from './errors';
+import { ResponseError } from 'kibana/server';
+
+describe('ML - error message utils', () => {
+  describe('extractErrorMessage', () => {
+    test('returns just the error message', () => {
+      const testMsg = 'Saved object [index-pattern/blahblahblah] not found';
+
+      const bodyWithNestedErrorMsg: MLCustomHttpResponseOptions<MLResponseError> = {
+        body: {
+          message: {
+            msg: testMsg,
+          },
+        },
+        statusCode: 404,
+      };
+      expect(extractErrorMessage(bodyWithNestedErrorMsg)).toBe(testMsg);
+
+      const bodyWithStringMsg: MLCustomHttpResponseOptions<MLResponseError> = {
+        body: {
+          msg: testMsg,
+        },
+        statusCode: 404,
+      };
+      expect(extractErrorMessage(bodyWithStringMsg)).toBe(testMsg);
+
+      const bodyWithStringMessage: MLCustomHttpResponseOptions<ResponseError> = {
+        body: {
+          message: testMsg,
+        },
+        statusCode: 404,
+      };
+      expect(extractErrorMessage(bodyWithStringMessage)).toBe(testMsg);
+
+      const bodyWithString: MLCustomHttpResponseOptions<ResponseError> = {
+        body: testMsg,
+        statusCode: 404,
+      };
+      expect(extractErrorMessage(bodyWithString)).toBe(testMsg);
+
+      const bodyWithError: MLCustomHttpResponseOptions<ResponseError> = {
+        body: new Error(testMsg),
+        statusCode: 404,
+      };
+      expect(extractErrorMessage(bodyWithError)).toBe(testMsg);
+
+      const bodyWithBoomError: MLCustomHttpResponseOptions<BoomResponse> = {
+        statusCode: 404,
+        body: {
+          data: [],
+          isBoom: true,
+          isServer: false,
+          output: {
+            statusCode: 404,
+            payload: {
+              statusCode: 404,
+              error: testMsg,
+              message: testMsg,
+            },
+            headers: {},
+          },
+        },
+      };
+      expect(extractErrorMessage(bodyWithBoomError)).toBe(testMsg);
+    });
+  });
+});

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

@@ -4,6 +4,7 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
+import { ResponseError, ResponseHeaders } from 'kibana/server';
 import { isErrorResponse } from '../types/errors';
 
 export function getErrorMessage(error: any) {
@@ -17,3 +18,77 @@ export function getErrorMessage(error: any) {
 
   return JSON.stringify(error);
 }
+
+// Adding temporary types until Kibana ResponseError is updated
+
+export interface BoomResponse {
+  data: any;
+  isBoom: boolean;
+  isServer: boolean;
+  output: {
+    statusCode: number;
+    payload: {
+      statusCode: number;
+      error: string;
+      message: string;
+    };
+    headers: {};
+  };
+}
+export type MLResponseError =
+  | {
+      message: {
+        msg: string;
+      };
+    }
+  | { msg: string };
+
+export interface MLCustomHttpResponseOptions<
+  T extends ResponseError | MLResponseError | BoomResponse
+> {
+  /** HTTP message to send to the client */
+  body?: T;
+  /** HTTP Headers with additional information about response */
+  headers?: ResponseHeaders;
+  statusCode: number;
+}
+
+export const extractErrorMessage = (
+  error:
+    | MLCustomHttpResponseOptions<MLResponseError | ResponseError | BoomResponse>
+    | undefined
+    | string
+): string => {
+  // extract only the error message within the response error coming from Kibana, Elasticsearch, and our own ML messages
+
+  if (typeof error === 'string') {
+    return error;
+  }
+  if (error?.body === undefined) return '';
+
+  if (typeof error.body === 'string') {
+    return error.body;
+  }
+  if (
+    typeof error.body === 'object' &&
+    'output' in error.body &&
+    error.body.output.payload.message
+  ) {
+    return error.body.output.payload.message;
+  }
+
+  if (typeof error.body === 'object' && 'msg' in error.body && typeof error.body.msg === 'string') {
+    return error.body.msg;
+  }
+
+  if (typeof error.body === 'object' && 'message' in error.body) {
+    if (typeof error.body.message === 'string') {
+      return error.body.message;
+    }
+    if (!(error.body.message instanceof Error) && typeof (error.body.message.msg === 'string')) {
+      return error.body.message.msg;
+    }
+  }
+  // If all else fail return an empty message instead of JSON.stringify
+  return '';
+};

x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_management/components/analytics_list/action_clone.tsx

@@ -21,7 +21,7 @@ import {
 import { State } from '../../hooks/use_create_analytics_form/state';
 import { DataFrameAnalyticsListRow } from './common';
 import { checkPermission } from '../../../../../capabilities/check_capabilities';
-import { extractErrorMessage } from '../../../../../util/error_utils';
+import { extractErrorMessage } from '../../../../../../../common/util/errors';
 
 interface PropDefinition {
   /**

x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_management/components/analytics_list/action_delete.tsx

@@ -18,6 +18,7 @@ import {
 } from '@elastic/eui';
 import { IIndexPattern } from 'src/plugins/data/common';
 import { FormattedMessage } from '@kbn/i18n/react';
+import { extractErrorMessage } from '../../../../../../../common/util/errors';
 import {
   deleteAnalytics,
   deleteAnalyticsAndDestIndex,
@@ -29,7 +30,6 @@ import {
 } from '../../../../../capabilities/check_capabilities';
 import { useMlKibana } from '../../../../../contexts/kibana';
 import { isDataFrameAnalyticsRunning, DataFrameAnalyticsListRow } from './common';
-import { extractErrorMessage } from '../../../../../util/error_utils';
 
 interface DeleteActionProps {
   item: DataFrameAnalyticsListRow;

x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_management/services/analytics_service/delete_analytics.ts

@@ -4,14 +4,14 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 import { i18n } from '@kbn/i18n';
+import { extractErrorMessage } from '../../../../../../../common/util/errors';
 import { getToastNotifications } from '../../../../../util/dependency_cache';
 import { ml } from '../../../../../services/ml_api_service';
 import { refreshAnalyticsList$, REFRESH_ANALYTICS_LIST_STATE } from '../../../../common';
 import {
   isDataFrameAnalyticsFailed,
   DataFrameAnalyticsListRow,
 } from '../../components/analytics_list/common';
-import { extractErrorMessage } from '../../../../../util/error_utils';
 
 export const deleteAnalytics = async (d: DataFrameAnalyticsListRow) => {
   const toastNotifications = getToastNotifications();

x-pack/plugins/ml/public/shared.ts

@@ -14,6 +14,7 @@ export * from '../common/types/audit_message';
 
 export * from '../common/util/anomaly_utils';
 export * from '../common/util/errors';
+
 export * from '../common/util/validators';
 
 export * from './application/formatters/metric_change_description';

x-pack/plugins/transform/common/index.ts

@@ -38,3 +38,20 @@ export interface ResultData {
 export interface TransformEndpointResult {
   [key: string]: ResultData;
 }
+
+export interface DeleteTransformEndpointRequest {
+  transformsInfo: TransformEndpointRequest[];
+  deleteDestIndex?: boolean;
+  deleteDestIndexPattern?: boolean;
+}
+
+export interface DeleteTransformStatus {
+  transformDeleted: ResultData;
+  destIndexDeleted?: ResultData;
+  destIndexPatternDeleted?: ResultData;
+  destinationIndex?: string | undefined;
+}
+
+export interface DeleteTransformEndpointResult {
+  [key: string]: DeleteTransformStatus;
+}

x-pack/plugins/transform/public/app/components/toast_notification_text.tsx

@@ -29,9 +29,14 @@ const MAX_SIMPLE_MESSAGE_LENGTH = 140;
 interface ToastNotificationTextProps {
   overlays: CoreStart['overlays'];
   text: any;
+  previewTextLength?: number;
 }
 
-export const ToastNotificationText: FC<ToastNotificationTextProps> = ({ overlays, text }) => {
+export const ToastNotificationText: FC<ToastNotificationTextProps> = ({
+  overlays,
+  text,
+  previewTextLength,
+}) => {
   if (typeof text === 'string' && text.length <= MAX_SIMPLE_MESSAGE_LENGTH) {
     return text;
   }
@@ -46,8 +51,9 @@ export const ToastNotificationText: FC<ToastNotificationTextProps> = ({ overlays
 
   const unformattedText = text.message ? text.message : text;
   const formattedText = typeof unformattedText === 'object' ? JSON.stringify(text, null, 2) : text;
-  const previewText = `${formattedText.substring(0, 140)}${
-    formattedText.length > 140 ? ' ...' : ''
+  const textLength = previewTextLength ?? 140;
+  const previewText = `${formattedText.substring(0, textLength)}${
+    formattedText.length > textLength ? ' ...' : ''
   }`;
 
   const openModal = () => {

x-pack/plugins/transform/public/app/hooks/index.ts

@@ -6,7 +6,7 @@
 
 export { useApi } from './use_api';
 export { useGetTransforms } from './use_get_transforms';
-export { useDeleteTransforms } from './use_delete_transform';
+export { useDeleteTransforms, useDeleteIndexAndTargetIndex } from './use_delete_transform';
 export { useStartTransforms } from './use_start_transform';
 export { useStopTransforms } from './use_stop_transform';
 export { useRequest } from './use_request';

x-pack/plugins/transform/public/app/hooks/use_api.ts

@@ -5,7 +5,12 @@
  */
 
 import { useMemo } from 'react';
-import { TransformEndpointRequest, TransformEndpointResult, TransformId } from '../../../common';
+import {
+  TransformId,
+  TransformEndpointRequest,
+  TransformEndpointResult,
+  DeleteTransformEndpointResult,
+} from '../../../common';
 import { API_BASE_PATH } from '../../../common/constants';
 
 import { useAppDependencies } from '../app_dependencies';
@@ -40,10 +45,12 @@ export const useApi = () => {
         });
       },
       deleteTransforms(
-        transformsInfo: TransformEndpointRequest[]
-      ): Promise<TransformEndpointResult> {
+        transformsInfo: TransformEndpointRequest[],
+        deleteDestIndex: boolean | undefined,
+        deleteDestIndexPattern: boolean | undefined
+      ): Promise<DeleteTransformEndpointResult> {
         return http.post(`${API_BASE_PATH}delete_transforms`, {
-          body: JSON.stringify(transformsInfo),
+          body: JSON.stringify({ transformsInfo, deleteDestIndex, deleteDestIndexPattern }),
         });
       },
       getTransformsPreview(obj: PreviewRequestBody): Promise<GetTransformsResponse> {