feat(Sdk): Replaced all single task properties (for/do, try, try/catch/do, ...) by maps that guarantee proper ordering

feat(Sdk): Removed the CompositeTaskDefinition and replace it with both DoTaskDefinition and ForkTaskDefinition

Signed-off-by: Charles d'Avernas <charles.davernas@neuroglia.io>

Author: cdavernas

src/ServerlessWorkflow.Sdk.Builders/CompositeTaskDefinitionBuilder.cs

@@ -0,0 +1,48 @@
+// Copyright © 2024-Present The Serverless Workflow Specification Authors
+//
+// 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
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// 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.
+
+namespace ServerlessWorkflow.Sdk.Builders;
+
+/// <summary>
+/// Represents the default implementation of the <see cref="IDoTaskDefinitionBuilder"/> interface
+/// </summary>
+public class DoTaskDefinitionBuilder
+    : TaskDefinitionBuilder<DoTaskDefinition>, IDoTaskDefinitionBuilder
+{
+
+    /// <summary>
+    /// Gets/sets a name/definition mapping of the tasks to execute sequentially, if any
+    /// </summary>
+    protected Map<string, TaskDefinition>? Tasks { get; set; }
+
+    /// <inheritdoc/>
+    public virtual IDoTaskDefinitionBuilder Do(Action<ITaskDefinitionMapBuilder> setup)
+    {
+        ArgumentNullException.ThrowIfNull(setup);
+        var builder = new TaskDefinitionMapBuilder();
+        setup(builder);
+        this.Tasks = builder.Build();
+        return this;
+    }
+
+    /// <inheritdoc/>
+    public override DoTaskDefinition Build()
+    {
+        if (this.Tasks == null || this.Tasks.Count < 2) throw new NullReferenceException("The execution strategy must define at least two subtasks");
+        return new()
+        {
+            Do = this.Tasks
+        };
+    }
+
+}

src/ServerlessWorkflow.Sdk.Builders/DoTaskDefinitionBuilder.cs

@@ -53,7 +53,7 @@ public class ErrorCatcherDefinitionBuilder
     /// <summary>
     /// Gets/sets the definition of the task to run when catching an error
     /// </summary>
-    protected TaskDefinition? RetryDo { get; set; }
+    protected Map<string, TaskDefinition>? RetryDo { get; set; }
 
     /// <inheritdoc/>
     public virtual IErrorCatcherDefinitionBuilder Errors(ErrorFilterDefinition filter)
@@ -117,10 +117,11 @@ public virtual IErrorCatcherDefinitionBuilder Retry(Action<IRetryPolicyDefinitio
     }
 
     /// <inheritdoc/>
-    public virtual IErrorCatcherDefinitionBuilder Do(Action<IGenericTaskDefinitionBuilder> setup)
+    public IErrorCatcherDefinitionBuilder Do(Action<ITaskDefinitionMapBuilder> setup)
     {
         ArgumentNullException.ThrowIfNull(setup);
-        var builder = new GenericTaskDefinitionBuilder();
+        var builder = new TaskDefinitionMapBuilder();
+        setup(builder);
         this.RetryDo = builder.Build();
         return this;
     }

src/ServerlessWorkflow.Sdk.Builders/ErrorCatcherDefinitionBuilder.cs

@@ -33,12 +33,12 @@ public class ExtensionDefinitionBuilder
     /// <summary>
     /// Gets/sets the definition of the task to run before the extended one
     /// </summary>
-    protected TaskDefinition? BeforeTask { get; set; }
+    protected Map<string, TaskDefinition>? BeforeTasks { get; set; }
 
     /// <summary>
     /// Gets/sets the definition of the task to run after the extended one
     /// </summary>
-    protected TaskDefinition? AfterTask { get; set; }
+    protected Map<string, TaskDefinition>? AfterTasks { get; set; }
 
     /// <inheritdoc/>
     public virtual IExtensionDefinitionBuilder Extend(string taskType)
@@ -57,22 +57,22 @@ public virtual IExtensionDefinitionBuilder When(string when)
     }
 
     /// <inheritdoc/>
