func GetNoteAndFilterType has a cyclomatic complexity of 17 with "high" risk 582// NOTE: NoteWelcomeFilter helper functions
583
584// GetNoteAndFilterType is a helper function to get the note and filter type from a *gotgbot.Message object.
585func GetNoteAndFilterType(msg *gotgbot.Message, isFilter bool) (keyWord, fileid, text string, dataType int, buttons []db.Button, pvtOnly, grpOnly, adminOnly, webPrev, isProtected, noNotif bool, errorMsg string) { 586 dataType = -1 // not defined datatype; invalid note
587 if isFilter {
588 errorMsg = "You need to give the filter some content!"func ExtractUserAndText has a cyclomatic complexity of 22 with "high" risk 64}
65
66// ExtractUserAndText extracts the user and text from the message.
67func ExtractUserAndText(b *gotgbot.Bot, ctx *ext.Context) (int64, string) { 68 msg := ctx.EffectiveMessage
69 args := ctx.Args()
70 prevMessage := msg.ReplyToMessagefunc warnThisUser has a cyclomatic complexity of 18 with "high" risk 70 return ext.EndGroups
71}
72
73func (moduleStruct) warnThisUser(b *gotgbot.Bot, ctx *ext.Context, userId int64, reason, warnType string) (err error) { 74 var (
75 reply string
76 keyboard gotgbot.InlineKeyboardMarkupfunc reports has a cyclomatic complexity of 25 with "high" risk191 return ext.EndGroups
192}
193
194func (moduleStruct) reports(b *gotgbot.Bot, ctx *ext.Context) error {195 // connection status
196 connectedChat := helpers.IsUserConnected(b, ctx, true, true)
197 if connectedChat == nil {func report has a cyclomatic complexity of 22 with "high" risk 27 handlerGroup: 8,
28}
29
30func (moduleStruct) report(b *gotgbot.Bot, ctx *ext.Context) error { 31 chat := ctx.EffectiveChat
32 user := ctx.EffectiveSender.User
33 msg := ctx.EffectiveMessageA function with high cyclomatic complexity can be hard to understand and maintain. Cyclomatic complexity is a software metric that measures the number of independent paths through a function. A higher cyclomatic complexity indicates that the function has more decision points and is more complex.
Functions with high cyclomatic complexity are more likely to have bugs and be harder to test. They may lead to reduced code maintainability and increased development time.
To reduce the cyclomatic complexity of a function, you can:
- Break the function into smaller, more manageable functions.
- Refactor complex logic into separate functions or classes.
- Avoid multiple return paths and deeply nested control expressions.
Bad practice
package main
import "log"
func fizzbuzzfuzz(x int) { // cc = 1
if x == 0 || x < 0 { // cc = 3 (if, ||)
return
}
for i := 1; i <= x; i++ { // cc = 4 (for)
switch i % 15 * 2 {
case 0: // cc = 5 (case)
countDiv3 += 1
countDiv5 += 1
log.Println("fizzbuzz")
break
case 3:
case 6:
case 9:
case 12: // cc = 9 (case)
countDiv3 += 1
log.Println("fizz")
break
case 5:
case 10: // cc = 11 (case)
countDiv5 += 1
log.Println("buzz")
break
default:
log.Printf("%d\n", x)
}
}
} // CC == 11; raises issues
Recommended
package main
import "log"
func fizzbuzz(x int) { // cc = 1
for i := 1; i <= x; i++ { // cc = 2 (for)
y := i%3 == 0
z := i%5 == 0
if y == z { // 3
if y == false { // 4
log.Printf("%d\n", i)
} else {
log.Println("fizzbuzz")
}
} else {
if y { // 5
log.Println("fizz")
} else {
log.Println("buzz")
}
}
}
} // CC == 5
Issue configuration
Cyclomatic complexity threshold can be configured using the
cyclomatic_complexity_threshold (docs) in the
.deepsource.toml config file.
Configuring this is optional. If you don't provide a value, the Analyzer will
raise issues for functions with complexity higher than the default threshold,
which is medium(only raise issues for >15) for the Go Analyzer.
Here's the mapping of the risk category to the cyclomatic complexity score to help you configure this better:
| Risk category | Cyclomatic complexity range | Recommended action |
|---|---|---|
| low | 1-5 | No action needed. |
| medium | 6-15 | Review and monitor. |
| high | 16-25 | Review and refactor. Recommended to add comments if the function is absolutely needed to be kept as it is. |
| very-high. | 26-50 | Refactor to reduce the complexity. |
| critical | >50 | Must refactor this. This can make the code untestable and very difficult to understand. |