[Rename] Display rename information on package detail page (#7964)

zhhyu · web-flow · commit 08a662d6b609 · 2020-04-29T14:17:38.000-07:00
* Initial commit

* Fix

* Tests

* Fix CI

* Test Coverage

* Handle feedback

* Protection

* Behind feture flag
diff --git a/src/NuGetGallery.Services/Configuration/FeatureFlagService.cs b/src/NuGetGallery.Services/Configuration/FeatureFlagService.cs
@@ -35,6 +35,7 @@ public class FeatureFlagService : IFeatureFlagService
         private const string ShowEnable2FADialog = GalleryPrefix + "ShowEnable2FADialog";
         private const string Get2FADismissFeedback = GalleryPrefix + "Get2FADismissFeedback";
         private const string UsabillaOnEveryPageFeatureName = GalleryPrefix + "UsabillaEveryPage";
+        private const string PackageRenamesFeatureName = GalleryPrefix + "PackageRenames";
 
         private readonly IFeatureFlagClient _client;
 
@@ -173,5 +174,10 @@ public bool IsUsabillaButtonEnabledOnEveryPage()
         {
             return _client.IsEnabled(UsabillaOnEveryPageFeatureName, defaultValue: false);
         }
+
+        public bool IsPackageRenamesEnabled(User user)
+        {
+            return _client.IsEnabled(PackageRenamesFeatureName, user, defaultValue: false);
+        }
     }
 }
diff --git a/src/NuGetGallery.Services/Configuration/IFeatureFlagService.cs b/src/NuGetGallery.Services/Configuration/IFeatureFlagService.cs
@@ -1,8 +1,8 @@
 ﻿// 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 NuGet.Services.Entities;
 using System.Collections.Generic;
+using NuGet.Services.Entities;
 
 namespace NuGetGallery
 {
@@ -79,7 +79,7 @@ public interface IFeatureFlagService
         /// <param name="user">The user to test for the Flight</param>
         /// <returns>Whether or not the Flight is enabled for the user</returns>
         bool IsGitHubUsageEnabled(User user);
-        
+
         /// <summary>
         /// Whether the OData controllers use the read-only replica.
         /// </summary>
@@ -125,5 +125,10 @@ public interface IFeatureFlagService
         /// Whether we should enable the Usabilla feedback button on every page.
         /// </summary>
         bool IsUsabillaButtonEnabledOnEveryPage();
+
+        /// <summary>
+        /// Whether the user is able to see or manage the package renames information.
+        /// </summary>
+        bool IsPackageRenamesEnabled(User user);
     }
 }
diff --git a/src/NuGetGallery/App_Start/DefaultDependenciesModule.cs b/src/NuGetGallery/App_Start/DefaultDependenciesModule.cs
@@ -264,6 +264,11 @@ protected override void Load(ContainerBuilder builder)
                 .As<IEntityRepository<PackageDeprecation>>()
                 .InstancePerLifetimeScope();
 
