feat(csharp): adds a missed first or default opprtunity rule - #22485
Open
baywet wants to merge 2 commits into
Open
feat(csharp): adds a missed first or default opprtunity rule#22485baywet wants to merge 2 commits into
baywet wants to merge 2 commits into
Conversation
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The detection currently produces behavior-changing recommendations for converted iteration types, incompatible defaults, and asynchronous enumeration.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Adds a C# quality query detecting loops that can use LINQ’s FirstOrDefault.
Changes:
- Implements and registers the new query.
- Adds documentation, examples, and tests.
- Extends shared LINQ detection helpers.
File summaries
| File | Description |
|---|---|
csharp/ql/lib/Linq/Helpers.qll |
Adds detection logic. |
csharp/ql/src/Linq/MissedFirstOrDefaultOpportunity.ql |
Defines the query. |
csharp/ql/src/Linq/MissedFirstOrDefaultOpportunity.qhelp |
Documents the recommendation. |
csharp/ql/src/Linq/MissedFirstOrDefaultOpportunity.cs |
Provides a flagged example. |
csharp/ql/src/Linq/MissedFirstOrDefaultOpportunityFix.cs |
Provides the recommended fix. |
csharp/ql/src/Linq/MissedFirstOrDefaultOpportunityGood.cs |
Provides non-alerting examples. |
csharp/ql/src/codeql-suites/csharp-security-and-quality.qls |
Enables the query in the quality suite. |
csharp/ql/test/query-tests/Linq/MissedFirstOrDefaultOpportunity/MissedFirstOrDefaultOpportunity.cs |
Adds test cases. |
csharp/ql/test/query-tests/Linq/MissedFirstOrDefaultOpportunity/MissedFirstOrDefaultOpportunity.qlref |
Configures the query test. |
csharp/ql/test/query-tests/Linq/MissedFirstOrDefaultOpportunity/MissedFirstOrDefaultOpportunity.expected |
Records expected results. |
Review details
Suppressed comments (2)
csharp/ql/lib/Linq/Helpers.qll:184
- This only checks that the condition accesses the iteration variable, but
foreachmay implicitly convert each source element to a different variable type. For example,foreach (string value in IEnumerable<object>)can match here, whileFirstOrDefaultreceives and returnsobject, so the proposed replacement neither exposesstringmembers in the predicate nor returns the same type. Require an identity conversion betweenfes.getElementType()and the iteration-variable type (or account for the requiredCast<T>()).
exists(VariableAccess va |
va.getTarget() = fes.getVariable() and
va = is.getCondition().getAChildExpr*()
csharp/ql/lib/Linq/Helpers.qll:179
- Exclude asynchronous foreach statements here. A type can implement both
IAsyncEnumerable<T>andIEnumerable<T>, so it satisfiesForeachStmtGenericEnumerable, but replacing itsawait foreachwithFirstOrDefaultswitches to synchronous enumeration and can change behavior.
is = firstStmt(fes) and
- Files reviewed: 10/10 changed files
- Comments generated: 1
- Review effort level: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
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.
there are already rules for missed where/all/oftype/select/cast opportunities. It only makes sense to have FirstOrDefault which is a very common use case. Related #22484