Add support for packageType query parameter

mhutch · mhutch · commit b219c6547c8c · 2020-12-11T21:52:31.000-05:00
diff --git a/src/ProjectFileTools.NuGetSearch/Contracts/IPackageInfo.cs b/src/ProjectFileTools.NuGetSearch/Contracts/IPackageInfo.cs
@@ -1,4 +1,5 @@
-﻿using ProjectFileTools.NuGetSearch.Feeds;
+using System.Collections.Generic;
+using ProjectFileTools.NuGetSearch.Feeds;
 
 namespace ProjectFileTools.NuGetSearch.Contracts
 {
@@ -24,6 +25,8 @@ public interface IPackageInfo
 
         string Tags { get; }
 
+        IReadOnlyList<PackageType> PackageTypes { get; }
+
         FeedKind SourceKind { get; }
     }
 }
diff --git a/src/ProjectFileTools.NuGetSearch/Contracts/IPackageQueryConfiguration.cs b/src/ProjectFileTools.NuGetSearch/Contracts/IPackageQueryConfiguration.cs
@@ -1,11 +1,13 @@
-﻿namespace ProjectFileTools.NuGetSearch.Contracts
+namespace ProjectFileTools.NuGetSearch.Contracts
 {
     public interface IPackageQueryConfiguration
     {
-        string CompatibiltyTarget { get; }
+        string CompatibilityTarget { get; }
 
         bool IncludePreRelease { get; }
 
         int MaxResults { get; }
+
+        PackageType PackageType { get; }
     }
 }
diff --git a/src/ProjectFileTools.NuGetSearch/Contracts/IPackageSearchManager.cs b/src/ProjectFileTools.NuGetSearch/Contracts/IPackageSearchManager.cs
@@ -1,14 +1,14 @@
-﻿using System;
+using System;
 using ProjectFileTools.NuGetSearch.Feeds;
 
 namespace ProjectFileTools.NuGetSearch.Contracts
 {
 
     public interface IPackageSearchManager
     {
-        IPackageFeedSearchJob<Tuple<string, FeedKind>> SearchPackageNames(string prefix, string tfm);
+        IPackageFeedSearchJob<Tuple<string, FeedKind>> SearchPackageNames(string prefix, string tfm, string packageType = null);
 
-        IPackageFeedSearchJob<Tuple<string, FeedKind>> SearchPackageVersions(string packageName, string tfm);
+        IPackageFeedSearchJob<Tuple<string, FeedKind>> SearchPackageVersions(string packageName, string tfm, string packageType = null);
 
         IPackageFeedSearchJob<IPackageInfo> SearchPackageInfo(string packageId, string version, string tfm);
     }
diff --git a/src/ProjectFileTools.NuGetSearch/Contracts/PackageType.cs b/src/ProjectFileTools.NuGetSearch/Contracts/PackageType.cs
@@ -0,0 +1,44 @@
+using System;
+using System.Collections.Generic;
+
+namespace ProjectFileTools.NuGetSearch.Contracts
+{
+    public class PackageType : IEquatable<PackageType>
+    {
+        public static IReadOnlyList<PackageType> DefaultList { get; } = new[] { KnownPackageType.Dependency };
+
+        public PackageType(string id, string version = null)
+        {
+            Name = id ?? throw new ArgumentNullException(nameof(id));
+            Version = version;
+        }
+        public string Name { get; }
+        public string Version { get; }
+
+
+        public override bool Equals(object obj) => Equals(obj as PackageType);
+
+        public bool Equals(PackageType other) => other is PackageType
+            && string.Equals(Name, other.Name, StringComparison.Ordinal)
+            && string.Equals(Version, other.Version, StringComparison.Ordinal);
+
+        public override int GetHashCode()
+        {
+            int hashCode = -612338121;
+            hashCode = hashCode * -1521134295 + StringComparer.Ordinal.GetHashCode(Name);
+            hashCode = hashCode * -1521134295 + StringComparer.Ordinal.GetHashCode(Version);
+            return hashCode;
+        }
+    }
+
+    public class KnownPackageType
+    {
+        public static PackageType Legacy { get; } = new PackageType("Legacy");
+        public static PackageType DotnetCliTool { get; } = new PackageType("DotnetCliTool");
+        public static PackageType Dependency { get; } = new PackageType("Dependency");
+        public static PackageType DotnetTool { get; } = new PackageType("DotnetTool");
+        public static PackageType SymbolsPackage { get; } = new PackageType("SymbolsPackage");
+        public static PackageType DotnetPlatform { get; } = new PackageType("DotnetPlatform");
+        public static PackageType MSBuildSdk { get; } = new PackageType("MSBuildSdk");
+    }
+}
diff --git a/src/ProjectFileTools.NuGetSearch/Feeds/Disk/NuGetPackageMatcher.cs b/src/ProjectFileTools.NuGetSearch/Feeds/Disk/NuGetPackageMatcher.cs
@@ -1,4 +1,6 @@
-﻿using ProjectFileTools.NuGetSearch.Contracts;
+using System.Linq;
+
+using ProjectFileTools.NuGetSearch.Contracts;
 using ProjectFileTools.NuGetSearch.IO;
 
 namespace ProjectFileTools.NuGetSearch.Feeds.Disk
@@ -17,7 +19,16 @@ public static bool IsMatch(string dir, IPackageInfo info, IPackageQueryConfigura
                 }
             }
 
