[dotnet] implement navigation commands with WebDriver BiDi

Author: titusfortner

dotnet/src/webdriver/Navigator.cs

@@ -19,6 +19,7 @@
 using System;
 using System.Collections.Generic;
 using System.Threading.Tasks;
+using WebDriverBiDi.BrowsingContext;
 
 namespace OpenQA.Selenium
 {
@@ -28,6 +29,7 @@ namespace OpenQA.Selenium
     internal class Navigator : INavigation
     {
         private WebDriver driver;
+        private string browsingContextId;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="Navigator"/> class
@@ -36,6 +38,8 @@ internal class Navigator : INavigation
         public Navigator(WebDriver driver)
         {
             this.driver = driver;
+            // TODO: store the value of the current window's context id on the driver object
+            this.browsingContextId = driver.CurrentWindowHandle;
         }
 
         /// <summary>
@@ -55,7 +59,17 @@ public void Back()
         /// <returns>A task object representing the asynchronous operation.</returns>
         public async Task BackAsync()
         {
-            await this.driver.InternalExecuteAsync(DriverCommand.GoBack, null).ConfigureAwait(false);
+            if (this.driver.BiDiDriver != null)
+            {
+                var traverseHistoryCommandParameters =
+                    new TraverseHistoryCommandParameters(this.browsingContextId, -1);
+                await this.driver.BiDiDriver.BrowsingContext.TraverseHistoryAsync(traverseHistoryCommandParameters)
+                    .ConfigureAwait(false);
+            }
+            else
+            {
+                await this.driver.InternalExecuteAsync(DriverCommand.GoBack, null).ConfigureAwait(false);
+            }
         }
 
         /// <summary>
@@ -75,7 +89,17 @@ public void Forward()
         /// <returns>A task object representing the asynchronous operation.</returns>
         public async Task ForwardAsync()
         {
-            await this.driver.InternalExecuteAsync(DriverCommand.GoForward, null).ConfigureAwait(false);
+            if (this.driver.BiDiDriver != null)
+            {
+                var traverseHistoryCommandParameters =
+                    new TraverseHistoryCommandParameters(this.browsingContextId, 1);
+                await this.driver.BiDiDriver.BrowsingContext.TraverseHistoryAsync(traverseHistoryCommandParameters)
+                    .ConfigureAwait(false);
+            }
+            else
+            {
+                await this.driver.InternalExecuteAsync(DriverCommand.GoForward, null).ConfigureAwait(false);
+            }
         }
 
         /// <summary>
@@ -102,11 +126,18 @@ public async Task GoToUrlAsync(string url)
                 throw new ArgumentNullException(nameof(url), "URL cannot be null.");
             }
 
-            Dictionary<string, object> parameters = new Dictionary<string, object>
+            if (this.driver.BiDiDriver != null)
             {
-                { "url", url }
-            };
-            await this.driver.InternalExecuteAsync(DriverCommand.Get, parameters).ConfigureAwait(false);
+                await driver.BiDiDriver.BrowsingContext.NavigateAsync(new NavigateCommandParameters(this.browsingContextId, url)).ConfigureAwait(false);
+            }
+            else
+            {
+                Dictionary<string, object> parameters = new Dictionary<string, object>
+                {
+                    { "url", url }
+                };
+                await this.driver.InternalExecuteAsync(DriverCommand.Get, parameters).ConfigureAwait(false);
+            }
         }
 
         /// <summary>
@@ -153,8 +184,16 @@ public void Refresh()
         /// <returns>A task object representing the asynchronous operation.</returns>
         public async Task RefreshAsync()
         {
-            // driver.SwitchTo().DefaultContent();
-            await this.driver.InternalExecuteAsync(DriverCommand.Refresh, null).ConfigureAwait(false);
+            if (this.driver.BiDiDriver != null)
+            {
+                var reloadCommandParameters =
+                    new ReloadCommandParameters(this.browsingContextId);
+                await this.driver.BiDiDriver.BrowsingContext.ReloadAsync(reloadCommandParameters).ConfigureAwait(false);
+            }
+            else
+            {
+                await this.driver.InternalExecuteAsync(DriverCommand.Refresh, null).ConfigureAwait(false);
+            }
         }
     }
 }

dotnet/test/common/NavigationTest.cs

@@ -1,6 +1,7 @@
 using NUnit.Framework;
 using System;
 using System.Threading.Tasks;
+using WebDriverBiDi;
 
 namespace OpenQA.Selenium
 {
@@ -13,10 +14,20 @@ public class NavigationTest : DriverTestFixture
         [NeedsFreshDriver(IsCreatedBeforeTest = true)]
         public void ShouldNotHaveProblemNavigatingWithNoPagesBrowsed()
         {
-            INavigation navigation;
-            navigation = driver.Navigate();
-            navigation.Back();
-            navigation.Forward();
+             INavigation navigation = driver.Navigate();
+
+            if (((WebDriver)driver).Capabilities.HasCapability("webSocketUrl"))
+            {
+                var ex1 = Assert.Throws<WebDriverBiDiException>(() => navigation.Back());
+                Assert.True(ex1!.Message.Contains("no such history entry"));
+                var ex2 = Assert.Throws<WebDriverBiDiException>(() => navigation.Forward());
+                Assert.True(ex2!.Message.Contains("no such history entry"));
+            }
+            else
+            {
+                Assert.DoesNotThrow(() => navigation.Back());
+                Assert.DoesNotThrow(() => navigation.Forward());
+            }
         }
 
         [Test]
@@ -25,8 +36,8 @@ public void ShouldGoBackAndForward()
             INavigation navigation;
             navigation = driver.Navigate();
 
-            driver.Url = macbethPage;
-            driver.Url = simpleTestPage;
+            navigation.GoToUrl(macbethPage);
+            navigation.GoToUrl(simpleTestPage);
 
             navigation.Back();
             Assert.AreEqual(macbethTitle, driver.Title);
@@ -96,8 +107,18 @@ public void ShouldRefreshPage()
         public Task ShouldNotHaveProblemNavigatingWithNoPagesBrowsedAsync()
         {
             var navigation = driver.Navigate();
-            Assert.DoesNotThrowAsync(async () => await navigation.BackAsync());
-            Assert.DoesNotThrowAsync(async () => await navigation.ForwardAsync());
+            if (((WebDriver)driver).Capabilities.HasCapability("webSocketUrl"))
+            {
+                var ex1 = Assert.ThrowsAsync<WebDriverBiDiException>(async () => await navigation.BackAsync());
+                Assert.True(ex1!.Message.Contains("no such history entry"));
+                var ex2 = Assert.ThrowsAsync<WebDriverBiDiException>(async () => await navigation.ForwardAsync());
+                Assert.True(ex2!.Message.Contains("no such history entry"));
+            }
+            else
+            {
+                Assert.DoesNotThrow(() => navigation.Back());
+                Assert.DoesNotThrow(() =>navigation.Forward());
+            }
             return Task.CompletedTask;
         }
 
@@ -141,9 +162,9 @@ public void ShouldGoToUrlUsingUriAsync()
             var navigation = driver.Navigate();
 
             navigation.GoToUrlAsync(new Uri(macbethPage));
-            Assert.AreEqual(driver.Title, macbethTitle);
-            navigation.GoToUrl(new Uri(simpleTestPage));
-            Assert.AreEqual(simpleTestTitle, driver.Title);
+            Assert.AreEqual(macbethTitle, driver.Title);
+            navigation.GoToUrlAsync(new Uri(simpleTestPage));
+            Assert.AreEqual(driver.Title, simpleTestTitle);
         }
 
         [Test]