Revert "Revert "Add Advanced Settings For Razor"" (#8181)

Author: Andrew Hall

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/DefaultRazorConfigurationService.cs

@@ -7,11 +7,12 @@
 using Microsoft.CodeAnalysis.Razor.Editor;
 using Microsoft.Extensions.Logging;
 using Microsoft.VisualStudio.LanguageServer.Protocol;
+using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 
 namespace Microsoft.AspNetCore.Razor.LanguageServer;
 
-internal class DefaultRazorConfigurationService : RazorConfigurationService
+internal class DefaultRazorConfigurationService : IConfigurationSyncService
 {
     private readonly ClientNotifierServiceBase _server;
     private readonly ILogger _logger;
@@ -32,7 +33,7 @@ public DefaultRazorConfigurationService(ClientNotifierServiceBase languageServer
         _logger = loggerFactory.CreateLogger<DefaultRazorConfigurationService>();
     }
 
-    public async override Task<RazorLSPOptions?> GetLatestOptionsAsync(CancellationToken cancellationToken)
+    public async Task<RazorLSPOptions?> GetLatestOptionsAsync(CancellationToken cancellationToken)
     {
         try
         {
@@ -76,7 +77,7 @@ private static ConfigurationParams GenerateConfigParams()
                 new ConfigurationItem()
                 {
                     Section = "vs.editor.razor"
-                },
+                }
             }
         };
     }
@@ -85,9 +86,9 @@ private static ConfigurationParams GenerateConfigParams()
     internal RazorLSPOptions BuildOptions(JObject[] result)
     {
         ExtractVSCodeOptions(result, out var trace, out var enableFormatting, out var autoClosingTags);
-        ExtractVSOptions(result, out var insertSpaces, out var tabSize);
+        var settings = ExtractVSOptions(result) ?? ClientSettings.Default;
 
-        return new RazorLSPOptions(trace, enableFormatting, autoClosingTags, insertSpaces, tabSize);
+        return new RazorLSPOptions(trace, enableFormatting, autoClosingTags, settings);
     }
 
     private void ExtractVSCodeOptions(
@@ -129,29 +130,32 @@ private void ExtractVSCodeOptions(
         }
     }
 
