Further cleanup of the code action api (5) (#80215)

Author: CyrusNajmabadi

src/EditorFeatures/CSharpTest/CodeActions/PreviewExceptionTests.cs

@@ -87,14 +87,14 @@ private static async Task ActionSets(EditorTestWorkspace workspace, CodeRefactor
         Assert.False(extensionManager.IsIgnored(provider));
     }
 
-    private static CodeRefactoringSuggestedAction CreateRefactoringSuggestedAction(EditorTestWorkspace workspace, CodeRefactoringProvider provider, out EditorLayerExtensionManager.ExtensionManager extensionManager)
+    private static SuggestedActionWithNestedFlavors CreateRefactoringSuggestedAction(EditorTestWorkspace workspace, CodeRefactoringProvider provider, out EditorLayerExtensionManager.ExtensionManager extensionManager)
     {
         var codeActions = new List<CodeAction>();
         RefactoringSetup(workspace, provider, codeActions, out extensionManager, out var textBuffer, out var document);
-        var suggestedAction = new CodeRefactoringSuggestedAction(
+        var suggestedAction = new SuggestedActionWithNestedFlavors(
             workspace.ExportProvider.GetExportedValue<IThreadingContext>(),
             workspace.ExportProvider.GetExportedValue<SuggestedActionsSourceProvider>(),
-            document, textBuffer, provider, codeActions.First(), fixAllFlavors: null);
+            document, textBuffer, provider, codeActions.First(), fixAllFlavors: null, diagnostic: null);
         return suggestedAction;
     }
 

src/EditorFeatures/Core/Suggestions/PreviewChanges/PreviewChangesCodeAction.cs

@@ -11,7 +11,7 @@
 
 namespace Microsoft.CodeAnalysis.Editor.Implementation.Suggestions;
 
-internal partial class SuggestedActionWithNestedFlavors
+internal sealed partial class SuggestedActionWithNestedFlavors
 {
     private sealed class PreviewChangesCodeAction(
         CodeAction originalCodeAction,

src/EditorFeatures/Core/Suggestions/RefineUsingCopilot/RefineUsingCopilotCodeAction.cs

@@ -11,9 +11,7 @@
 using Microsoft.CodeAnalysis.CodeActions;
 using Microsoft.CodeAnalysis.Collections;
 using Microsoft.CodeAnalysis.Copilot;
-using Microsoft.CodeAnalysis.Diagnostics;
 using Microsoft.CodeAnalysis.Shared.Extensions;
-using Roslyn.Utilities;
 
 namespace Microsoft.CodeAnalysis.Editor.Implementation.Suggestions;
 
@@ -26,7 +24,7 @@ internal partial class SuggestedActionWithNestedFlavors
     private sealed class RefineUsingCopilotCodeAction(
         Solution originalSolution,
         CodeAction originalCodeAction,
-        DiagnosticData? primaryDiagnostic,
+        Diagnostic? primaryDiagnostic,
         ICopilotCodeAnalysisService copilotCodeAnalysisService) : CodeAction
     {
         public override string Title => EditorFeaturesResources.Refine_using_Copilot;
@@ -73,12 +71,8 @@ protected override async Task<ImmutableArray<CodeActionOperation>> ComputeOperat
             var oldDocument = changeSummary.OldSolution.GetRequiredDocument(changedDocumentId);
             var newDocument = changeSummary.NewSolution.GetRequiredDocument(changedDocumentId);
 
-            var convertedPrimaryDiagnostic = primaryDiagnostic != null
-                ? await primaryDiagnostic.ToDiagnosticAsync(oldDocument.Project, cancellationToken).ConfigureAwait(false)
-                : null;
-
             cancellationToken.ThrowIfCancellationRequested();
-            return [new OpenRefinementSessionOperation(oldDocument, newDocument, convertedPrimaryDiagnostic, copilotCodeAnalysisService)];
+            return [new OpenRefinementSessionOperation(oldDocument, newDocument, primaryDiagnostic, copilotCodeAnalysisService)];
         }
 
         /// <summary>

src/EditorFeatures/Core/Suggestions/SuggestedActions/CodeFixSuggestedAction.cs

@@ -6,7 +6,9 @@
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.CodeAnalysis.CodeActions;
+using Microsoft.CodeAnalysis.CodeFixes;
 using Microsoft.CodeAnalysis.CodeFixesAndRefactorings;
+using Microsoft.CodeAnalysis.CodeRefactorings;
 using Microsoft.CodeAnalysis.Editor.Shared.Utilities;
 using Microsoft.CodeAnalysis.Internal.Log;
 using Microsoft.VisualStudio.Language.Intellisense;
@@ -24,28 +26,28 @@ internal sealed class RefactorOrFixAllSuggestedAction(
     ITextBuffer subjectBuffer,
     IRefactorOrFixAllState fixAllState,
     CodeAction originalCodeAction,
-    string? diagnosticTelemetryId,
-    AbstractFixAllCodeAction fixAllCodeAction)
+    string? diagnosticTelemetryId)
     : SuggestedAction(threadingContext,
         sourceProvider,
         originalSolution,
         subjectBuffer,
         fixAllState.FixAllProvider,
-        fixAllCodeAction),
+        fixAllState switch
+        {
+            FixAllState state => new FixAllCodeAction(state),
+            RefactorAllState state => new RefactorAllCodeAction(state),
+            _ => throw ExceptionUtilities.UnexpectedValue(fixAllState)
+        }),
     ITelemetryDiagnosticID<string?>
 {
-    public CodeAction OriginalCodeAction { get; } = originalCodeAction;
-
-    public IRefactorOrFixAllState FixAllState { get; } = fixAllState;
-
     public string? GetDiagnosticID() => diagnosticTelemetryId;
 
     public override bool TryGetTelemetryId(out Guid telemetryId)
     {
         // We get the telemetry id for the original code action we are fixing,
         // not the special 'FixAllCodeAction'.  that is the .CodeAction this
         // SuggestedAction is pointing at.
-        telemetryId = OriginalCodeAction.GetTelemetryId(FixAllState.Scope);
+        telemetryId = originalCodeAction.GetTelemetryId(fixAllState.Scope);
         return true;
     }
 
@@ -54,15 +56,15 @@ protected override async Task InnerInvokeAsync(
     {
         await this.ThreadingContext.JoinableTaskFactory.SwitchToMainThreadAsync(cancellationToken);
 
-        var fixAllKind = FixAllState.FixAllKind;
+        var fixAllKind = fixAllState.FixAllKind;
         var functionId = fixAllKind switch
         {
             FixAllKind.CodeFix => FunctionId.CodeFixes_FixAllOccurrencesSession,
             FixAllKind.Refactoring => FunctionId.Refactoring_FixAllOccurrencesSession,
             _ => throw ExceptionUtilities.UnexpectedValue(fixAllKind)
         };
 
-        using (Logger.LogBlock(functionId, FixAllLogger.CreateCorrelationLogMessage(FixAllState.CorrelationId), cancellationToken))
+        using (Logger.LogBlock(functionId, FixAllLogger.CreateCorrelationLogMessage(fixAllState.CorrelationId), cancellationToken))
         {
             await base.InnerInvokeAsync(progress, cancellationToken).ConfigureAwait(false);
         }

src/EditorFeatures/Core/Suggestions/SuggestedActions/CodeRefactoringSuggestedAction.cs

@@ -7,6 +7,7 @@
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.CodeAnalysis.CodeActions;
+using Microsoft.CodeAnalysis.CodeFixes;
 using Microsoft.CodeAnalysis.Copilot;
 using Microsoft.CodeAnalysis.Diagnostics;
 using Microsoft.CodeAnalysis.Editor.Host;
@@ -17,34 +18,37 @@
 using Microsoft.CodeAnalysis.Shared.Extensions;
 using Microsoft.CodeAnalysis.Text;
 using Microsoft.VisualStudio.Language.Intellisense;
+using Microsoft.VisualStudio.PlatformUI;
 using Microsoft.VisualStudio.Text;
 
 namespace Microsoft.CodeAnalysis.Editor.Implementation.Suggestions;
 
 /// <summary>
-/// Base type for all SuggestedActions that have 'flavors'.  'Flavors' are child actions that
-/// are presented as simple links, not as menu-items, in the light-bulb.  Examples of 'flavors'
-/// include 'preview changes' (for refactorings and fixes) and 'fix all in document, project, solution'
-/// (for refactorings and fixes).
+/// Type for all SuggestedActions that have 'flavors'.  'Flavors' are child actions that are presented as simple links,
+/// not as menu-items, in the light-bulb.  Examples of 'flavors' include 'preview changes' (for refactorings and fixes)
+/// and 'fix all in document, project, solution' (for refactorings and fixes).
 /// 
-/// Because all derivations support 'preview changes', we bake that logic into this base type.
+/// Supports 'preview changes' for all changes.
 /// </summary>
-internal abstract partial class SuggestedActionWithNestedFlavors(
+internal sealed partial class SuggestedActionWithNestedFlavors(
     IThreadingContext threadingContext,
     SuggestedActionsSourceProvider sourceProvider,
     TextDocument originalDocument,
     ITextBuffer subjectBuffer,
     object provider,
     CodeAction codeAction,
-    SuggestedActionSet? fixAllFlavors)
+    SuggestedActionSet? fixAllFlavors,
+    Diagnostic? diagnostic)
     : SuggestedAction(threadingContext,
         sourceProvider,
         originalDocument.Project.Solution,
         subjectBuffer,
         provider,
-        codeAction), ISuggestedActionWithFlavors
+        codeAction), ISuggestedActionWithFlavors, ITelemetryDiagnosticID<string?>
 {
     private readonly SuggestedActionSet? _fixAllFlavors = fixAllFlavors;
+    private readonly Diagnostic? _diagnostic = diagnostic;
+
     private ImmutableArray<SuggestedActionSet> _nestedFlavors;
 
     public TextDocument OriginalDocument { get; } = originalDocument;
@@ -139,7 +143,7 @@ await copilotService.IsAvailableAsync(cancellationToken).ConfigureAwait(false) i
 
             return CreateTrivialAction(
                 this, new RefineUsingCopilotCodeAction(
-                    this.OriginalSolution, this.CodeAction, this.GetDiagnostic(), copilotService));
+                    this.OriginalSolution, this.CodeAction, _diagnostic, copilotService));
         }
     }
 
