[ML] Transforms/Data frame analytics: Aligns data view / destination index creation workflow in wizards

.github/CODEOWNERS

@@ -517,8 +517,10 @@ x-pack/packages/ml/agg_utils @elastic/ml-ui
 x-pack/packages/ml/anomaly_utils @elastic/ml-ui
 x-pack/packages/ml/category_validator @elastic/ml-ui
 x-pack/packages/ml/chi2test @elastic/ml-ui
+x-pack/packages/ml/creation_wizard_utils @elastic/ml-ui
 x-pack/packages/ml/data_frame_analytics_utils @elastic/ml-ui
 x-pack/packages/ml/data_grid @elastic/ml-ui
+x-pack/packages/ml/data_view_utils @elastic/ml-ui
 x-pack/packages/ml/date_picker @elastic/ml-ui
 x-pack/packages/ml/date_utils @elastic/ml-ui
 x-pack/packages/ml/error_utils @elastic/ml-ui

package.json

@@ -536,8 +536,10 @@
     "@kbn/ml-anomaly-utils": "link:x-pack/packages/ml/anomaly_utils",
     "@kbn/ml-category-validator": "link:x-pack/packages/ml/category_validator",
     "@kbn/ml-chi2test": "link:x-pack/packages/ml/chi2test",
+    "@kbn/ml-creation-wizard-utils": "link:x-pack/packages/ml/creation_wizard_utils",
     "@kbn/ml-data-frame-analytics-utils": "link:x-pack/packages/ml/data_frame_analytics_utils",
     "@kbn/ml-data-grid": "link:x-pack/packages/ml/data_grid",
+    "@kbn/ml-data-view-utils": "link:x-pack/packages/ml/data_view_utils",
     "@kbn/ml-date-picker": "link:x-pack/packages/ml/date_picker",
     "@kbn/ml-date-utils": "link:x-pack/packages/ml/date_utils",
     "@kbn/ml-error-utils": "link:x-pack/packages/ml/error_utils",

tsconfig.base.json

@@ -1028,10 +1028,14 @@
       "@kbn/ml-category-validator/*": ["x-pack/packages/ml/category_validator/*"],
       "@kbn/ml-chi2test": ["x-pack/packages/ml/chi2test"],
       "@kbn/ml-chi2test/*": ["x-pack/packages/ml/chi2test/*"],
+      "@kbn/ml-creation-wizard-utils": ["x-pack/packages/ml/creation_wizard_utils"],
+      "@kbn/ml-creation-wizard-utils/*": ["x-pack/packages/ml/creation_wizard_utils/*"],
       "@kbn/ml-data-frame-analytics-utils": ["x-pack/packages/ml/data_frame_analytics_utils"],
       "@kbn/ml-data-frame-analytics-utils/*": ["x-pack/packages/ml/data_frame_analytics_utils/*"],
       "@kbn/ml-data-grid": ["x-pack/packages/ml/data_grid"],
       "@kbn/ml-data-grid/*": ["x-pack/packages/ml/data_grid/*"],
+      "@kbn/ml-data-view-utils": ["x-pack/packages/ml/data_view_utils"],
+      "@kbn/ml-data-view-utils/*": ["x-pack/packages/ml/data_view_utils/*"],
       "@kbn/ml-date-picker": ["x-pack/packages/ml/date_picker"],
       "@kbn/ml-date-picker/*": ["x-pack/packages/ml/date_picker/*"],
       "@kbn/ml-date-utils": ["x-pack/packages/ml/date_utils"],

x-pack/.i18nrc.json

