Merge pull request #15445 from CyrusNajmabadi/deterministicCodeActionApplication

Make BatchFix code action application deterministic.

src/EditorFeatures/VisualBasicTest/PopulateSwitch/PopulateSwitchTests_FixAllTests.vb

@@ -454,7 +454,7 @@ End Class]]>
                                </Project>
                            </Workspace>.ToString()
 
-            Await TestAsync(input, expected, compareTokens:=False, fixAllActionEquivalenceKey:=Nothing)
+            Await TestAsync(input, expected, compareTokens:=False)
         End Function
     End Class
 End Namespace
\ No newline at end of file

src/Features/Core/Portable/CodeFixes/Suppression/AbstractSuppressionCodeFixProvider.PragmaWarningBatchFixAllProvider.cs

 // Copyright (c) Microsoft.  All Rights Reserved.  Licensed under the Apache License, Version 2.0.  See License.txt in the project root for license information.
 
 using System;
+using System.Collections.Concurrent;
 using System.Collections.Immutable;
 using System.Linq;
 using System.Threading;
@@ -24,8 +25,9 @@ public PragmaWarningBatchFixAllProvider(AbstractSuppressionCodeFixProvider suppr
                 _suppressionFixProvider = suppressionFixProvider;
             }
 
-            public override async Task AddDocumentFixesAsync(
-                Document document, ImmutableArray<Diagnostic> diagnostics, Action<CodeAction> addFix,
+            protected override async Task AddDocumentFixesAsync(
+                Document document, ImmutableArray<Diagnostic> diagnostics, 
+                ConcurrentBag<(Diagnostic diagnostic, CodeAction action)> fixes,
                 FixAllState fixAllState, CancellationToken cancellationToken)
             {
                 var pragmaActionsBuilder = ArrayBuilder<IPragmaBasedCodeAction>.GetInstance();
@@ -58,9 +60,9 @@ public PragmaWarningBatchFixAllProvider(AbstractSuppressionCodeFixProvider suppr
                         pragmaDiagnosticsBuilder.ToImmutableAndFree(), 
                         fixAllState, cancellationToken);
 
-                    addFix(pragmaBatchFix);
+                    fixes.Add((diagnostic: null, pragmaBatchFix));
                 }
             }
         }
     }
-}
+}
\ No newline at end of file

src/Features/Core/Portable/CodeFixes/Suppression/AbstractSuppressionCodeFixProvider.RemoveSuppressionCodeAction.BatchFixer.cs

 // Copyright (c) Microsoft.  All Rights Reserved.  Licensed under the Apache License, Version 2.0.  See License.txt in the project root for license information.
 
 using System;
+using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.Collections.Immutable;
 using System.Linq;
@@ -32,8 +33,9 @@ public BatchFixer(AbstractSuppressionCodeFixProvider suppressionFixProvider)
                     _suppressionFixProvider = suppressionFixProvider;
                 }
 
-                public override async Task AddDocumentFixesAsync(
-                    Document document, ImmutableArray<Diagnostic> diagnostics, Action<CodeAction> addFix,
+                protected override async Task AddDocumentFixesAsync(
+                    Document document, ImmutableArray<Diagnostic> diagnostics, 
+                    ConcurrentBag<(Diagnostic diagnostic, CodeAction action)> fixes,
                     FixAllState fixAllState, CancellationToken cancellationToken)
                 {
                     // Batch all the pragma remove suppression fixes by executing them sequentially for the document.
@@ -64,7 +66,7 @@ public BatchFixer(AbstractSuppressionCodeFixProvider suppressionFixProvider)
                                 }
                                 else
                                 {
-                                    addFix(codeAction);
+                                    fixes.Add((diagnostic, codeAction));
                                 }
                             }
                         }
@@ -79,12 +81,13 @@ public BatchFixer(AbstractSuppressionCodeFixProvider suppressionFixProvider)
                             pragmaDiagnosticsBuilder.ToImmutableAndFree(),
                             fixAllState, cancellationToken);
 
-                        addFix(pragmaBatchFix);
+                        fixes.Add((diagnostic: null, pragmaBatchFix));
                     }
                 }
 
