Coding best practices: async vs await improvements

src/Ocelot.Provider.Consul/Consul.cs

@@ -30,9 +30,8 @@ public virtual async Task<List<Service>> GetAsync()
         var nodesTask = _consul.Catalog.Nodes();
 
         await Task.WhenAll(entriesTask, nodesTask);
-
-        var entries = entriesTask.Result.Response ?? Array.Empty<ServiceEntry>();
-        var nodes = nodesTask.Result.Response ?? Array.Empty<Node>();
+        var entries = (await entriesTask).Response ?? Array.Empty<ServiceEntry>();
+        var nodes = (await nodesTask).Response ?? Array.Empty<Node>();
         if (entries.Length == 0)
         {
             _logger.LogWarning(() => $"{nameof(Consul)} Provider: No service entries found for '{_configuration.KeyOfServiceInConsul}' service!");

src/Ocelot.Provider.Consul/PollConsul.cs

@@ -51,7 +51,7 @@ public Task<List<Service>> GetAsync()
             try
             {
                 _logger.LogInformation(() => $"Retrieving new client information for service: {ServiceName}...");
-                _services = _consulServiceDiscoveryProvider.GetAsync().Result;
+                _services = _consulServiceDiscoveryProvider.GetAsync().GetAwaiter().GetResult();
                 return Task.FromResult(_services);
             }
             finally

src/Ocelot/Configuration/Creator/IHttpHandlerOptionsCreator.cs

@@ -7,6 +7,6 @@ namespace Ocelot.Configuration.Creator
     /// </summary>
     public interface IHttpHandlerOptionsCreator
     {
-        HttpHandlerOptions Create(FileHttpHandlerOptions fileRoute);
+        HttpHandlerOptions Create(FileHttpHandlerOptions options);
     }
 }

src/Ocelot/Configuration/Repository/ConsulFileConfigurationPollerOption.cs

@@ -18,7 +18,7 @@ private int GetDelay()
         {
             var delay = 1000;
 
-            var fileConfig = Task.Run(async () => await _fileConfigurationRepository.Get()).Result;
+            var fileConfig = _fileConfigurationRepository.Get().GetAwaiter().GetResult();
             if (fileConfig?.Data?.GlobalConfiguration?.ServiceDiscoveryProvider != null &&
                     !fileConfig.IsError &&
                     fileConfig.Data.GlobalConfiguration.ServiceDiscoveryProvider.PollingInterval > 0)

src/Ocelot/Request/Mapper/StreamHttpContent.cs

@@ -56,7 +56,7 @@ private static async Task CopyAsync(Stream input, Stream output, long announcedC
                 if (zeroByteReadTask.IsCompletedSuccessfully)
                 {
                     // Consume the ValueTask's result in case it is backed by an IValueTaskSource
-                    _ = zeroByteReadTask.Result;
+                    _ = zeroByteReadTask.GetAwaiter().GetResult();
                 }
                 else
                 {

test/Ocelot.AcceptanceTests/AggregateTests.cs

@@ -746,7 +746,7 @@ private void GivenOcelotIsRunningWithSpecificAggregatorsRegisteredInDi<TAggregat
                     s.AddOcelot()
                         .AddSingletonDefinedAggregator<TAggregator>();
                 })
-                .Configure(a => { a.UseOcelot().Wait(); });
+                .Configure(async b => await b.UseOcelot());
 
             _ocelotServer = new TestServer(_webHostBuilder);
             _ocelotClient = _ocelotServer.CreateClient();

test/Ocelot.AcceptanceTests/Authentication/AuthenticationTests.cs

@@ -113,13 +113,13 @@ public void Should_return_201_using_identity_server_reference_token()
         }
 
         [IgnorePublicMethod]
-        public void GivenThereIsAnIdentityServerOn(string url, AccessTokenType tokenType)
+        public async Task GivenThereIsAnIdentityServerOn(string url, AccessTokenType tokenType)
         {
             var scopes = new string[] { "api", "api2" };
             _identityServerBuilder = CreateIdentityServer(url, tokenType, scopes, null)
                 .Build();
-            _identityServerBuilder.Start();
-            VerifyIdentityServerStarted(url);
+            await _identityServerBuilder.StartAsync();
+            await VerifyIdentityServerStarted(url);
         }
 
         public override void Dispose()

