Merge branch 'trunk' into interface_ip

harsha509 · web-flow · commit 7e19fdc705b1 · 2024-09-17T13:06:03.000-04:00
diff --git a/.gitignore b/.gitignore
@@ -78,6 +78,7 @@ py/docs/source/**/*
 py/build/
 py/LICENSE
 py/pytestdebug.log
+py/python.iml
 selenium.egg-info/
 third_party/java/jetty/jetty-repacked.jar
 *.user
diff --git a/MODULE.bazel b/MODULE.bazel
@@ -1,10 +1,10 @@
 module(name = "selenium")
 
 bazel_dep(name = "apple_rules_lint", version = "0.4.0")
-bazel_dep(name = "aspect_bazel_lib", version = "2.7.9")
-bazel_dep(name = "aspect_rules_esbuild", version = "0.20.1")
-bazel_dep(name = "aspect_rules_js", version = "1.42.3")
-bazel_dep(name = "aspect_rules_ts", version = "2.4.2")
+bazel_dep(name = "aspect_bazel_lib", version = "2.8.1")
+bazel_dep(name = "aspect_rules_esbuild", version = "0.21.0")
+bazel_dep(name = "aspect_rules_js", version = "2.0.1")
+bazel_dep(name = "aspect_rules_ts", version = "3.1.0")
 bazel_dep(name = "bazel_features", version = "1.13.0")
 bazel_dep(name = "bazel_skylib", version = "1.7.1")
 bazel_dep(name = "buildifier_prebuilt", version = "6.4.0")
