From 3759c27dd8ed605c76be4534ef84997822e96cea Mon Sep 17 00:00:00 2001
From: Joel Verhagen <jver@microsoft.com>
Date: Wed, 11 Aug 2021 10:38:15 -0700
Subject: [PATCH] Add bulk revalidate buttons to Validation admin panel (#8738)

* Fix bug causing only first package to revalidate to work
* Redirect back to admin panel when revalidating there
* Add revalidate pending packages and symbols to admin panel
* Add unit tests for new service method

Fix https://github.com/NuGet/NuGetGallery/issues/8702
---
 src/Bootstrap/dist/css/bootstrap-theme.css    |  3 +
 src/Bootstrap/less/theme/base.less            |  4 ++
 src/NuGetGallery/App_Code/ViewHelpers.cshtml  |  5 +-
 .../Admin/Controllers/ValidationController.cs | 21 +++++++
 .../Admin/Services/ValidationAdminService.cs  | 45 +++++++++++++-
 .../Areas/Admin/Views/Validation/Index.cshtml | 55 +++++++++++++++--
 .../Controllers/PackagesController.cs         | 22 +++++--
 .../Services/ValidationAdminServiceFacts.cs   | 59 ++++++++++++++++++-
 .../Controllers/PackagesControllerFacts.cs    | 30 ++++++++++
 9 files changed, 232 insertions(+), 12 deletions(-)

diff --git a/src/Bootstrap/dist/css/bootstrap-theme.css b/src/Bootstrap/dist/css/bootstrap-theme.css
index 53a4b48941..3c9f02528e 100644
--- a/src/Bootstrap/dist/css/bootstrap-theme.css
+++ b/src/Bootstrap/dist/css/bootstrap-theme.css
@@ -45,6 +45,9 @@ body h3 {
   text-overflow: ellipsis;
   white-space: nowrap;
 }
+.form-inline-empty {
+  display: inline-block;
+}
 .footer {
   background-color: #002440;
   color: #e3ebf1;
diff --git a/src/Bootstrap/less/theme/base.less b/src/Bootstrap/less/theme/base.less
index 5b8069c50f..e84d42c10f 100644
--- a/src/Bootstrap/less/theme/base.less
+++ b/src/Bootstrap/less/theme/base.less
@@ -55,6 +55,10 @@ body {
   }
 }
 
+.form-inline-empty {
+  display: inline-block;
+}
+
 .footer {
   background-color: @panel-footer-bg;
   color: @panel-footer-color;
diff --git a/src/NuGetGallery/App_Code/ViewHelpers.cshtml b/src/NuGetGallery/App_Code/ViewHelpers.cshtml
index 394c3bd0b7..ddf9915169 100644
--- a/src/NuGetGallery/App_Code/ViewHelpers.cshtml
+++ b/src/NuGetGallery/App_Code/ViewHelpers.cshtml
@@ -653,6 +653,7 @@ var hlp = new AccordionHelper(name, formModelStatePrefix, expanded, page);
     string controllerName,
     string role,
     string area = "",
+    string classes = null,
     Dictionary<string, string> formValues = null)
 {
     using (page.Html.BeginForm(
@@ -660,7 +661,7 @@ var hlp = new AccordionHelper(name, formModelStatePrefix, expanded, page);
         controllerName,
         new { area = area },
         FormMethod.Post,
-        new { id = formId }))
+        new { id = formId, @class = classes }))
     {
         @page.Html.AntiForgeryToken();
         if (formValues != null)
@@ -682,6 +683,7 @@ var hlp = new AccordionHelper(name, formModelStatePrefix, expanded, page);
     string controllerName,
     string role,
     string area = "",
+    string classes = null,
     Dictionary<string, string> formValues = null)
 {
     @PostLink(
@@ -692,6 +694,7 @@ var hlp = new AccordionHelper(name, formModelStatePrefix, expanded, page);
         controllerName,
         role,
         area,
+        classes,
         formValues);
 }
 
diff --git a/src/NuGetGallery/Areas/Admin/Controllers/ValidationController.cs b/src/NuGetGallery/Areas/Admin/Controllers/ValidationController.cs
index 797628e4de..38fee5789b 100644
--- a/src/NuGetGallery/Areas/Admin/Controllers/ValidationController.cs
+++ b/src/NuGetGallery/Areas/Admin/Controllers/ValidationController.cs
@@ -4,7 +4,9 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Threading.Tasks;
 using System.Web.Mvc;
