Merge pull request #6691 from NuGet/dev

[ReleasePrep][2018.11.20]RI of dev into master

Author: Christy Henriksson

src/NuGetGallery.Core/Extensions/PackageValidationSetExtensions.cs

@@ -0,0 +1,45 @@
+// 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.Linq;
+using NuGet.Services.Validation;
+using NuGet.Services.Validation.Issues;
+
+namespace NuGetGallery
+{
+    public static class PackageValidationSetExtensions
+    {
+        public static IReadOnlyList<ValidationIssue> GetValidationIssues(this PackageValidationSet validationSet)
+        {
+            IReadOnlyList<ValidationIssue> issues = null;
+
+            if (validationSet != null)
+            {
+                // Get the failed validation set's validation issues. The issues are ordered by their
+                // key so that it appears that issues are appended as more validations fail.
+                issues = validationSet
+                    .PackageValidations
+                    .SelectMany(v => v.PackageValidationIssues)
+                    .OrderBy(i => i.Key)
+                    .Select(i => ValidationIssue.Deserialize(i.IssueCode, i.Data))
+                    .ToList();
+
+                // Filter out unknown issues and deduplicate the issues by code and data. This also deduplicates cases
+                // where there is extraneous data in the serialized data field or if the issue code is unknown.
+                issues = issues
+                    .GroupBy(x => new { x.IssueCode, Data = x.Serialize() })
+                    .Select(x => x.First())
+                    .ToList();
+            }
+
+            // If the package failed validation but we could not find an issue that explains why, use a generic error message.
+            if (issues == null || !issues.Any())
+            {
+                issues = new[] { ValidationIssue.Unknown };
+            }
+
+            return issues;
+        }
+    }
+}

src/NuGetGallery.Core/Extensions/ValidationIssueExtensions.cs

@@ -0,0 +1,67 @@
+// 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 NuGet.Services.Validation;
+using NuGet.Services.Validation.Issues;
+
+namespace NuGetGallery
+{
+    internal static class ValidationIssueExtensions
+    {
+        /// <summary>
+        /// Returns a Markdown representation describing the <see cref="ValidationIssue"/> in a user-friendly way.
+        /// </summary>
+        public static string ToMarkdownString(this ValidationIssue validationIssue, string announcementsUrl, string twitterUrl)
+        {
+            if (validationIssue == null)
+            {
+                throw new ArgumentNullException(nameof(validationIssue));
+            }
+
+            if (announcementsUrl == null)
+            {
+                throw new ArgumentNullException(nameof(announcementsUrl));
+            }
+
+            if (twitterUrl == null)
+            {
+                throw new ArgumentNullException(nameof(twitterUrl));
+            }
+
+            switch (validationIssue.IssueCode)
+            {
+                case ValidationIssueCode.PackageIsSigned:
+                    return $"This package could not be published since it is signed. We do not accept signed packages at this moment. To be notified about package signing and more, watch our [Announcements]({announcementsUrl}) page or follow us on [Twitter]({twitterUrl}).";
+                case ValidationIssueCode.ClientSigningVerificationFailure:
+                    var clientIssue = (ClientSigningVerificationFailure)validationIssue;
+                    return clientIssue != null
+                        ? $"**{clientIssue.ClientCode}**: {clientIssue.ClientMessage}"
+                        : "This package's signature was unable to get verified.";
+                case ValidationIssueCode.PackageIsZip64:
+                    return "Zip64 packages are not supported.";
+                case ValidationIssueCode.OnlyAuthorSignaturesSupported:
+                    return "Signed packages must only have an author signature. Other signature types are not supported.";
+                case ValidationIssueCode.AuthorAndRepositoryCounterSignaturesNotSupported:
+                    return "Author countersignatures and repository countersignatures are not supported.";
+                case ValidationIssueCode.OnlySignatureFormatVersion1Supported:
+                    return "**NU3007:** Package signatures must have format version 1.";
+                case ValidationIssueCode.AuthorCounterSignaturesNotSupported:
+                    return "Author countersignatures are not supported.";
+                case ValidationIssueCode.PackageIsNotSigned:
+                    return "This package must be signed with a registered certificate. [Read more...](https://aka.ms/nuget-signed-ref)";
+                case ValidationIssueCode.PackageIsSignedWithUnauthorizedCertificate:
+                    var certIssue = (UnauthorizedCertificateFailure)validationIssue;
+                    return $"The package was signed, but the signing certificate {(certIssue != null ? $"(SHA-1 thumbprint {certIssue.Sha1Thumbprint})" : "")} is not associated with your account. You must register this certificate to publish signed packages. [Read more...](https://aka.ms/nuget-signed-ref)";
+                case ValidationIssueCode.SymbolErrorCode_ChecksumDoesNotMatch:
+                    return "The checksum does not match for the dll(s) and corresponding pdb(s).";
+                case ValidationIssueCode.SymbolErrorCode_MatchingAssemblyNotFound:
+                    return "The uploaded symbols package contains pdb(s) for a corresponding dll(s) not found in the nuget package.";
+                case ValidationIssueCode.SymbolErrorCode_PdbIsNotPortable:
+                    return "The uploaded symbols package contains one or more pdbs that are not portable.";
+                default:
+                    return "There was an unknown failure when validating your package.";
+            }
+        }
+    }
+}

