< Summary

Information
Class: Elsa.Workflows.Builders.WorkflowBuilder
Assembly: Elsa.Workflows.Core
File(s): /home/runner/work/elsa-core/elsa-core/src/modules/Elsa.Workflows.Core/Builders/WorkflowBuilder.cs
Line coverage
74%
Covered lines: 89
Uncovered lines: 31
Coverable lines: 120
Total lines: 302
Line coverage: 74.1%
Branch coverage
69%
Covered branches: 18
Total branches: 26
Branch coverage: 69.2%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
.ctor(...)100%11100%
get_Id()100%11100%
get_DefinitionId()100%11100%
get_TenantId()100%11100%
get_Version()100%11100%
get_Name()100%11100%
get_Description()100%11100%
get_IsReadonly()100%11100%
get_IsSystem()100%11100%
get_Root()100%11100%
get_Variables()100%11100%
get_Inputs()100%11100%
get_Outputs()100%11100%
get_Outcomes()100%11100%
get_Result()100%11100%
get_CustomProperties()100%11100%
get_WorkflowOptions()100%11100%
WithDefinitionId(...)100%11100%
WithId(...)100%210%
WithTenantId(...)100%11100%
WithVariable()100%11100%
WithVariable(...)100%11100%
WithVariable(...)100%210%
WithVariable(...)100%11100%
WithVariable(...)100%210%
WithVariables(...)0%620%
WithInput(...)100%11100%
WithInput(...)100%22100%
WithInput(...)0%620%
WithInput(...)100%11100%
WithInput(...)100%210%
WithOutput(...)100%11100%
WithOutput(...)50%2287.5%
WithOutput(...)0%620%
WithOutput(...)100%11100%
WithOutput(...)100%11100%
WithCustomProperty(...)100%210%
WithActivationStrategyType()100%210%
AsReadonly()100%210%
AsSystemWorkflow()100%11100%
BuildWorkflowAsync()93.75%1616100%
BuildWorkflowAsync()100%11100%

File(s)

/home/runner/work/elsa-core/elsa-core/src/modules/Elsa.Workflows.Core/Builders/WorkflowBuilder.cs

