Fix SonarQube string duplication and cognitive complexity issues #21
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…sues - Add ErrFailedToGetGitHubClient constant to eliminate string duplication - Extract handleNotificationSubscriptionAction helper function to reduce cognitive complexity in ManageNotificationSubscription - Fixes SonarQube issues go:S1192 and go:S3776 Co-Authored-By: Shawn Azman <shawn.d.azman@gmail.com>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
…w 3% - Add constants for high-impact duplicated strings in actions.go, notifications.go, repositories.go, and test files - Replace 50+ string duplications with constants across multiple files - Addresses SonarQube go:S1192 issues to meet quality gate requirements Co-Authored-By: Shawn Azman <shawn.d.azman@gmail.com>
- Add InvalidThreadIDFormat constant in notifications_test.go - Remove duplicate constants from actions_test.go (already exist in actions.go) - Add TestContentType, TestFileContent, TestFileName constants in raw_test.go - Replace all occurrences of duplicated strings with constants - Addresses additional SonarQube go:S1192 issues to reduce duplication rate Co-Authored-By: Shawn Azman <shawn.d.azman@gmail.com>
…ications - Remove duplicate TestFileName constant from repositories_test.go - Add constants for highest impact duplicated strings (docs/example.md, content strings) - Replace 15+ additional string duplications with constants - Addresses remaining SonarQube go:S1192 issues to meet quality gate requirements Co-Authored-By: Shawn Azman <shawn.d.azman@gmail.com>
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR addresses two high-severity SonarQube code quality issues:
"failed to get GitHub client: %w"across the codebaseManageNotificationSubscriptionfunctionChanges Made
String Deduplication
ErrFailedToGetGitHubClientconstant inserver.gopkg/github/actions.go,code_scanning.go,issues.go,notifications.go,pullrequests.go,repositories.go,repository_resource.go,search.go,search_utils.go,secret_scanning.goCognitive Complexity Reduction
handleNotificationSubscriptionActionhelper function fromManageNotificationSubscriptionTesting
Human Review Checklist
Critical items to verify:
handleNotificationSubscriptionActionhelper maintains identical logic flow to the original switch statementManageNotificationSubscriptionLower priority:
Tradeoffs
Alternatives Considered
Link to Devin run: https://app.devin.ai/sessions/5c4208e2af504a39963e320a44e23277
Requested by: @ShawnAzman