src/NuGetGallery.Core/Infrastructure/Mail/EmailRecipientsHelper.cs

@@ -0,0 +1,50 @@
+// 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;
+using System.Net.Mail;
+using NuGet.Services.Entities;
+
+namespace NuGetGallery.Infrastructure.Mail
+{
+    public static class EmailRecipientsHelper
+    {
+        public static IReadOnlyList<MailAddress> GetAllOwners(PackageRegistration packageRegistration, bool requireEmailAllowed)
+        {
+            if (packageRegistration == null)
+            {
+                throw new ArgumentNullException(nameof(packageRegistration));
+            }
+
+            var recipients = new List<MailAddress>();
+            var owners = requireEmailAllowed
+                ? packageRegistration.Owners.Where(o => o.EmailAllowed)
+                : packageRegistration.Owners;
+
+            foreach (var owner in owners)
+            {
+                recipients.Add(owner.ToMailAddress());
+            }
+
+            return recipients;
+        }
+
+        public static IReadOnlyList<MailAddress> GetOwnersSubscribedToPackagePushedNotification(PackageRegistration packageRegistration)
+        {
+            if (packageRegistration == null)
+            {
+                throw new ArgumentNullException(nameof(packageRegistration));
+            }
+
+            var recipients = new List<MailAddress>();
+            foreach (var owner in packageRegistration.Owners.Where(o => o.NotifyPackagePushed))
+            {
+                recipients.Add(owner.ToMailAddress());
+            }
+
+            return recipients;
+        }
+    }
+}

src/NuGetGallery.Core/Infrastructure/Mail/Messages/PackageAddedMessage.cs

@@ -0,0 +1,117 @@
+// 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;
+using System.Net.Mail;
+using Markdig;
+using NuGet.Services.Entities;
+using NuGet.Services.Messaging.Email;
+
+namespace NuGetGallery.Infrastructure.Mail.Messages
+{
+    public class PackageAddedMessage : MarkdownEmailBuilder
+    {
+        private readonly IMessageServiceConfiguration _configuration;
+        private readonly string _packageUrl;
+        private readonly string _packageSupportUrl;
+        private readonly string _emailSettingsUrl;
+        private readonly IEnumerable<string> _warningMessages;
+        private readonly bool _hasWarnings;
+
+        public PackageAddedMessage(
+            IMessageServiceConfiguration configuration,
+            Package package,
+            string packageUrl,
+            string packageSupportUrl,
+            string emailSettingsUrl,
+            IEnumerable<string> warningMessages)
+        {
+            _configuration = configuration ?? throw new ArgumentNullException(nameof(configuration));
+            Package = package ?? throw new ArgumentNullException(nameof(package));
+            _packageUrl = packageUrl ?? throw new ArgumentNullException(nameof(packageUrl));
+            _packageSupportUrl = packageSupportUrl ?? throw new ArgumentNullException(nameof(packageSupportUrl));
+            _emailSettingsUrl = emailSettingsUrl ?? throw new ArgumentNullException(nameof(emailSettingsUrl));
+            _warningMessages = warningMessages;
+            _hasWarnings = warningMessages != null && warningMessages.Any();
+        }
+
+        public override MailAddress Sender => _configuration.GalleryNoReplyAddress;
+
+        public Package Package { get; }
+
+        public override IEmailRecipients GetRecipients()
+        {
+            var to = EmailRecipientsHelper.GetOwnersSubscribedToPackagePushedNotification(Package.PackageRegistration);
+            return new EmailRecipients(to);
+        }
+
+        public override string GetSubject()
+        {
+            if (_hasWarnings)
+            {
+                return $"[{_configuration.GalleryOwner.DisplayName}] Package published with warnings - {Package.PackageRegistration.Id} {Package.Version}";
+            }
+            else
+            {
+                return $"[{_configuration.GalleryOwner.DisplayName}] Package published - {Package.PackageRegistration.Id} {Package.Version}";
+            }
+        }
+
+        protected override string GetMarkdownBody()
+        {
+            return GetBodyInternal(EmailFormat.Markdown);
+        }
+
+        protected override string GetPlainTextBody()
+        {
+            return GetBodyInternal(EmailFormat.PlainText);
+        }
+
+        protected override string GetHtmlBody()
+        {
+            return GetBodyInternal(EmailFormat.Html);
+        }
+
+        private string GetBodyInternal(EmailFormat format)
+        {
+            var warningMessages = GetWarningMessages();
+
+            var markdown = $@"The package [{Package.PackageRegistration.Id} {Package.Version}]({_packageUrl}) was recently published on {_configuration.GalleryOwner.DisplayName} by {Package.User.Username}. If this was not intended, please [contact support]({_packageSupportUrl}).";
+
+            if (!string.IsNullOrEmpty(warningMessages))
+            {
+                markdown += warningMessages;
+            }
+
+            string body;
+            switch (format)
+            {
+                case EmailFormat.PlainText:
+                    body = ToPlainText(markdown);
+                    break;
+                case EmailFormat.Markdown:
+                    body = markdown;
+                    break;
+                case EmailFormat.Html:
+                    body = Markdown.ToHtml(markdown);
+                    break;
+                default:
+                    throw new ArgumentOutOfRangeException(nameof(format));
+            }
+
+            return body + EmailMessageFooter.ForPackageOwnerNotifications(format, _configuration.GalleryOwner.DisplayName, _emailSettingsUrl);
+        }
+
+        private string GetWarningMessages()
+        {
+            var warningMessagesPlaceholder = string.Empty;
+            if (_hasWarnings)
+            {
+                warningMessagesPlaceholder = Environment.NewLine + Environment.NewLine + string.Join(Environment.NewLine, _warningMessages);
+            }
+            return warningMessagesPlaceholder;
+        }
+    }
+}