test/Ocelot.AcceptanceTests/Authentication/MultipleAuthSchemesFeatureTests.cs

@@ -80,7 +80,7 @@ private MultipleAuthSchemesFeatureTests GivenIdentityServerWithScopes(int index,
 
         var server = _identityServers[index] = builder.Build();
         server.Start();
-        VerifyIdentityServerStarted(url);
+        VerifyIdentityServerStarted(url).GetAwaiter().GetResult();
         return this;
     }
 

test/Ocelot.AcceptanceTests/AuthorizationTests.cs

@@ -308,7 +308,7 @@ private void GivenThereIsAServiceRunningOn(string url, int statusCode, string re
             });
         }
 
-        private void GivenThereIsAnIdentityServerOn(string url, string apiName, AccessTokenType tokenType)
+        private async Task GivenThereIsAnIdentityServerOn(string url, string apiName, AccessTokenType tokenType)
         {
             _identityServerBuilder = new WebHostBuilder()
                 .UseUrls(url)
@@ -390,12 +390,12 @@ private void GivenThereIsAnIdentityServerOn(string url, string apiName, AccessTo
                 })
                 .Build();
 
-            _identityServerBuilder.Start();
+            await _identityServerBuilder.StartAsync();
 
-            Steps.VerifyIdentityServerStarted(url);
+            await Steps.VerifyIdentityServerStarted(url);
         }
 
-        private void GivenThereIsAnIdentityServerOn(string url, string apiName, AccessTokenType tokenType, List<TestUser> users)
+        private async Task GivenThereIsAnIdentityServerOn(string url, string apiName, AccessTokenType tokenType, List<TestUser> users)
         {
             _identityServerBuilder = new WebHostBuilder()
                 .UseUrls(url)
@@ -461,9 +461,9 @@ private void GivenThereIsAnIdentityServerOn(string url, string apiName, AccessTo
                 })
                 .Build();
 
-            _identityServerBuilder.Start();
+            await _identityServerBuilder.StartAsync();
 
-            Steps.VerifyIdentityServerStarted(url);
+            await Steps.VerifyIdentityServerStarted(url);
         }
 
         private async Task GivenIHaveATokenForApiReadOnlyScope(string url)

test/Ocelot.AcceptanceTests/ClaimsToDownstreamPathTests.cs

@@ -123,7 +123,7 @@ private void GivenThereIsAServiceRunningOn(string url, int statusCode)
             _servicebuilder.Start();
         }
 
-        private void GivenThereIsAnIdentityServerOn(string url, string apiName, AccessTokenType tokenType, TestUser user)
+        private async Task GivenThereIsAnIdentityServerOn(string url, string apiName, AccessTokenType tokenType, TestUser user)
         {
             _identityServerBuilder = new WebHostBuilder()
                 .UseUrls(url)
@@ -194,9 +194,9 @@ private void GivenThereIsAnIdentityServerOn(string url, string apiName, AccessTo
                 })
                 .Build();
 
-            _identityServerBuilder.Start();
+            await _identityServerBuilder.StartAsync();
 
-            Steps.VerifyIdentityServerStarted(url);
+            await Steps.VerifyIdentityServerStarted(url);
         }
 
         public void Dispose()

test/Ocelot.AcceptanceTests/ClaimsToHeadersForwardingTests.cs

@@ -117,7 +117,7 @@ private void GivenThereIsAServiceRunningOn(string url, int statusCode)
             });
         }
 
-        private void GivenThereIsAnIdentityServerOn(string url, string apiName, AccessTokenType tokenType, TestUser user)
+        private async Task GivenThereIsAnIdentityServerOn(string url, string apiName, AccessTokenType tokenType, TestUser user)
         {
             _identityServerBuilder = new WebHostBuilder()
                 .UseUrls(url)
@@ -188,9 +188,9 @@ private void GivenThereIsAnIdentityServerOn(string url, string apiName, AccessTo
                 })
                 .Build();
 
-            _identityServerBuilder.Start();
+            await _identityServerBuilder.StartAsync();
 
-            Steps.VerifyIdentityServerStarted(url);
+            await Steps.VerifyIdentityServerStarted(url);
         }
 
         public void Dispose()

test/Ocelot.AcceptanceTests/ClaimsToQueryStringForwardingTests.cs

