add parallel example

Signed-off-by: Antonio Mendoza Pérez <[email protected]>

Author: antmendoza

spec/examples/checkcarvitals.spec.ts

@@ -14,10 +14,16 @@
  * limitations under the License.
  *
  */
-import {WorkflowBuilder} from "../../src/model/workflow.builder";
+import {
+	EventBuilder,
+	EventsBuilder,
+	EventStateBuilder,
+	OnEventBuilder,
+	RepeatBuilder,
+	SubFlowStateBuilder,
+	WorkflowBuilder,
+} from "../../src";
 import * as fs from "fs";
-import {SubFlowStateBuilder} from "../../src/model/sub-flow-state.builder";
-import {EventBuilder, EventsBuilder, EventStateBuilder, OnEventBuilder, RepeatBuilder} from '../../src';
 
 
 describe("checkcarvitals workflow example", () => {

spec/examples/parallel.json

@@ -0,0 +1,25 @@
+{
+  "id": "parallelexec",
+  "version": "1.0",
+  "name": "Parallel Execution Workflow",
+  "description": "Executes two branches in parallel",
+  "start": "ParallelExec",
+  "states":[
+    {
+      "name": "ParallelExec",
+      "type": "parallel",
+      "completionType": "and",
+      "branches": [
+        {
+          "name": "ShortDelayBranch",
+          "workflowId": "shortdelayworkflowid"
+        },
+        {
+          "name": "LongDelayBranch",
+          "workflowId": "longdelayworkflowid"
+        }
+      ],
+      "end": true
+    }
+  ]
+}

spec/examples/parallel.spec.ts

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2021-Present The Serverless Workflow Specification Authors
+ * <p>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+import * as fs from "fs";
+import {BranchBuilder, ParallelStateBuilder, WorkflowBuilder} from '../../src';
+
+
+describe("parallel workflow example", () => {
+	
+	
+	it('should generate Workflow object', function () {
+		
+		const workflow = new WorkflowBuilder()
+			.withId("parallelexec")
+			.withVersion("1.0")
+			.withName("Parallel Execution Workflow")
+			.withDescription("Executes two branches in parallel")
+			.withStart("ParallelExec")
+			.withStates([
+				new ParallelStateBuilder()
+					.withName("ParallelExec")
+					.withCompletionType("and")
+					.withBranches([
+						new BranchBuilder()
+							.withName("ShortDelayBranch")
+							.withWorkflowId("shortdelayworkflowid")
+							.build(),
+						new BranchBuilder()
+							.withName("LongDelayBranch")
+							.withWorkflowId("longdelayworkflowid")
+							.build(),
+					])
+					.withEnd(true)
+					.build(),
+			])
+			.build();
+		
+		
+		const expected = JSON.parse(fs.readFileSync("./spec/examples/parallel.json")
+			.toLocaleString()) as any;
+		expect(workflow).toEqual(expected);
+		
+	});
+	
+	
+});

src/index.ts

@@ -19,6 +19,7 @@ export {BaseWorkflow} from "./base-workflow";
 
 export {ActionBuilder} from "./model/action.builder";
 export {ActionDataFilterBuilder} from "./model/action-data-filter.builder";
+export {BranchBuilder} from "./model/branch.builder";
 export {CronDefBuilder} from "./model/cron-def.builder";
 export {DelayStateBuilder} from "./model/delay-state.builder";
 export {DatabasedSwitchBuilder} from "./model/databased-switch.builder";
@@ -38,6 +39,7 @@ export {MetadataBuilder} from "./model/metadata.builder";
 export {OnEventBuilder} from "./model/on-event.builder";
 export {OnErrorBuilder} from "./model/on-error.builder";
 export {OperationStateBuilder} from "./model/operation-state.builder";
+export {ParallelStateBuilder} from './model/parallel-state.builder';
 export {ProduceEventDefBuilder} from "./model/produce-event-def.builder";
 export {RepeatBuilder} from "./model/repeat.builder";
 export {ScheduleBuilder} from "./model/schedule.builder";

src/model/branch.builder.ts

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2021-Present The Serverless Workflow Specification Authors
+ * <p>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+import {Branch} from './types';
+
+export class BranchBuilder {
+	// @ts-ignore
+	private model: Branch = {};
+	
+	withName(value: string): BranchBuilder {
+		this.model.name = value;
+		return this;
+		
+	}
+	
+	withWorkflowId(value: string): BranchBuilder {
+		this.model.workflowId = value;
+		return this;
+		
+	}
+	
+	build(): Branch {
+		return this.model;
+		
+	}
+}

src/model/operation-state.builder.ts

@@ -18,50 +18,52 @@ import {OnErrors, OperationState, Transition} from "./workflow";
 import {ActionModeType, Actions, End, StateDataFilter} from "./types";
 
 export class OperationStateBuilder {
-
-    private model: OperationState = {
-        type: "operation"
-    }
-
-    withName(value: string): OperationStateBuilder {
-        this.model.name = value;
-        return this;
-
-    }
-
-
-    withActionMode(value: ActionModeType): OperationStateBuilder {
-        this.model.actionMode = value;
-        return this;
-
-    }
-
-    withEnd(value: End): OperationStateBuilder {
-        this.model.end = value;
-        return this;
-    }
-
-    withActions(value: Actions): OperationStateBuilder {
-        this.model.actions = value;
-        return this;
-    }
-
-    withTransition(value: Transition): OperationStateBuilder {
-        this.model.transition = value;
-        return this;
-        
-    }
+	
+	private model: OperationState = {
+		type: "operation",
+	};
+	
+	withName(value: string): OperationStateBuilder {
+		this.model.name = value;
+		return this;
+		
+	}
+	
+	
+	withActionMode(value: ActionModeType): OperationStateBuilder {
+		this.model.actionMode = value;
+		return this;
+		
+	}
+	
+	withEnd(value: End): OperationStateBuilder {
+		this.model.end = value;
+		return this;
+	}
+	
+	withActions(value: Actions): OperationStateBuilder {
+		this.model.actions = value;
+		return this;
+	}
+	
+	withTransition(value: Transition): OperationStateBuilder {
+		this.model.transition = value;
+		return this;
+		
+	}
+	
 	withStateDataFilter(value: StateDataFilter): OperationStateBuilder {
 		this.model.stateDataFilter = value;
 		return this;
 	}
-    withOnErrors(value: OnErrors): OperationStateBuilder {
-        this.model.onErrors = value;
-        return this;
-    }
-
-    build(): OperationState {
-        return this.model;
-    }
-    
+	
+	withOnErrors(value: OnErrors): OperationStateBuilder {
+		this.model.onErrors = value;
+		return this;
+	}
+	
+	build(): OperationState {
+		return this.model;
+	}
+	
 }

src/model/parallel-state.builder.ts

@@ -0,0 +1,54 @@
+/*
+ * Copyright 2021-Present The Serverless Workflow Specification Authors
+ * <p>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+import {ParallelState} from './workflow';
+import {Branches, CompletionType, End} from './types';
+
+export class ParallelStateBuilder {
+	private model: ParallelState = {
+		type: "parallel",
+	};
+	
+	
+	withName(value: string): ParallelStateBuilder {
+		this.model.name = value;
+		return this;
+		
+	}
+	
+	withCompletionType(value: CompletionType): ParallelStateBuilder {
+		this.model.completionType = value;
+		return this;
+		
+	}
+	
+	withBranches(value: Branches): ParallelStateBuilder {
+		this.model.branches = value;
+		return this;
+	}
+	
+	withEnd(value: End): ParallelStateBuilder {
+		this.model.end = value;
+		return this;
+		
+	}
+	
+	build(): ParallelState {
+		return this.model;
+	}
+	
+	
+}

src/model/types.ts

@@ -466,3 +466,37 @@ export interface TransitionDataCondition {
 	 */
 	metadata?: Metadata;
 }
+
+
+
+export type Branch =
+	{
+		/**
+		 * Branch name
+		 */
+		name: string;
+		/**
+		 * Actions to be executed in this branch
+		 */
+		actions?: Action[];
+		/**
+		 * Unique Id of a workflow to be executed in this branch
+		 */
+		workflowId: string;
+	} | {
+	/**
+	 * Branch name
+	 */
+	name: string;
+	/**
+	 * Actions to be executed in this branch
+	 */
+	actions: Action[];
+	/**
+	 * Unique Id of a workflow to be executed in this branch
+	 */
+	workflowId?: string;
+};
+export type Branches = Branch[];
+
+export type CompletionType = "and" | "xor" | "n_of_m";