Merge branch 'main' into sn/update-shared-infra

Author: stefannikolei

.github/workflows/build-and-test.yml

@@ -95,14 +95,14 @@ jobs:
         shell: bash
         run: |
           sudo npm install -g azurite
-          sudo azurite --loose &
+          sudo azurite --loose --skipApiVersionCheck &
 
       - name: Azurite Setup Windows
         if: matrix.options.os == 'windows-latest'
         shell: bash
         run: |
           npm install -g azurite
-          azurite --loose &
+          azurite --loose --skipApiVersionCheck &
 
       - name: S3rver Setup
         if: matrix.options.os != 'windows-latest'

ImageSharp.Web.sln

@@ -16,6 +16,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "_root", "_root", "{C317F1B1
 		Directory.Build.targets = Directory.Build.targets
 		LICENSE = LICENSE
 		README.md = README.md
+		SixLabors.ImageSharp.Web.props = SixLabors.ImageSharp.Web.props
 		shared-infrastructure\SixLabors.ruleset = shared-infrastructure\SixLabors.ruleset
 		shared-infrastructure\SixLabors.Tests.ruleset = shared-infrastructure\SixLabors.Tests.ruleset
 		shared-infrastructure\stylecop.json = shared-infrastructure\stylecop.json

README.md

@@ -90,7 +90,7 @@ On Windows to install and run the server as a background process run the followi
 
 ```bash
 npm install -g azurite
-start /B azurite --loose
+start /B azurite --loose --skipApiVersionCheck
 
 npm install -g s3rver
 start /B s3rver -d .
@@ -100,7 +100,7 @@ On Linux
 
 ```bash
 sudo npm install -g azurite
-sudo azurite --loose &
+sudo azurite --loose --skipApiVersionCheck &
 
 sudo npm install -g s3rver
 sudo s3rver -d . &

SixLabors.ImageSharp.Web.props

@@ -2,7 +2,7 @@
 <Project>
 
   <!--Add common namespaces to implicit global usings if enabled.-->
-  <ItemGroup Condition="'$(ImplicitUsings)'=='enable' OR '$(ImplicitUsings)'=='true'">
+  <ItemGroup Condition="'$(UseImageSharp)'=='enable' OR '$(UseImageSharp)'=='true'">
     <Using Include="SixLabors.ImageSharp" />
     <Using Include="SixLabors.ImageSharp.Processing" />
     <Using Include="SixLabors.ImageSharp.Web" />

samples/ImageSharp.Web.Sample/Pages/Index.cshtml

@@ -52,10 +52,10 @@
         </div>
         <div>
             <p>
-                <code>sixlabors.imagesharp.web.svg?width=300</code>
+                <code>sixlabors.imagesharp.web.svg?width=300&format=jpg</code>
             </p>
             <p>
-                <img src="sixlabors.imagesharp.web.svg" imagesharp-width="300" />
+            <img src="sixlabors.imagesharp.web.svg" imagesharp-width="300" imagesharp-format="Format.Jpg" />
             </p>
         </div>
     </section>

samples/ImageSharp.Web.Sample/Pages/_ViewImports.cshtml

@@ -1,3 +1,6 @@
+@using SixLabors.ImageSharp
+@using SixLabors.ImageSharp.Processing
+@using SixLabors.ImageSharp.Web
 @using ImageSharp.Web.Sample
 @namespace ImageSharp.Web.Sample.Pages
 @addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers

src/ImageSharp.Web.Providers.AWS/AmazonS3BucketClient.cs

@@ -0,0 +1,56 @@
+// Copyright (c) Six Labors.
+// Licensed under the Six Labors Split License.
+
+using Amazon.S3;
+
+namespace SixLabors.ImageSharp.Web;
+
+/// <summary>
+/// Represents a scoped Amazon S3 client instance that is explicitly associated with a single S3 bucket.
+/// This wrapper provides a strongly-typed link between the client and the bucket it operates on,
+/// and optionally manages the lifetime of the underlying <see cref="AmazonS3Client"/>.
+/// </summary>
+public sealed class AmazonS3BucketClient : IDisposable
+{
+    private readonly bool disposeClient;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="AmazonS3BucketClient"/> class.
+    /// </summary>
+    /// <param name="bucketName">
+    /// The bucket name associated with this client instance.
+    /// </param>
+    /// <param name="client">
+    /// The underlying Amazon S3 client instance. This should be an already configured instance of <see cref="AmazonS3Client"/>.
+    /// </param>
+    /// <param name="disposeClient">
+    /// A value indicating whether the underlying client should be disposed when this instance is disposed.
+    /// </param>
+    public AmazonS3BucketClient(string bucketName, AmazonS3Client client, bool disposeClient = true)
+    {
+        Guard.NotNullOrWhiteSpace(bucketName, nameof(bucketName));
+        Guard.NotNull(client, nameof(client));
+        this.BucketName = bucketName;
+        this.Client = client;
+        this.disposeClient = disposeClient;
+    }
+
+    /// <summary>
+    /// Gets the bucket name associated with this client instance.
+    /// </summary>
+    public string BucketName { get; }
+
+    /// <summary>
+    /// Gets the underlying Amazon S3 client instance.
+    /// </summary>
+    public AmazonS3Client Client { get; }
+
+    /// <inheritdoc/>
+    public void Dispose()
+    {
+        if (this.disposeClient)
+        {
+            this.Client.Dispose();
+        }
+    }
+}

