PAS-452 | Design generic fallback for e-mail providers & drop PostMark

src/AdminConsole/Components/Pages/Organization/Verify.razor

@@ -0,0 +1,45 @@
+@page "/organization/verify"
+@using Microsoft.Extensions.Options
+@using Passwordless.Common.Services.Mail
+
+@attribute [AllowAnonymous]
+
+@inject IOptionsSnapshot<MailConfiguration> MailOptions
+@inject IHttpContextAccessor HttpContextAccessor
+@inject NavigationManager NavigationManager
+@inject IWebHostEnvironment WebHostEnvironment
+
+<HeadContent>
+    @* This to refresh the page to check if the user has verified and logged in *@
+    <meta http-equiv="refresh" content="15" />
+</HeadContent>
+
+<Page Title="Verify your account">
+    <div class="flex flex-col items-center py-10 sm:max-w-xl mx-auto">
+    <span class="p-4 text-white rounded-full bg-primary-700">
+        <MailIcon Class="text-white w-8 h-8" />
+    </span>
+        <h2 class="mt-6 mb-8 text-center">Check your email to verify your account</h2>
+        <p class="mt-4 text-center">We've sent a confirmation link to the email address you provided. Click on the link in the email to verify your account.</p>
+    </div>
+
+    @if (ShouldShowFileMailPath && FileMailPath != null)
+    {
+        <div id="file-provider-debug-section">
+            <p>
+                <b>Development mode:</b> Email history is saved to <code>@FileMailPath</code> and displayed below.
+            </p>
+
+            @if (FileMailPathExists && FileMailContent != null)
+            {
+                <pre class="mt-4 text-wrap break-all">
+                    <code>@FileMailContent</code>
+                </pre>
+            }
+            else
+            {
+                <p class="mt-4">No emails have been sent yet.</p>
+            }
+        </div>
+    }
+</Page>

src/AdminConsole/Components/Pages/Organization/Verify.razor.cs

@@ -0,0 +1,35 @@
+using Microsoft.AspNetCore.Components;
+using Passwordless.Common.Services.Mail.File;
+
+namespace Passwordless.AdminConsole.Components.Pages.Organization;
+
+public partial class Verify : ComponentBase
+{
+    public bool ShouldShowFileMailPath => WebHostEnvironment.IsDevelopment() && MailOptions.Value.Providers.All(p => p.Name.Equals(FileMailProviderOptions.Provider, StringComparison.InvariantCultureIgnoreCase));
+
+    public string? FileMailPath { get; set; }
+
+    public bool FileMailPathExists { get; set; }
+
+    public string? FileMailContent { get; set; }
+
+    protected override async Task OnInitializedAsync()
+    {
+        if (HttpContextAccessor.HttpContext?.User.Identity?.IsAuthenticated ?? false)
+        {
+            NavigationManager.NavigateTo("/account/useronboarding");
+            return;
+        }
+
+        if (ShouldShowFileMailPath)
+        {
+            var fileMailProvider = MailOptions.Value.Providers.First() as FileMailProviderOptions;
+            FileMailPath = Path.GetFullPath(fileMailProvider!.Path);
+            FileMailPathExists = File.Exists(FileMailPath);
+            if (FileMailPathExists)
+            {
+                FileMailContent = await File.ReadAllTextAsync(FileMailPath);
+            }
+        }
+    }
+}

src/AdminConsole/readme.md

@@ -37,11 +37,18 @@ The [Admin Console](https://admin.passwordless.dev/) is your primary GUI for cre
     "ApiSecret": "myAppId:secret:123456",
     "ApiUrl": "<optional>"
   },
