Async rename commit

src/EditorFeatures/Core.Wpf/InlineRename/CommandHandlers/RenameCommandHandler.cs

@@ -5,6 +5,8 @@
 using System;
 using System.ComponentModel.Composition;
 using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
 using Microsoft.CodeAnalysis.Editor.Shared.Utilities;
 using Microsoft.CodeAnalysis.Host.Mef;
 using Microsoft.VisualStudio.Commanding;
@@ -94,11 +96,11 @@ protected override void SetAdornmentFocusToPreviousElement(ITextView textView)
             }
         }
 
-        protected override void Commit(InlineRenameSession activeSession, ITextView textView)
+        protected override async Task CommitAndSetFocusAsync(InlineRenameSession activeSession, ITextView textView)
         {
             try
             {
-                base.Commit(activeSession, textView);
+                await base.CommitAndSetFocusAsync(activeSession, textView).ConfigureAwait(false);
             }
             catch (NotSupportedException ex)
             {

src/EditorFeatures/Core.Wpf/InlineRename/UI/Adornment/RenameFlyout.xaml

@@ -20,6 +20,7 @@
              Focusable="False"
              UseLayoutRounding="True"
              Cursor="Arrow"
+             Visibility="{Binding Path=Visibility}"
              x:Name="control">
 
     <UserControl.Resources>

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

@@ -9,27 +9,34 @@
 using System.Diagnostics;
 using System.Linq;
 using System.Runtime.CompilerServices;
+using System.Threading;
+using System.Threading.Tasks;
+using System.Windows;
 using System.Windows.Interop;
 using Microsoft.CodeAnalysis.Editor.InlineRename;
 using Microsoft.CodeAnalysis.Editor.Shared.Extensions;
 using Microsoft.CodeAnalysis.Editor.Shared.Utilities;
 using Microsoft.CodeAnalysis.EditorFeatures.Lightup;
+using Microsoft.CodeAnalysis.ErrorReporting;
 using Microsoft.CodeAnalysis.InlineRename;
 using Microsoft.CodeAnalysis.InlineRename.UI.SmartRename;
 using Microsoft.CodeAnalysis.Options;
 using Microsoft.CodeAnalysis.Shared.TestHooks;
+using Microsoft.CodeAnalysis.Telemetry;
 using Microsoft.CodeAnalysis.Text;
 using Microsoft.VisualStudio.Imaging;
 using Microsoft.VisualStudio.Imaging.Interop;
 using Microsoft.VisualStudio.PlatformUI.OleComponentSupport;
 using Microsoft.VisualStudio.Text;
+using Roslyn.Utilities;
 
 namespace Microsoft.CodeAnalysis.Editor.Implementation.InlineRename
 {
     internal class RenameFlyoutViewModel : INotifyPropertyChanged, IDisposable
     {
         private readonly bool _registerOleComponent;
         private readonly IGlobalOptionService _globalOptionService;
+        private readonly IAsynchronousOperationListener _asyncListener;
         private OleComponent? _oleComponent;
         private bool _disposedValue;
         private bool _isReplacementTextValid = true;
@@ -52,8 +59,10 @@ public RenameFlyoutViewModel(
             Session.ReplacementTextChanged += OnReplacementTextChanged;
             Session.ReplacementsComputed += OnReplacementsComputed;
             Session.ReferenceLocationsChanged += OnReferenceLocationsChanged;
+            Session.CommitStateChange += SessionOnCommitStateChange;
             StartingSelection = selectionSpan;
             InitialTrackingSpan = session.TriggerSpan.CreateTrackingSpan(SpanTrackingMode.EdgeInclusive);
+            _asyncListener = listenerProvider.GetListener(FeatureAttribute.Rename);
             var smartRenameSession = smartRenameSessionFactory?.Value.CreateSmartRenameSession(Session.TriggerSpan);
             if (smartRenameSession is not null)
             {
@@ -63,6 +72,13 @@ public RenameFlyoutViewModel(
             RegisterOleComponent();
         }
 
+        private void SessionOnCommitStateChange(object sender, bool commitStarts)
+        {
+            // When commit in progress, we will use background indicator to show the progress.
+            // Rename flyout would hide the tooltip so we need to collapse it.
+            Visibility = commitStarts ? Visibility.Collapsed : Visibility.Visible;
+        }
+
         public SmartRenameViewModel? SmartRenameViewModel { get; }
 
         public string IdentifierText
@@ -73,7 +89,7 @@ public string IdentifierText
                 if (value != Session.ReplacementText)
                 {
                     Session.ApplyReplacementText(value, propagateEditImmediately: true, updateSelection: false);
-                    NotifyPropertyChanged(nameof(IdentifierText));
+                    NotifyPropertyChanged();
                 }
             }
         }
@@ -206,20 +222,64 @@ public bool IsRenameOverloadsEditable
         public bool IsRenameOverloadsVisible
             => Session.HasRenameOverloads;
 
+        public bool AllowUserInput
+            => !Session.IsCommitInProgress;
+
+        private Visibility _visibility;
+        public Visibility Visibility
+        {
+            get => _visibility;
+            set
+            {
+                if (value != _visibility)
+                {
+                    Set(ref _visibility, value);
+                    NotifyPropertyChanged();
+                }
+            }
+        }
+
         public TextSpan StartingSelection { get; }
 
         public bool Submit()
         {
+            using var token = _asyncListener.BeginAsyncOperation(nameof(Submit));
             if (StatusSeverity == Severity.Error)
             {
                 return false;
             }
 
             SmartRenameViewModel?.Commit(IdentifierText);
-            Session.Commit();
+            _ = CommitAsync().ReportNonFatalErrorAsync();
             return true;
         }
 
+        private async Task CommitAsync()
+        {
+            try
+            {
+                await Session.CommitAsync(previewChanges: false).ReportNonFatalErrorAsync().ConfigureAwait(false);
+            }
+            catch (Exception ex) when (FatalError.ReportAndCatch(ex, ErrorSeverity.Critical))
+            {
+                // Show a nice error to the user via an info bar
+                var errorReportingService = Session.Workspace.Services.GetService<IErrorReportingService>();
+                if (errorReportingService is null)
+                {
+                    return;
+                }
+
+                errorReportingService.ShowGlobalErrorInfo(
+                    message: string.Format(EditorFeaturesWpfResources.Error_performing_rename_0, ex.Message),
+                    TelemetryFeatureName.InlineRename,
+                    ex,
+                    new InfoBarUI(
+                        WorkspacesResources.Show_Stack_Trace,
+                        InfoBarUI.UIKind.HyperLink,
+                        () => errorReportingService.ShowDetailedErrorInfo(ex), closeAfterAction: true));
+            }
+        }
+
         public void Cancel()
         {
             SmartRenameViewModel?.Cancel();
@@ -310,6 +370,7 @@ protected virtual void Dispose(bool disposing)
                 {
                     Session.ReplacementTextChanged -= OnReplacementTextChanged;
                     Session.ReplacementsComputed -= OnReplacementsComputed;
+                    Session.CommitStateChange -= SessionOnCommitStateChange;
 
                     if (SmartRenameViewModel is not null)
                     {

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

@@ -145,16 +145,16 @@
 
                 <CheckBox Content="{Binding ElementName=dashboard, Path=RenameOverloads}" Margin="0,0,0,0" IsChecked="{Binding Path=DefaultRenameOverloadFlag, Mode=TwoWay}"
                       Name="OverloadsCheckbox" Visibility="{Binding ElementName=dashboard, Path=RenameOverloadsVisibility}" IsEnabled="{Binding ElementName=dashboard, Path=IsRenameOverloadsEditable}" />
-                <CheckBox Name="CommentsCheckbox" Content="{Binding ElementName=dashboard, Path=SearchInComments}" Margin="0,0,0,0" IsChecked="{Binding Path=DefaultRenameInCommentsFlag, Mode=TwoWay}" />
-                <CheckBox Name="StringsCheckbox" Content="{Binding ElementName=dashboard, Path=SearchInStrings}" Margin="0,0,0,0" IsChecked="{Binding Path=DefaultRenameInStringsFlag, Mode=TwoWay}" />
+                <CheckBox Name="CommentsCheckbox" Content="{Binding ElementName=dashboard, Path=SearchInComments}" Margin="0,0,0,0" IsChecked="{Binding Path=DefaultRenameInCommentsFlag, Mode=TwoWay}" IsEnabled="{Binding Path=CommitNotStart}" />
+                <CheckBox Name="StringsCheckbox" Content="{Binding ElementName=dashboard, Path=SearchInStrings}" Margin="0,0,0,0" IsChecked="{Binding Path=DefaultRenameInStringsFlag, Mode=TwoWay}" IsEnabled="{Binding Path=CommitNotStart}" />
                 <CheckBox Name="FileRenameCheckbox" 
                           Content="{Binding Path=FileRenameString}" 
                           Margin="0" 
                           IsChecked="{Binding Path=DefaultRenameFileFlag, Mode=TwoWay}" 
                           IsEnabled="{Binding Path=AllowFileRename, Mode=OneWay}" 
                           Visibility="{Binding Path=ShowFileRename, Converter={StaticResource BooleanToVisibilityConverter}, Mode=OneWay}"/>
 
-                <CheckBox Name="PreviewChangesCheckbox" Content="{Binding ElementName=dashboard, Path=PreviewChanges}" Margin="0,8,0,0" IsChecked="{Binding Path=DefaultPreviewChangesFlag, Mode=TwoWay}" />
+                <CheckBox Name="PreviewChangesCheckbox" Content="{Binding ElementName=dashboard, Path=PreviewChanges}" Margin="0,8,0,0" IsChecked="{Binding Path=DefaultPreviewChangesFlag, Mode=TwoWay}" IsEnabled="{Binding Path=CommitNotStart}" />
 
                 <!-- Summary: Includes the number of references to be updated and any conflict information -->
 

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;
@@ -328,10 +329,15 @@ private void Apply_Click(object sender, RoutedEventArgs e)
             => Commit();
 
         private void Commit()
+        {
+            _ = CommitAsync();
+        }
+
+        private async Task CommitAsync()
         {
             try
             {
-                _model.Session.Commit();
+                await _model.Session.CommitAsync(previewChanges: false).ConfigureAwait(true);
                 _textView.VisualElement.Focus();
             }
             catch (NotSupportedException ex)

src/EditorFeatures/Core.Wpf/InlineRename/UI/Dashboard/RenameDashboardViewModel.cs

@@ -20,6 +20,7 @@ internal class RenameDashboardViewModel : INotifyPropertyChanged, IDisposable
         private int _resolvableConflictCount;
         private int _unresolvableConflictCount;
         private bool _isReplacementTextValid;
+        private bool _commitNotStart;
 
         public RenameDashboardViewModel(InlineRenameSession session)
         {
@@ -29,9 +30,11 @@ public RenameDashboardViewModel(InlineRenameSession session)
             Session.ReferenceLocationsChanged += OnReferenceLocationsChanged;
             Session.ReplacementsComputed += OnReplacementsComputed;
             Session.ReplacementTextChanged += OnReplacementTextChanged;
+            Session.CommitStateChange += CommitStateChange;
 
             // Set the flag to true by default if we're showing the option.
             _isReplacementTextValid = true;
+            _commitNotStart = true;
         }
 
         public event PropertyChangedEventHandler PropertyChanged;
@@ -140,11 +143,30 @@ private void UpdateSeverity()
             }
         }
 
+        private void CommitStateChange(object sender, bool commitStart)
+            => CommitNotStart = !commitStart;
+
+        public bool CommitNotStart
+        {
+            get => _commitNotStart;
+            set
+            {
+                if (_commitNotStart != value)
+                {
+                    _commitNotStart = value;
+                    // Disable/Enable these checkbox in UI based on if commit is in-progress or not
+                    NotifyPropertyChanged();
+                    NotifyPropertyChanged(nameof(IsRenameOverloadsEditable));
+                    NotifyPropertyChanged(nameof(AllowFileRename));
+                }
+            }
+        }
+
         public InlineRenameSession Session { get; }
 
         public RenameDashboardSeverity Severity => _severity;
 
-        public bool AllowFileRename => Session.FileRenameInfo == InlineRenameFileRenameInfo.Allowed && _isReplacementTextValid;
+        public bool AllowFileRename => Session.FileRenameInfo == InlineRenameFileRenameInfo.Allowed && _isReplacementTextValid && _commitNotStart;
         public bool ShowFileRename => Session.FileRenameInfo != InlineRenameFileRenameInfo.NotAllowed;
         public string FileRenameString => Session.FileRenameInfo switch
         {
@@ -226,7 +248,7 @@ public Visibility RenameOverloadsVisibility
             => Session.HasRenameOverloads ? Visibility.Visible : Visibility.Collapsed;
 
         public bool IsRenameOverloadsEditable
-            => !Session.MustRenameOverloads;
+            => !Session.MustRenameOverloads && CommitNotStart;
 
         public bool DefaultRenameOverloadFlag
         {
@@ -292,6 +314,7 @@ public void Dispose()
             Session.ReplacementTextChanged -= OnReplacementTextChanged;
             Session.ReferenceLocationsChanged -= OnReferenceLocationsChanged;
             Session.ReplacementsComputed -= OnReplacementsComputed;
+            Session.CommitStateChange -= CommitStateChange;
         }
     }
 }

src/EditorFeatures/Core/ExtractMethod/ExtractMethodCommandHandler.cs

@@ -84,13 +84,6 @@ public CommandState GetCommandState(ExtractMethodCommandArgs args)
 
     public bool ExecuteCommand(ExtractMethodCommandArgs args, CommandExecutionContext context)
     {
-        // Finish any rename that had been started. We'll do this here before we enter the
-        // wait indicator for Extract Method
-        if (_renameService.ActiveSession != null)
-        {
-            _threadingContext.JoinableTaskFactory.Run(() => _renameService.ActiveSession.CommitAsync(previewChanges: false));
-        }
-
         if (!args.SubjectBuffer.SupportsRefactorings())
             return false;
 
@@ -106,7 +99,7 @@ public bool ExecuteCommand(ExtractMethodCommandArgs args, CommandExecutionContex
         if (document is null)
             return false;
 
-        _ = ExecuteAsync(view, textBuffer, document, span);
+        _ = ExecuteAsync(view, textBuffer, document, span).ReportNonFatalErrorAsync();
         return true;
     }
 
@@ -117,6 +110,15 @@ private async Task ExecuteAsync(
         SnapshotSpan span)
     {
         _threadingContext.ThrowIfNotOnUIThread();
+
+        // Finish any rename that had been started. We'll do this here before we enter the
+        // wait indicator for Extract Method
+        if (_renameService.ActiveSession != null)
+        {
+            // ConfigureAwait(true) to make sure the next wait indicator would be created correctly.
+            await _renameService.ActiveSession.CommitAsync(previewChanges: false).ConfigureAwait(true);
+        }
+
         var indicatorFactory = document.Project.Solution.Services.GetRequiredService<IBackgroundWorkIndicatorFactory>();
         using var indicatorContext = indicatorFactory.Create(
             view, span, EditorFeaturesResources.Applying_Extract_Method_refactoring, cancelOnEdit: true, cancelOnFocusLost: true);

src/EditorFeatures/Core/IInlineRenameSession.cs

@@ -50,5 +50,6 @@ internal interface IInlineRenameSession
     /// <summary>
     /// Dismisses the rename session, completing the rename operation across all files.
     /// </summary>
+    /// <remarks>The implementation would only be async when InlineRenameSessionOptionsStorage.RenameAsynchronously is set to true</remarks>
     Task CommitAsync(bool previewChanges);
 }

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

@@ -4,6 +4,7 @@
 
 using System;
 using System.Linq;
+using System.Threading;
 using Microsoft.CodeAnalysis.Editor.Shared.Extensions;
 using Microsoft.CodeAnalysis.Editor.Shared.Utilities;
 using Microsoft.CodeAnalysis.Shared.TestHooks;
@@ -64,8 +65,13 @@ private void HandlePossibleTypingCommand<TArgs>(TArgs args, Action nextHandler,
             return;
         }
 
-        var selectedSpans = args.TextView.Selection.GetSnapshotSpansOnBuffer(args.SubjectBuffer);
+        // If commit in progress, don't do anything, as we don't want user change the text view
+        if (_renameService.ActiveSession.IsCommitInProgress)
+        {
+            return;
+        }
 
+        var selectedSpans = args.TextView.Selection.GetSnapshotSpansOnBuffer(args.SubjectBuffer);
         if (selectedSpans.Count > 1)
         {
             // If we have multiple spans active, then that means we have something like box

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

@@ -18,7 +18,8 @@ public bool ExecuteCommand(EscapeKeyCommandArgs args, CommandExecutionContext co
         {
             _renameService.ActiveSession.Cancel();
             SetFocusToTextView(args.TextView);
-            return true;
+            // When ESC is pressed, don't handle the command here because rename might rely on
+            // BackgroundWorkIndicator to show the progress. Let platform propagates ESC to let indicator also get cancelled.
         }
 
         return false;