Set Playwright HttpCredentials.Origin to scope auth header correctly

featurist · Mar 1, 2024 · 95a48e3 · 95a48e3
1 parent 97cbad8
commit 95a48e3
Show file tree

Hide file tree

Showing 11 changed files with 62 additions and 52 deletions.
diff --git a/src/Coypu.AcceptanceTests/Examples/CustomSeleniumBrowserSession.cs b/src/Coypu.AcceptanceTests/Examples/CustomSeleniumBrowserSession.cs
@@ -45,7 +45,7 @@ public void CustomBrowser(string browserName)
             {
                 Assert.Inconclusive("This test requires Internet Explorer and will only run on Windows.");
             }
-            var driver = new SeleniumWebDriver(browser, false);
+            var driver = new SeleniumWebDriver(new SessionConfiguration{Browser = browser, Headless = false});
             using (var custom = new BrowserSession(driver))
             {
                 custom.Visit("https://saucelabs.com/test/guinea-pig");

diff --git a/src/Coypu.Drivers.Tests/DriverSpecs.cs b/src/Coypu.Drivers.Tests/DriverSpecs.cs
@@ -91,7 +91,7 @@ private static void EnsureDriver()
                 _driver.Dispose();
             }
 
-            _driver = (IDriver) Activator.CreateInstance(DriverType, Browser, Headless);
+            _driver = (IDriver) Activator.CreateInstance(DriverType, new SessionConfiguration{Driver = DriverType, Browser = Browser, Headless = Headless});
 
             _root = null;
         }

diff --git a/src/Coypu.Tests/When_interacting_with_the_browser/BrowserInteractionTests.cs b/src/Coypu.Tests/When_interacting_with_the_browser/BrowserInteractionTests.cs
@@ -108,7 +108,7 @@ public StubDriverFactory(IDriver driver)
             this.driver = driver;
         }
 
-        public IDriver NewWebDriver(Type driverType, Drivers.Browser browser, bool Headless, string appHost)
+        public IDriver NewWebDriver(SessionConfiguration sessionConfiguration)
         {
             return driver;
         }

