fix(Builders): Fix the IContainerProcessDefinitionBuilder and default implementation to allow configuring the container name

cdavernas · cdavernas · commit afc5c84e0d54 · 2025-01-14T17:00:41.000+01:00
fix(Builders): Fix the IListenerTargetDefinitionBuilder and default implementation to allow configuring the `until`clause
fix(Core): Minor fixes and improvements

Signed-off-by: Charles d'Avernas &lt;charles.davernas@neuroglia.io&gt;
diff --git a/src/ServerlessWorkflow.Sdk.Builders/ContainerProcessDefinitionBuilder.cs b/src/ServerlessWorkflow.Sdk.Builders/ContainerProcessDefinitionBuilder.cs
@@ -28,6 +28,11 @@ public class ContainerProcessDefinitionBuilder
     /// </summary>
     protected virtual string? Image { get; set; }
 
+    /// <summary>
+    /// Gets/sets the name of the container to run
+    /// </summary>
+    protected virtual string? Name { get; set; }
+
     /// <summary>
     /// Gets/sets the command, if any, to execute on the container
     /// </summary>
@@ -56,6 +61,14 @@ public virtual IContainerProcessDefinitionBuilder WithImage(string image)
         return this;
     }
 
+    /// <inheritdoc/>
+    public virtual IContainerProcessDefinitionBuilder WithName(string name)
+    {
+        ArgumentException.ThrowIfNullOrWhiteSpace(name);
+        this.Name = name;
+        return this;
+    }
+
     /// <inheritdoc/>
     public virtual IContainerProcessDefinitionBuilder WithCommand(string command)
     {
@@ -122,6 +135,7 @@ public override ContainerProcessDefinition Build()
         return new()
         {
             Image = this.Image,
+            Name = this.Name,
             Command = this.Command,
             Ports = this.Ports,
             Volumes = this.Volumes,
diff --git a/src/ServerlessWorkflow.Sdk.Builders/Interfaces/IContainerProcessDefinitionBuilder.cs b/src/ServerlessWorkflow.Sdk.Builders/Interfaces/IContainerProcessDefinitionBuilder.cs
@@ -29,6 +29,13 @@ public interface IContainerProcessDefinitionBuilder
     /// <returns>The configured <see cref="IContainerProcessDefinitionBuilder"/></returns>
     IContainerProcessDefinitionBuilder WithImage(string image);
 
+    /// <summary>
+    /// Configures the container to use the specified name
+    /// </summary>
+    /// <param name="name">The container's name</param>
+    /// <returns>The configured <see cref="IContainerProcessDefinitionBuilder"/></returns>
+    IContainerProcessDefinitionBuilder WithName(string name);
+
     /// <summary>
     /// Configures the command, if any, to execute on the container
     /// </summary>
diff --git a/src/ServerlessWorkflow.Sdk.Builders/Interfaces/IListenerTargetDefinitionBuilder.cs b/src/ServerlessWorkflow.Sdk.Builders/Interfaces/IListenerTargetDefinitionBuilder.cs
@@ -37,6 +37,18 @@ public interface IListenerTargetDefinitionBuilder
     /// <returns>A new <see cref="IEventFilterDefinitionBuilder"/></returns>
     IEventFilterDefinitionBuilder One();
 
+    /// <summary>
+    /// Configures the task to listen to any events until the specified condition expression matches
+    /// </summary>
+    /// <param name="expression">A runtime expression that represents the condition that must match for the task to stop consuming events</param>
+    void Until(string expression);
+
+    /// <summary>
+    /// Configures the task to listen to any events until the specified events are consumed
+    /// </summary>
+    /// <param name="setup">An <see cref="Action{T}"/> used to configure the events to consume for the task to stop consuming events</param>
+    void Until(Action<IListenerTargetDefinitionBuilder> setup);
+
     /// <summary>
     /// Builds the configured <see cref="EventConsumptionStrategyDefinition"/>
     /// </summary>
diff --git a/src/ServerlessWorkflow.Sdk.Builders/ListenerTargetDefinitionBuilder.cs b/src/ServerlessWorkflow.Sdk.Builders/ListenerTargetDefinitionBuilder.cs
@@ -35,6 +35,16 @@ public class ListenerTargetDefinitionBuilder
     /// </summary>
     protected IEventFilterDefinitionBuilder? SingleEvent { get; set; }
 
+    /// <summary>
+    /// Gets the runtime expression that represents the condition that must match for the task to stop consuming events
+    /// </summary>
+    protected string? UntilExpression { get; private set; }
+
+    /// <summary>
+    /// Gets the strategy used to configure the events to consume for the task to stop consuming events
+    /// </summary>
+    protected EventConsumptionStrategyDefinition? UntilEvents { get; private set; }
+
     /// <inheritdoc/>
     public virtual IEventFilterDefinitionCollectionBuilder All()
     {
@@ -56,6 +66,24 @@ public virtual IEventFilterDefinitionBuilder One()
         return this.SingleEvent;
     }
 
+    /// <inheritdoc/>
+    public virtual void Until(string expression)
+    {
+        ArgumentException.ThrowIfNullOrWhiteSpace(expression);
+        if (this.AnyEvents == null) throw new Exception("The until clause can only be specified when the strategy is used to consume any events");
+        this.UntilExpression = expression;
+    }
+
+    /// <inheritdoc/>
+    public virtual void Until(Action<IListenerTargetDefinitionBuilder> setup)
+    {
+        ArgumentNullException.ThrowIfNull(setup);
+        if (this.AnyEvents == null) throw new Exception("The until clause can only be specified when the strategy is used to consume any events");
+        var builder = new ListenerTargetDefinitionBuilder();
+        setup(builder);
+        this.UntilEvents = builder.Build();
+    }
+
     /// <inheritdoc/>
     public virtual EventConsumptionStrategyDefinition Build()
     {
@@ -64,7 +92,9 @@ public virtual EventConsumptionStrategyDefinition Build()
         {
             All = this.AllEvents?.Build(),
             Any = this.AnyEvents?.Build(),
-            One = this.SingleEvent?.Build()
+            One = this.SingleEvent?.Build(),
+            UntilExpression = this.UntilExpression,
+            Until = this.UntilEvents
         };
     }
 
diff --git a/src/ServerlessWorkflow.Sdk/Models/BranchingDefinition.cs b/src/ServerlessWorkflow.Sdk/Models/BranchingDefinition.cs
@@ -11,7 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-namespace ServerlessWorkflow.Sdk.Models.Tasks;
+namespace ServerlessWorkflow.Sdk.Models;
 
 /// <summary>
 /// Represents an object used to configure branches to perform concurrently
diff --git a/src/ServerlessWorkflow.Sdk/Models/ForLoopDefinition.cs b/src/ServerlessWorkflow.Sdk/Models/ForLoopDefinition.cs
@@ -20,7 +20,7 @@ namespace ServerlessWorkflow.Sdk.Models;
 public record ForLoopDefinition
 {
 
-     /// <summary>
+    /// <summary>
     /// Gets/sets the name of the variable that represents each element in the collection during iteration
     /// </summary>
     [Required]
diff --git a/src/ServerlessWorkflow.Sdk/Models/RaiseErrorDefinition.cs b/src/ServerlessWorkflow.Sdk/Models/RaiseErrorDefinition.cs
@@ -49,7 +49,7 @@ public virtual string? ErrorReference
     }
 
     /// <summary>
-    /// Gets/sets the endpoint at which to get the defined resource
+    /// Gets/sets the error to raise
     /// </summary>
     [Required]
     [DataMember(Name = "error", Order = 1), JsonInclude, JsonPropertyName("error"), JsonPropertyOrder(1), YamlMember(Alias = "error", Order = 1)]

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ namespace ServerlessWorkflow.Sdk.Models;`
`20`	`20`	`public record ForLoopDefinition`
`21`	`21`	`{`
`22`	`22`
`23`		`- /// <summary>`
	`23`	`+ /// <summary>`
`24`	`24`	`/// Gets/sets the name of the variable that represents each element in the collection during iteration`
`25`	`25`	`/// </summary>`
`26`	`26`	`[Required]`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ public virtual string? ErrorReference`
`49`	`49`	`}`
`50`	`50`
`51`	`51`	`/// <summary>`
`52`		`- /// Gets/sets the endpoint at which to get the defined resource`
	`52`	`+ /// Gets/sets the error to raise`
`53`	`53`	`/// </summary>`
`54`	`54`	`[Required]`
`55`	`55`	`[DataMember(Name = "error", Order = 1), JsonInclude, JsonPropertyName("error"), JsonPropertyOrder(1), YamlMember(Alias = "error", Order = 1)]`