[dotnet] add async navigation methods to interface and implement in event firing webdriver

Author: titusfortner

dotnet/src/support/Events/EventFiringWebDriver.cs

@@ -20,6 +20,7 @@
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
 using System.Drawing;
+using System.Threading.Tasks;
 
 namespace OpenQA.Selenium.Support.Events
 {
@@ -845,12 +846,21 @@ public EventFiringNavigation(EventFiringWebDriver driver)
             /// Move the browser back
             /// </summary>
             public void Back()
+            {
+                Task.Run(this.BackAsync).GetAwaiter().GetResult();
+            }
+
+            /// <summary>
+            /// Move the browser back as an asynchronous task.
+            /// </summary>
+            /// <returns>A task object representing the asynchronous operation</returns>
+            public async Task BackAsync()
             {
                 try
                 {
                     WebDriverNavigationEventArgs e = new WebDriverNavigationEventArgs(this.parentDriver);
                     this.parentDriver.OnNavigatingBack(e);
-                    this.wrappedNavigation.Back();
+                    await this.wrappedNavigation.BackAsync().ConfigureAwait(false);
                     this.parentDriver.OnNavigatedBack(e);
                 }
                 catch (Exception ex)
@@ -861,15 +871,24 @@ public void Back()
             }
 
             /// <summary>
-            /// Move the browser forward
+            /// Move a single "item" forward in the browser's history.
             /// </summary>
             public void Forward()
+            {
+                Task.Run(this.ForwardAsync).GetAwaiter().GetResult();
+            }
+
+            /// <summary>
+            /// Move a single "item" forward in the browser's history as an asynchronous task.
+            /// </summary>
+            /// <returns>A task object representing the asynchronous operation.</returns>
+            public async Task ForwardAsync()
             {
                 try
                 {
                     WebDriverNavigationEventArgs e = new WebDriverNavigationEventArgs(this.parentDriver);
                     this.parentDriver.OnNavigatingForward(e);
-                    this.wrappedNavigation.Forward();
+                    await this.wrappedNavigation.ForwardAsync().ConfigureAwait(false);
                     this.parentDriver.OnNavigatedForward(e);
                 }
                 catch (Exception ex)
@@ -880,16 +899,31 @@ public void Forward()
             }
 
             /// <summary>
-            /// Navigate to a url for your test
+            /// Navigate to a url.
             /// </summary>
             /// <param name="url">String of where you want the browser to go to</param>
             public void GoToUrl(string url)
             {
+                Task.Run(() => this.GoToUrlAsync(url)).GetAwaiter().GetResult();
+            }
+
+            /// <summary>
+            /// Navigate to a url as an asynchronous task.
+            /// </summary>
+            /// <param name="url">String of where you want the browser to go.</param>
+            /// <returns>A task object representing the asynchronous operation.</returns>
+            public async Task GoToUrlAsync(string url)
+            {
+                if (url == null)
+                {
+                    throw new ArgumentNullException(nameof(url), "url cannot be null");
+                }
+
                 try
                 {
                     WebDriverNavigationEventArgs e = new WebDriverNavigationEventArgs(this.parentDriver, url);
                     this.parentDriver.OnNavigating(e);
-                    this.wrappedNavigation.GoToUrl(url);
+                    await this.wrappedNavigation.GoToUrlAsync(url).ConfigureAwait(false);
                     this.parentDriver.OnNavigated(e);
                 }
                 catch (Exception ex)
@@ -900,38 +934,46 @@ public void GoToUrl(string url)
             }
 
             /// <summary>
-            /// Navigate to a url for your test
+            /// Navigate to a url.
             /// </summary>
             /// <param name="url">Uri object of where you want the browser to go to</param>
             public void GoToUrl(Uri url)
+            {
+                Task.Run(() => this.GoToUrlAsync(url)).GetAwaiter().GetResult();
+            }
+
+            /// <summary>
+            /// Navigate to a url as an asynchronous task.
+            /// </summary>
+            /// <param name="url">Uri object of where you want the browser to go.</param>
+            /// <returns>A task object representing the asynchronous operation.</returns>
+            public async Task GoToUrlAsync(Uri url)
             {
                 if (url == null)
                 {
                     throw new ArgumentNullException(nameof(url), "url cannot be null");
                 }
 
-                try
-                {
-                    WebDriverNavigationEventArgs e = new WebDriverNavigationEventArgs(this.parentDriver, url.ToString());
-                    this.parentDriver.OnNavigating(e);
-                    this.wrappedNavigation.GoToUrl(url);
-                    this.parentDriver.OnNavigated(e);
-                }
-                catch (Exception ex)
-                {
-                    this.parentDriver.OnException(new WebDriverExceptionEventArgs(this.parentDriver, ex));
-                    throw;
-                }
+                await this.GoToUrlAsync(url.ToString()).ConfigureAwait(false);
             }
 
             /// <summary>
-            /// Refresh the browser
+            /// Reload the current page.
             /// </summary>
             public void Refresh()
+            {
+                Task.Run(this.RefreshAsync).GetAwaiter().GetResult();
+            }
+
+            /// <summary>
+            /// Reload the current page as an asynchronous task.
+            /// </summary>
+            /// <returns>A task object representing the asynchronous operation.</returns>
+            public async Task RefreshAsync()
             {
                 try
                 {
-                    this.wrappedNavigation.Refresh();
+                    await this.wrappedNavigation.RefreshAsync().ConfigureAwait(false);
                 }
                 catch (Exception ex)
                 {

dotnet/src/webdriver/INavigation.cs

@@ -17,6 +17,7 @@
 // </copyright>
 
 using System;
+using System.Threading.Tasks;
 
 namespace OpenQA.Selenium
 {
@@ -31,12 +32,24 @@ public interface INavigation
         /// </summary>
         void Back();
 
+        /// <summary>
+        /// Move back a single entry in the browser's history as an asynchronous task.
+        /// </summary>
+        /// <returns>A task object representing the asynchronous operation.</returns>
+        Task BackAsync();
+
         /// <summary>
         /// Move a single "item" forward in the browser's history.
         /// </summary>
         /// <remarks>Does nothing if we are on the latest page viewed.</remarks>
         void Forward();
 
+        /// <summary>
+        /// Move a single "item" forward in the browser's history as an asynchronous task.
+        /// </summary>
+        /// <returns>A task object representing the asynchronous operation.</returns>
+        Task ForwardAsync();
+
         /// <summary>
         ///  Load a new web page in the current browser window.
         /// </summary>
@@ -52,6 +65,13 @@ public interface INavigation
         /// </remarks>
         void GoToUrl(string url);
 
+        /// <summary>
+        /// Navigate to a url as an asynchronous task.
+        /// </summary>
+        /// <param name="url">String of where you want the browser to go.</param>
+        /// <returns>A task object representing the asynchronous operation.</returns>
+        Task GoToUrlAsync(string url);
+
         /// <summary>
         ///  Load a new web page in the current browser window.
         /// </summary>
@@ -67,9 +87,22 @@ public interface INavigation
         /// </remarks>
         void GoToUrl(Uri url);
 
+        /// <summary>
+        /// Navigate to a url as an asynchronous task.
+        /// </summary>
+        /// <param name="url">Uri object of where you want the browser to go.</param>
+        /// <returns>A task object representing the asynchronous operation.</returns>
+        Task GoToUrlAsync(Uri url);
+
         /// <summary>
         /// Refreshes the current page.
         /// </summary>
         void Refresh();
+
+        /// <summary>
+        /// Reload the current page as an asynchronous task.
+        /// </summary>
+        /// <returns>A task object representing the asynchronous operation.</returns>
+        Task RefreshAsync();
     }
 }

dotnet/test/support/Events/EventFiringWebDriverTest.cs

@@ -58,12 +58,15 @@ Navigated back
 Navigating forward
 Navigated forward
 ";
+            string normalizedExpectedLog = expectedLog.Replace("\r\n", "\n").Replace("\r", "\n");
             mockDriver.VerifySet(x => x.Url = "http://www.get.com", Times.Once);
             mockDriver.Verify(x => x.Navigate(), Times.Exactly(3));
-            mockNavigation.Verify(x => x.GoToUrl("http://www.navigate-to.com"), Times.Once);
-            mockNavigation.Verify(x => x.Back(), Times.Once);
-            mockNavigation.Verify(x => x.Forward(), Times.Once);
-            Assert.AreEqual(expectedLog, log.ToString());
+            mockNavigation.Verify(x => x.GoToUrlAsync("http://www.navigate-to.com"), Times.Once);
+            mockNavigation.Verify(x => x.BackAsync(), Times.Once);
+            mockNavigation.Verify(x => x.ForwardAsync(), Times.Once);
+
+            string normalizedActualLog =  log.ToString().Replace("\r\n", "\n").Replace("\r", "\n");
+            Assert.AreEqual(normalizedExpectedLog, normalizedActualLog);
         }
 
         [Test]