#LineLine coverage
 1using Elsa.Extensions;
 2using Elsa.Workflows.Activities;
 3using Elsa.Workflows.Memory;
 4using Elsa.Workflows.Models;
 5
 6namespace Elsa.Workflows.Builders;
 7
 8/// <inheritdoc />
 37649public class WorkflowBuilder(IActivityVisitor activityVisitor, IIdentityGraphService identityGraphService, IActivityRegi
 10    : IWorkflowBuilder
 11{
 12    /// <inheritdoc />
 376913    public string? Id { get; set; }
 14
 15    /// <inheritdoc />
 1233716    public string? DefinitionId { get; set; }
 17
 18    /// <inheritdoc />
 391719    public string? TenantId { get; set; }
 20
 21    /// <inheritdoc />
 752922    public int Version { get; set; } = 1;
 23
 24    /// <inheritdoc />
 399325    public string? Name { get; set; }
 26
 27    /// <inheritdoc />
 376128    public string? Description { get; set; }
 29
 30    /// <inheritdoc />
 376131    public bool IsReadonly { get; set; }
 32
 33    /// <inheritdoc />
 381734    public bool IsSystem { get; set; }
 35
 36    /// <inheritdoc />
 752237    public IActivity? Root { get; set; }
 38
 39    /// <inheritdoc />
 876540    public ICollection<Variable> Variables { get; set; } = new List<Variable>();
 41
 42    /// <inheritdoc />
 792243    public ICollection<InputDefinition> Inputs { get; set; } = new List<InputDefinition>();
 44
 45    /// <inheritdoc />
 764046    public ICollection<OutputDefinition> Outputs { get; set; } = new List<OutputDefinition>();
 47
 48    /// <inheritdoc />
 752549    public ICollection<string> Outcomes { get; set; } = new List<string>();
 50
 51    /// <inheritdoc />
 1504752    public Variable? Result { get; set; } = new();
 53
 54    /// <inheritdoc />
 752555    public IDictionary<string, object> CustomProperties { get; set; } = new Dictionary<string, object>();
 56
 57    /// <inheritdoc />
 781158    public WorkflowOptions WorkflowOptions { get; } = new();
 59
 60    /// <inheritdoc />
 61    public IWorkflowBuilder WithDefinitionId(string definitionId)
 62    {
 351863        DefinitionId = definitionId;
 351864        return this;
 65    }
 66
 67    public IWorkflowBuilder WithId(string id)
 68    {
 069        Id = id;
 070        return this;
 71    }
 72
 73    /// <inheritdoc />
 74    public IWorkflowBuilder WithTenantId(string tenantId)
 75    {
 7876        TenantId = tenantId;
 7877        return this;
 78    }
 79
 80    /// <inheritdoc />
 81    [Obsolete("Use the overload that takes a name instead. This overload will be removed in a future version.")]
 82    public Variable<T> WithVariable<T>()
 83    {
 78584        var variable = new Variable<T>(null!, default!);
 78585        Variables.Add(variable);
 78586        variable.WithWorkflowStorage();
 78587        variable.Id = null!; // This ensures that a deterministic ID is assigned by the builder.
 78588        return variable;
 89    }
 90
 91    /// <inheritdoc />
 92    public Variable<T> WithVariable<T>(string name, T value)
 93    {
 39694        var variable = new Variable<T>(name, value);
 39695        Variables.Add(variable);
 39696        variable.WithWorkflowStorage();
 39697        return variable;
 98    }
 99
 100    /// <inheritdoc />
 101    [Obsolete("Use the overload that takes a name instead. This overload will be removed in a future version.")]
 102    public Variable<T> WithVariable<T>(T value)
 103    {
 0104        var variable = WithVariable<T>();
 0105        variable.Value = value;
 0106        return variable;
 107    }
 108
 109    /// <inheritdoc />
 110    public IWorkflowBuilder WithVariable<T>(Variable<T> variable)
 111    {
 57112        Variables.Add(variable);
 57113        return this;
 114    }
 115
 116    /// <inheritdoc />
 117    public IWorkflowBuilder WithVariable(Variable variable)
 118    {
 0119        Variables.Add(variable);
 0120        return this;
 121    }
 122
 123    /// <inheritdoc />
 124    public IWorkflowBuilder WithVariables(params Variable[] variables)
 125    {
 0126        foreach (var variable in variables)
 0127            Variables.Add(variable);
 0128        return this;
 129    }
 130
 131    /// <inheritdoc />
 132    public InputDefinition WithInput<T>(string name, string? description = default)
 133    {
 397134        return WithInput(name, typeof(T), description);
 135    }
 136
 137    /// <inheritdoc />
 138    public InputDefinition WithInput(string name, Type type, string? description = default)
 139    {
 397140        return WithInput(inputDefinition =>
 397141        {
 397142            inputDefinition.Name = name;
 397143            inputDefinition.Type = type;
 397144
 397145            if (description != null)
 56146                inputDefinition.Description = description;
 794147        });
 148    }
 149
 150    /// <inheritdoc />
 151    public InputDefinition WithInput(string name, Type type, Action<InputDefinition>? setup = default)
 152    {
 0153        return WithInput(inputDefinition =>
 0154        {
 0155            inputDefinition.Name = name;
 0156            inputDefinition.Type = type;
 0157            setup?.Invoke(inputDefinition);
 0158        });
 159    }
 160
 161    /// <inheritdoc />
 162    public InputDefinition WithInput(Action<InputDefinition> setup)
 163    {
 397164        var inputDefinition = new InputDefinition();
 397165        setup(inputDefinition);
 397166        Inputs.Add(inputDefinition);
 397167        return inputDefinition;
 168    }
 169
 170    /// <inheritdoc />
 171    public IWorkflowBuilder WithInput(InputDefinition inputDefinition)
 172    {
 0173        Inputs.Add(inputDefinition);
 0174        return this;
 175    }
 176
 177    public OutputDefinition WithOutput<T>(string name, string? description = default)
 178    {
 115179        return WithOutput(name, typeof(T), description);
 180    }
 181
 182    public OutputDefinition WithOutput(string name, Type type, string? description = default)
 183    {
 115184        return WithOutput(outputDefinition =>
 115185        {
 115186            outputDefinition.Name = name;
 115187            outputDefinition.Type = type;
 115188
 115189            if (description != null)
 0190                outputDefinition.Description = description;
 230191        });
 192    }
 193
 194    public OutputDefinition WithOutput(string name, Type type, Action<OutputDefinition>? setup = default)
 195    {
 0196        return WithOutput(outputDefinition =>
 0197        {
 0198            outputDefinition.Name = name;
 0199            outputDefinition.Type = type;
 0200            setup?.Invoke(outputDefinition);
 0201        });
 202    }
 203
 204    public OutputDefinition WithOutput(Action<OutputDefinition> setup)
 205    {
 115206        var outputDefinition = new OutputDefinition();
 115207        setup(outputDefinition);
 115208        return WithOutput(outputDefinition);
 209    }
 210
 211    public OutputDefinition WithOutput(OutputDefinition outputDefinition)
 212    {
 115213        Outputs.Add(outputDefinition);
 115214        return outputDefinition;
 215    }
 216
 217    /// <inheritdoc />
 218    public IWorkflowBuilder WithCustomProperty(string name, object value)
 219    {
 0220        CustomProperties[name] = value;
 0221        return this;
 222    }
 223
 224    /// <inheritdoc />
 225    public IWorkflowBuilder WithActivationStrategyType<T>() where T : IWorkflowActivationStrategy
 226    {
 0227        WorkflowOptions.ActivationStrategyType = typeof(T);
 0228        return this;
 229    }
 230
 231    /// <summary>
 232    /// Marks the workflow as readonly.
 233    /// </summary>
 234    public IWorkflowBuilder AsReadonly()
 235    {
 0236        IsReadonly = true;
 0237        return this;
 238    }
 239
 240    /// <summary>
 241    ///   Marks the workflow as a system workflow.
 242    ///   System workflows are not visible in the UI by default and are not meant to be modified by users.
 243    /// </summary>
 244    public IWorkflowBuilder AsSystemWorkflow()
 245    {
 56246        IsSystem = true;
 56247        return this;
 248    }
 249
 250    /// <inheritdoc />
 251    public async Task<Workflow> BuildWorkflowAsync(CancellationToken cancellationToken = default)
 252    {
 3761253        var definitionId = string.IsNullOrEmpty(DefinitionId) ? string.Empty : DefinitionId;
 3761254        var id = string.IsNullOrEmpty(Id) ? string.Empty : Id;
 3761255        var tenantId = string.IsNullOrEmpty(TenantId) ? null : TenantId;
 3761256        var root = Root ?? new Sequence();
 3761257        var identity = new WorkflowIdentity(definitionId, Version, id, tenantId);
 3761258        var publication = WorkflowPublication.LatestAndPublished;
 3761259        var name = string.IsNullOrEmpty(Name) ? definitionId : Name;
 3761260        var workflowMetadata = new WorkflowMetadata(name, Description);
 3761261        var workflow = new Workflow(identity, publication, workflowMetadata, WorkflowOptions, root, Variables, Inputs, O
 262
 263        // If a Result variable is defined, install it into the workflow, so we can capture the output into it.
 3761264        if (Result != null)
 265        {
 3761266            workflow.ResultVariable = Result;
 3761267            workflow.Result = new Output<object>(Result);
 268        }
 269
 3761270        var graph = await activityVisitor.VisitAsync(workflow, cancellationToken);
 3761271        var nodes = graph.Flatten().ToList();
 272
 273        // Register all activity types first. The identity graph service will need to know about all activity types.
 19230274        var distinctActivityTypes = nodes.Select(x => x.Activity.GetType()).Distinct().ToList();
 3761275        await activityRegistry.RegisterAsync(distinctActivityTypes, cancellationToken);
 276
 277        // Assign identities to all activities.
 3761278        await identityGraphService.AssignIdentitiesAsync(nodes);
 279
 280        // Give unnamed variables in each variable container a predictable name.
 26292281        var variableContainers = nodes.Where(x => x.Activity is IVariableContainer).Select(x => (IVariableContainer)x.Ac
 282
 21646283        foreach (var container in variableContainers)
 284        {
 7062285            var index = 0;
 8298286            var unnamedVariables = container.Variables.Where(x => string.IsNullOrWhiteSpace(x.Name)).ToList();
 287
 15804288            foreach (var unnamedVariable in unnamedVariables)
 840289                unnamedVariable.Name = $"Variable_{index++}";
 290        }
 291
 3761292        return workflow;
 3761293    }
 294
 295    /// <inheritdoc />
 296    public async Task<Workflow> BuildWorkflowAsync(IWorkflow workflowDefinition, CancellationToken cancellationToken = d
 297    {
 1346298        DefinitionId = workflowDefinition.GetType().Name;
 1346299        await workflowDefinition.BuildAsync(this, cancellationToken);
 1346300        return await BuildWorkflowAsync(cancellationToken);
 1346301    }
 302}
Generated by: ReportGenerator 5.5.11.0
09/26/2026 - 05:55:50
GitHub | reportgenerator.io

Methods/Properties

.ctor(Elsa.Workflows.IActivityVisitor,Elsa.Workflows.IIdentityGraphService,Elsa.Workflows.IActivityRegistry)
get_Id()
get_DefinitionId()
get_TenantId()
get_Version()
get_Name()
get_Description()
get_IsReadonly()
get_IsSystem()
get_Root()
get_Variables()
get_Inputs()
get_Outputs()
get_Outcomes()
get_Result()
get_CustomProperties()
get_WorkflowOptions()
WithDefinitionId(System.String)
WithId(System.String)
WithTenantId(System.String)
WithVariable()
WithVariable(System.String,T)
WithVariable(T)
WithVariable(Elsa.Workflows.Memory.Variable`1<T>)
WithVariable(Elsa.Workflows.Memory.Variable)
WithVariables(Elsa.Workflows.Memory.Variable[])
WithInput(System.String,System.String)
WithInput(System.String,System.Type,System.String)
WithInput(System.String,System.Type,System.Action`1<Elsa.Workflows.Models.InputDefinition>)
WithInput(System.Action`1<Elsa.Workflows.Models.InputDefinition>)
WithInput(Elsa.Workflows.Models.InputDefinition)
WithOutput(System.String,System.String)
WithOutput(System.String,System.Type,System.String)
WithOutput(System.String,System.Type,System.Action`1<Elsa.Workflows.Models.OutputDefinition>)
WithOutput(System.Action`1<Elsa.Workflows.Models.OutputDefinition>)
WithOutput(Elsa.Workflows.Models.OutputDefinition)
WithCustomProperty(System.String,System.Object)
WithActivationStrategyType()
AsReadonly()
AsSystemWorkflow()
BuildWorkflowAsync()
BuildWorkflowAsync()