Merge pull request #7257 from NuGet/mogah-prototype

[GiHub Usage] Add Gallery UI

Author: mogah

src/Bootstrap/dist/css/bootstrap-theme.css

@@ -117,6 +117,24 @@
     }
   }
 
+  .btn-gh-repo {
+    display: inline-block;
+    width: 100%;
+    background-color: white;
+  }
+
+  .btn-gh-repo:hover {
+    background-color: @state-info-bg;
+  }
+
+  .badge-gh-repo {
+    background-color: @navbar-inverse-bg;
+  }
+
+  .star-gh-repo {
+    color: #ffac0e;
+  }
+  
   .install-tabs {
     font-size: 0.8em;
 

src/Bootstrap/less/theme/page-display-package.less

@@ -0,0 +1,63 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace NuGetGallery
+{
+    public class GitHubUsageConfiguration : IGitHubUsageConfiguration
+    {
+        private readonly IReadOnlyDictionary<string, NuGetPackageGitHubInformation> _nuGetPackagesGitHubDependencies;
+
+        public GitHubUsageConfiguration(IReadOnlyCollection<RepositoryInformation> repositories)
+        {
+            if (repositories == null)
+            {
+                throw new ArgumentNullException(nameof(repositories));
+            }
+
+            _nuGetPackagesGitHubDependencies = GetNuGetPackagesDependents(repositories);
+        }
+
+        public NuGetPackageGitHubInformation GetPackageInformation(string packageId)
+        {
+            if (packageId == null)
+            {
+                throw new ArgumentNullException(nameof(packageId));
+            }
+
+            if (_nuGetPackagesGitHubDependencies.TryGetValue(packageId, out var value))
+            {
+                return value;
+            }
+
+            return NuGetPackageGitHubInformation.Empty;
+        }
+
+        private static IReadOnlyDictionary<string, NuGetPackageGitHubInformation> GetNuGetPackagesDependents(IReadOnlyCollection<RepositoryInformation> repositories)
+        {
+            var dependentsPerPackage = new Dictionary<string, List<RepositoryInformation>>(StringComparer.OrdinalIgnoreCase);
+            foreach (var repo in repositories)
+            {
+                foreach (var dependency in repo.Dependencies)
+                {
+                    if (!dependentsPerPackage.TryGetValue(dependency, out var packageDependents))
+                    {
+                        packageDependents = new List<RepositoryInformation>();
+                        dependentsPerPackage[dependency] = packageDependents;
+                    }
+
+                    packageDependents.Add(repo);
+                }
+            }
+
+            return dependentsPerPackage
+                .ToDictionary(
+                    entry => entry.Key,
+                    entry => new NuGetPackageGitHubInformation(entry.Value),
+                    StringComparer.OrdinalIgnoreCase);
+        }
+    }
+}

src/NuGetGallery.Core/GitHub/GitHubUsageConfiguration.cs

@@ -0,0 +1,20 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+namespace NuGetGallery
+{
+    public interface IGitHubUsageConfiguration
+    {
+        /// <summary>
+        /// Returns the GitHub dependants information about a NuGet package.
+        /// 
+        /// If a packageId has no information, the NuGetPackageGitHubInformation's TotalRepos will be 0
+        /// and the Repos list will be empty
+        /// 
+        /// </summary>
+        /// <exception cref="System.ArgumentNullException">Thrown when packageId is null</exception>
+        /// <param name="packageId">NuGet package id, cannot be null</param>
+        /// <returns>NuGetPackageGitHubInformation that contains the information about a NuGet package.</returns>
+        NuGetPackageGitHubInformation GetPackageInformation(string packageId);
+    }
+}

src/NuGetGallery.Core/GitHub/IGitHubUsageConfiguration.cs

@@ -0,0 +1,34 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace NuGetGallery
+{
+    public class NuGetPackageGitHubInformation
+    {
+        public const int ReposPerPackage = 10;
+
+        public readonly static NuGetPackageGitHubInformation Empty = new NuGetPackageGitHubInformation(new List<RepositoryInformation>());
+
+        public NuGetPackageGitHubInformation(IReadOnlyCollection<RepositoryInformation> repos)
+        {
+            if( repos == null)
+            {
+                throw new ArgumentNullException(nameof(repos));
+            }
+
+            TotalRepos = repos.Count;
+            Repos = repos
+                .OrderByDescending(x => x.Stars)
+                .ThenBy(x => x.Id, StringComparer.OrdinalIgnoreCase)
+                .Take(ReposPerPackage)
+                .ToList();
+        }
+
+        public int TotalRepos { get; }
+        public IReadOnlyCollection<RepositoryInformation> Repos { get; }
+    }
+}

src/NuGetGallery.Core/GitHub/NuGetPackageGitHubInformation.cs

@@ -0,0 +1,49 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using Newtonsoft.Json;
+using System;
+using System.Collections.Generic;
+
+namespace NuGetGallery
+{
+    public class RepositoryInformation
+    {
+        public RepositoryInformation(
+            string id,
+            string url,
+            int stars,
+            IReadOnlyList<string> dependencies)
+        {
+            if (stars < 0)
+            {
+                throw new IndexOutOfRangeException(string.Format("{0} cannot have a negative value!", nameof(stars)));
+            }
+
+            Id = id ?? throw new ArgumentNullException(nameof(id));
+            var idSplit = Id.Split('/');
+            if (idSplit.Length == 2)
+            {
+                Owner = idSplit[0];
+                Name = idSplit[1];
+            }
+            else
+            {
+                throw new ArgumentException(string.Format("{0} has an invalid format! It should be \"owner/repositoryName\"!", nameof(Id)));
+            }
+
+            Url = url ?? throw new ArgumentNullException(nameof(url));
+            Stars = stars;
+            Dependencies = dependencies ?? throw new ArgumentNullException(nameof(dependencies));
+        }
+
+        [JsonIgnore]
+        public string Name { get; }
+        [JsonIgnore]
+        public string Owner { get; }
+        public string Url { get; }
+        public int Stars { get; }
+        public string Id { get; }
+        public IReadOnlyList<string> Dependencies { get; }
+    }
+}

src/NuGetGallery.Core/GitHub/RepositoryInformation.cs

@@ -147,6 +147,10 @@
     <Compile Include="Features\FeatureFlagReference.cs" />
     <Compile Include="Features\FeatureFlagSaveResult.cs" />
     <Compile Include="Features\IEditableFeatureFlagStorageService.cs" />
+    <Compile Include="GitHub\GitHubUsageConfiguration.cs" />
+    <Compile Include="GitHub\IGitHubUsageConfiguration.cs" />
+    <Compile Include="GitHub\NuGetPackageGitHubInformation.cs" />
+    <Compile Include="GitHub\RepositoryInformation.cs" />
     <Compile Include="ICloudStorageStatusDependency.cs" />
     <Compile Include="Infrastructure\AzureEntityList.cs" />
     <Compile Include="Infrastructure\ElmahException.cs" />

src/NuGetGallery.Core/NuGetGallery.Core.csproj

@@ -39,6 +39,7 @@ public static class ContentNames
             public static readonly string CertificatesConfiguration = "Certificates-Configuration";
             public static readonly string SymbolsConfiguration = "Symbols-Configuration";
             public static readonly string TyposquattingConfiguration = "Typosquatting-Configuration";
+            public static readonly string NuGetPackagesGitHubDependencies = "GitHubUsage.v1";
         }
     }
 }

