evolutionary-architecture / evolutionary-architecture-by-example Goto Github PK

Is your feature request related to a problem? Please describe.
The current implementation for enabling modules relies on feature flags, which adds complexity to the system.

Describe the solution you'd like
I would like to simplify the process by directly reading module enablement from the configuration.

Describe alternatives you've considered
One alternative is to continue using feature flags for module enablement, but this may add unnecessary complexity. Another alternative could be to explore different methods of module activation.

Additional context
No additional context at this time.

Is your feature request related to a problem? Please describe.
Some people want to start theirs projects using evolutionary architecture example.
This is not developer friendly.

Describe the solution you'd like
Create a solution template for evolutionary architecture.

Is your feature request related to a problem? Please describe.
At main readme there is no links to chapters where chapters are described.

Describe the solution you'd like
Add missing links to enhance navigation

implement fluent validation for all queries and commands

Is your feature request related to a problem? Please describe.
The current implementation relies on ISystemClock for managing time-related operations. However, with the introduction of native time support in .NET 8, there's an opportunity to enhance the system by utilizing the new native time capabilities.

Describe the solution you'd like
Update the codebase to replace the usage of ISystemClock with the native time support introduced in .NET 8. This will involve refactoring the relevant sections of the code to leverage the new time functionalities provided by the .NET 8 framework.

Describe alternatives you've considered
An alternative could be to continue using ISystemClock, but considering that .NET 8 provides native time support, it makes sense to migrate to the native solution for improved performance and consistency across the codebase.

Additional context
The adoption of native time in .NET 8 can bring alignment with the latest advancements in the .NET framework. It's essential to test and validate the changes thoroughly to ensure compatibility and reliability across different scenarios.

Is your feature request related to a problem? Please describe.
It is frequent question How to implement observability? It is mentioned that observability is important from start of project. How to Do it?

My proposition is add this part as example

Describe the bug

There is an exception during using the app

System.Collections.Generic.IEnumerable1[MediatR.INotificationHandler1[EvolutionaryArchitecture.Fitnet.Contracts.SignContract.Events.ContractSignedEvent]]' from root provider because it requires scoped service 'EvolutionaryArchitecture.Fitnet.Passes.Data.Database.PassesPersistence

Is your feature request related to a problem? Please describe.

For chapter 1 and 2 component architecture looks similar only implementation details were changed but for chapter 3. Deployment and components were changed.

Describe the solution you'd like

Chapter 3 should have ice panel diagrams and linked

Is your feature request addressing a specific issue? Please elaborate.

Some individuals have suggested that the next stage of evolution could involve the incorporation of Dapr. This would enable us to maintain our focus on the business aspects rather than getting entangled in Microservices infrastructure management.

Please provide further details on the proposed solution.

I would like to initiate a discussion on this matter.

Is your feature request related to a problem? Please describe.
At the moment we focus mainly on solution architecture. It would be great to include description about infrastructure and how it can grow.

Describe the solution you'd like
Each chapter should contain a section that shows possible infrastructure solutions.

Describe alternatives you've considered
No alternatives considered.

Additional context
No additional context.

Is your feature request addressing a specific issue? Please elaborate.

In Chapter 3 of our project, we have introduced asynchronous communication through an external message broker, which is a critical component of our system. However, the absence of the Outbox Pattern in this chapter could potentially lead to data inconsistency and reliability issues when dealing with asynchronous messaging.

Please provide further details on the proposed solution.

It has been suggested to incorporate the outbox pattern in Chapter 3.

Is your feature request related to a problem? Please describe.
At the moment we focus mainly on solution architecture. It would be great to include description about testing strategy and how it can grow.

Describe the solution you'd like
Each chapter should contain a section that shows possible testing strategies.

Describe alternatives you've considered
No alternatives considered.

Additional context
No additional context.

Issue Description:

Problem:

The MassTransit library provides the ITestingHarness interface, which allows for testing and verification of published events. However, when the OutBoxPattern is configured, the behavior of publishing events changes. Instead of immediately publishing the event, the service sends the event in the background after loading it from the database.

Manual Testing:

Manually testing the scenario has confirmed that this behavior is functioning correctly.

Test To Fix

Is your feature request related to a problem? Please describe.
The current test classes utilize IEnumerable<object[]> for parameterized tests. Transitioning to TheoryData in Xunit can enhance code readability and maintainability.

Describe the solution you'd like
Update existing test classes that use IEnumerable<object[]> to leverage Xunit's TheoryData for parameterized testing. This transition will provide a more structured and intuitive approach to writing and maintaining test cases.

Domain Error Flow is controlled by exceptions that has impact on performance and maintability - We can switch to discriminated union results

Is your feature request related to a problem? Please describe.
Tests using fake event bus can't detected class scopes misconfiguration like scoped in singleton

Describe the solution you'd like
There should be check or test which detect such situations

Our repository has become a valuable resource for people seeking to understand how architectural evolution takes place. As we move forward, it's crucial to establish a clear framework for monitoring this evolution and ensuring alignment with our project's objectives.

Documentation of Architecture Evolution:

We should document the process of architectural evolution within our repository to provide transparency and insight into our decision-making. This documentation will help contributors and stakeholders understand how our architecture evolves over time.

Introducing Fitness Functions:

To continuously assess the direction of architectural evolution, we propose the use of fitness functions. Fitness functions are tools that enable us to quantitatively evaluate the fitness or suitability of our architecture concerning specific requirements. These functions will help us measure how well our architecture aligns with our evolving needs.

Description
Chapter-1-initial-architecture/README.adoc contains two broken links to code in this repository.

For example:

You can check how does it look like here.

Solution
In the links path meaboutsoftware/evolutionary-architecture needs to re replaced with evolutionary-architecture/evolutionary-architecture-by-example

Describe the bug
Docker file for chapter 1 references dotnet 7 rather that dotnet 8

To Reproduce
Steps to reproduce the behavior:

1. run docker-compose build in chapter 1 src directory

Expected behavior
Builds without issue.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):
-Windows 11

Smartphone (please complete the following information):

• N/A

Additional context
N/A.