Merge pull request #657 from NuGet/dev

RI Dev -> Master

Author: cristinamanum

src/ArchivePackages/Properties/AssemblyInfo.cs

@@ -1,7 +1,6 @@
 // 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.Reflection;
-using System.Runtime.CompilerServices;
 using System.Runtime.InteropServices;
 
 // General Information about an assembly is controlled through the following 

src/Gallery.CredentialExpiration/Configuration/InitializationConfiguration.cs

@@ -5,20 +5,20 @@ namespace Gallery.CredentialExpiration
 {
     public class InitializationConfiguration
     {
-        public int AllowEmailResendAfterDays { get; set; }
-
         public string ContainerName { get; set; }
 
         public string DataStorageAccount { get; set; }
 
+        public string EmailPublisherConnectionString { get; set; }
+
+        public string EmailPublisherTopicName { get; set; }
+
         public string GalleryAccountUrl { get; set; }
 
         public string GalleryBrand { get; set; }
 
         public string MailFrom { get; set; }
 
-        public string SmtpUri { get; set; }
-
         public int WarnDaysBeforeExpiration { get; set; }
 
         public bool WhatIf { get; set; }

src/Gallery.CredentialExpiration/CredentialExpirationEmailBuilder.cs

@@ -0,0 +1,94 @@
+// 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 Gallery.CredentialExpiration.Models;
+using NuGet.Services.Messaging.Email;
+
+namespace Gallery.CredentialExpiration
+{
+    public class CredentialExpirationEmailBuilder : MarkdownEmailBuilder
+    {
+        public CredentialExpirationEmailBuilder(
+            InitializationConfiguration initializationConfiguration,
+            MailAddress sender,
+            string username,
+            List<ExpiredCredentialData> credentials,
+            DateTimeOffset jobRunTime,
+            bool areCredentialsExpired)
+        {
+            InitializationConfiguration = initializationConfiguration
+                ?? throw new ArgumentNullException(nameof(initializationConfiguration));
+
+            Sender = sender ?? throw new ArgumentNullException(nameof(sender));
+
+            Credentials = credentials 
+                ?? throw new ArgumentNullException(nameof(credentials));
+
+            if (!Credentials.Any())
+            {
+                throw new ArgumentException(
+                    "Must provide at least one expiring or expired credential!", 
+                    nameof(credentials));
+            }
+
+            JobRunTime = jobRunTime;
+            AreCredentialsExpired = areCredentialsExpired;
+
+            Username = username ?? throw new ArgumentNullException(nameof(username));
+            var userEmail = credentials.FirstOrDefault()?.EmailAddress
+                ?? throw new ArgumentException(
+                    "Credentials provided must have an email address!", 
+                    nameof(credentials));
+
+            UserAddress = new MailAddress(userEmail, Username);
+        }
+
+        public InitializationConfiguration InitializationConfiguration { get; }
+        
+        public string Username { get; }
+        public MailAddress UserAddress { get; }
+        public List<ExpiredCredentialData> Credentials { get; }
+        public DateTimeOffset JobRunTime { get; }
+        public bool AreCredentialsExpired { get; }
+
+        public override MailAddress Sender { get; }
+
+        public override IEmailRecipients GetRecipients()
+        {
+            return new EmailRecipients(
+                to: new MailAddress[] { UserAddress });
+        }
+
+        public override string GetSubject()
+        {
+            var template = AreCredentialsExpired ? Strings.ExpiredEmailSubject : Strings.ExpiringEmailSubject;
+            return string.Format(template, InitializationConfiguration.GalleryBrand);
+        }
+
+        protected override string GetMarkdownBody()
+        {
+            var apiKeyExpiryMessageList = Credentials
+                .Select(x => BuildApiKeyExpiryMessage(x.Description, x.Expires, JobRunTime))
+                .ToList();
+
+            var apiKeyExpiryMessage = string.Join(Environment.NewLine, apiKeyExpiryMessageList);
+            var template = AreCredentialsExpired ? Strings.ExpiredEmailBody : Strings.ExpiringEmailBody;
+            return string.Format(template, Username, InitializationConfiguration.GalleryBrand, apiKeyExpiryMessage, InitializationConfiguration.GalleryAccountUrl);
+        }
+
+        private static string BuildApiKeyExpiryMessage(string description, DateTimeOffset expiry, DateTimeOffset currentTime)
+        {
+            var expiryInDays = (expiry - currentTime).TotalDays;
+            var message = expiryInDays < 0
+                ? string.Format(Strings.ApiKeyExpired, description)
+                : string.Format(Strings.ApiKeyExpiring, description, (int)expiryInDays);
+
+            // \u2022 - Unicode for bullet point.
+            return "\u2022 " + message + Environment.NewLine;
+        }
+    }
+}

src/Gallery.CredentialExpiration/Gallery.CredentialExpiration.csproj

@@ -42,6 +42,7 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="Configuration\InitializationConfiguration.cs" />
+    <Compile Include="CredentialExpirationEmailBuilder.cs" />
     <Compile Include="GalleryCredentialExpiration.cs" />
     <Compile Include="ICredentialExpirationExporter.cs" />
     <Compile Include="JobRunTimeCursor.cs" />
@@ -101,6 +102,9 @@
     <PackageReference Include="Newtonsoft.Json">
       <Version>9.0.1</Version>
     </PackageReference>
+    <PackageReference Include="NuGet.Services.Messaging.Email">
+      <Version>2.33.0</Version>
+    </PackageReference>
     <PackageReference Include="NuGet.Services.Storage">
       <Version>2.1.3</Version>
     </PackageReference>

src/Gallery.CredentialExpiration/Job.cs

@@ -5,7 +5,6 @@
 using System.Collections.Generic;
 using System.ComponentModel.Design;
 using System.Linq;
-using System.Net;
 using System.Net.Mail;
 using System.Threading;
 using System.Threading.Tasks;
@@ -18,6 +17,9 @@
 using Microsoft.WindowsAzure.Storage;
 using Newtonsoft.Json;
 using NuGet.Jobs;
+using NuGet.Services.Messaging;
+using NuGet.Services.Messaging.Email;
+using NuGet.Services.ServiceBus;
 using NuGet.Services.Storage;
 
 namespace Gallery.CredentialExpiration
@@ -28,22 +30,27 @@ public class Job : JsonConfigurationJob
 
         private readonly string _cursorFile = "cursorv2.json";
 
-        private InitializationConfiguration Configuration { get; set; }
+        private InitializationConfiguration InitializationConfiguration { get; set; }
+        private MailAddress FromAddress { get; set; }
+        private AsynchronousEmailMessageService EmailService { get; set; }
 
         private Storage Storage { get; set; }
 
-        private SmtpClient SmtpClient { get; set; }
-
         public override void Init(IServiceContainer serviceContainer, IDictionary<string, string> jobArgsDictionary)
         {
             base.Init(serviceContainer, jobArgsDictionary);
 
-            Configuration = _serviceProvider.GetRequiredService<IOptionsSnapshot<InitializationConfiguration>>().Value;
+            InitializationConfiguration = _serviceProvider.GetRequiredService<IOptionsSnapshot<InitializationConfiguration>>().Value;
+
+            var serializer = new ServiceBusMessageSerializer();
+            var topicClient = new TopicClientWrapper(InitializationConfiguration.EmailPublisherConnectionString, InitializationConfiguration.EmailPublisherTopicName);
+            var enqueuer = new EmailMessageEnqueuer(topicClient, serializer, LoggerFactory.CreateLogger<EmailMessageEnqueuer>());
+            EmailService = new AsynchronousEmailMessageService(enqueuer);
 
-            SmtpClient = CreateSmtpClient(Configuration.SmtpUri);
+            FromAddress = new MailAddress(InitializationConfiguration.MailFrom);
 
-            var storageAccount = CloudStorageAccount.Parse(Configuration.DataStorageAccount);
-            var storageFactory = new AzureStorageFactory(storageAccount, Configuration.ContainerName, LoggerFactory);
+            var storageAccount = CloudStorageAccount.Parse(InitializationConfiguration.DataStorageAccount);
+            var storageFactory = new AzureStorageFactory(storageAccount, InitializationConfiguration.ContainerName, LoggerFactory);
             Storage = storageFactory.Create();
         }
 
@@ -53,7 +60,7 @@ public override async Task Run()
             // Default values
             var jobCursor = new JobRunTimeCursor( jobCursorTime: jobRunTime, maxProcessedCredentialsTime: jobRunTime );
             var galleryCredentialExpiration = new GalleryCredentialExpiration(this,
-                new CredentialExpirationJobMetadata(jobRunTime, Configuration.WarnDaysBeforeExpiration, jobCursor));
+                new CredentialExpirationJobMetadata(jobRunTime, InitializationConfiguration.WarnDaysBeforeExpiration, jobCursor));
 
             try
             {
@@ -70,7 +77,7 @@ public override async Task Run()
                         new JsonSerializerSettings() { MissingMemberHandling = MissingMemberHandling.Error });
 
                     galleryCredentialExpiration = new GalleryCredentialExpiration(this,
-                        new CredentialExpirationJobMetadata(jobRunTime, Configuration.WarnDaysBeforeExpiration, jobCursor));
+                        new CredentialExpirationJobMetadata(jobRunTime, InitializationConfiguration.WarnDaysBeforeExpiration, jobCursor));
                 }
 
                 // Connect to database
