Change commit to async when enter is pressed

src/EditorFeatures/Core.Wpf/InlineRename/UI/Adornment/RenameFlyoutViewModel.cs

@@ -24,6 +24,7 @@
 using Microsoft.VisualStudio.Imaging.Interop;
 using Microsoft.VisualStudio.PlatformUI.OleComponentSupport;
 using Microsoft.VisualStudio.Text;
+using Roslyn.Utilities;
 
 namespace Microsoft.CodeAnalysis.Editor.Implementation.InlineRename
 {
@@ -228,7 +229,7 @@ public bool Submit()
             }
 
             SmartRenameViewModel?.Commit(IdentifierText);
-            Session.Commit();
+            _ = Session.CommitAsync(previewChanges: false).ReportNonFatalErrorAsync();
             return true;
         }
 

src/EditorFeatures/Core.Wpf/InlineRename/UI/Dashboard/RenameDashboard.xaml.cs

@@ -7,6 +7,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Threading.Tasks;
 using System.Windows;
 using System.Windows.Automation.Peers;
 using System.Windows.Controls;
@@ -243,7 +244,7 @@ protected override void OnAccessKey(AccessKeyEventArgs e)
                 }
                 else if (string.Equals(e.Key, RenameShortcutKey.Apply, StringComparison.OrdinalIgnoreCase))
                 {
-                    this.Commit();
+                    _ = this.CommitAsync();
                 }
             }
         }
@@ -318,13 +319,14 @@ private void CloseButton_Click(object sender, RoutedEventArgs e)
         }
 
         private void Apply_Click(object sender, RoutedEventArgs e)
-            => Commit();
+            => _ = CommitAsync();
 
-        private void Commit()
+        private async Task CommitAsync()
         {
             try
             {
-                _model.Session.Commit();
+                //.ConfigureAwait(true) to make sure Exceptions could be shown in UI.
+                await _model.Session.CommitAsync(previewChanges: false).ConfigureAwait(true);
                 _textView.VisualElement.Focus();
             }
             catch (NotSupportedException ex)

src/EditorFeatures/Core/IInlineRenameSession.cs

@@ -52,5 +52,8 @@ internal interface IInlineRenameSession
     /// <summary>
     /// Dismisses the rename session, completing the rename operation across all files.
     /// </summary>
+    /// <remarks>
+    /// It will only be async when InlineRenameUIOptionsStorage.CommitRenameAsynchronously is set to true.
+    /// </remarks>
     Task CommitAsync(bool previewChanges, IUIThreadOperationContext editorOperationContext = null);
 }

src/EditorFeatures/Core/InlineRename/CommandHandlers/AbstractRenameCommandHandler.cs

@@ -66,6 +66,11 @@ private void HandlePossibleTypingCommand<TArgs>(TArgs args, Action nextHandler,
             return;
         }
 
+        if (_renameService.ActiveSession.IsCommitInProgress)
+        {
+            return;
+        }
+
         var selectedSpans = args.TextView.Selection.GetSnapshotSpansOnBuffer(args.SubjectBuffer);
 
         if (selectedSpans.Count > 1)
@@ -121,4 +126,7 @@ private void Commit(IUIThreadOperationContext operationContext)
         RoslynDebug.AssertNotNull(_renameService.ActiveSession);
         _renameService.ActiveSession.Commit(previewChanges: false, operationContext);
     }
+
+    private bool IsRenameCommitInProgress()
+        => _renameService.ActiveSession?.IsCommitInProgress is true;
 }

src/EditorFeatures/Core/InlineRename/CommandHandlers/AbstractRenameCommandHandler_MoveSelectedLinesHandler.cs

@@ -15,6 +15,9 @@ public CommandState GetCommandState(MoveSelectedLinesUpCommandArgs args)
 
     public bool ExecuteCommand(MoveSelectedLinesUpCommandArgs args, CommandExecutionContext context)
     {
+        if (IsRenameCommitInProgress())
+            return true;
+
         CommitIfActive(args, context.OperationContext);
         return false;
     }
