[ML] Transforms: Adds reset action to transforms management.

x-pack/plugins/transform/common/api_schemas/reset_transforms.ts

@@ -0,0 +1,32 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { schema, TypeOf } from '@kbn/config-schema';
+
+import { transformStateSchema, ResponseStatus } from './common';
+
+export const resetTransformsRequestSchema = schema.object({
+ /**
+ * Reset Transforms
+ */
+ transformsInfo: schema.arrayOf(
+ schema.object({
+ id: schema.string(),
+ state: transformStateSchema,
+ })
+ ),
+});
+
+export type ResetTransformsRequestSchema = TypeOf<typeof resetTransformsRequestSchema>;
+
+export interface ResetTransformStatus {
+ transformReset: ResponseStatus;
+}
+
+export interface ResetTransformsResponseSchema {
+ [key: string]: ResetTransformStatus;
+}

x-pack/plugins/transform/common/api_schemas/type_guards.ts

@@ -16,6 +16,7 @@ import { isPopulatedObject } from '../shared_imports';
 import type { FieldHistogramsResponseSchema } from './field_histograms';
 import type { GetTransformsAuditMessagesResponseSchema } from './audit_messages';
 import type { DeleteTransformsResponseSchema } from './delete_transforms';
+import type { ResetTransformsResponseSchema } from './reset_transforms';
 import type { StartTransformsResponseSchema } from './start_transforms';
 import type { StopTransformsResponseSchema } from './stop_transforms';
 import type {
@@ -56,6 +57,15 @@ export const isDeleteTransformsResponseSchema = (
  );
 };
 
+export const isResetTransformsResponseSchema = (
+ arg: unknown
+): arg is ResetTransformsResponseSchema => {
+ return (
+ isPopulatedObject(arg) &&
+ Object.values(arg).every((d) => isPopulatedObject(d, ['transformReset']))
+ );
+};
+
 export const isEsIndices = (arg: unknown): arg is EsIndex[] => {
  return Array.isArray(arg);
 };

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

