Skip to content

Make SearchFilter.PackageType singular rather than plural #7469

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zivkan merged 9 commits into from
Jun 24, 2026
Merged

Make SearchFilter.PackageType singular rather than plural #7469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
1e19ccd
Enable nullable checks on PackageSearchResourceV3
zivkan Jun 10, 2026
24e0b1e
perf: use IReadOnlyList<Uri> to reduce allocations
zivkan Jun 10, 2026
82121a8
Remove server count logging
zivkan Jun 10, 2026
1643ba2
Remove unnecessart Search method
zivkan Jun 10, 2026
7fc6b73
Avoid double enumeration
zivkan Jun 10, 2026
940e695
Add SupportsPackageTypeFiltering to PackageSearchResource
zivkan Jun 10, 2026
f8487ae
Avoid resizing
zivkan Jun 10, 2026
d3dd5f1
breaking change: change PackageTypes to PackageType
zivkan Jun 10, 2026
72cf9b6
Minor perf improvements
zivkan Jun 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions src/NuGet.Clients/NuGet.VisualStudio.Internal.Contracts/Formatters/SearchFilterFormatter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ internal sealed class SearchFilterFormatter : NuGetMessagePackFormatter<SearchFi
{
private const string IncludePrereleasePropertyName = "includeprerelease";
private const string IncludeDelistedPropertyName = "includedelisted";
private const string PackageTypesPropertyName = "packagetypes";
private const string PackageTypePropertyName = "packagetype";
private const string FilterPropertyName = "filter";
private const string OrderByPropertyName = "orderby";
private const string SupportedFrameworksPropertyName = "supportedframeworks";
Expand All @@ -30,7 +30,7 @@ private SearchFilterFormatter()
SearchFilterType? filterType = null;
SearchOrderBy? searchOrderBy = null;
IEnumerable<string>? supportedFrameworks = null;
IEnumerable<string>? packageTypes = null;
string? packageType = null;

int propertyCount = reader.ReadMapHeader();
for (int propertyIndex = 0; propertyIndex < propertyCount; propertyIndex++)
Expand All @@ -43,8 +43,8 @@ private SearchFilterFormatter()
case IncludeDelistedPropertyName:
includeDelisted = reader.ReadBoolean();
break;
case PackageTypesPropertyName:
packageTypes = options.Resolver.GetFormatter<IEnumerable<string>>()!.Deserialize(ref reader, options);
case PackageTypePropertyName:
packageType = reader.ReadString();
break;
case FilterPropertyName:
filterType = options.Resolver.GetFormatter<SearchFilterType?>()!.Deserialize(ref reader, options);
Expand All @@ -65,7 +65,7 @@ private SearchFilterFormatter()
{
SupportedFrameworks = supportedFrameworks ?? [],
OrderBy = searchOrderBy,
PackageTypes = packageTypes ?? [],
PackageType = packageType,
IncludeDelisted = includeDelisted,
};
}
Expand All @@ -77,8 +77,8 @@ protected override void SerializeCore(ref MessagePackWriter writer, SearchFilter
writer.Write(value.IncludePrerelease);
writer.Write(IncludeDelistedPropertyName);
writer.Write(value.IncludeDelisted);
writer.Write(PackageTypesPropertyName);
options.Resolver.GetFormatter<IEnumerable<string>>()!.Serialize(ref writer, value.PackageTypes, options);
writer.Write(PackageTypePropertyName);
writer.Write(value.PackageType);
writer.Write(FilterPropertyName);
options.Resolver.GetFormatter<SearchFilterType?>()!.Serialize(ref writer, value.Filter, options);
writer.Write(OrderByPropertyName);
Expand Down
2 changes: 2 additions & 0 deletions src/NuGet.Core/NuGet.Protocol/LegacyFeed/PackageSearchResourceV2Feed.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,5 +59,7 @@ public override async Task<IEnumerable<IPackageSearchMetadata>> SearchAsync(

return results.ToList();
}

public override bool SupportsPackageTypeFiltering => false;
}
}
2 changes: 2 additions & 0 deletions src/NuGet.Core/NuGet.Protocol/LocalRepositories/LocalPackageSearchResource.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ public LocalPackageSearchResource(FindLocalPackagesResource localResource)
_localResource = localResource;
}

public override bool SupportsPackageTypeFiltering => false;
Comment thread
zivkan marked this conversation as resolved.

