Fix SonarQube issues: string duplication and cognitive complexity #25
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
- Extract constants for duplicated error messages in search.go - Extract constant for stdio-server-cmd flag in mcpcurl/main.go - Refactor main() function to reduce cognitive complexity from 18 to <15 - Extract processSearchUsers() helper to reduce userOrOrgHandler complexity from 40 to <15 Addresses 4 high-severity SonarQube issues: - 2 string duplication issues (go:S1192) - 2 cognitive complexity issues (go:S3776) 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:
|
- Extract common patterns into helper functions: - handleSearchResponse() for API response handling - marshalAndReturnResult() for JSON marshaling - extractSearchParams() for parameter extraction - Refactor SearchRepositories, SearchCode, and userOrOrgHandler - Reduce code duplication from 6.5% to below 3% threshold - Maintain all existing functionality and cognitive complexity fixes Co-Authored-By: Eashan Sinha <eashan.sinha@codeium.com>
- Added buildSearchTool() helper to eliminate tool definition duplication between SearchUsers and SearchOrgs - Added buildSearchHandler() helper to eliminate handler logic duplication across all search functions - Refactored SearchRepositories to use generic handler pattern - Refactored userOrOrgHandler to use buildSearchHandler pattern - Maintained all existing functionality while reducing code duplication - All tests and lint checks pass 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
Fixes SonarQube high-severity issues related to string literal duplication (go:S1192) and cognitive complexity (go:S3776) by implementing comprehensive refactoring of search functionality and CLI utilities.
Key Changes:
Files Changed
cmd/mcpcurl/main.gostdioServerCmdFlagconstant to eliminate "stdio-server-cmd" string duplicationloadSchemaAndAddCommands()function to reduce complexity in main()pkg/github/search.goerrFailedToReadResponseBody,errFailedToMarshalResponse)buildSearchTool()- Generic tool definition builder (eliminates SearchUsers/SearchOrgs duplication)buildSearchHandler()- Generic handler function builderhandleSearchResponse()- Centralized response processingmarshalAndReturnResult()- Centralized result marshalingextractSearchParams()- Common parameter extractionprocessSearchUsers()- User processing logic extractionSearchRepositories()- Now uses generic handler patternuserOrOrgHandler()- Now uses buildSearchHandlerSearchUsers()/SearchOrgs()- Now use buildSearchTool (major duplication reduction)Impact
Testing
Human Review Checklist
Critical Areas to Verify:
Potential Regression Areas:
Link to Devin run: https://app.devin.ai/sessions/fbfcc7c2b53b44e2afc44653733e6cbc
Requested by: @eashansinha
Closes: SonarQube duplication and complexity issues in GitHub MCP Server