@@ -55,6 +55,7 @@ export const APP_CLUSTER_PRIVILEGES = [
  'cluster:admin/transform/delete',
  'cluster:admin/transform/preview',
  'cluster:admin/transform/put',
+ 'cluster:admin/transform/reset',
  'cluster:admin/transform/start',
  'cluster:admin/transform/start_task',
  'cluster:admin/transform/stop',

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

@@ -8,6 +8,7 @@
 export { useApi } from './use_api';
 export { useGetTransforms } from './use_get_transforms';
 export { useDeleteTransforms, useDeleteIndexAndTargetIndex } from './use_delete_transform';
+export { useResetTransforms } from './use_reset_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

@@ -22,6 +22,10 @@ import type {
  FieldHistogramsRequestSchema,
  FieldHistogramsResponseSchema,
 } from '../../../common/api_schemas/field_histograms';
+import type {
+ ResetTransformsRequestSchema,
+ ResetTransformsResponseSchema,
+} from '../../../common/api_schemas/reset_transforms';
 import type {
  StartTransformsRequestSchema,
  StartTransformsResponseSchema,
@@ -157,6 +161,17 @@ export const useApi = () => {
  return e;
  }
  },
+ async resetTransforms(
+ reqBody: ResetTransformsRequestSchema
+ ): Promise<ResetTransformsResponseSchema | HttpFetchError> {
+ try {
+ return await http.post(`${API_BASE_PATH}reset_transforms`, {
+ body: JSON.stringify(reqBody),
+ });
+ } catch (e) {
+ return e;
+ }
+ },
  async startTransforms(
  reqBody: StartTransformsRequestSchema
  ): Promise<StartTransformsResponseSchema | HttpFetchError> {

x-pack/plugins/transform/public/app/hooks/use_reset_transform.tsx

@@ -0,0 +1,112 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import React from 'react';
+import { i18n } from '@kbn/i18n';
+import { toMountPoint } from '../../../../../../src/plugins/kibana_react/public';
+import type {
+ ResetTransformStatus,
+ ResetTransformsRequestSchema,
+} from '../../../common/api_schemas/reset_transforms';
+import { isResetTransformsResponseSchema } from '../../../common/api_schemas/type_guards';
+import { getErrorMessage } from '../../../common/utils/errors';
+import { useAppDependencies, useToastNotifications } from '../app_dependencies';
+import { REFRESH_TRANSFORM_LIST_STATE, refreshTransformList$ } from '../common';
+import { ToastNotificationText } from '../components';
+import { useApi } from './use_api';
+
+type SuccessCountField = keyof Omit<ResetTransformStatus, 'destinationIndex'>;
+
+export const useResetTransforms = () => {
+ const { overlays, theme } = useAppDependencies();
+ const toastNotifications = useToastNotifications();
+ const api = useApi();
+
+ return async (reqBody: ResetTransformsRequestSchema) => {
+ const results = await api.resetTransforms(reqBody);
+
+ if (!isResetTransformsResponseSchema(results)) {
+ toastNotifications.addDanger({
+ title: i18n.translate('xpack.transform.transformList.resetTransformGenericErrorMessage', {
+ defaultMessage: 'An error occurred calling the API endpoint to reset transforms.',
+ }),
+ text: toMountPoint(
+ <ToastNotificationText
+ previewTextLength={50}
+ overlays={overlays}
+ theme={theme}
+ text={getErrorMessage(results)}
+ />,
+ { theme$: theme.theme$ }
+ ),
+ });
+ return;
+ }
+
+ const isBulk = Object.keys(results).length > 1;
+ const successCount: Record<SuccessCountField, number> = {
+ transformReset: 0,
+ };
+ for (const transformId in results) {
+ // hasOwnProperty check to ensure only properties on object itself, and not its prototypes
+ if (results.hasOwnProperty(transformId)) {
+ const status = results[transformId];
+
+ // if we are only resetting one transform, show the success toast messages
+ if (!isBulk && status.transformReset) {
+ if (status.transformReset?.success) {
+ toastNotifications.addSuccess(
+ i18n.translate('xpack.transform.transformList.resetTransformSuccessMessage', {
+ defaultMessage: 'Request to reset transform {transformId} acknowledged.',
+ values: { transformId },
+ })
+ );
+ }
+ } else {
+ (Object.keys(successCount) as SuccessCountField[]).forEach((key) => {
+ if (status[key]?.success) {
+ successCount[key] = successCount[key] + 1;
+ }
+ });
+ }
+ if (status.transformReset?.error) {
+ const error = status.transformReset.error.reason;
+ toastNotifications.addDanger({
+ title: i18n.translate('xpack.transform.transformList.resetTransformErrorMessage', {
+ defaultMessage: 'An error occurred resetting the transform {transformId}',
+ values: { transformId },
+ }),
+ text: toMountPoint(
+ <ToastNotificationText
+ previewTextLength={50}
+ overlays={overlays}
+ theme={theme}
+ text={error}
+ />,
+ { theme$: theme.theme$ }
+ ),
+ });
+ }
+ }
+ }
+
+ // if we are deleting multiple transforms, combine the success messages
+ if (isBulk) {
+ if (successCount.transformReset > 0) {
+ toastNotifications.addSuccess(
+ i18n.translate('xpack.transform.transformList.bulkResetTransformSuccessMessage', {
+ defaultMessage:
+ 'Successfully reset {count} {count, plural, one {transform} other {transforms}}.',
+ values: { count: successCount.transformReset },
+ })
+ );
+ }
+ }
+
+ refreshTransformList$.next(REFRESH_TRANSFORM_LIST_STATE.REFRESH);
+ };
+};

x-pack/plugins/transform/public/app/lib/authorization/components/authorization_provider.tsx

@@ -28,6 +28,7 @@ const initialCapabilities: Capabilities = {
  canStartStopTransform: false,
  canCreateTransformAlerts: false,
  canUseTransformAlerts: false,
+ canResetTransform: false,
 };
 
 const initialValue: Authorization = {
@@ -77,6 +78,8 @@ export const AuthorizationProvider = ({ privilegesEndpoint, children }: Props) =
  'cluster:admin/transform/delete',
  ]);
 
+ value.capabilities.canResetTransform = hasPrivilege(['cluster', 'cluster:admin/transform/reset']);
+
  value.capabilities.canPreviewTransform = hasPrivilege([
  'cluster',
  'cluster:admin/transform/preview',

x-pack/plugins/transform/public/app/lib/authorization/components/common.ts

@@ -18,6 +18,7 @@ export interface Capabilities {
  canStartStopTransform: boolean;
  canCreateTransformAlerts: boolean;
  canUseTransformAlerts: boolean;
+ canResetTransform: boolean;
 }
 
 export type Privilege = [string, string];
@@ -91,6 +92,12 @@ export function createCapabilityFailureMessage(
  });
  break;
 
+ case 'canResetTransform':
+ message = i18n.translate('xpack.transform.capability.noPermission.resetTransformTooltip', {
+ defaultMessage: 'You do not have permission to reset transforms.',
+ });
+ break;
+
  case 'noTransformNodes':
  message = i18n.translate('xpack.transform.capability.noPermission.noTransformNodesTooltip', {
  defaultMessage: 'There are no transform nodes available.',

x-pack/plugins/transform/public/app/sections/transform_management/components/action_reset/index.ts

@@ -0,0 +1,10 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+export { useResetAction } from './use_reset_action';
+export { ResetActionModal } from './reset_action_modal';
+export { isResetActionDisabled, ResetActionName } from './reset_action_name';

x-pack/plugins/transform/public/app/sections/transform_management/components/action_reset/reset_action_modal.tsx

@@ -0,0 +1,88 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import React, { FC, useMemo } from 'react';
+import { i18n } from '@kbn/i18n';
+import { EUI_MODAL_CONFIRM_BUTTON, EuiConfirmModal, EuiFlexGroup, EuiSpacer } from '@elastic/eui';
+import { ResetAction } from './use_reset_action';
+import { isManagedTransform } from '../../../../common/managed_transforms_utils';
+import { ManagedTransformsWarningCallout } from '../managed_transforms_callout/managed_transforms_callout';
+
+export const ResetActionModal: FC<ResetAction> = ({
+ closeModal,
+ resetAndCloseModal,
+ items,
+ shouldForceReset,
+}) => {
+ const hasManagedTransforms = useMemo(() => items.some((t) => isManagedTransform(t)), [items]);
+ const isBulkAction = items.length > 1;
+
+ const bulkResetModalTitle = i18n.translate('xpack.transform.transformList.bulkResetModalTitle', {
+ defaultMessage: 'Reset {count} {count, plural, one {transform} other {transforms}}?',
+ values: { count: items.length },
+ });
+ const resetModalTitle = i18n.translate('xpack.transform.transformList.resetModalTitle', {
+ defaultMessage: 'Reset {transformId}?',
+ values: { transformId: items[0] && items[0].config.id },
+ });
+ const bulkResetModalContent = (
+ <>
+ <EuiFlexGroup direction="column" gutterSize="none">
+ {hasManagedTransforms ? (
+ <>
+ <ManagedTransformsWarningCallout
+ count={items.length}
+ action={i18n.translate(
+ 'xpack.transform.transformList.resetManagedTransformDescription',
+ { defaultMessage: 'resetting' }
+ )}
+ />
+ <EuiSpacer />
+ </>
+ ) : null}
+ </EuiFlexGroup>
+ </>
+ );
+
+ const resetModalContent = (
+ <>
+ <EuiFlexGroup direction="column" gutterSize="none">
+ {hasManagedTransforms ? (
+ <>
+ <ManagedTransformsWarningCallout
+ count={1}
+ action={i18n.translate(
+ 'xpack.transform.transformList.resetManagedTransformDescription',
+ { defaultMessage: 'resetting' }
+ )}
+ />
+ <EuiSpacer />
+ </>
+ ) : null}
+ </EuiFlexGroup>
+ </>
+ );
+
+ return (
+ <EuiConfirmModal
+ data-test-subj="transformResetModal"
+ title={isBulkAction === true ? bulkResetModalTitle : resetModalTitle}
+ onCancel={closeModal}
+ onConfirm={resetAndCloseModal}
+ cancelButtonText={i18n.translate('xpack.transform.transformList.resetModalCancelButton', {
+ defaultMessage: 'Cancel',
+ })}
+ confirmButtonText={i18n.translate('xpack.transform.transformList.resetModalResetButton', {
+ defaultMessage: 'Reset',
+ })}
+ defaultFocusedButton={EUI_MODAL_CONFIRM_BUTTON}
+ buttonColor="danger"
+ >
+ {isBulkAction ? bulkResetModalContent : resetModalContent}
+ </EuiConfirmModal>
+ );
+};