+            builder.RegisterType<EntityRepository<PackageRename>>()
+                .AsSelf()
+                .As<IEntityRepository<PackageRename>>()
+                .InstancePerLifetimeScope();
+
             ConfigureGalleryReadOnlyReplicaEntitiesContext(builder, loggerFactory, configuration, secretInjector);
 
             var supportDbConnectionFactory = CreateDbConnectionFactory(
@@ -412,6 +417,10 @@ protected override void Load(ContainerBuilder builder)
                 .As<IPackageDeprecationService>()
                 .InstancePerLifetimeScope();
 
+            builder.RegisterType<PackageRenameService>()
+                .As<IPackageRenameService>()
+                .InstancePerLifetimeScope();
+
             builder.RegisterType<PackageUpdateService>()
                 .As<IPackageUpdateService>()
                 .InstancePerLifetimeScope();
diff --git a/src/NuGetGallery/Controllers/PackagesController.cs b/src/NuGetGallery/Controllers/PackagesController.cs
@@ -119,6 +119,7 @@ public partial class PackagesController
         private readonly ILicenseExpressionSplitter _licenseExpressionSplitter;
         private readonly IFeatureFlagService _featureFlagService;
         private readonly IPackageDeprecationService _deprecationService;
+        private readonly IPackageRenameService _renameService;
         private readonly IABTestService _abTestService;
         private readonly IIconUrlProvider _iconUrlProvider;
         private readonly DisplayPackageViewModelFactory _displayPackageViewModelFactory;
@@ -157,6 +158,7 @@ public PackagesController(
             ILicenseExpressionSplitter licenseExpressionSplitter,
             IFeatureFlagService featureFlagService,
             IPackageDeprecationService deprecationService,
+            IPackageRenameService renameService,
             IABTestService abTestService,
             IIconUrlProvider iconUrlProvider)
         {
@@ -189,6 +191,7 @@ public PackagesController(
             _licenseExpressionSplitter = licenseExpressionSplitter ?? throw new ArgumentNullException(nameof(licenseExpressionSplitter));
             _featureFlagService = featureFlagService ?? throw new ArgumentNullException(nameof(featureFlagService));
             _deprecationService = deprecationService ?? throw new ArgumentNullException(nameof(deprecationService));
+            _renameService = renameService ?? throw new ArgumentNullException(nameof(renameService));
             _abTestService = abTestService ?? throw new ArgumentNullException(nameof(abTestService));
             _iconUrlProvider = iconUrlProvider ?? throw new ArgumentNullException(nameof(iconUrlProvider));
 
@@ -823,11 +826,18 @@ public virtual async Task<ActionResult> DisplayPackage(string id, string version
                 .GroupBy(d => d.PackageKey)
                 .ToDictionary(g => g.Key, g => g.First());
 
+            IReadOnlyList<PackageRename> packageRenames = null;
+            if (_featureFlagService.IsPackageRenamesEnabled(currentUser))
+            {
+                packageRenames = _renameService.GetPackageRenames(package.PackageRegistration);
+            }
+
             var model = _displayPackageViewModelFactory.Create(
                 package,
                 allVersions,
                 currentUser,
                 packageKeyToDeprecation,
+                packageRenames,
                 readme);
 
             model.ValidatingTooLong = _validationService.IsValidatingTooLong(package);
@@ -836,8 +846,9 @@ public virtual async Task<ActionResult> DisplayPackage(string id, string version
             model.IsCertificatesUIEnabled = _contentObjectService.CertificatesConfiguration?.IsUIEnabledForUser(currentUser) ?? false;
             model.IsAtomFeedEnabled = _featureFlagService.IsPackagesAtomFeedEnabled();
             model.IsPackageDeprecationEnabled = _featureFlagService.IsManageDeprecationEnabled(currentUser, allVersions);
+            model.IsPackageRenamesEnabled = _featureFlagService.IsPackageRenamesEnabled(currentUser);
 
-            if(model.IsGitHubUsageEnabled = _featureFlagService.IsGitHubUsageEnabled(currentUser))
+            if (model.IsGitHubUsageEnabled = _featureFlagService.IsGitHubUsageEnabled(currentUser))
             {
                 model.GitHubDependenciesInformation = _contentObjectService.GitHubUsageConfiguration.GetPackageInformation(id);
             }
diff --git a/src/NuGetGallery/Helpers/ViewModelExtensions/DeletePackageViewModelFactory.cs b/src/NuGetGallery/Helpers/ViewModelExtensions/DeletePackageViewModelFactory.cs
@@ -39,6 +39,7 @@ public DeletePackageViewModel Setup(
                 allVersions,
                 currentUser,
                 packageKeyToDeprecation: null,
+                packageRenames: null,
                 readmeResult: null);
 
             return SetupInternal(viewModel, package, reasons);
diff --git a/src/NuGetGallery/Helpers/ViewModelExtensions/DisplayPackageViewModelFactory.cs b/src/NuGetGallery/Helpers/ViewModelExtensions/DisplayPackageViewModelFactory.cs
@@ -23,6 +23,7 @@ public DisplayPackageViewModel Create(
             IReadOnlyCollection<Package> allVersions,
             User currentUser,
             IReadOnlyDictionary<int, PackageDeprecation> packageKeyToDeprecation,
+            IReadOnlyList<PackageRename> packageRenames,
             RenderedReadMeResult readmeResult)
         {
             var viewModel = new DisplayPackageViewModel();
@@ -32,6 +33,7 @@ public DisplayPackageViewModel Create(
                 allVersions,
                 currentUser,
                 packageKeyToDeprecation,
+                packageRenames,
                 readmeResult);
         }
 
@@ -41,11 +43,12 @@ public DisplayPackageViewModel Setup(
             IReadOnlyCollection<Package> allVersions,
             User currentUser,
             IReadOnlyDictionary<int, PackageDeprecation> packageKeyToDeprecation,
+            IReadOnlyList<PackageRename> packageRenames,
             RenderedReadMeResult readmeResult)
         {
             _listPackageItemViewModelFactory.Setup(viewModel, package, currentUser);
             SetupCommon(viewModel, package, pushedBy: null, packageKeyToDeprecation: packageKeyToDeprecation);
-            return SetupInternal(viewModel, package, allVersions, currentUser, packageKeyToDeprecation, readmeResult);
+            return SetupInternal(viewModel, package, allVersions, currentUser, packageKeyToDeprecation, packageRenames, readmeResult);
         }
 
         private DisplayPackageViewModel SetupInternal(
@@ -54,6 +57,7 @@ private DisplayPackageViewModel SetupInternal(
             IReadOnlyCollection<Package> allVersions,
             User currentUser,
             IReadOnlyDictionary<int, PackageDeprecation> packageKeyToDeprecation,
+            IReadOnlyList<PackageRename> packageRenames,
             RenderedReadMeResult readmeResult)
         {
             var dependencies = package.Dependencies.ToList();
@@ -112,6 +116,15 @@ private DisplayPackageViewModel SetupInternal(
                 viewModel.CustomMessage = deprecation.CustomMessage;
             }
 
+            if (packageRenames != null && packageRenames.Count != 0)
+            {
+                viewModel.PackageRenames = packageRenames;
+                if (package.PackageRegistration?.RenamedMessage != null)
+                {
+                    viewModel.RenamedMessage = package.PackageRegistration.RenamedMessage;
+                }
+            }
+
             viewModel.ReadMeHtml = readmeResult?.Content;
             viewModel.ReadMeImagesRewritten = readmeResult != null ? readmeResult.ImagesRewritten : false;
             viewModel.HasEmbeddedIcon = package.HasEmbeddedIcon;
diff --git a/src/NuGetGallery/NuGetGallery.csproj b/src/NuGetGallery/NuGetGallery.csproj
@@ -487,6 +487,7 @@
     <Compile Include="Services\GalleryContentFileMetadataService.cs" />
     <Compile Include="Services\InvalidLicenseUrlValidationMessage.cs" />
     <Compile Include="Services\InvalidUrlEncodingForLicenseUrlValidationMessage.cs" />
+    <Compile Include="Services\IPackageRenameService.cs" />
     <Compile Include="Services\ISearchSideBySideService.cs" />
     <Compile Include="Services\ISymbolPackageUploadService.cs" />
     <Compile Include="Services\ISymbolPackageFileService.cs" />
@@ -498,6 +499,7 @@
     <Compile Include="Services\PackageDeleteService.cs" />
     <Compile Include="Services\PackageDeprecationManagementService.cs" />
     <Compile Include="Services\PackageDeprecationService.cs" />
+    <Compile Include="Services\PackageRenameService.cs" />
     <Compile Include="Services\PackageShouldNotBeSignedUserFixableValidationMessage.cs" />
     <Compile Include="Services\PlainTextOnlyValidationMessage.cs" />
     <Compile Include="Services\RenderedReadMeResult.cs" />
@@ -2284,6 +2286,9 @@
       <Version>9.3.3</Version>
     </PackageReference>
   </ItemGroup>
+  <ItemGroup>
+    <Content Include="Views\Packages\_DisplayPackageRenames.cshtml" />
+  </ItemGroup>
   <PropertyGroup>
     <VisualStudioVersion Condition="'$(VisualStudioVersion)' == ''">10.0</VisualStudioVersion>
     <VSToolsPath Condition="'$(VSToolsPath)' == ''">$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)</VSToolsPath>
diff --git a/src/NuGetGallery/Scripts/gallery/page-display-package.js b/src/NuGetGallery/Scripts/gallery/page-display-package.js
@@ -1,16 +1,16 @@
 $(function () {
     'use strict';
 
+    // Configure the rename information container
+    window.nuget.configureExpander("rename-content-container", "ChevronDown", null, "ChevronUp");
+    configureExpanderWithEnterKeydown($('#show-rename-content-container'));
+
     // Configure the deprecation information container
     var container = $('#show-deprecation-content-container');
     if ($('#deprecation-content-container').children().length) {
         // If the deprecation information container has content, configure it as an expander.
         window.nuget.configureExpander("deprecation-content-container", "ChevronDown", null, "ChevronUp");
-        container.keydown(function (event) {
-            if (event.which === 13) { // Enter
-                $(event.target).click();
-            }
-        });
+        configureExpanderWithEnterKeydown(container)
     }
     else {
         // If the container does not have content, remove its expander attributes
@@ -25,6 +25,15 @@ $(function () {
         $('#deprecation-expander-icon-right').hide();
     }
 
+    // Configure expander with enter keydown event
+    function configureExpanderWithEnterKeydown(container) {
+        container.keydown(function (event) {
+            if (event.which === 13) { // Enter
+                $(event.target).click();
+            }
+        });
+    }
+
     // Configure ReadMe container
     var readmeContainer = $("#readme-container");
     if (readmeContainer[0])
diff --git a/src/NuGetGallery/Services/IPackageRenameService.cs b/src/NuGetGallery/Services/IPackageRenameService.cs
@@ -0,0 +1,13 @@
+﻿// 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 NuGet.Services.Entities;
+
+namespace NuGetGallery
+{
+    public interface IPackageRenameService
+    {
+        IReadOnlyList<PackageRename> GetPackageRenames(PackageRegistration package);
+    }
+}
diff --git a/src/NuGetGallery/Services/PackageRenameService.cs b/src/NuGetGallery/Services/PackageRenameService.cs
@@ -0,0 +1,30 @@
+﻿// 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.Linq;
+using System.Data.Entity;
+using System.Collections.Generic;
+using NuGet.Services.Entities;
+
+namespace NuGetGallery
+{
+    public class PackageRenameService : IPackageRenameService
+    {
+        private readonly IEntityRepository<PackageRename> _packageRenameRepository;
+
+        public PackageRenameService (
+            IEntityRepository<PackageRename> packageRenameRepository)
+        {
+            _packageRenameRepository = packageRenameRepository ?? throw new ArgumentNullException(nameof(packageRenameRepository));
+        }
+
+        public IReadOnlyList<PackageRename> GetPackageRenames(PackageRegistration packageRegistration)
+        {
+            return _packageRenameRepository.GetAll()
+                .Where(pr => pr.FromPackageRegistrationKey == packageRegistration.Key)
+                .Include(pr => pr.ToPackageRegistration)
+                .ToList();
+        }
+    }
+}
diff --git a/src/NuGetGallery/ViewModels/DisplayPackageViewModel.cs b/src/NuGetGallery/ViewModels/DisplayPackageViewModel.cs
@@ -33,6 +33,7 @@ public class DisplayPackageViewModel : ListPackageItemViewModel
         public bool IsDotnetNewTemplatePackageType { get; set; }
         public bool IsAtomFeedEnabled { get; set; }
         public bool IsPackageDeprecationEnabled { get; set; }
+        public bool IsPackageRenamesEnabled { get; set; }
         public bool IsGitHubUsageEnabled { get; set; }
         public NuGetPackageGitHubInformation GitHubDependenciesInformation { get; set; }
         public bool HasEmbeddedIcon { get; set; }
@@ -82,6 +83,9 @@ public bool HasNewerRelease
         public string AlternatePackageVersion { get; set; }
         public string CustomMessage { get; set; }
 
+        public IReadOnlyCollection<PackageRename> PackageRenames { get; set; }
+        public string RenamedMessage { get; set; }
+
         public void InitializeRepositoryMetadata(string repositoryUrl, string repositoryType)
         {
             RepositoryType = RepositoryKind.Unknown;
diff --git a/src/NuGetGallery/Views/Packages/DisplayPackage.cshtml b/src/NuGetGallery/Views/Packages/DisplayPackage.cshtml
@@ -288,6 +288,11 @@
                 @Html.Partial("_DisplayPackageDeprecation")
             }
 
+            @if (Model.IsPackageRenamesEnabled && Model.PackageRenames != null && Model.PackageRenames.Count != 0)
+            {
+                @Html.Partial("_DisplayPackageRenames")
+            }
+
             @if (Model.Prerelease)
             {
                 @ViewHelpers.AlertInfo(
diff --git a/src/NuGetGallery/Views/Packages/_DisplayPackageRenames.cshtml b/src/NuGetGallery/Views/Packages/_DisplayPackageRenames.cshtml
@@ -0,0 +1,51 @@
+﻿@model DisplayPackageViewModel
+
+<div class="deprecation-container">
+    <div class="icon-text alert alert-info">
+        <div id="show-rename-content-container" class="deprecation-expander" tabindex="0" data-toggle="collapse" data-target="#rename-content-container" aria-expanded="false" aria-controls="rename-content-container" aria-labelledby="rename-container-label" role="button">
+            <div class="deprecation-expander" role="button">
+                <div class="deprecation-expander-container">
+                    <i class="deprecation-expander-icon ms-Icon ms-Icon--Info" aria-hidden="true"></i>
+
+                    <div id="rename-container-label" class="deprecation-expander-info-right">
+                        @{
+                            if (Model.PackageRenames.Count == 1)
+                            {
+                                @:This package has been renamed.
+                            }
+                            else
+                            {
+                                @:This package has been renamed or split into new packages.
+                            }
+                        }
+                    </div>
+                </div>
+
+                <div class="deprecation-expander-container">
+                    <i class="deprecation-expander-icon deprecation-expander-info-right ms-Icon ms-Icon--ChevronDown" aria-hidden="true"></i>
+                </div>
+            </div>
+        </div>
+
+        <div class="deprecation-content-container collapse" id="rename-content-container">
+            <ul class="list-unstyled">
+                @if (Model.PackageRenames != null && Model.PackageRenames.Count != 0)
+                {
+                    foreach (var packageRename in Model.PackageRenames)
+                    {
+                        var renamePackageName = packageRename.ToPackageRegistration.Id;
+                        var renamePackageUrl = Url.Package(renamePackageName);
+                        <li><a href="@renamePackageUrl">@renamePackageName</a></li>
+                    }
+                }
+            </ul>
+            <p></p>
+
+            @if (!string.IsNullOrEmpty(Model.RenamedMessage))
+            {
+                <b>Additional Details</b>
+                <p>@Html.PreFormattedText(Model.RenamedMessage, Config)</p>
+            }
+        </div>
+    </div>
+</div>
diff --git a/tests/NuGetGallery.Facts/Controllers/PackagesControllerFacts.cs b/tests/NuGetGallery.Facts/Controllers/PackagesControllerFacts.cs
diff --git a/tests/NuGetGallery.Facts/Framework/TestContainer.cs b/tests/NuGetGallery.Facts/Framework/TestContainer.cs
diff --git a/tests/NuGetGallery.Facts/NuGetGallery.Facts.csproj b/tests/NuGetGallery.Facts/NuGetGallery.Facts.csproj
diff --git a/tests/NuGetGallery.Facts/Services/PackageRenameServiceFacts.cs b/tests/NuGetGallery.Facts/Services/PackageRenameServiceFacts.cs
diff --git a/tests/NuGetGallery.Facts/ViewModels/DisplayPackageViewModelFacts.cs b/tests/NuGetGallery.Facts/ViewModels/DisplayPackageViewModelFacts.cs

Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,7 @@ public class FeatureFlagService : IFeatureFlagService`
`35`	`35`	`private const string ShowEnable2FADialog = GalleryPrefix + "ShowEnable2FADialog";`
`36`	`36`	`private const string Get2FADismissFeedback = GalleryPrefix + "Get2FADismissFeedback";`
`37`	`37`	`private const string UsabillaOnEveryPageFeatureName = GalleryPrefix + "UsabillaEveryPage";`
	`38`	`+ private const string PackageRenamesFeatureName = GalleryPrefix + "PackageRenames";`
`38`	`39`
`39`	`40`	`private readonly IFeatureFlagClient _client;`
`40`	`41`
`@@ -173,5 +174,10 @@ public bool IsUsabillaButtonEnabledOnEveryPage()`
`173`	`174`	`{`
`174`	`175`	`return _client.IsEnabled(UsabillaOnEveryPageFeatureName, defaultValue: false);`
`175`	`176`	`}`
	`177`	`+`
	`178`	`+ public bool IsPackageRenamesEnabled(User user)`
	`179`	`+ {`
	`180`	`+ return _client.IsEnabled(PackageRenamesFeatureName, user, defaultValue: false);`
	`181`	`+ }`
`176`	`182`	`}`
`177`	`183`	`}`