public async override Task<IEnumerable<IPackageSearchMetadata>> SearchAsync(
string searchTerm,
SearchFilter filters,
Expand Down
2 changes: 1 addition & 1 deletion src/NuGet.Core/NuGet.Protocol/PublicAPI/net472/PublicAPI.Shipped.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1779,7 +1779,7 @@ override NuGet.Protocol.NuGetVersionConverter.WriteJson(Newtonsoft.Json.JsonWrit
~override NuGet.Protocol.PackageMetadataResourceV3Provider.TryCreate(NuGet.Protocol.Core.Types.SourceRepository source, System.Threading.CancellationToken token) -> System.Threading.Tasks.Task<System.Tuple<bool, NuGet.Protocol.Core.Types.INuGetResource>>
~override NuGet.Protocol.PackageSearchResourceV2Feed.SearchAsync(string searchTerm, NuGet.Protocol.Core.Types.SearchFilter filters, int skip, int take, NuGet.Common.ILogger log, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<NuGet.Protocol.Core.Types.IPackageSearchMetadata>>
~override NuGet.Protocol.PackageSearchResourceV2FeedProvider.TryCreate(NuGet.Protocol.Core.Types.SourceRepository source, System.Threading.CancellationToken token) -> System.Threading.Tasks.Task<System.Tuple<bool, NuGet.Protocol.Core.Types.INuGetResource>>
~override NuGet.Protocol.PackageSearchResourceV3.SearchAsync(string searchTerm, NuGet.Protocol.Core.Types.SearchFilter filter, int skip, int take, NuGet.Common.ILogger log, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<NuGet.Protocol.Core.Types.IPackageSearchMetadata>>
override NuGet.Protocol.PackageSearchResourceV3.SearchAsync(string! searchTerm, NuGet.Protocol.Core.Types.SearchFilter! filter, int skip, int take, NuGet.Common.ILogger! log, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<NuGet.Protocol.Core.Types.IPackageSearchMetadata!>!>!
~override NuGet.Protocol.PackageSearchResourceV3Provider.TryCreate(NuGet.Protocol.Core.Types.SourceRepository source, System.Threading.CancellationToken token) -> System.Threading.Tasks.Task<System.Tuple<bool, NuGet.Protocol.Core.Types.INuGetResource>>
~override NuGet.Protocol.PackageUpdateResourceV2Provider.TryCreate(NuGet.Protocol.Core.Types.SourceRepository source, System.Threading.CancellationToken token) -> System.Threading.Tasks.Task<System.Tuple<bool, NuGet.Protocol.Core.Types.INuGetResource>>
~override NuGet.Protocol.PackageUpdateResourceV3Provider.TryCreate(NuGet.Protocol.Core.Types.SourceRepository source, System.Threading.CancellationToken token) -> System.Threading.Tasks.Task<System.Tuple<bool, NuGet.Protocol.Core.Types.INuGetResource>>
Expand Down
8 changes: 8 additions & 0 deletions src/NuGet.Core/NuGet.Protocol/PublicAPI/net472/PublicAPI.Unshipped.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,11 @@ NuGet.Protocol.Plugins.GetOperationClaimsRequest.ServiceIndexJson.get -> string?
NuGet.Protocol.Plugins.GetServiceIndexResponse.GetServiceIndexResponse(NuGet.Protocol.Plugins.MessageResponseCode responseCode, string? serviceIndexJson) -> void
NuGet.Protocol.Plugins.GetServiceIndexResponse.ServiceIndexJson.get -> string?
static NuGet.Protocol.Plugins.MessageUtilities.SerializePayload(NuGet.Protocol.Plugins.Message! message) -> string?
*REMOVED*NuGet.Protocol.Core.Types.SearchFilter.PackageTypes.get -> System.Collections.Generic.IEnumerable<string!>!
*REMOVED*NuGet.Protocol.Core.Types.SearchFilter.PackageTypes.set -> void
NuGet.Protocol.Core.Types.SearchFilter.PackageType.get -> string?
NuGet.Protocol.Core.Types.SearchFilter.PackageType.set -> void
abstract NuGet.Protocol.Core.Types.PackageSearchResource.SupportsPackageTypeFiltering.get -> bool
override NuGet.Protocol.PackageSearchResourceV3.SupportsPackageTypeFiltering.get -> bool
override NuGet.Protocol.PackageSearchResourceV2Feed.SupportsPackageTypeFiltering.get -> bool
override NuGet.Protocol.LocalPackageSearchResource.SupportsPackageTypeFiltering.get -> bool
2 changes: 1 addition & 1 deletion src/NuGet.Core/NuGet.Protocol/PublicAPI/net8.0/PublicAPI.Shipped.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1770,7 +1770,7 @@ override NuGet.Protocol.NuGetVersionConverter.WriteJson(Newtonsoft.Json.JsonWrit
~override NuGet.Protocol.PackageMetadataResourceV3Provider.TryCreate(NuGet.Protocol.Core.Types.SourceRepository source, System.Threading.CancellationToken token) -> System.Threading.Tasks.Task<System.Tuple<bool, NuGet.Protocol.Core.Types.INuGetResource>>
~override NuGet.Protocol.PackageSearchResourceV2Feed.SearchAsync(string searchTerm, NuGet.Protocol.Core.Types.SearchFilter filters, int skip, int take, NuGet.Common.ILogger log, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<NuGet.Protocol.Core.Types.IPackageSearchMetadata>>
~override NuGet.Protocol.PackageSearchResourceV2FeedProvider.TryCreate(NuGet.Protocol.Core.Types.SourceRepository source, System.Threading.CancellationToken token) -> System.Threading.Tasks.Task<System.Tuple<bool, NuGet.Protocol.Core.Types.INuGetResource>>
~override NuGet.Protocol.PackageSearchResourceV3.SearchAsync(string searchTerm, NuGet.Protocol.Core.Types.SearchFilter filter, int skip, int take, NuGet.Common.ILogger log, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<NuGet.Protocol.Core.Types.IPackageSearchMetadata>>
override NuGet.Protocol.PackageSearchResourceV3.SearchAsync(string! searchTerm, NuGet.Protocol.Core.Types.SearchFilter! filter, int skip, int take, NuGet.Common.ILogger! log, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<NuGet.Protocol.Core.Types.IPackageSearchMetadata!>!>!
~override NuGet.Protocol.PackageSearchResourceV3Provider.TryCreate(NuGet.Protocol.Core.Types.SourceRepository source, System.Threading.CancellationToken token) -> System.Threading.Tasks.Task<System.Tuple<bool, NuGet.Protocol.Core.Types.INuGetResource>>
~override NuGet.Protocol.PackageUpdateResourceV2Provider.TryCreate(NuGet.Protocol.Core.Types.SourceRepository source, System.Threading.CancellationToken token) -> System.Threading.Tasks.Task<System.Tuple<bool, NuGet.Protocol.Core.Types.INuGetResource>>
~override NuGet.Protocol.PackageUpdateResourceV3Provider.TryCreate(NuGet.Protocol.Core.Types.SourceRepository source, System.Threading.CancellationToken token) -> System.Threading.Tasks.Task<System.Tuple<bool, NuGet.Protocol.Core.Types.INuGetResource>>
Expand Down
8 changes: 8 additions & 0 deletions src/NuGet.Core/NuGet.Protocol/PublicAPI/net8.0/PublicAPI.Unshipped.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,11 @@ NuGet.Protocol.Plugins.GetOperationClaimsRequest.ServiceIndexJson.get -> string?
NuGet.Protocol.Plugins.GetServiceIndexResponse.GetServiceIndexResponse(NuGet.Protocol.Plugins.MessageResponseCode responseCode, string? serviceIndexJson) -> void
NuGet.Protocol.Plugins.GetServiceIndexResponse.ServiceIndexJson.get -> string?
static NuGet.Protocol.Plugins.MessageUtilities.SerializePayload(NuGet.Protocol.Plugins.Message! message) -> string?
*REMOVED*NuGet.Protocol.Core.Types.SearchFilter.PackageTypes.get -> System.Collections.Generic.IEnumerable<string!>!
*REMOVED*NuGet.Protocol.Core.Types.SearchFilter.PackageTypes.set -> void
NuGet.Protocol.Core.Types.SearchFilter.PackageType.get -> string?
NuGet.Protocol.Core.Types.SearchFilter.PackageType.set -> void
abstract NuGet.Protocol.Core.Types.PackageSearchResource.SupportsPackageTypeFiltering.get -> bool
override NuGet.Protocol.PackageSearchResourceV3.SupportsPackageTypeFiltering.get -> bool
override NuGet.Protocol.PackageSearchResourceV2Feed.SupportsPackageTypeFiltering.get -> bool
override NuGet.Protocol.LocalPackageSearchResource.SupportsPackageTypeFiltering.get -> bool
5 changes: 5 additions & 0 deletions src/NuGet.Core/NuGet.Protocol/Resources/PackageSearchResource.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,10 @@ public abstract Task<IEnumerable<IPackageSearchMetadata>> SearchAsync(
int take,
Common.ILogger log,
CancellationToken cancellationToken);

/// <summary>
/// Indicates whether filtering on <see cref="SearchFilter.PackageType"/> is supported by the current package source.
/// </summary>
public abstract bool SupportsPackageTypeFiltering { get; }
}
}
Loading