+using NuGet.Services.Entities;
 using NuGet.Services.Validation;
 using NuGet.Versioning;
 using NuGetGallery.Areas.Admin.Services;
@@ -40,6 +42,25 @@ public virtual ActionResult Pending()
             return View(nameof(Index), new ValidationPageViewModel(query, packageValidations));
         }
 
+        [HttpPost]
+        [ValidateAntiForgeryToken]
+        public virtual async Task<RedirectToRouteResult> RevalidatePending(ValidatingType validatingType)
+        {
+            var revalidatedCount = await _validationAdminService.RevalidatePendingAsync(validatingType);
+
+            if (revalidatedCount == 0)
+            {
+                TempData["Message"] = $"There are no {validatingType} instances that are in the {PackageStatus.Validating} state so no validations were enqueued.";
+            }
+            else
+            {
+                TempData["Message"] = $"{revalidatedCount} validations were enqueued for {validatingType} instances that are in the {PackageStatus.Validating} state. " +
+                    $"It may take some time for the new validations to appear as the validation subsystem reacts to the enqueued messages.";
+            }
+
+            return RedirectToAction(nameof(Pending));
+        }
+
         [HttpGet]
         public virtual ActionResult Search(string q)
         {
diff --git a/src/NuGetGallery/Areas/Admin/Services/ValidationAdminService.cs b/src/NuGetGallery/Areas/Admin/Services/ValidationAdminService.cs
index 7891de6689..0c439b0f31 100644
--- a/src/NuGetGallery/Areas/Admin/Services/ValidationAdminService.cs
+++ b/src/NuGetGallery/Areas/Admin/Services/ValidationAdminService.cs
@@ -5,6 +5,7 @@
 using System.Collections.Generic;
 using System.Data.Entity;
 using System.Linq;
+using System.Threading.Tasks;
 using NuGet.Services.Entities;
 using NuGet.Services.Validation;
 using NuGet.Versioning;
@@ -20,17 +21,20 @@ public class ValidationAdminService
         private readonly IEntityRepository<PackageValidation> _validations;
         private readonly IEntityRepository<Package> _packages;
         private readonly IEntityRepository<SymbolPackage> _symbolPackages;
+        private readonly IValidationService _validationService;
 
         public ValidationAdminService(
             IEntityRepository<PackageValidationSet> validationSets,
             IEntityRepository<PackageValidation> validations,
             IEntityRepository<Package> packages,
-            IEntityRepository<SymbolPackage> symbolPackages)
+            IEntityRepository<SymbolPackage> symbolPackages,
+            IValidationService validationService)
         {
             _validationSets = validationSets ?? throw new ArgumentNullException(nameof(validationSets));
             _validations = validations ?? throw new ArgumentNullException(nameof(validations));
             _packages = packages ?? throw new ArgumentNullException(nameof(packages));
             _symbolPackages = symbolPackages ?? throw new ArgumentNullException(nameof(symbolPackages));
+            _validationService = validationService ?? throw new ArgumentNullException(nameof(validationService));
         }
 
         /// <summary>
@@ -83,6 +87,45 @@ public IReadOnlyList<PackageValidationSet> GetPending()
             return pendingValidations;
         }
 