-    private void ExtractVSOptions(
-        JObject[] result,
-        out bool insertSpaces,
-        out int tabSize)
+    private ClientSettings ExtractVSOptions(JObject[] result)
     {
-        var vsEditor = result[2];
+        try
+        {
+            var settings = result[2]?.ToObject<ClientSettings>();
+            if (settings is null)
+            {
+                return ClientSettings.Default;
+            }
 
-        insertSpaces = RazorLSPOptions.Default.InsertSpaces;
-        tabSize = RazorLSPOptions.Default.TabSize;
+            // Deserializing can result in null properties. Fill with default as needed
+            if (settings.ClientSpaceSettings is null)
+            {
+                settings = settings with { ClientSpaceSettings = ClientSpaceSettings.Default };
+            }
 
-        if (vsEditor is null)
-        {
-            return;
-        }
+            if (settings.AdvancedSettings is null)
+            {
+                settings = settings with { AdvancedSettings = ClientAdvancedSettings.Default };
+            }
 
-        if (vsEditor.TryGetValue(nameof(EditorSettings.IndentWithTabs), out var parsedInsertTabs))
-        {
-            insertSpaces = !GetObjectOrDefault(parsedInsertTabs, insertSpaces);
+            return settings;
         }
-
-        if (vsEditor.TryGetValue(nameof(EditorSettings.IndentSize), out var parsedTabSize))
+        catch (JsonReaderException)
         {
-            tabSize = GetObjectOrDefault(parsedTabSize, tabSize);
+            return ClientSettings.Default;
         }
     }
 

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/Extensions/IServiceCollectionExtensions.cs

@@ -166,7 +166,7 @@ public static void AddTextDocumentServices(this IServiceCollection services)
 
     public static void AddOptionsServices(this IServiceCollection services)
     {
-        services.AddSingleton<RazorConfigurationService, DefaultRazorConfigurationService>();
+        services.AddSingleton<IConfigurationSyncService, DefaultRazorConfigurationService>();
         services.AddSingleton<RazorLSPOptionsMonitor>();
         services.AddSingleton<IOptionsMonitor<RazorLSPOptions>, RazorLSPOptionsMonitor>();
     }

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/Formatting/CSharpOnTypeFormattingPass.cs

@@ -20,6 +20,7 @@
 using Microsoft.CodeAnalysis.Razor.Workspaces.Extensions;
 using Microsoft.CodeAnalysis.Text;
 using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
 using Microsoft.VisualStudio.LanguageServer.Protocol;
 using SyntaxNode = Microsoft.AspNetCore.Razor.Language.Syntax.SyntaxNode;
 using TextSpan = Microsoft.CodeAnalysis.Text.TextSpan;
@@ -29,10 +30,12 @@ namespace Microsoft.AspNetCore.Razor.LanguageServer.Formatting;
 internal class CSharpOnTypeFormattingPass : CSharpFormattingPassBase
 {
     private readonly ILogger _logger;
+    private readonly IOptionsMonitor<RazorLSPOptions> _optionsMonitor;
 
     public CSharpOnTypeFormattingPass(
         RazorDocumentMappingService documentMappingService,
         ClientNotifierServiceBase server,
+        IOptionsMonitor<RazorLSPOptions> optionsMonitor,
         ILoggerFactory loggerFactory)
         : base(documentMappingService, server)
     {
@@ -42,11 +45,12 @@ public CSharpOnTypeFormattingPass(
         }
 
         _logger = loggerFactory.CreateLogger<CSharpOnTypeFormattingPass>();
+        _optionsMonitor = optionsMonitor;
     }
 
     public async override Task<FormattingResult> ExecuteAsync(FormattingContext context, FormattingResult result, CancellationToken cancellationToken)
     {
-        if (!context.IsFormatOnType || result.Kind != RazorLanguageKind.CSharp)
+        if (!context.IsFormatOnType || result.Kind != RazorLanguageKind.CSharp || !_optionsMonitor.CurrentValue.FormatOnType)
         {
             // We don't want to handle regular formatting or non-C# on type formatting here.
             return result;

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/Formatting/HtmlFormattingPass.cs

@@ -13,6 +13,7 @@
 using Microsoft.AspNetCore.Razor.LanguageServer.Protocol;
 using Microsoft.CodeAnalysis.Text;
 using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
 using Microsoft.VisualStudio.LanguageServer.Protocol;
 using TextSpan = Microsoft.CodeAnalysis.Text.TextSpan;
 
@@ -21,11 +22,13 @@ namespace Microsoft.AspNetCore.Razor.LanguageServer.Formatting;
 internal class HtmlFormattingPass : FormattingPassBase
 {
     private readonly ILogger _logger;
+    private readonly IOptionsMonitor<RazorLSPOptions> _optionsMonitor;
 
     public HtmlFormattingPass(
         RazorDocumentMappingService documentMappingService,
         ClientNotifierServiceBase server,
         DocumentVersionCache documentVersionCache,
+        IOptionsMonitor<RazorLSPOptions> optionsMonitor,
         ILoggerFactory loggerFactory)
         : base(documentMappingService, server)
     {
@@ -37,6 +40,7 @@ public HtmlFormattingPass(
         _logger = loggerFactory.CreateLogger<HtmlFormattingPass>();
 
         HtmlFormatter = new HtmlFormatter(server, documentVersionCache);
+        _optionsMonitor = optionsMonitor;
     }
 
     // We want this to run first because it uses the client HTML formatter.
@@ -52,7 +56,7 @@ public async override Task<FormattingResult> ExecuteAsync(FormattingContext cont
 
         TextEdit[] htmlEdits;
 
-        if (context.IsFormatOnType && result.Kind == RazorLanguageKind.Html)
+        if (context.IsFormatOnType && result.Kind == RazorLanguageKind.Html && _optionsMonitor.CurrentValue.FormatOnType)
         {
             htmlEdits = await HtmlFormatter.FormatOnTypeAsync(context, cancellationToken).ConfigureAwait(false);
         }

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/Formatting/RazorDocumentOnTypeFormattingEndpoint.cs

@@ -82,6 +82,12 @@ public TextDocumentIdentifier GetTextDocumentIdentifier(DocumentOnTypeFormatting
             return null;
         }
 
+        if (!_optionsMonitor.CurrentValue.FormatOnType)
+        {
+            requestContext.Logger.LogInformation("Formatting on type disabled.");
+            return null;
+        }
+
         if (!s_allTriggerCharacters.Contains(request.Character, StringComparer.Ordinal))
         {
             requestContext.Logger.LogWarning("Unexpected trigger character '{requestCharacter}'.", request.Character);

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/RazorConfigurationService.cs renamed to src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/IConfigurationSyncService.cs

@@ -6,7 +6,10 @@
 
 namespace Microsoft.AspNetCore.Razor.LanguageServer;
 
-internal abstract class RazorConfigurationService
+/// <summary>
+/// Service that syncs settings from the client to the LSP server
+/// </summary>
+internal interface IConfigurationSyncService
 {
-    public abstract Task<RazorLSPOptions?> GetLatestOptionsAsync(CancellationToken cancellationToken);
+    Task<RazorLSPOptions?> GetLatestOptionsAsync(CancellationToken cancellationToken);
 }

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/RazorLSPOptions.cs

@@ -1,38 +1,28 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the MIT license. See License.txt in the project root for license information.
 
-using System;
-using Microsoft.Extensions.Internal;
+using Microsoft.CodeAnalysis.Razor.Editor;
 using Microsoft.Extensions.Logging;
 
 namespace Microsoft.AspNetCore.Razor.LanguageServer;
 
-internal class RazorLSPOptions : IEquatable<RazorLSPOptions>
+public record RazorLSPOptions(
+    Trace Trace,
+    bool EnableFormatting,
+    bool AutoClosingTags,
+    bool InsertSpaces,
+    int TabSize,
+    bool FormatOnType)
 {
-    public RazorLSPOptions(Trace trace, bool enableFormatting, bool autoClosingTags, bool insertSpaces, int tabSize)
+    public RazorLSPOptions(Trace trace, bool enableFormatting, bool autoClosingTags, ClientSettings settings)
+        : this(trace, enableFormatting, autoClosingTags, !settings.ClientSpaceSettings.IndentWithTabs, settings.ClientSpaceSettings.IndentSize, settings.AdvancedSettings.FormatOnType)
     {
-        Trace = trace;
-        EnableFormatting = enableFormatting;
-        AutoClosingTags = autoClosingTags;
-        TabSize = tabSize;
-        InsertSpaces = insertSpaces;
     }
 
-    public static RazorLSPOptions Default =>
-        new(trace: default, enableFormatting: true, autoClosingTags: true, insertSpaces: true, tabSize: 4);
-
-    public Trace Trace { get; }
+    public readonly static RazorLSPOptions Default = new(Trace: default, EnableFormatting: true, AutoClosingTags: true, InsertSpaces: true, TabSize: 4, FormatOnType: true);
 
     public LogLevel MinLogLevel => GetLogLevelForTrace(Trace);
 
-    public bool EnableFormatting { get; }
-
-    public bool AutoClosingTags { get; }
-
-    public int TabSize { get; }
-
-    public bool InsertSpaces { get; }
-
     public static LogLevel GetLogLevelForTrace(Trace trace)
         => trace switch
         {
@@ -41,26 +31,4 @@ public static LogLevel GetLogLevelForTrace(Trace trace)
             Trace.Verbose => LogLevel.Trace,
             _ => LogLevel.None,
         };
-
-    public bool Equals(RazorLSPOptions? other)
-        => other is not null &&
-           Trace == other.Trace &&
-           EnableFormatting == other.EnableFormatting &&
-           AutoClosingTags == other.AutoClosingTags &&
-           InsertSpaces == other.InsertSpaces &&
-           TabSize == other.TabSize;
-
-    public override bool Equals(object? obj)
-        => Equals(obj as RazorLSPOptions);
-
-    public override int GetHashCode()
-    {
-        var hash = new HashCodeCombiner();
-        hash.Add(Trace);
-        hash.Add(EnableFormatting);
-        hash.Add(AutoClosingTags);
-        hash.Add(InsertSpaces);
-        hash.Add(TabSize);
-        return hash;
-    }
 }

src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/RazorLSPOptionsMonitor.cs

@@ -10,12 +10,12 @@ namespace Microsoft.AspNetCore.Razor.LanguageServer;
 
 internal class RazorLSPOptionsMonitor : IOptionsMonitor<RazorLSPOptions>
 {
-    private readonly RazorConfigurationService _configurationService;
+    private readonly IConfigurationSyncService _configurationService;
     private readonly IOptionsMonitorCache<RazorLSPOptions> _cache;
     private event Action<RazorLSPOptions, string>? OnChangeEvent;
     private RazorLSPOptions _currentValue;
 
-    public RazorLSPOptionsMonitor(RazorConfigurationService configurationService, IOptionsMonitorCache<RazorLSPOptions> cache)
+    public RazorLSPOptionsMonitor(IConfigurationSyncService configurationService, IOptionsMonitorCache<RazorLSPOptions> cache)
     {
         if (configurationService is null)
         {

src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Editor/ClientSettings.cs

@@ -0,0 +1,31 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the MIT license. See License.txt in the project root for license information.
+
+using System;
+
+namespace Microsoft.CodeAnalysis.Razor.Editor;
+
+/// <summary>
+/// Settings that are set and handled on the client, but needed by the LSP Server to function correctly. When these are
+/// updated a workspace/didchangeconfiguration should be sent from client to the server. Then the server requests
+/// workspace/configuration to get the latest settings. For VS, the razor protocol also handles this and serializes the
+/// settings back to the server.
+/// </summary>
+/// <param name="ClientSpaceSettings"></param>
+/// <param name="AdvancedSettings"></param>
+public record ClientSettings(ClientSpaceSettings ClientSpaceSettings, ClientAdvancedSettings AdvancedSettings)
+{
+    public static readonly ClientSettings Default = new(ClientSpaceSettings.Default, ClientAdvancedSettings.Default);
+}
+
+public sealed record ClientSpaceSettings(bool IndentWithTabs, int IndentSize)
+{
+    public static readonly ClientSpaceSettings Default = new(IndentWithTabs: false, IndentSize: 4);
+
+    public int IndentSize { get; } = IndentSize >= 0 ? IndentSize : throw new ArgumentOutOfRangeException(nameof(IndentSize));
+}
+
+public sealed record ClientAdvancedSettings(bool FormatOnType)
+{
+    public static readonly ClientAdvancedSettings Default = new(FormatOnType: true);
+}

src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Editor/EditorSettingsChangedEventArgs.cs renamed to src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Editor/ClientSettingsChangedEventArgs.cs

@@ -5,9 +5,9 @@
 
 namespace Microsoft.CodeAnalysis.Razor.Editor;
 
-public sealed class EditorSettingsChangedEventArgs : EventArgs
+public sealed class ClientSettingsChangedEventArgs : EventArgs
 {
-    public EditorSettingsChangedEventArgs(EditorSettings settings)
+    public ClientSettingsChangedEventArgs(ClientSettings settings)
     {
         if (settings is null)
         {
@@ -17,5 +17,5 @@ public EditorSettingsChangedEventArgs(EditorSettings settings)
         Settings = settings;
     }
 
-    public EditorSettings Settings { get; }
+    public ClientSettings Settings { get; }
 }