@@ -24,6 +27,9 @@ public CommandState GetCommandState(MoveSelectedLinesDownCommandArgs args)
 
     public bool ExecuteCommand(MoveSelectedLinesDownCommandArgs args, CommandExecutionContext context)
     {
+        if (IsRenameCommitInProgress())
+            return true;
+
         CommitIfActive(args, context.OperationContext);
         return false;
     }

src/EditorFeatures/Core/InlineRename/CommandHandlers/AbstractRenameCommandHandler_RefactoringWithCommandHandler.cs

@@ -18,6 +18,9 @@ public CommandState GetCommandState(ReorderParametersCommandArgs args)
 
     public bool ExecuteCommand(ReorderParametersCommandArgs args, CommandExecutionContext context)
     {
+        if (IsRenameCommitInProgress())
+            return true;
+
         CommitIfActive(args, context.OperationContext);
         return false;
     }
@@ -27,6 +30,9 @@ public CommandState GetCommandState(RemoveParametersCommandArgs args)
 
     public bool ExecuteCommand(RemoveParametersCommandArgs args, CommandExecutionContext context)
     {
+        if (IsRenameCommitInProgress())
+            return true;
+
         CommitIfActive(args, context.OperationContext);
         return false;
     }
@@ -36,6 +42,9 @@ public CommandState GetCommandState(ExtractInterfaceCommandArgs args)
 
     public bool ExecuteCommand(ExtractInterfaceCommandArgs args, CommandExecutionContext context)
     {
+        if (IsRenameCommitInProgress())
+            return true;
+
         CommitIfActive(args, context.OperationContext);
         return false;
     }
@@ -45,6 +54,9 @@ public CommandState GetCommandState(EncapsulateFieldCommandArgs args)
 
     public bool ExecuteCommand(EncapsulateFieldCommandArgs args, CommandExecutionContext context)
     {
+        if (IsRenameCommitInProgress())
+            return true;
+
         CommitIfActive(args, context.OperationContext);
         return false;
     }

src/EditorFeatures/Core/InlineRename/CommandHandlers/AbstractRenameCommandHandler_RenameHandler.cs

