[ML] Transforms: Adds `_schedule_now` action to transform list. #153545

walterra · 2023-03-23T13:25:53Z

Summary

Fixes #150350.
Fixes #153314.

Adds _schedule_now action to transform list.

Fixes bulk actions to be correctly disabled when not available.

Checklist

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Unit or functional tests were updated or added to match the most common scenarios
This was checked for breaking API changes and was labeled appropriately

elasticmachine · 2023-03-23T14:46:35Z

Pinging @elastic/ml-ui (:ml)

...app/sections/transform_management/components/action_schedule_now/use_schedule_now_action.tsx

x-pack/plugins/translations/translations/fr-FR.json

x-pack/plugins/transform/public/app/hooks/use_schedule_now_transform.tsx

walterra · 2023-03-23T16:54:58Z

I copied the pattern with the confirmation modal from the start transform action, but I wonder if it's necessary here since the transform is running anyway so a warning about cluster load seems unnecessary and the _schedule_now action also doesn't have additional options like the delete model to toggle whether to delete destination indices. Let me know what you think, I tend to remove the modal.

qn895 · 2023-03-23T18:17:12Z

Tested latest changes with different Kibana users with and without transform_admin privilege and the actions are disabled/enabled as expected 👍 For wording, I agree that it will be good to discuss whether we should use Schedule now or a more user-friendly term.

On minor suggestion is to change how we are currently handling error message toasts. The toast content can be minimized/simplified, and the full error can be more explanatory. For example (and I know this permission issue has already been fixed), clicking See the full error will yield this modal, which is not meaningful for the general user. In addition, having a shorter timeout might be good as well.

walterra · 2023-03-24T07:34:58Z

I agree the error handling and toasts would be good to be improved. However, since this affects all actions on the page and not just _schedule_now, I created a new issue for that to be picked up in a follow up: #153620

peteharverson · 2023-03-24T11:29:15Z

x-pack/plugins/transform/server/routes/api/transforms.ts

