[ML] Enhance job id error message (elastic#45349)

[ML] Enhance job id error message

x-pack/legacy/plugins/ml/common/constants/validation.ts

@@ -14,3 +14,5 @@ export enum VALIDATION_STATUS {
 export const SKIP_BUCKET_SPAN_ESTIMATION = true;
 
 export const ALLOWED_DATA_UNITS = ['B', 'KB', 'MB', 'GB', 'TB', 'PB'];
+
+export const JOB_ID_MAX_LENGTH = 64;

x-pack/legacy/plugins/ml/common/util/job_utils.d.ts

@@ -27,3 +27,5 @@ export function basicJobValidation(
 export const ML_MEDIAN_PERCENTS: number;
 
 export const ML_DATA_PREVIEW_COUNT: number;
+
+export function isJobIdValid(jobId: string): boolean;

x-pack/legacy/plugins/ml/common/util/job_utils.js

@@ -10,8 +10,9 @@ import _ from 'lodash';
 import semver from 'semver';
 import numeral from '@elastic/numeral';
 
-import { ALLOWED_DATA_UNITS } from '../constants/validation';
+import { ALLOWED_DATA_UNITS, JOB_ID_MAX_LENGTH } from '../constants/validation';
 import { parseInterval } from './parse_interval';
+import { maxLengthValidator } from './validators';
 
 // work out the default frequency based on the bucket_span in seconds
 export function calculateDatafeedFrequencyDefaultSeconds(bucketSpanSeconds) {
@@ -223,7 +224,7 @@ export function mlFunctionToESAggregation(functionName) {
 // Job name must contain lowercase alphanumeric (a-z and 0-9), hyphens or underscores;
 // it must also start and end with an alphanumeric character'
 export function isJobIdValid(jobId) {
-  return (jobId.match(/^[a-z0-9\-\_]{1,64}$/g) && !jobId.match(/^([_-].*)?(.*[_-])?$/g)) ? true : false;
+  return (jobId.match(/^[a-z0-9\-\_]+$/g) && !jobId.match(/^([_-].*)?(.*[_-])?$/g)) ? true : false;
 }
 
 // To get median data for jobs and charts we need to use Elasticsearch's
@@ -278,6 +279,9 @@ export function basicJobValidation(job, fields, limits, skipMmlChecks = false) {
     } else if (isJobIdValid(job.job_id) === false) {
       messages.push({ id: 'job_id_invalid' });
       valid = false;
+    } else if (maxLengthValidator(JOB_ID_MAX_LENGTH)(job.job_id)) {
+      messages.push({ id: 'job_id_invalid_max_length', maxLength: JOB_ID_MAX_LENGTH });
+      valid = false;
     } else {
       messages.push({ id: 'job_id_valid' });
     }
@@ -487,22 +491,14 @@ export function validateModelMemoryLimitUnits(job) {
 }
 
 export function validateGroupNames(job) {
-  const messages = [];
-  let valid = true;
-  if (job.groups !== undefined) {
-    let groupIdValid = true;
-    job.groups.forEach(group => {
-      if (isJobIdValid(group) === false) {
-        groupIdValid = false;
-        valid = false;
-      }
-    });
-    if (job.groups.length > 0 && groupIdValid) {
-      messages.push({ id: 'job_group_id_valid' });
-    } else if (job.groups.length > 0 && !groupIdValid) {
-      messages.push({ id: 'job_group_id_invalid' });
-    }
-  }
+  const { groups = [] } = job;
+  const errorMessages = [
+    ...groups.some(group => !isJobIdValid(group)) ? [{ id: 'job_group_id_invalid' }] : [],
+    ...groups.some(group => maxLengthValidator(JOB_ID_MAX_LENGTH)(group)) ? [{ id: 'job_group_id_invalid_max_length' }] : [],
+  ];
+  const valid = errorMessages.length === 0;
+  const messages = (valid && groups.length) ? [{ id: 'job_group_id_valid' }] : errorMessages;
+
   return {
     valid,
     messages,

x-pack/legacy/plugins/ml/common/util/validators.test.ts

@@ -0,0 +1,22 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import { maxLengthValidator } from './validators';
+
+describe('maxLengthValidator', () => {
+  test('should allow a valid input', () => {
+    expect(maxLengthValidator(2)('xx')).toBe(null);
+  });
+
+  test('should describe an invalid input', () => {
+    expect(maxLengthValidator(3)('example')).toEqual({
+      maxLength: {
+        requiredLength: 3,
+        actualLength: 7,
+      },
+    });
+  });
+});

x-pack/legacy/plugins/ml/common/util/validators.ts

@@ -0,0 +1,23 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+/**
+ * Provides a validator function for maximum allowed input length.
+ * @param maxLength Maximum length allowed.
+ */
+export function maxLengthValidator(
+  maxLength: number
+): (value: string) => { maxLength: { requiredLength: number; actualLength: number } } | null {
+  return value =>
+    value && value.length > maxLength
+      ? {
+          maxLength: {
+            requiredLength: maxLength,
+            actualLength: value.length,
+          },
+        }
+      : null;
+}

x-pack/legacy/plugins/ml/public/data_frame_analytics/common/analytics.ts

@@ -9,11 +9,6 @@ import { BehaviorSubject } from 'rxjs';
 import { filter, distinctUntilChanged } from 'rxjs/operators';
 import { Subscription } from 'rxjs';
 
-// @ts-ignore
-import { isJobIdValid } from '../../../common/util/job_utils';
-
-export const isAnalyticsIdValid = isJobIdValid;
-
 export type IndexName = string;
 export type IndexPattern = string;
 export type DataFrameAnalyticsId = string;

x-pack/legacy/plugins/ml/public/data_frame_analytics/common/index.ts

@@ -6,7 +6,6 @@
 
 export {
   getAnalysisType,
-  isAnalyticsIdValid,
   isOutlierAnalysis,
   refreshAnalyticsList$,
   useRefreshAnalyticsList,

x-pack/legacy/plugins/ml/public/data_frame_analytics/pages/analytics_management/components/create_analytics_form/create_analytics_form.tsx

@@ -25,6 +25,7 @@ import { metadata } from 'ui/metadata';
 import { INDEX_PATTERN_ILLEGAL_CHARACTERS } from 'ui/index_patterns';
 
 import { CreateAnalyticsFormProps } from '../../hooks/use_create_analytics_form';
+import { JOB_ID_MAX_LENGTH } from '../../../../../../common/constants/validation';
 
 // based on code used by `ui/index_patterns` internally
 // remove the space character from the list of illegal characters
@@ -53,6 +54,7 @@ export const CreateAnalyticsForm: FC<CreateAnalyticsFormProps> = ({ actions, sta
     jobIdEmpty,
     jobIdExists,
     jobIdValid,
+    jobIdInvalidMaxLength,
     sourceIndex,
     sourceIndexNameEmpty,
     sourceIndexNameValid,
@@ -106,7 +108,7 @@ export const CreateAnalyticsForm: FC<CreateAnalyticsFormProps> = ({ actions, sta
             label={i18n.translate('xpack.ml.dataframe.analytics.create.jobIdLabel', {
               defaultMessage: 'Job ID',
             })}
-            isInvalid={(!jobIdEmpty && !jobIdValid) || jobIdExists}
+            isInvalid={(!jobIdEmpty && !jobIdValid) || jobIdExists || jobIdInvalidMaxLength}
             error={[
               ...(!jobIdEmpty && !jobIdValid
                 ? [
@@ -123,6 +125,20 @@ export const CreateAnalyticsForm: FC<CreateAnalyticsFormProps> = ({ actions, sta
                     }),
                   ]
                 : []),
+              ...(jobIdInvalidMaxLength
+                ? [
+                    i18n.translate(
+                      'xpack.ml.dataframe.analytics.create.jobIdInvalidMaxLengthErrorMessage',
+                      {
+                        defaultMessage:
+                          'Job ID must be no more than {maxLength, plural, one {# character} other {# characters}} long.',
+                        values: {
+                          maxLength: JOB_ID_MAX_LENGTH,
+                        },
+                      }
+                    ),
+                  ]
+                : []),
             ]}
           >
             <EuiFieldText

x-pack/legacy/plugins/ml/public/data_frame_analytics/pages/analytics_management/hooks/use_create_analytics_form/reducer.ts

@@ -11,10 +11,11 @@ import { validateIndexPattern } from 'ui/index_patterns';
 
 import { isValidIndexName } from '../../../../../../common/util/es_utils';
 
-import { isAnalyticsIdValid } from '../../../../common';
-
 import { Action, ACTION } from './actions';
 import { getInitialState, getJobConfigFromFormState, State } from './state';
+import { isJobIdValid } from '../../../../../../common/util/job_utils';
+import { maxLengthValidator } from '../../../../../../common/util/validators';
+import { JOB_ID_MAX_LENGTH } from '../../../../../../common/constants/validation';
 
 const getSourceIndexString = (state: State) => {
   const { jobConfig } = state;
@@ -189,7 +190,10 @@ export function reducer(state: State, action: Action): State {
       if (action.payload.jobId !== undefined) {
         newFormState.jobIdExists = state.jobIds.some(id => newFormState.jobId === id);
         newFormState.jobIdEmpty = newFormState.jobId === '';
-        newFormState.jobIdValid = isAnalyticsIdValid(newFormState.jobId);
+        newFormState.jobIdValid = isJobIdValid(newFormState.jobId);
+        newFormState.jobIdInvalidMaxLength = !!maxLengthValidator(JOB_ID_MAX_LENGTH)(
+          newFormState.jobId
+        );
       }
 
       if (action.payload.sourceIndex !== undefined) {

x-pack/legacy/plugins/ml/public/data_frame_analytics/pages/analytics_management/hooks/use_create_analytics_form/state.ts

@@ -32,6 +32,7 @@ export interface State {
     jobId: DataFrameAnalyticsId;
     jobIdExists: boolean;
     jobIdEmpty: boolean;
+    jobIdInvalidMaxLength?: boolean;
     jobIdValid: boolean;
     sourceIndex: EsIndexName;
     sourceIndexNameEmpty: boolean;

x-pack/legacy/plugins/ml/public/jobs/new_job_new/common/job_validator/util.ts

@@ -7,7 +7,7 @@
 import { i18n } from '@kbn/i18n';
 import { BasicValidations } from './job_validator';
 import { Job } from '../job_creator/configs';
-import { ALLOWED_DATA_UNITS } from '../../../../../common/constants/validation';
+import { ALLOWED_DATA_UNITS, JOB_ID_MAX_LENGTH } from '../../../../../common/constants/validation';
 import { newJobLimits } from '../../../new_job/utils/new_job_defaults';
 import { ValidationResults, ValidationMessage } from '../../../../../common/util/job_utils';
 import { ExistingJobsAndGroups } from '../../../../services/job_service';
@@ -27,11 +27,23 @@ export function populateValidationMessages(
       'xpack.ml.newJob.wizard.validateJob.jobNameAllowedCharactersDescription',
       {
         defaultMessage:
-          'Job name can contain lowercase alphanumeric (a-z and 0-9), hyphens or underscores; ' +
+          'Job ID can contain lowercase alphanumeric (a-z and 0-9), hyphens or underscores; ' +
           'must start and end with an alphanumeric character',
       }
     );
     basicValidations.jobId.message = msg;
+  } else if (validationResults.contains('job_id_invalid_max_length')) {
+    basicValidations.jobId.valid = false;
+    basicValidations.jobId.message = i18n.translate(
+      'xpack.ml.newJob.wizard.validateJob.jobIdInvalidMaxLengthErrorMessage',
+      {
+        defaultMessage:
+          'Job ID must be no more than {maxLength, plural, one {# character} other {# characters}} long.',
+        values: {
+          maxLength: JOB_ID_MAX_LENGTH,
+        },
+      }
+    );
   } else if (validationResults.contains('job_id_already_exists')) {
     basicValidations.jobId.valid = false;
     const msg = i18n.translate('xpack.ml.newJob.wizard.validateJob.jobNameAlreadyExists', {
@@ -52,6 +64,18 @@ export function populateValidationMessages(
       }
     );
     basicValidations.groupIds.message = msg;
+  } else if (validationResults.contains('job_group_id_invalid_max_length')) {
+    basicValidations.groupIds.valid = false;
+    basicValidations.groupIds.message = i18n.translate(
+      'xpack.ml.newJob.wizard.validateJob.jobGroupMaxLengthDescription',
+      {
+        defaultMessage:
+          'Job group name must be no more than {maxLength, plural, one {# character} other {# characters}} long.',
+        values: {
+          maxLength: JOB_ID_MAX_LENGTH,
+        },
+      }
+    );
   } else if (validationResults.contains('job_group_id_already_exists')) {
     basicValidations.groupIds.valid = false;
     const msg = i18n.translate('xpack.ml.newJob.wizard.validateJob.groupNameAlreadyExists', {

x-pack/legacy/plugins/ml/server/models/job_validation/messages.js

@@ -6,6 +6,7 @@
 
 
 import { i18n } from '@kbn/i18n';
+import { JOB_ID_MAX_LENGTH } from '../../../common/constants/validation';
 
 let messages;
 
@@ -240,26 +241,40 @@ export const getMessages = () => {
     job_id_empty: {
       status: 'ERROR',
       text: i18n.translate('xpack.ml.models.jobValidation.messages.jobIdEmptyMessage', {
-        defaultMessage: 'The job name field must not be empty.',
+        defaultMessage: 'Job ID field must not be empty.',
       }),
       url: 'https://www.elastic.co/guide/en/elasticsearch/reference/{{version}}/ml-job-resource.html#ml-job-resource'
     },
     job_id_invalid: {
       status: 'ERROR',
       text: i18n.translate('xpack.ml.models.jobValidation.messages.jobIdInvalidMessage', {
-        defaultMessage: 'The job name is invalid. It can contain lowercase alphanumeric (a-z and 0-9) characters, ' +
+        defaultMessage: 'Job ID is invalid. It can contain lowercase alphanumeric (a-z and 0-9) characters, ' +
           'hyphens or underscores and must start and end with an alphanumeric character.',
       }),
       url: 'https://www.elastic.co/guide/en/elasticsearch/reference/{{version}}/ml-job-resource.html#ml-job-resource'
     },
+    job_id_invalid_max_length: {
+      status: 'ERROR',
+      text: i18n.translate('xpack.ml.models.jobValidation.messages.jobIdInvalidMaxLengthErrorMessage', {
+        defaultMessage: 'Job ID must be no more than {maxLength, plural, one {# character} other {# characters}} long.',
+        values: {
+          maxLength: JOB_ID_MAX_LENGTH,
+        },
+      }),
+      url: 'https://www.elastic.co/guide/en/elasticsearch/reference/{{version}}/ml-job-resource.html#ml-job-resource'
+    },
     job_id_valid: {
       status: 'SUCCESS',
       heading: i18n.translate('xpack.ml.models.jobValidation.messages.jobIdValidHeading', {
-        defaultMessage: 'Job id format is valid',
+        defaultMessage: 'Job ID format is valid',
       }),
       text: i18n.translate('xpack.ml.models.jobValidation.messages.jobIdValidMessage', {
         defaultMessage: 'Lowercase alphanumeric (a-z and 0-9) characters, hyphens or underscores, ' +
-          'starts and ends with an alphanumeric character.',
+          'starts and ends with an alphanumeric character, and is no more than ' +
+          '{maxLength, plural, one {# character} other {# characters}} long.',
+        values: {
+          maxLength: JOB_ID_MAX_LENGTH,
+        },
       }),
       url: 'https://www.elastic.co/guide/en/elasticsearch/reference/{{version}}/ml-job-resource.html#ml-job-resource'
     },
@@ -271,14 +286,28 @@ export const getMessages = () => {
       }),
       url: 'https://www.elastic.co/guide/en/elasticsearch/reference/{{version}}/ml-job-resource.html#ml-job-resource'
     },
+    job_group_id_invalid_max_length: {
+      status: 'ERROR',
+      text: i18n.translate('xpack.ml.models.jobValidation.messages.jobGroupIdInvalidMaxLengthErrorMessage', {
+        defaultMessage: 'Job group name must be no more than {maxLength, plural, one {# character} other {# characters}} long.',
+        values: {
+          maxLength: JOB_ID_MAX_LENGTH,
+        },
+      }),
+      url: 'https://www.elastic.co/guide/en/elasticsearch/reference/{{version}}/ml-job-resource.html#ml-job-resource'
+    },
     job_group_id_valid: {
       status: 'SUCCESS',
       heading: i18n.translate('xpack.ml.models.jobValidation.messages.jobGroupIdValidHeading', {
         defaultMessage: 'Job group id formats are valid',
       }),
       text: i18n.translate('xpack.ml.models.jobValidation.messages.jobGroupIdValidMessage', {
         defaultMessage: 'Lowercase alphanumeric (a-z and 0-9) characters, hyphens or underscores, ' +
-          'starts and ends with an alphanumeric character.',
+          'starts and ends with an alphanumeric character, and is no more than ' +
+          '{maxLength, plural, one {# character} other {# characters}} long.',
+        values: {
+          maxLength: JOB_ID_MAX_LENGTH,
+        },
       }),
       url: 'https://www.elastic.co/guide/en/elasticsearch/reference/{{version}}/ml-job-resource.html#ml-job-resource'
     },