+        public async Task<int> RevalidatePendingAsync(ValidatingType validatingType)
+        {
+            if (validatingType == ValidatingType.Package)
+            {
+                var pendingPackages = _packages
+                    .GetAll()
+                    .Include(p => p.PackageRegistration)
+                    .Where(p => p.PackageStatusKey == PackageStatus.Validating)
+                    .ToList();
+
+                foreach (var package in pendingPackages)
+                {
+                    await _validationService.RevalidateAsync(package);
+                }
+
+                return pendingPackages.Count;
+            }
+            else if (validatingType == ValidatingType.SymbolPackage)
+            {
+                var pendingSymbolPackages = _symbolPackages
+                    .GetAll()
+                    .Include(p => p.Package)
+                    .Include(p => p.Package.PackageRegistration)
+                    .Where(s => s.StatusKey == PackageStatus.Validating)
+                    .ToList();
+
+                foreach (var symbolPackage in pendingSymbolPackages)
+                {
+                    await _validationService.RevalidateAsync(symbolPackage);
+                }
+
+                return pendingSymbolPackages.Count;
+            }
+            else
+            {
+                throw new NotSupportedException("The validating type " + validatingType + " is not supported.");
+            }
+        }
+
         public PackageDeletedStatus GetDeletedStatus(int key, ValidatingType validatingType)
         {
             switch (validatingType)
diff --git a/src/NuGetGallery/Areas/Admin/Views/Validation/Index.cshtml b/src/NuGetGallery/Areas/Admin/Views/Validation/Index.cshtml
index e91d06ba0a..ccd3e0423c 100644
--- a/src/NuGetGallery/Areas/Admin/Views/Validation/Index.cshtml
+++ b/src/NuGetGallery/Areas/Admin/Views/Validation/Index.cshtml
@@ -17,7 +17,37 @@
 <section role="main" class="container main-container">
     <h2>Package Validations</h2>
 
-    <p>Get <a href="@Url.Action(actionName:"Pending")">pending validations</a>.</p>
+    <div>
+        <a href="@Url.Action(actionName:"Pending")">Get pending validations</a>
+        |
+        @ViewHelpers.PostLink(
+            this,
+            formId: "revalidate-pending-packages",
+            linkText: "Revalidate pending packages",
+            actionName: "RevalidatePending",
+            controllerName: "Validation",
+            role: string.Empty,
+            area: "Admin",
+            classes: "form-inline-empty",
+            formValues: new Dictionary<string, string>
+            {
+                { "validatingType", ValidatingType.Package.ToString() },
+            })
+        |
+        @ViewHelpers.PostLink(
+            this,
+            formId: "revalidate-pending-symbol-packages",
+            linkText: "Revalidate pending symbol packages",
+            actionName: "RevalidatePending",
+            controllerName: "Validation",
+            role: string.Empty,
+            area: "Admin",
+            classes: "form-inline-empty",
+            formValues: new Dictionary<string, string>
+            {
+                { "validatingType", ValidatingType.SymbolPackage.ToString() },
+            })
+    </div>
 
     <form method="get" action="@Url.Action(actionName: "Search")">
         <p>
@@ -78,7 +108,7 @@
                     {
                         @ViewHelpers.PostLink(
                             this,
-                            formId: "revalidate-package-form",
+                            formId: "revalidate-package-form-" + package.PackageKey,
                             linkText: "Revalidate package",
                             actionName: "Revalidate",
                             controllerName: "Packages",
@@ -87,6 +117,7 @@
                             {
                                 { "id", package.Id },
                                 { "version", package.NormalizedVersion },
+                                { "returnUrl", Url.Current() },
                             })
                         <br />
                     }
@@ -94,7 +125,7 @@
                     {
                         @ViewHelpers.PostLink(
                             this,
-                            formId: "revalidate-symbols-form",
+                            formId: "revalidate-symbols-form-" + package.PackageKey,
                             linkText: "Revalidate symbols",
                             actionName: "RevalidateSymbols",
                             controllerName: "Packages",
@@ -103,6 +134,7 @@
                             {
                                 { "id", package.Id },
                                 { "version", package.NormalizedVersion },
+                                { "returnUrl", Url.Current() },
                             })
                         <br />
                     }
@@ -193,8 +225,21 @@
                         </table>
                     }
                 </div>
-                
+
             }
         </div>
     }
-</section>
\ No newline at end of file
+</section>
+
+@section BottomScripts {
+    <script>
+    $(document).ready(function () {
+        $('#revalidate-pending-packages, #revalidate-pending-symbol-packages').submit(function (e) {
+            var operation = $(".post-link[data-form-id='" + e.target.id + "']").text().toLowerCase();
+            if (!operation || !confirm('Are you sure you want to ' + operation + '?')) {
+                e.preventDefault();
+            }
+        });
+    });
+    </script>
+}
diff --git a/src/NuGetGallery/Controllers/PackagesController.cs b/src/NuGetGallery/Controllers/PackagesController.cs
index 9a8d655292..f8ebffb99b 100644
--- a/src/NuGetGallery/Controllers/PackagesController.cs
+++ b/src/NuGetGallery/Controllers/PackagesController.cs
@@ -1911,7 +1911,7 @@ public virtual async Task<ActionResult> Reflow(string id, string version)
         [ValidateAntiForgeryToken]
         [UIAuthorize(Roles = "Admins")]
         [RequiresAccountConfirmation("revalidate a package")]
