PowerPipe 1.2.0-rc4
See the version list below for details.
dotnet add package PowerPipe --version 1.2.0-rc4
NuGet\Install-Package PowerPipe -Version 1.2.0-rc4
<PackageReference Include="PowerPipe" Version="1.2.0-rc4" />
paket add PowerPipe --version 1.2.0-rc4
#r "nuget: PowerPipe, 1.2.0-rc4"
// Install PowerPipe as a Cake Addin #addin nuget:?package=PowerPipe&version=1.2.0-rc4&prerelease // Install PowerPipe as a Cake Tool #tool nuget:?package=PowerPipe&version=1.2.0-rc4&prerelease
<p align="center"> <img src="https://github.com/mvSapphire/PowerPipe/blob/master/assets/readme-header.png?raw=true" alt="drawing" width="250"/> </p>
<span align="center">
</span>
A .NET Library for Constructing Advanced Workflows with Fluent Interface
PowerPipe is a versatile .NET library designed to streamline the process of building advanced workflows using a fluent interface. The primary objective of this project is to eliminate the need for writing boilerplate code when implementing workflows.
Check out Medium article 👀
If you like this project give it a star 🌟
🔥 Features and Benefits
- Lightweight
- Fluent interface
- Ease & Structured Workflow construction
- Dependency Injection support
- Developed using .NET 6
🧐 Sample use case
Imagine creating an e-commerce platform. The platform must process incoming customer orders, each demanding validation, inventory updates, and potentially more intricate steps.
public class ECommercePipelineService : IECommercePipelineService
{
private readonly IPipelineStepFactory _pipelineStepFactory;
private bool PaymentSucceed(ECommerceContext context) => context.PaymentResult.Status is PaymentStatus.Success;
public ECommercePipelineService(IPipelineStepFactory pipelineStepFactory)
{
_pipelineStepFactory = pipelineStepFactory;
}
public IPipeline<OrderResult> BuildPipeline()
{
var context = new ECommerceContext();
return new PipelineBuilder<ECommerceContext, OrderResult>(_pipelineStepFactory, context)
.Add<OrderValidationStep>()
.Add<PaymentProcessingStep>()
.OnError(PipelineStepErrorHandling.Retry, retryInterval: TimeSpan.FromSeconds(2), maxRetryCount: 2)
.If(PaymentSucceed, b => b
.Add<OrderConfirmationStep>()
.Add<InventoryReservationStep>())
.Parallel(b => b
.Add<CustomerNotificationsStep>()
.Add<AnalyticsAndReportingStep>(), maxDegreeOfParallelism: 2)
.Build();
}
}
🛠️ Getting started
Installation
- Package Manager Console
Install-Package PowerPipe
Install-Package PowerPipe.Extensions.MicrosoftDependencyInjection
- .NET CLI
dotnet add package PowerPipe
dotnet add package PowerPipe.Extensions.MicrosoftDependencyInjection
Building pipeline
- Create pipeline context and result
public class SampleContext : PipelineContext<SampleResult>
{
// Properties and methods specific to the context
}
public class SampleResult
{
// Implementation details
}
- Create pipeline steps
public class SampleStep1 : IPipelineStep<SampleContext>
{
// Implementation details…
}
public class SampleStep2 : IPipelineStep<OrderContext>
{
// Implementation details…
}
- Define your pipeline
- Use
Add<T>
method to add a step to your pipeline
var pipeline = new PipelineBuilder<OrderProcessingContext, Order>()
.Add<SampleStep1>()
.Add<SampleStep2>()
.Build();
- Use
AddIf<T>
method to add a step to the pipeline based on the predicate
// Define predicate based on context
private bool ExecuteStep2(OrderProcessingContext context) =>
context.ExecuteStep2Allowed;
var pipeline = new PipelineBuilder<OrderProcessingContext, Order>()
.Add<SampleStep1>()
.AddIf<SampleStep2>(ExecuteStep2)
.Build();
- Use
AddIfElse<TFirst, TSecond>
method to add one of the steps by the predicate
private bool ExecuteStep2(OrderProcessingContext context) =>
context.ExecuteStep2Allowed;
var pipeline = new PipelineBuilder<OrderProcessingContext, Order>()
.AddIfElse<SampleStep1, SampleStep2>(ExecuteStep2)
.Build();
- Use
If
method to add a nested pipeline based on a predicate
private bool ExecuteNestedPipeline(OrderProcessingContext context) =>
context.ExecuteNestedPipelineAllowed;
var pipeline = new PipelineBuilder<OrderProcessingContext, Order>()
.If(ExecuteNestedPipeline, b => b
.Add<SampleStep1>()
.Add<SampleStep2>())
.Build();
- Use
Parallel
method to execute your steps in parallel
In order to execute steps in parallel your steps should implement
IPipelineParallelStep<TContext>
interface
var pipeline = new PipelineBuilder<OrderProcessingContext, Order>()
.Parallel(b => b
.Add<SampleParallelStep1>()
.Add<SampleParallelStep2>(), maxDegreeOfParallelism: 3)
.Build();
- Use
OnError
method to add error-handling behavior
Currently available only two types of error handling
Suppress
andRetry
var pipeline = new PipelineBuilder<OrderProcessingContext, Order>()
.Add<SampleStep1>()
.OnError(PipelineStepErrorHandling.Retry)
.Build();
- Use
CompensateWith
method to add a compensation step to the previously added step in the pipeline
Compensation steps should implement
IPipelineCompensationStep<TContext>
public class SampleStep1Compensation : IPipelineCompensationStep<SampleContext> {}
var pipeline = new PipelineBuilder<OrderProcessingContext, Order>()
.Add<SampleStep1>()
.CompensateWith<SampleStep1Compensation>()
.Build();
- Extensions: Microsoft Dependency Injection
The PowerPipe.Extensions.MicrosoftDependencyInjection
extension provides integration with Microsoft Dependency Injection.
- Use
AddPowerPipe
to register all required services and scan libraries for your step implementations.
public static IServiceCollection AddPowerPipe(
this IServiceCollection serviceCollection,
PowerPipeConfiguration configuration)
By default all found implementations will be registered as Transient.
services.AddPowerPipe(cfg =>
{
cfg.RegisterServicesFromAssemblies(Assembly.GetExecutingAssembly());
});
But you can configure service lifetime per step implementation.
services.AddPowerPipe(cfg =>
{
cfg.RegisterServicesFromAssemblies(typeof(Program).Assembly)
.ChangeDefaultLifetime(ServiceLifetime.Scoped) // to override default lifetime
.AddSingleton<Step1>()
.AddTransient<Step2>()
.AddTransient(typeof(Step2));
});
Check out sample project 👀
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net6.0
- No dependencies.
NuGet packages (2)
Showing the top 2 NuGet packages that depend on PowerPipe:
Package | Downloads |
---|---|
PowerPipe.Extensions.MicrosoftDependencyInjection
A library for .NET that uses a fluent interface to construct advanced workflows with ease |
|
PowerPipe.Visualization
A library for .NET that uses a fluent interface to construct advanced workflows with ease |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
3.0.0 | 158 | 7/31/2024 |
2.0.0 | 1,029 | 3/22/2024 |
1.2.0 | 13,526 | 11/13/2023 |
1.1.2 | 355 | 9/21/2023 |
1.1.1 | 169 | 9/12/2023 |
1.1.0 | 169 | 9/11/2023 |
1.0.3 | 5,279 | 7/17/2023 |
1.0.2 | 11,406 | 2/8/2023 |
1.0.1 | 645 | 1/16/2023 |
1.0.0 | 401 | 1/3/2023 |
0.1.10 | 4,946 | 5/10/2022 |
0.1.9 | 523 | 5/10/2022 |
0.1.8 | 541 | 5/6/2022 |
0.1.7 | 538 | 5/5/2022 |
0.1.6 | 561 | 4/21/2022 |
0.1.5 | 538 | 4/21/2022 |
0.1.4 | 563 | 4/21/2022 |
0.1.3 | 565 | 4/18/2022 |
0.1.2 | 582 | 2/14/2022 |
0.1.1 | 541 | 2/14/2022 |
0.1.0 | 594 | 2/14/2022 |