@@ -86,11 +93,11 @@ public override async Task Run()
                     .ForEach(ecd => ecd.Description = Constants.NonScopedApiKeyDescription);
 
                 // Group credentials for each user
-                var userToExpiredCredsMapping = credentialsInRange
+                var userToCredentialsMapping = credentialsInRange
                     .GroupBy(x => x.Username)
                     .ToDictionary(user => user.Key, value => value.ToList());
 
-                foreach (var userCredMapping in userToExpiredCredsMapping)
+                foreach (var userCredMapping in userToCredentialsMapping)
                 {
                     var username = userCredMapping.Key;
                     var credentialList = userCredMapping.Value;
@@ -99,10 +106,10 @@ public override async Task Run()
                     var expiringCredentialList = galleryCredentialExpiration.GetExpiringCredentials(credentialList);
                     var expiredCredentialList = galleryCredentialExpiration.GetExpiredCredentials(credentialList);
 
-                    await HandleExpiredCredentialEmail(username, expiringCredentialList, jobRunTime, expired: false);
+                    await HandleExpiredCredentialEmail(username, expiringCredentialList, jobRunTime, areCredentialsExpired: false);
 
                     // send expired API keys email notification
-                    await HandleExpiredCredentialEmail(username, expiredCredentialList, jobRunTime, expired: true);
+                    await HandleExpiredCredentialEmail(username, expiredCredentialList, jobRunTime, areCredentialsExpired: true);
                 }
             }
             finally
