[NuGet Symbol Server]Symbols validation status view (#6407)

Author: shishirx34

src/NuGetGallery/Controllers/PackagesController.cs

@@ -467,7 +467,8 @@ public virtual async Task<ActionResult> DisplayPackage(string id, string version
             var model = new DisplayPackageViewModel(package, currentUser, packageHistory);
 
             model.ValidatingTooLong = _validationService.IsValidatingTooLong(package);
-            model.ValidationIssues = _validationService.GetLatestValidationIssues(package);
+            model.PackageValidationIssues = _validationService.GetLatestPackageValidationIssues(package);
+            model.SymbolsPackageValidationIssues = _validationService.GetLatestPackageValidationIssues(model.LatestSymbolsPackage);
             model.IsCertificatesUIEnabled = _contentObjectService.CertificatesConfiguration?.IsUIEnabledForUser(currentUser) ?? false;
 
             model.ReadMeHtml = await _readMeService.GetReadMeHtmlAsync(package);

src/NuGetGallery/Services/IValidationService.cs

@@ -45,6 +45,13 @@ public interface IValidationService
         /// </summary>
         /// <param name="package">The package whose validation issues should be fetched.</param>
         /// <returns>The validation issues encountered in the latest validation.</returns>
-        IReadOnlyList<ValidationIssue> GetLatestValidationIssues(Package package);
+        IReadOnlyList<ValidationIssue> GetLatestPackageValidationIssues(Package package);
+
+        /// <summary>
+        /// Get the symbol package's validation issues from the latest validation.
+        /// </summary>
+        /// <param name="symbolPackage">The symbol package whose validation issues should be fetched.</param>
+        /// <returns>The validation issues encountered in the latest validation.</returns>
+        IReadOnlyList<ValidationIssue> GetLatestPackageValidationIssues(SymbolPackage symbolPackage);
     }
 }

src/NuGetGallery/Services/ValidationService.cs

@@ -75,18 +75,33 @@ public bool IsValidatingTooLong(Package package)
             return false;
         }
 
