Async HttpClient framework

Co-Authored-By: ta264 <ta264@users.noreply.github.com>

src/NzbDrone.Common/Extensions/StreamExtensions.cs

@@ -1,18 +1,19 @@
-using System.IO;
+using System.IO;
+using System.Threading.Tasks;
 
 namespace NzbDrone.Common.Extensions
 {
     public static class StreamExtensions
     {
-        public static byte[] ToBytes(this Stream input)
+        public static async Task<byte[]> ToBytes(this Stream input)
         {
             var buffer = new byte[16 * 1024];
             using (var ms = new MemoryStream())
             {
                 int read;
-                while ((read = input.Read(buffer, 0, buffer.Length)) > 0)
+                while ((read = await input.ReadAsync(buffer, 0, buffer.Length)) > 0)
                 {
-                    ms.Write(buffer, 0, read);
+                    await ms.WriteAsync(buffer, 0, read);
                 }
 
                 return ms.ToArray();

src/NzbDrone.Common/Http/Dispatchers/IHttpDispatcher.cs

@@ -1,10 +1,11 @@
 using System.Net;
+using System.Threading.Tasks;
 
 namespace NzbDrone.Common.Http.Dispatchers
 {
     public interface IHttpDispatcher
     {
-        HttpResponse GetResponse(HttpRequest request, CookieContainer cookies);
-        void DownloadFile(string url, string fileName);
+        Task<HttpResponse> GetResponseAsync(HttpRequest request, CookieContainer cookies);
+        Task DownloadFileAsync(string url, string fileName);
     }
 }

src/NzbDrone.Common/Http/Dispatchers/ManagedHttpDispatcher.cs

@@ -4,6 +4,7 @@ using System.IO;
 using System.IO.Compression;
 using System.Net;
 using System.Reflection;
+using System.Threading.Tasks;
 using NLog;
 using NLog.Fluent;
 using NzbDrone.Common.EnvironmentInfo;
@@ -29,7 +30,7 @@ namespace NzbDrone.Common.Http.Dispatchers
             _logger = logger;
         }
 
-        public HttpResponse GetResponse(HttpRequest request, CookieContainer cookies)
+        public async Task<HttpResponse> GetResponseAsync(HttpRequest request, CookieContainer cookies)
         {
             var webRequest = (HttpWebRequest)WebRequest.Create((Uri)request.Url);
 
@@ -78,7 +79,7 @@ namespace NzbDrone.Common.Http.Dispatchers
                     }
                 }
 
-                httpWebResponse = (HttpWebResponse)webRequest.GetResponse();
+                httpWebResponse = (HttpWebResponse)await webRequest.GetResponseAsync();
             }
             catch (WebException e)
             {
@@ -121,7 +122,7 @@ namespace NzbDrone.Common.Http.Dispatchers
                 {
                     try
                     {
-                        data = responseStream.ToBytes();
+                        data = await responseStream.ToBytes();
 
                         if (PlatformInfo.IsMono && httpWebResponse.ContentEncoding == "gzip")
                         {
@@ -146,7 +147,7 @@ namespace NzbDrone.Common.Http.Dispatchers
             return new HttpResponse(request, new HttpHeader(httpWebResponse.Headers), httpWebResponse.Cookies, data, httpWebResponse.StatusCode);
         }
 
-        public void DownloadFile(string url, string fileName)
+        public async Task DownloadFileAsync(string url, string fileName)
         {
             try
             {
@@ -165,7 +166,7 @@ namespace NzbDrone.Common.Http.Dispatchers
                 {
                     webClient.Headers.Add(HttpRequestHeader.UserAgent, _userAgentBuilder.GetUserAgent());
                     webClient.Proxy = GetProxy(uri);
-                    webClient.DownloadFile(uri.FullUri, fileName);
+                    await webClient.DownloadFileTaskAsync(url, fileName);
                     stopWatch.Stop();
                     _logger.Debug("Downloading Completed. took {0:0}s", stopWatch.Elapsed.Seconds);
                 }
@@ -173,11 +174,23 @@ namespace NzbDrone.Common.Http.Dispatchers
             catch (WebException e)
             {
                 _logger.Warn("Failed to get response from: {0} {1}", url, e.Message);
+
+                if (File.Exists(fileName))
+                {
+                    File.Delete(fileName);
+                }
+
                 throw;
             }
             catch (Exception e)
             {
                 _logger.Warn(e, "Failed to get response from: " + url);
+
+                if (File.Exists(fileName))
+                {
+                    File.Delete(fileName);
+                }
+
                 throw;
             }
         }

src/NzbDrone.Common/Http/HttpClient.cs

@@ -3,6 +3,7 @@ using System.Collections.Generic;
 using System.Diagnostics;
 using System.Linq;
 using System.Net;
+using System.Threading.Tasks;
 using NLog;
 using NzbDrone.Common.Cache;
 using NzbDrone.Common.EnvironmentInfo;
@@ -23,6 +24,16 @@ namespace NzbDrone.Common.Http
         HttpResponse Post(HttpRequest request);
         HttpResponse<T> Post<T>(HttpRequest request)
             where T : new();
+
+        Task<HttpResponse> ExecuteAsync(HttpRequest request);
+        Task DownloadFileAsync(string url, string fileName);
+        Task<HttpResponse> GetAsync(HttpRequest request);
+        Task<HttpResponse<T>> GetAsync<T>(HttpRequest request)
+            where T : new();
+        Task<HttpResponse> HeadAsync(HttpRequest request);
+        Task<HttpResponse> PostAsync(HttpRequest request);
+        Task<HttpResponse<T>> PostAsync<T>(HttpRequest request)
+            where T : new();
     }
 
     public class HttpClient : IHttpClient
@@ -50,11 +61,11 @@ namespace NzbDrone.Common.Http
             _cookieContainerCache = cacheManager.GetCache<CookieContainer>(typeof(HttpClient));
         }
 
-        public HttpResponse Execute(HttpRequest request)
+        public async Task<HttpResponse> ExecuteAsync(HttpRequest request)
         {
             var cookieContainer = InitializeRequestCookies(request);
 
-            var response = ExecuteRequest(request, cookieContainer);
+            var response = await ExecuteRequestAsync(request, cookieContainer);
 
             if (request.AllowAutoRedirect && response.HasHttpRedirect)
             {
@@ -73,7 +84,7 @@ namespace NzbDrone.Common.Http
                         throw new WebException($"Too many automatic redirections were attempted for {autoRedirectChain.Join(" -> ")}", WebExceptionStatus.ProtocolError);
                     }
 
-                    response = ExecuteRequest(request, cookieContainer);
+                    response = await ExecuteRequestAsync(request, cookieContainer);
                 }
                 while (response.HasHttpRedirect);
             }
@@ -100,7 +111,12 @@ namespace NzbDrone.Common.Http
             return response;
         }
 
-        private HttpResponse ExecuteRequest(HttpRequest request, CookieContainer cookieContainer)
+        public HttpResponse Execute(HttpRequest request)
+        {
+            return ExecuteAsync(request).GetAwaiter().GetResult();
+        }
+
+        private async Task<HttpResponse> ExecuteRequestAsync(HttpRequest request, CookieContainer cookieContainer)
         {
             foreach (var interceptor in _requestInterceptors)
             {
@@ -109,7 +125,7 @@ namespace NzbDrone.Common.Http
 
             if (request.RateLimit != TimeSpan.Zero)
             {
-                _rateLimitService.WaitAndPulse(request.Url.Host, request.RateLimit);
+                await _rateLimitService.WaitAndPulseAsync(request.Url.Host, request.RateLimit);
             }
 
             _logger.Trace(request);
@@ -118,7 +134,7 @@ namespace NzbDrone.Common.Http
 
             PrepareRequestCookies(request, cookieContainer);
 
-            var response = _httpDispatcher.GetResponse(request, cookieContainer);
+            var response = await _httpDispatcher.GetResponseAsync(request, cookieContainer);
 
             HandleResponseCookies(response, cookieContainer);
 
@@ -227,45 +243,78 @@ namespace NzbDrone.Common.Http
             }
         }
 
+        public async Task DownloadFileAsync(string url, string fileName)
+        {
+            await _httpDispatcher.DownloadFileAsync(url, fileName);
+        }
+
         public void DownloadFile(string url, string fileName)
         {
-            _httpDispatcher.DownloadFile(url, fileName);
+            // https://docs.microsoft.com/en-us/archive/msdn-magazine/2015/july/async-programming-brownfield-async-development#the-thread-pool-hack
+            Task.Run(() => DownloadFileAsync(url, fileName)).GetAwaiter().GetResult();
         }
 
-        public HttpResponse Get(HttpRequest request)
+        public Task<HttpResponse> GetAsync(HttpRequest request)
         {
             request.Method = HttpMethod.GET;
-            return Execute(request);
+            return ExecuteAsync(request);
         }
 
-        public HttpResponse<T> Get<T>(HttpRequest request)
+        public HttpResponse Get(HttpRequest request)
+        {
+            return Task.Run(() => GetAsync(request)).GetAwaiter().GetResult();
+        }
+
+        public async Task<HttpResponse<T>> GetAsync<T>(HttpRequest request)
             where T : new()
         {
-            var response = Get(request);
+            var response = await GetAsync(request);
             CheckResponseContentType(response);
             return new HttpResponse<T>(response);
         }
 
-        public HttpResponse Head(HttpRequest request)
+        public HttpResponse<T> Get<T>(HttpRequest request)
+            where T : new()
+        {
+            return Task.Run(() => GetAsync<T>(request)).GetAwaiter().GetResult();
+        }
+
+        public Task<HttpResponse> HeadAsync(HttpRequest request)
         {
             request.Method = HttpMethod.HEAD;
-            return Execute(request);
+            return ExecuteAsync(request);
         }
 
-        public HttpResponse Post(HttpRequest request)
+        public HttpResponse Head(HttpRequest request)
+        {
+            return Task.Run(() => HeadAsync(request)).GetAwaiter().GetResult();
+        }
+
+        public Task<HttpResponse> PostAsync(HttpRequest request)
         {
             request.Method = HttpMethod.POST;
-            return Execute(request);
+            return ExecuteAsync(request);
         }
 
-        public HttpResponse<T> Post<T>(HttpRequest request)
+        public HttpResponse Post(HttpRequest request)
+        {
+            return Task.Run(() => PostAsync(request)).GetAwaiter().GetResult();
+        }
+
+        public async Task<HttpResponse<T>> PostAsync<T>(HttpRequest request)
             where T : new()
         {
-            var response = Post(request);
+            var response = await PostAsync(request);
             CheckResponseContentType(response);
             return new HttpResponse<T>(response);
         }
 
+        public HttpResponse<T> Post<T>(HttpRequest request)
+            where T : new()
+        {
+            return Task.Run(() => PostAsync<T>(request)).GetAwaiter().GetResult();
+        }
+
         private void CheckResponseContentType(HttpResponse response)
         {
             if (response.Headers.ContentType != null && response.Headers.ContentType.Contains("text/html"))

src/NzbDrone.Common/TPL/RateLimitService.cs

@@ -1,5 +1,6 @@
-using System;
+using System;
 using System.Collections.Concurrent;
+using System.Threading.Tasks;
 using NLog;
 using NzbDrone.Common.Cache;
 
@@ -8,6 +9,7 @@ namespace NzbDrone.Common.TPL
     public interface IRateLimitService
     {
         void WaitAndPulse(string key, TimeSpan interval);
+        Task WaitAndPulseAsync(string key, TimeSpan interval);
     }
 
     public class RateLimitService : IRateLimitService
@@ -23,19 +25,35 @@ namespace NzbDrone.Common.TPL
 
         public void WaitAndPulse(string key, TimeSpan interval)
         {
-            var waitUntil = _rateLimitStore.AddOrUpdate(key,
-                (s) => DateTime.UtcNow + interval,
-                (s, i) => new DateTime(Math.Max(DateTime.UtcNow.Ticks, i.Ticks), DateTimeKind.Utc) + interval);
+            var delay = GetDelay(key, interval);
 
-            waitUntil -= interval;
+            if (delay.TotalSeconds > 0.0)
+            {
+                _logger.Trace("Rate Limit triggered, delaying '{0}' for {1:0.000} sec", key, delay.TotalSeconds);
+                System.Threading.Thread.Sleep(delay);
+            }
+        }
 
-            var delay = waitUntil - DateTime.UtcNow;
+        public async Task WaitAndPulseAsync(string key, TimeSpan interval)
+        {
+            var delay = GetDelay(key, interval);
 
             if (delay.TotalSeconds > 0.0)
             {
                 _logger.Trace("Rate Limit triggered, delaying '{0}' for {1:0.000} sec", key, delay.TotalSeconds);
-                System.Threading.Thread.Sleep(delay);
+                await Task.Delay(delay);
             }
         }
+
+        private TimeSpan GetDelay(string key, TimeSpan interval)
+        {
+            var waitUntil = _rateLimitStore.AddOrUpdate(key,
+                (s) => DateTime.UtcNow + interval,
+                (s, i) => new DateTime(Math.Max(DateTime.UtcNow.Ticks, i.Ticks), DateTimeKind.Utc) + interval);
+
+            waitUntil -= interval;
+
+            return waitUntil - DateTime.UtcNow;
+        }
     }
 }