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
1A. Completely remove CustomAction mechanism, as it will be unused after stage 1 "run now"
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 PerformSingleExecution action, now supported in the DeploymentManager and GUI.
- Added new command type DMPerformSingleExecutionCommand for processing single execution requests.
- Enhanced process state management with new fields for visible actions and action tooltips.
- New PerformSingleExecutionButton added to the toolbar for executing single actions.
- Improved tooltip management for actions based on current process state.
- Updated API endpoints for better error handling and specificity in responses.
Bug Fixes
- Improved error handling and logging for health check endpoints.
Documentation
- Updated changelog and migration guide to reflect new features and changes in command structure.
- Added new test cases for tooltip visibility based on process states.

...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

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

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

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.~~ <-this change is reverted

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

…ate-handling

This reverts commit aeaec47

…ate-handling # Conflicts: # docs/Changelog.md # docs/MigrationGuide.md

arkadius

PeriodicProcessServiceIntegrationTest failed. Is it related with your change?

mgoworko · 2024-12-03T09:59:27Z

PeriodicProcessServiceIntegrationTest failed. Is it related with your change?

Seems completely not related. My change did not modify how periodic processes work internally. Logs are not conclusive, but I think it was Flink deployment error that caused it. It passes locally and passed on retry.

…ate-handling

arkadius · 2024-12-03T15:03:20Z

PeriodicProcessServiceIntegrationTest failed. Is it related with your change?

Seems completely not related. My change did not modify how periodic processes work internally. Logs are not conclusive, but I think it was Flink deployment error that caused it. It passes locally and passed on retry.

OK, so let's merge it

…ution (#7165)

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

Merged

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

mgoworko added 3 commits December 2, 2024 13:15

Revert "review changes"

cb6085c

This reverts commit aeaec47

Review changes

cbd42a5

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

53f65bb

…ate-handling # Conflicts: # docs/Changelog.md # docs/MigrationGuide.md

This comment was marked as outdated.

Sign in to view

arkadius approved these changes Dec 2, 2024

View reviewed changes

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

4c5746e

…ate-handling

mgoworko merged commit 9db6f47 into staging Dec 4, 2024
18 checks passed

mgoworko deleted the improve-run-now-state-handling branch December 4, 2024 07:30

lciolecki pushed a commit that referenced this pull request Dec 7, 2024

Replace "run now" CustomAction with standard action PerformSingleExec…

5e982e3

…ution (#7165)

lciolecki pushed a commit that referenced this pull request Dec 10, 2024

Replace "run now" CustomAction with standard action PerformSingleExec…

eb3ccd5

…ution (#7165)

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

Dzuming Nov 26, 2024

mgoworko Nov 27, 2024 •

edited

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.

arkadius left a comment

mgoworko commented Dec 3, 2024

arkadius commented Dec 3, 2024

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

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

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

Dzuming Nov 26, 2024

Choose a reason for hiding this comment

mgoworko Nov 27, 2024 • edited Loading

Choose a reason for hiding this comment

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

mgoworko commented Dec 3, 2024

arkadius commented Dec 3, 2024

mgoworko commented Nov 18, 2024 •

edited by coderabbitai bot

Loading

mgoworko Nov 27, 2024 •

edited

Loading