@@ -18,7 +18,7 @@ bazel_dep(name = "protobuf", version = "21.7", dev_dependency = True, repo_name
 bazel_dep(name = "rules_cc", version = "0.0.9", dev_dependency = True)
 
 bazel_dep(name = "rules_dotnet", version = "0.15.1")
-bazel_dep(name = "rules_java", version = "7.6.3")
+bazel_dep(name = "rules_java", version = "7.11.1")
 bazel_dep(name = "rules_jvm_external", version = "6.3")
 bazel_dep(name = "rules_nodejs", version = "6.2.0")
 bazel_dep(name = "rules_oci", version = "1.7.6")
diff --git a/dotnet/src/webdriver/BiDi/WebDriver.Extensions.cs b/dotnet/src/webdriver/BiDi/WebDriver.Extensions.cs
@@ -5,7 +5,7 @@ namespace OpenQA.Selenium.BiDi;
 
 public static class WebDriverExtensions
 {
-    public static async Task<BiDi> AsBidirectionalAsync(this IWebDriver webDriver)
+    public static async Task<BiDi> AsBiDiAsync(this IWebDriver webDriver)
     {
         var webSocketUrl = ((IHasCapabilities)webDriver).Capabilities.GetCapability("webSocketUrl");
 
@@ -16,9 +16,9 @@ public static async Task<BiDi> AsBidirectionalAsync(this IWebDriver webDriver)
         return bidi;
     }
 
-    public static async Task<BrowsingContext> AsBidirectionalContextAsync(this IWebDriver webDriver)
+    public static async Task<BrowsingContext> AsBiDiContextAsync(this IWebDriver webDriver)
     {
-        var bidi = await webDriver.AsBidirectionalAsync();
+        var bidi = await webDriver.AsBiDiAsync();
 
         var currentBrowsingContext = new BrowsingContext(bidi, webDriver.CurrentWindowHandle);
 
diff --git a/java/test/org/openqa/selenium/environment/webserver/CookieHandler.java b/java/test/org/openqa/selenium/environment/webserver/CookieHandler.java
@@ -116,9 +116,9 @@ private Collection<Cookie> getCookies(HttpRequest request) {
   private void addCookie(HttpResponse response, Cookie cook) {
     StringBuilder cookie = new StringBuilder();
 
-    // TODO: escape string as necessary
-    String name = cook.getName();
-    cookie.append(name).append("=").append(cook.getValue()).append("; ");
+    String name = escapeCookieValue(cook.getName());
+    String value = escapeCookieValue(cook.getValue());
+    cookie.append(name).append("=").append(value).append("; ");
 
     append(cookie, cook.getDomain(), str -> "Domain=" + str);
     append(cookie, cook.getPath(), str -> "Path=" + str);
@@ -191,4 +191,45 @@ private Cookie parse(String cookieString) {
 
     return builder.build();
   }
+
+  private String escapeCookieValue(String value) {
+    if (value == null || value.isEmpty()) {
+      return "";
+    }
+
+    StringBuilder cookieValue = new StringBuilder();
+
+    for (char c : value.toCharArray()) {
+      switch (c) {
+        case '\\':
+          cookieValue.append("\\\\");
+          break;
+        case '"':
+          cookieValue.append("\\\"");
+          break;
+        case ';':
+          cookieValue.append("\\;");
+          break;
+        case ',':
+          cookieValue.append("\\,");
+          break;
+        case '\r':
+        case '\n':
+          // Skip carriage return and newline characters
+          break;
+        case '<':
+          cookieValue.append("&lt;");
+          break;
+        case '>':
+          cookieValue.append("&gt;");
+          break;
+        case '&':
+          cookieValue.append("&amp;");
+          break;
+        default:
+          cookieValue.append(c); // Append safe characters as they are
+      }
+    }
+    return cookieValue.toString();
+  }
 }
diff --git a/javascript/node/selenium-webdriver/CHANGES.md b/javascript/node/selenium-webdriver/CHANGES.md
@@ -1,6 +1,6 @@
 ## 4.24.1
 
--  Close CDP websocket connection on driver.quit (#14501)
+- Close CDP websocket connection on driver.quit (#14501)
 
 ## 4.24.0
 
diff --git a/javascript/node/selenium-webdriver/test/bidi/network_test.js b/javascript/node/selenium-webdriver/test/bidi/network_test.js
@@ -42,7 +42,9 @@ suite(
       it('can listen to event before request is sent', async function () {
         let beforeRequestEvent = null
         await network.beforeRequestSent(function (event) {
-          beforeRequestEvent = event
+          if (event.request.url.includes('empty')) {
+            beforeRequestEvent = event
+          }
         })
 
         await driver.get(Pages.emptyPage)
diff --git a/rb/lib/selenium/webdriver/chrome/service.rb b/rb/lib/selenium/webdriver/chrome/service.rb
@@ -24,6 +24,7 @@ class Service < WebDriver::Service
         DEFAULT_PORT = 9515
         EXECUTABLE = 'chromedriver'
         SHUTDOWN_SUPPORTED = true
+        DRIVER_PATH_ENV_KEY = 'SE_CHROMEDRIVER'
 
         def log
           return @log unless @log.is_a? String
diff --git a/rb/lib/selenium/webdriver/common/service.rb b/rb/lib/selenium/webdriver/common/service.rb
@@ -69,6 +69,7 @@ def driver_path=(path)
       def initialize(path: nil, port: nil, log: nil, args: nil)
         port ||= self.class::DEFAULT_PORT
         args ||= []
+        path ||= env_path
 
         @executable_path = path
         @host = Platform.localhost
@@ -87,16 +88,22 @@ def initialize(path: nil, port: nil, log: nil, args: nil)
       end
 
       def launch
-        @executable_path ||= begin
-          default_options = WebDriver.const_get("#{self.class.name&.split('::')&.[](2)}::Options").new
-          DriverFinder.new(default_options, self).driver_path
-        end
+        @executable_path ||= env_path || find_driver_path
         ServiceManager.new(self).tap(&:start)
       end
 
       def shutdown_supported
         self.class::SHUTDOWN_SUPPORTED
       end
+
+      def find_driver_path
+        default_options = WebDriver.const_get("#{self.class.name&.split('::')&.[](2)}::Options").new
+        DriverFinder.new(default_options, self).driver_path
+      end
+
+      def env_path
+        ENV.fetch(self.class::DRIVER_PATH_ENV_KEY, nil)
+      end
     end # Service
   end # WebDriver
 end # Selenium
diff --git a/rb/lib/selenium/webdriver/edge/service.rb b/rb/lib/selenium/webdriver/edge/service.rb
@@ -24,7 +24,7 @@ class Service < WebDriver::Service
         DEFAULT_PORT = 9515
         EXECUTABLE = 'msedgedriver'
         SHUTDOWN_SUPPORTED = true
-
+        DRIVER_PATH_ENV_KEY = 'SE_EDGEDRIVER'
         def log
           return @log unless @log.is_a? String
 
diff --git a/rb/lib/selenium/webdriver/firefox/service.rb b/rb/lib/selenium/webdriver/firefox/service.rb
@@ -24,6 +24,7 @@ class Service < WebDriver::Service
         DEFAULT_PORT = 4444
         EXECUTABLE = 'geckodriver'
         SHUTDOWN_SUPPORTED = false
+        DRIVER_PATH_ENV_KEY = 'SE_GECKODRIVER'
       end # Service
     end # Firefox
   end # WebDriver
diff --git a/rb/lib/selenium/webdriver/ie/service.rb b/rb/lib/selenium/webdriver/ie/service.rb
@@ -24,6 +24,7 @@ class Service < WebDriver::Service
         DEFAULT_PORT = 5555
         EXECUTABLE = 'IEDriverServer'
         SHUTDOWN_SUPPORTED = true
+        DRIVER_PATH_ENV_KEY = 'SE_IEDRIVER'
       end # Server
     end # IE
   end # WebDriver
diff --git a/rb/lib/selenium/webdriver/safari/service.rb b/rb/lib/selenium/webdriver/safari/service.rb
@@ -24,7 +24,7 @@ class Service < WebDriver::Service
         DEFAULT_PORT = 7050
         EXECUTABLE = 'safaridriver'
         SHUTDOWN_SUPPORTED = false
-
+        DRIVER_PATH_ENV_KEY = 'SE_SAFARIDRIVER'
         def initialize(path: nil, port: nil, log: nil, args: nil)
           raise Error::WebDriverError, 'Safari Service does not support setting log output' if log
 
diff --git a/rb/sig/lib/selenium/webdriver/chrome/service.rbs b/rb/sig/lib/selenium/webdriver/chrome/service.rbs
@@ -2,6 +2,8 @@ module Selenium
   module WebDriver
     module Chrome
       class Service < WebDriver::Service
+        DRIVER_PATH_ENV_KEY: String
+
         @log: untyped
 
         DEFAULT_PORT: Integer
diff --git a/rb/sig/lib/selenium/webdriver/common/service.rbs b/rb/sig/lib/selenium/webdriver/common/service.rbs
@@ -47,6 +47,8 @@ module Selenium
 
       attr_accessor args: untyped
 
+      def env_path: -> String
+
       alias extra_args args
 
       def initialize: (?path: untyped?, ?port: untyped?, ?log: untyped?, ?args: untyped?) -> void
diff --git a/rb/sig/lib/selenium/webdriver/edge/service.rbs b/rb/sig/lib/selenium/webdriver/edge/service.rbs
@@ -2,6 +2,8 @@ module Selenium
   module WebDriver
     module Edge
       class Service < WebDriver::Service
+        DRIVER_PATH_ENV_KEY: String
+
         @log: untyped
 
         DEFAULT_PORT: Integer
diff --git a/rb/sig/lib/selenium/webdriver/firefox/service.rbs b/rb/sig/lib/selenium/webdriver/firefox/service.rbs
@@ -4,6 +4,7 @@ module Selenium
       class Service < WebDriver::Service
         DEFAULT_PORT: 4444
 
+        DRIVER_PATH_ENV_KEY: String
         EXECUTABLE: "geckodriver"
 
         SHUTDOWN_SUPPORTED: false
diff --git a/rb/sig/lib/selenium/webdriver/ie/service.rbs b/rb/sig/lib/selenium/webdriver/ie/service.rbs
@@ -4,6 +4,7 @@ module Selenium
       class Service < WebDriver::Service
         DEFAULT_PORT: Integer
 
+        DRIVER_PATH_ENV_KEY: String
         EXECUTABLE: String
 
         SHUTDOWN_SUPPORTED: bool
diff --git a/rb/sig/lib/selenium/webdriver/safari/service.rbs b/rb/sig/lib/selenium/webdriver/safari/service.rbs
@@ -4,6 +4,7 @@ module Selenium
       class Service < WebDriver::Service
         DEFAULT_PORT: Integer
 
+        DRIVER_PATH_ENV_KEY: String
         EXECUTABLE: String
 
         SHUTDOWN_SUPPORTED: bool
diff --git a/rb/spec/integration/selenium/webdriver/ie/service_spec.rb b/rb/spec/integration/selenium/webdriver/ie/service_spec.rb
@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+require_relative '../spec_helper'
+
+module Selenium
+  module WebDriver
+    module IE
+      describe Service, exclusive: [{bidi: false, reason: 'Not yet implemented with BiDi'}, {browser: :ie}] do
+        let(:service) { described_class.new }
+        let(:service_manager) { service.launch }
+
+        after { service_manager.stop }
+
+        it 'auto uses iedriver' do
+          service.executable_path = DriverFinder.new(Options.new, described_class.new).driver_path
+
+          expect(service_manager.uri).to be_a(URI)
+        end
+
+        it 'can be started outside driver' do
+          expect(service_manager.uri).to be_a(URI)
+        end
+      end
+    end # IE
+  end # WebDriver
+end # Selenium
diff --git a/rb/spec/integration/selenium/webdriver/safari/service_spec.rb b/rb/spec/integration/selenium/webdriver/safari/service_spec.rb
@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+require_relative '../spec_helper'
+
+module Selenium
+  module WebDriver
+    module Safari
+      describe Service, exclusive: [{bidi: false, reason: 'Not yet implemented with BiDi'}, {browser: :safari}] do
+        let(:service) { described_class.new }
+        let(:service_manager) { service.launch }
+
+        after { service_manager.stop }
+
+        it 'auto uses safaridriver' do
+          service.executable_path = DriverFinder.new(Options.new, described_class.new).driver_path
+
+          expect(service_manager.uri).to be_a(URI)
+        end
+
+        it 'can be started outside driver' do
+          expect(service_manager.uri).to be_a(URI)
+        end
+      end
+    end # Safari
+  end # WebDriver
+end # Selenium
diff --git a/rb/spec/unit/selenium/webdriver/chrome/service_spec.rb b/rb/spec/unit/selenium/webdriver/chrome/service_spec.rb
@@ -119,6 +119,28 @@ module Chrome
             driver.new(service: service)
             expect(described_class).not_to have_received(:new)
           end
+
+          context 'with a path env variable' do
+            let(:service) { described_class.new }
+            let(:service_path) { "/path/to/#{Service::EXECUTABLE}" }
+
+            before do
+              ENV['SE_CHROMEDRIVER'] = service_path
+            end
+
+            after { ENV.delete('SE_CHROMEDRIVER') }
+
+            it 'uses the path from the environment' do
+              expect(service.executable_path).to match(/chromedriver/)
+            end
+
+            it 'updates the path after setting the environment variable' do
+              ENV['SE_CHROMEDRIVER'] = '/foo/bar'
+              service.executable_path = service_path
+
+              expect(service.executable_path).to match(/chromedriver/)
+            end
+          end
         end
       end
     end # Chrome
diff --git a/rb/spec/unit/selenium/webdriver/edge/service_spec.rb b/rb/spec/unit/selenium/webdriver/edge/service_spec.rb
diff --git a/rb/spec/unit/selenium/webdriver/firefox/service_spec.rb b/rb/spec/unit/selenium/webdriver/firefox/service_spec.rb
diff --git a/rb/spec/unit/selenium/webdriver/ie/service_spec.rb b/rb/spec/unit/selenium/webdriver/ie/service_spec.rb
diff --git a/rb/spec/unit/selenium/webdriver/safari/service_spec.rb b/rb/spec/unit/selenium/webdriver/safari/service_spec.rb
diff --git a/rust/src/config.rs b/rust/src/config.rs
diff --git a/rust/src/firefox.rs b/rust/src/firefox.rs
diff --git a/rust/src/lib.rs b/rust/src/lib.rs
diff --git a/rust/src/main.rs b/rust/src/main.rs
diff --git a/rust/tests/browser_tests.rs b/rust/tests/browser_tests.rs

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ namespace OpenQA.Selenium.BiDi;`
`5`	`5`
`6`	`6`	`public static class WebDriverExtensions`
`7`	`7`	`{`
`8`		`- public static async Task<BiDi> AsBidirectionalAsync(this IWebDriver webDriver)`
	`8`	`+ public static async Task<BiDi> AsBiDiAsync(this IWebDriver webDriver)`
`9`	`9`	`{`
`10`	`10`	`var webSocketUrl = ((IHasCapabilities)webDriver).Capabilities.GetCapability("webSocketUrl");`
`11`	`11`
`@@ -16,9 +16,9 @@ public static async Task<BiDi> AsBidirectionalAsync(this IWebDriver webDriver)`
`16`	`16`	`return bidi;`
`17`	`17`	`}`
`18`	`18`
`19`		`- public static async Task<BrowsingContext> AsBidirectionalContextAsync(this IWebDriver webDriver)`
	`19`	`+ public static async Task<BrowsingContext> AsBiDiContextAsync(this IWebDriver webDriver)`
`20`	`20`	`{`
`21`		`- var bidi = await webDriver.AsBidirectionalAsync();`
	`21`	`+ var bidi = await webDriver.AsBiDiAsync();`
`22`	`22`
`23`	`23`	`var currentBrowsingContext = new BrowsingContext(bidi, webDriver.CurrentWindowHandle);`
`24`	`24`