Add new noSelectStar analyzer #42
Merged
Conversation
This file contains 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
This guards against forwards compatibility issues from adding new columns an old server won't know how to handle. Relates-to: https://mattermost.atlassian.net/browse/MM-62169
agnivade
reviewed
Dec 12, 2024
noSelectStar/testdata/src/a/a.go
Outdated
| Select("id", "name", "*") // want `do not use Select with \*: explicitly select the needed columns instead` | ||
|
|
||
| // These should not trigger warnings for Select function | ||
| Select("id, name") |
There was a problem hiding this comment.
Can we also add a test case like:
query := s.getQueryBuilder().
Select("*").
From("Channels").
Where(sq.Eq{"Id": ids})
to test for completeness?
There was a problem hiding this comment.
Good catch: the previous code was entirely incompatible with our actual pattern here. I confess to offloading too much to aider here: I suppose this is analogous to the self-driving car problem where the drivers risk not paying sufficient attention to take over when things don't go right.
I still used aider to fix this, but enhanced the test cases manually.
There was a problem hiding this comment.
Good that we have humans to review code 😂
The commit adds a test case for the squirrel builder pattern to verify that the linter catches SELECT * usage even when using method chaining. Specifically:
1. Imported the squirrel package as `sq`
2. Added a test case using `sq.StatementBuilder.PlaceholderFormat(sq.Dollar).Select("*")...`
3. Added an appropriate `want` comment to verify the linter catches the SELECT * usage
This ensures the linter works correctly with fluent SQL builder libraries like squirrel.
agnivade
approved these changes
Dec 13, 2024
lieut-data
added
3: Reviews Complete
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 guards against forwards compatibility issues with
SELECT *.I won't actually enable this in the monorepo until https://mattermost.atlassian.net/browse/MM-62110 is resolved.
Ticket Link
Relates-to: https://mattermost.atlassian.net/browse/MM-62169