Breaking change: Make S3ServiceOptions take a RegionEndpoint enumerat…

…ion instead of a string, and discard DefaultRegion from the constructor
imazen · Jun 15, 2020 · 55a5319 · 55a5319
1 parent 1fc0d39
commit 55a5319
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -64,9 +64,9 @@ namespace Imageflow.Server.Example
 
             // Make S3 containers available at /ri/ and /imageflow-resources/
             // If you use credentials, do not check them into your repository
-            services.AddImageflowS3Service(new S3ServiceOptions( RegionEndpoint.USEast1, null,null)
-                .MapPrefix("/ri/", "us-east-1", "resizer-images")
-                .MapPrefix("/imageflow-resources/", "us-west-2", "imageflow-resources"));
+            services.AddImageflowS3Service(new S3ServiceOptions( null,null)
+                .MapPrefix("/ri/", RegionEndpoint.USEast1, "resizer-images")
+                .MapPrefix("/imageflow-resources/", RegionEndpoint.USWest2, "imageflow-resources"));
 
             // Make Azure container available at /azure
             services.AddImageflowAzureBlobService(

diff --git a/examples/Imageflow.Server.Example/Startup.cs b/examples/Imageflow.Server.Example/Startup.cs
@@ -31,10 +31,10 @@ public void ConfigureServices(IServiceCollection services)
 
             // Make S3 containers available at /ri/ and /imageflow-resources/
             // If you use credentials, do not check them into your repository
-            services.AddImageflowS3Service(new S3ServiceOptions( RegionEndpoint.USEast1, null,null)
-                .MapPrefix("/ri/", "us-east-1", "resizer-images")
-                .MapPrefix("/imageflow-resources/", "us-west-2", "imageflow-resources"));
-
+            services.AddImageflowS3Service(new S3ServiceOptions( null,null)
+                .MapPrefix("/ri/", RegionEndpoint.USEast1, "resizer-images")
+                .MapPrefix("/imageflow-resources/", RegionEndpoint.USWest2, "imageflow-resources"));
+            
             // Make Azure container available at /azure
             services.AddImageflowAzureBlobService(
                 new AzureBlobServiceOptions(

diff --git a/src/Imageflow.Server.Storage.S3/PrefixMapping.cs b/src/Imageflow.Server.Storage.S3/PrefixMapping.cs
@@ -1,9 +1,11 @@
+using Amazon;
+
 namespace Imageflow.Server.Storage.S3
 {
     internal struct PrefixMapping
     {
         internal string Prefix;
-        internal string Region;
+        internal RegionEndpoint Region;
         internal string Bucket;
         internal string BlobPrefix;
     }

diff --git a/src/Imageflow.Server.Storage.S3/S3Service.cs b/src/Imageflow.Server.Storage.S3/S3Service.cs
@@ -17,17 +17,17 @@ public class S3Service : IBlobProvider
 
         private readonly List<string> prefixes = new List<string>();
 
-        private readonly AmazonS3Client client;
+        private readonly AWSCredentials credentials;
         public S3Service(S3ServiceOptions options, ILogger<S3Service> logger)
         {
 
             if (options.AccessKeyId == null)
             {
-                client = new AmazonS3Client(new AnonymousAWSCredentials(),options.DefaultRegion);
+                credentials = new AnonymousAWSCredentials();
             }
             else
             {
-                client = new AmazonS3Client(new BasicAWSCredentials(options.AccessKeyId, options.SecretAccessKey), options.DefaultRegion);
+                credentials = new  BasicAWSCredentials(options.AccessKeyId, options.SecretAccessKey);
             }
 
             foreach (var m in options.mappings)
@@ -64,6 +64,7 @@ public async Task<IBlobData> Fetch(string virtualPath)
                 : mapping.BlobPrefix + "/" + virtualPath.Substring(prefix.Length).TrimStart('/');
 
             try {
+                using var client = new AmazonS3Client(credentials, mapping.Region);
                 var req = new Amazon.S3.Model.GetObjectRequest() { BucketName = mapping.Bucket, Key = key };
 
                 var s = await client.GetObjectAsync(req);

diff --git a/src/Imageflow.Server.Storage.S3/S3ServiceOptions.cs b/src/Imageflow.Server.Storage.S3/S3ServiceOptions.cs
@@ -11,19 +11,17 @@ public class S3ServiceOptions
 
         internal readonly string AccessKeyId;
         internal readonly string SecretAccessKey;
-        internal readonly RegionEndpoint DefaultRegion;
         internal readonly List<PrefixMapping> mappings = new List<PrefixMapping>();
-        public S3ServiceOptions( RegionEndpoint defaultRegion, string accessKeyId, string secretAccessKey)
+        public S3ServiceOptions(string accessKeyId, string secretAccessKey)
         {
-            DefaultRegion = defaultRegion;
             this.AccessKeyId = accessKeyId;
             this.SecretAccessKey = secretAccessKey;
         }
 
-        public S3ServiceOptions MapPrefix(string prefix, string region, string bucket)
+        public S3ServiceOptions MapPrefix(string prefix, RegionEndpoint region, string bucket)
             => MapPrefix(prefix, region, bucket, "");
 
-        public S3ServiceOptions MapPrefix(string prefix, string region, string bucket, string blobPrefix)
+        public S3ServiceOptions MapPrefix(string prefix, RegionEndpoint region, string bucket, string blobPrefix)
         {
             prefix = prefix.TrimStart('/').TrimEnd('/');
             if (prefix.Length == 0)

diff --git a/tests/Imageflow.Server.Tests/IntegrationTest.cs b/tests/Imageflow.Server.Tests/IntegrationTest.cs
@@ -141,8 +141,8 @@ public async void TestAmazonS3()
                     {
                         services.AddImageflowDiskCache(new DiskCacheOptions(diskCacheDir) {AsyncWrites = false});
                         services.AddImageflowS3Service(
-                            new S3ServiceOptions(RegionEndpoint.USEast1, null, null)
-                                .MapPrefix("/ri/", "us-east-1", "resizer-images"));
+                            new S3ServiceOptions(null, null)
+                                .MapPrefix("/ri/", RegionEndpoint.USEast1, "resizer-images"));
                     })
                     .ConfigureWebHost(webHost =>
                     {