[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>
@@ -52,7 +56,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>
@@ -69,7 +83,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>
@@ -93,11 +117,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>
@@ -138,8 +169,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,5 +1,6 @@
 using NUnit.Framework;
 using System;
+using WebDriverBiDi;
 
 namespace OpenQA.Selenium
 {
@@ -12,10 +13,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
+            {
+                navigation.Back();
+                navigation.Forward();
+            }
         }
 
         [Test]
@@ -40,7 +51,7 @@ public void ShouldAcceptInvalidUrlsUsingUris()
             INavigation navigation;
             navigation = driver.Navigate();
             Assert.That(() => navigation.GoToUrl((Uri)null), Throws.InstanceOf<ArgumentNullException>());
-            // new Uri("") and new Uri("isidsji30342??éåµñ©æ") 
+            // new Uri("") and new Uri("isidsji30342??éåµñ©æ")
             // throw an exception, so we needn't worry about them.
         }
 
@@ -89,6 +100,5 @@ public void ShouldRefreshPage()
             changedDiv = driver.FindElement(By.Id("dynamo"));
             Assert.AreEqual("What's for dinner?", changedDiv.Text);
         }
-
     }
 }