src/NuGetGallery.Services/ServicesConstants.cs

@@ -2,6 +2,7 @@
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System;
+using System.Collections.Generic;
 using System.Threading.Tasks;
 using Newtonsoft.Json;
 using NuGetGallery.Services;
@@ -28,6 +29,7 @@ public ContentObjectService(IContentService contentService)
         public ICertificatesConfiguration CertificatesConfiguration { get; set; }
         public ISymbolsConfiguration SymbolsConfiguration { get; set; }
         public ITyposquattingConfiguration TyposquattingConfiguration { get; set; }
+        public IGitHubUsageConfiguration GitHubUsageConfiguration { get; set; }
 
         public async Task Refresh()
         {
@@ -46,9 +48,15 @@ await Refresh<SymbolsConfiguration>(ServicesConstants.ContentNames.SymbolsConfig
             TyposquattingConfiguration =
                await Refresh<TyposquattingConfiguration>(ServicesConstants.ContentNames.TyposquattingConfiguration) ??
                new TyposquattingConfiguration();
+
+            var reposCache = 
+                await Refresh<IReadOnlyCollection<RepositoryInformation>>(ServicesConstants.ContentNames.NuGetPackagesGitHubDependencies) ??
+                Array.Empty<RepositoryInformation>();
+
+            GitHubUsageConfiguration = new GitHubUsageConfiguration(reposCache);
         }
 
-        private async Task<T> Refresh<T>(string contentName) 
+        private async Task<T> Refresh<T>(string contentName)
             where T : class
         {
             var configString = (await _contentService.GetContentItemAsync(contentName, RefreshInterval))?.ToString();

src/NuGetGallery.Services/Storage/ContentObjectService.cs

@@ -1,6 +1,7 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
+using System.Collections.Generic;
 using System.Threading.Tasks;
 using NuGetGallery.Services;
 
@@ -12,6 +13,8 @@ public interface IContentObjectService
         ICertificatesConfiguration CertificatesConfiguration { get; }
         ISymbolsConfiguration SymbolsConfiguration { get; }
         ITyposquattingConfiguration TyposquattingConfiguration { get; }
+        IGitHubUsageConfiguration GitHubUsageConfiguration { get; }
+
         Task Refresh();
     }
 }