Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/DumplingsDevs/Pipelines

The most flexible mediation implementation in the .NET ecosystem with your own types
https://github.com/DumplingsDevs/Pipelines

Last synced: 3 months ago
JSON representation

The most flexible mediation implementation in the .NET ecosystem with your own types

Awesome Lists containing this project

README 

        
[![CI-main](https://github.com/DumplingsDevs/Pipelines/actions/workflows/build-and-test.yml/badge.svg?branch=main)](https://github.com/DumplingsDevs/Pipelines/actions/workflows/build-and-test.yml)

[![NuGet](https://img.shields.io/nuget/v/DumplingsDevs.Pipelines.svg)](https://www.nuget.org/packages/DumplingsDevs.Pipelines/)



---





  Pipelines

  Pipelines




# 📢 What is Pipelines?



We believe that a good library should adapt to the application, not the other way. That is why Pipelines grants you the

freedom to create any number of mediators within your application. Each of them can be tailored to specific use cases,

ensuring maximum flexibility in programming. This is possible because:



- Pipelines does not expose its types - it does not require implementing an interface or inheriting from a class. You

  have absolute control over input data and operation results.

- Each mediator built with Pipelines is independent and decoupled from the others.

- To maintain the best performance, we utilized the Source Generator mechanism, which minimizes the use of reflection.

- Decorator support allows you to add additional effects like validation, logging, or even using the Unit of Work

  pattern. Additionally, it enables the construction of the Chain of Responsibility pattern.



-----



# 📦 Installation

```

dotnet add package DumplingsDevs.Pipelines

dotnet add package DumplingsDevs.Pipelines.WrapperDispatcherGenerator

```



----



# 📚 Documentation



The [Quick Start](docs/quick_start.md) section will allow you to quickly create your first Pipeline.



If you prefer learning through real examples, please check out the examples below:

- [Multistep process](docs/process_pipeline.md)

- [Commands, Queries and Domain Events Dispatching](docs/command_queries_events_example.md)



If you want to learn more, please read the articles below.



- [Main Concepts](docs/main_concepts.md)

- [Configuration](docs/configuration.md)

- [Pipeline Cookbook](docs/pipeline_cookbook.md)

- [Troubleshooting](docs/troubleshooting.md)

- [Proxy vs Generated Dispatcher](docs/dispatcher_source_generator.md)

- [Benchmarks](docs/benchmarks.md)

- [ADR](docs/adr.md)

- [Articles](docs/articles.md)



---- 



# ⚠️ Limitations

- Pipelines in which multiple handlers will be handled for one input must have a `Task` or `void` return type.

- Cannot create a Pipeline that returns both generic and non-generic types.



-----



# 🛤 Roadmap

- [ ] **ADR Documentation**: Record key architectural decisions made during implementation using ADRs.

- [ ] **Code Cleanup**: Refine and tidy up the codebase post-MVP, paving the way for new feature development.

- [ ] **Support for Nullable Results**: Add functionality to handle nullable result types.

- [ ] **Multiple Inputs in Dispatcher**: Enhance the dispatcher handle method to accept a list of inputs instead of just one.

- [ ] **Parallel Pipeline**: Introduce a pipeline to facilitate parallel execution of multiple handlers.

- [ ] **Stream Pipeline**: Implement support for streaming pipelines.

- [ ] **Decorator Performance Optimization**: Improve performance, especially concerning the use of `ActivatorUtilities.CreateInstance()`.



-----



# 🥟💡 The Dumplings Behind the Magic

Hey there! We're Dumplings Devs, made up of Mateusz Wróblewski and Kamil Bytner. We're passionate about software and always up for a coding challenge. 



---





  DumplingsDevs

  DumplingsDevs