@@ -117,53 +124,35 @@ public override async Task Run()
             }
         }
 
-        private async Task HandleExpiredCredentialEmail(string username, List<ExpiredCredentialData> credentialList, DateTimeOffset jobRunTime, bool expired)
+        private async Task HandleExpiredCredentialEmail(string username, List<ExpiredCredentialData> credentials, DateTimeOffset jobRunTime, bool areCredentialsExpired)
         {
-            if (credentialList == null || credentialList.Count == 0)
+            if (credentials == null || credentials.Count == 0)
             {
                 return;
             }
 
             Logger.LogInformation("Handling {Expired} credential(s) (Keys: {Descriptions})...",
-                expired ? "expired" : "expiring",
-                string.Join(", ", credentialList.Select(x => x.Description).ToList()));
-
-            // Build message
-            var userEmail = credentialList.FirstOrDefault().EmailAddress;
-            var mailMessage = new MailMessage(Configuration.MailFrom, userEmail);
+                areCredentialsExpired ? "expired" : "expiring",
+                string.Join(", ", credentials.Select(x => x.Description).ToList()));
 
-            var apiKeyExpiryMessageList = credentialList
-                .Select(x => BuildApiKeyExpiryMessage(x.Description, x.Expires, jobRunTime))
-                .ToList();
-
-            var apiKeyExpiryMessage = string.Join(Environment.NewLine, apiKeyExpiryMessageList);
-            // Build email body
-            if (expired)
-            {
-                mailMessage.Subject = string.Format(Strings.ExpiredEmailSubject, Configuration.GalleryBrand);
-                mailMessage.Body = string.Format(Strings.ExpiredEmailBody, username, Configuration.GalleryBrand, apiKeyExpiryMessage, Configuration.GalleryAccountUrl);
-            }
-            else
-            {
-                mailMessage.Subject = string.Format(Strings.ExpiringEmailSubject, Configuration.GalleryBrand);
-                mailMessage.Body = string.Format(Strings.ExpiringEmailBody, username, Configuration.GalleryBrand, apiKeyExpiryMessage, Configuration.GalleryAccountUrl);
-            }
+            var emailBuilder = new CredentialExpirationEmailBuilder(
+                InitializationConfiguration, 
+                FromAddress, 
+                username, 
+                credentials, 
+                jobRunTime, 
+                areCredentialsExpired);
 
             // Send email
             try
             {
-                if (!Configuration.WhatIf) // if WhatIf is passed, we will not send e-mails (e.g. dev/int don't have to annoy users)
+                if (!InitializationConfiguration.WhatIf) // if WhatIf is passed, we will not send e-mails (e.g. dev/int don't have to annoy users)
                 {
-                    await SmtpClient.SendMailAsync(mailMessage);
+                    await EmailService.SendMessageAsync(emailBuilder);
                 }
 
                 Logger.LogInformation("Handled {Expired} credential .",
-                    expired ? "expired" : "expiring");
-            }
-            catch (SmtpFailedRecipientException ex)
-            {
-                var logMessage = "Failed to handle credential - recipient failed!";
-                Logger.LogWarning(LogEvents.FailedToSendMail, ex, logMessage);
+                    areCredentialsExpired ? "expired" : "expiring");
             }
             catch (Exception ex)
             {
@@ -174,36 +163,6 @@ private async Task HandleExpiredCredentialEmail(string username, List<ExpiredCre
             }
         }
 
