Pass CancellationToken through SymbolDetails.CreateAsync()

Author: andyleejordan

src/PowerShellEditorServices/Services/Symbols/SymbolDetails.cs

@@ -3,6 +3,7 @@
 
 using System.Diagnostics;
 using System.Management.Automation;
+using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.PowerShell.EditorServices.Services.PowerShell;
 using Microsoft.PowerShell.EditorServices.Services.PowerShell.Runspace;
@@ -34,11 +35,11 @@ internal class SymbolDetails
 
         #region Constructors
 
-        // TODO: This should take a cancellation token!
         internal static async Task<SymbolDetails> CreateAsync(
             SymbolReference symbolReference,
             IRunspaceInfo currentRunspace,
-            IInternalPowerShellExecutionService executionService)
+            IInternalPowerShellExecutionService executionService,
+            CancellationToken cancellationToken)
         {
             SymbolDetails symbolDetails = new()
             {
@@ -50,14 +51,16 @@ internal static async Task<SymbolDetails> CreateAsync(
                 CommandInfo commandInfo = await CommandHelpers.GetCommandInfoAsync(
                     symbolReference.Id,
                     currentRunspace,
-                    executionService).ConfigureAwait(false);
+                    executionService,
+                    cancellationToken).ConfigureAwait(false);
 
                 if (commandInfo is not null)
                 {
                     symbolDetails.Documentation =
                         await CommandHelpers.GetCommandSynopsisAsync(
                             commandInfo,
-                            executionService).ConfigureAwait(false);
+                            executionService,
+                            cancellationToken).ConfigureAwait(false);
 
                     if (commandInfo.CommandType == CommandTypes.Application)
                     {

src/PowerShellEditorServices/Services/Symbols/SymbolsService.cs

@@ -222,12 +222,16 @@ public static IEnumerable<SymbolReference> FindOccurrencesInFile(
         /// Finds the details of the symbol at the given script file location.
         /// </summary>
         public Task<SymbolDetails?> FindSymbolDetailsAtLocationAsync(
-            ScriptFile scriptFile, int line, int column)
+            ScriptFile scriptFile, int line, int column, CancellationToken cancellationToken)
         {
             SymbolReference? symbol = FindSymbolAtLocation(scriptFile, line, column);
             return symbol is null
                 ? Task.FromResult<SymbolDetails?>(null)
-                : SymbolDetails.CreateAsync(symbol, _runspaceContext.CurrentRunspace, _executionService);
+                : SymbolDetails.CreateAsync(
+                    symbol,
+                    _runspaceContext.CurrentRunspace,
+                    _executionService,
+                    cancellationToken);
         }
 
         /// <summary>

src/PowerShellEditorServices/Services/TextDocument/Handlers/HoverHandler.cs

@@ -50,7 +50,8 @@ public override async Task<Hover> Handle(HoverParams request, CancellationToken
                 await _symbolsService.FindSymbolDetailsAtLocationAsync(
                         scriptFile,
                         request.Position.Line + 1,
-                        request.Position.Character + 1).ConfigureAwait(false);
+                        request.Position.Character + 1,
+                        cancellationToken).ConfigureAwait(false);
 
             if (symbolDetails is null)
             {

test/PowerShellEditorServices.Test/Language/SymbolsServiceTests.cs

@@ -755,7 +755,8 @@ public async Task FindsDetailsForBuiltInCommand()
             SymbolDetails symbolDetails = await symbolsService.FindSymbolDetailsAtLocationAsync(
                 GetScriptFile(FindsDetailsForBuiltInCommandData.SourceDetails),
                 FindsDetailsForBuiltInCommandData.SourceDetails.StartLineNumber,
-                FindsDetailsForBuiltInCommandData.SourceDetails.StartColumnNumber).ConfigureAwait(true);
+                FindsDetailsForBuiltInCommandData.SourceDetails.StartColumnNumber,
+                CancellationToken.None).ConfigureAwait(true);
 
             Assert.Equal("Gets the processes that are running on the local computer.", symbolDetails.Documentation);
         }