-			return true;
+            if (queryConfiguration.PackageType != null)
+            {
+                //NOTE: can't find any info on how the version is supposed to be handled (or what it's even for), so use an exact match
+                if (!info.PackageTypes.Any(p => queryConfiguration.PackageType.Equals(p)))
+                {
+                    return false;
+                }
+            }
+
+            return true;
         }
     }
 }
diff --git a/src/ProjectFileTools.NuGetSearch/Feeds/NuSpecReader.cs b/src/ProjectFileTools.NuGetSearch/Feeds/NuSpecReader.cs
@@ -1,4 +1,5 @@
-﻿using System.Xml.Linq;
+using System.Collections.Generic;
+using System.Xml.Linq;
 using ProjectFileTools.NuGetSearch.Contracts;
 
 namespace ProjectFileTools.NuGetSearch.Feeds
@@ -23,9 +24,26 @@ internal static IPackageInfo Read(string nuspec, FeedKind kind)
             XElement iconUrl = metadata?.Element (XName.Get ("iconUrl", ns.NamespaceName));
             XElement tags = metadata?.Element(XName.Get("tags", ns.NamespaceName));
 
+            List<PackageType> packageTypes = null;
+            XElement packageTypesEl = metadata?.Element(XName.Get("packageTypes", ns.NamespaceName));
+            if (packageTypesEl != null)
+            {
+                var nameName = XName.Get("name", ns.NamespaceName);
+                var versionName = XName.Get("name", ns.NamespaceName);
+                packageTypes = new List<PackageType>();
+                foreach (var packageType in packageTypesEl.Elements(XName.Get("packageType", ns.NamespaceName)))
+                {
+                    var typeName = packageType.Attribute(nameName).Value;
+                    var typeVersion = packageType.Attribute(versionName)?.Value;
+                    packageTypes.Add (new PackageType(typeName, typeVersion));
+                }
+            }
+
             if (id != null)
             {
-                return new PackageInfo(id.Value, version?.Value, title?.Value, authors?.Value, summary?.Value, description?.Value, licenseUrl?.Value, projectUrl?.Value, iconUrl?.Value, tags?.Value, kind);
+                return new PackageInfo(
+                    id.Value, version?.Value, title?.Value, authors?.Value, summary?.Value, description?.Value,
+                    licenseUrl?.Value, projectUrl?.Value, iconUrl?.Value, tags?.Value, kind, packageTypes);
             }
 
             return null;