@@ -204,7 +204,7 @@ private void GivenThereIsAServiceRunningOn(string url, int statusCode)
             _servicebuilder.Start();
         }
 
-        private void GivenThereIsAnIdentityServerOn(string url, string apiName, AccessTokenType tokenType, TestUser user)
+        private async Task GivenThereIsAnIdentityServerOn(string url, string apiName, AccessTokenType tokenType, TestUser user)
         {
             _identityServerBuilder = new WebHostBuilder()
                 .UseUrls(url)
@@ -275,9 +275,9 @@ private void GivenThereIsAnIdentityServerOn(string url, string apiName, AccessTo
                 })
                 .Build();
 
-            _identityServerBuilder.Start();
+            await _identityServerBuilder.StartAsync();
 
-            Steps.VerifyIdentityServerStarted(url);
+            await Steps.VerifyIdentityServerStarted(url);
         }
 
         public void Dispose()

test/Ocelot.AcceptanceTests/Configuration/ConfigurationInConsulTests.cs

@@ -73,7 +73,7 @@ public void should_return_response_200_with_simple_url_when_using_jsonserialized
                 .BDDfy();
         }
 
-        private void GivenThereIsAFakeConsulServiceDiscoveryProvider(string url, string serviceName)
+        private Task GivenThereIsAFakeConsulServiceDiscoveryProvider(string url, string serviceName)
         {
             _fakeConsulBuilder = Host.CreateDefaultBuilder()
                 .ConfigureWebHost(webBuilder =>
@@ -128,8 +128,7 @@ private void GivenThereIsAFakeConsulServiceDiscoveryProvider(string url, string
                                 });
                             });
                 }).Build();
-
-            _fakeConsulBuilder.Start();
+            return _fakeConsulBuilder.StartAsync();
         }
 
         public class FakeConsulGetResponse
@@ -148,7 +147,7 @@ public FakeConsulGetResponse(string value)
             public string Session => "adf4238a-882b-9ddc-4a9d-5b6758e4159e";
         }
 
-        private void GivenThereIsAServiceRunningOn(string url, string basePath, int statusCode, string responseBody)
+        private Task GivenThereIsAServiceRunningOn(string url, string basePath, int statusCode, string responseBody)
         {
             _builder = Host.CreateDefaultBuilder()
                 .ConfigureWebHost(webBuilder =>
@@ -169,8 +168,7 @@ private void GivenThereIsAServiceRunningOn(string url, string basePath, int stat
                     });
                 })
                 .Build();
-
-            _builder.Start();
+            return _builder.StartAsync();
         }
 
         public void Dispose()

test/Ocelot.AcceptanceTests/OpenTracingTests.cs

@@ -515,7 +515,7 @@ public static Waiter WaitFor(int milliSeconds)
         }
     }
 
-    public class Waiter
+    public class Waiter // TODO Move to Ocelot.Testing project
     {
         private readonly int _milliSeconds;
 
@@ -524,36 +524,27 @@ public Waiter(int milliSeconds)
             _milliSeconds = milliSeconds;
         }
 
+        // TODO Replace with async version in tests
         public bool Until(Func<bool> condition)
         {
-            var stopwatch = Stopwatch.StartNew();
-            var passed = false;
-            while (stopwatch.ElapsedMilliseconds < _milliSeconds)
-            {
-                if (condition.Invoke())
-                {
-                    passed = true;
-                    break;
-                }
-            }
-
-            return passed;
+            Task<bool> WrappedCondition() => Task.FromResult(condition.Invoke());
+            return UntilAsync(WrappedCondition).GetAwaiter().GetResult();
         }
 
-        public async Task<bool> Until(Func<Task<bool>> condition)
+        public async Task<bool> UntilAsync(Func<Task<bool>> condition)
         {
             var stopwatch = Stopwatch.StartNew();
-            var passed = false;
             while (stopwatch.ElapsedMilliseconds < _milliSeconds)
             {
                 if (await condition.Invoke())
                 {
-                    passed = true;
-                    break;
+                    stopwatch.Stop();
+                    return true;
                 }
             }
 
-            return passed;
+            stopwatch.Stop();
+            return false;
         }
 
         public bool Until<T>(Func<bool> condition)
@@ -569,6 +560,7 @@ public bool Until<T>(Func<bool> condition)
                 }
             }
 
+            stopwatch.Stop();
             return passed;
         }
     }