-        public virtual async Task<ActionResult> Revalidate(string id, string version)
+        public virtual async Task<ActionResult> Revalidate(string id, string version, string returnUrl = null)
         {
             var package = _packageService.FindPackageByIdAndVersionStrict(id, version);
 
@@ -1933,14 +1933,21 @@ public virtual async Task<ActionResult> Revalidate(string id, string version)
                 TempData["Message"] = $"An error occurred while revalidating the package. {ex.Message}";
             }
 
-            return SafeRedirect(Url.Package(id, version));
+            if (string.IsNullOrEmpty(returnUrl))
+            {
+                return SafeRedirect(Url.Package(id, version));
+            }
+            else
+            {
+                return SafeRedirect(returnUrl);
+            }
         }
 
         [HttpPost]
         [ValidateAntiForgeryToken]
         [UIAuthorize(Roles = "Admins")]
         [RequiresAccountConfirmation("revalidate a symbols package")]
-        public virtual async Task<ActionResult> RevalidateSymbols(string id, string version)
+        public virtual async Task<ActionResult> RevalidateSymbols(string id, string version, string returnUrl = null)
         {
             var package = _packageService.FindPackageByIdAndVersionStrict(id, version);
 
@@ -1988,7 +1995,14 @@ public virtual async Task<ActionResult> RevalidateSymbols(string id, string vers
                 TempData["Message"] = $"An error occurred while revalidating the symbols package. {ex.Message}";
             }
 
-            return SafeRedirect(Url.Package(id, version));
+            if (string.IsNullOrEmpty(returnUrl))
+            {
+                return SafeRedirect(Url.Package(id, version));
+            }
+            else
+            {
+                return SafeRedirect(returnUrl);
+            }
         }
 
         /// <summary>
diff --git a/tests/NuGetGallery.Facts/Areas/Admin/Services/ValidationAdminServiceFacts.cs b/tests/NuGetGallery.Facts/Areas/Admin/Services/ValidationAdminServiceFacts.cs
index 301e6f7b5d..ee84b1a2ac 100644
--- a/tests/NuGetGallery.Facts/Areas/Admin/Services/ValidationAdminServiceFacts.cs
+++ b/tests/NuGetGallery.Facts/Areas/Admin/Services/ValidationAdminServiceFacts.cs
@@ -3,6 +3,7 @@
 
 using System;
 using System.Linq;
+using System.Threading.Tasks;
 using Moq;
 using NuGet.Services.Entities;
 using NuGet.Services.Validation;
@@ -30,6 +31,59 @@ public void DoesNotReturnDuplicatePackageValidationSets()
             }
         }
 
