refactoring

Author: krivchenko-kv

README.md

@@ -32,14 +32,12 @@ Job=.NET 8.0  Runtime=.NET 8.0
 Для работы с хранилищем необходимо создать клиент.
 
 ```csharp
-var storageClient = new S3Client(new S3Settings
+var storageClient = new (new S3BucketSettings
 {
     AccessKey = "ROOTUSER",
     Bucket = "mybucket",
-    EndPoint = "localhost",     // для Yandex.Objects это "storage.yandexcloud.net"
-    Port = 9000,                // стандартный порт Minio - 9000, для Yandex.Objects указывать не нужно
+    EndPoint = "http://localhost:9000",     // для Yandex.Objects это "https://storage.yandexcloud.net"
     SecretKey = "ChangeMe123",
-    UseHttps = false,           // для Yandex.Objects укажите true
     UseHttp2 = false            // Yandex.Objects позволяет работать по HTTP2, можете указать true
 })
 ```
@@ -117,7 +115,7 @@ else {
 ### Получение файла
 
 ```csharp
-StorageFile fileGetResult = await storageClient.GetFile(fileName, cancellationToken);
+S3File fileGetResult = await storageClient.GetFile(fileName, cancellationToken);
 if (fileGetResult) {
     Console.WriteLine($"Размер файла {fileGetResult.Length}, контент {fileGetResult.ContetType}");
     return await fileGetResult.GetStream(cancellationToken);

src/Storage.Benchmark/GlobalSuppressions.cs

@@ -0,0 +1,11 @@
+// This file is used by Code Analysis to maintain SuppressMessage
+// attributes that are applied to this project.
+// Project-level suppressions either have no target or are given
+// a specific target and scoped to a namespace, type, member, etc.
+
+using System.Diagnostics.CodeAnalysis;
+
+[assembly: SuppressMessage("Minor Code Smell", "S1075:URIs should not be hardcoded", Justification = "<Pending>")]
+[assembly: SuppressMessage("Major Code Smell", "S125:Sections of code should not be commented out", Justification = "<Pending>")]
+[assembly: SuppressMessage("Major Code Smell", "S112:General or reserved exceptions should never be thrown", Justification = "<Pending>")]
+[assembly: SuppressMessage("Performance", "CA1859:Use concrete types when possible for improved performance", Justification = "<Pending>")]

src/Storage.Benchmark/InternalBenchmarks/DownloadBenchmark.cs

@@ -1,4 +1,4 @@
-using BenchmarkDotNet.Attributes;
+using BenchmarkDotNet.Attributes;
 using Storage.Benchmark.Utils;
 
 namespace Storage.Benchmark.InternalBenchmarks;
@@ -10,7 +10,7 @@ public class DownloadBenchmark
 {
 	private CancellationToken _cancellation;
 	private string _fileId = null!;
-	private S3Client _s3Client = null!;
+	private S3BucketClient _s3Client = null!;
 
 	[GlobalSetup]
 	public void Config()

src/Storage.Benchmark/InternalBenchmarks/HashBenchmark.cs

@@ -1,4 +1,4 @@
-using BenchmarkDotNet.Attributes;
+using BenchmarkDotNet.Attributes;
 using BenchmarkDotNet.Jobs;
 using Storage.Benchmark.Utils;
 using Storage.Utils;
@@ -26,15 +26,15 @@ public void Config()
 	public int ByteHash()
 	{
 		return HashHelper
-			.GetPayloadHash(_byteData, DefaultArrayPool.Instance)
+			.GetPayloadHash(_byteData)
 			.Length;
 	}
 
 	[Benchmark]
 	public int StringHash()
 	{
 		return HashHelper
-			.GetPayloadHash(_stringData, DefaultArrayPool.Instance)
+			.GetPayloadHash(_stringData)
 			.Length;
 	}
 }

src/Storage.Benchmark/InternalBenchmarks/SignatureBenchmark.cs

@@ -1,4 +1,4 @@
-using BenchmarkDotNet.Attributes;
+using BenchmarkDotNet.Attributes;
 using BenchmarkDotNet.Jobs;
 using Storage.Benchmark.Utils;
 using Storage.Utils;
@@ -26,10 +26,8 @@ public void Config()
 		_headers = ["host", "x-amz-content-sha256", "x-amz-date"];
 		_now = DateTime.UtcNow;
 		_request = new HttpRequestMessage(HttpMethod.Post, "http://company-name.com/controller");
-		_payloadHash = HashHelper.GetPayloadHash(data, DefaultArrayPool.Instance);
-		_signature = new Signature(
-			new HttpDescription(DefaultArrayPool.Instance, "", "", "", []),
-			settings.SecretKey, settings.Region, settings.Service);
+		_payloadHash = HashHelper.GetPayloadHash(data);
+		_signature = new Signature(settings.Region, settings.Service, settings.SecretKey);
 	}
 
 	[Benchmark]

src/Storage.Benchmark/S3Benchmark.cs

@@ -1,4 +1,4 @@
-using Amazon.S3;
+using Amazon.S3;
 using Amazon.S3.Model;
 using Amazon.S3.Transfer;
 using Amazon.S3.Util;
@@ -24,7 +24,7 @@ public class S3Benchmark
 	private IAmazonS3 _amazonClient = null!;
 	private TransferUtility _amazonTransfer = null!;
 	private IMinioClient _minioClient = null!;
-	private S3Client _s3Client = null!;
+	private S3BucketClient _s3Client = null!;
 
 	[GlobalSetup]
 	public void Config()
@@ -87,7 +87,9 @@ await _amazonClient.DeleteObjectAsync(
 			new DeleteObjectRequest { BucketName = _bucket, Key = _fileId },
 			_cancellation);
 
-		return ++result;
+		result++;
+
+		return result;
 	}
 
 	[Benchmark]
@@ -151,7 +153,9 @@ await _minioClient.RemoveObjectAsync(
 				.WithObject(_fileId),
 			_cancellation);
 
-		return ++result;
+		++result;
+
+		return result;
 	}
 
 	[Benchmark(Baseline = true)]
@@ -207,7 +211,9 @@ public async Task<int> Storage()
 		result++;
 
 		await _s3Client.DeleteFile(_fileId, _cancellation);
-		return ++result;
+
+		result++;
+		return result;
 	}
 
 	private static void ThrowException(string? message = null)

src/Storage.Benchmark/Utils/BenchmarkHelper.cs

@@ -1,4 +1,4 @@
-using Amazon;
+using Amazon;
 using Amazon.Runtime;
 using Amazon.S3;
 using Microsoft.Extensions.Configuration;
@@ -8,49 +8,40 @@ namespace Storage.Benchmark.Utils;
 
 internal static class BenchmarkHelper
 {
-	public static readonly byte[] StreamBuffer = new byte[2048];
-
-	// ReSharper disable once InconsistentNaming
-	public static AmazonS3Client CreateAWSClient(S3Settings settings)
+	public static readonly byte[] StreamBuffer = new byte[2048];
+
+	// ReSharper disable once InconsistentNaming
+	public static AmazonS3Client CreateAWSClient(S3BucketSettings settings)
 	{
-		var scheme = settings.UseHttps ? Uri.UriSchemeHttps : Uri.UriSchemeHttp;
-		var port = settings.Port.HasValue ? $":{settings.Port}" : string.Empty;
-
 		return new AmazonS3Client(
 			new BasicAWSCredentials(settings.AccessKey, settings.SecretKey),
 			new AmazonS3Config
 			{
 				RegionEndpoint = RegionEndpoint.USEast1,
-				ServiceURL = $"{scheme}://{settings.EndPoint}{port}",
-				ForcePathStyle = true, // MUST be true to work correctly with MinIO server
+				ServiceURL = settings.Endpoint,
+				ForcePathStyle = true, // MUST be true to work correctly with MinIO server
 			});
 	}
 
-	public static IMinioClient CreateMinioClient(S3Settings settings)
+	public static IMinioClient CreateMinioClient(S3BucketSettings settings)
 	{
-		var builder = new MinioClient();
-		var port = settings.Port;
-		if (port.HasValue)
-		{
-			builder.WithEndpoint(settings.EndPoint, port.Value);
-		}
-		else
-		{
-			builder.WithEndpoint(settings.EndPoint);
-		}
+		Uri endpoint = new (settings.Endpoint);
 
+		var builder = new MinioClient();
+		
 		return builder
+			.WithEndpoint(endpoint)
 			.WithCredentials(settings.AccessKey, settings.SecretKey)
-			.WithSSL(settings.UseHttps)
+			
 			.Build();
 	}
 
-	public static S3Client CreateStoragesClient(S3Settings settings)
+	public static S3BucketClient CreateStoragesClient(S3BucketSettings settings)
 	{
-		return new S3Client(settings);
+		return new S3BucketClient(new HttpClient(), settings);
 	}
 
-	public static void EnsureBucketExists(S3Client client, CancellationToken cancellation)
+	public static void EnsureBucketExists(S3BucketClient client, CancellationToken cancellation)
 	{
 		if (client.IsBucketExists(cancellation).GetAwaiter().GetResult())
 		{
@@ -62,7 +53,7 @@ public static void EnsureBucketExists(S3Client client, CancellationToken cancell
 
 	public static void EnsureFileExists(
 		IConfiguration config,
-		S3Client client,
+		S3BucketClient client,
 		string fileName,
 		CancellationToken cancellation)
 	{
@@ -76,7 +67,7 @@ public static void EnsureFileExists(
 
 		if (!result)
 		{
-			throw new Exception("File isn't uploaded");
+			throw new FileLoadException("File isn't uploaded");
 		}
 	}
 
@@ -86,7 +77,7 @@ public static byte[] ReadBigArray(IConfiguration config)
 
 		return !string.IsNullOrEmpty(filePath) && File.Exists(filePath)
 			? File.ReadAllBytes(filePath)
-			: GetByteArray(123 * 1024 * 1024); // 123 Mb
+			: GetByteArray(123 * 1024 * 1024); // 123 Mb
 	}
 
 	public static InputStream ReadBigFile(IConfiguration config)
@@ -114,28 +105,28 @@ public static async Task<int> ReadStreamMock(Stream input, byte[] buffer, Cancel
 		return result;
 	}
 
-	public static S3Settings ReadSettings(IConfiguration config)
+	public static S3BucketSettings ReadSettings(IConfiguration config)
 	{
-		var settings = config.GetRequiredSection("S3Storage").Get<S3Settings>();
-		if (settings == null || string.IsNullOrEmpty(settings.EndPoint))
+		var settings = config.GetRequiredSection("S3Storage").Get<S3BucketSettings>();
+		if (settings == null || string.IsNullOrEmpty(settings.Endpoint))
 		{
-			throw new Exception("S3Storage configuration is not found");
+			throw new UriFormatException("S3Storage configuration is not found");
 		}
 
 		var isContainer = Environment.GetEnvironmentVariable("DOTNET_RUNNING_IN_CONTAINER");
 		if (isContainer != null && bool.TryParse(isContainer, out var value) && value)
 		{
-			settings = new S3Settings
+			Uri endpointUri = new (settings.Endpoint);
+
+			settings = new S3BucketSettings
 			{
 				AccessKey = settings.AccessKey,
 				Bucket = settings.Bucket,
-				EndPoint = "host.docker.internal",
-				Port = settings.Port,
+				Endpoint = $"{endpointUri.Scheme}://host.docker.internal:{endpointUri.Port}",
 				Region = settings.Region,
 				SecretKey = settings.SecretKey,
 				Service = settings.Service,
 				UseHttp2 = settings.UseHttp2,
-				UseHttps = settings.UseHttps,
 			};
 		}
 

src/Storage.Benchmark/appsettings.json

@@ -1,11 +1,9 @@
-{
+{
   "BigFilePath": "",
   "S3Storage": {
     "AccessKey": "ROOTUSER",
     "Bucket": "benchmark",
-    "EndPoint": "localhost",
-    "Port": "5300",
-    "SecretKey": "ChangeMe123",
-    "UseHttps": false
+    "EndPoint": "http://localhost:5300",
+    "SecretKey": "ChangeMe123"
   }
-}
+}

src/Storage.Tests/BucketShould.cs

@@ -1,9 +1,9 @@
-namespace Storage.Tests;
+namespace Storage.Tests;
 
 public sealed class BucketShould(StorageFixture fixture) : IClassFixture<StorageFixture>
 {
 	private readonly CancellationToken _ct = CancellationToken.None;
-	private readonly S3Client _client = fixture.S3Client;
+	private readonly S3BucketClient _client = fixture.S3Client;
 
 	[Fact]
 	public async Task CreateBucket()
@@ -59,7 +59,7 @@ public Task NotThrowIfDeleteNotExistsBucket()
 			.Should().NotThrowAsync();
 	}
 
-	private async Task DeleteTestBucket(S3Client client)
+	private async Task DeleteTestBucket(S3BucketClient client)
 	{
 		var bucketDeleteResult = await client.DeleteBucket(_ct);
 

src/Storage.Tests/ClientShould.cs

@@ -1,17 +1,17 @@
-namespace Storage.Tests;
+namespace Storage.Tests;
 
 public sealed class ClientShould(StorageFixture fixture) : IClassFixture<StorageFixture>
 {
 	private readonly CancellationToken _ct = CancellationToken.None;
-	private readonly S3Client _client = fixture.S3Client;
+	private readonly S3BucketClient _client = fixture.S3Client;
 
 	[Fact]
 	public void DeserializeSettingsJson()
 	{
 		var expected = fixture.Settings;
 
 		var json = JsonSerializer.Serialize(expected);
-		var actual = JsonSerializer.Deserialize<S3Settings>(json);
+		var actual = JsonSerializer.Deserialize<S3BucketSettings>(json);
 
 		actual.Should().BeEquivalentTo(expected);
 	}