[vrotsc, vrotsc-annotations] (#339) Add Workflow canvas Default Error Handler item #346

akantchev · 2024-07-18T08:45:21Z

*New `DefaultErrorHandler` decorator for Workflows

This decorator is used to specify a default error handler. It can be bound either to a workflow item component or workflow end.

Supported Parameters

target - target item to be attached to the default error handler, could be one of workflow item or workflow end.
exceptionVariable - Exception variable that will hold the exception data when triggered.

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

Example:

import { Workflow, RootItem, In, Out, Item, DefaultErrorHandler, WorkflowEndItem } from "vrotsc-annotations";

@Workflow({
	name: "Default Error Handler Custom Item",
	path: "VMware/PSCoE",
	description: "Default error handler workflow with error handler redirecting to a workflow item",
	attributes: {
		errorMessage: {
			type: "string"
		}
	}
})
export class HandleDefaultError {

	@RootItem()
	public initiateWorkflow() {
		System.log("Initiating workflow execution");
	}

	@Item({
		target: "workflowEnd"
	})
	public processError(@In errorMessage: string) {
		System.log(`Processing error using custom task with message '${errorMessage}'`);
	}

	@DefaultErrorHandler({
		exceptionVariable: "errorMessage",
		target: "processError"
	})
	public defaultErrorHandler(@Out errorMessage: string) {
		// NOOP
	}

	@WorkflowEndItem({
		endMode: 0,
		exceptionVariable: "errorMessage",
	})
	public workflowEnd(@Out errorMessage: string) {
		System.log(`Terminating workflow with error ${errorMessage}`);
	}
}

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.

Test Screenshot

Release Notes

*New `DefaultErrorHandler` decorator for Workflows

This decorator is used to specify a default error handler. Note that the default error handler will be generated
with its own end workflow item as it is required by the component.

Supported Parameters

target - Not implemented yet
exception - if set the variable will be bound to the error handler and its own end workflow component.
If set the end workflow component bound to the error handler will have exit code 1, otherwise the exit code will be 0.

Related issues and PRs

Implementation of #339

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

vmwclabot · 2024-07-18T08:45:25Z

@akantchev, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <[email protected]> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 84547d6 must be signed by [email protected]

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

vmwclabot · 2024-07-18T12:43:46Z

@akantchev, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <[email protected]> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 84547d6 must be signed by [email protected]
Commit 3d222aa must be signed by [email protected]

vmwclabot · 2024-07-18T12:43:46Z

@akantchev, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <[email protected]> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 84547d6 must be signed by [email protected]
Commit 3d222aa must be signed by [email protected]

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

vmwclabot · 2024-07-18T14:12:38Z

@akantchev, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <[email protected]> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 84547d6 must be signed by [email protected]
Commit 3d222aa must be signed by [email protected]

vmwclabot · 2024-07-18T14:12:39Z

@akantchev, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <[email protected]> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 84547d6 must be signed by [email protected]
Commit 3d222aa must be signed by [email protected]

Michaelpalacce

Non relevant

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

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

+		// NOOP
+	}
+
+	@DefaultErrorHandler({


Don't modify old tests like this, rather add new ones

Actually this one serves as an integration test for all currently supported workflow items, hence it should be here, Furthermore there are other tests for this specific functionality as well.

No it doesn't 😄 the example was just too big perhaps, but it was meant mainly for Workflow

Discussed offline, comment not applicable anymore.

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

typescript/vrotsc/e2e/expect/canvas-items/workflows/VMware/PSCoE/Waiting Timer Edge.xml

Why are there changes here?

Due to changes in the typescript representations of the workflows.

typescript/vrotsc/src/compiler/decorators.ts

Michaelpalacce · 2024-07-19T06:11:04Z

typescript/vrotsc/src/compiler/decorators.ts

@@ -58,6 +58,7 @@ export interface WorkflowItemDescriptor<T = any> {
 	canvasItemPolymorphicBag: T;
 	polyglot?: PolyglotDescriptor;
 	parent: WorkflowDescriptor;
+	type?: WorkflowItemType;


You should get this from the assigned strategy. You can do descriptor.strategy.getDecoratorType()

Property removed.

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

...ler/transformer/fileTransformers/workflow/decorators/defaultErrorHandlerDecoratorStrategy.ts

+import { buildItemParameterBindings, InputOutputBindings } from "./helpers/presentation";
+
+// UI positioning constants in the output XML file.
+const xBasePosition = 180;


We have a task for this

Michaelpalacce · 2024-07-19T06:20:02Z

...ler/transformer/fileTransformers/workflow/decorators/defaultErrorHandlerDecoratorStrategy.ts

+		const exceptionVariable = itemInfo?.canvasItemPolymorphicBag?.exception;
+		const hasException = (exceptionVariable !== null && exceptionVariable !== undefined && exceptionVariable);
+
+		stringBuilder.append(`<error-handler name="item${pos}" `);


To make it more readable, maybe sth like:

stringBuilder.append(`<error-handler` + ` name="item${pos}" ` + ` ${hasException ? `throw-bind-name="${exceptionVariable}" ` : ""}` + `>`).appendLine();

as we do with others?

Actually your proposal is less readable.

Michaelpalacce · 2024-07-19T06:21:21Z

...ler/transformer/fileTransformers/workflow/decorators/defaultErrorHandlerDecoratorStrategy.ts

+		stringBuilder.append("</error-handler>").appendLine();
+
+		// attach a default end item to the error handler, note that the name of the end item and the error handler should be the same
+		const defaultEndItem = this.buildDefaultEndItem(itemInfo, pos, exceptionVariable);


This doesn't really make sense, the whole idea is that they can attach to an end item or another task to handle the error in some way

Besides, this can easily point to the default end item that was created.

Actually it does, it should have a default end item, attached to the error handler.

You didn't answer the first question. users can point to a task or sth else, how do we handle that?

Where is the requirement to have a default end item?

Discussed offline, comment not applicable anymore.

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

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

@@ -127,6 +127,8 @@ type CompositeType = {

 type AttributeValue = CompositeType | SupportedValues | SupportedValues[];

+type WorkflowEndMode = 0 | 1;


Michaelpalacce · 2024-07-19T06:23:02Z

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

@@ -253,7 +266,11 @@ interface VroPolyglotDecorator {
 	new(obj?: VroPolyglotConfiguration): VroPolyglotConfiguration;
 }

-interface VroPolyglotConfiguration { package: string, method: string; }
+interface VroPolyglotConfiguration {


Let's revert this

Discussed offline, reverting is not needed.

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

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

+
+interface VroWorkflowDefaultErrorHandlerDecorator {
+	(obj?: VroItemConfiguration): VroWorkflowDefaultErrorHandlerMethodDecorator;
+	new(obj?: VroItemConfiguration): VroItemConfiguration;


Each item should have their own definition so they are easy to change and don't bring confusion

It does not make sense to have own definition in this case, as it does not bring new properties.

So each other type have their own Config Type, but specifically the DefaultErrorhanlder will point to the Item one? Isn't it more clear for the user if it has it's own?

Discussed offline, decided that the whole interface will be reworked using inheritance once all needed workflow components are implemented (will be done in a separate PR).

Michaelpalacce · 2024-07-19T06:34:07Z

...ler/transformer/fileTransformers/workflow/decorators/defaultErrorHandlerDecoratorStrategy.ts

+					itemInfo.target = propValue;
+					break;
+				}
+				case "exception": {


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

Annotation variable name changed.

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

vmwclabot · 2024-07-22T12:06:40Z

@akantchev, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <[email protected]> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 84547d6 must be signed by [email protected]
Commit 3d222aa must be signed by [email protected]

vmwclabot · 2024-07-22T12:06:40Z

@akantchev, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <[email protected]> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 84547d6 must be signed by [email protected]
Commit 3d222aa must be signed by [email protected]

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

vmwclabot · 2024-07-22T12:21:44Z

@akantchev, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <[email protected]> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 84547d6 must be signed by [email protected]
Commit 3d222aa must be signed by [email protected]

vmwclabot · 2024-07-22T12:21:44Z

@akantchev, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <[email protected]> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 84547d6 must be signed by [email protected]
Commit 3d222aa must be signed by [email protected]

[Task 340] Initial implementation of workflow error handler method de…

84547d6

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

akantchev added area/documentation Relates to improvements or additions to documentation area/vrotsc Relates to `vrotsc` module version/minor Introduces a non-breaking feature or change kind/feature New Feature to the project labels Jul 18, 2024

akantchev self-assigned this Jul 18, 2024

akantchev requested a review from a team as a code owner July 18, 2024 08:45

vmwclabot added the dco-required label Jul 18, 2024

[Task 340] style: Formatting.

3d222aa

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

akantchev changed the title ~~[vrotsc] (#340) Added a new canvas item for Default Error Handler~~ [vrotsc] (#339) Added a new canvas item for Default Error Handler Jul 18, 2024

vmware deleted a comment from vmwclabot Jul 18, 2024

akantchev removed the dco-required label Jul 18, 2024

akantchev requested a review from Michaelpalacce July 18, 2024 08:52

vmware deleted a comment from vmwclabot Jul 18, 2024

akantchev removed the area/documentation Relates to improvements or additions to documentation label Jul 18, 2024

[Task 339] code: Added handling of corner cases.

da11366

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

vmwclabot added dco-required labels Jul 18, 2024

akantchev mentioned this pull request Jul 18, 2024

Canvas Item Decorator Support For Default error handler #339

Closed

[Task 339] code: Improvements.

5db1f5b

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

Michaelpalacce requested changes Jul 19, 2024

View reviewed changes

Michaelpalacce reviewed Jul 19, 2024

View reviewed changes

akantchev changed the title ~~[vrotsc] (#339) Added a new canvas item for Default Error Handler~~ [vrotsc, vrotsc-annotations] (#339) Added a new canvas item for Default Error Handler Jul 22, 2024

[Task 339] code/tests: Added more tests, merged with main.

98767f5

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

akantchev requested a review from Michaelpalacce July 22, 2024 12:11

akantchev added 2 commits July 22, 2024 15:18

[Task 339] docs: Updated examples.

65e1e90

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

[Task 339] docs: Updated links.

c9b453b

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

Michaelpalacce approved these changes Jul 22, 2024

View reviewed changes

akantchev merged commit 2c96994 into main Jul 22, 2024
14 checks passed

VenelinBakalov deleted the feature/340-canvas-item-default-error-handler branch July 29, 2024 09:16

VenelinBakalov removed the dco-required label Jul 30, 2024

VenelinBakalov changed the title ~~[vrotsc, vrotsc-annotations] (#339) Added a new canvas item for Default Error Handler~~ [vrotsc, vrotsc-annotations] (#339) Add Workflow canvas Default Error Handler item Aug 1, 2024

		@@ -127,6 +127,8 @@ type CompositeType = {

		type AttributeValue = CompositeType \| SupportedValues \| SupportedValues[];

		type WorkflowEndMode = 0 \| 1;

[vrotsc, vrotsc-annotations] (#339) Add Workflow canvas Default Error Handler item #346

[vrotsc, vrotsc-annotations] (#339) Add Workflow canvas Default Error Handler item #346

Conversation

akantchev commented Jul 18, 2024 • edited Loading

*New DefaultErrorHandler decorator for Workflows

Supported Parameters

Checklist

Testing

Test Screenshot

Release Notes

*New DefaultErrorHandler decorator for Workflows

Supported Parameters

Related issues and PRs

vmwclabot commented Jul 18, 2024

vmwclabot commented Jul 18, 2024

vmwclabot commented Jul 18, 2024

vmwclabot commented Jul 18, 2024

vmwclabot commented Jul 18, 2024

Michaelpalacce left a comment • edited by akantchev 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

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

vmwclabot commented Jul 22, 2024

vmwclabot commented Jul 22, 2024

vmwclabot commented Jul 22, 2024

vmwclabot commented Jul 22, 2024

akantchev commented Jul 18, 2024 •

edited

Loading

*New `DefaultErrorHandler` decorator for Workflows

*New `DefaultErrorHandler` decorator for Workflows

Michaelpalacce left a comment •

edited by akantchev

Loading