Replace "run now" CustomAction with standard action PerformSingleExecution #7165

mgoworko · 2024-11-18T16:42:42Z

Describe your changes

The main purpose of this PR, is to refactor "run now" action for periodic DeploymentManagers:

before: it was a CustomAction
now: it is a standard actions, similar to CANCEL, DEPLOY, etc.

Planned changes related to the PeriodicDeploymentManager:

This change modifies basic handling and UX of "run now" action
Second phase (already in progress while writing this comment) will involve:

moving the periodic deployment manager closer to Nu core
- database, that was separate, moved the main Nu db
- deployment manager decoupled from Flink
- interface moved to the deployment manager API module, but mostly as-is, without huge changes
improving and optimizing queries about periodic scenarios and their status

Third phase may involve further integrating the periodics into the general deployment manager interface - phase 2 is preparation for that.

Most important changes:

The "run now" actions is now implemented as standard action:

it has its own dedicated button on actions panel, no longer uses generic CustomAction mechanism and button
this new button is now fully controlled by Nu backend response, both
- its visibility (only for periodic processes)
- active/inactive (greyed out), it is active only when newest version of scenario is scheduled

The ProcessStateDefinitionManager improvements:

it is now aware, which version of the scenario is newest, and which is deployed
it allows to manage allowed actions, depending on deployed and latest version (it was needed for "run now" action)
ProcessStateDefinitionManager now allows to define, which action buttons are visible on FE (def applicableActions) (right now only applied to "run now" for periodic processes)
ProcessStateDefinitionManager now allows to specify custom tooltips for action buttons (again, it was needed by "run now" action")

The PeriodicProcessStateDefinitionManager changes:

"run now" is now a standard action, handled in the graph of state transitions
"run now" is available only when newest version of scenario is scheduled
in other states, custom tooltips are returned, describing why it is now possible to invoke "run now"

Checklist before merge

Related issue ID is placed at the beginning of PR title in [brackets] (can be GH issue or Nu Jira issue)
Code is cleaned from temporary changes and commented out lines
Parts of the code that are not easy to understand are documented in the code
Changes are covered by automated tests
Showcase in dev-application.conf added to demonstrate the feature
Documentation added or updated
Added entry in Changelog.md describing the change from the perspective of a public distribution user
Added MigrationGuide.md entry in the appropriate subcategory if introducing a breaking change
Verify that PR will be squashed during merge

Summary by CodeRabbit

New Features
- Introduced the PerformSingleExecution action, enhancing scenario execution capabilities.
- Added support for a new command type, DMPerformSingleExecutionCommand, in the DeploymentManager.
- New methods for handling applicable actions and tooltips in the ProcessStateDefinitionManager.
- Enhanced the ProcessState class with new fields for applicable actions and action tooltips.
- Implemented the PerformSingleExecutionButton in the toolbar for immediate execution.
- Added a new PerformSingleExecutionRequest and PerformSingleExecutionResponse for API interactions.
- Expanded event tracking to include the PerformSingleExecution action.
- Improved the ActivitiesPanelRow component to recognize additional running states.
Bug Fixes
- Improved error handling and logging in various health check endpoints.
Documentation
- Updated changelog and migration guide to reflect new features and changes in command handling and process state management.
Chores
- Cleaned up unused imports and improved code formatting across multiple files.

...src/main/scala/pl/touk/nussknacker/engine/api/deployment/ProcessStateDefinitionManager.scala

extensions-api/src/main/scala/pl/touk/nussknacker/engine/api/deployment/ProcessAction.scala

arkadius

Minor comments added

designer/client/src/components/toolbarSettings/buttons/ActionButton.tsx

arkadius · 2024-11-26T13:45:14Z

...gner/client/src/components/toolbars/scenarioActions/buttons/PerformSingleExecutionButton.tsx

+    const action = (p, c) => HttpService.performSingleExecution(p, c).finally(() => dispatch(loadProcessState(processName)));
+    const message = t("panels.actions.perform-single-execution.dialog", "Perform single execution", { name: processName });
+
+    const tooltip = ProcessStateUtils.getActionCustomTooltip(scenarioState, PredefinedActionName.PerformSingleExecution) ?? "run now";


Please use i18n mechanism

I think I've done it now. Backend returns type of tooltip ("NOT_ALLOWED_IN_CURRENT_STATE" /"NOT_ALLOWED_FOR_DEPLOYED_VERSION") and frontend handles actual message rendering with i18s.

It's not exactly what I head in mind. I mean i18n for "run now" text :). I would not apply i18n for backend messages this way. If we decide to do this, it should be done full on BE side and done more holistic. Let's revert this

arkadius · 2024-11-26T13:47:45Z

...manager-api/src/main/scala/pl/touk/nussknacker/engine/api/deployment/DMScenarioCommand.scala

@@ -86,3 +80,9 @@ case class DMCancelScenarioCommand(scenarioName: ProcessName, user: User) extend

 case class DMStopScenarioCommand(scenarioName: ProcessName, savepointDir: Option[String], user: User)
    extends DMScenarioCommand[SavepointResult]
+
+case class DMPerformSingleExecutionCommand(


What about custom actions? Can you write in the description the plan of changes that will be made in further PRs?

Let's write a TODO describing further plan that won't be a part of currently planned changes. Do you agree that eventually we should extract some kind of a scheduler interface and in the deployment manager keep only logic related with the deployment? Or maybe you see it differently?

I added in this PR description the general plan for periodics, especially the change that is already in progress.

I'm not sure ATM about the future of CustomAction's. We aren't using them internally anymore - "run now" was our only usage. They are left in the codebased and APIs right now, so Nu users can still use them.

I guess we need to decide, whether to leave CustomAction's as they are, or remove them.

We should remove custom actions. It was done only for this one thing. It complicates deployments mechanism and slow down development. Let's add a removal step to the plan

Dzuming · 2024-11-26T12:11:18Z

designer/client/src/components/toolbarSettings/buttons/ActionButton.tsx

-            disabled={name === "run now" ? disabledValue : false}
-            type={type}
-        />
+        <CustomActionButton action={action} processName={processName} disabled={false} processStatus={status} type={type} />


As I see, there is no option to disable a custom action based on FE types. Do we need this disabled flag?

It is part of common ToolbarButtonProps, used for all buttons. AFAIK this value must be provided. I guess at the moment it is the only button, that is never disabled on FE side, so constant false provided here

After Arek's comments I added internationalization of tooltip messages, I think it needs FE review too.

designer/client/src/reducers/graph/utils.fixtures.ts

…ate-handling

This comment was marked as outdated.

Sign in to view

github-actions bot added client client main fe ui labels Nov 18, 2024

This comment was marked as outdated.

Sign in to view

github-actions bot added the docs label Nov 19, 2024

mgoworko changed the title ~~Improve "run now" state handling and treat it as a standard action, not custom action~~ Replace "run now" CustomAction with standard action PerformSingleExecution, improve state handling and notifications Nov 19, 2024

mgoworko changed the title ~~Replace "run now" CustomAction with standard action PerformSingleExecution, improve state handling and notifications~~ Replace "run now" CustomAction with standard action PerformSingleExecution Nov 19, 2024

mgoworko marked this pull request as ready for review November 19, 2024 10:00

This comment was marked as outdated.

Sign in to view

github-actions bot mentioned this pull request Nov 19, 2024

Update Cypress snapshots in improve-run-now-state-handling #7172

Closed

This comment was marked as outdated.

Sign in to view

gskrobisz reviewed Nov 20, 2024

View reviewed changes

...src/main/scala/pl/touk/nussknacker/engine/api/deployment/ProcessStateDefinitionManager.scala Show resolved Hide resolved

gskrobisz reviewed Nov 20, 2024

View reviewed changes

extensions-api/src/main/scala/pl/touk/nussknacker/engine/api/deployment/ProcessAction.scala Outdated Show resolved Hide resolved

gskrobisz approved these changes Nov 20, 2024

View reviewed changes

mgoworko mentioned this pull request Nov 20, 2024

Add notifications related to currently displayed scenario #7184

Open

9 tasks

This comment was marked as outdated.

Sign in to view

mgoworko added 2 commits November 20, 2024 15:58

Rebased run now improvements

6374e6e

qs

d3c0e7d

mgoworko force-pushed the improve-run-now-state-handling branch from 879fd84 to d3c0e7d Compare November 20, 2024 15:23

This comment was marked as outdated.

Sign in to view

review changes

daa96bd

This comment was marked as outdated.

Sign in to view

added state tests

9d20653

This comment was marked as outdated.

Sign in to view

github-actions bot mentioned this pull request Nov 21, 2024

Update Cypress snapshots in improve-run-now-state-handling #7196

Closed

arkadius reviewed Nov 26, 2024

View reviewed changes

Dzuming reviewed Nov 26, 2024

View reviewed changes

arkadius reviewed Nov 26, 2024

View reviewed changes

designer/client/src/reducers/graph/utils.fixtures.ts Outdated Show resolved Hide resolved

mgoworko added 2 commits November 27, 2024 18:35

review changes

aeaec47

Merge remote-tracking branch 'origin/staging' into improve-run-now-st…

10f2268

…ate-handling

This comment was marked as outdated.

Sign in to view

fixes

6c9fa55

This comment was marked as outdated.

Sign in to view

mgoworko requested review from arkadius and Dzuming November 28, 2024 08:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace "run now" CustomAction with standard action PerformSingleExecution #7165

Replace "run now" CustomAction with standard action PerformSingleExecution #7165

mgoworko commented Nov 18, 2024 •

edited by coderabbitai bot

Loading

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

arkadius left a comment

arkadius Nov 26, 2024

mgoworko Nov 27, 2024

arkadius Nov 28, 2024

arkadius Nov 26, 2024

mgoworko Nov 27, 2024

arkadius Nov 28, 2024

Dzuming Nov 26, 2024

mgoworko Nov 27, 2024

This comment was marked as outdated.

This comment was marked as outdated.

Replace "run now" CustomAction with standard action PerformSingleExecution #7165

Are you sure you want to change the base?

Replace "run now" CustomAction with standard action PerformSingleExecution #7165

Conversation

mgoworko commented Nov 18, 2024 • edited by coderabbitai bot Loading

Describe your changes

Checklist before merge

Summary by CodeRabbit

Summary by CodeRabbit

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

arkadius 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

This comment was marked as outdated.

This comment was marked as outdated.

mgoworko commented Nov 18, 2024 •

edited by coderabbitai bot

Loading