Implementing Clean Architecture - What is a use case?11 Feb 2018
Now that my architecture is screaming the business capabilities of my system let’s look at those with more detail.
In the Clean Architecture all the application specific business rules go into the use cases circle.
But what is a use case? How big should it be? How does it interact with its environment?
As a starting point for answering these questions I like to fish for find some definitions …
In software and systems engineering, a use case is a list of actions or event steps typically defining the interactions between a role (known in the Unified Modeling Language as an actor) and a system to achieve a goal.
These use cases orchestrate the flow of data to and from the entities, and direct those entities to use their Critical Business Rules to achieve the goals of the use case.
OK, these definitions are rather high-level and nothing concrete. I kinda expected that ;-)
Enough of theory - let’s look at something more practical …
To recap, Athena is an “agile backlog visualizer” implemented in F# using Asp.Net MVC. It provides various reports to improve the overall transparency in a software project. One major report is showing the ranked backlog with cut-lines:
Is providing this report a use case? On the most highest and abstract level: yes. The simplified “list of actions” is:
- Get all workitems from TFS (Team Foundation Server)
- Rank all workitems
- Get the team capacity
- Determine the cut-lines
- Generate the report (including all further details like TFS links and hints for missing information)
This would probably be the level on which I would specify an expected system behavior.
But should I implement this use case in a single use case interactor?
How big should a use case be?
There is no ideal size of a use case. Use cases can be long or short, high-level or more concrete. It all depends on the level of abstraction we want to consider.
Let me rephrase the question: How big should a use case INTERACTOR be?
So what would be a driving principle for deciding about “size”? Correct: Single Responsibility Pattern (SRP).
Let’s look closer at the list of actions from above …
Action: Get all workitems from TFS
This is clearly data access, isn’t it?
Yes and no. Obviously fetching the (raw) data from TFS is data access. But there are also business rules. The TFS itself is rather generic. We have put quite some custom conventions on top of it like: fruits, confidence levels, product lines and many more.
Interpreting plain text fields and generic tags and giving these information business semantics is about business rules. So I want to have this logic in the use cases circle. Guided by the SRP I would say
⇨ First use case interactor found
Action: Rank all workitems
Ranking the backlog is definitively about business rules as those define how the ranking should happen. Ideally this is a very simple task which just sorts workitems by stack rank. But reality is rarely ideal so I could imagine additional rules, e.g.:
- Always rank MMP higher than “best effort”
- Rank workitems without any given rank lowest
- In case of duplicate ranks, rank one product line over the other product line.
⇨ As this has nothing to do with backlog conventions and parsing I will add a second interactor.
Action: Get the team capacity
This is again mostly about data access. We have a non-TFS data source where all teams are modeled with their ramp up and ramp down in head count for one year. Getting this (raw) data is pure data access.
In a second step I need to calculate the team capacity from the given data. This step is again about business rules:
- Subtract corridors like hot fixes for the installed base from the modeled head count
- Convert head count into person days by applying an “availability factor” (e.g. remove holidays)
- Apply correct time frame (e.g. duration of an iteration or software version)
⇨ As this involves quite different entities than the previous two interactors I will create a third one.
Action: Determine the cut-lines
Now that I have a ranked backlog and the capacity I can determine the cut-lines.
Note: You may wonder why I talk about multiple cut-lines. This comes from the confidence levels. Each confidence level defines a certain percentage by which the actual estimation is correct, e.g. confidence level “low” could be defined as “+/- 50%” which means that the actual estimation could be “50% too expensive” or “50% too cheap”. This approach basically gives three numbers for each estimation: an optimistic, a pessimistic and a realistic one. Hence, we have three cut-lines.
Calculating the cut-lines is a simple algorithm which walks the backlog from top to bottom, sums up estimations and matches these against the capacity. It is clearly about business rules so I will add it to a use case interactor.
⇨ Considering the existing interactors and my preference of pragmatic decisions I will put this logic into
Action: Generate the report
At first glance this may look like “UI work”, but that’s not all. Here are further business rules to consider:
- Validate missing information (missing confidence level, missing estimation)
- Provide total capacity for reference
- Provide total effort for reference
- Compute list of involved team members (for the filters)
I want to have these business rules realized in an interactor as well.
⇨ Even with my preference for pragmatic decisions this logic doesn’t fit nicely into any existing interactor without violating SRP. So let me create a new one.
How do I combine use case interactors?
We have created four interactors so far. But how do we “combine” them to realize the high-level use case?
Basically there are two possibilities:
- Combine the interactors in the controller, so in the interface adapters circle
- Combine the interactors in another interactor, so in the use cases circle
I could easily find pros and cons for each alternative. The driving question for me would be, how much (business) logic is involved in combining the other interactors?
I want the interface adapters (controllers, presenters) rather dumb. So as soon as some logic is involved in combining interactors I prefer having another interactor realizing the combination.
For the use case discussed here I tend to make again a pragmatic decision: I will make the
“combining interactor” which calls the other interactors.
How do I access the database?
In his book Uncle Bob writes about database access:
Between the use case interactors and the database are the database gateways. These gateways are polymorphic interfaces that contain methods for every create, read, update, or delete operation that can be performed by the application on the database. For example, if the application needs to know the last names of all the users who logged in yesterday, then the UserGateway interface will have a method named getLastNamesOfUsersWhoLoggedInAfter that takes a Date as its argument and returns a list of last names.
For our use case I will define two interfaces. One to get the workitems from TFS and one to get the team capacity information from the external service.
Details about accessing “IO devices” and external systems I will discuss in one of my next posts.
How do I interact with controller and presenter?
According to the Dependency Rule a use case interactor must not depend on a controller or presenter. Instead, the use case interactor defines “input ports” and “output ports” to invert the dependencies.
In the use case I have described here the setup is simpler.
- As I use Asp.Net MVC, the controller and the presenter are the same class: the Asp.Net MVC controller.
- All methods I have defined on the interactors so far are simple and pure functions which get parameters and return results. So I don’t need to define any “ports”. I will simply pass DTOs (data transfer objects) around.
So I will just let the controller call
BacklogInteractor.GetBacklog passing some filter DTO which will
return some report DTO as result.
Which role is than actually left to the controller and the presenter? The answer to this question I will leave to another post.
How do others think about use cases and interactors?
During research for this post I found many discussions about the “right cut” of use cases. Here is a list of some well crafted thoughts:
- How big or small should a Use Case Interactor be in Clean Architecture?
- Do Interactors in clean architecture violate the Single Responsibility Principle?
- Who should handle combining interactors?
The "Implementing Clean Architecture" series
- How to implement the Clean Architecture?
- Implementing Clean Architecture - An Overview
- Implementing Clean Architecture - Make it scream
- Implementing Clean Architecture - What is a use case?
- Implementing Clean Architecture - Of controllers and presenters
- Implementing Clean Architecture - Are Asp.Net controllers "Clean"?