+        public class TheRevalidatePendingMethod : FactsBase
+        {
+            [Fact]
+            public async Task RevalidatesValidatingPackagesAsync()
+            {
+                _packages
+                    .Setup(x => x.GetAll())
+                    .Returns(() => new[]
+                    {
+                        new Package { Key = 1, PackageStatusKey = PackageStatus.Available },
+                        new Package { Key = 2, PackageStatusKey = PackageStatus.Validating },
+                        new Package { Key = 3, PackageStatusKey = PackageStatus.Validating },
+                        new Package { Key = 4, PackageStatusKey = PackageStatus.Deleted },
+                        new Package { Key = 5, PackageStatusKey = PackageStatus.FailedValidation },
+                    }.AsQueryable());
+
+                var revalidatedCount = await _target.RevalidatePendingAsync(ValidatingType.Package);
+
+                Assert.Equal(2, revalidatedCount);
+                _validationService.Verify(x => x.RevalidateAsync(It.IsAny<Package>()), Times.Exactly(2));
+                _validationService.Verify(x => x.RevalidateAsync(It.Is<Package>(p => p.Key == 2)), Times.Once);
+                _validationService.Verify(x => x.RevalidateAsync(It.Is<Package>(p => p.Key == 3)), Times.Once);
+            }
+
+            [Fact]
+            public async Task RevalidatesValidatingSymbolsPackagesAsync()
+            {
+                _symbolPackages
+                    .Setup(x => x.GetAll())
+                    .Returns(() => new[]
+                    {
+                        new SymbolPackage { Key = 1, StatusKey = PackageStatus.Available },
+                        new SymbolPackage { Key = 2, StatusKey = PackageStatus.Validating },
+                        new SymbolPackage { Key = 3, StatusKey = PackageStatus.Validating },
+                        new SymbolPackage { Key = 4, StatusKey = PackageStatus.Deleted },
+                        new SymbolPackage { Key = 5, StatusKey = PackageStatus.FailedValidation },
+                    }.AsQueryable());
+
+                var revalidatedCount = await _target.RevalidatePendingAsync(ValidatingType.SymbolPackage);
+
+                Assert.Equal(2, revalidatedCount);
+                _validationService.Verify(x => x.RevalidateAsync(It.IsAny<SymbolPackage>()), Times.Exactly(2));
+                _validationService.Verify(x => x.RevalidateAsync(It.Is<SymbolPackage>(p => p.Key == 2)), Times.Once);
+                _validationService.Verify(x => x.RevalidateAsync(It.Is<SymbolPackage>(p => p.Key == 3)), Times.Once);
+            }
+
+            [Fact]
+            public async Task RejectsUnknownPackageStatusKey()
+            {
+                await Assert.ThrowsAsync<NotSupportedException>(() => _target.RevalidatePendingAsync(ValidatingType.Generic));
+            }
+        }
+
         public class TheGetPackageDeletedStatusMethod : FactsBase
         {
             [Fact]
@@ -133,6 +187,7 @@ public abstract class FactsBase
             protected readonly Mock<IEntityRepository<PackageValidation>> _validations;
             protected readonly Mock<IEntityRepository<Package>> _packages;
             protected readonly Mock<IEntityRepository<SymbolPackage>> _symbolPackages;
+            protected readonly Mock<IValidationService> _validationService;
             protected readonly ValidationAdminService _target;
 
             public FactsBase()
@@ -160,6 +215,7 @@ public FactsBase()
                 _validations = new Mock<IEntityRepository<PackageValidation>>();
                 _packages = new Mock<IEntityRepository<Package>>();
                 _symbolPackages = new Mock<IEntityRepository<SymbolPackage>>();
+                _validationService = new Mock<IValidationService>();
 
                 _packages
                     .Setup(x => x.GetAll())
@@ -178,7 +234,8 @@ public FactsBase()
                     _validationSets.Object,
                     _validations.Object,
                     _packages.Object,
-                    _symbolPackages.Object);
+                    _symbolPackages.Object,
+                    _validationService.Object);
             }
         }
     }
diff --git a/tests/NuGetGallery.Facts/Controllers/PackagesControllerFacts.cs b/tests/NuGetGallery.Facts/Controllers/PackagesControllerFacts.cs
index a845331b91..357691711f 100644
--- a/tests/NuGetGallery.Facts/Controllers/PackagesControllerFacts.cs
+++ b/tests/NuGetGallery.Facts/Controllers/PackagesControllerFacts.cs
@@ -9173,6 +9173,21 @@ await _target.Revalidate(
                     Times.Once);
             }
 
+            [Fact]
+            public async Task RedirectsToCustomReturnUrl()
+            {
+                // Arrange & Act
+                var result = await _target.Revalidate(
+                    _package.PackageRegistration.Id,
+                    _package.Version,
+                    "/Admin");
+
+                // Assert
+                var redirect = Assert.IsType<SafeRedirectResult>(result);
+                Assert.Equal("/Admin", redirect.Url);
+                Assert.Equal("/", redirect.SafeUrl);
+            }
+
             [Fact]
             public async Task RedirectsAfterRevalidatingPackage()
             {
@@ -9261,6 +9276,21 @@ await _target.RevalidateSymbols(
                     Times.Once);
             }
 
+            [Fact]
+            public async Task RedirectsToCustomReturnUrl()
+            {
+                // Arrange & Act
+                var result = await _target.RevalidateSymbols(
+                    _package.PackageRegistration.Id,
+                    _package.Version,
+                    "/Admin");
+
+                // Assert
+                var redirect = Assert.IsType<SafeRedirectResult>(result);
+                Assert.Equal("/Admin", redirect.Url);
+                Assert.Equal("/", redirect.SafeUrl);
+            }
+
             [Theory]
             [InlineData(PackageStatus.Available)]
             [InlineData(PackageStatus.FailedValidation)]