< Summary

Information
Class: Elsa.Workflows.Features.WorkflowsFeature
Assembly: Elsa.Workflows.Core
File(s): /home/runner/work/elsa-core/elsa-core/src/modules/Elsa.Workflows.Core/Features/WorkflowsFeature.cs
Line coverage
92%
Covered lines: 119
Uncovered lines: 9
Coverable lines: 128
Total lines: 262
Line coverage: 92.9%
Branch coverage
N/A
Covered branches: 0
Total branches: 0
Branch coverage: N/A
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Metrics

File(s)

/home/runner/work/elsa-core/elsa-core/src/modules/Elsa.Workflows.Core/Features/WorkflowsFeature.cs

#LineLine coverage
 1using Elsa.Common;
 2using Elsa.Common.Features;
 3using Elsa.Common.Serialization;
 4using Elsa.Expressions.Features;
 5using Elsa.Extensions;
 6using Elsa.Features.Abstractions;
 7using Elsa.Features.Attributes;
 8using Elsa.Features.Services;
 9using Elsa.Workflows.ActivationValidators;
 10using Elsa.Workflows.Builders;
 11using Elsa.Workflows.CommitStates;
 12using Elsa.Workflows.IncidentStrategies;
 13using Elsa.Workflows.LogPersistence;
 14using Elsa.Workflows.LogPersistence.Strategies;
 15using Elsa.Workflows.Middleware.Activities;
 16using Elsa.Workflows.Middleware.Workflows;
 17using Elsa.Workflows.Pipelines.ActivityExecution;
 18using Elsa.Workflows.Pipelines.WorkflowExecution;
 19using Elsa.Workflows.PortResolvers;
 20using Elsa.Workflows.Serialization.Configurators;
 21using Elsa.Workflows.Serialization.Helpers;
 22using Elsa.Workflows.Serialization.Serializers;
 23using Elsa.Workflows.Services;
 24using Elsa.Workflows.UIHints.CheckList;
 25using Elsa.Workflows.UIHints.Dictionary;
 26using Elsa.Workflows.UIHints.Dropdown;
 27using Elsa.Workflows.UIHints.JsonEditor;
 28using Elsa.Workflows.UIHints.RadioList;
 29using Microsoft.Extensions.DependencyInjection;
 30
 31namespace Elsa.Workflows.Features;
 32
 33/// <summary>
 34/// Adds workflow services to the system.
 35/// </summary>
 36[DependsOn(typeof(SystemClockFeature))]
 37[DependsOn(typeof(ExpressionsFeature))]
 38[DependsOn(typeof(MediatorFeature))]
 39[DependsOn(typeof(DefaultFormattersFeature))]
 40[DependsOn(typeof(MultitenancyFeature))]
 41[DependsOn(typeof(CommitStrategiesFeature))]
 42public class WorkflowsFeature : FeatureBase
 43{
 44    /// <inheritdoc />
 12945    public WorkflowsFeature(IModule module) : base(module)
 46    {
 12947    }
 48
 49    /// <summary>
 50    /// A factory that instantiates a concrete <see cref="IStandardInStreamProvider"/>.
 51    /// </summary>
 25852    public Func<IServiceProvider, IStandardInStreamProvider> StandardInStreamProvider { get; set; } = _ => new StandardI
 53
 54    /// <summary>
 55    /// A factory that instantiates a concrete <see cref="IStandardOutStreamProvider"/>.
 56    /// </summary>
 75557    public Func<IServiceProvider, IStandardOutStreamProvider> StandardOutStreamProvider { get; set; } = _ => new Standar
 58
 59    /// <summary>
 60    /// A factory that instantiates a concrete <see cref="IIdentityGenerator"/>.
 61    /// </summary>
 38762    public Func<IServiceProvider, IIdentityGenerator> IdentityGenerator { get; set; } = sp => new RandomLongIdentityGene
 63
 64    /// <summary>
 65    /// A handler for committing workflow execution state.
 66    /// </summary>
 38767    public Func<IServiceProvider, ICommitStateHandler> CommitStateHandler { get; set; } = sp => new NoopCommitStateHandl
 68
 69    /// <summary>
 70    /// A factory that instantiates a concrete <see cref="ILoggerStateGenerator{WorkflowExecutionContext}"/>.
 71    /// </summary>
 38172    public Func<IServiceProvider, ILoggerStateGenerator<WorkflowExecutionContext>> WorkflowLoggerStateGenerator { get; s
 73
 74    /// <summary>
 75    /// A factory that instantiates a concrete <see cref="ILoggerStateGenerator{ActivityExecutionContext}"/>.
 76    /// </summary>
 38777    public Func<IServiceProvider, ILoggerStateGenerator<ActivityExecutionContext>> ActivityLoggerStateGenerator { get; s
 78
 79    /// <summary>
 80    /// A delegate to configure the <see cref="IWorkflowExecutionPipeline"/>.
 81    /// </summary>
 75982    public Action<IWorkflowExecutionPipelineBuilder> WorkflowExecutionPipeline { get; set; } = builder => builder
 12983        .UseExceptionHandling()
 12984        .UseDefaultActivityScheduler();
 85
 86    /// <summary>
 87    /// A delegate to configure the <see cref="IActivityExecutionPipeline"/>.
 88    /// </summary>
 75989    public Action<IActivityExecutionPipelineBuilder> ActivityExecutionPipeline { get; set; } = builder => builder.UseDef
 90
 91    /// <summary>
 92    /// Fluent method to set <see cref="StandardInStreamProvider"/>.
 93    /// </summary>
 94    public WorkflowsFeature WithStandardInStreamProvider(Func<IServiceProvider, IStandardInStreamProvider> provider)
 95    {
 096        StandardInStreamProvider = provider;
 097        return this;
 98    }
 99
 100    /// <summary>
 101    /// Fluent method to set <see cref="StandardOutStreamProvider"/>.
 102    /// </summary>
 103    public WorkflowsFeature WithStandardOutStreamProvider(Func<IServiceProvider, IStandardOutStreamProvider> provider)
 104    {
 243105        StandardOutStreamProvider = provider;
 243106        return this;
 107    }
 108
 109    /// <summary>
 110    /// Fluent method to set <see cref="IdentityGenerator"/>.
 111    /// </summary>
 112    public WorkflowsFeature WithIdentityGenerator(Func<IServiceProvider, IIdentityGenerator> generator)
 113    {
 0114        IdentityGenerator = generator;
 0115        return this;
 116    }
 117
 118    /// <summary>
 119    /// Fluent method to set <see cref="ILoggerStateGenerator{WorkflowExecutionContext}"/>.
 120    /// </summary>
 121    public WorkflowsFeature WithWorkflowLoggerStateGenerator(Func<IServiceProvider, ILoggerStateGenerator<WorkflowExecut
 122    {
 0123        WorkflowLoggerStateGenerator = generator;
 0124        return this;
 125    }
 126
 127    /// <summary>
 128    /// Fluent method to set <see cref="ILoggerStateGenerator{ActivityExecutionContext}"/>.
 129    /// </summary>
 130    public WorkflowsFeature WithActivityLoggerStateGenerator(Func<IServiceProvider, ILoggerStateGenerator<ActivityExecut
 131    {
 0132        ActivityLoggerStateGenerator = generator;
 0133        return this;
 134    }
 135
 136    /// <summary>
 137    /// Fluent method to configure the <see cref="IWorkflowExecutionPipeline"/>.
 138    /// </summary>
 139    public WorkflowsFeature WithWorkflowExecutionPipeline(Action<IWorkflowExecutionPipelineBuilder> setup)
 140    {
 129141        WorkflowExecutionPipeline = setup;
 129142        return this;
 143    }
 144
 145    /// <summary>
 146    /// Fluent method to configure the <see cref="IActivityExecutionPipeline"/>.
 147    /// </summary>
 148    public WorkflowsFeature WithActivityExecutionPipeline(Action<IActivityExecutionPipelineBuilder> setup)
 149    {
 129150        ActivityExecutionPipeline = setup;
 129151        return this;
 152    }
 153
 154    /// <inheritdoc />
 155    public override void Apply()
 156    {
 129157        AddElsaCore(Services);
 129158    }
 159
 160    private void AddElsaCore(IServiceCollection services)
 161    {
 129162        services
 129163
 129164            // Core.
 129165            .AddScoped<IActivityInvoker, ActivityInvoker>()
 129166            .AddScoped<IWorkflowRunner, WorkflowRunner>()
 129167            .AddScoped<IActivityTestRunner, ActivityTestRunner>()
 129168            .AddScoped<IActivityVisitor, ActivityVisitor>()
 129169            .AddScoped<IIdentityGraphService, IdentityGraphService>()
 129170            .AddScoped<IWorkflowGraphBuilder, WorkflowGraphBuilder>()
 129171            .AddScoped<IWorkflowStateExtractor, WorkflowStateExtractor>()
 129172            .AddScoped<IActivitySchedulerFactory, ActivitySchedulerFactory>()
 129173            .AddSingleton<IWorkflowExecutionContextSchedulerStrategy, WorkflowExecutionContextSchedulerStrategy>()
 129174            .AddSingleton<IActivityExecutionContextSchedulerStrategy, ActivityExecutionContextSchedulerStrategy>()
 129175            .AddScoped(CommitStateHandler)
 129176            .AddSingleton<IHasher, Hasher>()
 129177            .AddSingleton<IStimulusHasher, StimulusHasher>()
 129178            .AddSingleton(IdentityGenerator)
 0179            .AddSingleton<IBookmarkPayloadSerializer>(sp => ActivatorUtilities.CreateInstance<BookmarkPayloadSerializer>
 129180            .AddSingleton<IActivityDescriber, ActivityDescriber>()
 129181            .AddSingleton<IActivityRegistry, ActivityRegistry>()
 129182            .AddScoped<IActivityRegistryLookupService, ActivityRegistryLookupService>()
 129183            .AddSingleton<IPropertyDefaultValueResolver, PropertyDefaultValueResolver>()
 129184            .AddSingleton<IPropertyUIHandlerResolver, PropertyUIHandlerResolver>()
 129185            .AddSingleton<IActivityFactory, ActivityFactory>()
 129186            .AddTransient<WorkflowBuilder>()
 2965187            .AddScoped(typeof(Func<IWorkflowBuilder>), sp => () => sp.GetRequiredService<WorkflowBuilder>())
 129188            .AddScoped<IWorkflowBuilderFactory, WorkflowBuilderFactory>()
 129189            .AddScoped<IVariablePersistenceManager, VariablePersistenceManager>()
 129190            .AddScoped<IIncidentStrategyResolver, DefaultIncidentStrategyResolver>()
 129191            .AddScoped<IActivityStateFilterManager, DefaultActivityStateFilterManager>()
 129192            .AddScoped<IWorkflowInstanceVariableReader, DefaultWorkflowInstanceVariableReader>()
 129193            .AddScoped<IWorkflowInstanceVariableWriter, DefaultWorkflowInstanceVariableWriter>()
 129194            .AddScoped<DefaultActivityInputEvaluator>()
 129195
 129196            // Incident Strategies.
 129197            .AddTransient<IIncidentStrategy, FaultStrategy>()
 129198            .AddTransient<IIncidentStrategy, ContinueWithIncidentsStrategy>()
 129199
 129200            // Pipelines.
 501201            .AddScoped<IActivityExecutionPipeline>(sp => new ActivityExecutionPipeline(sp, ActivityExecutionPipeline))
 501202            .AddScoped<IWorkflowExecutionPipeline>(sp => new WorkflowExecutionPipeline(sp, WorkflowExecutionPipeline))
 129203
 129204            // Built-in activity services.
 129205            .AddScoped<IActivityResolver, PropertyBasedActivityResolver>()
 129206            .AddScoped<IActivityResolver, SwitchActivityResolver>()
 129207            .AddSerializationOptionsConfigurator<AdditionalConvertersConfigurator>()
 129208            .AddSerializationOptionsConfigurator<CustomConstructorConfigurator>()
 129209
 129210            // Domain event handlers.
 129211            .AddHandlersFrom<WorkflowsFeature>()
 129212
 129213            // Stream providers.
 129214            .AddScoped(StandardInStreamProvider)
 129215            .AddScoped(StandardOutStreamProvider)
 129216
 129217            // Storage drivers.
 129218            .AddScoped<IStorageDriverManager, StorageDriverManager>()
 129219            .AddStorageDriver<WorkflowStorageDriver>()
 129220            .AddStorageDriver<WorkflowInstanceStorageDriver>()
 129221            .AddStorageDriver<MemoryStorageDriver>()
 129222
 129223            // Serialization.
 129224            .AddSingleton<IWorkflowStateSerializer, JsonWorkflowStateSerializer>()
 129225            .AddSingleton<IPayloadSerializer, JsonPayloadSerializer>()
 129226            .AddSingleton<IActivitySerializer, JsonActivitySerializer>()
 129227            .AddSingleton<IApiSerializer, ApiSerializer>()
 129228            .AddSingleton<ISafeSerializer, SafeSerializer>()
 129229            .AddSingleton<IJsonSerializer, StandardJsonSerializer>()
 129230            .AddSingleton<SyntheticPropertiesWriter>()
 129231            .AddSingleton<ActivityWriter>()
 129232
 129233            // Instantiation strategies.
 129234            .AddScoped<IWorkflowActivationStrategy, AllowAlwaysStrategy>()
 129235
 129236            // UI.
 129237            .AddScoped<IUIHintHandler, DropDownUIHintHandler>()
 129238            .AddScoped<IUIHintHandler, CheckListUIHintHandler>()
 129239            .AddScoped<IUIHintHandler, RadioListUIHintHandler>()
 129240            .AddScoped<IUIHintHandler, JsonEditorUIHintHandler>()
 129241            .AddScoped<IPropertyUIHandler, StaticCheckListOptionsProvider>()
 129242            .AddScoped<IPropertyUIHandler, StaticRadioListOptionsProvider>()
 129243            .AddScoped<IPropertyUIHandler, StaticDropDownOptionsProvider>()
 129244            .AddScoped<IPropertyUIHandler, JsonCodeOptionsProvider>()
 129245            .AddScoped<DictionaryValueEvaluator>()
 129246            .AddSingleton<IActivityDescriptorModifier, DictionaryUIHintInputModifier>()
 129247
 129248            // Logger state generators.
 129249            .AddSingleton(WorkflowLoggerStateGenerator)
 129250            .AddSingleton(ActivityLoggerStateGenerator)
 129251
 129252            // Log Persistence Strategies.
 129253            .AddScoped<ILogPersistenceStrategyService, DefaultLogPersistenceStrategyService>()
 129254            .AddScoped<ILogPersistenceStrategy, Include>()
 129255            .AddScoped<ILogPersistenceStrategy, Exclude>()
 129256            .AddScoped<ILogPersistenceStrategy, Inherit>()
 129257            .AddScoped<ILogPersistenceStrategy, Configuration>()
 129258
 129259            // Logging
 129260            .AddLogging();
 129261    }
 262}