Some code actions ordering and cleanup (#11659)

There was some feedback on Reddit this morning about code action
ordering and Extract to Component being a little "in your face". See
https://www.reddit.com/r/Blazor/comments/1jjg3bh/am_i_doing_something_wrong_or_is_intellisense_and/mjq7jp3/?context=3
and the rest of the thread in general.

This PR:

* Makes sure Extract to Component always last, since it is offered
basically everywhere
* Makes sure Add Using and Fully Qualify are always first, since they're
the most likely code actions people want
* Ensures Extract to Code Behind is offered at `$$@code` since
previously there would be no light bulb in that situation, but now there
is and muscle-memory makes people hit it, which extract the code block
to a new component, which is not what they want.

Note that the ordering here is only among the Razor code actions. All C#
and Html code actions are always still after the Razor code actions,
even Extract to Component.

Author: davidwengier

src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/CodeActions/CodeActionsService.cs

@@ -246,7 +246,7 @@ private static async Task<ImmutableArray<RazorVSInternalCodeAction>> Consolidate
     {
         var results = await Task.WhenAll(tasks).ConfigureAwait(false);
 
-        using var codeActions = new PooledArrayBuilder<RazorVSInternalCodeAction>();
+        using var codeActions = new PooledArrayBuilder<RazorVSInternalCodeAction>(capacity: tasks.Length);
 
         cancellationToken.ThrowIfCancellationRequested();
 
@@ -255,7 +255,7 @@ private static async Task<ImmutableArray<RazorVSInternalCodeAction>> Consolidate
             codeActions.AddRange(result);
         }
 
-        return codeActions.ToImmutable();
+        return codeActions.DrainToImmutableOrderedBy(static r => r.Order);
     }
 
     private static ImmutableHashSet<string> GetAllAvailableCodeActionNames()

src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/CodeActions/Models/RazorVSInternalCodeAction.cs

@@ -13,4 +13,10 @@ internal sealed class RazorVSInternalCodeAction : VSInternalCodeAction
     [JsonPropertyName("name")]
     [DataMember(Name = "name")]
     public string? Name { get; set; }
+
+    /// <summary>
+    /// The order code actions should appear. This is not serialized as its just used in the code actions service
+    /// </summary>
+    [JsonIgnore]
+    public int Order { get; set; }
 }

src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/CodeActions/Razor/ExtractToCodeBehindCodeActionProvider.cs

@@ -57,6 +57,9 @@ public Task<ImmutableArray<RazorVSInternalCodeAction>> ProvideAsync(RazorCodeAct
             // When the caret is '@$$code' or '@c$$ode' or '@co$$de' or '@cod$$e' then tree is:
             // RazorDirective -> RazorDirectiveBody -> MetaCode
             RazorDirectiveBodySyntax { Parent: RazorDirectiveSyntax d } => d,
+            // When the caret is '$$@code' then tree is:
+            // RazorDirective
+            RazorDirectiveSyntax d => d,
             _ => null
         };
         if (directiveNode is null)

src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/CodeActions/Razor/RazorCodeActionFactory.cs

@@ -48,7 +48,10 @@ public static RazorVSInternalCodeAction CreateAddComponentUsing(string @namespac
             Title = newTagName is null ? title : $"{newTagName} - {title}",
             Data = data,
             TelemetryId = s_addComponentUsingTelemetryId,
-            Priority = VSInternalPriorityLevel.High
+            Priority = VSInternalPriorityLevel.High,
+            Name = LanguageServerConstants.CodeActions.AddUsing,
+            // Adding a using for an existing component should be first
+            Order = -1000,
         };
         return codeAction;
     }
