Dependency filtering using DependencyInfoResource.

Author: maraf

src/PackageManager.NuGet/Services/INuGetPackageFilter.cs

@@ -3,12 +3,13 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
+using System.Threading;
 using System.Threading.Tasks;
 
 namespace PackageManager.Services
 {
     public interface INuGetPackageFilter
     {
-        NuGetPackageFilterResult IsPassed(IPackageSearchMetadata package);
+        Task<NuGetPackageFilterResult> IsPassedAsync(SourceRepository repository, IPackageSearchMetadata package, CancellationToken cancellationToken);
     }
 }

src/PackageManager.NuGet/Services/NuGetInstallService.cs

@@ -182,7 +182,7 @@ await ReadPackageConfig(
                             {
                                 log.Debug($"Package '{package.PackageIdentity}' was found.");
 
-                                NuGetPackageFilterResult filterResult = packageFilter.IsPassed(metadata);
+                                NuGetPackageFilterResult filterResult = await packageFilter.IsPassedAsync(repository, metadata, cancellationToken);
                                 result.Add(new NuGetInstalledPackage(
                                     new NuGetPackage(metadata, repository, contentService, versionService),
                                     filterResult == NuGetPackageFilterResult.Ok

src/PackageManager.NuGet/Services/NuGetPackageVersionService.cs

@@ -45,7 +45,7 @@ public async Task<IReadOnlyList<IPackage>> GetListAsync(int resultCount, IPackag
             try
             {
                 List<IPackage> result = new List<IPackage>();
-                if (await SearchOlderVersionsDirectly(result, resultCount, package, repository, versionFilter))
+                if (await SearchOlderVersionsDirectly(result, resultCount, package, repository, versionFilter, cancellationToken))
                     return result;
 
                 if (await SearchOlderVersionsUsingMetadataResource(result, resultCount, package, repository, versionFilter, isPrereleaseIncluded, cancellationToken))
@@ -60,7 +60,7 @@ public async Task<IReadOnlyList<IPackage>> GetListAsync(int resultCount, IPackag
             }
         }
 
-        private async Task<bool> SearchOlderVersionsDirectly(List<IPackage> result, int resultCount, IPackageSearchMetadata package, SourceRepository repository, Func<IPackageSearchMetadata, IPackageSearchMetadata, bool> versionFilter)
+        private async Task<bool> SearchOlderVersionsDirectly(List<IPackage> result, int resultCount, IPackageSearchMetadata package, SourceRepository repository, Func<IPackageSearchMetadata, IPackageSearchMetadata, bool> versionFilter, CancellationToken cancellationToken)
         {
             bool isSuccess = false;
             IEnumerable<VersionInfo> versions = null;
@@ -81,7 +81,7 @@ private async Task<bool> SearchOlderVersionsDirectly(List<IPackage> result, int
                 // TODO: Filter prelease on V2 feed.
                 if (version.PackageSearchMetadata != null && versionFilter(package, version.PackageSearchMetadata))
                 {
-                    IPackage item = ProcessOlderVersion(repository, version.PackageSearchMetadata);
+                    IPackage item = await ProcessOlderVersionAsync(repository, version.PackageSearchMetadata, cancellationToken);
                     if (item != null)
                     {
                         result.Add(item);
@@ -118,7 +118,7 @@ private async Task<bool> SearchOlderVersionsUsingMetadataResource(List<IPackage>
                 {
                     if (versionFilter(package, version))
                     {
-                        IPackage item = ProcessOlderVersion(repository, version);
+                        IPackage item = await ProcessOlderVersionAsync(repository, version, cancellationToken);
                         if (item != null)
                         {
                             result.Add(item);
@@ -132,11 +132,11 @@ private async Task<bool> SearchOlderVersionsUsingMetadataResource(List<IPackage>
             return true;
         }
 
-        private IPackage ProcessOlderVersion(SourceRepository repository, IPackageSearchMetadata version)
+        private async Task<IPackage> ProcessOlderVersionAsync(SourceRepository repository, IPackageSearchMetadata version, CancellationToken cancellationToken)
         {
             log.Debug($"Found '{version.Identity}'.");
 
-            NuGetPackageFilterResult filterResult = filter.IsPassed(version);
+            NuGetPackageFilterResult filterResult = await filter.IsPassedAsync(repository, version, cancellationToken);
             switch (filterResult)
             {
                 case NuGetPackageFilterResult.Ok:

src/PackageManager.NuGet/Services/NuGetSearchService.cs

@@ -102,7 +102,7 @@ public async Task<IEnumerable<IPackage>> SearchAsync(IEnumerable<IPackageSource>
                         if (result.Count >= options.PageSize)
                             break;
 
-                        await AddPackage(result, repository, package, options.IsPrereleaseIncluded, cancellationToken);
+                        await AddPackageAsync(result, repository, package, options.IsPrereleaseIncluded, cancellationToken);
                         sourceSearchPackageCount++;
                     }
 
@@ -128,9 +128,9 @@ public async Task<IEnumerable<IPackage>> SearchAsync(IEnumerable<IPackageSource>
             return result;
         }
 
-        private async Task AddPackage(List<IPackage> result, SourceRepository repository, IPackageSearchMetadata package, bool isPrereleaseIncluded, CancellationToken cancellationToken)
+        private async Task AddPackageAsync(List<IPackage> result, SourceRepository repository, IPackageSearchMetadata package, bool isPrereleaseIncluded, CancellationToken cancellationToken)
         {
-            NuGetPackageFilterResult filterResult = filter.IsPassed(package);
+            NuGetPackageFilterResult filterResult = await filter.IsPassedAsync(repository, package, cancellationToken);
             switch (filterResult)
             {
                 case NuGetPackageFilterResult.Ok:

src/PackageManager.NuGet/Services/OkNuGetPackageFilter.cs

@@ -2,15 +2,16 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
+using System.Threading;
 using System.Threading.Tasks;
 using NuGet.Protocol.Core.Types;
 
 namespace PackageManager.Services
 {
     public class OkNuGetPackageFilter : INuGetPackageFilter
     {
-        public NuGetPackageFilterResult IsPassed(IPackageSearchMetadata package)
-            => NuGetPackageFilterResult.Ok;
+        public Task<NuGetPackageFilterResult> IsPassedAsync(SourceRepository repository, IPackageSearchMetadata package, CancellationToken cancellationToken)
+            => Task.FromResult(NuGetPackageFilterResult.Ok);
 
         #region Singleton
 

src/PackageManager.UI/App.xaml.cs

@@ -69,7 +69,7 @@ protected override void OnStartup(StartupEventArgs e)
             NuGetSourceRepositoryFactory repositoryFactory = new NuGetSourceRepositoryFactory();
             INuGetPackageFilter packageFilter = null;
             if (Args.Dependencies.Any())
-                packageFilter = new DependencyNuGetPackageFilter(Args.Dependencies, frameworks);
+                packageFilter = new DependencyNuGetPackageFilter(LogFactory.Scope("Filter"), Args.Dependencies, frameworks);
 
             NuGetPackageContent.IFrameworkFilter frameworkFilter = null;
             if (Args.Monikers.Any())

src/PackageManager.UI/Services/DependencyNuGetPackageFilter.cs

@@ -2,54 +2,75 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
+using System.Threading;
 using System.Threading.Tasks;
 using Neptuo;
+using Neptuo.Logging;
+using NuGet.Common;
 using NuGet.Frameworks;
 using NuGet.Packaging.Core;
 using NuGet.Protocol.Core.Types;
 using NuGet.Versioning;
+using PackageManager.Logging;
 
 namespace PackageManager.Services
 {
     public class DependencyNuGetPackageFilter : INuGetPackageFilter
     {
+        private readonly ILog log;
+        private readonly NuGetLogger nuGetLogger;
         private readonly IReadOnlyCollection<Args.Dependency> dependencies;
         private readonly IReadOnlyCollection<NuGetFramework> frameworks;
 
-        public DependencyNuGetPackageFilter(IReadOnlyCollection<Args.Dependency> dependencies, IReadOnlyCollection<NuGetFramework> frameworks)
+        public DependencyNuGetPackageFilter(ILog log, IReadOnlyCollection<Args.Dependency> dependencies, IReadOnlyCollection<NuGetFramework> frameworks)
         {
+            Ensure.NotNull(log, "log");
             Ensure.NotNull(dependencies, "dependencies");
             Ensure.NotNull(frameworks, "frameworks");
+            this.log = log;
             this.dependencies = dependencies;
             this.frameworks = frameworks;
+
+            nuGetLogger = new NuGetLogger(log);
         }
 
-        public NuGetPackageFilterResult IsPassed(IPackageSearchMetadata package)
+        public async Task<NuGetPackageFilterResult> IsPassedAsync(SourceRepository repository, IPackageSearchMetadata package, CancellationToken cancellationToken)
         {
             if (!dependencies.Any())
                 return NuGetPackageFilterResult.Ok;
 
-            foreach (var group in package.DependencySets)
+            DependencyInfoResource resource = await repository.GetResourceAsync<DependencyInfoResource>();
+            if (resource == null)
+                return NuGetPackageFilterResult.NotCompatible;
+
+            NuGetPackageFilterResult result = NuGetPackageFilterResult.Ok;
+            foreach (NuGetFramework framework in frameworks)
             {
-                if (frameworks.Contains(group.TargetFramework))
+                SourcePackageDependencyInfo dependencyInfo = await resource.ResolvePackage(package.Identity, framework, new SourceCacheContext(), nuGetLogger, cancellationToken);
+                if (dependencyInfo != null)
                 {
-                    NuGetPackageFilterResult result = NuGetPackageFilterResult.Ok;
-
                     // Dependency filtering:
                     // - When incompatible dependency version is found there is a chance that previous version has the right one.
                     // - When all dependencies are missing, don't even try previous versions.
                     foreach (var dependency in dependencies)
                     {
-                        PackageDependency packageDependency = group.Packages.FirstOrDefault(p => p.Id == dependency.Id);
+                        PackageDependency packageDependency = dependencyInfo.Dependencies.FirstOrDefault(p => p.Id == dependency.Id);
                         if (packageDependency == null)
+                        {
+                            log.Info($"Package '{package.Identity}' skipped: missing dependency '{dependency.Id}'.");
                             result = NuGetPackageFilterResult.NotCompatible;
+                        }
 
                         if (dependency.Version != null && !packageDependency.VersionRange.Satisfies(new NuGetVersion(dependency.Version)))
+                        {
+                            log.Info($"Package '{package.Identity}' skipped: not compatible version '{dependency.Version}' on dependency '{dependency.Id}'.");
                             return NuGetPackageFilterResult.NotCompatibleVersion;
+                        }
                     }
 
                     return result;
                 }
+
             }
 
             return NuGetPackageFilterResult.NotCompatible;

src/PackageManager/ViewModels/PackageSourceSelectorViewModel.cs

@@ -48,10 +48,13 @@ public string SelectedName
 
                     selectedSources = null;
 
-                    if (value == null)
-                        service.MarkAsPrimary(null);
-                    else
-                        service.MarkAsPrimary(service.All.FirstOrDefault(s => s.Name == value));
+                    if (!isServiceUpdating)
+                    {
+                        if (value == null)
+                            service.MarkAsPrimary(null);
+                        else
+                            service.MarkAsPrimary(service.All.FirstOrDefault(s => s.Name == value));
+                    }
                 }
             }
         }
@@ -68,32 +71,43 @@ public PackageSourceSelectorViewModel(IPackageSourceCollection service)
 
         private void OnServiceChanged()
         {
-            string selectedName = SelectedName;
-            SourceNames.Clear();
-
-            bool isSelectedNameContained = false;
-            void Add(string name)
+            try
             {
-                if (!isSelectedNameContained)
-                    isSelectedNameContained = name == selectedName;
+                isServiceUpdating = true;
 
-                SourceNames.Add(name);
-            }
+                string selectedName = SelectedName;
+                SourceNames.Clear();
 
-            if (service.All.Count > 1)
-                Add(AllFeedName);
+                bool isSelectedNameContained = false;
+                void Add(string name)
+                {
+                    if (!isSelectedNameContained)
+                        isSelectedNameContained = name == selectedName;
+
+                    SourceNames.Add(name);
+                }
 
-            foreach (IPackageSource source in service.All)
-                Add(source.Name);
+                if (service.All.Count > 1)
+                    Add(AllFeedName);
 
-            if (isSelectedNameContained)
-                SelectedName = selectedName;
-            else if(service.Primary != null)
-                SelectedName = SourceNames.FirstOrDefault(s => s == service.Primary.Name);
-            else
-                SelectedName = SourceNames.FirstOrDefault();
+                foreach (IPackageSource source in service.All)
+                    Add(source.Name);
+
+                if (isSelectedNameContained)
+                    SelectedName = selectedName;
+                else if (service.Primary != null)
+                    SelectedName = SourceNames.FirstOrDefault(s => s == service.Primary.Name);
+                else
+                    SelectedName = SourceNames.FirstOrDefault();
+            }
+            finally
+            {
+                isServiceUpdating = false;
+            }
         }
 
+        private bool isServiceUpdating = false;
+
         public void Dispose()
         {
             service.Changed -= OnServiceChanged;

test/PackageManager.NuGet.Tests/Services/InstallService.cs

@@ -28,6 +28,7 @@ public static IInstallService Create(string extractPath)
 
             var frameworkFilter = new NuGetFrameworkFilter(frameworks);
             var packageFilter = new DependencyNuGetPackageFilter(
+                new DefaultLog(),
                 new List<Args.Dependency>()
                 {
                     new Args.Dependency("GitExtensions.Extensibility", null)

test/PackageManager.NuGet.Tests/Services/SearchService.cs

@@ -28,6 +28,7 @@ public static (ISearchService search, IPackageSourceCollection sources) Create(s
 
             var frameworkFilter = new NuGetFrameworkFilter(frameworks);
             var packageFilter = new DependencyNuGetPackageFilter(
+                new DefaultLog(),
                 new List<Args.Dependency>()
                 {
                     new Args.Dependency("GitExtensions.Extensibility", null)
@@ -45,10 +46,10 @@ public static (ISearchService search, IPackageSourceCollection sources) Create(s
                     frameworkFilter
                 ),
                 new DependencyNuGetPackageFilter(
+                    new DefaultLog(),
                     new List<Args.Dependency>() { new Args.Dependency("GitExtensions.Extensibility", null) },
                     frameworks
-                ),
-                new NuGetFrameworkFilter(frameworks)
+                )
             );
 
             EnsureConfigDeleted(configFilePath);