Calabonga.PipelineExecutor 2.0.0

Calabonga.PipelineExecutor

Pipeline pattern implementation. Simple process executor with step-by-step pipeline execution. You can use a Calabonga.PipelineExecutor as a nuget-package in your applications.

How to install

Install a nuget-package, for example something like this:

dotnet add package Calabonga.PipelineExecutor

How to use

1. You should have a class for pipeline processing. It should implemente IPipelineResult interface as a marker for pipeline. Something like that:

/// <summary>
/// Entity as a context and result for PipelineExecutor
/// </summary>
public class ImageResult : IPipelineResult
{
    public string Name { get; set; } = null!;

    public double Height { get; set; }

    public double Width { get; set; }
}

2. Than you need create a steps for pipeline executor. This is a example for one of them (pay attention to base class of the ResizeStep, this is important):

public class ResizeStep : PipelineStep<ImageResult>
{
    public override int OrderIndex => 2;

    public override Task<StepResult> ExecuteAsync(
        ImageResult item,
        IPipelineConfiguration<ImageResult> configuration,
        ILogger<PipelineExecutor<ImageResult>> logger,
        CancellationToken cancellationToken)
    {
        item.Height = 100;
        item.Width = 100;

        logger.LogInformation("[PIPELINE] Resize done 100 x 100");

        return Task.FromResult(StepResult.Success());
    }
}

3. Make sure dependencies registered in your Dependency Container;

// Register PipelineExecutor for ImageResult processing
services.AddScoped<PipelineExecutor<ImageResult>>();

// Register PipelineExecutor a DefaultPipeConfiguration (integrated into nuget) or create a custom 
// see ImagePipelineConfiguration shown below.
services.AddScoped<IPipelineConfiguration<ImageResult>, DefaultPipelineConfiguration<ImageResult>>();

// Register a steps of the PipelineExecutor you created.
// Something like shown below:
services.AddScoped<IPipelineStep<ImageResult>, ResizeStep>();
services.AddScoped<IPipelineStep<ImageResult>, UpdateNameStep>();
services.AddScoped<IPipelineStep<ImageResult>, UppercaseNameStep>();

4. Custom configuration can be used:

/// <summary>
/// Custom configuration for <see cref="PipelineExecutor{T}"/>
/// with some additional parameters
/// </summary>
public class ImagePipelineConfiguration : IPipelineConfiguration<ImageResult>
{
    private readonly IOptions<AppSettings> _settings;

    public ImagePipelineConfiguration(IOptions<AppSettings> settings)
    {
        _settings = settings;
    }

    /// <summary>
    /// Will be used in <see cref="UpdateNameStep"/>
    /// </summary>
    public string ImageDefaultName => _settings.Value.Name ?? "ImageResult-Name-From-Configuration.png";

    /// <summary>
    /// Strategy for steps executing when manual steps added (<see cref="PipelineExecutor.AdditionalStepStrategy"/>).
    /// </summary>
    public AdditionalStepStrategy AdditionalStepStrategy => AdditionalStepStrategy.Append;

    /// <summary>
    /// Strategy when step operation failed (<see cref="FailedStepStrategy"/>)
    /// </summary>
    public FailedStepStrategy FailedStepStrategy => FailedStepStrategy.NotStopPipeline;
}

If you want to use custom configuration, then you should replace registration in DI-container. Something like that:

// Register PipelineExecutor a DefaultPipeConfiguration (integrated into nuget)
//services.AddScoped<IPipelineConfiguration<ImageResult>, DefaultPipelineConfiguration<ImageResult>>();
//
// Register a Custom PipelineExecutorConfiguration for ImageResult
services.AddScoped<IPipelineConfiguration<ImageResult>, ImagePipelineConfiguration>();

History

2.0.0

• PipelineConfiguration setup improved
  • IPipelineResult created a marker for object class for IPipelineConfiguration
  • IPipelineContext renmed to IPipelineConfiguration
  • DefaultPipelineContext renamed to DefaultPipelineConfiguration
• Demo project in solution updated
• Readme updated

1.1.0

• Some syntax fixed.

1.0.0

• First Release
• More summary added/updated

1.0.0-beta.2

• Project URL address fixed
• Repository URL address fixed

1.0.0-beta.1

• First release.

Screenshots

Console app result shown