[vrotsc] (#340) Add Workflow canvas Workflow End item #348

akantchev · 2024-07-18T12:37:57Z

*New `@WorkflowEndItem` decorator for Workflows

The decorator is used to specify a custom workflow end item.

Supported Parameters

endMode - End mode of the component, could be one of 0 or 1, where 0 is exit success and 1 is error.
exceptionVariable - Exception variable that will hold the exception data when triggered.
businessStatus - Value of the business status in the end component.

In order to bind inputs and outputs, you do it with the @Out decorator. This is the same way we do it for other items.

Example:

import { Workflow, RootItem, WorkflowEndItem } from "vrotsc-annotations";

@Workflow({
	name: "Workflow End Exception",
	path: "VMware/PSCoE",
	description: "Workflow with root and end item with end mode 1",
	attributes: {
		errorMessage: {
			type: "string"
		},
		businessStatus: {
			type: "string"
		},
		endMode: {
			type: "number"
		}
	}
})
export class WorkflowEnd {

	@RootItem()
	public initiateWorkflow() {
		// NOOP
	}

	@WorkflowEndItem({
		endMode: 1,
		exceptionVariable: "errorMessage",
		businessStatus: "Bad"
	})
	public workflowEnd() {
		// NOOP
	}
}

Checklist

I have added relevant error handling and logging messages to help troubleshooting
I have added tests that prove my fix is effective or that my feature works
I have added necessary documentation, relevant usage information (if applicable)
I have updated the PR title with affected component, related issue number and a short summary of the changes introduced
I have added labels for implementation kind (kind/) and version type (version/)
I have tested against live environment, if applicable
I have my changes rebased and squashed to the minimal number of relevant commits. Notice: don't squash all commits
I have added a descriptive commit message with a short title, including a Fixed #XXX - or Closed #XXX - prefix to auto-close the issue

Testing

Added e2e tests to the PR and also tested on an actual environment. Testing process on live environment:

Create project of archetype typescript-project-all.
Add a typescript representation of a workflow as shown in the example above.
Push project to a live environment with vRO.

Release Notes

*New `@WorkflowEndItem` decorator for Workflows

The decorator is used to specify a custom workflow end item.

Supported Parameters

endMode - End mode of the component, could be one of 0 or 1, where 0 is exit success and 1 is error.
exceptionVariable - Exception variable that will hold the exception data when triggered.
businessStatus - Value of the business status assigned with the end.

In order to bind inputs and outputs, you do it with the @Out decorator. This is the same way we do it for other items.

Related issues and PRs

Implementation of #340

Signed-off-by: Alexander Kantchev <[email protected]>

Michaelpalacce · 2024-07-19T06:26:08Z

In the example, why do we have:

@WorkflowEndItem({
    endMode: 1,
    exception: "errorMessage",
  })
  public workflowEnd(@In endMode: number, @Out errorMessage: string) {
    // NOOP
  }

@In endMode?

Michaelpalacce · 2024-07-19T06:26:42Z

typescript/vrotsc/e2e/cases/canvas-items/workflow.wf.ts

@@ -19,6 +19,9 @@ import { Workflow, Out, In, Item, RootItem, DecisionItem, WaitingTimerItem, Work
 		},
 		result: {
 			type: "number"
+		},


Why modify this test? I see you may be confused but this test is to test the WorkflowItem

Actually this serves as an integration test for the currently supported components.

Michaelpalacce · 2024-07-19T06:26:52Z

typescript/vrotsc/e2e/cases/canvas-items/end-item-exception.wf.ts

+		exception: "errorMessage",
+		businessStatus: "Bad"
+	})
+	public workflowEnd(@In endMode: number, @Out errorMessage: string) {


Why is endMode needed?

It is required by the XML representation of the component.

This is an input parameter, end-mode is a property of the workflow item. It makes no sense to have it as an input too

Code updated.

Michaelpalacce · 2024-07-19T06:27:08Z

typescript/vrotsc/e2e/cases/canvas-items/end-item-happy.wf.ts

+	@WorkflowEndItem({
+		endMode: 0
+	})
+	public workflowEnd(@In endMode: number) {


Same comment here

It is required by the XML representation of the component.

...sc/src/compiler/transformer/fileTransformers/workflow/decorators/endItemDecoratorStrategy.ts

Michaelpalacce · 2024-07-19T06:30:03Z

...sc/src/compiler/transformer/fileTransformers/workflow/decorators/endItemDecoratorStrategy.ts

+		const endMode = itemInfo?.canvasItemPolymorphicBag?.endMode;
+		const exceptionVariable = itemInfo?.canvasItemPolymorphicBag?.exception;
+		const businessStatus = itemInfo?.canvasItemPolymorphicBag?.businessStatus;
+		const hasException = (exceptionVariable !== null && exceptionVariable !== undefined && exceptionVariable);


! exceptionVariable Checks for all of these

Code updated.

Michaelpalacce · 2024-07-19T06:32:41Z

...sc/src/compiler/transformer/fileTransformers/workflow/decorators/endItemDecoratorStrategy.ts

+		const hasBusinessStatus = (businessStatus !== null && businessStatus !== undefined && businessStatus);
+
+		stringBuilder.append(`<workflow-item name="item${pos}" type="end" end-mode="${endMode}" `);
+		if (hasException) {


only for endmode 1

Actually not, you can support endMode = 1 and without throwing of an exception, in case the error is handled in another workflow.

In the UI this is not present, I found no way to do this

...sc/src/compiler/transformer/fileTransformers/workflow/decorators/endItemDecoratorStrategy.ts

Michaelpalacce · 2024-07-19T06:33:44Z

vro-types/vrotsc-annotations/index.d.ts

+
+interface VroWorkflowEndItemConfiguration {
+	endMode?: WorkflowEndMode;
+	exception?: string;


exception will mean sth else in other items... can we rename this?

Code updated.

akantchev · 2024-07-19T10:45:12Z

In the example, why do we have:

@WorkflowEndItem({
    endMode: 1,
    exception: "errorMessage",
  })
  public workflowEnd(@In endMode: number, @Out errorMessage: string) {
    // NOOP
  }

endMode?

To control the end mode of the end component, this could support the following scenarios:

endMode = 0, success
endMode = 1, error with support of exception throwing.
endMode = 1, error without support of exception throwing.

The use case 3 can be used when the workflow is controlled by other workflow and does not need exception throwing when the exit code is 1

Signed-off-by: Alexander Kantchev <[email protected]>

Michaelpalacce · 2024-07-19T15:38:57Z

@In endMode: number,

I am ok with it being in the decorator, I meant @In endMode: number,

…ters. Signed-off-by: Alexander Kantchev <[email protected]>

Signed-off-by: Alexander Kantchev <[email protected]>

[Task 340] Initial implementation of workflow end item.

40adf1a

Signed-off-by: Alexander Kantchev <[email protected]>

akantchev requested a review from a team as a code owner July 18, 2024 12:37

github-actions bot added the kind/feature New Feature to the project label Jul 18, 2024

[Task 340] docs: Updated md files.

0f96880

Signed-off-by: Alexander Kantchev <[email protected]>

akantchev self-assigned this Jul 18, 2024

akantchev added area/vrotsc Relates to `vrotsc` module version/minor Introduces a non-breaking feature or change labels Jul 18, 2024

akantchev requested a review from Michaelpalacce July 18, 2024 12:40

[Task 340] docs: Updated formatting.

fadec02

Signed-off-by: Alexander Kantchev <[email protected]>

akantchev mentioned this pull request Jul 18, 2024

Canvas Item Support for End Workflow #340

Closed

[Task 340] code: Added support for business status.

23cc51e

Signed-off-by: Alexander Kantchev <[email protected]>

Michaelpalacce requested changes Jul 19, 2024

View reviewed changes

[Task 340] code: Updated annotation variable name.

9d6cf9a

Signed-off-by: Alexander Kantchev <[email protected]>

akantchev added 2 commits July 22, 2024 11:55

[Task 340] code: Updated test workflows methods not to contain parame…

3c61a76

…ters. Signed-off-by: Alexander Kantchev <[email protected]>

[Task 340] code: Removed unused imports in test workflows.

3932ea3

Signed-off-by: Alexander Kantchev <[email protected]>

akantchev requested a review from Michaelpalacce July 22, 2024 08:59

[Task 340] docs: Updated examples, added parameter docs.

18c4e1c

Signed-off-by: Alexander Kantchev <[email protected]>

Michaelpalacce approved these changes Jul 22, 2024

View reviewed changes

akantchev merged commit 356aa9f into main Jul 22, 2024
14 checks passed

VenelinBakalov deleted the feature/340-canvas-item-end-workflow branch July 29, 2024 07:16

VenelinBakalov changed the title ~~[vrotsc] (#340) Added a new canvas item for workflow end.~~ [vrotsc] (#340) Add Workflow canvas Workflow End item Aug 1, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[vrotsc] (#340) Add Workflow canvas Workflow End item #348

[vrotsc] (#340) Add Workflow canvas Workflow End item #348

akantchev commented Jul 18, 2024 •

edited

Loading

Michaelpalacce commented Jul 19, 2024 •

edited

Loading

Michaelpalacce Jul 19, 2024

akantchev Jul 19, 2024

Michaelpalacce Jul 19, 2024

akantchev Jul 19, 2024

Michaelpalacce Jul 19, 2024

akantchev Jul 22, 2024

Michaelpalacce Jul 19, 2024

akantchev Jul 19, 2024

Michaelpalacce Jul 19, 2024

akantchev Jul 19, 2024

Michaelpalacce Jul 19, 2024

Michaelpalacce Jul 19, 2024

akantchev Jul 19, 2024

Michaelpalacce Jul 19, 2024

Michaelpalacce Jul 19, 2024

akantchev Jul 19, 2024

akantchev commented Jul 19, 2024 •

edited

Loading

Michaelpalacce commented Jul 19, 2024

[vrotsc] (#340) Add Workflow canvas Workflow End item #348

[vrotsc] (#340) Add Workflow canvas Workflow End item #348

Conversation

akantchev commented Jul 18, 2024 • edited Loading

*New @WorkflowEndItem decorator for Workflows

Supported Parameters

Checklist

Testing

Release Notes

*New @WorkflowEndItem decorator for Workflows

Supported Parameters

Related issues and PRs

Michaelpalacce commented Jul 19, 2024 • edited Loading

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

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

akantchev commented Jul 19, 2024 • edited Loading

Michaelpalacce commented Jul 19, 2024

akantchev commented Jul 18, 2024 •

edited

Loading

*New `@WorkflowEndItem` decorator for Workflows

*New `@WorkflowEndItem` decorator for Workflows

Michaelpalacce commented Jul 19, 2024 •

edited

Loading

akantchev commented Jul 19, 2024 •

edited

Loading