Remove usage of WaitAndGetResult from debugger paths (#76483)

CyrusNajmabadi · web-flow · commit 7edae945c2d6 · 2024-12-18T07:46:50.000-08:00
diff --git a/src/VisualStudio/Core/Def/Implementation/AbstractOleCommandTarget.cs b/src/VisualStudio/Core/Def/Implementation/AbstractOleCommandTarget.cs
@@ -5,6 +5,7 @@
 using System.Diagnostics.CodeAnalysis;
 using System.Runtime.InteropServices;
 using Microsoft.CodeAnalysis.Editor.Shared.Extensions;
+using Microsoft.CodeAnalysis.Editor.Shared.Utilities;
 using Microsoft.VisualStudio.ComponentModelHost;
 using Microsoft.VisualStudio.Editor;
 using Microsoft.VisualStudio.OLE.Interop;
@@ -35,6 +36,7 @@ public AbstractOleCommandTarget(
     }
 
     public IComponentModel ComponentModel { get; }
+    protected IThreadingContext ThreadingContext => ComponentModel.GetService<IThreadingContext>();
 
     public IVsEditorAdaptersFactoryService EditorAdaptersFactory
     {
diff --git a/src/VisualStudio/Core/Def/Implementation/AbstractVsTextViewFilter.cs b/src/VisualStudio/Core/Def/Implementation/AbstractVsTextViewFilter.cs
@@ -7,6 +7,7 @@
 using System;
 using System.Linq;
 using System.Threading;
+using System.Threading.Tasks;
 using Microsoft.CodeAnalysis.BraceMatching;
 using Microsoft.CodeAnalysis.Debugging;
 using Microsoft.CodeAnalysis.Editor;
@@ -29,156 +30,141 @@
 
 namespace Microsoft.VisualStudio.LanguageServices.Implementation;
 
-internal abstract class AbstractVsTextViewFilter : AbstractOleCommandTarget, IVsTextViewFilter
+internal abstract class AbstractVsTextViewFilter(
+    IWpfTextView wpfTextView,
+    IComponentModel componentModel) : AbstractOleCommandTarget(wpfTextView, componentModel), IVsTextViewFilter
 {
-    public AbstractVsTextViewFilter(
-        IWpfTextView wpfTextView,
-        IComponentModel componentModel)
-        : base(wpfTextView, componentModel)
+    int IVsTextViewFilter.GetDataTipText(TextSpan[] pSpan, out string pbstrText)
     {
+        (pbstrText, var result) = this.ThreadingContext.JoinableTaskFactory.Run(() => GetDataTipTextAsync(pSpan));
+        return result;
     }
 
-    int IVsTextViewFilter.GetDataTipText(TextSpan[] pSpan, out string pbstrText)
+    private async Task<(string pbstrText, int result)> GetDataTipTextAsync(TextSpan[] pSpan)
     {
         try
         {
             if (pSpan == null || pSpan.Length != 1)
-            {
-                pbstrText = null;
-                return VSConstants.E_INVALIDARG;
-            }
+                return (null, VSConstants.E_INVALIDARG);
 
-            return GetDataTipTextImpl(pSpan, out pbstrText);
+            return await GetDataTipTextImplAsync(pSpan).ConfigureAwait(true);
         }
         catch (Exception e) when (FatalError.ReportAndCatch(e) && false)
         {
             throw ExceptionUtilities.Unreachable();
         }
     }
 
-    protected virtual int GetDataTipTextImpl(TextSpan[] pSpan, out string pbstrText)
+    protected virtual async Task<(string pbstrText, int result)> GetDataTipTextImplAsync(TextSpan[] pSpan)
     {
         var subjectBuffer = WpfTextView.GetBufferContainingCaret();
         if (subjectBuffer == null)
-        {
-            pbstrText = null;
-            return VSConstants.E_FAIL;
-        }
+            return (null, VSConstants.E_FAIL);
 
-        return GetDataTipTextImpl(subjectBuffer, pSpan, out pbstrText);
+        return await GetDataTipTextImplAsync(subjectBuffer, pSpan).ConfigureAwait(true);
     }
 
-    protected int GetDataTipTextImpl(ITextBuffer subjectBuffer, TextSpan[] pSpan, out string pbstrText)
+    protected async Task<(string pbstrText, int result)> GetDataTipTextImplAsync(ITextBuffer subjectBuffer, TextSpan[] pSpan)
     {
-        pbstrText = null;
-
         var vsBuffer = EditorAdaptersFactory.GetBufferAdapter(subjectBuffer);
 
         // TODO: broken in REPL
         if (vsBuffer == null)
-        {
-            return VSConstants.E_FAIL;
-        }
+            return (null, VSConstants.E_FAIL);
 
         using (Logger.LogBlock(FunctionId.Debugging_VsLanguageDebugInfo_GetDataTipText, CancellationToken.None))
         {
-            pbstrText = null;
             if (pSpan == null || pSpan.Length != 1)
-            {
-                return VSConstants.E_INVALIDARG;
-            }
+                return (null, VSConstants.E_INVALIDARG);
 
             var result = VSConstants.E_FAIL;
-            string pbstrTextInternal = null;
+            string pbstrText = null;
 
             var uiThreadOperationExecutor = ComponentModel.GetService<IUIThreadOperationExecutor>();
-            uiThreadOperationExecutor.Execute(
+            using var context = uiThreadOperationExecutor.BeginExecute(
                 title: ServicesVSResources.Debugger,
                 defaultDescription: ServicesVSResources.Getting_DataTip_text,
                 allowCancellation: true,
-                showProgress: false,
-                action: context =>
-            {
-                IServiceProvider serviceProvider = ComponentModel.GetService<SVsServiceProvider>();
-                var debugger = (IVsDebugger)serviceProvider.GetService(typeof(SVsShellDebugger));
-                var debugMode = new DBGMODE[1];
+                showProgress: false);
 
-                var cancellationToken = context.UserCancellationToken;
-                if (ErrorHandler.Succeeded(debugger.GetMode(debugMode)) && debugMode[0] != DBGMODE.DBGMODE_Design)
-                {
-                    var textSpan = pSpan[0];
+            IServiceProvider serviceProvider = ComponentModel.GetService<SVsServiceProvider>();
+            var debugger = (IVsDebugger)serviceProvider.GetService(typeof(SVsShellDebugger));
+            var debugMode = new DBGMODE[1];
+
+            var cancellationToken = context.UserCancellationToken;
+            if (ErrorHandler.Succeeded(debugger.GetMode(debugMode)) && debugMode[0] != DBGMODE.DBGMODE_Design)
+            {
+                var textSpan = pSpan[0];
 
-                    var textSnapshot = subjectBuffer.CurrentSnapshot;
-                    var document = textSnapshot.GetOpenDocumentInCurrentContextWithChanges();
+                var textSnapshot = subjectBuffer.CurrentSnapshot;
+                var document = textSnapshot.GetOpenDocumentInCurrentContextWithChanges();
 
-                    if (document != null)
+                if (document != null)
+                {
+                    var languageDebugInfo = document.Project.Services.GetService<ILanguageDebugInfoService>();
+                    if (languageDebugInfo != null)
                     {
-                        var languageDebugInfo = document.Project.Services.GetService<ILanguageDebugInfoService>();
-                        if (languageDebugInfo != null)
+                        var spanOpt = textSnapshot.TryGetSpan(textSpan);
+                        if (spanOpt.HasValue)
                         {
-                            var spanOpt = textSnapshot.TryGetSpan(textSpan);
-                            if (spanOpt.HasValue)
+                            // 'kind' is an lsp-only concept, so we don't want/need to include it here (especially
+                            // as it can be expensive to compute, and we don't want to block the UI thread).
+                            var dataTipInfo = await languageDebugInfo.GetDataTipInfoAsync(
+                                document, spanOpt.Value.Start, includeKind: false, cancellationToken).ConfigureAwait(true);
+                            if (!dataTipInfo.IsDefault)
                             {
-                                // 'kind' is an lsp-only concept, so we don't want/need to include it here (especially
-                                // as it can be expensive to compute, and we don't want to block the UI thread).
-                                var dataTipInfo = languageDebugInfo.GetDataTipInfoAsync(
-                                    document, spanOpt.Value.Start, includeKind: false, cancellationToken).WaitAndGetResult(cancellationToken);
-                                if (!dataTipInfo.IsDefault)
-                                {
-                                    var resultSpan = dataTipInfo.Span.ToSnapshotSpan(textSnapshot);
-                                    var textOpt = dataTipInfo.Text;
+                                var resultSpan = dataTipInfo.Span.ToSnapshotSpan(textSnapshot);
+                                var textOpt = dataTipInfo.Text;
 
-                                    pSpan[0] = resultSpan.ToVsTextSpan();
-                                    result = debugger.GetDataTipValue((IVsTextLines)vsBuffer, pSpan, textOpt, out pbstrTextInternal);
-                                }
+                                pSpan[0] = resultSpan.ToVsTextSpan();
+                                result = debugger.GetDataTipValue((IVsTextLines)vsBuffer, pSpan, textOpt, out pbstrText);
                             }
                         }
                     }
                 }
-            });
+            }
 
-            pbstrText = pbstrTextInternal;
-            return result;
+            return (pbstrText, result);
         }
     }
 
     int IVsTextViewFilter.GetPairExtents(int iLine, int iIndex, TextSpan[] pSpan)
     {
-        try
-        {
-            var result = VSConstants.S_OK;
-            ComponentModel.GetService<IUIThreadOperationExecutor>().Execute(
-                "Intellisense",
-                defaultDescription: "",
-                allowCancellation: true,
-                showProgress: false,
-                action: c => result = GetPairExtentsWorker(iLine, iIndex, pSpan, c.UserCancellationToken));
-
-            return result;
-        }
-        catch (Exception e) when (FatalError.ReportAndCatch(e) && false)
-        {
-            throw ExceptionUtilities.Unreachable();
-        }
+        return this.ThreadingContext.JoinableTaskFactory.Run(() => GetPairExtentsAsync(iLine, iIndex, pSpan));
     }
 
-    private int GetPairExtentsWorker(int iLine, int iIndex, TextSpan[] pSpan, CancellationToken cancellationToken)
+    private async Task<int> GetPairExtentsAsync(int iLine, int iIndex, TextSpan[] pSpan)
     {
+        using var waitContext = ComponentModel.GetService<IUIThreadOperationExecutor>().BeginExecute(
+            "Intellisense",
+            defaultDescription: "",
+            allowCancellation: true,
+            showProgress: false);
+
         var braceMatcher = ComponentModel.GetService<IBraceMatchingService>();
         var globalOptions = ComponentModel.GetService<IGlobalOptionService>();
-        return GetPairExtentsWorker(
+
+        return await GetPairExtentsAsync(
             WpfTextView,
             braceMatcher,
             globalOptions,
             iLine,
             iIndex,
             pSpan,
             (VSConstants.VSStd2KCmdID)this.CurrentlyExecutingCommand == VSConstants.VSStd2KCmdID.GOTOBRACE_EXT,
-            cancellationToken);
+            waitContext.UserCancellationToken).ConfigureAwait(true);
     }
 
     // Internal for testing purposes
-    internal static int GetPairExtentsWorker(ITextView textView, IBraceMatchingService braceMatcher, IGlobalOptionService globalOptions, int iLine, int iIndex, TextSpan[] pSpan, bool extendSelection, CancellationToken cancellationToken)
+    internal static async Task<int> GetPairExtentsAsync(
+        ITextView textView,
+        IBraceMatchingService braceMatcher,
+        IGlobalOptionService globalOptions,
+        int iLine,
+        int iIndex,
+        TextSpan[] pSpan,
+        bool extendSelection,
+        CancellationToken cancellationToken)
     {
         pSpan[0].iStartLine = pSpan[0].iEndLine = iLine;
         pSpan[0].iStartIndex = pSpan[0].iEndIndex = iIndex;
@@ -202,7 +188,8 @@ internal static int GetPairExtentsWorker(ITextView textView, IBraceMatchingServi
                 if (document != null)
                 {
                     var options = globalOptions.GetBraceMatchingOptions(document.Project.Language);
-                    var matchingSpan = braceMatcher.FindMatchingSpanAsync(document, position, options, cancellationToken).WaitAndGetResult(cancellationToken);
+                    var matchingSpan = await braceMatcher.FindMatchingSpanAsync(
+                        document, position, options, cancellationToken).ConfigureAwait(true);
 
                     if (matchingSpan.HasValue)
                     {
@@ -236,7 +223,8 @@ internal static int GetPairExtentsWorker(ITextView textView, IBraceMatchingServi
                                 if (extendSelection)
                                 {
                                     // case a.
-                                    var closingSpans = braceMatcher.FindMatchingSpanAsync(document, matchingSpan.Value.Start, options, cancellationToken).WaitAndGetResult(cancellationToken);
+                                    var closingSpans = await braceMatcher.FindMatchingSpanAsync(
+                                        document, matchingSpan.Value.Start, options, cancellationToken).ConfigureAwait(true);
                                     var vsClosingSpans = textView.GetSpanInView(closingSpans.Value.ToSnapshotSpan(subjectBuffer.CurrentSnapshot)).First().ToVsTextSpan();
                                     pSpan[0].iEndIndex = vsClosingSpans.iStartIndex;
                                 }
@@ -255,7 +243,8 @@ internal static int GetPairExtentsWorker(ITextView textView, IBraceMatchingServi
                                     pSpan[0].iEndIndex = vsTextSpan.iStartIndex;
 
                                     // case b.
-                                    var openingSpans = braceMatcher.FindMatchingSpanAsync(document, matchingSpan.Value.End, options, cancellationToken).WaitAndGetResult(cancellationToken);
+                                    var openingSpans = await braceMatcher.FindMatchingSpanAsync(
+                                        document, matchingSpan.Value.End, options, cancellationToken).ConfigureAwait(true);
                                     var vsOpeningSpans = textView.GetSpanInView(openingSpans.Value.ToSnapshotSpan(subjectBuffer.CurrentSnapshot)).First().ToVsTextSpan();
                                     pSpan[0].iStartIndex = vsOpeningSpans.iStartIndex;
                                 }
diff --git a/src/VisualStudio/Core/Def/Implementation/StandaloneCommandFilter.cs b/src/VisualStudio/Core/Def/Implementation/StandaloneCommandFilter.cs
@@ -10,16 +10,5 @@ namespace Microsoft.VisualStudio.LanguageServices.Implementation;
 /// <summary>
 /// A CommandFilter used for "normal" files, as opposed to Venus files which are special.
 /// </summary>
-internal sealed class StandaloneCommandFilter : AbstractVsTextViewFilter
-{
-    /// <summary>
-    /// Creates a new command handler that is attached to an IVsTextView.
-    /// </summary>
-    /// <param name="wpfTextView">The IWpfTextView of the view.</param>
-    internal StandaloneCommandFilter(
-        IWpfTextView wpfTextView,
-        IComponentModel componentModel)
-        : base(wpfTextView, componentModel)
-    {
-    }
-}
+internal sealed class StandaloneCommandFilter(
+    IWpfTextView wpfTextView, IComponentModel componentModel) : AbstractVsTextViewFilter(wpfTextView, componentModel);
diff --git a/src/VisualStudio/Core/Def/Venus/VenusCommandFilter.cs b/src/VisualStudio/Core/Def/Venus/VenusCommandFilter.cs
@@ -6,6 +6,7 @@
 
 using System.Diagnostics;
 using System.Linq;
+using System.Threading.Tasks;
 using Microsoft.VisualStudio.ComponentModelHost;
 using Microsoft.VisualStudio.Editor;
 using Microsoft.VisualStudio.LanguageServices.Implementation.Extensions;
@@ -43,14 +44,13 @@ public VenusCommandFilter(
     protected override ITextBuffer GetSubjectBufferContainingCaret()
         => _subjectBuffer;
 
-    protected override int GetDataTipTextImpl(TextSpan[] pSpan, out string pbstrText)
+    protected override async Task<(string pbstrText, int result)> GetDataTipTextImplAsync(TextSpan[] pSpan)
     {
         var textViewModel = WpfTextView.TextViewModel;
         if (textViewModel == null)
         {
             Debug.Assert(WpfTextView.IsClosed);
-            pbstrText = null;
-            return VSConstants.E_FAIL;
+            return (null, VSConstants.E_FAIL);
         }
 
         // We need to map the TextSpan from the DataBuffer to our subject buffer.
@@ -72,7 +72,7 @@ protected override int GetDataTipTextImpl(TextSpan[] pSpan, out string pbstrText
             // Next, we'll check to see if there is actually a DataTip for this candidate.
             // If there is, we'll map this span back to the DataBuffer and return it.
             var subjectBufferSpanData = new TextSpan[] { candidateSpan.ToVsTextSpan() };
-            var hr = GetDataTipTextImpl(_subjectBuffer, subjectBufferSpanData, out pbstrText);
+            var (pbstrText, hr) = await GetDataTipTextImplAsync(_subjectBuffer, subjectBufferSpanData).ConfigureAwait(true);
             if (ErrorHandler.Succeeded(hr))
             {
                 var subjectSpan = _subjectBuffer.CurrentSnapshot.GetSpan(subjectBufferSpanData[0]);
@@ -85,18 +85,14 @@ protected override int GetDataTipTextImpl(TextSpan[] pSpan, out string pbstrText
                     .SingleOrDefault(x => x.IntersectsWith(span));
 
                 if (surfaceSpan == default)
-                {
-                    pbstrText = null;
-                    return VSConstants.E_FAIL;
-                }
+                    return (null, VSConstants.E_FAIL);
 
                 // pSpan is an in/out parameter
                 pSpan[0] = surfaceSpan.ToVsTextSpan();
-                return hr;
+                return (pbstrText, hr);
             }
         }
 
-        pbstrText = null;
-        return VSConstants.E_FAIL;
+        return (null, VSConstants.E_FAIL);
     }
 }
diff --git a/src/VisualStudio/Core/Test/AbstractTextViewFilterTests.vb b/src/VisualStudio/Core/Test/AbstractTextViewFilterTests.vb

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`using System.Diagnostics.CodeAnalysis;`
`6`	`6`	`using System.Runtime.InteropServices;`
`7`	`7`	`using Microsoft.CodeAnalysis.Editor.Shared.Extensions;`
	`8`	`+using Microsoft.CodeAnalysis.Editor.Shared.Utilities;`
`8`	`9`	`using Microsoft.VisualStudio.ComponentModelHost;`
`9`	`10`	`using Microsoft.VisualStudio.Editor;`
`10`	`11`	`using Microsoft.VisualStudio.OLE.Interop;`
`@@ -35,6 +36,7 @@ public AbstractOleCommandTarget(`
`35`	`36`	`}`
`36`	`37`
`37`	`38`	`public IComponentModel ComponentModel { get; }`
	`39`	`+ protected IThreadingContext ThreadingContext => ComponentModel.GetService<IThreadingContext>();`
`38`	`40`
`39`	`41`	`public IVsEditorAdaptersFactoryService EditorAdaptersFactory`
`40`	`42`	`{`