From ac3b849132dedd21709927c30b2419a7a6f28483 Mon Sep 17 00:00:00 2001 From: Melissa Alvarez Date: Fri, 23 Feb 2024 14:36:09 -0700 Subject: [PATCH] [ML] Data Frame Analytics creation: add messaging when permission requirements are not met (#177720) ## Summary Fixes https://github.com/elastic/kibana/issues/174125 This PR fixes the way the job creation success is checked - previously a non-error was considered a success and any returned errors were swallowed. The job creation request returns an object containing information on whether the job was created and whether there were any errors. This returned object is now checked. Now the job creation error is shown and job start is only attempted if creation is truly successful. Callouts have also been added at the config and details step if there are permission issues with the selected data views. The user can continue to use the wizard and create a usable job config but they are warned that job creation will fail due to the permission issues and are directed to docs. Configuration step when insufficient source index permission: image Details step when insufficient destination index permission: image Creation error now properly shown to user: image ### Checklist Delete any items that are not applicable to this PR. - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [ ] Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US)) - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server)) - [ ] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers) --- packages/kbn-doc-links/src/get_doc_links.ts | 2 + .../configuration_step/configuration_step.tsx | 3 + .../configuration_step_form.tsx | 3 + .../details_step/details_step_form.tsx | 2 + .../components/index_permissions_callout.tsx | 69 +++++++++++++++++++ .../pages/analytics_creation/hooks/index.ts | 1 + .../hooks/use_has_index_permission.ts | 53 ++++++++++++++ .../pages/analytics_creation/page.tsx | 3 +- .../use_create_analytics_form.ts | 36 +++++++--- .../ml_api_service/data_frame_analytics.ts | 3 +- 10 files changed, 163 insertions(+), 12 deletions(-) create mode 100644 x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/components/index_permissions_callout.tsx create mode 100644 x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/hooks/use_has_index_permission.ts diff --git a/packages/kbn-doc-links/src/get_doc_links.ts b/packages/kbn-doc-links/src/get_doc_links.ts index 0561176f3a50c..bfa2953310e0c 100644 --- a/packages/kbn-doc-links/src/get_doc_links.ts +++ b/packages/kbn-doc-links/src/get_doc_links.ts @@ -536,6 +536,8 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D customUrls: `${MACHINE_LEARNING_DOCS}ml-configuring-url.html`, dataFrameAnalytics: `${MACHINE_LEARNING_DOCS}ml-dfanalytics.html`, dFAPrepareData: `${MACHINE_LEARNING_DOCS}ml-dfa-overview.html#prepare-transform-data`, + dFAStartJob: `${ELASTICSEARCH_DOCS}start-dfanalytics.html`, + dFACreateJob: `${ELASTICSEARCH_DOCS}put-dfanalytics.html`, featureImportance: `${MACHINE_LEARNING_DOCS}ml-feature-importance.html`, outlierDetectionRoc: `${MACHINE_LEARNING_DOCS}ml-dfa-finding-outliers.html#ml-dfanalytics-roc`, regressionEvaluation: `${MACHINE_LEARNING_DOCS}ml-dfa-regression.html#ml-dfanalytics-regression-evaluation`, diff --git a/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/components/configuration_step/configuration_step.tsx b/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/components/configuration_step/configuration_step.tsx index 710fd49f72fb6..34490462c2c2d 100644 --- a/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/components/configuration_step/configuration_step.tsx +++ b/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/components/configuration_step/configuration_step.tsx @@ -15,6 +15,7 @@ import { ANALYTICS_STEPS } from '../../page'; export interface ConfigurationStepProps extends CreateAnalyticsStepProps { isClone: boolean; + sourceDataViewTitle: string; } export const ConfigurationStep: FC = ({ @@ -24,6 +25,7 @@ export const ConfigurationStep: FC = ({ step, stepActivated, isClone, + sourceDataViewTitle, }) => { const showForm = step === ANALYTICS_STEPS.CONFIGURATION; const showDetails = step !== ANALYTICS_STEPS.CONFIGURATION && stepActivated === true; @@ -40,6 +42,7 @@ export const ConfigurationStep: FC = ({ isClone={isClone} state={state} setCurrentStep={setCurrentStep} + sourceDataViewTitle={sourceDataViewTitle} /> )} {showDetails && } diff --git a/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/components/configuration_step/configuration_step_form.tsx b/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/components/configuration_step/configuration_step_form.tsx index d065ef84fa970..8ad8994fce64c 100644 --- a/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/components/configuration_step/configuration_step_form.tsx +++ b/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/components/configuration_step/configuration_step_form.tsx @@ -68,6 +68,7 @@ import { ExplorationQueryBarProps } from '../../../analytics_exploration/compone import { ScatterplotMatrix } from '../../../../../components/scatterplot_matrix'; import { RuntimeMappings } from '../runtime_mappings'; import { ConfigurationStepProps } from './configuration_step'; +import { IndexPermissionsCallout } from '../index_permissions_callout'; const runtimeMappingKey = 'runtime_mapping'; const notIncludedReason = 'field not in includes list'; @@ -119,6 +120,7 @@ export const ConfigurationStepForm: FC = ({ isClone, state, setCurrentStep, + sourceDataViewTitle, }) => { const { selectedDataView, selectedSavedSearch } = useDataSource(); const { savedSearchQuery, savedSearchQueryStr } = useSavedSearch(); @@ -583,6 +585,7 @@ export const ConfigurationStepForm: FC = ({ + {savedSearchQuery === null && ( = ({ return ( + = ({ + indexName, + docsType, +}) => { + const { + services: { + docLinks: { + links: { + ml: { dFAStartJob, dFACreateJob }, + }, + }, + }, + } = useMlKibana(); + + const docsLink = docsType === 'start' ? dFAStartJob : dFACreateJob; + const hasRequiredIndicesPermissions = useHasRequiredIndicesPermissions( + indexName, + docsType === 'start' + ); + // If 'hasRequiredIndicesPermissions' is undefined - the index passed to the check is an empty string + if (hasRequiredIndicesPermissions === undefined || hasRequiredIndicesPermissions === true) { + return null; + } + + return ( + <> + +

+ + + + ), + }} + /> +

