Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

SE - Nullable: Learn object constraint from value comparison #6925

Merged
merged 5 commits into from
Mar 16, 2023
Merged

SE - Nullable: Learn object constraint from value comparison #6925

merged 5 commits into from
Mar 16, 2023

Conversation

pavel-mikula-sonarsource
Copy link
Contributor

@pavel-mikula-sonarsource pavel-mikula-sonarsource commented Mar 14, 2023 •
edited
Loading

Part of #6812

if(arg == 42)
  // We know arg is NotNull
else
  // We don't know anything. It could be another NotNull, or it could be Null

Rebase will be needed once #6923 is merged

Base automatically changed from Pavel/SE/08-Branching-Null to feature/SE March 15, 2023 09:03
martin-strecker-sonarsource
martin-strecker-sonarsource requested changes Mar 15, 2023
View reviewed changes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There might be a regression for unknownNullableBool != null and that test case seems to be missing. Also changed test cases should use HaveOnlyConstraint().

analyzers/src/SonarAnalyzer.Common/SymbolicExecution/Roslyn/OperationProcessors/Binary.cs Outdated Show resolved Hide resolved
...r.UnitTest/SymbolicExecution/Roslyn/RoslynSymbolicExecutionTest.Branching.LearnConstraint.cs Outdated Show resolved Hide resolved
...r.UnitTest/SymbolicExecution/Roslyn/RoslynSymbolicExecutionTest.Branching.LearnConstraint.cs Outdated Show resolved Hide resolved
...r.UnitTest/SymbolicExecution/Roslyn/RoslynSymbolicExecutionTest.Branching.LearnConstraint.cs Outdated Show resolved Hide resolved
...r.UnitTest/SymbolicExecution/Roslyn/RoslynSymbolicExecutionTest.Branching.LearnConstraint.cs Show resolved Hide resolved
...r.UnitTest/SymbolicExecution/Roslyn/RoslynSymbolicExecutionTest.Branching.LearnConstraint.cs Outdated Show resolved Hide resolved
...r.UnitTest/SymbolicExecution/Roslyn/RoslynSymbolicExecutionTest.Branching.LearnConstraint.cs Show resolved Hide resolved
...r.UnitTest/SymbolicExecution/Roslyn/RoslynSymbolicExecutionTest.Branching.LearnConstraint.cs Show resolved Hide resolved
...r.UnitTest/SymbolicExecution/Roslyn/RoslynSymbolicExecutionTest.Branching.LearnConstraint.cs Show resolved Hide resolved
...r.UnitTest/SymbolicExecution/Roslyn/RoslynSymbolicExecutionTest.Branching.LearnConstraint.cs Show resolved Hide resolved
@pavel-mikula-sonarsource pavel-mikula-sonarsource marked this pull request as ready for review March 15, 2023 15:03
martin-strecker-sonarsource
martin-strecker-sonarsource requested changes Mar 15, 2023
View reviewed changes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A test case with bool? arg is still missing.

martin-strecker-sonarsource
martin-strecker-sonarsource requested changes Mar 16, 2023
View reviewed changes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Test coverage is good now. I have one suggestion for the special casing of the nullable bool you may want to give a try.

analyzers/src/SonarAnalyzer.Common/SymbolicExecution/Roslyn/OperationProcessors/Binary.cs Outdated
// We can fall through ?? because "constraint" and "testedSymbol" are exclusive. Symbols with the constraint will be recognized as "constraint" side.
if ((OperandConstraint(binary.LeftOperand) ?? OperandConstraint(binary.RightOperand)) is { } constraint
&& (OperandSymbolWithoutConstraint(binary.LeftOperand) ?? OperandSymbolWithoutConstraint(binary.RightOperand)) is { } testedSymbol)
&& (OperandSymbolWithoutConstraint(binary.LeftOperand) ?? OperandSymbolWithoutConstraint(binary.RightOperand)) is { } testedSymbol
&& !(useOpposite && constraint is BoolConstraint && testedSymbol.GetSymbolType().IsNullableBoolean()))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is really ugly special casing. Shouldn't this do the same thing 🤔 ?

Suggested change
&& !(useOpposite && constraint is BoolConstraint && testedSymbol.GetSymbolType().IsNullableBoolean()))
&& !(useOpposite && testedSymbol.GetSymbolType().IsNullable()))

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In theory should, until someone adds a BoolConstraint to something else than bool somewhere. I'll keep it as we don't have IsNullable and I don't want to add it for this

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

D'accord. Can you add a code comment with examples about why we need this special case and also add a hint that ObjectConstraint.ApplyOpposite(true) does the same logic but at a different place? Our future self will have a hard time understanding what is going on here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added

martin-strecker-sonarsource
martin-strecker-sonarsource requested changes Mar 16, 2023
View reviewed changes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A code comment is justified in this case.

martin-strecker-sonarsource
martin-strecker-sonarsource approved these changes Mar 16, 2023
View reviewed changes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 1 Code Smell

100.0% 100.0% Coverage
0.0% 0.0% Duplication

@pavel-mikula-sonarsource pavel-mikula-sonarsource merged commit 5158adc into feature/SE Mar 16, 2023
@pavel-mikula-sonarsource pavel-mikula-sonarsource deleted the Pavel/SE/09-Branching-Value branch March 16, 2023 13:39
pavel-mikula-sonarsource added a commit that referenced this pull request Mar 20, 2023
@pavel-mikula-sonarsource
SE - Nullable: Learn object constraint from value comparison (#6925)
a880e01
pavel-mikula-sonarsource added a commit that referenced this pull request Mar 28, 2023
@pavel-mikula-sonarsource
SE - Nullable: Learn object constraint from value comparison (#6925)
3e26197
pavel-mikula-sonarsource added a commit that referenced this pull request Mar 31, 2023
@pavel-mikula-sonarsource
SE - Nullable: Learn object constraint from value comparison (#6925)
d100351
pavel-mikula-sonarsource added a commit that referenced this pull request Apr 4, 2023
@pavel-mikula-sonarsource
SE - Nullable: Learn object constraint from value comparison (#6925)
83225ac
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@martin-strecker-sonarsource martin-strecker-sonarsource martin-strecker-sonarsource approved these changes

Assignees

@pavel-mikula-sonarsource pavel-mikula-sonarsource

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@pavel-mikula-sonarsource @martin-strecker-sonarsource