[ML] DF Analytics: Creation wizard part 2 (#68462)

* Add ability to clone job * remove deprecated creation form code * ensure excludes cloned correctly and update clone action jest test * remove unused translations * update helper function name
elastic · Jun 9, 2020 · 696d71e · 696d71e
1 parent ccb6073
commit 696d71e
Show file tree

Hide file tree

Showing 38 changed files with 236 additions and 1,493 deletions.
diff --git a/x-pack/plugins/ml/public/application/data_frame_analytics/_index.scss b/x-pack/plugins/ml/public/application/data_frame_analytics/_index.scss
@@ -1,5 +1,3 @@
 @import 'pages/analytics_exploration/components/regression_exploration/index';
 @import 'pages/analytics_management/components/analytics_list/index';
-@import 'pages/analytics_management/components/create_analytics_form/index';
-@import 'pages/analytics_management/components/create_analytics_flyout/index';
 @import 'pages/analytics_management/components/create_analytics_button/index';
diff --git a/...nalytics/pages/analytics_creation/components/configuration_step/analysis_fields_table.tsx b/...nalytics/pages/analytics_creation/components/configuration_step/analysis_fields_table.tsx
@@ -85,7 +85,7 @@ export const MemoizedAnalysisFieldsTable: FC<{
       if (excludes.length > 0) {
         setCurrentSelection(excludes);
       }
-    }, []);
+    }, [tableItems]);
 
     // Only set form state on unmount to prevent re-renders due to props changing if exludes was updated on each selection
     useEffect(() => {

diff --git a/...lytics/pages/analytics_creation/components/configuration_step/configuration_step_form.tsx b/...lytics/pages/analytics_creation/components/configuration_step/configuration_step_form.tsx
@@ -20,13 +20,13 @@ import {
   TRAINING_PERCENT_MAX,
 } from '../../../../common/analytics';
 import { CreateAnalyticsStepProps } from '../../../analytics_management/hooks/use_create_analytics_form';
-import { Messages } from '../../../analytics_management/components/create_analytics_form/messages';
+import { Messages } from '../shared';
 import {
   DEFAULT_MODEL_MEMORY_LIMIT,
   getJobConfigFromFormState,
   State,
 } from '../../../analytics_management/hooks/use_create_analytics_form/state';
-import { shouldAddAsDepVarOption } from '../../../analytics_management/components/create_analytics_form/form_options_validation';
+import { shouldAddAsDepVarOption } from './form_options_validation';
 import { ml } from '../../../../../services/ml_api_service';
 import { getToastNotifications } from '../../../../../util/dependency_cache';
 
@@ -56,7 +56,7 @@ export const ConfigurationStepForm: FC<CreateAnalyticsStepProps> = ({
   const { currentSavedSearch, currentIndexPattern } = mlContext;
   const { savedSearchQuery, savedSearchQueryStr } = useSavedSearch();
 
-  const { initiateWizard, setEstimatedModelMemoryLimit, setFormState } = actions;
+  const { setEstimatedModelMemoryLimit, setFormState } = actions;
   const { estimatedModelMemoryLimit, form, isJobCreated, requestMessages } = state;
   const firstUpdate = useRef<boolean>(true);
   const {
@@ -75,9 +75,12 @@ export const ConfigurationStepForm: FC<CreateAnalyticsStepProps> = ({
     modelMemoryLimit,
     previousJobType,
     requiredFieldsError,
+    sourceIndex,
     trainingPercent,
   } = form;
 
+  const toastNotifications = getToastNotifications();
+
   const setJobConfigQuery = ({ query, queryString }: { query: any; queryString: string }) => {
     setFormState({ jobConfigQuery: query, jobConfigQueryString: queryString });
   };
@@ -90,7 +93,7 @@ export const ConfigurationStepForm: FC<CreateAnalyticsStepProps> = ({
   const indexPreviewProps = {
     ...indexData,
     dataTestSubj: 'mlAnalyticsCreationDataGrid',
-    toastNotifications: getToastNotifications(),
+    toastNotifications,
   };
 
   const isJobTypeWithDepVar =
@@ -209,7 +212,8 @@ export const ConfigurationStepForm: FC<CreateAnalyticsStepProps> = ({
         });
       }
     } catch (e) {
-      let errorMessage;
+      let maxDistinctValuesErrorMessage;
+
       if (
         jobType === ANALYSIS_CONFIG_TYPE.CLASSIFICATION &&
         e.body &&
@@ -218,7 +222,23 @@ export const ConfigurationStepForm: FC<CreateAnalyticsStepProps> = ({
         (e.body.message.includes('must have at most') ||
           e.body.message.includes('must have at least'))
       ) {
-        errorMessage = e.body.message;
+        maxDistinctValuesErrorMessage = e.body.message;
+      }
+
+      if (
+        e.body &&
+        e.body.message !== undefined &&
+        e.body.message.includes('status_exception') &&
+        e.body.message.includes('Unable to estimate memory usage as no documents')
+      ) {
+        toastNotifications.addWarning(
+          i18n.translate('xpack.ml.dataframe.analytics.create.allDocsMissingFieldsErrorMessage', {
+            defaultMessage: `Unable to estimate memory usage. There are mapped fields for source index [{index}] that do not exist in any indexed documents. You will have to switch to the JSON editor for explicit field selection and include only fields that exist in indexed documents.`,
+            values: {
+              index: sourceIndex,
+            },
+          })
+        );
       }
       const fallbackModelMemoryLimit =
         jobType !== undefined
@@ -227,17 +247,13 @@ export const ConfigurationStepForm: FC<CreateAnalyticsStepProps> = ({
       setEstimatedModelMemoryLimit(fallbackModelMemoryLimit);
       setFormState({
         fieldOptionsFetchFail: true,
-        maxDistinctValuesError: errorMessage,
+        maxDistinctValuesError: maxDistinctValuesErrorMessage,
         loadingFieldOptions: false,
         ...(shouldUpdateModelMemoryLimit ? { modelMemoryLimit: fallbackModelMemoryLimit } : {}),
       });
     }
   }, 300);
 
-  useEffect(() => {
-    initiateWizard();
-  }, []);
-
   useEffect(() => {
     setFormState({ sourceIndex: currentIndexPattern.title });
   }, []);

diff --git a/...analytics_form/form_options_validation.ts → ...iguration_step/form_options_validation.ts b/...analytics_form/form_options_validation.ts → ...iguration_step/form_options_validation.ts
@@ -7,7 +7,7 @@
 import { ES_FIELD_TYPES } from '../../../../../../../../../../src/plugins/data/public';
 import { Field, EVENT_RATE_FIELD_ID } from '../../../../../../../common/types/fields';
 import { ANALYSIS_CONFIG_TYPE } from '../../../../common/analytics';
-import { AnalyticsJobType } from '../../hooks/use_create_analytics_form/state';
+import { AnalyticsJobType } from '../../../analytics_management/hooks/use_create_analytics_form/state';
 import { BASIC_NUMERICAL_TYPES, EXTENDED_NUMERICAL_TYPES } from '../../../../common/fields';
 
 export const CATEGORICAL_TYPES = new Set(['ip', 'keyword']);

diff --git a/...ytics/pages/analytics_creation/components/configuration_step/supported_fields_message.tsx b/...ytics/pages/analytics_creation/components/configuration_step/supported_fields_message.tsx
@@ -12,10 +12,7 @@ import { AnalyticsJobType } from '../../../analytics_management/hooks/use_create
 import { ANALYSIS_CONFIG_TYPE } from '../../../../common/analytics';
 import { Field, EVENT_RATE_FIELD_ID } from '../../../../../../../common/types/fields';
 import { BASIC_NUMERICAL_TYPES, EXTENDED_NUMERICAL_TYPES } from '../../../../common/fields';
-import {
-  OMIT_FIELDS,
-  CATEGORICAL_TYPES,
-} from '../../../analytics_management/components/create_analytics_form/form_options_validation';
+import { OMIT_FIELDS, CATEGORICAL_TYPES } from './form_options_validation';
 import { ES_FIELD_TYPES } from '../../../../../../../../../../src/plugins/data/public';
 import { newJobCapsService } from '../../../../../services/new_job_capabilities_service';
 

diff --git a/...itor/create_analytics_advanced_editor.tsx → ...itor/create_analytics_advanced_editor.tsx b/...itor/create_analytics_advanced_editor.tsx → ...itor/create_analytics_advanced_editor.tsx
@@ -22,9 +22,9 @@ import { XJsonMode } from '../../../../../../../shared_imports';
 
 const xJsonMode = new XJsonMode();
 
-import { CreateAnalyticsFormProps } from '../../hooks/use_create_analytics_form';
-import { CreateStep } from '../../../analytics_creation/components/create_step';
-import { ANALYTICS_STEPS } from '../../../analytics_creation/page';
+import { CreateAnalyticsFormProps } from '../../../analytics_management/hooks/use_create_analytics_form';
+import { CreateStep } from '../create_step';
+import { ANALYTICS_STEPS } from '../../page';
 
 export const CreateAnalyticsAdvancedEditor: FC<CreateAnalyticsFormProps> = (props) => {
   const { actions, state } = props;
@@ -125,7 +125,6 @@ export const CreateAnalyticsAdvancedEditor: FC<CreateAnalyticsFormProps> = (prop
           onChange={onChange}
           setOptions={{
             fontSize: '12px',
-            maxLines: 20,
           }}
           theme="textmate"
           aria-label={i18n.translate(

diff --git a/...create_analytics_advanced_editor/index.ts → ...create_analytics_advanced_editor/index.ts b/...create_analytics_advanced_editor/index.ts → ...create_analytics_advanced_editor/index.ts
diff --git a/...tion/data_frame_analytics/pages/analytics_creation/components/create_step/create_step.tsx b/...tion/data_frame_analytics/pages/analytics_creation/components/create_step/create_step.tsx
@@ -16,7 +16,7 @@ import {
 import { i18n } from '@kbn/i18n';
 
 import { CreateAnalyticsFormProps } from '../../../analytics_management/hooks/use_create_analytics_form';
-import { Messages } from '../../../analytics_management/components/create_analytics_form/messages';
+import { Messages } from '../shared';
 import { ANALYTICS_STEPS } from '../../page';
 import { BackToListPanel } from '../back_to_list_panel';
 
@@ -26,14 +26,7 @@ interface Props extends CreateAnalyticsFormProps {
 
 export const CreateStep: FC<Props> = ({ actions, state, step }) => {
   const { createAnalyticsJob, startAnalyticsJob } = actions;
-  const {
-    isAdvancedEditorValidJson,
-    isJobCreated,
-    isJobStarted,
-    isModalButtonDisabled,
-    isValid,
-    requestMessages,
-  } = state;
+  const { isAdvancedEditorValidJson, isJobCreated, isJobStarted, isValid, requestMessages } = state;
 
   const [checked, setChecked] = useState<boolean>(true);
 
@@ -75,7 +68,7 @@ export const CreateStep: FC<Props> = ({ actions, state, step }) => {
           <EuiFlexItem grow={false}>
             <EuiButton
               className="mlAnalyticsCreateWizard__footerButton"
-              disabled={!isValid || !isAdvancedEditorValidJson || isModalButtonDisabled}
+              disabled={!isValid || !isAdvancedEditorValidJson}
               onClick={handleCreation}
               fill
               data-test-subj="mlAnalyticsCreateJobWizardCreateButton"

diff --git a/...components/create_analytics_form/index.ts → ...ytics_creation/components/shared/index.ts b/...components/create_analytics_form/index.ts → ...ytics_creation/components/shared/index.ts
@@ -4,4 +4,4 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-export { CreateAnalyticsForm } from './create_analytics_form';
+export { Messages } from './messages';
diff --git a/...onents/create_analytics_form/messages.tsx → ...s_creation/components/shared/messages.tsx b/...onents/create_analytics_form/messages.tsx → ...s_creation/components/shared/messages.tsx
@@ -8,7 +8,7 @@ import React, { Fragment, FC } from 'react';
 
 import { EuiCallOut, EuiCodeBlock, EuiSpacer } from '@elastic/eui';
 
-import { FormMessage } from '../../hooks/use_create_analytics_form/state'; // State
+import { FormMessage } from '../../../analytics_management/hooks/use_create_analytics_form/state';
 
 interface Props {
   messages: FormMessage[];

diff --git a/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/page.tsx b/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/page.tsx
@@ -23,8 +23,10 @@ import { i18n } from '@kbn/i18n';
 import { FormattedMessage } from '@kbn/i18n/react';
 import { useMlContext } from '../../../contexts/ml';
 import { newJobCapsService } from '../../../services/new_job_capabilities_service';
+import { ml } from '../../../services/ml_api_service';
+import { DataFrameAnalyticsId } from '../../common/analytics';
 import { useCreateAnalyticsForm } from '../analytics_management/hooks/use_create_analytics_form';
-import { CreateAnalyticsAdvancedEditor } from '../analytics_management/components/create_analytics_advanced_editor';
+import { CreateAnalyticsAdvancedEditor } from './components/create_analytics_advanced_editor';
 import { AdvancedStep, ConfigurationStep, CreateStep, DetailsStep } from './components';
 
 export enum ANALYTICS_STEPS {
@@ -34,7 +36,11 @@ export enum ANALYTICS_STEPS {
   CREATE,
 }
 
-export const Page: FC = () => {
+interface Props {
+  jobId?: DataFrameAnalyticsId;
+}
+
+export const Page: FC<Props> = ({ jobId }) => {
   const [currentStep, setCurrentStep] = useState<ANALYTICS_STEPS>(ANALYTICS_STEPS.CONFIGURATION);
   const [activatedSteps, setActivatedSteps] = useState<boolean[]>([true, false, false, false]);
 
@@ -44,23 +50,36 @@ export const Page: FC = () => {
   const createAnalyticsForm = useCreateAnalyticsForm();
   const { isAdvancedEditorEnabled } = createAnalyticsForm.state;
   const { jobType } = createAnalyticsForm.state.form;
-  const { switchToAdvancedEditor } = createAnalyticsForm.actions;
+  const { initiateWizard, setJobClone, switchToAdvancedEditor } = createAnalyticsForm.actions;
 
   useEffect(() => {
-    if (activatedSteps[currentStep] === false) {
-      activatedSteps.splice(currentStep, 1, true);
-      setActivatedSteps(activatedSteps);
-    }
-  }, [currentStep]);
+    initiateWizard();
 
-  useEffect(() => {
     if (currentIndexPattern) {
       (async function () {
         await newJobCapsService.initializeFromIndexPattern(currentIndexPattern, false, false);
+
+        if (jobId !== undefined) {
+          const analyticsConfigs = await ml.dataFrameAnalytics.getDataFrameAnalytics(jobId);
+          if (
+            Array.isArray(analyticsConfigs.data_frame_analytics) &&
+            analyticsConfigs.data_frame_analytics.length > 0
+          ) {
+            const clonedJobConfig: any = analyticsConfigs.data_frame_analytics[0];
+            await setJobClone(clonedJobConfig);
+          }
+        }
       })();
     }
   }, []);
 
+  useEffect(() => {
+    if (activatedSteps[currentStep] === false) {
+      activatedSteps.splice(currentStep, 1, true);
+      setActivatedSteps(activatedSteps);
+    }
+  }, [currentStep]);
+
   const analyticsWizardSteps = [
     {
       title: i18n.translate('xpack.ml.dataframe.analytics.creation.configurationStepTitle', {
@@ -127,10 +146,19 @@ export const Page: FC = () => {
                 <EuiFlexItem grow={false}>
                   <EuiTitle size="m">
                     <h1>
-                      <FormattedMessage
-                        id="xpack.ml.dataframe.analytics.creationPageTitle"
-                        defaultMessage="Create analytics job"
-                      />
+                      {jobId === undefined && (
+                        <FormattedMessage
+                          id="xpack.ml.dataframe.analytics.creationPageTitle"
+                          defaultMessage="Create analytics job"
+                        />
+                      )}
+                      {jobId !== undefined && (
+                        <FormattedMessage
+                          id="xpack.ml.dataframe.analytics.clone.creationPageTitle"
+                          defaultMessage="Clone analytics job from {jobId}"
+                          values={{ jobId }}
+                        />
+                      )}
                     </h1>
                   </EuiTitle>
                 </EuiFlexItem>

diff --git a/...frame_analytics/pages/analytics_management/components/analytics_list/action_clone.test.ts b/...frame_analytics/pages/analytics_management/components/analytics_list/action_clone.test.ts
@@ -140,8 +140,8 @@ describe('Analytics job clone action', () => {
       expect(isAdvancedConfig(advancedClassificationJob)).toBe(true);
     });
 
-    test('should detect advanced outlier_detection job', () => {
-      const advancedOutlierDetectionJob = {
+    test('should detect advanced regression job', () => {
+      const advancedRegressionJob = {
         description: "Outlier detection job with 'glass' dataset",
         source: {
           index: ['glass_withoutdupl_norm'],
@@ -155,10 +155,8 @@ describe('Analytics job clone action', () => {
           results_field: 'ml',
         },
         analysis: {
-          outlier_detection: {
-            compute_feature_influence: false,
-            outlier_fraction: 0.05,
-            standardization_enabled: true,
+          regression: {
+            loss_function: 'msle',
           },
         },
         analyzed_fields: {
@@ -168,7 +166,7 @@ describe('Analytics job clone action', () => {
         model_memory_limit: '1mb',
         allow_lazy_start: false,
       };
-      expect(isAdvancedConfig(advancedOutlierDetectionJob)).toBe(true);
+      expect(isAdvancedConfig(advancedRegressionJob)).toBe(true);
     });
 
     test('should detect a custom query', () => {
@@ -207,32 +205,6 @@ describe('Analytics job clone action', () => {
       expect(isAdvancedConfig(advancedRegressionJob)).toBe(true);
     });
 
-    test('should detect custom analysis settings', () => {
-      const config = {
-        description: "Classification clone with 'bank-marketing' dataset",
-        source: {
-          index: 'bank-marketing',
-        },
-        dest: {
-          index: 'bank_classification4',
-        },
-        analyzed_fields: {
-          excludes: [],
-        },
-        analysis: {
-          classification: {
-            dependent_variable: 'y',
-            training_percent: 71,
-            max_trees: 1500,
-            num_top_feature_importance_values: 4,
-          },
-        },
-        model_memory_limit: '400mb',
-      };
-
-      expect(isAdvancedConfig(config)).toBe(true);
-    });
-
     test('should detect as advanced if the prop is unknown', () => {
       const config = {
         description: "Classification clone with 'bank-marketing' dataset",