src/ImageSharp.Web.Providers.AWS/AmazonS3ClientFactory.cs

@@ -18,7 +18,7 @@ internal static class AmazonS3ClientFactory
     /// A new <see cref="AmazonS3Client"/>.
     /// </returns>
     /// <exception cref="ArgumentException">Invalid configuration.</exception>
-    public static AmazonS3Client CreateClient(IAWSS3BucketClientOptions options)
+    public static AmazonS3BucketClient CreateClient(IAWSS3BucketClientOptions options)
     {
         if (!string.IsNullOrWhiteSpace(options.Endpoint))
         {
@@ -27,7 +27,7 @@ public static AmazonS3Client CreateClient(IAWSS3BucketClientOptions options)
             // PathStyle endpoint doesn't support AccelerateEndpoint.
             AmazonS3Config config = new() { ServiceURL = options.Endpoint, ForcePathStyle = true, AuthenticationRegion = options.Region };
             SetTimeout(config, options.Timeout);
-            return new AmazonS3Client(options.AccessKey, options.AccessSecret, config);
+            return new(options.BucketName, new AmazonS3Client(options.AccessKey, options.AccessSecret, config));
         }
         else if (!string.IsNullOrWhiteSpace(options.AccessKey))
         {
@@ -36,14 +36,14 @@ public static AmazonS3Client CreateClient(IAWSS3BucketClientOptions options)
             RegionEndpoint region = RegionEndpoint.GetBySystemName(options.Region);
             AmazonS3Config config = new() { RegionEndpoint = region, UseAccelerateEndpoint = options.UseAccelerateEndpoint };
             SetTimeout(config, options.Timeout);
-            return new AmazonS3Client(options.AccessKey, options.AccessSecret, config);
+            return new(options.BucketName, new AmazonS3Client(options.AccessKey, options.AccessSecret, config));
         }
         else if (!string.IsNullOrWhiteSpace(options.Region))
         {
             RegionEndpoint region = RegionEndpoint.GetBySystemName(options.Region);
             AmazonS3Config config = new() { RegionEndpoint = region, UseAccelerateEndpoint = options.UseAccelerateEndpoint };
             SetTimeout(config, options.Timeout);
-            return new AmazonS3Client(config);
+            return new(options.BucketName, new AmazonS3Client(config));
         }
         else
         {

src/ImageSharp.Web.Providers.AWS/Caching/AWSS3StorageCache.cs

@@ -13,22 +13,29 @@ namespace SixLabors.ImageSharp.Web.Caching.AWS;
 /// <summary>
 /// Implements an AWS S3 Storage based cache.
 /// </summary>
-public class AWSS3StorageCache : IImageCache
+public class AWSS3StorageCache : IImageCache, IDisposable
 {
-    private readonly AmazonS3Client amazonS3Client;
+    private readonly AmazonS3BucketClient amazonS3Client;
     private readonly string bucketName;
     private readonly string cacheFolder;
+    private bool isDisposed;
 
     /// <summary>
     /// Initializes a new instance of the <see cref="AWSS3StorageCache"/> class.
     /// </summary>
     /// <param name="cacheOptions">The cache options.</param>
-    public AWSS3StorageCache(IOptions<AWSS3StorageCacheOptions> cacheOptions)
+    /// <param name="serviceProvider">The current service provider.</param>
+    public AWSS3StorageCache(IOptions<AWSS3StorageCacheOptions> cacheOptions, IServiceProvider serviceProvider)
     {
         Guard.NotNull(cacheOptions, nameof(cacheOptions));
         AWSS3StorageCacheOptions options = cacheOptions.Value;
-        this.bucketName = options.BucketName;
-        this.amazonS3Client = AmazonS3ClientFactory.CreateClient(options);
+
+        this.amazonS3Client =
+            options.S3ClientFactory?.Invoke(options, serviceProvider)
+            ?? AmazonS3ClientFactory.CreateClient(options);
+
+        this.bucketName = this.amazonS3Client.BucketName;
+
         this.cacheFolder = string.IsNullOrEmpty(options.CacheFolder)
             ? string.Empty
             : options.CacheFolder.Trim().Trim('/') + '/';
@@ -42,8 +49,8 @@ public AWSS3StorageCache(IOptions<AWSS3StorageCacheOptions> cacheOptions)
         try
         {
             // HEAD request throws a 404 if not found.
-            MetadataCollection metadata = (await this.amazonS3Client.GetObjectMetadataAsync(request)).Metadata;
-            return new AWSS3StorageCacheResolver(this.amazonS3Client, this.bucketName, keyWithFolder, metadata);
+            MetadataCollection metadata = (await this.amazonS3Client.Client.GetObjectMetadataAsync(request)).Metadata;
+            return new AWSS3StorageCacheResolver(this.amazonS3Client.Client, this.bucketName, keyWithFolder, metadata);
         }
         catch
         {
@@ -60,15 +67,16 @@ public Task SetAsync(string key, Stream stream, ImageCacheMetadata metadata)
             Key = this.GetKeyWithFolder(key),
             ContentType = metadata.ContentType,
             InputStream = stream,
-            AutoCloseStream = false
+            AutoCloseStream = false,
+            UseChunkEncoding = false
         };
 
         foreach (KeyValuePair<string, string> d in metadata.ToDictionary())
         {
             request.Metadata.Add(d.Key, d.Value);
         }
 
-        return this.amazonS3Client.PutObjectAsync(request);
+        return this.amazonS3Client.Client.PutObjectAsync(request);
     }
 
     /// <summary>
@@ -86,16 +94,38 @@ public Task SetAsync(string key, Stream stream, ImageCacheMetadata metadata)
     /// If the bucket does not already exist, a <see cref="PutBucketResponse"/> describing the newly
     /// created bucket. If the container already exists, <see langword="null"/>.
     /// </returns>
-    public static PutBucketResponse? CreateIfNotExists(
-        AWSS3StorageCacheOptions options,
-        S3CannedACL acl)
+    public static PutBucketResponse? CreateIfNotExists(AWSS3StorageCacheOptions options, S3CannedACL acl)
         => AsyncHelper.RunSync(() => CreateIfNotExistsAsync(options, acl));
 
-    private static async Task<PutBucketResponse?> CreateIfNotExistsAsync(
-        AWSS3StorageCacheOptions options,
-        S3CannedACL acl)
+    /// <summary>
+    /// Releases the unmanaged resources used by the <see cref="AWSS3StorageCache"/> and optionally releases the managed resources.
+    /// </summary>
+    /// <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
+    protected virtual void Dispose(bool disposing)
+    {
+        if (!this.isDisposed)
+        {
+            if (disposing)
+            {
+                this.amazonS3Client?.Dispose();
+            }
+
+            this.isDisposed = true;
+        }
+    }
+
+    /// <inheritdoc/>
+    public void Dispose()
+    {
+        // Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
+        this.Dispose(disposing: true);
+        GC.SuppressFinalize(this);
+    }
+
+    private static async Task<PutBucketResponse?> CreateIfNotExistsAsync(AWSS3StorageCacheOptions options, S3CannedACL acl)
     {
-        AmazonS3Client client = AmazonS3ClientFactory.CreateClient(options);
+        using AmazonS3BucketClient bucketClient = AmazonS3ClientFactory.CreateClient(options);
+        AmazonS3Client client = bucketClient.Client;
 
         bool foundBucket = false;
         ListBucketsResponse listBucketsResponse = await client.ListBucketsAsync();
@@ -141,7 +171,7 @@ private static readonly TaskFactory TaskFactory
         /// <summary>
         /// Executes an async <see cref="Task"/> method synchronously.
         /// </summary>
-        /// <param name="task">The task to excecute.</param>
+        /// <param name="task">The task to execute.</param>
         public static void RunSync(Func<Task> task)
         {
             CultureInfo cultureUi = CultureInfo.CurrentUICulture;
@@ -159,7 +189,7 @@ public static void RunSync(Func<Task> task)
         /// a <paramref name="task"/> return type synchronously.
         /// </summary>
         /// <typeparam name="TResult">The type of result to return.</typeparam>
-        /// <param name="task">The task to excecute.</param>
+        /// <param name="task">The task to execute.</param>
         /// <returns>The <typeparamref name="TResult"/>.</returns>
         public static TResult RunSync<TResult>(Func<Task<TResult>> task)
         {

src/ImageSharp.Web.Providers.AWS/Caching/AWSS3StorageCacheOptions.cs

@@ -8,6 +8,9 @@ namespace SixLabors.ImageSharp.Web.Caching.AWS;
 /// </summary>
 public class AWSS3StorageCacheOptions : IAWSS3BucketClientOptions
 {
+    /// <inheritdoc/>
+    public Func<IAWSS3BucketClientOptions, IServiceProvider, AmazonS3BucketClient>? S3ClientFactory { get; set; }
+
     /// <inheritdoc/>
     public string? Region { get; set; }