diff --git a/src/Coypu/ActivatorDriverFactory.cs b/src/Coypu/ActivatorDriverFactory.cs
@@ -7,11 +7,11 @@ public class ActivatorDriverFactory : DriverFactory
     {
         public static int OpenDrivers { get; set; }
 
-        public IDriver NewWebDriver(Type driverType, Drivers.Browser browser, bool headless, string appHost)
+        public IDriver NewWebDriver(SessionConfiguration sessionConfiguration)
         {
             try
             {
-                var driver = (IDriver)Activator.CreateInstance(driverType, browser, headless, appHost);
+                var driver = (IDriver)Activator.CreateInstance(sessionConfiguration.Driver, sessionConfiguration);
                 OpenDrivers++;
                 return driver;
             }

diff --git a/src/Coypu/BrowserSession.cs b/src/Coypu/BrowserSession.cs
@@ -72,7 +72,7 @@ internal BrowserSession(SessionConfiguration sessionConfiguration,
                                 RestrictedResourceDownloader restrictedResourceDownloader)
             : base(sessionConfiguration,
                    null,
-                   driverFactory.NewWebDriver(sessionConfiguration.Driver, sessionConfiguration.Browser, sessionConfiguration.Headless, sessionConfiguration.AppHost),
+                   driverFactory.NewWebDriver(sessionConfiguration),
                    timingStrategy,
                    waiter,
                    urlBuilder,

diff --git a/src/Coypu/DriverFactory.cs b/src/Coypu/DriverFactory.cs
@@ -4,6 +4,6 @@ namespace Coypu
 {
     public interface DriverFactory
     {
-        IDriver NewWebDriver(Type driverType, Drivers.Browser browser, bool headless, string appHost);
+        IDriver NewWebDriver(SessionConfiguration sessionConfiguration);
     }
 }
diff --git a/src/Coypu/Drivers/Playwright/PlaywrightDriver.cs b/src/Coypu/Drivers/Playwright/PlaywrightDriver.cs
@@ -6,7 +6,6 @@
 using Cookie = System.Net.Cookie;
 using Microsoft.Playwright;
 using System.Collections.Immutable;
-using System.Threading.Tasks;
 
 #pragma warning disable 1591
 
@@ -21,36 +20,36 @@ public class PlaywrightDriver : IDriver
         private readonly IBrowser _playwrightBrowser;
         private IBrowserContext _context;
 
-        public PlaywrightDriver(Browser browser, bool headless, string appHost)
+        public PlaywrightDriver(SessionConfiguration sessionConfiguration)
         {
             _dialogs = new Dialogs();
             _playwright = Microsoft.Playwright.Playwright.CreateAsync().Sync();
-            _browser = browser;
-            _headless = headless;
-            var browserType = PlaywrightBrowserType(browser, _playwright); // TODO: map browser to playwright browser type
+            _browser = sessionConfiguration.Browser;
+            _headless = sessionConfiguration.Headless;
+            var browserType = PlaywrightBrowserType(_browser, _playwright); // TODO: map browser to playwright browser type
 
             _playwrightBrowser = browserType.LaunchAsync(
                 new BrowserTypeLaunchOptions
                 {
-                  Headless = headless,
-                  Channel = PlaywrightBrowserChannel(browser),
+                  Headless = _headless,
+                  Channel = PlaywrightBrowserChannel(_browser),
                 }
             ).Sync();
-            NewContext(appHost);
+            NewContext(sessionConfiguration);
         }
 
-        private void NewContext(string appHost)
+        private void NewContext(SessionConfiguration sessionConfiguration)
         {
             var options = new BrowserNewPageOptions();
-            if (Uri.IsWellFormedUriString(appHost, UriKind.Absolute))
+            if (!string.IsNullOrEmpty(sessionConfiguration.AppHost) && !string.IsNullOrEmpty(sessionConfiguration.UserInfo))
             {
-              var userInfo = new Uri(appHost).UserInfo;
-              if (!string.IsNullOrEmpty(userInfo)) {
-                var credentials = userInfo.Split(':');
+              if (!string.IsNullOrEmpty(sessionConfiguration.UserInfo)) {
+                var credentials = sessionConfiguration.UserInfo.Split(':');
                 options.HttpCredentials = new HttpCredentials
                 {
                   Username = credentials[0],
-                  Password = credentials[1]
+                  Password = credentials[1],
+                  Origin = new FullyQualifiedUrlBuilder().GetFullyQualifiedUrl("", sessionConfiguration).TrimEnd('/')
                 };
               }
             }

diff --git a/src/Coypu/Drivers/Selenium/DriverFactory.cs b/src/Coypu/Drivers/Selenium/DriverFactory.cs
@@ -1,7 +1,6 @@
 using System;
 using OpenQA.Selenium;
 using OpenQA.Selenium.Chrome;
-using OpenQA.Selenium.DevTools.V85.HeadlessExperimental;
 using OpenQA.Selenium.Edge;
 using OpenQA.Selenium.Firefox;
 using OpenQA.Selenium.IE;
@@ -12,17 +11,18 @@ namespace Coypu.Drivers.Selenium
 {
     internal class DriverFactory
     {
-        public IWebDriver NewWebDriver(Browser browser, bool headless)
+        public IWebDriver NewWebDriver(SessionConfiguration sessionConfiguration)
         {
+            var browser = sessionConfiguration.Browser;
             var firefoxOptions = new FirefoxOptions();
             var chromeOptions = new ChromeOptions();
             EdgeOptions edgeOptions = new EdgeOptions();
-            if (headless) {
+            if (sessionConfiguration.Headless) {
               firefoxOptions.AddArgument("--headless");
               chromeOptions.AddArgument("--headless=new");
               edgeOptions.AddArgument("headless");
               edgeOptions.AddArgument("disable-gpu");
-              if (browser == Browser.Safari) {
+              if (sessionConfiguration.Browser == Browser.Safari) {
                 throw new NotSupportedException("Safari does not support headless mode");
               }
               if (browser == Browser.Safari) {

diff --git a/src/Coypu/Drivers/Selenium/SeleniumWebDriver.cs b/src/Coypu/Drivers/Selenium/SeleniumWebDriver.cs
@@ -22,8 +22,8 @@ public class SeleniumWebDriver : IDriver
         private IWebDriver _webDriver;
         private readonly WindowHandleFinder _windowHandleFinder;
 
-        public SeleniumWebDriver(Browser browser, bool headless, string _appHost = null)
-            : this(new DriverFactory().NewWebDriver(browser, headless), browser) { }
+        public SeleniumWebDriver(SessionConfiguration sessionConfiguration)
+            : this(new DriverFactory().NewWebDriver(sessionConfiguration), sessionConfiguration.Browser) { }
 
         protected SeleniumWebDriver(IWebDriver webDriver,
                                     Browser browser)

diff --git a/src/Coypu/FullyQualifiedUrlBuilder.cs b/src/Coypu/FullyQualifiedUrlBuilder.cs
@@ -1,18 +1,29 @@
-using System;
-
-namespace Coypu
-{
-    internal class FullyQualifiedUrlBuilder : UrlBuilder
-    {
-        public string GetFullyQualifiedUrl(string virtualPath, SessionConfiguration sessionConfiguration)
-        {
-            var scheme = sessionConfiguration.SSL ? "https" : "http";
-            var userInfoPart = string.IsNullOrEmpty(sessionConfiguration.UserInfo) ? "" : sessionConfiguration.UserInfo + "@";
-            var baseUrl = sessionConfiguration.Port == 80
-                ? $"{scheme}://{userInfoPart}{sessionConfiguration.AppHost}"
-                : $"{scheme}://{userInfoPart}{sessionConfiguration.AppHost}:{sessionConfiguration.Port}";
-
-            return new Uri(new Uri(baseUrl), virtualPath).AbsoluteUri;
-        }
-    }
-}
+using System;
+
+namespace Coypu
+{
+    internal class FullyQualifiedUrlBuilder : UrlBuilder
+    {
+        public string GetFullyQualifiedUrl(string virtualPath, SessionConfiguration sessionConfiguration)
+    {
+      var scheme = sessionConfiguration.SSL ? "https" : "http";
+      string userInfoPart = GetUserInfoPart(sessionConfiguration);
+      var baseUrl = sessionConfiguration.Port == 80
+          ? $"{scheme}://{userInfoPart}{sessionConfiguration.AppHost}"
+          : $"{scheme}://{userInfoPart}{sessionConfiguration.AppHost}:{sessionConfiguration.Port}";
+
+      return new Uri(new Uri(baseUrl), virtualPath).AbsoluteUri;
+    }
+
+    private static string GetUserInfoPart(SessionConfiguration sessionConfiguration)
+    {
+      // PlaywrightDriver implements basic auth properly via the Authorization header
+      if (sessionConfiguration.Driver == typeof(Drivers.Playwright.PlaywrightDriver) ||
+          string.IsNullOrEmpty(sessionConfiguration.UserInfo))
+      {
+        return string.Empty;
+      }
+      return sessionConfiguration.UserInfo + "@";
+    }
+  }
+}
diff --git a/src/Coypu/UrlBuilder.cs b/src/Coypu/UrlBuilder.cs
@@ -1,7 +1,7 @@
-namespace Coypu
-{
-    public interface UrlBuilder
-    {
-        string GetFullyQualifiedUrl(string virtualPath, SessionConfiguration sessionConfiguration);
-    }
-}
+namespace Coypu
+{
+    public interface UrlBuilder
+    {
+        string GetFullyQualifiedUrl(string virtualPath, SessionConfiguration sessionConfiguration);
+    }
+}