+  /**
+   * @apiGroup Transforms
+   *
+   * @api {post} /api/transform/schedule_now_transforms Schedules transforms now


Please can you add an API integration test for this new route.

Added API integration tests in 3563f14.

peteharverson

Tested and overall looks good. Just think that some of the text needs tweaking.

@szabosteve any thoughts on the text here?

peteharverson · 2023-03-24T11:50:08Z

...nsform/public/app/sections/transform_management/components/transform_list/transform_list.tsx

@@ -286,6 +326,9 @@ export const TransformList: FC<TransformListProps> = ({
      {bulkDeleteAction.isModalVisible && <DeleteActionModal {...bulkDeleteAction} />}
      {bulkResetAction.isModalVisible && <ResetActionModal {...bulkResetAction} />}
      {bulkStopAction.isModalVisible && <StopActionModal {...bulkStopAction} />}
+      {bulkScheduleNowAction.isModalVisible && (
+        <ScheduleNowActionModal {...bulkScheduleNowAction} />


I agree with you that this confirm modal isn't necessary here. It makes sense to show the warning when starting a transform, but since it is already started for this action, it seems unnecessary.

Removed the modal in f4898da.

peteharverson · 2023-03-24T12:01:57Z

x-pack/plugins/transform/public/app/hooks/use_schedule_now_transform.tsx

+        if (result.success === true) {
+          toastNotifications.addSuccess(
+            i18n.translate('xpack.transform.transformList.scheduleNowTransformSuccessMessage', {
+              defaultMessage: 'Request to schedule transform {transformId} now acknowledged.',


I don't think the word now is needed here. Request to schedule transform access_data_by_client acknowledged.

peteharverson · 2023-03-24T12:02:53Z

x-pack/plugins/transform/public/app/hooks/use_schedule_now_transform.tsx

+            title: i18n.translate(
+              'xpack.transform.transformList.scheduleNowTransformErrorMessage',
+              {
+                defaultMessage: 'An error occurred scheduling the transform {transformId} now.',


Likewise, I don't think you need the word now in here. It's ambiguous as it is anyway - did the error occur 'now' or did an error occur calling schedule_now?

peteharverson · 2023-03-24T12:09:13Z

x-pack/plugins/transform/public/app/lib/authorization/components/common.ts

+      message = i18n.translate(
+        'xpack.transform.capability.noPermission.scheduleNowTransformTooltip',
+        {
+          defaultMessage: 'You do not have permission to schedule transforms now.',


I don't think you need the word now here. You do not have permission to schedule transforms.

peteharverson · 2023-03-24T12:10:04Z

x-pack/plugins/transform/public/app/hooks/use_schedule_now_transform.tsx

+        title: i18n.translate(
+          'xpack.transform.stepCreateForm.scheduleNowTransformResponseSchemaErrorMessage',
+          {
+            defaultMessage: 'An error occurred calling the schedule now transforms request.',


Maybe An error occurred calling the request to schedule the transform. ?

peteharverson · 2023-03-24T12:12:22Z

...pp/sections/transform_management/components/action_schedule_now/schedule_now_action_name.tsx

+      'xpack.transform.transformList.cannotScheduleNowCompleteBatchTransformBulkActionToolTip',
+      {
+        defaultMessage:
+          'One or more transforms are completed batch transforms and cannot be scheduled now.',


One or more transforms are completed batch transforms which cannot be scheduled. perhaps?

peteharverson · 2023-03-24T12:12:46Z

...pp/sections/transform_management/components/action_schedule_now/schedule_now_action_name.tsx

+    completedBatchTransformMessage = i18n.translate(
+      'xpack.transform.transformList.cannotScheduleNowCompleteBatchTransformToolTip',
+      {
+        defaultMessage: '{transformId} is a completed batch transform and cannot be scheduled now.',


{transformId} is a completed batch transform and cannot be scheduled. ?

peteharverson · 2023-03-24T12:16:43Z

...pp/sections/transform_management/components/action_schedule_now/schedule_now_action_name.tsx

+} from '../../../../lib/authorization';
+import { TransformListRow, isCompletedBatchTransform } from '../../../../common';
+
+export const scheduleNowActionNameText = i18n.translate(


Can you add a tooltip to this button to provide clarification as to what this action does as @qn895 suggested?

Something like Instantly run the transform to process data without waiting for the configured interval between checks for changes in the source indices. ?

Added a tooltip in a92b1ae.

szabosteve

I would lean to explain what happens here instead of using the endpoint name. It's very hard to use the endpoint name unambiguously in the UI text (in fact, any text). It's a bit unwieldy. I left some suggestions. Please let me know what you think.

EDIT: After a discussion with Walter, I updated the suggestions to avoid using the verb run because of the ambiguity with start.

szabosteve · 2023-03-24T12:39:04Z

x-pack/plugins/transform/public/app/hooks/use_schedule_now_transform.tsx

+        if (result.success === true) {
+          toastNotifications.addSuccess(
+            i18n.translate('xpack.transform.transformList.scheduleNowTransformSuccessMessage', {
+              defaultMessage: 'Request to schedule transform {transformId} now acknowledged.',


Suggested change

defaultMessage: 'Request to schedule transform {transformId} now acknowledged.',

defaultMessage: 'Request to schedule transform {transformId} to process data instantly acknowledged.',

szabosteve · 2023-03-24T12:40:05Z

x-pack/plugins/transform/public/app/hooks/use_schedule_now_transform.tsx

+            title: i18n.translate(
+              'xpack.transform.transformList.scheduleNowTransformErrorMessage',
+              {
+                defaultMessage: 'An error occurred scheduling the transform {transformId} now.',


Suggested change

defaultMessage: 'An error occurred scheduling the transform {transformId} now.',

defaultMessage: 'An error occurred scheduling transform {transformId} to process data instantly.',

szabosteve · 2023-03-24T12:41:23Z

x-pack/plugins/transform/public/app/hooks/use_schedule_now_transform.tsx

+        title: i18n.translate(
+          'xpack.transform.stepCreateForm.scheduleNowTransformResponseSchemaErrorMessage',
+          {
+            defaultMessage: 'An error occurred calling the schedule now transforms request.',


Suggested change

defaultMessage: 'An error occurred calling the schedule now transforms request.',

defaultMessage: 'An error occurred calling the request to schedule the transform to process data instantly.',

szabosteve · 2023-03-24T12:44:27Z

x-pack/plugins/transform/public/app/lib/authorization/components/common.ts

+      message = i18n.translate(
+        'xpack.transform.capability.noPermission.scheduleNowTransformTooltip',
+        {
+          defaultMessage: 'You do not have permission to schedule transforms now.',


Suggested change

defaultMessage: 'You do not have permission to schedule transforms now.',

defaultMessage: 'You do not have permission to schedule transforms to process data instantly.',

szabosteve · 2023-03-24T12:46:18Z

x-pack/plugins/transform/public/app/lib/authorization/components/common.ts

+      message = i18n.translate(
+        'xpack.transform.capability.noPermission.scheduleNowTransformTooltip',
+        {
+          defaultMessage: 'You do not have permission to schedule transforms now.',


Suggested change

defaultMessage: 'You do not have permission to schedule transforms now.',

defaultMessage: 'You do not have permission to schedule transforms to process data instantly.',

szabosteve · 2023-03-24T12:50:13Z

...pp/sections/transform_management/components/action_schedule_now/schedule_now_action_name.tsx

+      'xpack.transform.transformList.cannotScheduleNowCompleteBatchTransformBulkActionToolTip',
+      {
+        defaultMessage:
+          'One or more transforms are completed batch transforms and cannot be scheduled now.',


Suggested change

'One or more transforms are completed batch transforms and cannot be scheduled now.',

'One or more transforms are completed batch transforms and cannot be scheduled to process data instantly.',

szabosteve · 2023-03-24T12:50:40Z

...pp/sections/transform_management/components/action_schedule_now/schedule_now_action_name.tsx

+    completedBatchTransformMessage = i18n.translate(
+      'xpack.transform.transformList.cannotScheduleNowCompleteBatchTransformToolTip',
+      {
+        defaultMessage: '{transformId} is a completed batch transform and cannot be scheduled now.',


Suggested change

defaultMessage: '{transformId} is a completed batch transform and cannot be scheduled now.',

defaultMessage: '{transformId} is a completed batch transform and cannot be scheduled to process data instantly.',

walterra · 2023-03-24T15:17:49Z

@peteharverson @qn895 @szabosteve Addressed all comments, this is ready for another look! Thanks for your feedback esp. about the wording!

kibana-ci · 2023-03-24T16:17:40Z

💚 Build Succeeded

Buildkite Build
Commit: 3563f14

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`transform`	313	317	+4

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`transform`	372.9KB	376.6KB	+3.7KB

Unknown metric groups

ESLint disabled line counts

id	before	after	diff
`securitySolution`	433	436	+3

Total ESLint disabled count

id	before	after	diff
`securitySolution`	513	516	+3

History

💔 Build #115310 failed a92b1ae
💚 Build #115101 succeeded ca7197e
💚 Build #115026 succeeded 69df7c2
💔 Build #115000 failed f991e5a
💔 Build #114990 failed 8f1fadd

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @walterra

qn895 · 2023-03-24T16:25:51Z

Latest changes LGTM 🎉

szabosteve

UI text LGTM!

peteharverson

Latest text changes LGTM

adds _schedule_now action

8f1fadd

walterra self-assigned this Mar 23, 2023

walterra added 3 commits March 23, 2023 14:46

fix i18n

f991e5a

fix bulk menu disabled status

0ca8fbe

fix jest tests

69df7c2

walterra added release_note:enhancement :ml Feature:Transforms ML transforms v8.8.0 labels Mar 23, 2023

walterra requested review from qn895 and peteharverson March 23, 2023 14:46

walterra marked this pull request as ready for review March 23, 2023 14:46

walterra requested a review from a team as a code owner March 23, 2023 14:46

qn895 reviewed Mar 23, 2023

View reviewed changes

...app/sections/transform_management/components/action_schedule_now/use_schedule_now_action.tsx Show resolved Hide resolved

qn895 reviewed Mar 23, 2023

View reviewed changes

x-pack/plugins/translations/translations/fr-FR.json Show resolved Hide resolved

qn895 reviewed Mar 23, 2023

View reviewed changes

x-pack/plugins/transform/public/app/hooks/use_schedule_now_transform.tsx Outdated Show resolved Hide resolved

walterra added 3 commits March 23, 2023 17:22

add missing privilege

967f452

fix line reference

bdff00b

fix i18n

ca7197e

peteharverson reviewed Mar 24, 2023

View reviewed changes

szabosteve reviewed Mar 24, 2023

View reviewed changes

walterra added 4 commits March 24, 2023 14:29

Merge branch 'main' into ml-150350-transform-schedule-now

02b902b

remove schedule now confirmation modal

f4898da

tweak texts

f0ed391

adds default tooltip to schedule-now button

a92b1ae

walterra added 2 commits March 24, 2023 16:00

fix modal removal

24ba764

API integration test

3563f14

qn895 approved these changes Mar 24, 2023

View reviewed changes

szabosteve approved these changes Mar 24, 2023

View reviewed changes

peteharverson approved these changes Mar 24, 2023

View reviewed changes

walterra merged commit 0cc560f into elastic:main Mar 26, 2023

kibanamachine added the backport:skip This commit does not require backporting label Mar 26, 2023

walterra deleted the ml-150350-transform-schedule-now branch March 26, 2023 10:18

walterra mentioned this pull request Apr 3, 2023

[ML] Transforms: Fix _schedule_now capabilities check #154218

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ML] Transforms: Adds `_schedule_now` action to transform list. #153545

[ML] Transforms: Adds `_schedule_now` action to transform list. #153545

walterra commented Mar 23, 2023 •

edited

Loading

elasticmachine commented Mar 23, 2023

walterra commented Mar 23, 2023

qn895 commented Mar 23, 2023

walterra commented Mar 24, 2023

peteharverson Mar 24, 2023

walterra Mar 24, 2023

peteharverson left a comment

peteharverson Mar 24, 2023

walterra Mar 24, 2023

peteharverson Mar 24, 2023

peteharverson Mar 24, 2023

peteharverson Mar 24, 2023

peteharverson Mar 24, 2023

peteharverson Mar 24, 2023

peteharverson Mar 24, 2023

peteharverson Mar 24, 2023

walterra Mar 24, 2023

szabosteve left a comment •

edited

Loading

szabosteve Mar 24, 2023 •

edited

Loading

szabosteve Mar 24, 2023 •

edited

Loading

szabosteve Mar 24, 2023 •

edited

Loading

szabosteve Mar 24, 2023 •

edited

Loading

szabosteve Mar 24, 2023 •

edited

Loading

szabosteve Mar 24, 2023 •

edited

Loading

szabosteve Mar 24, 2023 •

edited

Loading

walterra commented Mar 24, 2023

kibana-ci commented Mar 24, 2023

ESLint disabled line counts

Total ESLint disabled count

qn895 commented Mar 24, 2023

szabosteve left a comment

peteharverson left a comment

	defaultMessage: 'Request to schedule transform {transformId} now acknowledged.',
	defaultMessage: 'Request to schedule transform {transformId} to process data instantly acknowledged.',

	defaultMessage: 'An error occurred scheduling the transform {transformId} now.',
	defaultMessage: 'An error occurred scheduling transform {transformId} to process data instantly.',

	defaultMessage: 'An error occurred calling the schedule now transforms request.',
	defaultMessage: 'An error occurred calling the request to schedule the transform to process data instantly.',

	defaultMessage: 'You do not have permission to schedule transforms now.',
	defaultMessage: 'You do not have permission to schedule transforms to process data instantly.',

	'One or more transforms are completed batch transforms and cannot be scheduled now.',
	'One or more transforms are completed batch transforms and cannot be scheduled to process data instantly.',

	defaultMessage: '{transformId} is a completed batch transform and cannot be scheduled now.',
	defaultMessage: '{transformId} is a completed batch transform and cannot be scheduled to process data instantly.',

[ML] Transforms: Adds _schedule_now action to transform list. #153545

[ML] Transforms: Adds _schedule_now action to transform list. #153545

Conversation

walterra commented Mar 23, 2023 • edited Loading

Summary

Checklist

elasticmachine commented Mar 23, 2023

walterra commented Mar 23, 2023

qn895 commented Mar 23, 2023

walterra commented Mar 24, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

peteharverson left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

szabosteve left a comment • edited Loading

Choose a reason for hiding this comment

szabosteve Mar 24, 2023 • edited Loading

Choose a reason for hiding this comment

szabosteve Mar 24, 2023 • edited Loading

Choose a reason for hiding this comment

szabosteve Mar 24, 2023 • edited Loading

Choose a reason for hiding this comment

szabosteve Mar 24, 2023 • edited Loading

Choose a reason for hiding this comment

szabosteve Mar 24, 2023 • edited Loading

Choose a reason for hiding this comment

szabosteve Mar 24, 2023 • edited Loading

Choose a reason for hiding this comment

szabosteve Mar 24, 2023 • edited Loading

Choose a reason for hiding this comment

walterra commented Mar 24, 2023

kibana-ci commented Mar 24, 2023

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

ESLint disabled line counts

Total ESLint disabled count

History

qn895 commented Mar 24, 2023

szabosteve left a comment

Choose a reason for hiding this comment

peteharverson left a comment

Choose a reason for hiding this comment

[ML] Transforms: Adds `_schedule_now` action to transform list. #153545

[ML] Transforms: Adds `_schedule_now` action to transform list. #153545

walterra commented Mar 23, 2023 •

edited

Loading

szabosteve left a comment •

edited

Loading

szabosteve Mar 24, 2023 •

edited

Loading

szabosteve Mar 24, 2023 •

edited

Loading

szabosteve Mar 24, 2023 •

edited

Loading

szabosteve Mar 24, 2023 •

edited

Loading

szabosteve Mar 24, 2023 •

edited

Loading

szabosteve Mar 24, 2023 •

edited

Loading

szabosteve Mar 24, 2023 •

edited

Loading