src/NuGetGallery.Core/Infrastructure/Mail/Messages/PackageValidationFailedMessage.cs

@@ -0,0 +1,86 @@
+// 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.Net.Mail;
+using System.Text;
+using NuGet.Services.Entities;
+using NuGet.Services.Messaging.Email;
+using NuGet.Services.Validation;
+
+namespace NuGetGallery.Infrastructure.Mail.Messages
+{
+    public class PackageValidationFailedMessage : MarkdownEmailBuilder
+    {
+        private readonly IMessageServiceConfiguration _configuration;
+        private readonly Package _package;
+        private readonly PackageValidationSet _validationSet;
+        private readonly string _packageUrl;
+        private readonly string _packageSupportUrl;
+        private readonly string _announcementsUrl;
+        private readonly string _twitterUrl;
+
+        public PackageValidationFailedMessage(
+            IMessageServiceConfiguration configuration,
+            Package package,
+            PackageValidationSet validationSet,
+            string packageUrl,
+            string packageSupportUrl,
+            string announcementsUrl,
+            string twitterUrl)
+        {
+            _configuration = configuration ?? throw new ArgumentNullException(nameof(configuration));
+            _package = package ?? throw new ArgumentNullException(nameof(package));
+            _validationSet = validationSet ?? throw new ArgumentNullException(nameof(validationSet));
+            _packageUrl = packageUrl ?? throw new ArgumentNullException(nameof(packageUrl));
+            _packageSupportUrl = packageSupportUrl ?? throw new ArgumentNullException(nameof(packageSupportUrl));
+            _announcementsUrl = announcementsUrl ?? throw new ArgumentNullException(nameof(announcementsUrl));
+            _twitterUrl = twitterUrl ?? throw new ArgumentNullException(nameof(twitterUrl));
+        }
+
+        public override MailAddress Sender => _configuration.GalleryNoReplyAddress;
+
+        public override IEmailRecipients GetRecipients()
+        {
+            var to = EmailRecipientsHelper.GetAllOwners(_package.PackageRegistration, requireEmailAllowed: false);
+            return new EmailRecipients(to);
+        }
+
+        public override string GetSubject()
+            => $"[{_configuration.GalleryOwner.DisplayName}] Package validation failed - {_package.PackageRegistration.Id} {_package.Version}";
+
+        protected override string GetMarkdownBody()
+        {
+            var validationIssues = _validationSet.GetValidationIssues();
+
+            var bodyBuilder = new StringBuilder();
+            bodyBuilder.Append($@"The package [{_package.PackageRegistration.Id} {_package.Version}]({_packageUrl}) failed validation because of the following reason(s):
+");
+
+            foreach (var validationIssue in validationIssues)
+            {
+                bodyBuilder.Append($@"
+- {validationIssue.ToMarkdownString(_announcementsUrl, _twitterUrl)}");
+            }
+
+            bodyBuilder.Append($@"
+
+Your package was not published on {_configuration.GalleryOwner.DisplayName} and is not available for consumption.
+
+");
+
+            if (validationIssues.Any(i => i.IssueCode == ValidationIssueCode.Unknown))
+            {
+                bodyBuilder.Append($"Please [contact support]({_packageSupportUrl}) to help fix your package.");
+            }
+            else
+            {
+                var issuePluralString = validationIssues.Count() > 1 ? "all the issues" : "the issue";
+                bodyBuilder.Append($"You can reupload your package once you've fixed {issuePluralString} with it.");
+            }
+
+            return bodyBuilder.ToString();
+        }
+    }
+}