Fix up bugs with find tags (#859)

alerickson · web-flow · commit 17616ee55926 · 2022-11-14T13:58:03.000-08:00
diff --git a/src/code/FindHelper.cs b/src/code/FindHelper.cs
@@ -29,6 +29,8 @@ internal class FindHelper
         private CancellationToken _cancellationToken;
         private readonly PSCmdlet _cmdletPassedIn;
         private List<string> _pkgsLeftToFind;
+        private List<string> _tagsLeftToFind;
+
         private ResourceType _type;
         private string _version;
         private SwitchParameter _prerelease = false;
@@ -246,7 +248,7 @@ public List<PSResourceInfo> FindTag(
             _credential = credential;
 
             List<PSResourceInfo> foundPackages = new List<PSResourceInfo>();
-            List<string> tagsLeftToFind = new List<string>(tag);
+            _tagsLeftToFind = new List<string>(tag);
 
             if (tag.Length == 0)
             {
@@ -292,18 +294,30 @@ public List<PSResourceInfo> FindTag(
                 return foundPackages;
             }
 
-            for (int i = 0; i < repositoriesToSearch.Count && tagsLeftToFind.Any(); i++)
+            for (int i = 0; i < repositoriesToSearch.Count && _tagsLeftToFind.Any(); i++)
             {
+                if (_type != ResourceType.None && repositoriesToSearch[i].Name != "PSGallery")
+                {
+                    _cmdletPassedIn.ThrowTerminatingError(new ErrorRecord(
+                        new PSInvalidOperationException("-Type parameter is only supported with the PowerShellGallery."),
+                        "ErrorUsingTypeParameter",
+                        ErrorCategory.InvalidOperation,
+                        this));
+                }
+                
                 _cmdletPassedIn.WriteVerbose(string.Format("Searching in repository {0}", repositoriesToSearch[i].Name));
                 if (repositoriesToSearch[i].ApiVersion == PSRepositoryInfo.APIVersion.v2)
-                {
-                    //  tag1, tag2, tag3 
-                    
+                {                    
                     // TODO:  didn't really finsh come back here
                     foreach (PSResourceInfo cmdInfo in HttpSearchFromRepository(repositoriesToSearch[i]))
                     {
                         foundPackages.Add(cmdInfo);
-                    }                        
+                    }
+                }
+                if (repositoriesToSearch[i].ApiVersion == PSRepositoryInfo.APIVersion.v3)
+                {
+                    // TODO: implement this when we work on v3 requests
+                    break;
                 }
             }
 
@@ -321,11 +335,17 @@ private IEnumerable<PSResourceInfo> HttpSearchFromRepository(PSRepositoryInfo re
                 // -Name parameter and -Tag parameter are exclusive
                 if (_tag != null)
                 {
+                    HashSet<string> tagsFound;
                     // TODO:  this is currently very buggy and the url queries need to be fixed
-                    foreach (PSResourceInfo pkgs in HttpFindTags(repositoryInfo, _type))
+                    foreach (PSResourceInfo pkgs in HttpFindTags(repositoryInfo, _type, out tagsFound))
                     {
                         yield return pkgs;
                     }
+
+                    foreach(string tag in tagsFound)
+                    {
+                        _tagsLeftToFind.Remove(tag);
+                    }
                 }
                 else if (_pkgsLeftToFind.Count > 0)
                 {
@@ -337,7 +357,6 @@ private IEnumerable<PSResourceInfo> HttpSearchFromRepository(PSRepositoryInfo re
 
                 yield break;
             }
-
             // TODO:  ADD command search, dscresource search, etc. 
         }
 
@@ -850,9 +869,9 @@ private bool IsTagMatch(PSResourceInfo pkg)
             return _tag.Intersect(pkg.Tags, StringComparer.InvariantCultureIgnoreCase).ToList().Count > 0;
         }
 
-        private PSResourceInfo[] HttpFindTags(PSRepositoryInfo repository, ResourceType type)
+        private PSResourceInfo[] HttpFindTags(PSRepositoryInfo repository, ResourceType type, out HashSet<string> tagsFound)
         {
-            return _httpFindPSResource.FindTags(_tag, repository, _prerelease, type, out string errRecord);
+            return _httpFindPSResource.FindTags(_tag, repository, _prerelease, type, out tagsFound, out string errRecord);
             // TODO:  write out error
         }
 
diff --git a/src/code/FindPSResource.cs b/src/code/FindPSResource.cs
@@ -285,15 +285,12 @@ private void ProcessTagParameterSet()
                  return;
             }
             
-            List<PSResourceInfo> foundPackages = _findHelper.FindByResourceName(
-                name: Utils.EmptyStrArray,
+            List<PSResourceInfo> foundPackages = _findHelper.FindTag(
                 type: Type,
-                version: Version,
                 prerelease: Prerelease,
                 tag: tagsToSearch,
                 repository: Repository,
-                credential: Credential,
-                includeDependencies: IncludeDependencies);
+                credential: Credential);
        
             foreach (var package in foundPackages)
             {
diff --git a/src/code/HttpFindPSResource.cs b/src/code/HttpFindPSResource.cs
@@ -58,12 +58,13 @@ public PSResourceInfo FindAll(PSRepositoryInfo repository, bool includePrereleas
         /// - No prerelease: http://www.powershellgallery.com/api/v2/Search()?$filter=IsLatestVersion&searchTerm='tag:JSON'
         /// - Include prerelease: http://www.powershellgallery.com/api/v2/Search()?$filter=IsAbsoluteLatestVersion&searchTerm='tag:JSON'&includePrerelease=true
         /// </summary>
-        public PSResourceInfo[] FindTags(string[] tags, PSRepositoryInfo repository, bool includePrerelease, ResourceType type, out string errRecord)
+        public PSResourceInfo[] FindTags(string[] tags, PSRepositoryInfo repository, bool includePrerelease, ResourceType type, out HashSet<string> tagsFound, out string errRecord)
         {
             errRecord = String.Empty;
             List<PSResourceInfo> pkgsFound = new List<PSResourceInfo>(); 
             HashSet<string> tagPkgs = new HashSet<string>();   
-            
+            tagsFound = new HashSet<string>();   
+
             // TAG example:
             // chocolatey, crescendo 
             //  >  chocolatey  ===  ModuleA
@@ -74,8 +75,6 @@ public PSResourceInfo[] FindTags(string[] tags, PSRepositoryInfo repository, boo
             {
                 string[] responses = v2ServerAPICall.FindTag(tag, repository, includePrerelease, type, out errRecord);
 
-                // TODO:  map the tag with the package which the tag came from 
-
                 foreach (string response in responses)
                 {
                     var elemList = ConvertResponseToXML(response);
@@ -93,6 +92,7 @@ public PSResourceInfo[] FindTags(string[] tags, PSRepositoryInfo repository, boo
                         {
                             tagPkgs.Add(psGetInfo.Name);
                             pkgsFound.Add(psGetInfo);
+                            tagsFound.Add(tag);
                         }
                         else 
                         {
@@ -102,7 +102,7 @@ public PSResourceInfo[] FindTags(string[] tags, PSRepositoryInfo repository, boo
                             errRecord = errorMsg;
                         }
                     }
-                }                
+                }
             }
 
             return pkgsFound.ToArray();
diff --git a/src/code/IFindPSResource.cs b/src/code/IFindPSResource.cs
@@ -1,3 +1,4 @@
+using System.Collections.Generic;
 using Microsoft.PowerShell.PowerShellGet.UtilClasses;
 using NuGet.Versioning;
 
@@ -21,7 +22,7 @@ public interface IFindPSResource
     /// - No prerelease: http://www.powershellgallery.com/api/v2/Search()?$filter=IsLatestVersion&searchTerm='tag:JSON'
     /// - Include prerelease: http://www.powershellgallery.com/api/v2/Search()?$filter=IsAbsoluteLatestVersion&searchTerm='tag:JSON'&includePrerelease=true
     /// </summary>
-    PSResourceInfo[] FindTags(string[] tags, PSRepositoryInfo repository, bool includePrerelease, ResourceType type, out string errRecord);
+    PSResourceInfo[] FindTags(string[] tags, PSRepositoryInfo repository, bool includePrerelease, ResourceType type, out HashSet<string> tagsFound, out string errRecord);
 
     /// <summary>
     /// Find method which allows for searching for packages with resource type specified from a repository and returns latest version for each.

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,8 @@ internal class FindHelper`
`29`	`29`	`private CancellationToken _cancellationToken;`
`30`	`30`	`private readonly PSCmdlet _cmdletPassedIn;`
`31`	`31`	`private List<string> _pkgsLeftToFind;`
	`32`	`+ private List<string> _tagsLeftToFind;`
	`33`	`+`
`32`	`34`	`private ResourceType _type;`
`33`	`35`	`private string _version;`
`34`	`36`	`private SwitchParameter _prerelease = false;`
`@@ -246,7 +248,7 @@ public List<PSResourceInfo> FindTag(`
`246`	`248`	`_credential = credential;`
`247`	`249`
`248`	`250`	`List<PSResourceInfo> foundPackages = new List<PSResourceInfo>();`
`249`		`- List<string> tagsLeftToFind = new List<string>(tag);`
	`251`	`+ _tagsLeftToFind = new List<string>(tag);`
`250`	`252`
`251`	`253`	`if (tag.Length == 0)`
`252`	`254`	`{`
`@@ -292,18 +294,30 @@ public List<PSResourceInfo> FindTag(`
`292`	`294`	`return foundPackages;`
`293`	`295`	`}`
`294`	`296`
`295`		`- for (int i = 0; i < repositoriesToSearch.Count && tagsLeftToFind.Any(); i++)`
	`297`	`+ for (int i = 0; i < repositoriesToSearch.Count && _tagsLeftToFind.Any(); i++)`
`296`	`298`	`{`
	`299`	`+ if (_type != ResourceType.None && repositoriesToSearch[i].Name != "PSGallery")`
	`300`	`+ {`
	`301`	`+ _cmdletPassedIn.ThrowTerminatingError(new ErrorRecord(`
	`302`	`+ new PSInvalidOperationException("-Type parameter is only supported with the PowerShellGallery."),`
	`303`	`+ "ErrorUsingTypeParameter",`
	`304`	`+ ErrorCategory.InvalidOperation,`
	`305`	`+ this));`
	`306`	`+ }`
	`307`	`+`
`297`	`308`	`_cmdletPassedIn.WriteVerbose(string.Format("Searching in repository {0}", repositoriesToSearch[i].Name));`
`298`	`309`	`if (repositoriesToSearch[i].ApiVersion == PSRepositoryInfo.APIVersion.v2)`
`299`		`- {`
`300`		`- // tag1, tag2, tag3`
`301`		`-`
	`310`	`+ {`
`302`	`311`	`// TODO: didn't really finsh come back here`
`303`	`312`	`foreach (PSResourceInfo cmdInfo in HttpSearchFromRepository(repositoriesToSearch[i]))`
`304`	`313`	`{`
`305`	`314`	`foundPackages.Add(cmdInfo);`
`306`		`- }`
	`315`	`+ }`
	`316`	`+ }`
	`317`	`+ if (repositoriesToSearch[i].ApiVersion == PSRepositoryInfo.APIVersion.v3)`
	`318`	`+ {`
	`319`	`+ // TODO: implement this when we work on v3 requests`
	`320`	`+ break;`
`307`	`321`	`}`
`308`	`322`	`}`
`309`	`323`
`@@ -321,11 +335,17 @@ private IEnumerable<PSResourceInfo> HttpSearchFromRepository(PSRepositoryInfo re`
`321`	`335`	`// -Name parameter and -Tag parameter are exclusive`
`322`	`336`	`if (_tag != null)`
`323`	`337`	`{`
	`338`	`+ HashSet<string> tagsFound;`
`324`	`339`	`// TODO: this is currently very buggy and the url queries need to be fixed`
`325`		`- foreach (PSResourceInfo pkgs in HttpFindTags(repositoryInfo, _type))`
	`340`	`+ foreach (PSResourceInfo pkgs in HttpFindTags(repositoryInfo, _type, out tagsFound))`
`326`	`341`	`{`
`327`	`342`	`yield return pkgs;`
`328`	`343`	`}`
	`344`	`+`
	`345`	`+ foreach(string tag in tagsFound)`
	`346`	`+ {`
	`347`	`+ _tagsLeftToFind.Remove(tag);`
	`348`	`+ }`
`329`	`349`	`}`
`330`	`350`	`else if (_pkgsLeftToFind.Count > 0)`
`331`	`351`	`{`
`@@ -337,7 +357,6 @@ private IEnumerable<PSResourceInfo> HttpSearchFromRepository(PSRepositoryInfo re`
`337`	`357`
`338`	`358`	`yield break;`
`339`	`359`	`}`
`340`		`-`
`341`	`360`	`// TODO: ADD command search, dscresource search, etc.`
`342`	`361`	`}`
`343`	`362`
`@@ -850,9 +869,9 @@ private bool IsTagMatch(PSResourceInfo pkg)`
`850`	`869`	`return _tag.Intersect(pkg.Tags, StringComparer.InvariantCultureIgnoreCase).ToList().Count > 0;`
`851`	`870`	`}`
`852`	`871`
`853`		`- private PSResourceInfo[] HttpFindTags(PSRepositoryInfo repository, ResourceType type)`
	`872`	`+ private PSResourceInfo[] HttpFindTags(PSRepositoryInfo repository, ResourceType type, out HashSet<string> tagsFound)`
`854`	`873`	`{`
`855`		`- return _httpFindPSResource.FindTags(_tag, repository, _prerelease, type, out string errRecord);`
	`874`	`+ return _httpFindPSResource.FindTags(_tag, repository, _prerelease, type, out tagsFound, out string errRecord);`
`856`	`875`	`// TODO: write out error`
`857`	`876`	`}`
`858`	`877`
Original file line number	Diff line number	Diff line change
`@@ -58,12 +58,13 @@ public PSResourceInfo FindAll(PSRepositoryInfo repository, bool includePrereleas`
`58`	`58`	`/// - No prerelease: http://www.powershellgallery.com/api/v2/Search()?$filter=IsLatestVersion&searchTerm='tag:JSON'`
`59`	`59`	`/// - Include prerelease: http://www.powershellgallery.com/api/v2/Search()?$filter=IsAbsoluteLatestVersion&searchTerm='tag:JSON'&includePrerelease=true`
`60`	`60`	`/// </summary>`
`61`		`- public PSResourceInfo[] FindTags(string[] tags, PSRepositoryInfo repository, bool includePrerelease, ResourceType type, out string errRecord)`
	`61`	`+ public PSResourceInfo[] FindTags(string[] tags, PSRepositoryInfo repository, bool includePrerelease, ResourceType type, out HashSet<string> tagsFound, out string errRecord)`
`62`	`62`	`{`
`63`	`63`	`errRecord = String.Empty;`
`64`	`64`	`List<PSResourceInfo> pkgsFound = new List<PSResourceInfo>();`
`65`	`65`	`HashSet<string> tagPkgs = new HashSet<string>();`
`66`		`-`
	`66`	`+ tagsFound = new HashSet<string>();`
	`67`	`+`
`67`	`68`	`// TAG example:`
`68`	`69`	`// chocolatey, crescendo`
`69`	`70`	`// > chocolatey === ModuleA`
`@@ -74,8 +75,6 @@ public PSResourceInfo[] FindTags(string[] tags, PSRepositoryInfo repository, boo`
`74`	`75`	`{`
`75`	`76`	`string[] responses = v2ServerAPICall.FindTag(tag, repository, includePrerelease, type, out errRecord);`
`76`	`77`
`77`		`- // TODO: map the tag with the package which the tag came from`
`78`		`-`
`79`	`78`	`foreach (string response in responses)`
`80`	`79`	`{`
`81`	`80`	`var elemList = ConvertResponseToXML(response);`
`@@ -93,6 +92,7 @@ public PSResourceInfo[] FindTags(string[] tags, PSRepositoryInfo repository, boo`
`93`	`92`	`{`
`94`	`93`	`tagPkgs.Add(psGetInfo.Name);`
`95`	`94`	`pkgsFound.Add(psGetInfo);`
	`95`	`+ tagsFound.Add(tag);`
`96`	`96`	`}`
`97`	`97`	`else`
`98`	`98`	`{`
`@@ -102,7 +102,7 @@ public PSResourceInfo[] FindTags(string[] tags, PSRepositoryInfo repository, boo`
`102`	`102`	`errRecord = errorMsg;`
`103`	`103`	`}`
`104`	`104`	`}`
`105`		`- }`
	`105`	`+ }`
`106`	`106`	`}`
`107`	`107`
`108`	`108`	`return pkgsFound.ToArray();`