This rule raises an issue when the code cognitive complexity of a function is above a certain threshold.
Why is this an issue?
Cognitive Complexity is a measure of how hard it is to understand the control flow of a unit of code. Code with high cognitive complexity is hard
to read, understand, test, and modify.
As a rule of thumb, high cognitive complexity is a sign that the code should be refactored into smaller, easier-to-manage pieces.
Which syntax in code does impact cognitive complexity score?
Here are the core concepts:
- Cognitive complexity is incremented each time the code breaks the normal linear reading flow.
This concerns, for example:
Loop structures, Conditionals, Catches, Switches, Jumps to label and mixed operators in condition.
- Each nesting level adds a malus to the breaking call.
During code reading, the deeper you go through nested layers, the
harder it becomes to keep the context in mind.
- Method calls are free
A well-picked method name is a summary of multiple lines of code. A reader can first explore a
high-level view of what the code is performing then go deeper and deeper by looking at called functions content.
Note: This does not
apply to recursive calls, those will increment cognitive score.
The method of computation is fully detailed in the pdf linked in the resources.
What is the potential impact?
Developers spend more time reading and understanding code than writing it. High cognitive complexity slows down changes and increases the cost of
maintenance.
How to fix it
Reducing cognitive complexity can be challenging.
Here are a few suggestions:
- Extract complex conditions in a new function.
Mixed operators in condition will increase complexity. Extracting the
condition in a new function with an appropriate name will reduce cognitive load.
- Break down large functions.
Large functions can be hard to understand and maintain. If a function is doing too many
things, consider breaking it down into smaller, more manageable functions. Each function should have a single responsibility.
- Avoid deep nesting by returning early.
To avoid the nesting of conditions, process exceptional cases first and return
early.
Code examples
Extraction of a complex condition in a new function.
Noncompliant code example
The code is using a complex condition and has a cognitive cost of 3.
void processEligibleUser(User user) {
if ((user.isActive() && user.hasProfile()) // +1 (if) +1 (multiple conditions)
|| (user.getAge() > 18)) { // +1 (mixing operators)
// process the user
}
}
Compliant solution
Even if the cognitive complexity of the whole program did not change, it is easier for a reader to understand the code of the
processEligibleUser function, which now only has a cognitive score of 1.
void processEligibleUser(User user) {
if (isEligibleUser(user)) { // +1 (if)
// process the user
}
}
bool isEligibleUser(User user) {
return (user.isActive() && user.hasProfile()) // +1 (multiple conditions)
|| (user.getAge() > 18)); // +1 (mixing operators)
}
Break down large functions.
Noncompliant code example
The code is simplified here to illustrate the purpose. Please imagine there is more happening in the process.
The overall complexity of
processUser is 8.
void processUser(User user) {
if (user.isActive()) { // +1 (if)
if (user.hasProfile()) { // +1 (if) +1 (nested)
// process active user with profile
} else { // +1 (else)
// process active user without profile
}
} else { // +1 (else)
if (user.hasProfile()) { // +1 (if) +1 (nested)
// process inactive user with profile
} else { // +1 (else)
// process inactive user without profile
}
}
}
This function could be refactored into smaller functions: The complexity is spread over multiple functions, and the breaks in flow are no longer
nested.
The processUser now has a complexity score of two.
Compliant solution
void processUser(User user) {
if (user.isActive()) { // +1 (if)
processActiveUser(user);
} else { // +1 (else)
processInactiveUser(user);
}
}
void processActiveUser(User user) {
if (user.hasProfile()) { // +1 (if)
// process active user with profile
} else { // +1 (else)
// process active user without profile
}
}
void processInactiveUser(User user) {
if (user.hasProfile()) { // +1 (if)
// process inactive user with profile
} else { // +1 (else)
// process inactive user without profile
}
}
Avoid deep nesting by returning early.
Noncompliant code example
The below code has a cognitive complexity of 3.
void checkUser(User user) {
if (user.isActive()) { // +1 (if)
if (user.hasProfile()) { // +1 (if) +1 (nested)
// do something
}
}
}
Compliant solution
Checking for the edge case first flattens the if statements and reduces the cognitive complexity to 2.
void checkUser(User user) {
if (!user.isActive()) {
return;
}
if (!user.hasProfile()) {
return;
}
// do something
}
Pitfalls
As this code is complex, ensure that you have unit tests that cover the code before refactoring.
Resources
Documentation
Articles & blog posts
