Fix ProvideCodeLenses to not take useless CancellationToken

Author: andyleejordan

src/PowerShellEditorServices/Services/CodeLens/ICodeLensProvider.cs

@@ -27,9 +27,8 @@ internal interface ICodeLensProvider
         /// <param name="scriptFile">
         /// The document for which CodeLenses should be provided.
         /// </param>
-        /// <param name="cancellationToken"></param>
         /// <returns>An IEnumerable of CodeLenses.</returns>
-        IEnumerable<CodeLens> ProvideCodeLenses(ScriptFile scriptFile, CancellationToken cancellationToken);
+        IEnumerable<CodeLens> ProvideCodeLenses(ScriptFile scriptFile);
 
         /// <summary>
         /// Resolves a CodeLens that was created without a Command.

src/PowerShellEditorServices/Services/CodeLens/PesterCodeLensProvider.cs

@@ -96,9 +96,8 @@ private static CodeLens[] GetPesterLens(PesterSymbolReference pesterSymbol, Scri
         /// Get all Pester CodeLenses for a given script file.
         /// </summary>
         /// <param name="scriptFile">The script file to get Pester CodeLenses for.</param>
-        /// <param name="cancellationToken"></param>
         /// <returns>All Pester CodeLenses for the given script file.</returns>
-        public IEnumerable<CodeLens> ProvideCodeLenses(ScriptFile scriptFile, CancellationToken cancellationToken)
+        public IEnumerable<CodeLens> ProvideCodeLenses(ScriptFile scriptFile)
         {
             // Don't return anything if codelens setting is disabled
             if (!_configurationService.CurrentSettings.Pester.CodeLens)
@@ -108,11 +107,6 @@ public IEnumerable<CodeLens> ProvideCodeLenses(ScriptFile scriptFile, Cancellati
 
             foreach (SymbolReference symbol in _symbolProvider.ProvideDocumentSymbols(scriptFile))
             {
-                if (cancellationToken.IsCancellationRequested)
-                {
-                    yield break;
-                }
-
                 if (symbol is not PesterSymbolReference pesterSymbol)
                 {
                     continue;

src/PowerShellEditorServices/Services/CodeLens/ReferencesCodeLensProvider.cs

@@ -52,17 +52,11 @@ public ReferencesCodeLensProvider(WorkspaceService workspaceService, SymbolsServ
         /// Get all reference code lenses for a given script file.
         /// </summary>
         /// <param name="scriptFile">The PowerShell script file to get code lenses for.</param>
-        /// <param name="cancellationToken"></param>
         /// <returns>An IEnumerable of CodeLenses describing all functions, classes and enums in the given script file.</returns>
-        public IEnumerable<CodeLens> ProvideCodeLenses(ScriptFile scriptFile, CancellationToken cancellationToken)
+        public IEnumerable<CodeLens> ProvideCodeLenses(ScriptFile scriptFile)
         {
             foreach (SymbolReference symbol in _symbolProvider.ProvideDocumentSymbols(scriptFile))
             {
-                if (cancellationToken.IsCancellationRequested)
-                {
-                    yield break;
-                }
-
                 // TODO: Can we support more here?
                 if (symbol.IsDeclaration &&
                     symbol.Type is

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

@@ -42,9 +42,9 @@ public override Task<CodeLensContainer> Handle(CodeLensParams request, Cancellat
             _logger.LogDebug($"Handling code lens request for {request.TextDocument.Uri}");
 
             ScriptFile scriptFile = _workspaceService.GetFile(request.TextDocument.Uri);
-            IEnumerable<CodeLens> codeLensResults = ProvideCodeLenses(scriptFile, cancellationToken);
+            IEnumerable<CodeLens> codeLensResults = ProvideCodeLenses(scriptFile);
 
-            return !codeLensResults.Any()
+            return cancellationToken.IsCancellationRequested
                 ? Task.FromResult(s_emptyCodeLensContainer)
                 : Task.FromResult(new CodeLensContainer(codeLensResults));
         }
@@ -66,19 +66,13 @@ public override Task<CodeLens> Handle(CodeLens request, CancellationToken cancel
         /// Get all the CodeLenses for a given script file.
         /// </summary>
         /// <param name="scriptFile">The PowerShell script file to get CodeLenses for.</param>
-        /// <param name="cancellationToken"></param>
         /// <returns>All generated CodeLenses for the given script file.</returns>
-        private IEnumerable<CodeLens> ProvideCodeLenses(ScriptFile scriptFile, CancellationToken cancellationToken)
+        private IEnumerable<CodeLens> ProvideCodeLenses(ScriptFile scriptFile)
         {
             foreach (ICodeLensProvider provider in _symbolsService.GetCodeLensProviders())
             {
-                foreach (CodeLens codeLens in provider.ProvideCodeLenses(scriptFile, cancellationToken))
+                foreach (CodeLens codeLens in provider.ProvideCodeLenses(scriptFile))
                 {
-                    if (cancellationToken.IsCancellationRequested)
-                    {
-                        yield break;
-                    }
-
                     yield return codeLens;
                 }
             }

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

@@ -2,7 +2,6 @@
 // Licensed under the MIT License.
 
 using System.Collections.Generic;
-using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.Extensions.Logging;
@@ -46,11 +45,6 @@ public override Task<DocumentHighlightContainer> Handle(
                 request.Position.Line + 1,
                 request.Position.Character + 1);
 
-            if (!occurrences.Any())
-            {
-                return Task.FromResult(s_emptyHighlightContainer);
-            }
-
             List<DocumentHighlight> highlights = new();
             foreach (SymbolReference occurrence in occurrences)
             {
@@ -63,7 +57,7 @@ public override Task<DocumentHighlightContainer> Handle(
 
             _logger.LogDebug("Highlights: " + highlights);
 
-            return highlights.Count == 0
+            return cancellationToken.IsCancellationRequested || highlights.Count == 0
                 ? Task.FromResult(s_emptyHighlightContainer)
                 : Task.FromResult(new DocumentHighlightContainer(highlights));
         }