test/Ocelot.AcceptanceTests/RateLimiting/ClientRateLimitingTests.cs

@@ -72,12 +72,12 @@ public void Should_wait_for_period_timespan_to_elapse_before_making_next_request
     private int Count() => ++_count;
     private string Url() => $"/ClientRateLimit/?{Count()}";
 
-    private void WhenIGetUrlOnTheApiGatewayMultipleTimesForRateLimit(Func<string> urlDelegate, long times)
+    private async Task WhenIGetUrlOnTheApiGatewayMultipleTimesForRateLimit(Func<string> urlDelegate, long times)
     {
         for (long i = 0; i < times; i++)
         {
             var url = urlDelegate.Invoke();
-            WhenIGetUrlOnTheApiGatewayMultipleTimesForRateLimit(url, 1);
+            await WhenIGetUrlOnTheApiGatewayMultipleTimesForRateLimit(url, 1);
         }
     }
 

test/Ocelot.AcceptanceTests/Requester/PayloadTooLargeTests.cs

@@ -112,9 +112,9 @@ private void GivenOcelotIsRunningOnKestrelWithCustomBodyMaxSize(long customBodyM
                     {
                         s.AddOcelot();
                     })
-                    .Configure(app =>
+                    .Configure(async app =>
                     {
-                        app.UseOcelot().Wait();
+                        await app.UseOcelot();
                     })
                     .UseUrls("http://localhost:5001");
             }).Build();
@@ -150,9 +150,9 @@ private void GivenOcelotIsRunningOnHttpSysWithCustomBodyMaxSize(long customBodyM
                 {
                     s.AddOcelot();
                 })
-                .Configure(app =>
+                .Configure(async app =>
                 {
-                    app.UseOcelot().Wait();
+                    await app.UseOcelot();
                 })
                 .UseUrls("http://localhost:5001");
             }).Build();

test/Ocelot.AcceptanceTests/ServiceDiscovery/ConsulConfigurationInConsulTests.cs

@@ -316,13 +316,13 @@ public void should_handle_request_to_consul_for_downstream_service_and_make_requ
             .BDDfy();
         }
 
-        private void ThenTheConfigIsUpdatedInOcelot()
+        private async Task ThenTheConfigIsUpdatedInOcelot()
         {
-            var result = Wait.WaitFor(20000).Until(() =>
+            var result = await Wait.WaitFor(20000).UntilAsync(async () =>
             {
                 try
                 {
-                    _steps.WhenIGetUrlOnTheApiGateway("/cs/status/awesome");
+                    await _steps.WhenIGetUrlOnTheApiGateway("/cs/status/awesome");
                     _steps.ThenTheStatusCodeShouldBe(HttpStatusCode.OK);
                     _steps.ThenTheResponseBodyShouldBe("Hello from Laura");
                     return true;
@@ -348,7 +348,7 @@ private void GivenTheServicesAreRegisteredWithConsul(params ServiceEntry[] servi
             }
         }
 
-        private void GivenThereIsAFakeConsulServiceDiscoveryProvider(string url, string serviceName)
+        private Task GivenThereIsAFakeConsulServiceDiscoveryProvider(string url, string serviceName)
         {
             _fakeConsulBuilder = new WebHostBuilder()
                             .UseUrls(url)
@@ -404,8 +404,7 @@ private void GivenThereIsAFakeConsulServiceDiscoveryProvider(string url, string
                                 });
                             })
                             .Build();
-
-            _fakeConsulBuilder.Start();
+            return _fakeConsulBuilder.StartAsync();
         }
 
         public class FakeConsulGetResponse
@@ -424,7 +423,7 @@ public FakeConsulGetResponse(string value)
             public string Session => "adf4238a-882b-9ddc-4a9d-5b6758e4159e";
         }
 
-        private void GivenThereIsAServiceRunningOn(string url, string basePath, int statusCode, string responseBody)
+        private Task GivenThereIsAServiceRunningOn(string url, string basePath, int statusCode, string responseBody)
         {
             _builder = new WebHostBuilder()
                 .UseUrls(url)
@@ -443,8 +442,7 @@ private void GivenThereIsAServiceRunningOn(string url, string basePath, int stat
                     });
                 })
                 .Build();
-
-            _builder.Start();
+            return _builder.StartAsync();
         }
 
         public void Dispose()