Implement CodeFix for CA2246 #3694

Youssef1313 · 2020-05-30T11:31:16Z

....CodeQuality.Analyzers/QualityGuidelines/AssigningSymbolAndItsMemberInSameStatement.Fixer.cs

...Quality.Analyzers/QualityGuidelines/AssigningSymbolAndItsMemberInSameStatementTests.Fixer.cs

mavasani · 2020-06-02T17:20:42Z

....CodeQuality.Analyzers/QualityGuidelines/AssigningSymbolAndItsMemberInSameStatement.Fixer.cs

+
+            string title = MicrosoftCodeQualityAnalyzersResources.AssigningSymbolAndItsMemberInSameStatementTitle;
+            context.RegisterCodeFix(new MyCodeAction(title,
+                 async ct => await SplitAssignment(context.Document, node, ct).ConfigureAwait(false),


I believe we should offer 3 code fixes here as suggested in #2527 (comment). Otherwise, we might misdirect user into making a breaking change assuming the tooling is recommending this code fix, hence it should be the appropriate one. CA2246 is certainly one case where we should either have all fixes or none.

@mavasani, Sure. I'd be happy to implement the other code fixes as soon as I get the current codefix working.

Youssef1313 · 2020-09-30T23:19:53Z

@Evangelink @mavasani This is ready for another look.

codecov · 2020-10-01T08:21:01Z

Codecov Report

Merging #3694 into master will decrease coverage by 48.83%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           master    #3694       +/-   ##
===========================================
- Coverage   95.80%   46.96%   -48.84%     
===========================================
  Files        1168      803      -365     
  Lines      264635    90387   -174248     
  Branches    15964     8623     -7341     
===========================================
- Hits       253544    42454   -211090     
- Misses       9077    46948    +37871     
+ Partials     2014      985     -1029

...t.CodeQuality.Analyzers/QualityGuidelines/AssigningSymbolAndItsMemberInSameStatementTests.cs

....CodeQuality.Analyzers/QualityGuidelines/AssigningSymbolAndItsMemberInSameStatement.Fixer.cs

...t.CodeQuality.Analyzers/QualityGuidelines/AssigningSymbolAndItsMemberInSameStatementTests.cs

....CodeQuality.Analyzers/QualityGuidelines/AssigningSymbolAndItsMemberInSameStatement.Fixer.cs

Youssef1313 · 2020-10-01T18:48:33Z

@Evangelink I wasn't able to handle the case of 4 assignment members (a.Property = c = a = b;), so I've done some refactoring. (or nearly a re-write). It seems to work (with one problem with handling trivia). But I feel the implementation can be improved.

Evangelink

I will need a second review (tomorrow) but there are some things off.

....CodeQuality.Analyzers/QualityGuidelines/AssigningSymbolAndItsMemberInSameStatement.Fixer.cs

Evangelink · 2020-10-01T20:01:20Z

....CodeQuality.Analyzers/QualityGuidelines/AssigningSymbolAndItsMemberInSameStatement.Fixer.cs

+                new MyCodeAction($"{title} 1", ct => GetDocument(context.Document, root, assignment.Parent, replacements1)),
+                new MyCodeAction($"{title} 2", ct => GetDocument(context.Document, root, assignment.Parent, replacements2))


The title parameter is what get displayed so it feels off to have XXX 1 and XXX 2.

@Evangelink I have this temporary until I can get with good titles. Do you have any suggestions? Not sure how to describe the code fixes.

src/NetAnalyzers/CSharp/AnalyzerReleases.Unshipped.md

Youssef1313 · 2020-10-10T17:20:51Z

I've fixed the trivia handling. However, all tests that contains a comparison of 4 elements (e.g. [|a.Property.Property|] = [|a.Property|] = a = b;) are failing.

It looks like that after the first replacement, the second will fail as it tries to replace a node that now isn't part of the syntax tree.

I faced such a problem before and the solution was to use ReplaceNode which takes a lambda to compute replacement. But that solution is very hard to apply in this specific case. I'm out of ideas for how to fix these tests.

Evangelink · 2020-10-12T09:19:50Z

...uality.Analyzers/QualityGuidelines/CSharpAssigningSymbolAndItsMemberInSameStatement.Fixer.cs

+            var replacements1 = replacements.Concat(GetAssignmentExpressionStatement(assignment.Left, mostRightMember, leadingTrivia, trailingTrivia));
+            var replacements2 = replacements.Concat(GetAssignmentExpressionStatement(members, leadingTrivia, trailingTrivia));
+
+#pragma warning disable RS1010 // Provide an explicit value for EquivalenceKey - false positve 


Instead of having this pragma, could we bump the version of the analyzer we are using to rely on one where I have fixed this issue?

@Evangelink Sure. Do you know which version got the fix?
We will also need to remove the suppression in:

roslyn-analyzers/src/NetAnalyzers/Core/Microsoft.CodeQuality.Analyzers/ApiDesignGuidelines/MarkAttributesWithAttributeUsage.Fixer.cs

Line 56 in 91b109f

#pragma warning disable RS1010 // Provide an explicit value for EquivalenceKey - false positive

Just made a test and it seems that the latest available pre-release (i.e. 3.3.1-beta1.20505.3) does not contain the fix so let's move on as-is and we will do a separate PR to get rid of both pragmas.

Evangelink · 2020-10-12T09:23:15Z

...uality.Analyzers/QualityGuidelines/CSharpAssigningSymbolAndItsMemberInSameStatement.Fixer.cs

+
+            while (members.Count > 2)
+            {
+                replacements.Add(GetAssignmentExpressionStatement(members, leadingTrivia, trailingTrivia));


I am not sure which change to suggest (maybe the method name) but when reviewing it feels weird because we loop on members.Count and it's not really clear there is a change to this variable. At first I thought there was a "silly" bug.

Evangelink · 2020-10-12T09:26:24Z

...uality.Analyzers/QualityGuidelines/CSharpAssigningSymbolAndItsMemberInSameStatement.Fixer.cs

+            var replacements1 = replacements.Concat(GetAssignmentExpressionStatement(assignment.Left, mostRightMember, leadingTrivia, trailingTrivia));
+            var replacements2 = replacements.Concat(GetAssignmentExpressionStatement(members, leadingTrivia, trailingTrivia));


Could you please use a meaningful name instead of XXX1 and XXX2? Maybe something like finalAssignmentToLeft and finalAssignmentToRight.

Evangelink · 2020-10-12T09:27:47Z

...uality.Analyzers/QualityGuidelines/CSharpAssigningSymbolAndItsMemberInSameStatement.Fixer.cs

+                new MyCodeAction($"{title} 1", ct => GetDocument(context.Document, root, assignment.Parent, replacements1)),
+                new MyCodeAction($"{title} 2", ct => GetDocument(context.Document, root, assignment.Parent, replacements2))


Same name suggestion here. We will currently see something like:

title |-> title 1 |-> title 2

in the lightbulb, that's not really helpful.

@Evangelink If I used the same wording you suggested in #3694 (comment) as titles (e.g. Split assignments with final assignment to the left variable), do you think it's good to the end-user?

I think so. @mavasani any opinion?

...uality.Analyzers/QualityGuidelines/CSharpAssigningSymbolAndItsMemberInSameStatement.Fixer.cs

...t.CodeQuality.Analyzers/QualityGuidelines/AssigningSymbolAndItsMemberInSameStatementTests.cs

Co-authored-by: Amaury Levé <evangelink@gmail.com>

Youssef1313 requested a review from a team as a code owner May 30, 2020 11:31

Youssef1313 commented May 30, 2020

View reviewed changes

....CodeQuality.Analyzers/QualityGuidelines/AssigningSymbolAndItsMemberInSameStatement.Fixer.cs Outdated Show resolved Hide resolved

sharwell reviewed Jun 2, 2020

View reviewed changes

...Quality.Analyzers/QualityGuidelines/AssigningSymbolAndItsMemberInSameStatementTests.Fixer.cs Outdated Show resolved Hide resolved

mavasani reviewed Jun 2, 2020

View reviewed changes

Implement CA2246 codefix

f7df990

Youssef1313 force-pushed the issue-2527 branch from 282bfb3 to f7df990 Compare September 30, 2020 23:18

Update the test to test both code actions

2db806b

Youssef1313 force-pushed the issue-2527 branch from b1a5d93 to 2db806b Compare September 30, 2020 23:41

No separation between analyzer and codefix tests

29f3918

Youssef1313 commented Oct 1, 2020

View reviewed changes

Minor fixes in tests

17c641a

Evangelink reviewed Oct 1, 2020

View reviewed changes

Refactor codefix

3768e90

Youssef1313 added 2 commits October 1, 2020 19:09

Convert more tests from analyzer tests to codefix tests

8e62dcd

Suppress false positive RS1010

f7fc00a

Evangelink reviewed Oct 1, 2020

View reviewed changes

Youssef1313 added 2 commits October 1, 2020 20:27

Improve trivia handling - still not working as expected

9d14a22

Move to C# layer and add to Unshipped

9b01d9d

Youssef1313 commented Oct 10, 2020

View reviewed changes

src/NetAnalyzers/CSharp/AnalyzerReleases.Unshipped.md Outdated Show resolved Hide resolved

Youssef1313 and others added 3 commits October 10, 2020 16:37

Fix namespaces and class names

b97a38c

Manually update AnalyzerReleases.*.md

111abcc

Revert Unshipped change

9de938a

Fix trivia handling

ebf37bd

Evangelink reviewed Oct 12, 2020

View reviewed changes

Apply suggestions from code review

56f180d

Co-authored-by: Amaury Levé <evangelink@gmail.com>

Apply suggestion from code review

f82374a

Co-authored-by: Amaury Levé <evangelink@gmail.com>

Base automatically changed from master to main March 5, 2021 02:20

mavasani assigned genlu and jmarolf May 20, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement CodeFix for CA2246 #3694

Implement CodeFix for CA2246 #3694

Youssef1313 commented May 30, 2020

mavasani Jun 2, 2020

Youssef1313 Jun 2, 2020

Youssef1313 commented Sep 30, 2020

codecov bot commented Oct 1, 2020 •

edited

Youssef1313 commented Oct 1, 2020

Evangelink left a comment

Evangelink Oct 1, 2020

Youssef1313 Oct 1, 2020

Youssef1313 commented Oct 10, 2020

Evangelink Oct 12, 2020

Youssef1313 Oct 12, 2020

Evangelink Oct 12, 2020

Evangelink Oct 12, 2020

Evangelink Oct 12, 2020

Evangelink Oct 12, 2020

Youssef1313 Oct 12, 2020

Evangelink Oct 12, 2020

		new MyCodeAction($"{title} 1", ct => GetDocument(context.Document, root, assignment.Parent, replacements1)),
		new MyCodeAction($"{title} 2", ct => GetDocument(context.Document, root, assignment.Parent, replacements2))

		var replacements1 = replacements.Concat(GetAssignmentExpressionStatement(assignment.Left, mostRightMember, leadingTrivia, trailingTrivia));
		var replacements2 = replacements.Concat(GetAssignmentExpressionStatement(members, leadingTrivia, trailingTrivia));

Implement CodeFix for CA2246 #3694

Are you sure you want to change the base?

Implement CodeFix for CA2246 #3694

Conversation

Youssef1313 commented May 30, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Youssef1313 commented Sep 30, 2020

codecov bot commented Oct 1, 2020 • edited

Codecov Report

Youssef1313 commented Oct 1, 2020

Evangelink left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Youssef1313 commented Oct 10, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Oct 1, 2020 •

edited