-        public IReadOnlyList<ValidationIssue> GetLatestValidationIssues(Package package)
+        public IReadOnlyList<ValidationIssue> GetLatestPackageValidationIssues(Package package)
+        {
+            return GetValidationIssues(package.Key, package.PackageStatusKey, ValidatingType.Package);
+        }
+
+        public IReadOnlyList<ValidationIssue> GetLatestPackageValidationIssues(SymbolPackage symbolPackage)
+        {
+            if (symbolPackage == null)
+            {
+                return new List<ValidationIssue>();
+            }
+
+            return GetValidationIssues(symbolPackage.Key, symbolPackage.StatusKey, ValidatingType.SymbolPackage);
+        }
+
+        private IReadOnlyList<ValidationIssue> GetValidationIssues(int entityKey, PackageStatus status, ValidatingType validatingType)
         {
             IReadOnlyList<ValidationIssue> issues = new ValidationIssue[0];
 
             // Only query the database for validation issues if the package has failed validation.
-            if (package.PackageStatusKey == PackageStatus.FailedValidation)
+            if (status == PackageStatus.FailedValidation)
             {
                 // Grab the most recently completed validation set for this package. Note that the orchestrator will stop
                 // processing a validation set if all validation succeed, OR, one or more validation fails.
-                var validationSet = _validationSets
+                var validationSet = _validationSets?
                     .GetAll()
-                    .Where(s => s.PackageKey == package.Key)
+                    .Where(s => s.PackageKey == entityKey && s.ValidatingType == validatingType)
                     .Where(s => s.PackageValidations.All(v => v.ValidationStatus == ValidationStatus.Succeeded) ||
                                 s.PackageValidations.Any(v => v.ValidationStatus == ValidationStatus.Failed))
                     .Include(s => s.PackageValidations.Select(v => v.PackageValidationIssues))

src/NuGetGallery/ViewModels/DisplayPackageViewModel.cs

@@ -26,7 +26,7 @@ public DisplayPackageViewModel(Package package, User currentUser, IOrderedEnumer
             PushedBy = GetPushedBy(package, currentUser);
             PackageFileSize = package.PackageFileSize;
 
-            LatestSymbolPackage = package
+            LatestSymbolsPackage = package
                 .SymbolPackages
                 .OrderByDescending(sp => sp.Created)
                 .FirstOrDefault();
@@ -61,7 +61,8 @@ public DisplayPackageViewModel(Package package, User currentUser, string pushedB
         }
 
         public bool ValidatingTooLong { get; set; }
-        public IReadOnlyList<ValidationIssue> ValidationIssues { get; set; }
+        public IReadOnlyList<ValidationIssue> PackageValidationIssues { get; set; }
+        public IReadOnlyList<ValidationIssue> SymbolsPackageValidationIssues { get; set; }
         public DependencySetsViewModel Dependencies { get; set; }
         public IEnumerable<DisplayPackageViewModel> PackageVersions { get; set; }
         public string Copyright { get; set; }
@@ -70,7 +71,7 @@ public DisplayPackageViewModel(Package package, User currentUser, string pushedB
         public int DownloadsPerDay { get; private set; }
         public int TotalDaysSinceCreated { get; private set; }
         public long PackageFileSize { get; private set; }
-        public SymbolPackage LatestSymbolPackage { get; private set; }
+        public SymbolPackage LatestSymbolsPackage { get; private set; }
 
         public bool HasSemVer2Version { get; }
         public bool HasSemVer2Dependency { get; }

src/NuGetGallery/Views/Packages/DisplayPackage.cshtml

@@ -9,7 +9,8 @@
 
     var absolutePackageUrl = Url.Absolute(Url.Package(Model.Id));
 
-    var hasSymbolPackageAvailable = Model.LatestSymbolPackage != null && Model.LatestSymbolPackage.StatusKey == PackageStatus.Available;
+    var hasSymbolsPackageAvailable = Model.LatestSymbolsPackage != null && Model.LatestSymbolsPackage.StatusKey == PackageStatus.Available;
+    var showSymbolsPackageStatus = Model.LatestSymbolsPackage != null && Model.LatestSymbolsPackage.StatusKey != PackageStatus.Available;
 
     PackageManagerViewModel[] packageManagers;
 
@@ -199,14 +200,14 @@
                     @<text>
                         <strong>Package publishing failed.</strong> This package could not be published due to the following reason(s):
                         <ul class="failed-validation-alert-list">
-                            @foreach (var issue in Model.ValidationIssues)
+                            @foreach (var issue in Model.PackageValidationIssues)
                             {
                                 <li>@Html.Partial("_ValidationIssue", issue)</li>
                             }
                         </ul>
-                        @if (!Model.ValidationIssues.Any(i => i.IssueCode == ValidationIssueCode.Unknown))
+                        @if (!Model.PackageValidationIssues.Any(i => i.IssueCode == ValidationIssueCode.Unknown))
                         {
-                            var issuePluralString = Model.ValidationIssues.Count() > 1 ? "all the issues" : "the issue";
+                            var issuePluralString = Model.PackageValidationIssues.Count() > 1 ? "all the issues" : "the issue";
                             <text>Once you've fixed @issuePluralString with your package, you can reupload it with the same ID and version.</text>
                         }
                         else
@@ -238,20 +239,20 @@
             @if (Model.HasNewerRelease)
             {
                 @ViewHelpers.AlertInfo(
-                        @<text>
-                            There is a newer version of this package available.
-                            <br /> See the version list below for details.
-                        </text>
-                     )
+                    @<text>
+                        There is a newer version of this package available.
+                        <br /> See the version list below for details.
+                    </text>
+                )
             }
             else if (Model.HasNewerPrerelease)
             {
                 @ViewHelpers.AlertInfo(
-                        @<text>
-                            There is a newer prerelease version of this package available.
-                            <br /> See the version list below for details.
-                        </text>
-                     )
+                    @<text>
+                        There is a newer prerelease version of this package available.
+                        <br /> See the version list below for details.
+                    </text>
+                )
             }
 
             @if (Model.Listed && Model.IsIndexed.HasValue && !Model.IsIndexed.Value && Model.Available)
@@ -269,6 +270,43 @@
                 @ViewHelpers.AlertIsSemVer2Package(Model.HasSemVer2Version, Model.HasSemVer2Dependency)
             }
 
+            @if (showSymbolsPackageStatus)
+            {
+                if (Model.LatestSymbolsPackage.StatusKey == PackageStatus.Validating)
+                {
+                    @ViewHelpers.AlertWarning(
+                        @<text>
+                            The symbols for this package have not been indexed yet. They are not available
+                            for download from the NuGet.org symbol server. Symbols will be indexed and will 
+                            be available for download after both validation and indexing are complete. 
+                            Symbols validation and indexing may take up to an hour. <a href="https://aka.ms/NuGetSymbolsPackageValidation">Read more</a>.
+                        </text>
+                     )
+                }
+                else if (Model.LatestSymbolsPackage.StatusKey == PackageStatus.FailedValidation)
+                {
+                    @ViewHelpers.AlertDanger(
+                    @<text>
+                        <strong>Symbols package publishing failed.</strong> The associated symbols package could not be published due to the following reason(s):
+                        <ul class="failed-validation-alert-list">
+                            @foreach (var issue in Model.SymbolsPackageValidationIssues)
+                            {
+                                <li>@Html.Partial("_ValidationIssue", issue)</li>
+                            }
+                        </ul>
+                        @if (!Model.SymbolsPackageValidationIssues.Any(i => i.IssueCode == ValidationIssueCode.Unknown))
+                        {
+                            var issuePluralString = Model.SymbolsPackageValidationIssues.Count() > 1 ? "all the issues" : "the issue";
+                            <text>Once you've fixed @issuePluralString with your symbols package, you can re-upload it.</text>
+                        }
+                        else
+                        {
+                            <text>Please contact <a href="mailto:[email protected]">support@nuget.org</a> to help fix your symbols package.</text>
+                        }
+                    </text>)
+                }
+            }
+
             @if (!Model.Listed && Model.Available)
             {
                 if (Model.CanDisplayPrivateMetadata)
@@ -467,7 +505,7 @@
                                     </td>
                                     <td>
                                         <a href="@Url.Package(packageVersion)" title="@packageVersion.FullVersion">
-                                                @packageVersion.Version.Abbreviate(30)
+                                            @packageVersion.Version.Abbreviate(30)
                                         </a>
                                     </td>
                                     <td>
@@ -626,12 +664,12 @@
                         <a href="@Url.PackageDownload(2, Model.Id, Model.Version)" data-track="outbound-manual-download" title="Download the raw nupkg file." rel="nofollow">Download Package</a>
                         &nbsp;(@Model.PackageFileSize.ToUserFriendlyBytesLabel())
                     </li>
-                    if (hasSymbolPackageAvailable)
+                    if (hasSymbolsPackageAvailable)
                     {
                         <li>
                             <i class="ms-Icon ms-Icon--CloudDownload" aria-hidden="true"></i>
                             <a href="@Url.SymbolPackageDownload(2, Model.Id, Model.Version)" data-track="outbound-manual-download" title="Download the raw snupkg file." rel="nofollow">Download Symbols</a>
-                            &nbsp;(@Model.LatestSymbolPackage.FileSize.ToUserFriendlyBytesLabel())
+                            &nbsp;(@Model.LatestSymbolsPackage.FileSize.ToUserFriendlyBytesLabel())
                         </li>
                     }
                     <li class="no-clickonce">

src/NuGetGallery/Views/Packages/_ValidationIssue.cshtml

@@ -58,6 +58,16 @@
             </text>
             break;
         }
+    case ValidationIssueCode.SymbolErrorCode_ChecksumDoesNotMatch:
+        <text>
+            The checksum does not match for the dll(s) and corresponding pdb(s).
+        </text>
+        break;
+    case ValidationIssueCode.SymbolErrorCode_MatchingPortablePDBNotFound:
+        <text>
+            The uploaded symbols package contains pdb(s) for a corresponding dll(s) not found in the nuget package.
+        </text>
+        break;
     default:
         <text>
             There was an unknown failure when validating your package.

src/NuGetGallery/Views/Shared/Gallery/Header.cshtml

@@ -1,7 +1,7 @@
 @{
     var ShowWarningIndicator = Config.Current.DeprecateNuGetPasswordLogins && (User.HasPasswordLogin() || (!User.HasMultiFactorAuthenticationEnabled() && User.WasMicrosoftAccountUsedForSignin()));
     var ShowPasswordDeprecationBanner = TempData.ContainsKey("ShowPasswordDeprecationWarning")
-        && Convert.ToBoolean((string)TempData["ShowPasswordDeprecationWarning"])
+        && Convert.ToBoolean(TempData["ShowPasswordDeprecationWarning"].ToString())
         && Request.IsAuthenticated
         && Config.Current.DeprecateNuGetPasswordLogins
         && User.HasPasswordLogin();

tests/NuGetGallery.Facts/Controllers/PackagesControllerFacts.cs

@@ -744,15 +744,15 @@ public async Task GetsValidationIssues()
                     new TestIssue("This should not be deduplicated by the controller layer"),
                 };
 
-                validationService.Setup(v => v.GetLatestValidationIssues(It.IsAny<Package>()))
+                validationService.Setup(v => v.GetLatestPackageValidationIssues(It.IsAny<Package>()))
                     .Returns(expectedIssues);
 
                 // Act
                 var result = await controller.DisplayPackage("Foo", version: null);
 
                 // Assert
                 var model = ResultAssert.IsView<DisplayPackageViewModel>(result);
-                Assert.Equal(model.ValidationIssues, expectedIssues);
+                Assert.Equal(model.PackageValidationIssues, expectedIssues);
             }
 
             private class TestIssue : ValidationIssue

