[NuGet Symbol Server] Revalidate Symbols (#6547)

Author: shishirx34

src/NuGetGallery.Core/Entities/IPackageEntity.cs

@@ -7,7 +7,7 @@ namespace NuGetGallery
     /// The common entity type to be shared by <see cref="Package"/> and <see cref="SymbolPackage"/>
     /// This allows us the generic type instantiation in dependency injection for the commonly required code.
     /// </summary>
-    public interface IPackageEntity
+    public interface IPackageEntity : IEntity
     {
         string Id { get; }
 

src/NuGetGallery.Core/Entities/Package.cs

@@ -10,7 +10,7 @@ namespace NuGetGallery
 {
     [DisplayColumn("Title")]
     public class Package
-        : IEntity, IPackageEntity
+        : IPackageEntity
     {
 
 #pragma warning disable 618 // TODO: remove Package.Authors completely once production services definitely no longer need it

src/NuGetGallery.Core/Entities/SymbolPackage.cs

@@ -7,7 +7,7 @@
 namespace NuGetGallery
 {
     public class SymbolPackage
-        : IEntity, IPackageEntity, IEquatable<SymbolPackage>
+        : IPackageEntity, IEquatable<SymbolPackage>
     {
         public int Key { get; set; }
 

src/NuGetGallery.Core/Extensions/PackageExtensions.cs

@@ -0,0 +1,23 @@
+// 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.Linq;
+
+namespace NuGetGallery.Extensions
+{
+    public static class PackageExtensions
+    {
+        /// <summary>
+        /// Get the latest(last) uploaded symbols package for the given package.
+        /// </summary>
+        /// <param name="package"><see cref="Package"/> for which latest symbol package is to be retrieved.</param>
+        /// <returns>The latest symbol package if present, null otherwise</returns>
+        public static SymbolPackage LatestSymbolPackage(this Package package)
+        {
+            return package
+                .SymbolPackages?
+                .OrderByDescending(sp => sp.Created)
+                .FirstOrDefault();
+        }
+    }
+}

src/NuGetGallery.Core/NuGetGallery.Core.csproj

@@ -161,6 +161,7 @@
     <Compile Include="Entities\UserSecurityPolicy.cs" />
     <Compile Include="Entities\User.cs" />
     <Compile Include="Extensions\EntitiesContextExtensions.cs" />
+    <Compile Include="Extensions\PackageExtensions.cs" />
     <Compile Include="Extensions\PackageRegistrationExtensions.cs" />
     <Compile Include="Extensions\PackageValidationSetExtensions.cs" />
     <Compile Include="Extensions\StorageExceptionExtensions.cs" />
@@ -296,10 +297,10 @@
       <Version>4.8.0-preview4.5287</Version>
     </PackageReference>
     <PackageReference Include="NuGet.Services.Validation">
-      <Version>2.28.0-master-37018</Version>
+      <Version>2.29.0</Version>
     </PackageReference>
     <PackageReference Include="NuGet.Services.Validation.Issues">
-      <Version>2.28.0-master-37018</Version>
+      <Version>2.29.0</Version>
     </PackageReference>
     <PackageReference Include="WindowsAzure.Storage">
       <Version>7.1.2</Version>

src/NuGetGallery/Areas/Admin/Views/Validation/Index.cshtml

@@ -60,9 +60,16 @@
                 }
 
                 <b>@package.ValidatingType Key:</b> @package.PackageKey<br />
-                @if (package.DeletedStatus == PackageDeletedStatus.NotDeleted && package.ValidatingType == ValidatingType.Package )
+                @if (package.DeletedStatus == PackageDeletedStatus.NotDeleted)
                 {
-                    <a href="@Url.RevalidatePackage(package.Id, package.NormalizedVersion)">Revalidate</a><br />
+                    if (package.ValidatingType == ValidatingType.Package)
+                    {
+                        <a href="@Url.RevalidatePackage(package.Id, package.NormalizedVersion)">Revalidate Package</a><br />
+                    }
+                    else if (package.ValidatingType == ValidatingType.SymbolPackage)
+                    {
+                        <a href="@Url.RevalidateSymbolsPackage(package.Id, package.NormalizedVersion)">Revalidate Symbols</a><br />
+                    }
                 }
 
                 @if (package.DeletedStatus != PackageDeletedStatus.Unknown)

src/NuGetGallery/Controllers/PackagesController.cs

@@ -22,6 +22,7 @@
 using NuGetGallery.Auditing;
 using NuGetGallery.Configuration;
 using NuGetGallery.Diagnostics;
+using NuGetGallery.Extensions;
 using NuGetGallery.Filters;
 using NuGetGallery.Helpers;
 using NuGetGallery.Infrastructure.Lucene;
@@ -1276,6 +1277,60 @@ public virtual async Task<ActionResult> Revalidate(string id, string version)
             return SafeRedirect(Url.Package(id, version));
         }
 
+
+        [UIAuthorize(Roles = "Admins")]
+        [RequiresAccountConfirmation("revalidate a symbols package")]
+        public virtual async Task<ActionResult> RevalidateSymbols(string id, string version)
+        {
+            var package = _packageService.FindPackageByIdAndVersion(id, version);
+
+            if (package == null)
+            {
+                return new HttpStatusCodeResult(HttpStatusCode.NotFound,
+                    string.Format(Strings.PackageWithIdAndVersionNotFound, id, version));
+            }
+
+            try
+            {
+                // Select the latest symbols package for re-validation only if it is
+                // 1. Available
+                // 2. Or Pending validations
+                // 2. Or Failed Validations
+                var latestSymbolPackage = package.LatestSymbolPackage();
+                if (latestSymbolPackage == null)
+                {
+                    return new HttpStatusCodeResult(HttpStatusCode.BadRequest,
+                        string.Format(Strings.SymbolsPackage_PackageNotAvailable, id, version));
+                }
+
+                switch (latestSymbolPackage.StatusKey)
+                {
+                    case PackageStatus.Available:
+                    case PackageStatus.Validating:
+                    case PackageStatus.FailedValidation:
+                        // Allowed to revalidate
+                        break;
+                    case PackageStatus.Deleted:
+                        return new HttpStatusCodeResult(HttpStatusCode.BadRequest,
+                            string.Format(Strings.SymbolsPackage_RevalidateDeletedPackage, id, version));
+                   default:
+                        return new HttpStatusCodeResult(HttpStatusCode.BadRequest, $"Unkown Package status {latestSymbolPackage.StatusKey}!");
+                }
+
+                await _validationService.RevalidateAsync(latestSymbolPackage);
+
+                TempData["Message"] = "The symbols package is being revalidated.";
+            }
+            catch (Exception ex)
+            {
+                ex.Log();
+
+                TempData["Message"] = $"An error occurred while revalidating the symbols package. {ex.Message}";
+            }
+
+            return SafeRedirect(Url.Package(id, version));
+        }
+
         [UIAuthorize(Roles = "Admins")]
         [HttpPost]
         [RequiresAccountConfirmation("delete a package")]

src/NuGetGallery/Services/AsynchronousPackageValidationInitiator.cs

@@ -44,6 +44,7 @@ public async Task<PackageStatus> StartValidationAsync(TPackageEntity package)
             }
 
             ValidatingType validatingType;
+            var entityKey = package.Key == default(int) ? (int?)null : package.Key;
             if (package is Package)
             {
                 validatingType = ValidatingType.Package;
@@ -61,7 +62,8 @@ public async Task<PackageStatus> StartValidationAsync(TPackageEntity package)
                 package.Id,
                 package.Version,
                 Guid.NewGuid(),
-                validatingType);
+                validatingType,
+                entityKey: entityKey);
 
             var activityName = $"Enqueuing asynchronous package validation: " +
                 $"{data.PackageId} {data.PackageVersion} {data.ValidatingType} ({data.ValidationTrackingId})";

src/NuGetGallery/Services/ITelemetryService.cs

@@ -186,6 +186,13 @@ public interface ITelemetryService
         /// <param name="packageVersion">The version of the package that has the symbols uploaded.</param>
         void TrackSymbolPackageFailedGalleryValidationEvent(string packageId, string packageVersion);
 
+        /// <summary>
+        /// Track metric for symbol package revalidation
+        /// </summary>
+        /// <param name="packageId">The id of the symbols package that has the symbols revalidated.</param>
+        /// <param name="packageVersion">The version of the symbols package that has the symbols revalidated.</param>
+        void TrackSymbolPackageRevalidate(string packageId, string packageVersion);
+
         /// <summary>
         /// The typosquatting check result and total time for the uploaded package.
         /// </summary>

src/NuGetGallery/Services/IValidationService.cs

@@ -33,6 +33,13 @@ public interface IValidationService
         /// <param name="package">The package to start validation for.</param>
         Task RevalidateAsync(Package package);
 
+        /// <summary>
+        /// Starts the asynchronous validation for the provided new symbols package but does not change the symbol package's
+        /// <see cref="Package.PackageStatusKey"/>.
+        /// </summary>
+        /// <param name="symbolPackage">The symbols package to start validation for.</param>
+        Task RevalidateAsync(SymbolPackage symbolPackage);
+
         /// <summary>
         /// Whether the package's validation time exceeds the expected validation time.
         /// </summary>