Concurrent installation (#1950)

Author: alerickson

src/code/ContainerRegistryServerAPICalls.cs

@@ -3,6 +3,7 @@
 
 using System;
 using System.Collections;
+using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
 using System.IO;
@@ -81,6 +82,16 @@ public ContainerRegistryServerAPICalls(PSRepositoryInfo repository, PSCmdlet cmd
 
         #region Overridden Methods
 
+        public override Task<FindResults> FindVersionAsync(string packageName, string version, ResourceType type, ConcurrentQueue<ErrorRecord> errorMsgs, ConcurrentQueue<string> warningMsgs, ConcurrentQueue<string> debugMsgs, ConcurrentQueue<string> verboseMsgs)
+        {
+            throw new NotImplementedException("FindVersionAsync is not implemented for ContainerRegistryServerAPICalls.");
+        }
+
+        public override Task<FindResults> FindVersionGlobbingAsync(string packageName, VersionRange versionRange, bool includePrerelease, ResourceType type, bool getOnlyLatest, ConcurrentQueue<ErrorRecord> errorMsgs, ConcurrentQueue<string> warningMsgs, ConcurrentQueue<string> debugMsgs, ConcurrentQueue<string> verboseMsgs)
+        {
+            throw new NotImplementedException("FindVersionGlobbingAsync is not implemented for ContainerRegistryServerAPICalls.");   
+        }
+
         /// <summary>
         /// Find method which allows for searching for all packages from a repository and returns latest version for each.
         /// </summary>
@@ -146,6 +157,12 @@ public override FindResults FindName(string packageName, bool includePrerelease,
             return new FindResults(stringResponse: new string[] { }, hashtableResponse: pkgResult.ToArray(), responseType: containerRegistryFindResponseType);
         }
 
+
+        public override Task<FindResults> FindNameAsync(string packageName, bool includePrerelease, ResourceType type, ConcurrentQueue<ErrorRecord> errorMsgs, ConcurrentQueue<string> warningMsgs, ConcurrentQueue<string> debugMsgs, ConcurrentQueue<string> verboseMsgs)
+        {
+            throw new NotImplementedException("FindNameAsync is not implemented for ContainerRegistryServerAPICalls.");
+        }
+
         /// <summary>
         /// Find method which allows for searching for single name and tag and returns latest version.
         /// Name: no wildcard support
@@ -302,6 +319,19 @@ public override Stream InstallPackage(string packageName, string packageVersion,
             return results;
         }
 
+        /// <summary>
+        /// Installs a specific package asynchronously.
+        /// User may request to install package with or without providing version (as seen in examples below), but prior to calling this method the package is located and package version determined.
+        /// Therefore, package version should not be null in this method.
+        /// Name: no wildcard support.
+        /// Examples: Install "PowerShellGet" -Version "3.5.0-alpha"
+        ///           Install "PowerShellGet" -Version "3.0.0"
+        /// </summary>
+        public override Task<Stream> InstallPackageAsync(string packageName, string packageVersion, bool includePrerelease, ConcurrentQueue<ErrorRecord> errorMsgs, ConcurrentQueue<string> warningMsgs, ConcurrentQueue<string> debugMsgs, ConcurrentQueue<string> verboseMsgs)
+        {
+            throw new NotImplementedException("FindNameAsync is not implemented for ContainerRegistryServerAPICalls.");
+        }
+
         /// <summary>
         /// Installs a package with version specified.
         /// Version can be prerelease or stable.

src/code/FindHelper.cs

@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
 using Microsoft.PowerShell.PSResourceGet.UtilClasses;

src/code/GetHelper.cs

@@ -292,7 +292,7 @@ protected override void ProcessRecord()
                 case InputObjectParameterSet:
                     foreach (var inputObj in InputObject)
                     {
-                        string normalizedVersionString = Utils.GetNormalizedVersionString(inputObj.Version.ToString(), inputObj.Prerelease);
+                        string normalizedVersionString = Utils.GetFullVersionString(inputObj.Version.ToString(), inputObj.Prerelease);
                         ProcessInstallHelper(
                             pkgNames: new string[] { inputObj.Name },
                             pkgVersion: normalizedVersionString,

src/code/InstallHelper.cs

@@ -13,6 +13,7 @@
 using System.Net;
 using System.Runtime.ExceptionServices;
 using System.Management.Automation;
+using System.Collections.Concurrent;
 
 namespace Microsoft.PowerShell.PSResourceGet.Cmdlets
 {
@@ -48,6 +49,15 @@ public NuGetServerAPICalls (PSRepositoryInfo repository, PSCmdlet cmdletPassedIn
 
         #region Overridden Methods
 
+        public override Task<FindResults> FindVersionAsync(string packageName, string version, ResourceType type, ConcurrentQueue<ErrorRecord> errorMsgs, ConcurrentQueue<string> warningMsgs, ConcurrentQueue<string> debugMsgs, ConcurrentQueue<string> verboseMsgs)
+        {
+            throw new NotImplementedException("FindVersionAsync is not implemented for NuGetServerAPICalls.");
+        }
+
+        public override Task<FindResults> FindVersionGlobbingAsync(string packageName, VersionRange versionRange, bool includePrerelease, ResourceType type, bool getOnlyLatest, ConcurrentQueue<ErrorRecord> errorMsgs, ConcurrentQueue<string> warningMsgs, ConcurrentQueue<string> debugMsgs, ConcurrentQueue<string> verboseMsgs)
+        {
+            throw new NotImplementedException("FindVersionGlobbingAsync is not implemented for NuGetServerAPICalls.");
+        }
         /// <summary>
         /// Find method which allows for searching for all packages from a repository and returns latest version for each.
         /// Examples: Search -Repository MyNuGetServer
@@ -183,6 +193,11 @@ public override FindResults FindName(string packageName, bool includePrerelease,
             return new FindResults(stringResponse: new string[]{ response }, hashtableResponse: emptyHashResponses, responseType: FindResponseType);
         }
 
+        public override Task<FindResults> FindNameAsync(string packageName, bool includePrerelease, ResourceType type, ConcurrentQueue<ErrorRecord> errorMsgs, ConcurrentQueue<string> warningMsgs, ConcurrentQueue<string> debugMsgs, ConcurrentQueue<string> verboseMsgs)
+        {
+            throw new NotImplementedException("FindNameAsync is not implemented for NuGetServerAPICalls.");
+        }
+
         /// <summary>
         /// Find method which allows for searching for single name and tag and returns latest version.
         /// Name: no wildcard support
@@ -446,6 +461,19 @@ public override Stream InstallPackage(string packageName, string packageVersion,
             return results;
         }
 
+        /// <summary>
+        /// Installs a specific package asynchronously.
+        /// User may request to install package with or without providing version (as seen in examples below), but prior to calling this method the package is located and package version determined.
+        /// Therefore, package version should not be null in this method.
+        /// Name: no wildcard support.
+        /// Examples: Install "PowerShellGet" -Version "3.5.0-alpha"
+        ///           Install "PowerShellGet" -Version "3.0.0"
+        /// </summary>
+        public override Task<Stream> InstallPackageAsync(string packageName, string packageVersion, bool includePrerelease, ConcurrentQueue<ErrorRecord> errorMsgs, ConcurrentQueue<string> warningMsgs, ConcurrentQueue<string> debugMsgs, ConcurrentQueue<string> verboseMsgs)
+        {
+            throw new NotImplementedException("InstallPackageAsync is not implemented for NuGetServerAPICalls.");
+        }
+
         /// <summary>
         /// Helper method that makes the HTTP request for the NuGet server protocol url passed in for find APIs.
         /// </summary>

src/code/InstallPSResource.cs

@@ -1535,7 +1535,7 @@ private static Dependency[] GetDependencies(ArrayList dependencyInfos)
 
         private static string ConcatenateVersionWithPrerelease(string version, string prerelease)
         {
-            return Utils.GetNormalizedVersionString(version, prerelease);
+            return Utils.GetThreeDigitNormalizedVersionString(version, prerelease);
         }
 
         #endregion
@@ -1820,9 +1820,8 @@ private static ResourceType ParseHttpMetadataTypeForLocalRepo(
 
         private PSObject ConvertToCustomObject()
         {
-            // 1.0.0-alpha1
-            // 1.0.0.0
-            string NormalizedVersion = IsPrerelease ? ConcatenateVersionWithPrerelease(Version.ToString(), Prerelease) : Version.ToString();
+            string version = Utils.GetFullVersionString(Version.ToString(), Prerelease);
+            string NormalizedVersion = Utils.GetThreeDigitNormalizedVersionString(Version.ToString(), Prerelease); 
 
             var additionalMetadata = new PSObject();
 
@@ -1852,7 +1851,7 @@ private PSObject ConvertToCustomObject()
 
             var psObject = new PSObject();
             psObject.Properties.Add(new PSNoteProperty(nameof(Name), Name));
-            psObject.Properties.Add(new PSNoteProperty(nameof(Version), NormalizedVersion));
+            psObject.Properties.Add(new PSNoteProperty(nameof(Version), version));
             psObject.Properties.Add(new PSNoteProperty(nameof(Type), Type));
             psObject.Properties.Add(new PSNoteProperty(nameof(Description), Description));
             psObject.Properties.Add(new PSNoteProperty(nameof(Author), Author));

src/code/LocalServerApiCalls.cs

@@ -216,7 +216,7 @@ protected override void ProcessRecord()
                 case InputObjectParameterSet:
                     foreach (var inputObj in InputObject)
                     {
-                        string normalizedVersionString = Utils.GetNormalizedVersionString(inputObj.Version.ToString(), inputObj.Prerelease);
+                        string normalizedVersionString = Utils.GetFullVersionString(inputObj.Version.ToString(), inputObj.Prerelease);
                         ProcessSaveHelper(
                             pkgNames: new string[] { inputObj.Name },
                             pkgVersion: normalizedVersionString,

src/code/NuGetServerAPICalls.cs

@@ -10,6 +10,8 @@
 using System.Text;
 using System.Runtime.ExceptionServices;
 using System.Management.Automation;
+using System.Threading.Tasks;
+using System.Collections.Concurrent;
 
 namespace Microsoft.PowerShell.PSResourceGet.Cmdlets
 {
@@ -81,6 +83,13 @@ public ServerApiCall(PSRepositoryInfo repository, NetworkCredential networkCrede
         /// </summary>
         public abstract FindResults FindName(string packageName, bool includePrerelease, ResourceType type, out ErrorRecord errRecord);
 
+        /// <summary>
+        /// Find method which allows for async searching for package by single name and returns latest version.
+        /// Name: no wildcard support
+        /// Examples: Search "PowerShellGet"
+        /// </summary>
+        public abstract Task<FindResults> FindNameAsync(string packageName, bool includePrerelease, ResourceType type, ConcurrentQueue<ErrorRecord> errorMsgs, ConcurrentQueue<string> warningMsgs, ConcurrentQueue<string> debugMsgs, ConcurrentQueue<string> verboseMsgs);
+
         /// <summary>
         /// Find method which allows for searching for package by single name and tag and returns latest version.
         /// Name: no wildcard support
@@ -95,6 +104,15 @@ public ServerApiCall(PSRepositoryInfo repository, NetworkCredential networkCrede
         /// </summary>
         public abstract FindResults FindNameGlobbing(string packageName, bool includePrerelease, ResourceType type, out ErrorRecord errRecord);
 
+        /// <summary>
+        /// Find method which allows for async searching for single name with version range.
+        /// Name: no wildcard support
+        /// Version: supports wildcards
+        /// Examples: Search "PowerShellGet" "[3.0.0.0, 5.0.0.0]"
+        ///           Search "PowerShellGet" "3.*"
+        /// </summary>
+        public abstract Task<FindResults> FindVersionGlobbingAsync(string packageName, VersionRange versionRange, bool includePrerelease, ResourceType type, bool getOnlyLatest, ConcurrentQueue<ErrorRecord> errorMsgs, ConcurrentQueue<string> warningMsgs, ConcurrentQueue<string> debugMsgs, ConcurrentQueue<string> verboseMsgs);
+
         /// <summary>
         /// Find method which allows for searching for single name with wildcards and tag and returns latest version.
         /// Name: supports wildcards
@@ -118,6 +136,14 @@ public ServerApiCall(PSRepositoryInfo repository, NetworkCredential networkCrede
         /// </summary>
         public abstract FindResults FindVersion(string packageName, string version, ResourceType type, out ErrorRecord errRecord);
 
+        /// <summary>
+        /// Find method which allows for async searching for single name with specific version.
+        /// Name: no wildcard support
+        /// Version: no wildcard support
+        /// Examples: Search "PowerShellGet" "2.2.5"
+        /// </summary>
+        public abstract Task<FindResults> FindVersionAsync(string packageName, string version, ResourceType type, ConcurrentQueue<ErrorRecord> errorMsgs, ConcurrentQueue<string> warningMsgs, ConcurrentQueue<string> debugMsgs, ConcurrentQueue<string> verboseMsgs);
+
         /// <summary>
         /// Find method which allows for searching for single name with specific version.
         /// Name: no wildcard support
@@ -140,6 +166,19 @@ public ServerApiCall(PSRepositoryInfo repository, NetworkCredential networkCrede
         /// </summary>
         public abstract Stream InstallPackage(string packageName, string packageVersion, bool includePrerelease, out ErrorRecord errRecord);
 
+        /// <summary>
+        /// Installs specific package asynchronously.
+        /// Name: no wildcard support.
+        /// Examples: Install "PowerShellGet"
+        ///           Install "PowerShellGet" -Version "3.0.0"
+        ///           Install "PowerShellGet" -Version "3.0.0-beta24"
+        /// Implementation Note:   if not prerelease: https://www.powershellgallery.com/api/v2/package/powershellget (Returns latest stable)
+        ///                        if prerelease, the calling method should first call IFindPSResource.FindName(),
+        ///                             then find the exact version to install, then call into install version
+        /// </summary>
+        public abstract Task<Stream> InstallPackageAsync(string packageName, string packageVersion, bool includePrerelease, ConcurrentQueue<ErrorRecord> errorMsgs, ConcurrentQueue<string> warningMsgs, ConcurrentQueue<string> debugMsgs, ConcurrentQueue<string> verboseMsgs);
+
+
         #endregion
 
     }