-    public virtual IExtensionDefinitionBuilder Before(Action<IGenericTaskDefinitionBuilder> setup)
+    public virtual IExtensionDefinitionBuilder Before(Action<ITaskDefinitionMapBuilder> setup)
     {
         ArgumentNullException.ThrowIfNull(setup);
-        var builder = new GenericTaskDefinitionBuilder();
+        var builder = new TaskDefinitionMapBuilder();
         setup(builder);
-        this.BeforeTask = builder.Build();
+        this.BeforeTasks = builder.Build();
         return this;
     }
 
     /// <inheritdoc/>
-    public virtual IExtensionDefinitionBuilder After(Action<IGenericTaskDefinitionBuilder> setup)
+    public virtual IExtensionDefinitionBuilder After(Action<ITaskDefinitionMapBuilder> setup)
     {
         ArgumentNullException.ThrowIfNull(setup);
-        var builder = new GenericTaskDefinitionBuilder();
+        var builder = new TaskDefinitionMapBuilder();
         setup(builder);
-        this.AfterTask = builder.Build();
+        this.AfterTasks = builder.Build();
         return this;
     }
 
@@ -84,8 +84,8 @@ public virtual ExtensionDefinition Build()
         {
             Extend = this.TaskType,
             When = this.WhenExpression,
-            Before = this.BeforeTask,
-            After = this.AfterTask
+            Before = this.BeforeTasks,
+            After = this.AfterTasks
         };
     }
 

src/ServerlessWorkflow.Sdk.Builders/ExtensionDefinitionBuilder.cs

@@ -36,9 +36,9 @@ public class ForTaskDefinitionBuilder
     protected virtual string? AtVariableName { get; set; }
 
     /// <summary>
-    /// Gets an <see cref="Action{T}"/> used to setup the task to perform for each iteration
+    /// Gets/sets a name/definition map of the tasks to perform for each element in the collection to enumerate
     /// </summary>
-    protected virtual Action<IGenericTaskDefinitionBuilder>? DoSetup { get; set; }
+    protected virtual Map<string, TaskDefinition>? Tasks { get; set; }
 
     /// <inheritdoc/>
     public virtual IForTaskDefinitionBuilder Each(string variableName)
@@ -65,10 +65,12 @@ public virtual IForTaskDefinitionBuilder At(string variableName)
     }
 
     /// <inheritdoc/>
-    public virtual IForTaskDefinitionBuilder Do(Action<IGenericTaskDefinitionBuilder> setup)
+    public virtual IForTaskDefinitionBuilder Do(Action<ITaskDefinitionMapBuilder> setup)
     {
         ArgumentNullException.ThrowIfNull(setup);
-        this.DoSetup = setup;
+        var builder = new TaskDefinitionMapBuilder();
+        setup(builder);
+        this.Tasks = builder.Build();
         return this;
     }
 
@@ -77,9 +79,7 @@ public override ForTaskDefinition Build()
     {
         if (string.IsNullOrWhiteSpace(this.EachVariableName)) throw new NullReferenceException("The variable name used to store the iterated items must be set");
         if (string.IsNullOrWhiteSpace(this.InExpression)) throw new NullReferenceException("The runtime expression used to resolve the collection to iterate must be set");
-        if (this.DoSetup == null) throw new NullReferenceException("The task to perform at each iteration must be set");
-        var taskBuilder = new GenericTaskDefinitionBuilder();
-        this.DoSetup(taskBuilder);
+        if (this.Tasks == null || this.Tasks.Count < 1) throw new NullReferenceException("The task to perform at each iteration must be set");
         return new()
         {
             For = new()
@@ -88,7 +88,7 @@ public override ForTaskDefinition Build()
                 In = this.InExpression,
                 At = this.AtVariableName
             },
-            Do = taskBuilder.Build()
+            Do = this.Tasks
         };
     }
 

src/ServerlessWorkflow.Sdk.Builders/ForTaskDefinitionBuilder.cs