diff --git a/src/ProjectFileTools.NuGetSearch/Feeds/PackageInfo.cs b/src/ProjectFileTools.NuGetSearch/Feeds/PackageInfo.cs
@@ -1,11 +1,13 @@
-﻿using ProjectFileTools.NuGetSearch.Contracts;
+using System.Collections.Generic;
+
+using ProjectFileTools.NuGetSearch.Contracts;
 
 namespace ProjectFileTools.NuGetSearch.Feeds
 {
 
     public class PackageInfo : IPackageInfo
     {
-        public PackageInfo(string id, string version, string title, string authors, string summary, string description, string licenseUrl, string projectUrl, string iconUrl, string tags, FeedKind sourceKind)
+        public PackageInfo(string id, string version, string title, string authors, string summary, string description, string licenseUrl, string projectUrl, string iconUrl, string tags, FeedKind sourceKind, IReadOnlyList<PackageType> packageTypes)
         {
             Id = id;
             Version = version;
@@ -17,6 +19,7 @@ public PackageInfo(string id, string version, string title, string authors, stri
             SourceKind = sourceKind;
             IconUrl = iconUrl;
             Tags = tags;
+            PackageTypes = packageTypes ?? PackageType.DefaultList;
         }
 
         public string Id { get; }
@@ -40,5 +43,7 @@ public PackageInfo(string id, string version, string title, string authors, stri
         public string Tags { get; }
 
         public FeedKind SourceKind { get; }
+
+        public IReadOnlyList<PackageType> PackageTypes { get; }
     }
 }
diff --git a/src/ProjectFileTools.NuGetSearch/Feeds/PackageQueryConfiguration.cs b/src/ProjectFileTools.NuGetSearch/Feeds/PackageQueryConfiguration.cs
@@ -1,34 +1,37 @@
-﻿using ProjectFileTools.NuGetSearch.Contracts;
+using ProjectFileTools.NuGetSearch.Contracts;
 
 namespace ProjectFileTools.NuGetSearch.Feeds
 {
     public class PackageQueryConfiguration : IPackageQueryConfiguration
     {
-        public PackageQueryConfiguration(string targetFrameworkMoniker, bool includePreRelease = true, int maxResults = 100)
+        public PackageQueryConfiguration(string targetFrameworkMoniker, bool includePreRelease = true, int maxResults = 100, PackageType packageType = null)
         {
-            CompatibiltyTarget = targetFrameworkMoniker;
+            CompatibilityTarget = targetFrameworkMoniker;
             IncludePreRelease = includePreRelease;
             MaxResults = maxResults;
+            PackageType = packageType;
         }
 
-        public string CompatibiltyTarget { get; }
+        public string CompatibilityTarget { get; }
 
         public bool IncludePreRelease { get; }
 
         public int MaxResults { get; }
 
+        public PackageType PackageType { get; }
+
         public override int GetHashCode()
         {
-            return (CompatibiltyTarget?.GetHashCode() ?? 0) ^ IncludePreRelease.GetHashCode() ^ MaxResults.GetHashCode();
+            return (CompatibilityTarget?.GetHashCode() ?? 0) ^ IncludePreRelease.GetHashCode() ^ MaxResults.GetHashCode() ^ (PackageType?.GetHashCode() ?? 0);
         }
 
         public override bool Equals(object obj)
         {
-            PackageQueryConfiguration cfg = obj as PackageQueryConfiguration;
-            return cfg != null
-                && string.Equals(CompatibiltyTarget, cfg.CompatibiltyTarget, System.StringComparison.Ordinal)
+            return obj is PackageQueryConfiguration cfg
+                && string.Equals(CompatibilityTarget, cfg.CompatibilityTarget, System.StringComparison.Ordinal)
                 && IncludePreRelease == cfg.IncludePreRelease
-                && MaxResults == cfg.MaxResults;
+                && MaxResults == cfg.MaxResults
+                && (PackageType?.Equals(cfg.PackageType) ?? false);
         }
     }
 }
diff --git a/src/ProjectFileTools.NuGetSearch/Feeds/Web/NuGetV3ServiceFeed.cs b/src/ProjectFileTools.NuGetSearch/Feeds/Web/NuGetV3ServiceFeed.cs
@@ -1,4 +1,4 @@
-﻿using System;
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading;
@@ -192,10 +192,11 @@ public async Task<IPackageNameSearchResult> GetPackageNamesAsync(string prefix,
             }
 
             IReadOnlyList<string> results = new List<string>();
-            string frameworkQuery = !string.IsNullOrEmpty(queryConfiguration.CompatibiltyTarget) ? $"&supportedFramework={queryConfiguration.CompatibiltyTarget}" : "";
-            const string autoCompleteServiceTypeIdentifier = "SearchAutocompleteService";
+            string frameworkQuery = !string.IsNullOrEmpty(queryConfiguration.CompatibilityTarget) ? $"&supportedFramework={queryConfiguration.CompatibilityTarget}" : "";
+            string packageTypeQuery = !string.IsNullOrEmpty(queryConfiguration.PackageType?.Name) ? $"&packageType={queryConfiguration.PackageType.Name}" : "";
+            const string autoCompleteServiceTypeIdentifier = "SearchAutocompleteService/3.5.0";
             List<string> serviceEndpoints = await DiscoverEndpointsAsync(_feed, autoCompleteServiceTypeIdentifier, cancellationToken).ConfigureAwait(false);
-            Func<string, string> queryFunc = x => $"{x}?q={prefix}{frameworkQuery}&take={queryConfiguration.MaxResults}&prerelease={queryConfiguration.IncludePreRelease}";
+            Func<string, string> queryFunc = x => $"{x}?q={prefix}&semVerLevel=2.0.0{frameworkQuery}{packageTypeQuery}&take={queryConfiguration.MaxResults}&prerelease={queryConfiguration.IncludePreRelease}";
             JObject document = await ExecuteAutocompleteServiceQueryAsync(serviceEndpoints, queryFunc, cancellationToken).ConfigureAwait(false);
 
             if (document != null)
@@ -294,7 +295,7 @@ public async Task<IPackageInfo> GetPackageInfoAsync(string packageId, string ver
                                         licenseUrl = catalogEntry["licenseUrl"]?.ToString();
                                         iconUrl = catalogEntry["iconUrl"]?.ToString();
                                         tags = catalogEntry ["tags"]?.ToString ();
-                                        packageInfo = new PackageInfo(id, version, title, authors, summary, description, licenseUrl, projectUrl, iconUrl, tags, _kind);
+                                        packageInfo = new PackageInfo(id, version, title, authors, summary, description, licenseUrl, projectUrl, iconUrl, tags, _kind, null);
                                         return packageInfo;
                                     }
                                 }
@@ -311,7 +312,7 @@ public async Task<IPackageInfo> GetPackageInfoAsync(string packageId, string ver
                                         licenseUrl = catalogEntry["licenseUrl"]?.ToString();
                                         iconUrl = catalogEntry["iconUrl"]?.ToString ();
                                         tags = catalogEntry["tags"]?.ToString();
-                                        packageInfo = new PackageInfo(id, version, title, authors, summary, description, licenseUrl, projectUrl, iconUrl, tags, _kind);
+                                        packageInfo = new PackageInfo(id, version, title, authors, summary, description, licenseUrl, projectUrl, iconUrl, tags, _kind, null);
                                         bestSemanticVersion = currentVersion;
                                     }
                                 }
