Use Brevo Rest API (leaderboardsgg#218)

* Add brevo csharp client.

* Add Brevo options.

* Add Brevo service.

* Replace EmailSender with BrevoService.

* Update TestApiFactory to mock Brevo.

* Mark EmailSender as Obsolete.

* formatting

LeaderboardBackend.Test/Features/Emails/EmailSenderTests.cs

@@ -13,6 +13,8 @@
 
 namespace LeaderboardBackend.Test.Features.Emails;
 
+[Obsolete("EmailSender is no longer used.")]
+[Ignore("EmailSender is no longer used.")]
 public class EmailSenderTests
 {
     private IEmailSender _sut = null!;

LeaderboardBackend.Test/TestApi/TestApiFactory.cs

@@ -1,8 +1,8 @@
 using System;
 using System.Net.Http;
 using LeaderboardBackend.Models.Entities;
+using LeaderboardBackend.Services;
 using LeaderboardBackend.Test.Lib;
-using MailKit.Net.Smtp;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.AspNetCore.Mvc.Testing;
 using Microsoft.Extensions.DependencyInjection;
@@ -41,8 +41,7 @@ protected override void ConfigureWebHost(IWebHostBuilder builder)
                 };
             });
 
-            // mock SMTP client
-            services.Replace(ServiceDescriptor.Transient<ISmtpClient>(_ => new Mock<ISmtpClient>().Object));
+            services.Replace(ServiceDescriptor.Singleton(_ => new Mock<IEmailSender>().Object));
 
             using IServiceScope scope = services.BuildServiceProvider().CreateScope();
             ApplicationContext dbContext =

LeaderboardBackend/LeaderboardBackend.csproj

@@ -24,6 +24,7 @@
 
   <ItemGroup>
     <PackageReference Include="BCrypt.Net-Next" Version="4.0.3" />
+    <PackageReference Include="brevo_csharp" Version="1.0.0" />
     <PackageReference Include="DotNetEnv" Version="3.0.0" />
     <PackageReference Include="EFCore.NamingConventions" Version="8.0.3" />
     <PackageReference Include="FluentValidation" Version="11.9.2" />

LeaderboardBackend/Program.cs

@@ -12,7 +12,6 @@
 using LeaderboardBackend.Models.Entities;
 using LeaderboardBackend.Services;
 using LeaderboardBackend.Swagger;
-using MailKit.Net.Smtp;
 using Microsoft.AspNetCore.Authentication.JwtBearer;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Mvc;
@@ -34,7 +33,7 @@
 {
     AppConfig? appConfigWithoutDotEnv = builder.Configuration.Get<AppConfig>();
     EnvConfigurationSource dotEnvSource =
-        new(new string[] { appConfigWithoutDotEnv?.EnvPath ?? ".env" }, LoadOptions.NoClobber());
+        new([appConfigWithoutDotEnv?.EnvPath ?? ".env"], LoadOptions.NoClobber());
     builder.Configuration.Sources.Insert(0, dotEnvSource); // all other configuration providers override .env
 }
 
@@ -48,8 +47,8 @@
     .ValidateOnStart();
 
 builder.Services
-    .AddOptions<EmailSenderConfig>()
-    .BindConfiguration(EmailSenderConfig.KEY)
+    .AddOptions<BrevoOptions>()
+    .BindConfiguration(BrevoOptions.KEY)
     .ValidateFluentValidation()
     .ValidateOnStart();
 
@@ -104,33 +103,26 @@
 builder.Services.AddScoped<IAccountConfirmationService, AccountConfirmationService>();
 builder.Services.AddScoped<IAccountRecoveryService, AccountRecoveryService>();
 builder.Services.AddScoped<IRunService, RunService>();
-builder.Services.AddSingleton<IEmailSender, EmailSender>();
-builder.Services.AddSingleton<ISmtpClient>(_ => new SmtpClient() { Timeout = 3000 });
+builder.Services.AddSingleton<IEmailSender, BrevoService>();
 builder.Services.AddSingleton<IClock>(_ => SystemClock.Instance);
 
 AppConfig? appConfig = builder.Configuration.Get<AppConfig>();
 if (!string.IsNullOrWhiteSpace(appConfig?.AllowedOrigins))
 {
-    builder.Services.AddCors(options =>
-    {
-        options.AddDefaultPolicy(
+    builder.Services.AddCors(options => options.AddDefaultPolicy(
             policy =>
                 policy
                     .WithOrigins(appConfig.ParseAllowedOrigins())
                     .SetIsOriginAllowedToAllowWildcardSubdomains()
                     .AllowAnyMethod()
                     .AllowAnyHeader()
-        );
-    });
+        ));
 }
 else if (builder.Environment.IsDevelopment())
 {
-    builder.Services.AddCors(options =>
-    {
-        options.AddDefaultPolicy(
+    builder.Services.AddCors(options => options.AddDefaultPolicy(
             policy => policy.AllowAnyOrigin().AllowAnyMethod().AllowAnyHeader()
-        );
-    });
+        ));
 }
 
 // Add controllers to the container.