+  // https://docs.passwordless.dev/guide/self-hosting/configuration.html#e-mail
   "Mail": {
-    // Mail Providers are pluggable. Remove "Postmark" to use the FileProvider
-    "Postmark": {
-      "ApiKey": "",
-      "From": ""
+    "Smtp": {
+      "From": "sender@example.com",
+      "Username": "username",
+      "Password": "password",
+      "Host": "smtp.example.com",
+      "Port": 587,
+      "StartTls": true,
+      "Ssl": false,
+      "SslOverride": false,
+      "TrustServer": false
     }
   },
   "ConnectionStrings": {

src/Common/Common.csproj

@@ -11,14 +11,15 @@
     <PackageReference Include="MailKit" Version="4.7.1.1" />
     <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.8" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.Relational" Version="8.0.8" />
-    <PackageReference Include="Postmark" Version="4.7.12" />
     <PackageReference Include="Serilog.AspNetCore" Version="8.0.2" />
     <PackageReference Include="Serilog.Enrichers.Environment" Version="3.0.1" />
     <PackageReference Include="Serilog.Expressions" Version="5.0.0" />
     <PackageReference Include="Serilog.Sinks.Datadog.Logs" Version="0.5.2" />
     <PackageReference Include="Serilog.Sinks.Seq" Version="8.0.0" />
     <PackageReference Include="Swashbuckle.AspNetCore" Version="6.7.1" />
     <PackageReference Include="System.Configuration.ConfigurationManager" Version="8.0.0" />
+    <PackageReference Include="AWSSDK.SimpleEmailV2" Version="3.7.400.2" />
+    <PackageReference Include="SendGrid" Version="9.29.3" />
   </ItemGroup>
 
   <ItemGroup>

src/Common/HealthChecks/MailKitHealthCheck.cs

@@ -1,16 +1,16 @@
 using MailKit.Net.Smtp;
 using Microsoft.Extensions.Diagnostics.HealthChecks;
-using Passwordless.Common.Services.Mail;
+using Passwordless.Common.Services.Mail.Smtp;
 
 namespace Passwordless.Common.HealthChecks;
 
 public class MailKitHealthCheck : IHealthCheck
 {
-    private readonly MailKitSmtpMailProvider _mailProvider;
+    private readonly SmtpMailProvider _smtpMailProvider;
 
-    public MailKitHealthCheck(MailKitSmtpMailProvider mailProvider)
+    public MailKitHealthCheck(SmtpMailProvider smtpMailProvider)
     {
-        _mailProvider = mailProvider;
+        _smtpMailProvider = smtpMailProvider;
     }
 
     public async Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context, CancellationToken cancellationToken = default)
@@ -19,7 +19,7 @@ public async Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context
         bool hasErrors = false;
         try
         {
-            client = await _mailProvider.GetClientAsync();
+            client = await _smtpMailProvider.GetClientAsync();
         }
         catch
         {

src/Common/Services/Mail/AggregateMailProvider.cs

@@ -0,0 +1,52 @@
+using Microsoft.Extensions.Options;
+
+namespace Passwordless.Common.Services.Mail;
+
+/// <summary>
+/// Wraps multiple mail providers and tries to send the message using them in order.
+/// </summary>
+public class AggregateMailProvider : IMailProvider
+{
+    private readonly IOptionsSnapshot<MailConfiguration> _options;
+    private readonly IMailProviderFactory _factory;
+    private readonly ILogger<AggregateMailProvider> _logger;
+
+    public const string FallBackFailedMessage = "No registered mail provider was able to send the message";
+
+    public AggregateMailProvider(
+        IOptionsSnapshot<MailConfiguration> options,
+        IMailProviderFactory factory,
+        ILogger<AggregateMailProvider> logger)
+    {
+        _options = options;
+        _factory = factory;
+        _logger = logger;
+    }
+
+    public async Task SendAsync(MailMessage message)
+    {
+        if (message.From == null)
+        {
+            message.From = _options.Value.From;
+        }
+        foreach (var providerConfiguration in _options.Value.Providers)
+        {
+            try
+            {
+                _logger.LogDebug("Attempting to send message using provider '{Provider}'", providerConfiguration.Name);
+                var provider = _factory.Create(providerConfiguration.Name, providerConfiguration);
+
+                await provider.SendAsync(message);
+                _logger.LogInformation("Sent message using provider '{Provider}'", providerConfiguration.Name);
+                return;
+            }
+            catch (Exception e)
+            {
+                _logger.LogError(e, "Failed to send message using provider '{Provider}'", providerConfiguration.Name);
+            }
+        }
+
+        _logger.LogCritical(FallBackFailedMessage);
+        throw new InvalidOperationException(FallBackFailedMessage);
+    }
+}

src/Common/Services/Mail/Aws/AwsMailProvider.cs

@@ -0,0 +1,86 @@
+using Amazon;
+using Amazon.Runtime;
+using Amazon.SimpleEmailV2;
+using Amazon.SimpleEmailV2.Model;
+
+namespace Passwordless.Common.Services.Mail.Aws;
+
+public class AwsMailProvider : IMailProvider
+{
+    private readonly IAmazonSimpleEmailServiceV2 _client;
+    private readonly ILogger<AwsMailProvider> _logger;
+
+    public AwsMailProvider(
+        AwsMailProviderOptions options,
+        ILogger<AwsMailProvider> logger)
+    {
+        var credentials = new BasicAWSCredentials(options.AccessKey, options.SecretKey);
+        _client = new AmazonSimpleEmailServiceV2Client(credentials, RegionEndpoint.GetBySystemName(options.Region));
+        _logger = logger;
+    }
+
+    public async Task SendAsync(MailMessage message)
+    {
+        var request = new SendEmailRequest
+        {
+            FromEmailAddress = message.From
+        };
+
+        if (message.To.Any())
+        {
+            request.Destination = new Destination
+            {
+                ToAddresses = message.To.ToList()
+            };
+        }
+
+        request.Content = new EmailContent
+        {
+            Simple = new Message
+            {
+                Subject = new Content { Data = message.Subject },
+                Body = new Body
+                {
+                    Html = new Content { Data = message.HtmlBody },
+                    Text = new Content { Data = message.TextBody },
+                }
+            }
+        };
+
+        try
+        {
+            await _client.SendEmailAsync(request);
+            _logger.LogInformation("Sent email with subject '{Subject}' to '{To}'", message.Subject, message.To);
+        }
+        catch (AccountSuspendedException ex)
+        {
+            _logger.LogError(ex, "The account's ability to send email has been permanently restricted.");
+            throw;
+        }
+        catch (MailFromDomainNotVerifiedException ex)
+        {
+            _logger.LogError(ex, "The sending domain is not verified.");
+            throw;
+        }
+        catch (MessageRejectedException ex)
+        {
+            _logger.LogError(ex, "The message content is invalid.");
+            throw;
+        }
+        catch (SendingPausedException ex)
+        {
+            _logger.LogError(ex, "The account's ability to send email is currently paused.");
+            throw;
+        }
+        catch (TooManyRequestsException ex)
+        {
+            _logger.LogError(ex, "Too many requests were made. Please try again later.");
+            throw;
+        }
+        catch (Exception ex)
+        {
+            _logger.LogError(ex, "An error occurred while sending the email.");
+            throw;
+        }
+    }
+}

src/Common/Services/Mail/Aws/AwsMailProviderOptions.cs

@@ -0,0 +1,17 @@
+namespace Passwordless.Common.Services.Mail.Aws;
+
+public class AwsMailProviderOptions : BaseMailProviderOptions
+{
+    public const string Provider = "aws";
+
+    public AwsMailProviderOptions()
+    {
+        Name = Provider;
+    }
+
+    public string AccessKey { get; set; }
+
+    public string SecretKey { get; set; }
+
+    public string Region { get; set; }
+}

src/Common/Services/Mail/BaseMailProviderOptions.cs

@@ -0,0 +1,9 @@
+namespace Passwordless.Common.Services.Mail;
+
+public abstract class BaseMailProviderOptions
+{
+    /// <summary>
+    /// The name of the provider.
+    /// </summary>
+    public string Name { get; set; }
+}