@@ -193,8 +197,10 @@ await copilotService.IsAvailableAsync(cancellationToken).ConfigureAwait(false) i
         // GetPreviewPane() needs to run on the UI thread.
         this.ThreadingContext.ThrowIfNotOnUIThread();
 
-        return previewPaneService.GetPreviewPane(GetDiagnostic(), previewContents!);
+        var diagnosticData = _diagnostic is null ? null : CodeFix.GetDiagnosticData(this.OriginalDocument.Project, _diagnostic);
+        return previewPaneService.GetPreviewPane(diagnosticData, previewContents!);
     }
 
-    protected virtual DiagnosticData? GetDiagnostic() => null;
+    public string? GetDiagnosticID()
+        => _diagnostic?.GetTelemetryDiagnosticID();
 }

src/EditorFeatures/Core/Suggestions/SuggestedActions/AbstractFixAllSuggestedAction.cs renamed to src/EditorFeatures/Core/Suggestions/SuggestedActions/RefactorOrFixAllSuggestedAction.cs

@@ -287,25 +287,20 @@ async Task<ImmutableArray<UnifiedSuggestedActionSet>> GetRefactoringsAsync()
                 ISuggestedAction ConvertToSuggestedAction(UnifiedSuggestedAction unifiedSuggestedAction)
                     => unifiedSuggestedAction switch
                     {
-                        UnifiedCodeFixSuggestedAction codeFixAction => new CodeFixSuggestedAction(
+                        UnifiedCodeFixSuggestedAction codeFixAction => new SuggestedActionWithNestedFlavors(
                             _threadingContext, owner, originalDocument, subjectBuffer,
-                            codeFixAction.CodeFix, codeFixAction.Provider, codeFixAction.OriginalCodeAction,
-                            ConvertToSuggestedActionSet(codeFixAction.FixAllFlavors, originalDocument)),
-                        UnifiedCodeRefactoringSuggestedAction codeRefactoringAction => new CodeRefactoringSuggestedAction(
+                            codeFixAction.Provider, codeFixAction.OriginalCodeAction,
+                            ConvertToSuggestedActionSet(codeFixAction.FixAllFlavors, originalDocument),
+                            codeFixAction.CodeFix.PrimaryDiagnostic),
+                        UnifiedCodeRefactoringSuggestedAction codeRefactoringAction => new SuggestedActionWithNestedFlavors(
                             _threadingContext, owner, originalDocument, subjectBuffer,
                             codeRefactoringAction.Provider, codeRefactoringAction.OriginalCodeAction,
-                            ConvertToSuggestedActionSet(codeRefactoringAction.FixAllFlavors, originalDocument)),
-                        UnifiedFixAllCodeFixSuggestedAction fixAllAction
+                            ConvertToSuggestedActionSet(codeRefactoringAction.FixAllFlavors, originalDocument),
+                            diagnostic: null),
+                        UnifiedRefactorOrFixAllSuggestedAction refactorOrFixAllAction
                             => new RefactorOrFixAllSuggestedAction(
                                 _threadingContext, owner, originalSolution, subjectBuffer,
-                                fixAllAction.FixAllState, fixAllAction.OriginalCodeAction, fixAllAction.TelemetryId,
-                                new FixAllCodeAction(fixAllAction.FixAllState)),
-                        UnifiedRefactorAllCodeRefactoringSuggestedAction fixAllCodeRefactoringAction
-                            => new RefactorOrFixAllSuggestedAction(
-                                _threadingContext, owner, originalSolution, subjectBuffer,
-                                fixAllCodeRefactoringAction.FixAllState, fixAllCodeRefactoringAction.OriginalCodeAction,
-                                diagnosticTelemetryId: null,
-                                new RefactorAllCodeRefactoringCodeAction(fixAllCodeRefactoringAction.FixAllState)),
+                                refactorOrFixAllAction.FixAllState, refactorOrFixAllAction.OriginalCodeAction, refactorOrFixAllAction.TelemetryId),
                         UnifiedSuggestedActionWithNestedActions nestedAction => new SuggestedActionWithNestedActions(
                             _threadingContext, owner, originalSolution, subjectBuffer,
                             nestedAction.Provider, nestedAction.OriginalCodeAction,

src/EditorFeatures/Core/Suggestions/SuggestedActionWithNestedActions.cs renamed to src/EditorFeatures/Core/Suggestions/SuggestedActions/SuggestedActionWithNestedActions.cs

@@ -11,7 +11,7 @@ namespace Microsoft.CodeAnalysis.CodeRefactorings;
 /// <summary>
 /// Fix all code action for a code action registered by a <see cref="CodeRefactoringProvider"/>.
 /// </summary>
-internal sealed class RefactorAllCodeRefactoringCodeAction(IRefactorOrFixAllState fixAllState)
+internal sealed class RefactorAllCodeAction(IRefactorOrFixAllState fixAllState)
     : AbstractFixAllCodeAction(fixAllState, showPreviewChangesDialog: true)
 {
     protected override IRefactorOrFixAllContext CreateFixAllContext(IRefactorOrFixAllState fixAllState, IProgress<CodeAnalysisProgress> progressTracker, CancellationToken cancellationToken)