@@ -60,46 +63,51 @@ public static RazorVSInternalCodeAction CreateFullyQualifyComponent(string fully
             Title = fullyQualifiedName,
             Edit = workspaceEdit,
             TelemetryId = s_fullyQualifyComponentTelemetryId,
-            Priority = VSInternalPriorityLevel.High
+            Priority = VSInternalPriorityLevel.High,
+            Name = LanguageServerConstants.CodeActions.FullyQualify,
+            // Fully qualifying an existing component should be very high, but not quite as high as Add Using
+            Order = -900,
         };
         return codeAction;
     }
 
     public static RazorVSInternalCodeAction CreateComponentFromTag(RazorCodeActionResolutionParams resolutionParams)
     {
-        var title = SR.Create_Component_FromTag_Title;
         var data = JsonSerializer.SerializeToElement(resolutionParams);
         var codeAction = new RazorVSInternalCodeAction()
         {
-            Title = title,
+            Title = SR.Create_Component_FromTag_Title,
             Data = data,
             TelemetryId = s_createComponentFromTagTelemetryId,
+            Name = LanguageServerConstants.CodeActions.CreateComponentFromTag,
         };
         return codeAction;
     }
 
     public static RazorVSInternalCodeAction CreateExtractToCodeBehind(RazorCodeActionResolutionParams resolutionParams)
     {
-        var title = SR.ExtractTo_CodeBehind_Title;
         var data = JsonSerializer.SerializeToElement(resolutionParams);
         var codeAction = new RazorVSInternalCodeAction()
         {
-            Title = title,
+            Title = SR.ExtractTo_CodeBehind_Title,
             Data = data,
             TelemetryId = s_createExtractToCodeBehindTelemetryId,
+            Name = LanguageServerConstants.CodeActions.ExtractToCodeBehindAction,
         };
         return codeAction;
     }
 
     public static RazorVSInternalCodeAction CreateExtractToComponent(RazorCodeActionResolutionParams resolutionParams)
     {
-        var title = SR.ExtractTo_Component_Title;
         var data = JsonSerializer.SerializeToElement(resolutionParams);
         var codeAction = new RazorVSInternalCodeAction()
         {
-            Title = title,
+            Title = SR.ExtractTo_Component_Title,
             Data = data,
             TelemetryId = s_createExtractToComponentTelemetryId,
+            Name = LanguageServerConstants.CodeActions.ExtractToNewComponentAction,
+            // Since Extract to Component is offered basically everywhere, always offer it last
+            Order = 9999
         };
         return codeAction;
     }
@@ -127,7 +135,8 @@ public static RazorVSInternalCodeAction CreateGenerateMethod(VSTextDocumentIdent
         {
             Title = title,
             Data = data,
-            TelemetryId = s_generateMethodTelemetryId
+            TelemetryId = s_generateMethodTelemetryId,
+            Name = LanguageServerConstants.CodeActions.GenerateEventHandler,
         };
         return codeAction;
     }
@@ -155,7 +164,8 @@ public static RazorVSInternalCodeAction CreateAsyncGenerateMethod(VSTextDocument
         {
             Title = title,
             Data = data,
-            TelemetryId = s_generateAsyncMethodTelemetryId
+            TelemetryId = s_generateAsyncMethodTelemetryId,
+            Name = LanguageServerConstants.CodeActions.GenerateAsyncEventHandler,
         };
         return codeAction;
     }

src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Protocol/LanguageServerConstants.cs

@@ -35,6 +35,8 @@ public static class CodeActions
     {
         public const string GenerateEventHandler = "GenerateEventHandler";
 
+        public const string GenerateAsyncEventHandler = "GenerateAsyncEventHandler";
+
         public const string EditBasedCodeActionCommand = "EditBasedCodeActionCommand";
 
         public const string ExtractToCodeBehindAction = "ExtractToCodeBehind";
@@ -45,6 +47,8 @@ public static class CodeActions
 
         public const string AddUsing = "AddUsing";
 
+        public const string FullyQualify = "FullyQualify";
+
         public const string PromoteUsingDirective = "PromoteUsingDirective";
 
         public const string CodeActionFromVSCode = "CodeActionFromVSCode";