-                public async override Task AddProjectFixesAsync(
-                    Project project, ImmutableArray<Diagnostic> diagnostics, Action<CodeAction> addFix, 
+                protected async override Task AddProjectFixesAsync(
+                    Project project, ImmutableArray<Diagnostic> diagnostics, 
+                    ConcurrentBag<(Diagnostic diagnostic, CodeAction action)> bag, 
                     FixAllState fixAllState, CancellationToken cancellationToken)
                 {
                     foreach (var diagnostic in diagnostics.Where(d => !d.Location.IsInSource && d.IsSuppressed))
@@ -99,13 +102,15 @@ public BatchFixer(AbstractSuppressionCodeFixProvider suppressionFixProvider)
                                 removeSuppressionCodeAction = removeSuppressionCodeAction.CloneForFixMultipleContext();
                             }
 
-                            addFix(removeSuppressionCodeAction);
+                            bag.Add((diagnostic, removeSuppressionCodeAction));
                         }
                     }
                 }
 
                 public override async Task<CodeAction> TryGetMergedFixAsync(
-                    IEnumerable<CodeAction> batchOfFixes, FixAllState fixAllState, CancellationToken cancellationToken)
+                    ImmutableArray<(Diagnostic diagnostic, CodeAction action)> batchOfFixes, 
+                    FixAllState fixAllState, 
+                    CancellationToken cancellationToken)
                 {
                     // Batch all the attribute removal fixes into a single fix.
                     // Pragma removal fixes have already been batch for each document AddDocumentFixes method.
@@ -115,10 +120,10 @@ public BatchFixer(AbstractSuppressionCodeFixProvider suppressionFixProvider)
                     var currentSolution = oldSolution;
 
                     var attributeRemoveFixes = new List<AttributeRemoveAction>();
-                    var newBatchOfFixes = new List<CodeAction>();
+                    var newBatchOfFixes = new List<(Diagnostic diagnostic, CodeAction action)>();
                     foreach (var codeAction in batchOfFixes)
                     {
-                        var attributeRemoveFix = codeAction as AttributeRemoveAction;
+                        var attributeRemoveFix = codeAction.action as AttributeRemoveAction;
                         if (attributeRemoveFix != null)
                         {
                             attributeRemoveFixes.Add(attributeRemoveFix);
@@ -152,10 +157,11 @@ public BatchFixer(AbstractSuppressionCodeFixProvider suppressionFixProvider)
                             equivalenceKey: fixAllState.CodeActionEquivalenceKey);
 #pragma warning restore RS0005 // Do not use generic CodeAction.Create to create CodeAction
 
-                        newBatchOfFixes.Insert(0, batchAttributeRemoveFix);
+                        newBatchOfFixes.Insert(0, (diagnostic: null, batchAttributeRemoveFix));
                     }
 
-                    return await base.TryGetMergedFixAsync(newBatchOfFixes, fixAllState, cancellationToken).ConfigureAwait(false);
+                    return await base.TryGetMergedFixAsync(
+                        newBatchOfFixes.ToImmutableArray(), fixAllState, cancellationToken).ConfigureAwait(false);
                 }
 
                 private static async Task<ImmutableArray<SyntaxNode>> GetAttributeNodesToFixAsync(ImmutableArray<AttributeRemoveAction> attributeRemoveFixes, CancellationToken cancellationToken)

src/Workspaces/Core/Portable/CodeFixes/FixAllOccurrences/BatchSimplificationFixAllProvider.cs

 // Copyright (c) Microsoft.  All Rights Reserved.  Licensed under the Apache License, Version 2.0.  See License.txt in the project root for license information.
 
 using System;
+using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.Collections.Immutable;
 using System.Linq;
@@ -24,15 +25,16 @@ internal class BatchSimplificationFixAllProvider : BatchFixAllProvider
 
         protected BatchSimplificationFixAllProvider() { }
 
-        public override async Task AddDocumentFixesAsync(
-            Document document, ImmutableArray<Diagnostic> diagnostics, Action<CodeAction> addFix, 
+        protected override async Task AddDocumentFixesAsync(
+            Document document, ImmutableArray<Diagnostic> diagnostics, 
+            ConcurrentBag<(Diagnostic diagnostic, CodeAction action)> fixes, 
             FixAllState fixAllState, CancellationToken cancellationToken)
         {
             var changedDocument = await AddSimplifierAnnotationsAsync(
                 document, diagnostics, fixAllState, cancellationToken).ConfigureAwait(false);
             var title = GetFixAllTitle(fixAllState);
-            var codeAction = new MyCodeAction(title, (c) => Task.FromResult(changedDocument));
-            addFix(codeAction);
+            var codeAction = new MyCodeAction(title, c => Task.FromResult(changedDocument));
+            fixes.Add((diagnostics.First(), codeAction));
         }
 
         /// <summary>

src/Workspaces/Core/Portable/CodeFixes/FixAllOccurrences/FixAllLogger.cs

@@ -126,11 +126,11 @@ public static void LogDiagnosticsStats(ImmutableDictionary<Project, ImmutableArr
             }));
         }
 
-        public static void LogFixesToMergeStats(ConcurrentBag<CodeAction> fixesToMerge)
+        public static void LogFixesToMergeStats(int count)
         {
             Logger.Log(FunctionId.CodeFixes_FixAllOccurrencesComputation_Merge, KeyValueLogMessage.Create(m =>
             {
-                m[s_totalFixesToMerge] = fixesToMerge.Count;
+                m[s_totalFixesToMerge] = count;
             }));
         }
     }