tests/NuGetGallery.Facts/Services/ValidationServiceFacts.cs

@@ -206,12 +206,22 @@ public void IgnoresPackagesThatHaventFailedValidations(PackageStatus status)
                 _package.PackageStatusKey = status;
 
                 // Act
-                var issues = _target.GetLatestValidationIssues(_package);
+                var issues = _target.GetLatestPackageValidationIssues(_package);
 
                 // Assert
                 _validationSets.Verify(x => x.GetAll(), Times.Never());
             }
 
+            [Fact]
+            public void ReturnsEmptyListForNullSymbolsPackage()
+            {
+                // Arrange and act
+                var issues = _target.GetLatestPackageValidationIssues(symbolPackage: null);
+
+                Assert.NotNull(issues);
+                Assert.Empty(issues);
+            }
+
             [Fact]
             public void DeduplicatesValidationIssuesByCodeAndData()
             {
@@ -281,7 +291,7 @@ public void DeduplicatesValidationIssuesByCodeAndData()
                     .Returns(new[] { packageValidationSet }.AsQueryable());
 
                 // Act
-                var issues = _target.GetLatestValidationIssues(_package);
+                var issues = _target.GetLatestPackageValidationIssues(_package);
 
                 // Assert
                 _validationSets.Verify(x => x.GetAll(), Times.Once);
@@ -326,7 +336,7 @@ public void ReturnsSingleUnknownIssueIfNoneArePersisted()
                     .Returns(new[] { packageValidationSet }.AsQueryable());
 
                 // Act
-                var issues = _target.GetLatestValidationIssues(_package);
+                var issues = _target.GetLatestPackageValidationIssues(_package);
 
                 // Assert
                 _validationSets.Verify(x => x.GetAll(), Times.Once);
@@ -397,7 +407,7 @@ public void FetchesValidationIssues()
                                .Returns(new[] { packageValidationSet1, packageValidationSet2, packageValidationSet3 }.AsQueryable());
 
                 // Act
-                var issues = _target.GetLatestValidationIssues(_package);
+                var issues = _target.GetLatestPackageValidationIssues(_package);
 
                 // Assert
                 _validationSets.Verify(x => x.GetAll(), Times.Once());

tests/NuGetGallery.Facts/ViewModels/DisplayPackageViewModelFacts.cs

@@ -155,7 +155,7 @@ public void TheCtorReturnsLatestSymbolPackageByDateCreated()
 
             var viewModel = new DisplayPackageViewModel(package, null, packageHistory: Enumerable.Empty<Package>().OrderBy(x => 1));
 
-            Assert.Equal(symbolPackageList[0], viewModel.LatestSymbolPackage);
+            Assert.Equal(symbolPackageList[0], viewModel.LatestSymbolsPackage);
         }
 
         [Fact]