@@ -329,7 +330,7 @@ public async Task<IPackageInfo> GetPackageInfoAsync(string packageId, string ver
         public async Task<IPackageVersionSearchResult> GetPackageVersionsAsync(string id, IPackageQueryConfiguration queryConfiguration, CancellationToken cancellationToken)
         {
             IReadOnlyList<string> results = new List<string>();
-            string frameworkQuery = !string.IsNullOrEmpty(queryConfiguration.CompatibiltyTarget) ? $"&supportedFramework={queryConfiguration.CompatibiltyTarget}" : "";
+            string frameworkQuery = !string.IsNullOrEmpty(queryConfiguration.CompatibilityTarget) ? $"&supportedFramework={queryConfiguration.CompatibilityTarget}" : "";
             const string autoCompleteServiceTypeIdentifier = "SearchAutocompleteService";
             List<string> serviceEndpoints = await DiscoverEndpointsAsync(_feed, autoCompleteServiceTypeIdentifier, cancellationToken).ConfigureAwait(false);
             Func<string, string> queryFunc = x => $"{x}?id={id}{frameworkQuery}&take={queryConfiguration.MaxResults}&prerelease={queryConfiguration.IncludePreRelease}";
diff --git a/src/ProjectFileTools.NuGetSearch/Search/PackageSearchManager.cs b/src/ProjectFileTools.NuGetSearch/Search/PackageSearchManager.cs

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`		`-using ProjectFileTools.NuGetSearch.Feeds;`
	`1`	`+using System.Collections.Generic;`
	`2`	`+using ProjectFileTools.NuGetSearch.Feeds;`
`2`	`3`
`3`	`4`	`namespace ProjectFileTools.NuGetSearch.Contracts`
`4`	`5`	`{`
`@@ -24,6 +25,8 @@ public interface IPackageInfo`
`24`	`25`
`25`	`26`	`string Tags { get; }`
`26`	`27`
	`28`	`+ IReadOnlyList<PackageType> PackageTypes { get; }`
	`29`	`+`
`27`	`30`	`FeedKind SourceKind { get; }`
`28`	`31`	`}`
`29`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,11 +1,13 @@`
`1`		`-namespace ProjectFileTools.NuGetSearch.Contracts`
	`1`	`+namespace ProjectFileTools.NuGetSearch.Contracts`
`2`	`2`	`{`
`3`	`3`	`public interface IPackageQueryConfiguration`
`4`	`4`	`{`
`5`		`- string CompatibiltyTarget { get; }`
	`5`	`+ string CompatibilityTarget { get; }`
`6`	`6`
`7`	`7`	`bool IncludePreRelease { get; }`
`8`	`8`
`9`	`9`	`int MaxResults { get; }`
	`10`	`+`
	`11`	`+ PackageType PackageType { get; }`
`10`	`12`	`}`
`11`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,14 +1,14 @@`
`1`		`-using System;`
	`1`	`+using System;`
`2`	`2`	`using ProjectFileTools.NuGetSearch.Feeds;`
`3`	`3`
`4`	`4`	`namespace ProjectFileTools.NuGetSearch.Contracts`
`5`	`5`	`{`
`6`	`6`
`7`	`7`	`public interface IPackageSearchManager`
`8`	`8`	`{`
`9`		`- IPackageFeedSearchJob<Tuple<string, FeedKind>> SearchPackageNames(string prefix, string tfm);`
	`9`	`+ IPackageFeedSearchJob<Tuple<string, FeedKind>> SearchPackageNames(string prefix, string tfm, string packageType = null);`
`10`	`10`
`11`		`- IPackageFeedSearchJob<Tuple<string, FeedKind>> SearchPackageVersions(string packageName, string tfm);`
	`11`	`+ IPackageFeedSearchJob<Tuple<string, FeedKind>> SearchPackageVersions(string packageName, string tfm, string packageType = null);`
`12`	`12`
`13`	`13`	`IPackageFeedSearchJob<IPackageInfo> SearchPackageInfo(string packageId, string version, string tfm);`
`14`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,6 @@`
`1`		`-using ProjectFileTools.NuGetSearch.Contracts;`
	`1`	`+using System.Linq;`
	`2`	`+`
	`3`	`+using ProjectFileTools.NuGetSearch.Contracts;`
`2`	`4`	`using ProjectFileTools.NuGetSearch.IO;`
`3`	`5`
`4`	`6`	`namespace ProjectFileTools.NuGetSearch.Feeds.Disk`
`@@ -17,7 +19,16 @@ public static bool IsMatch(string dir, IPackageInfo info, IPackageQueryConfigura`
`17`	`19`	`}`
`18`	`20`	`}`
`19`	`21`
`20`		`- return true;`
	`22`	`+ if (queryConfiguration.PackageType != null)`
	`23`	`+ {`
	`24`	`+ //NOTE: can't find any info on how the version is supposed to be handled (or what it's even for), so use an exact match`
	`25`	`+ if (!info.PackageTypes.Any(p => queryConfiguration.PackageType.Equals(p)))`
	`26`	`+ {`
	`27`	`+ return false;`
	`28`	`+ }`
	`29`	`+ }`
	`30`	`+`
	`31`	`+ return true;`
`21`	`32`	`}`
`22`	`33`	`}`
`23`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,34 +1,37 @@`
`1`		`-using ProjectFileTools.NuGetSearch.Contracts;`
	`1`	`+using ProjectFileTools.NuGetSearch.Contracts;`
`2`	`2`
`3`	`3`	`namespace ProjectFileTools.NuGetSearch.Feeds`
`4`	`4`	`{`
`5`	`5`	`public class PackageQueryConfiguration : IPackageQueryConfiguration`
`6`	`6`	`{`
`7`		`- public PackageQueryConfiguration(string targetFrameworkMoniker, bool includePreRelease = true, int maxResults = 100)`
	`7`	`+ public PackageQueryConfiguration(string targetFrameworkMoniker, bool includePreRelease = true, int maxResults = 100, PackageType packageType = null)`
`8`	`8`	`{`
`9`		`- CompatibiltyTarget = targetFrameworkMoniker;`
	`9`	`+ CompatibilityTarget = targetFrameworkMoniker;`
`10`	`10`	`IncludePreRelease = includePreRelease;`
`11`	`11`	`MaxResults = maxResults;`
	`12`	`+ PackageType = packageType;`
`12`	`13`	`}`
`13`	`14`
`14`		`- public string CompatibiltyTarget { get; }`
	`15`	`+ public string CompatibilityTarget { get; }`
`15`	`16`
`16`	`17`	`public bool IncludePreRelease { get; }`
`17`	`18`
`18`	`19`	`public int MaxResults { get; }`
`19`	`20`
	`21`	`+ public PackageType PackageType { get; }`
	`22`	`+`
`20`	`23`	`public override int GetHashCode()`
`21`	`24`	`{`
`22`		`- return (CompatibiltyTarget?.GetHashCode() ?? 0) ^ IncludePreRelease.GetHashCode() ^ MaxResults.GetHashCode();`
	`25`	`+ return (CompatibilityTarget?.GetHashCode() ?? 0) ^ IncludePreRelease.GetHashCode() ^ MaxResults.GetHashCode() ^ (PackageType?.GetHashCode() ?? 0);`
`23`	`26`	`}`
`24`	`27`
`25`	`28`	`public override bool Equals(object obj)`
`26`	`29`	`{`
`27`		`- PackageQueryConfiguration cfg = obj as PackageQueryConfiguration;`
`28`		`- return cfg != null`
`29`		`- && string.Equals(CompatibiltyTarget, cfg.CompatibiltyTarget, System.StringComparison.Ordinal)`
	`30`	`+ return obj is PackageQueryConfiguration cfg`
	`31`	`+ && string.Equals(CompatibilityTarget, cfg.CompatibilityTarget, System.StringComparison.Ordinal)`
`30`	`32`	`&& IncludePreRelease == cfg.IncludePreRelease`
`31`		`- && MaxResults == cfg.MaxResults;`
	`33`	`+ && MaxResults == cfg.MaxResults`
	`34`	`+ && (PackageType?.Equals(cfg.PackageType) ?? false);`
`32`	`35`	`}`
`33`	`36`	`}`
`34`	`37`	`}`