@@ -67,10 +67,14 @@ private async Task ExecuteCommandAsync(RenameCommandArgs args, IUIThreadOperatio
         // If there is already an active session, commit it first
         if (_renameService.ActiveSession != null)
         {
-            // Is the caret within any of the rename fields in this buffer?
-            // If so, focus the dashboard
-            if (_renameService.ActiveSession.TryGetContainingEditableSpan(caretPoint.Value, out _))
+            if (_renameService.ActiveSession.IsCommitInProgress)
             {
+                return;
+            }
+            else if (_renameService.ActiveSession.TryGetContainingEditableSpan(caretPoint.Value, out _))
+            {
+                // Is the caret within any of the rename fields in this buffer?
+                // If so, focus the dashboard
                 SetFocusToAdornment(args.TextView);
                 return;
             }

src/EditorFeatures/Core/InlineRename/CommandHandlers/AbstractRenameCommandHandler_ReturnHandler.cs

@@ -6,6 +6,7 @@
 using Microsoft.VisualStudio.Text.Editor;
 using Microsoft.VisualStudio.Text.Editor.Commanding.Commands;
 using Microsoft.VisualStudio.Utilities;
+using Roslyn.Utilities;
 
 namespace Microsoft.CodeAnalysis.Editor.Implementation.InlineRename;
 
@@ -27,7 +28,7 @@ public bool ExecuteCommand(ReturnKeyCommandArgs args, CommandExecutionContext co
 
     protected virtual void CommitAndSetFocus(InlineRenameSession activeSession, ITextView textView, IUIThreadOperationContext operationContext)
     {
-        Commit(operationContext);
+        _ = activeSession.CommitAsync(previewChanges: false, operationContext).ReportNonFatalErrorAsync();
         SetFocusToTextView(textView);
     }
 }

src/EditorFeatures/Core/InlineRename/CommandHandlers/AbstractRenameCommandHandler_UndoRedoHandler.cs

@@ -18,31 +18,43 @@ public CommandState GetCommandState(RedoCommandArgs args)
 
     public bool ExecuteCommand(UndoCommandArgs args, CommandExecutionContext context)
     {
-        if (_renameService.ActiveSession != null)
+        if (_renameService.ActiveSession == null)
         {
-            for (var i = 0; i < args.Count && _renameService.ActiveSession != null; i++)
-            {
-                _renameService.ActiveSession.UndoManager.Undo(args.SubjectBuffer);
-            }
+            return false;
+        }
 
+        if (_renameService.ActiveSession.IsCommitInProgress)
+        {
+            // When rename commit is in progress, handle the command so it won't change the workspace
             return true;
         }
 
-        return false;
+        for (var i = 0; i < args.Count && _renameService.ActiveSession != null; i++)
+        {
+            _renameService.ActiveSession.UndoManager.Undo(args.SubjectBuffer);
+        }
+
+        return true;
     }
 
     public bool ExecuteCommand(RedoCommandArgs args, CommandExecutionContext context)
     {
-        if (_renameService.ActiveSession != null)
+        if (_renameService.ActiveSession == null)
         {
-            for (var i = 0; i < args.Count && _renameService.ActiveSession != null; i++)
-            {
-                _renameService.ActiveSession.UndoManager.Redo(args.SubjectBuffer);
-            }
+            return false;
+        }
 
+        if (_renameService.ActiveSession.IsCommitInProgress)
+        {
+            // When rename commit is in progress, handle the command so it won't change the workspace
             return true;
         }
 
-        return false;
+        for (var i = 0; i < args.Count && _renameService.ActiveSession != null; i++)
+        {
+            _renameService.ActiveSession.UndoManager.Redo(args.SubjectBuffer);
+        }
+
+        return true;
     }
 }

src/EditorFeatures/Core/InlineRename/CommandHandlers/AbstractRenameCommandHandler_WordDeleteHandler.cs

@@ -34,6 +34,12 @@ private bool HandleWordDeleteCommand(ITextBuffer subjectBuffer, ITextView view,
             return false;
         }
 
+        if (_renameService.ActiveSession.IsCommitInProgress)
+        {
+            // When rename commit is in progress, handle the command so it won't change the workspace
+            return true;
+        }
+
         var caretPoint = view.GetCaretPoint(subjectBuffer);
         if (caretPoint.HasValue)
         {

src/EditorFeatures/Core/InlineRename/InlineRenameSession.cs

@@ -749,7 +749,7 @@ private bool CommitSynchronously(bool previewChanges, IUIThreadOperationContext
     /// </remarks>
     public async Task CommitAsync(bool previewChanges, IUIThreadOperationContext editorOperationContext = null)
     {
-        if (this.RenameService.GlobalOptions.GetOption(InlineRenameSessionOptionsStorage.RenameAsynchronously))
+        if (this.RenameService.GlobalOptions.ShouldCommitAsynchronously())
         {
             await CommitWorkerAsync(previewChanges, canUseBackgroundWorkIndicator: true, editorOperationContext).ConfigureAwait(false);
         }
@@ -782,6 +782,12 @@ private async Task<bool> CommitWorkerAsync(bool previewChanges, bool canUseBackg
             return false;
         }
 
+        // Don't dup commit.
+        if (this.IsCommitInProgress)
+        {
+            return false;
+        }
+
         previewChanges = previewChanges || PreviewChanges;
 
         if (editorUIOperationContext is not null)

src/EditorFeatures/Core/InlineRename/InlineRenameSessionOptionsStorage.cs

@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
+using System;
 using Microsoft.CodeAnalysis.Options;
 
 namespace Microsoft.CodeAnalysis.InlineRename;
@@ -13,5 +14,13 @@ internal static class InlineRenameSessionOptionsStorage
     public static readonly Option2<bool> RenameInComments = new("dotnet_rename_in_comments", defaultValue: false);
     public static readonly Option2<bool> RenameFile = new("dotnet_rename_file", defaultValue: true);
     public static readonly Option2<bool> PreviewChanges = new("dotnet_preview_inline_rename_changes", defaultValue: false);
+
+    [Obsolete]
     public static readonly Option2<bool> RenameAsynchronously = new("dotnet_rename_asynchronously", defaultValue: true);
+
+    public static readonly Option2<bool?> CommitRenameAsynchronously = new("dotnet_commit_rename_asynchronously", defaultValue: null);
+    public static readonly Option2<bool> CommitRenameAsynchronouslyFeatureFlag = new("dotnet_commit_rename_asynchronously_feature_flag", defaultValue: false);
+
+    public static bool ShouldCommitAsynchronously(this IGlobalOptionService globalOptionService)
+        => globalOptionService.GetOption(CommitRenameAsynchronously) ?? globalOptionService.GetOption(CommitRenameAsynchronouslyFeatureFlag);
 }

src/VisualStudio/CSharp/Impl/Options/AdvancedOptionPageControl.xaml.cs

@@ -105,7 +105,10 @@ public AdvancedOptionPageControl(OptionStore optionStore, IComponentModel compon
             BindToOption(Always_use_default_symbol_servers_for_navigation, MetadataAsSourceOptionsStorage.AlwaysUseDefaultSymbolServers);
 
             // Rename
-            BindToOption(Rename_asynchronously_exerimental, InlineRenameSessionOptionsStorage.RenameAsynchronously);
+            BindToOption(Rename_asynchronously_exerimental, InlineRenameSessionOptionsStorage.CommitRenameAsynchronously, () =>
+            {
+                return optionStore.GetOption(InlineRenameSessionOptionsStorage.CommitRenameAsynchronouslyFeatureFlag);
+            });
             BindToOption(Rename_UI_setting, InlineRenameUIOptionsStorage.UseInlineAdornment, label: Rename_UI_setting_label);
 
             // Using Directives

src/VisualStudio/Core/Def/Options/VisualStudioOptionStorage.cs

@@ -344,6 +344,8 @@ public bool TryFetch(LocalUserRegistryOptionPersister persister, OptionKey2 opti
         {"dotnet_rename_use_inline_adornment", new RoamingProfileStorage("TextEditor.RenameUseInlineAdornment")},
         {"dotnet_preview_inline_rename_changes", new RoamingProfileStorage("TextEditor.Specific.PreviewRename")},
         {"dotnet_collapse_suggestions_in_inline_rename_ui", new RoamingProfileStorage("TextEditor.CollapseRenameSuggestionsUI")},
+        {"dotnet_commit_rename_asynchronously", new RoamingProfileStorage("TextEditor.Specific.CommitRenameAsynchronously")},
+        {"dotnet_commit_rename_asynchronously_feature_flag", new FeatureFlagStorage("Roslyn.CommitRenameAsynchronously")},
         {"dotnet_rename_get_suggestions_automatically", new FeatureFlagStorage(@"Editor.AutoSmartRenameSuggestions")},
         {"dotnet_rename_asynchronously", new RoamingProfileStorage("TextEditor.Specific.RenameAsynchronously")},
         {"dotnet_rename_file", new RoamingProfileStorage("TextEditor.Specific.RenameFile")},

src/VisualStudio/VisualBasic/Impl/Options/AdvancedOptionPageControl.xaml.vb

@@ -98,7 +98,10 @@ Namespace Microsoft.VisualStudio.LanguageServices.VisualBasic.Options
                          End Function)
 
             ' Rename
-            BindToOption(Rename_asynchronously_exerimental, InlineRenameSessionOptionsStorage.RenameAsynchronously)
+            BindToOption(Rename_asynchronously_exerimental, InlineRenameSessionOptionsStorage.CommitRenameAsynchronously,
+                        Function()
+                            Return optionStore.GetOption(InlineRenameSessionOptionsStorage.CommitRenameAsynchronouslyFeatureFlag)
+                        End Function)
             BindToOption(Rename_UI_setting, InlineRenameUIOptionsStorage.UseInlineAdornment, label:=Rename_UI_setting_label)
 
             ' Import directives