+ + + + ); +}; diff --git a/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/hooks/index.ts b/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/hooks/index.ts index b156af3dec66a..b7e112a934e1d 100644 --- a/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/hooks/index.ts +++ b/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/hooks/index.ts @@ -6,3 +6,4 @@ */ export { useIndexData } from './use_index_data'; +export { useHasRequiredIndicesPermissions } from './use_has_index_permission'; diff --git a/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/hooks/use_has_index_permission.ts b/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/hooks/use_has_index_permission.ts new file mode 100644 index 0000000000000..2fc8fb6b85f14 --- /dev/null +++ b/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_creation/hooks/use_has_index_permission.ts @@ -0,0 +1,53 @@ +/* + * 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 { useState, useEffect } from 'react'; + +import { useMlKibana } from '../../../../contexts/kibana'; + +export const useHasRequiredIndicesPermissions = ( + indexName: string, + isDestIndex: boolean = false +) => { + const [hasIndexPermissions, setHasIndexPermissions] = useState(true); + const { + services: { + mlServices: { + mlApiServices: { hasPrivileges }, + }, + }, + } = useMlKibana(); + + useEffect( + function checkRequiredIndexPermissions() { + async function checkPrivileges() { + const sourceIndexPriv = ['view_index_metadata']; + const destIndexPriv = ['create_index', 'manage', 'index']; + + const privileges = await hasPrivileges({ + index: [ + { + names: [indexName], + privileges: ['read', ...(isDestIndex ? destIndexPriv : sourceIndexPriv)], + }, + ], + }); + + setHasIndexPermissions(privileges.hasPrivileges?.has_all_requested === true); + } + + checkPrivileges(); + }, + [hasPrivileges, indexName, isDestIndex] + ); + + if (indexName === '') { + return; + } + + return hasIndexPermissions; +}; 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 index b86d819cc7938..cc5543ed6c23a 100644 --- 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 @@ -103,6 +103,7 @@ export const Page: FC = ({ jobId }) => { setCurrentStep={setCurrentStep} step={currentStep} stepActivated={activatedSteps[ANALYTICS_STEPS.CONFIGURATION]} + sourceDataViewTitle={selectedDataView.getIndexPattern()} /> ), status: @@ -188,7 +189,7 @@ export const Page: FC = ({ jobId }) => { diff --git a/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_management/hooks/use_create_analytics_form/use_create_analytics_form.ts b/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_management/hooks/use_create_analytics_form/use_create_analytics_form.ts index c097577bc289a..e8edab907ef9e 100644 --- a/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_management/hooks/use_create_analytics_form/use_create_analytics_form.ts +++ b/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_management/hooks/use_create_analytics_form/use_create_analytics_form.ts @@ -10,6 +10,7 @@ import { useReducer } from 'react'; import { i18n } from '@kbn/i18n'; import { extractErrorMessage } from '@kbn/ml-error-utils'; +import { extractErrorProperties } from '@kbn/ml-error-utils'; import type { DataFrameAnalyticsConfig } from '@kbn/ml-data-frame-analytics-utils'; import { useMlKibana } from '../../../../../contexts/kibana'; @@ -91,14 +92,21 @@ export const useCreateAnalyticsForm = (): CreateAnalyticsFormProps => { const analyticsJobConfig = ( isAdvancedEditorEnabled ? jobConfig : getJobConfigFromFormState(form) ) as DataFrameAnalyticsConfig; + const errorMessage = i18n.translate( + 'xpack.ml.dataframe.analytics.create.errorCreatingDataFrameAnalyticsJob', + { + defaultMessage: 'An error occurred creating the data frame analytics job:', + } + ); try { - await ml.dataFrameAnalytics.createDataFrameAnalytics( + const creationResp = await ml.dataFrameAnalytics.createDataFrameAnalytics( jobId, analyticsJobConfig, createDataView, form.timeFieldName ); + addRequestMessage({ message: i18n.translate( 'xpack.ml.dataframe.stepCreateForm.createDataFrameAnalyticsSuccessMessage', @@ -108,21 +116,29 @@ export const useCreateAnalyticsForm = (): CreateAnalyticsFormProps => { } ), }); - setIsJobCreated(true); - refresh(); - return true; + + if ( + creationResp.dataFrameAnalyticsJobsCreated.length && + creationResp.dataFrameAnalyticsJobsErrors.length === 0 + ) { + setIsJobCreated(true); + refresh(); + return true; + } else if (creationResp.dataFrameAnalyticsJobsErrors.length) { + addRequestMessage({ + error: extractErrorProperties(creationResp.dataFrameAnalyticsJobsErrors[0].error).message, + message: errorMessage, + }); + return false; + } } catch (e) { addRequestMessage({ error: extractErrorMessage(e), - message: i18n.translate( - 'xpack.ml.dataframe.analytics.create.errorCreatingDataFrameAnalyticsJob', - { - defaultMessage: 'An error occurred creating the data frame analytics job:', - } - ), + message: errorMessage, }); return false; } + return false; }; const prepareFormValidation = async () => { diff --git a/x-pack/plugins/ml/public/application/services/ml_api_service/data_frame_analytics.ts b/x-pack/plugins/ml/public/application/services/ml_api_service/data_frame_analytics.ts index 8b2c7bd294744..b0729db61c5ff 100644 --- a/x-pack/plugins/ml/public/application/services/ml_api_service/data_frame_analytics.ts +++ b/x-pack/plugins/ml/public/application/services/ml_api_service/data_frame_analytics.ts @@ -23,6 +23,7 @@ import { useMlKibana } from '../../contexts/kibana'; import type { ValidateAnalyticsJobResponse } from '../../../../common/constants/validation'; import type { DeepPartial } from '../../../../common/types/common'; import type { JobMessage } from '../../../../common/types/audit_message'; +import type { PutDataFrameAnalyticsResponseSchema } from '../../../../server/routes/schemas/data_frame_analytics_schema'; export interface GetDataFrameAnalyticsStatsResponseOk { node_failures?: object; @@ -88,7 +89,7 @@ export const dataFrameAnalyticsApiProvider = (httpService: HttpService) => ({ timeFieldName?: string ) { const body = JSON.stringify(analyticsConfig); - return httpService.http({ + return httpService.http({ path: `${ML_INTERNAL_BASE_PATH}/data_frame/analytics/${analyticsId}`, method: 'PUT', query: { createDataView, timeFieldName },