[ML] Data Frame Analytics creation: ensure included fields selection …

…table is shown when no docs contain all mapped fields (#104191) * use indexPatternFields if explain error due to missing values in docs * fix types
elastic · Jul 6, 2021 · ebc103f · ebc103f
1 parent d5ca242
commit ebc103f
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 6 deletions.
diff --git a/x-pack/plugins/ml/public/application/components/data_grid/types.ts b/x-pack/plugins/ml/public/application/components/data_grid/types.ts
@@ -82,6 +82,7 @@ export interface UseIndexDataReturnType
     | 'resultsField'
   > {
   renderCellValue: RenderCellValue;
+  indexPatternFields?: string[];
 }
 
 export interface UseDataGridReturnType {

diff --git a/x-pack/plugins/ml/public/application/data_frame_analytics/common/analytics.ts b/x-pack/plugins/ml/public/application/data_frame_analytics/common/analytics.ts
@@ -102,7 +102,7 @@ export enum INDEX_STATUS {
 
 export interface FieldSelectionItem {
   name: string;
-  mappings_types: string[];
+  mappings_types?: string[];
   is_included: boolean;
   is_required: boolean;
   feature_type?: string;

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
@@ -115,6 +115,7 @@ export const ConfigurationStepForm: FC<ConfigurationStepProps> = ({
   const [fetchingExplainData, setFetchingExplainData] = useState<boolean>(false);
   const [maxDistinctValuesError, setMaxDistinctValuesError] = useState<string | undefined>();
   const [unsupportedFieldsError, setUnsupportedFieldsError] = useState<string | undefined>();
+  const [noDocsContainMappedFields, setNoDocsContainMappedFields] = useState<boolean>(false);
   const [minimumFieldsRequiredMessage, setMinimumFieldsRequiredMessage] = useState<
     undefined | string
   >();
@@ -261,9 +262,13 @@ export const ConfigurationStepForm: FC<ConfigurationStepProps> = ({
       formToUse.includes = [...includes, dependentVariable];
     }
 
-    const { success, expectedMemory, fieldSelection, errorMessage } = await fetchExplainData(
-      formToUse
-    );
+    const {
+      success,
+      expectedMemory,
+      fieldSelection,
+      errorMessage,
+      noDocsContainMappedFields: noDocsWithFields,
+    } = await fetchExplainData(formToUse);
 
     if (success) {
       if (shouldUpdateEstimatedMml) {
@@ -286,6 +291,7 @@ export const ConfigurationStepForm: FC<ConfigurationStepProps> = ({
         setFieldOptionsFetchFail(false);
         setMaxDistinctValuesError(undefined);
         setUnsupportedFieldsError(undefined);
+        setNoDocsContainMappedFields(false);
         setIncludesTableItems(fieldSelection ? fieldSelection : []);
       }
 
@@ -315,6 +321,7 @@ export const ConfigurationStepForm: FC<ConfigurationStepProps> = ({
       setFieldOptionsFetchFail(true);
       setMaxDistinctValuesError(maxDistinctValuesErrorMessage);
       setUnsupportedFieldsError(unsupportedFieldsErrorMessage);
+      setNoDocsContainMappedFields(noDocsWithFields);
       setFetchingExplainData(false);
       setFormState({
         ...(shouldUpdateModelMemoryLimit ? { modelMemoryLimit: fallbackModelMemoryLimit } : {}),
@@ -326,6 +333,17 @@ export const ConfigurationStepForm: FC<ConfigurationStepProps> = ({
     setFormState({ sourceIndex: currentIndexPattern.title });
   }, []);
 
+  const indexPatternFieldsTableItems = useMemo(() => {
+    if (indexData?.indexPatternFields !== undefined) {
+      return indexData.indexPatternFields.map((field) => ({
+        name: field,
+        is_included: false,
+        is_required: false,
+      }));
+    }
+    return [];
+  }, [`${indexData?.indexPatternFields}`]);
+
   useEffect(() => {
     if (typeof savedSearchQueryStr === 'string') {
       setFormState({ jobConfigQuery: savedSearchQuery, jobConfigQueryString: savedSearchQueryStr });
@@ -399,7 +417,12 @@ export const ConfigurationStepForm: FC<ConfigurationStepProps> = ({
           ? [...updatedIncludes, dependentVariable]
           : updatedIncludes;
 
-        const { success, fieldSelection, errorMessage } = await fetchExplainData(formCopy);
+        const {
+          success,
+          fieldSelection,
+          errorMessage,
+          noDocsContainMappedFields: noDocsWithFields,
+        } = await fetchExplainData(formCopy);
         if (success) {
           // update the field selection table
           const hasRequiredFields = fieldSelection.some(
@@ -423,6 +446,7 @@ export const ConfigurationStepForm: FC<ConfigurationStepProps> = ({
           setIncludesTableItems(updatedFieldSelection ? updatedFieldSelection : fieldSelection);
           setMaxDistinctValuesError(undefined);
           setUnsupportedFieldsError(undefined);
+          setNoDocsContainMappedFields(noDocsWithFields);
           setFormState({
             includes: updatedIncludes,
             requiredFieldsError: !hasRequiredFields ? requiredFieldsErrorText : undefined,
@@ -444,6 +468,7 @@ export const ConfigurationStepForm: FC<ConfigurationStepProps> = ({
 
           setMaxDistinctValuesError(maxDistinctValuesErrorMessage);
           setUnsupportedFieldsError(unsupportedFieldsErrorMessage);
+          setNoDocsContainMappedFields(noDocsWithFields);
         }
       }
     }
@@ -501,6 +526,11 @@ export const ConfigurationStepForm: FC<ConfigurationStepProps> = ({
   // `undefined` means uninitialized, `null` means initialized but not used.
   if (savedSearchQuery === undefined) return null;
 
+  const tableItems =
+    includesTableItems.length > 0 && !noDocsContainMappedFields
+      ? includesTableItems
+      : indexPatternFieldsTableItems;
+
   return (
     <Fragment>
       <Messages messages={requestMessages} />
@@ -649,7 +679,7 @@ export const ConfigurationStepForm: FC<ConfigurationStepProps> = ({
         includes={includes}
         minimumFieldsRequiredMessage={minimumFieldsRequiredMessage}
         setMinimumFieldsRequiredMessage={setMinimumFieldsRequiredMessage}
-        tableItems={includesTableItems}
+        tableItems={firstUpdate.current ? includesTableItems : tableItems}
         unsupportedFieldsError={unsupportedFieldsError}
         setUnsupportedFieldsError={setUnsupportedFieldsError}
         setFormState={setFormState}

diff --git a/...ion/data_frame_analytics/pages/analytics_creation/components/shared/fetch_explain_data.ts b/...ion/data_frame_analytics/pages/analytics_creation/components/shared/fetch_explain_data.ts
@@ -27,6 +27,7 @@ export const fetchExplainData = async (formState: State['form']) => {
   let success = true;
   let expectedMemory = '';
   let fieldSelection: FieldSelectionItem[] = [];
+  let noDocsContainMappedFields = false;
 
   try {
     delete jobConfig.dest;
@@ -45,11 +46,19 @@ export const fetchExplainData = async (formState: State['form']) => {
     }
   }
 
+  if (
+    errorMessage.includes('status_exception') &&
+    errorMessage.includes('Unable to estimate memory usage as no documents')
+  ) {
+    noDocsContainMappedFields = true;
+  }
+
   return {
     success,
     expectedMemory,
     fieldSelection,
     errorMessage,
     errorReason,
+    noDocsContainMappedFields,
   };
 };
diff --git a/.../public/application/data_frame_analytics/pages/analytics_creation/hooks/use_index_data.ts b/.../public/application/data_frame_analytics/pages/analytics_creation/hooks/use_index_data.ts
@@ -255,6 +255,7 @@ export const useIndexData = (
 
   return {
     ...dataGrid,
+    indexPatternFields,
     renderCellValue,
   };
 };