@@ -55,7 +55,9 @@
     "xpack.metricsData": "plugins/metrics_data_access",
     "xpack.ml": [
       "packages/ml/anomaly_utils",
+      "packages/ml/creation_wizard_utils",
       "packages/ml/data_grid",
+      "packages/ml/data_view_utils",
       "packages/ml/date_picker",
       "packages/ml/trained_models_utils",
       "packages/ml/category_validator",

x-pack/packages/ml/creation_wizard_utils/README.md

@@ -0,0 +1,3 @@
+# @kbn/ml-creation-wizard-utils
+
+Utilities and components shared across creation wizards in plugins owned by the @elastic/ml-ui team.

x-pack/packages/ml/creation_wizard_utils/components/destination_index_form.tsx

@@ -0,0 +1,102 @@
+/*
+ * 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, { type FC } from 'react';
+
+import { EuiFieldText, EuiFormRow, EuiLink } from '@elastic/eui';
+
+import { i18n } from '@kbn/i18n';
+
+import { UseIdAsIndexNameSwitch } from './use_id_as_index_name_switch';
+
+interface DestinationIndexFormProps {
+  createIndexLink: string;
+  destinationIndex: string;
+  destinationIndexNameEmpty: boolean;
+  destinationIndexNameExists: boolean;
+  destinationIndexNameValid: boolean;
+  destIndexSameAsId: boolean;
+  fullWidth?: boolean;
+  indexNameExistsMessage: string;
+  isJobCreated: boolean;
+  onDestinationIndexChange: (d: string) => void;
+  setDestIndexSameAsId: (d: boolean) => void;
+  switchLabel: string;
+}
+
+export const DestinationIndexForm: FC<DestinationIndexFormProps> = ({
+  createIndexLink,
+  destinationIndex,
+  destinationIndexNameEmpty,
+  destinationIndexNameExists,
+  destinationIndexNameValid,
+  destIndexSameAsId,
+  fullWidth = true,
+  indexNameExistsMessage,
+  isJobCreated,
+  onDestinationIndexChange,
+  setDestIndexSameAsId,
+  switchLabel,
+}) => (
+  <>
+    <EuiFormRow
+      fullWidth={fullWidth}
+      helpText={destIndexSameAsId === true && destinationIndexNameExists && indexNameExistsMessage}
+    >
+      <UseIdAsIndexNameSwitch
+        destIndexSameAsId={destIndexSameAsId}
+        isJobCreated={isJobCreated}
+        setDestIndexSameAsId={setDestIndexSameAsId}
+        label={switchLabel}
+      />
+    </EuiFormRow>
+    {destIndexSameAsId === false && (
+      <EuiFormRow
+        fullWidth={fullWidth}
+        label={i18n.translate('xpack.ml.creationWizardUtils.destinationIndexLabel', {
+          defaultMessage: 'Destination index',
+        })}
+        isInvalid={
+          destinationIndexNameEmpty || (!destinationIndexNameEmpty && !destinationIndexNameValid)
+        }
+        helpText={destinationIndexNameExists && indexNameExistsMessage}
+        error={
+          !destinationIndexNameEmpty &&
+          !destinationIndexNameValid && [
+            <>
+              {i18n.translate('xpack.ml.creationWizardUtils.destinationIndexInvalidError', {
+                defaultMessage: 'Invalid destination index name.',
+              })}
+              <br />
+              <EuiLink href={createIndexLink} target="_blank">
+                {i18n.translate('xpack.ml.creationWizardUtils.destinationIndexInvalidErrorLink', {
+                  defaultMessage: 'Learn more about index name limitations.',
+                })}
+              </EuiLink>
+            </>,
+          ]
+        }
+      >
+        <EuiFieldText
+          fullWidth={fullWidth}
+          disabled={isJobCreated}
+          placeholder="destination index"
+          value={destinationIndex}
+          onChange={(e) => onDestinationIndexChange(e.target.value)}
+          aria-label={i18n.translate(
+            'xpack.ml.creationWizardUtils.destinationIndexInputAriaLabel',
+            {
+              defaultMessage: 'Choose a unique destination index name.',
+            }
+          )}
+          isInvalid={!destinationIndexNameEmpty && !destinationIndexNameValid}
+          data-test-subj="mlCreationWizardUtilsDestinationIndexInput"
+        />
+      </EuiFormRow>
+    )}
+  </>
+);

x-pack/packages/ml/creation_wizard_utils/components/use_id_as_index_name_switch.tsx

@@ -0,0 +1,33 @@
+/*
+ * 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, { type FC } from 'react';
+
+import { EuiSwitch } from '@elastic/eui';
+
+interface UseIdAsIndexNameSwitchProps {
+  destIndexSameAsId: boolean;
+  isJobCreated: boolean;
+  setDestIndexSameAsId: (d: boolean) => void;
+  label: string;
+}
+
+export const UseIdAsIndexNameSwitch: FC<UseIdAsIndexNameSwitchProps> = ({
+  destIndexSameAsId,
+  isJobCreated,
+  setDestIndexSameAsId,
+  label,
+}) => (
+  <EuiSwitch
+    disabled={isJobCreated}
+    name="mlCreationWizardUtilsJobIdAsDestIndexName"
+    label={label}
+    checked={destIndexSameAsId === true}
+    onChange={() => setDestIndexSameAsId(!destIndexSameAsId)}
+    data-test-subj="mlCreationWizardUtilsJobIdAsDestIndexNameSwitch"
+  />
+);

x-pack/packages/ml/creation_wizard_utils/jest.config.js

@@ -0,0 +1,12 @@
+/*
+ * 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.
+ */
+
+module.exports = {
+  preset: '@kbn/test',
+  rootDir: '../../../..',
+  roots: ['<rootDir>/x-pack/packages/ml/creation_wizard_utils'],
+};

x-pack/packages/ml/creation_wizard_utils/kibana.jsonc

@@ -0,0 +1,5 @@
+{
+  "type": "shared-common",
+  "id": "@kbn/ml-creation-wizard-utils",
+  "owner": "@elastic/ml-ui"
+}

x-pack/packages/ml/creation_wizard_utils/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@kbn/ml-creation-wizard-utils",
+  "private": true,
+  "version": "1.0.0",
+  "license": "Elastic License 2.0"
+}

