refactor: Update GenerateDescriptor with Async suffix (#33)

Signed-off-by: Sajay Antony <[email protected]>
oras-project · Dec 13, 2023 · 52fcd19 · 52fcd19
1 parent bb7a18b
commit 52fcd19
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 7 deletions.
diff --git a/Oras.Tests/RemoteTest/RepositoryTest.cs b/Oras.Tests/RemoteTest/RepositoryTest.cs
@@ -2119,7 +2119,7 @@ public async Task ManifestStore_generateDescriptorWithVariousDockerContentDigest
                     var err = false;
                     try
                     {
-                        await s.GenerateDescriptor(resp, reference, method);
+                        await s.GenerateDescriptorAsync(resp, reference, method);
                     }
                     catch (Exception e)
                     {

diff --git a/Oras/Remote/Auth/HttpClientWithBasicAuth.cs b/Oras/Remote/Auth/HttpClientWithBasicAuth.cs
@@ -12,14 +12,14 @@ public class HttpClientWithBasicAuth : HttpClient
     {
         public HttpClientWithBasicAuth(string username, string password)
         {
-            DefaultRequestHeaders.Add("User-Agent", new string[] { "oras-dotnet" });
+            this.AddUserAgent();
             DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic",
                 Convert.ToBase64String(Encoding.UTF8.GetBytes($"{username}:{password}")));
         }
 
         public HttpClientWithBasicAuth(string username, string password, HttpMessageHandler handler) : base(handler)
         {
-            DefaultRequestHeaders.Add("User-Agent", new string[] { "oras-dotnet" });
+            this.AddUserAgent();
             DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic",
                 Convert.ToBase64String(Encoding.UTF8.GetBytes($"{username}:{password}")));
         }

diff --git a/Oras/Remote/HttpClientExtensions.cs b/Oras/Remote/HttpClientExtensions.cs
@@ -0,0 +1,12 @@
+using System.Net.Http;
+
+namespace Oras.Remote
+{
+    internal static class HttpClientExtensions
+    {
+        public static void AddUserAgent(this HttpClient client)
+        {
+            client.DefaultRequestHeaders.Add("User-Agent", new string[] { "oras-dotnet" });
+        }
+    }
+}
diff --git a/Oras/Remote/Registry.cs b/Oras/Remote/Registry.cs
@@ -28,7 +28,7 @@ public Registry(string name)
             reference.ValidateRegistry();
             RemoteReference = reference;
             HttpClient = new HttpClient();
-            HttpClient.DefaultRequestHeaders.Add("User-Agent", new string[] { "oras-dotnet" });
+            HttpClient.AddUserAgent();
         }
 
         public Registry(string name, HttpClient httpClient)

diff --git a/Oras/Remote/Repository.cs b/Oras/Remote/Repository.cs
@@ -593,7 +593,7 @@ public async Task<Descriptor> ResolveAsync(string reference, CancellationToken c
 
             return res.StatusCode switch
             {
-                HttpStatusCode.OK => await GenerateDescriptor(res, remoteReference, req.Method),
+                HttpStatusCode.OK => await GenerateDescriptorAsync(res, remoteReference, req.Method),
                 HttpStatusCode.NotFound => throw new NotFoundException($"reference {reference} not found"),
                 _ => throw await ErrorUtility.ParseErrorResponse(res)
             };
@@ -607,7 +607,7 @@ public async Task<Descriptor> ResolveAsync(string reference, CancellationToken c
         /// <param name="httpMethod"></param>
         /// <returns></returns>
         /// <exception cref="Exception"></exception>
-        public async Task<Descriptor> GenerateDescriptor(HttpResponseMessage res, RemoteReference reference, HttpMethod httpMethod)
+        public async Task<Descriptor> GenerateDescriptorAsync(HttpResponseMessage res, RemoteReference reference, HttpMethod httpMethod)
         {
             string mediaType;
             try
@@ -749,7 +749,7 @@ public async Task DeleteAsync(Descriptor target, CancellationToken cancellationT
                     }
                     else
                     {
-                        desc = await GenerateDescriptor(resp, remoteReference, HttpMethod.Get);
+                        desc = await GenerateDescriptorAsync(resp, remoteReference, HttpMethod.Get);
                     }
 
                     return (desc, await resp.Content.ReadAsStreamAsync());