-        private static string BuildApiKeyExpiryMessage(string description, DateTimeOffset expiry, DateTimeOffset currentTime)
-        {
-            var expiryInDays = (expiry - currentTime).TotalDays;
-            var message = expiryInDays < 0
-                ? string.Format(Strings.ApiKeyExpired, description)
-                : string.Format(Strings.ApiKeyExpiring, description, (int)expiryInDays);
-
-            // \u2022 - Unicode for bullet point.
-            return "\u2022 " + message + Environment.NewLine;
-        }
-        
-        private SmtpClient CreateSmtpClient(string smtpUriString)
-        {
-            var smtpUri = new SmtpUri(new Uri(smtpUriString));
-            var smtpClient = new SmtpClient(smtpUri.Host, smtpUri.Port)
-            {
-                EnableSsl = smtpUri.Secure
-            };
-
-            if (!string.IsNullOrWhiteSpace(smtpUri.UserName))
-            {
-                smtpClient.UseDefaultCredentials = false;
-                smtpClient.Credentials = new NetworkCredential(
-                    smtpUri.UserName,
-                    smtpUri.Password);
-            }
-
-            return smtpClient;
-        }
-
         protected override void ConfigureAutofacServices(ContainerBuilder containerBuilder)
         {
         }

src/Gallery.CredentialExpiration/Settings/dev.json

@@ -1,12 +1,12 @@
 {
   "Initialization": {
-    "AllowEmailResendAfterDays": 7,
     "ContainerName": "credentialexpiration",
     "DataStorageAccount": "DefaultEndpointsProtocol=https;AccountName=nugetdevuse2gallery;AccountKey=$$Dev-NuGetDevUse2Gallery-StorageKey$$",
+    "EmailPublisherConnectionString": "Endpoint=sb://nugetdev.servicebus.windows.net/;SharedAccessKeyName=enqueuer;SharedAccessKey=$$Dev-ServiceBus-SharedAccessKey-EmailPublisher-Enqueuer$$",
+    "EmailPublisherTopicName": "email-publisher",
     "GalleryAccountUrl": "https://dev.nugettest.org/account/ApiKeys",
     "GalleryBrand": "NuGet Gallery",
     "MailFrom": "[email protected]",
-    "SmtpUri": "#{Jobs.gallery.credentialexpiration.SmtpUri}",
     "WarnDaysBeforeExpiration": 7,
     "WhatIf": true
   },

src/Gallery.CredentialExpiration/Settings/int.json

@@ -1,8 +1,9 @@
 {
   "Initialization": {
-    "AllowEmailResendAfterDays": 7,
     "ContainerName": "credentialexpiration",
     "DataStorageAccount": "DefaultEndpointsProtocol=https;AccountName=nugetintusncgallery;AccountKey=$$Int-NuGetIntUsncGallery-StorageKey$$",
+    "EmailPublisherConnectionString": "Endpoint=sb://nugetint.servicebus.windows.net/;SharedAccessKeyName=enqueuer;SharedAccessKey=$$Int-ServiceBus-SharedAccessKey-EmailPublisher-Enqueuer$$",
+    "EmailPublisherTopicName": "email-publisher",
     "GalleryAccountUrl": "https://int.nugettest.org/account/ApiKeys",
     "GalleryBrand": "NuGet Gallery",
     "MailFrom": "[email protected]",

src/Gallery.CredentialExpiration/Settings/prod.json

@@ -1,8 +1,9 @@
 {
   "Initialization": {
-    "AllowEmailResendAfterDays": 7,
     "ContainerName": "credentialexpiration",
     "DataStorageAccount": "DefaultEndpointsProtocol=https;AccountName=nugetgallery;AccountKey=$$Prod-NuGetGalleryStorage-Key$$",
+    "EmailPublisherConnectionString": "Endpoint=sb://nugetprod.servicebus.windows.net/;SharedAccessKeyName=enqueuer;SharedAccessKey=$$Prod-ServiceBus-SharedAccessKey-EmailPublisher-Enqueuer$$",
+    "EmailPublisherTopicName": "email-publisher",
     "GalleryAccountUrl": "https://www.nuget.org/account/ApiKeys",
     "GalleryBrand": "NuGet Gallery",
     "MailFrom": "[email protected]",