@@ -237,19 +229,14 @@
         }
 )
     .SetDefaultPolicy(new AuthorizationPolicyBuilder()
-        .AddAuthenticationSchemes(new[] { JwtBearerDefaults.AuthenticationScheme })
+        .AddAuthenticationSchemes(JwtBearerDefaults.AuthenticationScheme)
         .RequireAuthenticatedUser()
         .AddRequirements(new[] { new UserTypeRequirement(UserTypes.USER) })
         .Build());
 
 builder.Services.AddSingleton<IValidatorInterceptor, LeaderboardBackend.Models.Validation.UseErrorCodeInterceptor>();
-builder.Services.AddFluentValidationAutoValidation(c =>
-{
-    c.DisableDataAnnotationsValidation = true;
-});
-builder.Services.Configure<ApiBehaviorOptions>(options =>
-{
-    options.InvalidModelStateResponseFactory = context =>
+builder.Services.AddFluentValidationAutoValidation(c => c.DisableDataAnnotationsValidation = true);
+builder.Services.Configure<ApiBehaviorOptions>(options => options.InvalidModelStateResponseFactory = context =>
     {
         ValidationProblemDetails problemDetails = new(context.ModelState);
 
@@ -258,14 +245,13 @@
         // For JSON syntax errors that we don't override, their keys will be the field
         // path that has the error, which always starts with "$", denoting the object
         // root. We check for that, and return the error code accordingly. - zysim
-        if (problemDetails.Errors.Keys.Any(x => x.StartsWith("$")))
+        if (problemDetails.Errors.Keys.Any(x => x.StartsWith('$')))
         {
             return new BadRequestObjectResult(problemDetails);
         }
 
         return new UnprocessableEntityObjectResult(problemDetails);
-    };
-});
+    });
 
 // Can't use AddSingleton here since we call the DB in the Handler
 builder.Services.AddScoped<IAuthorizationHandler, UserTypeAuthorizationHandler>();
@@ -278,6 +264,9 @@
 #region WebApplication
 WebApplication app = builder.Build();
 
+BrevoOptions brevoOptions = app.Services.GetRequiredService<IOptionsMonitor<BrevoOptions>>().CurrentValue;
+brevo_csharp.Client.Configuration.Default.AddApiKey("api-key", brevoOptions.ApiKey);
+
 // Configure the HTTP request pipeline.
 app.UseSwagger();
 app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "LeaderboardBackend v1"));

LeaderboardBackend/Services/Impl/BrevoOptions.cs

@@ -0,0 +1,20 @@
+using FluentValidation;
+
+namespace LeaderboardBackend.Services;
+
+public class BrevoOptions
+{
+    public const string KEY = "Brevo";
+    public string ApiKey { get; set; } = string.Empty;
+    public required string SenderName { get; set; }
+    public required string SenderEmail { get; set; }
+}
+
+public class BrevoOptionsValidator : AbstractValidator<BrevoOptions>
+{
+    public BrevoOptionsValidator()
+    {
+        RuleFor(x => x.SenderName).NotEmpty();
+        RuleFor(x => x.SenderEmail).EmailAddress();
+    }
+}

LeaderboardBackend/Services/Impl/BrevoService.cs

@@ -0,0 +1,18 @@
+using brevo_csharp.Api;
+using brevo_csharp.Model;
+using Microsoft.Extensions.Options;
+
+namespace LeaderboardBackend.Services;
+
+public class BrevoService(IOptions<BrevoOptions> options, ILogger<BrevoService> logger) : IEmailSender
+{
+    private readonly TransactionalEmailsApi _transactionalEmailsApi = new();
+    private readonly SendSmtpEmailSender _smtpEmailSender = new(options.Value.SenderName, options.Value.SenderEmail);
+
+    public async System.Threading.Tasks.Task EnqueueEmailAsync(string recipientAddress, string subject, string htmlMessage)
+    {
+        SendSmtpEmail email = new(_smtpEmailSender, [new(recipientAddress)], null, null, htmlMessage, null, subject);
+        CreateSmtpEmail result = await _transactionalEmailsApi.SendTransacEmailAsync(email);
+        logger.LogInformation("Email sent with id {Id}", result.MessageId);
+    }
+}

LeaderboardBackend/Services/Impl/EmailSender.cs

@@ -4,6 +4,7 @@
 
 namespace LeaderboardBackend.Services;
 
+[Obsolete("Replaced by BrevoService")]
 public class EmailSender : IEmailSender
 {
     private readonly EmailSenderConfig _config;

LeaderboardBackend/appsettings.json

@@ -7,9 +7,9 @@
 	},
 	"EnvPath": ".env",
 	"AllowedHosts": "*",
-	"EmailSender": {
+	"Brevo": {
 		"SenderName": "Leaderboards.gg",
-		"SenderAddress": "[email protected]"
+		"SenderEmail": "[email protected]"
 	},
   "Feature": {
     "AccountRecovery": true,

example.env

@@ -14,9 +14,6 @@ ApplicationContext__PG__PORT=5432
 JWT__KEY=coolsecretkeywowitssoincredibleiloveit
 JWT__ISSUER=leaderboards.gg
 
-EmailSender__Smtp__Host=smtp-relay.sendinblue.com
-EmailSender__Smtp__Port=587
-EmailSender__Smtp__Username=User42
-EmailSender__Smtp__Password=Password123
-
 ADMINER_PORT=1337
+
+Brevo__ApiKey=my-brevo-api-key