@@ -0,0 +1,64 @@
+// Copyright © 2024-Present The Serverless Workflow Specification Authors
+//
+// 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
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// 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.
+
+namespace ServerlessWorkflow.Sdk.Builders;
+
+/// <summary>
+/// Represents the default implementation of the <see cref="IForkTaskDefinitionBuilder"/> interface
+/// </summary>
+public class ForkTaskDefinitionBuilder
+    : TaskDefinitionBuilder<ForkTaskDefinition>, IForkTaskDefinitionBuilder
+{
+
+    /// <summary>
+    /// Gets/sets a name/definition mapping of the tasks to execute concurrently, if any
+    /// </summary>
+    protected Map<string, TaskDefinition>? Tasks { get; set; }
+
+    /// <summary>
+    /// Gets/sets a boolean indicating whether or not the task to execute concurrently should compete each other
+    /// </summary>
+    protected bool ShouldCompete { get; set; }
+
+    /// <inheritdoc/>
+    public virtual IForkTaskDefinitionBuilder Branch(Action<ITaskDefinitionMapBuilder> setup)
+    {
+        ArgumentNullException.ThrowIfNull(setup);
+        var builder = new TaskDefinitionMapBuilder();
+        setup(builder);
+        this.Tasks = builder.Build();
+        return this;
+    }
+
+    /// <inheritdoc/>
+    public virtual IForkTaskDefinitionBuilder Compete()
+    {
+        this.ShouldCompete = true;
+        return this;
+    }
+
+    /// <inheritdoc/>
+    public override ForkTaskDefinition Build()
+    {
+        if (this.Tasks == null || this.Tasks.Count < 2) throw new NullReferenceException("The execution strategy must define at least two subtasks");
+        return new()
+        {
+            Fork = new() 
+            {
+                Branches = this.Tasks,
+                Compete = this.ShouldCompete
+            }
+        };
+    }
+
+}

src/ServerlessWorkflow.Sdk.Builders/ForkTaskDefinitionBuilder.cs

@@ -33,6 +33,15 @@ public virtual ICallTaskDefinitionBuilder Call(string? function = null)
         return builder;
     }
 
+    /// <inheritdoc/>
+    public virtual IDoTaskDefinitionBuilder Do(Action<ITaskDefinitionMapBuilder> setup)
+    {
+        var builder = new DoTaskDefinitionBuilder();
+        builder.Do(setup);
+        this.Builder = builder;
+        return builder;
+    }
+
     /// <inheritdoc/>
     public virtual IEmitTaskDefinitionBuilder Emit(EventDefinition e)
     {
@@ -60,6 +69,14 @@ public virtual IForTaskDefinitionBuilder For()
         return builder;
     }
 
+    /// <inheritdoc/>
+    public virtual IForkTaskDefinitionBuilder Fork()
+    {
+        var builder = new ForkTaskDefinitionBuilder();
+        this.Builder = builder;
+        return builder;
+    }
+
     /// <inheritdoc/>
     public virtual IListenTaskDefinitionBuilder Listen()
     {
@@ -69,9 +86,9 @@ public virtual IListenTaskDefinitionBuilder Listen()
     }
 
     /// <inheritdoc/>
-    public virtual ICompositeTaskDefinitionBuilder Execute()
+    public virtual IDoTaskDefinitionBuilder Execute()
     {
-        var builder = new CompositeTaskDefinitionBuilder();
+        var builder = new DoTaskDefinitionBuilder();
         this.Builder = builder;
         return builder;
     }

src/ServerlessWorkflow.Sdk.Builders/GenericTaskDefinitionBuilder.cs

@@ -14,12 +14,17 @@
 namespace ServerlessWorkflow.Sdk.Builders;
 
 /// <summary>
-/// Defines the fundamentals of a service used to build <see cref="CompositeTaskDefinition"/>s
+/// Defines the fundamentals of a service used to build <see cref="DoTaskDefinition"/>s
 /// </summary>
-public interface ICompositeTaskDefinitionBuilder
-    : ITaskDefinitionBuilder<CompositeTaskDefinition>, ITaskExecutionStrategyDefinitionBuilder<ICompositeTaskDefinitionBuilder>
+public interface IDoTaskDefinitionBuilder
+    : ITaskDefinitionBuilder<DoTaskDefinition>
 {
 
-
+    /// <summary>
+    /// Configures the tasks to perform sequentially
+    /// </summary>
+    /// <param name="setup">An <see cref="Action{T}"/> used to setup the tasks to perform sequentially</param>
+    /// <returns>The configured <see cref="IDoTaskDefinitionBuilder"/></returns>
+    IDoTaskDefinitionBuilder Do(Action<ITaskDefinitionMapBuilder> setup);
 
 }