Fix high severity SonarQube issues: string duplication and cognitive complexity #22
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
…complexity - Create constants.go with common error message templates to eliminate string duplication (go:S1192) - Extract helper functions from GetFileContents to reduce cognitive complexity from 86 (go:S3776) - Replace 'failed to get GitHub client: %w' and 'failed to marshal response: %w' with constants - Refactor GetFileContents into smaller functions: extractFileContentParams, resolvePullRequestRef, createResourceURI, tryGetRawContent, getContentViaAPI - All tests pass and linting is clean Co-Authored-By: Eashan Sinha <eashan.sinha@codeium.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:
|
- Replace all instances of 'failed to get GitHub client: %w' with ErrFailedToGetGitHubClient constant - Replace all instances of 'failed to marshal response: %w' with ErrFailedToMarshalResponse constant - Updated 8 files: actions.go, code_scanning.go, issues.go, notifications.go, pullrequests.go, repository_resource.go, search.go, secret_scanning.go - This should resolve SonarCloud CI failure showing 5.8% duplication on new code - All tests pass and linting is clean Co-Authored-By: Eashan Sinha <eashan.sinha@codeium.com>
- Remove duplicate constants from actions.go that were causing increased duplication - Add comprehensive error message and description constants to constants.go - Replace all instances of duplicated strings with constants across the codebase - Fix string duplications in error messages, descriptions, and other literals - Ensure consistent usage of constants for Repository owner/name, Sort order, etc. - Address remaining duplications identified in SonarQube analysis Co-Authored-By: Eashan Sinha <eashan.sinha@codeium.com>
…onstants used 3+ times - Reduced constants.go from 31 to 5 constants focusing on most duplicated strings - Reverted low-value constants back to inline strings to reduce duplication overhead - Fixed undefined ErrFailedToGetLatestReview references in pullrequests.go - Completed string replacements in docs/error-handling.md and internal/ghmcp/server.go - Successfully replaced 'repo://' with RepoURIPrefix constant in repository_resource.go - All lint and test checks pass locally Co-Authored-By: Eashan Sinha <eashan.sinha@codeium.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 fixes two high-severity SonarQube issues related to code quality:
GetFileContentsfunction by breaking it into smaller, focused helper functionsChanges
1. String Duplication Fix
pkg/github/constants.gowith common error message templates"failed to get GitHub client: %w"and"failed to marshal response: %w"acrossactions.goandrepositories.go2. Cognitive Complexity Reduction
GetFileContentsfunction (complexity 86) into smaller helper functions:extractFileContentParams- parameter extraction and validationresolvePullRequestRef- pull request reference resolutioncreateResourceURI- resource URI generationtryGetRawContent- raw content fetching with proper content type handlinggetContentViaAPI- GitHub API fallback for content retrievalFileContentParamsstruct to encapsulate function parametersKey Considerations for Review
Tradeoffs:
Alternatives Considered:
Testing
Link to Devin run: https://app.devin.ai/sessions/b27df605292342f8b012db8621596320
Requested by: @eashansinha
Closes: N/A (SonarQube code quality improvement)