[vrotsc] (#325) Add Workflow canvas Workflow item

[Michaelpalacce]

Description

New WorkflowItem decorator for Workflows

The new Decorator gives you the ability to specify a canvas item that calls a Workflow.

• @WorkflowItem({target: "", linkedItem: "" })
  • target - The name of the next in line item.
  • linkedItem - The ID of the workflow to call

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, Out, In, Item, RootItem, DecisionItem, WaitingTimerItem, WorkflowItem } from "vrotsc-annotations";

@Workflow({
	name: "Example Waiting Timer",
	path: "VMware/PSCoE",
	attributes: {
		waitingTimer: {
			type: "Date"
		},
		counter: {
			type: "number"
		},
		first: {
			type: "number"
		},
		second: {
			type: "number"
		},
		result: {
			type: "number"
		}
	}
})
export class HandleNetworkConfigurationBackup {
	@DecisionItem({ target: "waitForEvent", else: "prepareItems" })
	public decisionElement(waitingTimer: Date) {
		return waitingTimer !== null;
	}

	@Item({ target: "callOtherWf" })
	public prepareItems(@In @Out first: number, @In @Out second: number) {
		first = 1;
		second = 2;
	}

	@WorkflowItem({
		target: "print",
		linkedItem: "9e4503db-cbaa-435a-9fad-144409c08df0"
	})
	public callOtherWf(@In first: number, @In second: number, @Out result: number) {
	}

	@Item({ target: "end" })
	public print(@In result: number) {
		System.log("Result: " + result);
	}

	@Item({ target: "decisionElement", exception: "" })
	public execute(@Out @In waitingTimer: Date, @Out @In counter: number): void {
		if (!counter) {
			counter = 0;
		}

		counter++;

		if (counter < 2) {
			const tt = Date.now() + 5 * 1000;
			waitingTimer = new Date(tt);
		} else {
			waitingTimer = null;
		}

		System.log("Counter: " + counter);
		System.log("Waiting Timer: " + waitingTimer);
	}

	@Item({ target: "execute", exception: "" })
	@RootItem()
	public start() {
		System.log("Starting workflow");
	}

	@WaitingTimerItem({ target: "execute" })
	public waitForEvent(@In waitingTimer: Date) {
	}
}

You can see in the screenshot that the result is 3 :)

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 synced any structure and/or content vRA-NG improvements with vra-ng and ts-vra-ng archetypes (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

[akantchev]

It is a good practice to wrap the cases with braces {}, i.e.

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

[Michaelpalacce]

Really? Because I removed it because I thought it wasn't a good practice... I think It was also part of our convention that we don't do this

[akantchev]

I am not aware of such convention, however I think using braces would improve readability of the code.

[akantchev]

You can change the above line to

const param = itemInfo.parent.parameters.find((p: WorkflowParameter) => p.name === paramName);

[akantchev]

It might be a good idea to change the above line to:

 scriptProgram = context.sourceFiles?.length

[akantchev]

Just a side note: I think it would be good to introduce a new WorkflowItemType called EndItem and this end item to be able to be linked for example to a decision item (as an alternative exit).

[Michaelpalacce]

That's a todo for later for sure