Merge pull request 'Refactored the S3 services to properly upload the file' (#34) from s3service into master

Reviewed-on: #34

LiteCharms.Features.Tests/CommonFixture.cs

@@ -14,18 +14,20 @@ public class CommonFixture : IDisposable
     {
         Configuration = new ConfigurationBuilder()
             .SetBasePath(Directory.GetCurrentDirectory())
-            .AddJsonFile("appsettings.json")
             .AddUserSecrets<CommonFixture>()
+            .AddJsonFile(Path.Combine(Directory.GetCurrentDirectory(), "appsettings.json"), optional: true, reloadOnChange: true)
             .AddEnvironmentVariables()
             .Build();
 
-        Services = new ServiceCollection()
+        Services = new ServiceCollection()            
             .AddMediator()
             .AddLogging()
             .AddShopServices()
             .AddEmailServiceBus()
+            .AddGarageS3(Configuration)
             .AddShopDatabase(Configuration)
             .AddEmailServices(Configuration)
+            .AddSingleton(Configuration)
             .BuildServiceProvider();
 
         Mediator = Services.GetRequiredService<IMediator>();

LiteCharms.Features.Tests/LiteCharms.Features.Tests.csproj

@@ -27,10 +27,10 @@
 
   <!-- Global Usings -->
   <ItemGroup>
-    <Using Include="Mediator"/>
+    <Using Include="Mediator" />
-    <Using Include="Xunit.Abstractions"/>
+    <Using Include="Xunit.Abstractions" />
-    <Using Include="Microsoft.Extensions.DependencyInjection"/>
+    <Using Include="Microsoft.Extensions.DependencyInjection" />
-    <Using Include="Microsoft.Extensions.Configuration"/>
+    <Using Include="Microsoft.Extensions.Configuration" />
   </ItemGroup>
 
   <ItemGroup>
@@ -43,7 +43,7 @@
 
   <ItemGroup>
     <None Update="appsettings.json">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
   </ItemGroup>
 

LiteCharms.Features.Tests/S3ServiceFeatureTests.cs

@@ -0,0 +1,28 @@
+using LiteCharms.Features.S3.Abstractions;
+
+namespace LiteCharms.Features.Tests;
+
+public class S3ServiceFeatureTests(CommonFixture fixture, ITestOutputHelper output) : IClassFixture<CommonFixture>
+{
+    [Fact]
+    public async Task BookshopS3Service_MustReturnUrl()
+    {
+        var service = fixture.Services.GetKeyedService<IS3Service>(S3.Constants.BookshopQuotesBucketName);
+
+        var fileName = "appsettings.json";
+
+        string path = Path.Combine(Directory.GetCurrentDirectory(), fileName);
+
+        Assert.True(File.Exists(path));
+
+        var stream = File.OpenRead(path);
+
+        var result = await service!.UploadFileAsync(fileName, stream, MimeKit.MimeTypes.GetMimeType(fileName));
+
+        Assert.True(result.IsSuccess);
+        Assert.NotNull(result.Value);
+        Assert.NotEmpty(result.Value);
+
+        output.WriteLine(result.Value);        
+    }
+}

LiteCharms.Features.Tests/appsettings.json

@@ -1,4 +1,16 @@
 {
+  "BookshopS3Settings": {
+    "ServiceUrl": "http://192.168.1.177:30900",
+    "Region": "garage",
+    "BucketName": "bookshop",
+    "CdnBaseUrl": "https://bookshop.cdn.khongisa.co.za"
+  },
+  "BookshopQuotesS3Settings": {
+    "ServiceUrl": "http://192.168.1.177:30900",
+    "Region": "garage",
+    "BucketName": "bookshop.quotes",
+    "CdnBaseUrl": "https://bookshop.quotes.cdn.khongisa.co.za"
+  },
   "Email": {
     "Credentials": {
       "Username": "shop@litecharms.co.za"

LiteCharms.Features/Extensions/S3.cs

@@ -1,30 +1,63 @@
-using Amazon.Runtime;
+using LiteCharms.Features.S3;
-using LiteCharms.Features.S3;
+using LiteCharms.Features.S3.Abstractions;
-using LiteCharms.Features.S3.Configuration;
+using static LiteCharms.Features.S3.Constants;
 
 namespace LiteCharms.Features.Extensions;
 
 public static class S3
 {
     public static IServiceCollection AddGarageS3(this IServiceCollection services, IConfiguration configuration)
-    {
+    {        
-        var optionsSection = configuration.GetSection(nameof(S3Settings));
+        if (!string.IsNullOrWhiteSpace(configuration.GetSection($"{BookshopS3SettingsSection}:ServiceUrl").Value))
-        services.Configure<S3Settings>(optionsSection);
-
-        var options = optionsSection.Get<S3Settings>()
-            ?? throw new InvalidOperationException("S3 configuration section is missing.");
-
-        var credentials = new BasicAWSCredentials(options.AccessKey, options.SecretKey);
-
-        var s3Config = new AmazonS3Config
         {
-            ServiceURL = options.ServiceUrl,
+            services.AddKeyedSingleton<IAmazonS3, AmazonS3Client>(BookshopBucketName, (provider, client) =>
-            AuthenticationRegion = options.Region,            
+                new AmazonS3Client(new BasicAWSCredentials(configuration.GetSection($"{BookshopS3SettingsSection}:AccessKey").Value,
-            ForcePathStyle = true,
+                configuration.GetSection($"{BookshopS3SettingsSection}:SecretKey").Value),
-        };
+                new AmazonS3Config
+                {
+                    ServiceURL = configuration.GetSection($"{BookshopS3SettingsSection}:ServiceUrl").Value,
+                    AuthenticationRegion = configuration.GetSection($"{BookshopS3SettingsSection}:Region").Value,
+                    ForcePathStyle = true,
+                    EndpointDiscoveryEnabled = true,
+                    UseHttp = configuration.GetSection($"{BookshopS3SettingsSection}:ServiceUrl").Value!.Contains("http://")
+                }));
 
-        services.AddSingleton<IAmazonS3>(new AmazonS3Client(credentials, s3Config));
+            services.AddKeyedScoped<IS3Service, BookshopS3Service>(BookshopBucketName); 
-        services.AddScoped<S3Service>();
+        }
+
+        if (!string.IsNullOrWhiteSpace(configuration.GetSection($"{BookshopInvoicesS3SettingsSection}:ServiceUrl").Value))
+        {
+            services.AddKeyedSingleton<IAmazonS3, AmazonS3Client>(BookshopInvoicesBucketName, (provider, client) =>
+                new AmazonS3Client(new BasicAWSCredentials(configuration.GetSection($"{BookshopInvoicesS3SettingsSection}:AccessKey").Value,
+                configuration.GetSection($"{BookshopInvoicesS3SettingsSection}:SecretKey").Value),
+                new AmazonS3Config
+                {
+                    ServiceURL = configuration.GetSection($"{BookshopInvoicesS3SettingsSection}:ServiceUrl").Value,
+                    AuthenticationRegion = configuration.GetSection($"{BookshopInvoicesS3SettingsSection}:Region").Value,
+                    ForcePathStyle = true,
+                    EndpointDiscoveryEnabled = true,
+                    UseHttp = configuration.GetSection($"{BookshopS3SettingsSection}:ServiceUrl").Value!.Contains("http://")
+                }));
+
+            services.AddKeyedScoped<IS3Service, BookshopInvoicesS3Service>(BookshopInvoicesBucketName);
+        }
+
+        if (!string.IsNullOrWhiteSpace(configuration.GetSection($"{BookshopQuotesS3SettingsSection}:ServiceUrl").Value))
+        {
+            services.AddKeyedSingleton<IAmazonS3, AmazonS3Client>(BookshopQuotesBucketName, (provider, client) =>
+                new AmazonS3Client(new BasicAWSCredentials(configuration.GetSection($"{BookshopQuotesS3SettingsSection}:AccessKey").Value,
+                configuration.GetSection($"{BookshopQuotesS3SettingsSection}:SecretKey").Value),
+                new AmazonS3Config
+                {
+                    ServiceURL = configuration.GetSection($"{BookshopQuotesS3SettingsSection}:ServiceUrl").Value,
+                    AuthenticationRegion = configuration.GetSection($"{BookshopQuotesS3SettingsSection}:Region").Value,
+                    ForcePathStyle = true,
+                    EndpointDiscoveryEnabled = true,
+                    UseHttp = configuration.GetSection($"{BookshopS3SettingsSection}:ServiceUrl").Value!.Contains("http://")
+                }));
+
+            services.AddKeyedScoped<IS3Service, BookshopQuotesS3Service>(BookshopQuotesBucketName);
+        }
 
         return services;
     }

LiteCharms.Features/LiteCharms.Features.csproj

@@ -137,6 +137,7 @@
     <!-- global Usings -->
     <Using Include="Amazon.S3" />
     <Using Include="Amazon.S3.Model" />
+    <Using Include="Amazon.Runtime" />
   </ItemGroup>
 
   <!-- Shared Usings -->

LiteCharms.Features/S3/Abstractions/IS3Service.cs

@@ -0,0 +1,6 @@
+namespace LiteCharms.Features.S3.Abstractions;
+
+public interface IS3Service
+{
+    Task<Result<string>> UploadFileAsync(string fileName, Stream fileStream, string contentType, CancellationToken cancellationToken = default);
+}

LiteCharms.Features/S3/Abstractions/S3ServiceBase.cs

@@ -0,0 +1,42 @@
+namespace LiteCharms.Features.S3.Abstractions;
+
+public abstract class S3ServiceBase(IAmazonS3 amazonS3)
+{
+    protected readonly IAmazonS3 Client = amazonS3;
+
+    protected abstract string BucketName { get; }
+    protected abstract string CdnBaseUrl { get; }
+
+    public virtual async Task<Result<string>> UploadFileAsync(string fileName, Stream fileStream, string contentType, CancellationToken cancellationToken = default)
+    {
+        try
+        {
+            if (string.IsNullOrWhiteSpace(BucketName))
+                return Result.Fail<string>("Bucket name is not configured.");
+
+            if (string.IsNullOrWhiteSpace(CdnBaseUrl))
+                return Result.Fail<string>("CDN base URL is not configured.");
+
+            var fileKey = $"{Guid.NewGuid():N}{Path.GetExtension(fileName)}";
+
+            var putRequest = new PutObjectRequest
+            {
+                BucketName = BucketName,
+                Key = fileKey,
+                InputStream = fileStream,
+                ContentType = contentType,
+                UseChunkEncoding = false
+            };
+
+            var response = await Client.PutObjectAsync(putRequest, cancellationToken);
+
+            return response.HttpStatusCode != System.Net.HttpStatusCode.OK
+                ? Result.Fail<string>($"Failed to upload {fileName} to S3.")
+                : Result.Ok($"{CdnBaseUrl}/{fileKey}");
+        }
+        catch (Exception ex)
+        {
+            return Result.Fail<string>(new Error($"Error uploading {fileName} to S3: {ex.Message}").CausedBy(ex));
+        }
+    }
+}

LiteCharms.Features/S3/BookshopInvoicesS3Service.cs

@@ -0,0 +1,11 @@
+using LiteCharms.Features.S3.Abstractions;
+using static LiteCharms.Features.S3.Constants;
+
+namespace LiteCharms.Features.S3;
+
+public class BookshopInvoicesS3Service(IConfiguration configuration, [FromKeyedServices(BookshopInvoicesBucketName)] IAmazonS3 amazonS3) :
+    S3ServiceBase(amazonS3), IS3Service
+{
+    protected override string BucketName => configuration.GetSection($"{BookshopInvoicesS3SettingsSection}:BucketName").Value ?? "";
+    protected override string CdnBaseUrl => configuration.GetSection($"{BookshopInvoicesS3SettingsSection}:CdnBaseUrl").Value ?? "";
+}

LiteCharms.Features/S3/BookshopQuotesS3Service.cs

@@ -0,0 +1,11 @@
+using LiteCharms.Features.S3.Abstractions;
+using static LiteCharms.Features.S3.Constants;
+
+namespace LiteCharms.Features.S3;
+
+public class BookshopQuotesS3Service(IConfiguration configuration, [FromKeyedServices(BookshopQuotesBucketName)] IAmazonS3 amazonS3) :
+    S3ServiceBase(amazonS3), IS3Service
+{
+    protected override string BucketName => configuration.GetSection($"{BookshopQuotesS3SettingsSection}:BucketName").Value ?? "";
+    protected override string CdnBaseUrl => configuration.GetSection($"{BookshopQuotesS3SettingsSection}:CdnBaseUrl").Value ?? "";
+}

LiteCharms.Features/S3/BookshopS3Service.cs

@@ -0,0 +1,11 @@
+using LiteCharms.Features.S3.Abstractions;
+using static LiteCharms.Features.S3.Constants;
+
+namespace LiteCharms.Features.S3;
+
+public class BookshopS3Service(IConfiguration configuration, [FromKeyedServices(BookshopBucketName)] IAmazonS3 amazonS3) :
+    S3ServiceBase(amazonS3), IS3Service
+{
+    protected override string BucketName => configuration.GetSection($"{BookshopS3SettingsSection}:BucketName").Value ?? "";
+    protected override string CdnBaseUrl => configuration.GetSection($"{BookshopS3SettingsSection}:CdnBaseUrl").Value ?? "";
+}

LiteCharms.Features/S3/Configuration/S3Settings.cs

@@ -11,4 +11,6 @@ public class S3Settings
     public string? BucketName { get; set; }
 
     public string? Region { get; set; }
+
+    public string? CdnBaseUrl { get; set; }
 }

LiteCharms.Features/S3/Constants.cs

@@ -0,0 +1,12 @@
+namespace LiteCharms.Features.S3;
+
+public static class Constants
+{
+    public const string BookshopS3SettingsSection = "BookshopS3Settings";
+    public const string BookshopInvoicesS3SettingsSection = "BookshopInvoicesS3Settings";
+    public const string BookshopQuotesS3SettingsSection = "BookshopQuotesS3Settings";
+
+    public const string BookshopBucketName = "bookshop";
+    public const string BookshopInvoicesBucketName = "bookshop.invoices";
+    public const string BookshopQuotesBucketName = "bookshop.quotes";
+}

LiteCharms.Features/S3/S3Service.cs

@@ -1,28 +0,0 @@
-namespace LiteCharms.Features.S3;
-
-public class S3Service(IAmazonS3 amazonS3)
-{
-    public async Task<Result<string>> UploadFileAsync(string bucketName, string fileName, Stream fileStream, string contentType, string cdnBaseUrl, CancellationToken cancellationToken = default)
-    {
-        try
-        {
-            var putRequest = new PutObjectRequest
-            {
-                BucketName = bucketName,
-                Key = fileName,
-                InputStream = fileStream,
-                ContentType = contentType
-            };
-
-            var response = await amazonS3.PutObjectAsync(putRequest, cancellationToken);
-
-            return response.HttpStatusCode != System.Net.HttpStatusCode.OK
-                ? Result.Fail<string>($"Failed to upload {fileName} to S3.")
-                : Result.Ok(string.Format(cdnBaseUrl, bucketName, fileName));
-        }
-        catch (Exception ex)
-        {
-            return Result.Fail<string>(new Error($"Error uploading {fileName} to S3: {ex.Message}").CausedBy(ex));
-        }
-    }
-}