pipelineblocks's Introduction

PipelineBlocks

A .NET Standard library that can be used to create two-directional pipeline blocks.

Features

It's asynchronous.
Allows moving forward and backward in the pipeline.
Allows skipping the current block and removing it from the pipeline.
Blocks can be marked as an exit, meaning the pipeline can be finished at that stage.
Blocks can be marked as a checkpoint, allowing the pipeline to revert to this stage from any descendant block.
Child blocks can be dynamically determined based on the data of the current block.
Blocks can be merged into modules for better organization and reuse.
The library includes unit tests.

Example

using PipelineBlocks.Extensions;
using PipelineBlocks.Models;

var block2 = new PipelineBlock<string>()
{
    Job = (x, c) => BlockResult.Forward("success"),
    KeyCondition = x => "block2",
    NameCondition = x => "block2",
    CheckpointCondition = x => false,
    ExitCondition = x => true,
    ChildCondition = x => null
};
var block1 = new PipelineBlock<int>()
{
    Job = (x, c) => BlockResult.Forward(123),
    KeyCondition = x => "block1",
    NameCondition = x => "block1",
    CheckpointCondition = x => false,
    ExitCondition = x => true,
    ChildCondition = x => block2
};
await block1.ExecuteAsync();

Available actions in active block

sequenceDiagram
participant PA as Parent A (exit)
participant PB as Parent B (checkpoint)
participant A as Active block (exit)
participant CA as Child
A ->> CA: BlockResult.Forward<T>
Note left of CA: Continuue pipeline
A ->> CA: BlockResult<T>.Skip
Note left of CA: Continuue pipeline
A ->> PA: BlockResult<T>.BackToExit
Note right of PA: Finish pipeline
A ->> PB: BlockResult<T>.BackToCheckpoint
Note right of PB: Continuue pipeline
A ->> A: BlockResult.Exit<T>
Note right of A: Finish pipeline
A ->> A: BlockResult<T>.Error
Note right of A: Finish pipeline

Recommend Projects