Refactored completers to respect a timeout of default 2 seconds. Added completer for Get-PnPPage

Author: erwinvanhunen

CHANGELOG.md

@@ -10,6 +10,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 
 ### Added
 
+- Added tab completers for all cmdlets using a ListPipeBind parameter (e.g. `Get-PnPList -Identity`), all cmdlets using a FieldPipeBind parameter (e.g. `Get-PnPField -Identity`), `Get-PnPPropertyBag` and `Get-PnPPage` cmdlets. The argument lookup will timeout after 2 seconds. This value can controlled by setting an environment variables called "PNPPSCOMPLETERTIMEOUT" and set the value to a number specifying milliseconds (e.g. 2000 is 2 seconds)
 - Added `Reset-PnPDocumentID` cmdlet to request resetting the document ID for a document [#4238](https://github.com/pnp/powershell/pull/4238)
 - Added `Get-PnPPriviledgedIdentityManagementEligibleAssignment`, `Get-PnPPriviledgedIdentityManagementRole` and `Enable-PnPPriviledgedIdentityManagement` cmdlets to allow scripting of enabling Privileged Identity Management roles for a user [#4039](https://github.com/pnp/powershell/pull/4039)
 - Added `Add-PnPTenantRestrictedSearchAllowedList` which allows setting up a list of allowed URLs for Restricted SharePoint Search [#3993](https://github.com/pnp/powershell/pull/3993)

src/Commands/Base/Completers/ContentTypeCompleter.cs

@@ -9,9 +9,9 @@
 
 namespace PnP.PowerShell.Commands.Base.Completers
 {
-    public sealed class ContentTypeCompleter : IArgumentCompleter
+    public sealed class ContentTypeCompleter : PnPArgumentCompleter
     {
-        public IEnumerable<CompletionResult> CompleteArgument(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters)
+        public override IEnumerable<CompletionResult> GetArguments(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters)
         {
             wordToComplete = wordToComplete.Trim('"');
 

src/Commands/Base/Completers/FieldInternalNameCompleter.cs

@@ -9,9 +9,9 @@
 
 namespace PnP.PowerShell.Commands.Base.Completers
 {
-    public sealed class FieldInternalNameCompleter : IArgumentCompleter
+    public sealed class FieldInternalNameCompleter : PnPArgumentCompleter
     {
-        public IEnumerable<CompletionResult> CompleteArgument(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters)
+        public override IEnumerable<CompletionResult> GetArguments(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters)
         {
             wordToComplete = wordToComplete.Trim('"');
 

src/Commands/Base/Completers/ListNameCompleter.cs

@@ -8,9 +8,9 @@
 
 namespace PnP.PowerShell.Commands.Base.Completers
 {
-    public sealed class ListNameCompleter : IArgumentCompleter
+    public sealed class ListNameCompleter : PnPArgumentCompleter
     {
-        public IEnumerable<CompletionResult> CompleteArgument(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters)
+        public override IEnumerable<CompletionResult> GetArguments(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters)
         {
             wordToComplete = wordToComplete.Trim('"');
 

src/Commands/Base/Completers/PageCompleter.cs

@@ -0,0 +1,34 @@
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using System.Linq;
+using System.Management.Automation;
+using System.Management.Automation.Language;
+using System.Reflection.Metadata;
+using System.Threading;
+using System.Threading.Tasks;
+using AngleSharp.Css.Values;
+using Microsoft.SharePoint.Client;
+using PnP.Core.Transformation.Model;
+using PnP.PowerShell.Commands.Extensions;
+
+namespace PnP.PowerShell.Commands.Base.Completers
+{
+    public sealed class PageCompleter : PnPArgumentCompleter
+    {
+        public override IEnumerable<CompletionResult> GetArguments(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters)
+        {
+            List<CompletionResult> results = new List<CompletionResult>();
+            wordToComplete = wordToComplete.Trim('"');
+            wordToComplete = wordToComplete.Replace('\\', '/');
+            var pages = PnPConnection.Current.PnPContext.Web.GetPages(wordToComplete.TrimStart('/'));
+            foreach (var page in pages.OrderBy(p => p.Name))
+            {
+                var result = string.IsNullOrEmpty(page.Folder) ? page.Name : page.Folder + "/" + page.Name;
+                results.Add(new CompletionResult($"\"{result}\""));
+            }
+            return results;
+        }
+    }
+
+}

src/Commands/Base/Completers/PnPArgumentCompleter.cs

@@ -0,0 +1,40 @@
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using System.Management.Automation;
+using System.Management.Automation.Language;
+using System.Threading;
+using System.Threading.Tasks;
+using PnP.PowerShell.Commands.Extensions;
+
+public abstract class PnPArgumentCompleter : IArgumentCompleter
+{
+    private const int Timeout = 2000;
+    public IEnumerable<CompletionResult> CompleteArgument(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters)
+    {
+        var task = Task.Run(() => GetArguments(commandName, parameterName, wordToComplete, commandAst, fakeBoundParameters));
+        return task.TimeoutAfter(TimeSpan.FromMilliseconds(GetTimeOut())).GetAwaiter().GetResult();
+    }
+
+    public abstract IEnumerable<CompletionResult> GetArguments(string commandName, string parameterName, string wordToComplete, CommandAst commandAst, IDictionary fakeBoundParameters);
+
+    private Int32 GetTimeOut()
+    {
+        var timeOutFromEnv = Environment.GetEnvironmentVariable("PNPPSCOMPLETERTIMEOUT");
+        if (!string.IsNullOrEmpty(timeOutFromEnv))
+        {
+            try
+            {
+                return Convert.ToInt32(timeOutFromEnv);
+            }
+            catch (FormatException)
+            {
+                return Timeout;
+            }
+        }
+        else
+        {
+            return Timeout;
+        }
+    }
+}

src/Commands/Extensions/TaskExtensions.cs

@@ -0,0 +1,28 @@
+using System;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace PnP.PowerShell.Commands.Extensions
+{
+     public static class TaskExtensions
+    {
+        public static async Task<TResult> TimeoutAfter<TResult>(this Task<TResult> task, TimeSpan timeout)
+        {
+
+            using (var timeoutCancellationTokenSource = new CancellationTokenSource())
+            {
+
+                var completedTask = await Task.WhenAny(task, Task.Delay(timeout, timeoutCancellationTokenSource.Token));
+                if (completedTask == task)
+                {
+                    timeoutCancellationTokenSource.Cancel();
+                    return await task;  // Very important in order to propagate exceptions
+                }
+                else
+                {
+                    throw new TimeoutException("The operation has timed out.");
+                }
+            }
+        }
+    }
+}

src/Commands/Pages/GetPage.cs

@@ -1,4 +1,5 @@
 
+using PnP.PowerShell.Commands.Base.Completers;
 using PnP.PowerShell.Commands.Base.PipeBinds;
 using System;
 using System.Management.Automation;
@@ -11,6 +12,7 @@ namespace PnP.PowerShell.Commands.Pages
     public class GetPage : PnPWebCmdlet
     {
         [Parameter(Mandatory = true, ValueFromPipeline = true, Position = 0)]
+        [ArgumentCompleter(typeof(PCompleter))]
         public PagePipeBind Identity;
 
         protected override void ExecuteCmdlet()