x-pack/packages/ml/creation_wizard_utils/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "extends": "../../../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "target/types",
+    "types": [
+      "jest",
+      "node",
+      "react"
+    ]
+  },
+  "include": [
+    "**/*.ts",
+    "**/*.tsx",
+  ],
+  "exclude": [
+    "target/**/*"
+  ],
+  "kbn_references": [
+    "@kbn/i18n",
+  ]
+}

x-pack/packages/ml/data_view_utils/README.md

@@ -0,0 +1,3 @@
+# @kbn/ml-data-view-utils
+
+Utilities for handling data views in plugins owned by the @elastic/ml-ui team.

x-pack/packages/ml/data_view_utils/actions/create.ts

@@ -0,0 +1,54 @@
+/*
+ * 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 type { DataViewsService, RuntimeField } from '@kbn/data-views-plugin/common';
+
+import type { CreateDataViewApiResponseSchema } from '../types/api_create_response_schema';
+
+interface CreateDataViewFnOptions {
+  dataViewsService: DataViewsService;
+  dataViewName: string;
+  runtimeMappings: Record<string, RuntimeField>;
+  timeFieldName?: string;
+  errorFallbackId: string;
+}
+
+export const createDataViewFn = async ({
+  dataViewsService,
+  dataViewName,
+  runtimeMappings,
+  timeFieldName,
+  // A fall back id to be able to track the response
+  // because in case of an error we don't get a data view id.
+  errorFallbackId,
+}: CreateDataViewFnOptions): Promise<CreateDataViewApiResponseSchema> => {
+  const response: CreateDataViewApiResponseSchema = {
+    dataViewsCreated: [],
+    dataViewsErrors: [],
+  };
+
+  try {
+    const dataViewsResp = await dataViewsService.createAndSave(
+      {
+        title: dataViewName,
+        timeFieldName,
+        runtimeFieldMap: runtimeMappings,
+        allowNoIndex: true,
+      },
+      false,
+      true
+    );
+
+    if (dataViewsResp.id) {
+      response.dataViewsCreated = [{ id: dataViewsResp.id }];
+    }
+  } catch (error) {
+    response.dataViewsErrors = [{ id: errorFallbackId, error }];
+  }
+
+  return response;
+};

x-pack/packages/ml/data_view_utils/actions/delete.ts

@@ -0,0 +1,48 @@
+/*
+ * 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 type { DataViewsService } from '@kbn/data-views-plugin/common';
+
+import type { DeleteDataViewApiResponseSchema } from '../types/api_delete_response_schema';
+
+import { DataViewHandler } from './data_view_handler';
+
+async function getDataViewId(dataViewsService: DataViewsService, patternName: string) {
+  const iph = new DataViewHandler(dataViewsService);
+  return await iph.getDataViewId(patternName);
+}
+
+async function deleteDestDataViewById(dataViewsService: DataViewsService, dataViewId: string) {
+  const iph = new DataViewHandler(dataViewsService);
+  return await iph.deleteDataViewById(dataViewId);
+}
+
+interface DeleteDataViewFnOptions {
+  dataViewsService: DataViewsService;
+  dataViewName: string;
+}
+
+export const deleteDataViewFn = async ({
+  dataViewsService,
+  dataViewName,
+}: DeleteDataViewFnOptions): Promise<DeleteDataViewApiResponseSchema> => {
+  const response: DeleteDataViewApiResponseSchema = {
+    success: false,
+  };
+
+  try {
+    const dataViewId = await getDataViewId(dataViewsService, dataViewName);
+    if (dataViewId) {
+      await deleteDestDataViewById(dataViewsService, dataViewId);
+    }
+    response.success = true;
+  } catch (deleteDestDataViewError) {
+    response.error = deleteDestDataViewError;
+  }
+
+  return response;
+};