ensure at least one field besides depVar included in analysis

elastic · May 5, 2020 · cb5fdc4 · cb5fdc4
1 parent f2d1095
commit cb5fdc4
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 7 deletions.
diff --git a/...ics/pages/analytics_management/components/create_analytics_form/create_analytics_form.tsx b/...ics/pages/analytics_management/components/create_analytics_form/create_analytics_form.tsx
@@ -48,6 +48,8 @@ import {
 } from '../../../../common/analytics';
 import { shouldAddAsDepVarOption, OMIT_FIELDS } from './form_options_validation';
 
+const requiredFieldsErrorText = 'At least one field must be included in the analysis.';
+
 export const CreateAnalyticsForm: FC<CreateAnalyticsFormProps> = ({ actions, state }) => {
   const {
     services: { docLinks },
@@ -96,6 +98,7 @@ export const CreateAnalyticsForm: FC<CreateAnalyticsFormProps> = ({ actions, sta
     numTopFeatureImportanceValuesValid,
     previousJobType,
     previousSourceIndex,
+    requiredFieldsError,
     sourceIndex,
     sourceIndexNameEmpty,
     sourceIndexNameValid,
@@ -158,6 +161,8 @@ export const CreateAnalyticsForm: FC<CreateAnalyticsFormProps> = ({ actions, sta
   };
 
   const debouncedGetExplainData = debounce(async () => {
+    const jobTypeOrIndexChanged =
+      previousSourceIndex !== sourceIndex || previousJobType !== jobType;
     const shouldUpdateModelMemoryLimit = !firstUpdate.current || !modelMemoryLimit;
     const shouldUpdateEstimatedMml =
       !firstUpdate.current || !modelMemoryLimit || estimatedModelMemoryLimit === '';
@@ -167,7 +172,7 @@ export const CreateAnalyticsForm: FC<CreateAnalyticsFormProps> = ({ actions, sta
     }
     // Reset if sourceIndex or jobType changes (jobType requires dependent_variable to be set -
     // which won't be the case if switching from outlier detection)
-    if (previousSourceIndex !== sourceIndex || previousJobType !== jobType) {
+    if (jobTypeOrIndexChanged) {
       setFormState({
         loadingFieldOptions: true,
       });
@@ -186,8 +191,21 @@ export const CreateAnalyticsForm: FC<CreateAnalyticsFormProps> = ({ actions, sta
         setEstimatedModelMemoryLimit(expectedMemoryWithoutDisk);
       }
 
+      const fieldSelection: FieldSelectionItem[] = resp.field_selection;
+
+      let hasRequiredFields = false;
+      if (fieldSelection) {
+        for (let i = 0; i < fieldSelection.length; i++) {
+          const field = fieldSelection[i];
+          if (field.is_included === true && field.is_required === false) {
+            hasRequiredFields = true;
+            break;
+          }
+        }
+      }
+
       // If sourceIndex has changed load analysis field options again
-      if (previousSourceIndex !== sourceIndex || previousJobType !== jobType) {
+      if (jobTypeOrIndexChanged) {
         const analyzedFieldsOptions: EuiComboBoxOptionOption[] = [];
 
         if (resp.field_selection) {
@@ -204,21 +222,24 @@ export const CreateAnalyticsForm: FC<CreateAnalyticsFormProps> = ({ actions, sta
           loadingFieldOptions: false,
           fieldOptionsFetchFail: false,
           maxDistinctValuesError: undefined,
+          requiredFieldsError: !hasRequiredFields ? requiredFieldsErrorText : undefined,
         });
       } else {
         setFormState({
           ...(shouldUpdateModelMemoryLimit ? { modelMemoryLimit: expectedMemoryWithoutDisk } : {}),
+          requiredFieldsError: !hasRequiredFields ? requiredFieldsErrorText : undefined,
         });
       }
     } catch (e) {
       let errorMessage;
       if (
         jobType === ANALYSIS_CONFIG_TYPE.CLASSIFICATION &&
-        e.message !== undefined &&
-        e.message.includes('status_exception') &&
-        e.message.includes('must have at most')
+        e.body &&
+        e.body.message !== undefined &&
+        e.body.message.includes('status_exception') &&
+        e.body.message.includes('must have at most')
       ) {
-        errorMessage = e.message;
+        errorMessage = e.body.message;
       }
       const fallbackModelMemoryLimit =
         jobType !== undefined
@@ -321,6 +342,7 @@ export const CreateAnalyticsForm: FC<CreateAnalyticsFormProps> = ({ actions, sta
       excludesOptions: [],
       previousSourceIndex: sourceIndex,
       sourceIndex: selectedOptions[0].label || '',
+      requiredFieldsError: undefined,
     });
   };
 
@@ -565,7 +587,9 @@ export const CreateAnalyticsForm: FC<CreateAnalyticsFormProps> = ({ actions, sta
             <Fragment>
               <EuiFormRow
                 fullWidth
-                isInvalid={maxDistinctValuesError !== undefined}
+                isInvalid={
+                  maxDistinctValuesError !== undefined || requiredFieldsError !== undefined
+                }
                 error={[
                   ...(fieldOptionsFetchFail === true && maxDistinctValuesError !== undefined
                     ? [
@@ -580,6 +604,14 @@ export const CreateAnalyticsForm: FC<CreateAnalyticsFormProps> = ({ actions, sta
                         </Fragment>,
                       ]
                     : []),
+                  ...(requiredFieldsError !== undefined
+                    ? [
+                        i18n.translate('xpack.ml.dataframe.analytics.create.requiredFieldsError', {
+                          defaultMessage: 'Invalid. {message}',
+                          values: { message: requiredFieldsError },
+                        }),
+                      ]
+                    : []),
                 ]}
               >
                 <Fragment />

diff --git a/..._frame_analytics/pages/analytics_management/components/create_analytics_form/job_type.tsx b/..._frame_analytics/pages/analytics_management/components/create_analytics_form/job_type.tsx
@@ -69,6 +69,7 @@ export const JobType: FC<Props> = ({ type, setFormState }) => {
               previousJobType: type,
               jobType: value,
               excludes: [],
+              requiredFieldsError: undefined,
             });
           }}
           data-test-subj="mlAnalyticsCreateJobFlyoutJobTypeSelect"

diff --git a/...ata_frame_analytics/pages/analytics_management/hooks/use_create_analytics_form/reducer.ts b/...ata_frame_analytics/pages/analytics_management/hooks/use_create_analytics_form/reducer.ts
@@ -124,6 +124,7 @@ export const validateAdvancedEditor = (state: State): State => {
     createIndexPattern,
     excludes,
     maxDistinctValuesError,
+    requiredFieldsError,
   } = state.form;
   const { jobConfig } = state;
 
@@ -330,6 +331,7 @@ export const validateAdvancedEditor = (state: State): State => {
 
   state.isValid =
     maxDistinctValuesError === undefined &&
+    requiredFieldsError === undefined &&
     excludesValid &&
     trainingPercentValid &&
     state.form.modelMemoryLimitUnitValid &&
@@ -397,6 +399,7 @@ const validateForm = (state: State): State => {
     maxDistinctValuesError,
     modelMemoryLimit,
     numTopFeatureImportanceValuesValid,
+    requiredFieldsError,
   } = state.form;
   const { estimatedModelMemoryLimit } = state;
 
@@ -412,6 +415,7 @@ const validateForm = (state: State): State => {
 
   state.isValid =
     maxDistinctValuesError === undefined &&
+    requiredFieldsError === undefined &&
     !jobTypeEmpty &&
     !mmlValidationResult &&
     !jobIdEmpty &&

diff --git a/.../data_frame_analytics/pages/analytics_management/hooks/use_create_analytics_form/state.ts b/.../data_frame_analytics/pages/analytics_management/hooks/use_create_analytics_form/state.ts
@@ -76,6 +76,7 @@ export interface State {
     numTopFeatureImportanceValuesValid: boolean;
     previousJobType: null | AnalyticsJobType;
     previousSourceIndex: EsIndexName | undefined;
+    requiredFieldsError: string | undefined;
     sourceIndex: EsIndexName;
     sourceIndexNameEmpty: boolean;
     sourceIndexNameValid: boolean;
@@ -133,6 +134,7 @@ export const getInitialState = (): State => ({
     numTopFeatureImportanceValuesValid: true,
     previousJobType: null,
     previousSourceIndex: undefined,
+    requiredFieldsError: undefined,
     sourceIndex: '',
     sourceIndexNameEmpty: true,
     sourceIndexNameValid: false,