Merge branch 'trunk' into py-bidi-browsing_context

Author: navin772

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -35,13 +35,14 @@ body:
       label: Debugging Logs
       placeholder: |
         Note: the stack trace should be in the explanation section above
-        Instructions for enabling logging can be found in the link below
+        Instructions for enabling and referencing logs can be found in the links below
       render: logs
   - type: markdown
     id: link
     attributes:
       value: |
         **Read our [logging documentation](https://www.selenium.dev/documentation/webdriver/troubleshooting/logging/)**
+        **Link to a [gist](https://gist.github.com/) if logs are too long**
          
 
         ## Help us Address Your Issue Faster!

.github/workflows/ci-ruby.yml

@@ -22,15 +22,6 @@ jobs:
       cache-key: rb-docs
       run: bazel run //rb:docs
 
-  lint:
-    name: Lint
-    needs: build
-    uses: ./.github/workflows/bazel.yml
-    with:
-      name: Lint
-      cache-key: rb-lint
-      run: bazel test //rb:lint
-
   unit-tests:
     name: Unit Tests
     needs: build

.skipped-tests

@@ -57,3 +57,4 @@
 -//rb/spec/integration/selenium/webdriver:element-chrome-bidi
 -//rb/spec/integration/selenium/webdriver:element-chrome-remote
 -//rb/spec/integration/selenium/webdriver:action_builder-firefox-beta-remote
+-//rb:lint

dotnet/src/webdriver/BiDi/Communication/Transport/WebSocketTransport.cs

@@ -35,6 +35,7 @@ class WebSocketTransport(Uri _uri) : ITransport, IDisposable
     private readonly ArraySegment<byte> _receiveBuffer = new(new byte[1024 * 8]);
 
     private readonly SemaphoreSlim _socketSendSemaphoreSlim = new(1, 1);
+    private readonly MemoryStream _sharedMemoryStream = new();
 
     public async Task ConnectAsync(CancellationToken cancellationToken)
     {
@@ -43,21 +44,19 @@ public async Task ConnectAsync(CancellationToken cancellationToken)
 
     public async Task<byte[]> ReceiveAsync(CancellationToken cancellationToken)
     {
-        using var ms = new MemoryStream();
+        _sharedMemoryStream.SetLength(0);
 
         WebSocketReceiveResult result;
 
         do
         {
             result = await _webSocket.ReceiveAsync(_receiveBuffer, cancellationToken).ConfigureAwait(false);
 
-            await ms.WriteAsync(_receiveBuffer.Array!, _receiveBuffer.Offset, result.Count, cancellationToken).ConfigureAwait(false);
+            await _sharedMemoryStream.WriteAsync(_receiveBuffer.Array!, _receiveBuffer.Offset, result.Count, cancellationToken).ConfigureAwait(false);
         }
         while (!result.EndOfMessage);
 
-        ms.Seek(0, SeekOrigin.Begin);
-
-        byte[] data = ms.ToArray();
+        byte[] data = _sharedMemoryStream.ToArray();
 
         if (_logger.IsEnabled(LogEventLevel.Trace))
         {
@@ -69,10 +68,12 @@ public async Task<byte[]> ReceiveAsync(CancellationToken cancellationToken)
 
     public async Task SendAsync(byte[] data, CancellationToken cancellationToken)
     {
-        await _socketSendSemaphoreSlim.WaitAsync(cancellationToken);
+        var semaphoreTask = _socketSendSemaphoreSlim.WaitAsync(cancellationToken);
 
         try
         {
+            await semaphoreTask.ConfigureAwait(false);
+
             if (_logger.IsEnabled(LogEventLevel.Trace))
             {
                 _logger.Trace($"BiDi SND --> {Encoding.UTF8.GetString(data)}");
@@ -89,5 +90,7 @@ public async Task SendAsync(byte[] data, CancellationToken cancellationToken)
     public void Dispose()
     {
         _webSocket.Dispose();
+        _sharedMemoryStream.Dispose();
+        _socketSendSemaphoreSlim.Dispose();
     }
 }

py/selenium/webdriver/chromium/webdriver.py

@@ -19,6 +19,7 @@
 from selenium.webdriver.common.driver_finder import DriverFinder
 from selenium.webdriver.common.options import ArgOptions
 from selenium.webdriver.common.service import Service
+from selenium.webdriver.remote.command import Command
 from selenium.webdriver.remote.webdriver import WebDriver as RemoteWebDriver
 
 
@@ -149,6 +150,33 @@ def get_issue_message(self):
         session."""
         return self.execute("getIssueMessage")["value"]
 
+    @property
+    def log_types(self):
+        """Gets a list of the available log types.
+
+        Example:
+        --------
+        >>> driver.log_types
+        """
+        return self.execute(Command.GET_AVAILABLE_LOG_TYPES)["value"]
+
+    def get_log(self, log_type):
+        """Gets the log for a given log type.
+
+        Parameters:
+        -----------
+        log_type : str
+            - Type of log that which will be returned
+
+        Example:
+        --------
+        >>> driver.get_log('browser')
+        >>> driver.get_log('driver')
+        >>> driver.get_log('client')
+        >>> driver.get_log('server')
+        """
+        return self.execute(Command.GET_LOG, {"type": log_type})["value"]
+
     def set_sink_to_use(self, sink_name: str) -> dict:
         """Sets a specific sink, using its name, as a Cast session receiver
         target.

py/selenium/webdriver/remote/webdriver.py

@@ -14,7 +14,9 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
+
 """The WebDriver implementation."""
+
 import base64
 import contextlib
 import copy
@@ -223,7 +225,11 @@ def __init__(
             - Custom client configuration to use. Defaults to None.
         """
 
-        if isinstance(options, list):
+        if options is None:
+            raise TypeError(
+                "missing 1 required keyword-only argument: 'options' (instance of driver `options.Options` class)"
+            )
+        elif isinstance(options, list):
             capabilities = create_matches(options)
             _ignore_local_proxy = False
         else:
@@ -345,9 +351,14 @@ def start_session(self, capabilities: dict) -> None:
         """
 
         caps = _create_caps(capabilities)
-        response = self.execute(Command.NEW_SESSION, caps)["value"]
-        self.session_id = response.get("sessionId")
-        self.caps = response.get("capabilities")
+        try:
+            response = self.execute(Command.NEW_SESSION, caps)["value"]
+            self.session_id = response.get("sessionId")
+            self.caps = response.get("capabilities")
+        except Exception:
+            if self.service is not None:
+                self.service.stop()
+            raise
 
     def _wrap_value(self, value):
         if isinstance(value, dict):
@@ -1169,34 +1180,6 @@ def orientation(self, value) -> None:
         else:
             raise WebDriverException("You can only set the orientation to 'LANDSCAPE' and 'PORTRAIT'")
 
-    @property
-    def log_types(self):
-        """Gets a list of the available log types. This only works with w3c
-        compliant browsers.
-
-        Example:
-        --------
-        >>> driver.log_types
-        """
-        return self.execute(Command.GET_AVAILABLE_LOG_TYPES)["value"]
-
-    def get_log(self, log_type):
-        """Gets the log for a given log type.
-
-        Parameters:
-        -----------
-        log_type : str
-            - Type of log that which will be returned
-
-        Example:
-        --------
-        >>> driver.get_log('browser')
-        >>> driver.get_log('driver')
-        >>> driver.get_log('client')
-        >>> driver.get_log('server')
-        """
-        return self.execute(Command.GET_LOG, {"type": log_type})["value"]
-
     def start_devtools(self):
         global devtools
         if self._websocket_connection:

py/test/selenium/webdriver/chrome/chrome_service_tests.py

@@ -14,18 +14,19 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
+
 import os
 import subprocess
 import time
 from unittest.mock import patch
 
 import pytest
 
-from selenium.common.exceptions import WebDriverException
+from selenium.common.exceptions import SessionNotCreatedException
+from selenium.webdriver.chrome.options import Options
 from selenium.webdriver.chrome.service import Service
 
 
-@pytest.mark.xfail_chrome(raises=WebDriverException)
 @pytest.mark.no_driver_after_test
 def test_uses_chromedriver_logging(clean_driver, driver_executable) -> None:
     log_file = "chromedriver.log"
@@ -107,6 +108,17 @@ def test_log_output_null_default(driver, capfd) -> None:
     driver.quit()
 
 
+@pytest.mark.no_driver_after_test
+def test_driver_is_stopped_if_browser_cant_start(clean_driver) -> None:
+    options = Options()
+    options.add_argument("--user-data-dir=/no/such/location")
+    service = Service()
+    with pytest.raises(SessionNotCreatedException):
+        clean_driver(options=options, service=service)
+    assert not service.is_connectable()
+    assert service.process.poll() is not None
+
+
 @pytest.fixture
 def service():
     return Service()

py/test/selenium/webdriver/common/api_example_tests.py

@@ -15,11 +15,9 @@
 # specific language governing permissions and limitations
 # under the License.
 
-
 import pytest
 
 from selenium.common.exceptions import NoSuchElementException
-from selenium.common.exceptions import WebDriverException
 from selenium.webdriver.common.by import By
 from selenium.webdriver.support import expected_conditions as EC
 from selenium.webdriver.support.wait import WebDriverWait
@@ -239,7 +237,8 @@ def test_is_element_displayed(driver, pages):
     assert not not_visible
 
 
-@pytest.mark.xfail_chrome
+@pytest.mark.xfail_edge
+@pytest.mark.xfail_firefox(reason="https://github.com/mozilla/geckodriver/issues/2224")
 @pytest.mark.xfail_safari
 def test_move_window_position(driver, pages):
     pages.load("blank.html")
@@ -273,17 +272,23 @@ def test_change_window_size(driver, pages):
     assert size["height"] == newSize[1]
 
 
-@pytest.mark.xfail_firefox(raises=WebDriverException)
-@pytest.mark.xfail_remote
-@pytest.mark.xfail_safari
+@pytest.mark.xfail_ie(raises=AttributeError, reason="Logging API is no longer available")
+@pytest.mark.xfail_firefox(raises=AttributeError, reason="Logging API is no longer available")
+@pytest.mark.xfail_remote(raises=AttributeError, reason="Logging API is no longer available")
+@pytest.mark.xfail_safari(raises=AttributeError, reason="Logging API is no longer available")
+@pytest.mark.xfail_webkitgtk(raises=AttributeError, reason="Logging API is no longer available")
+@pytest.mark.xfail_wpewebkit(raises=AttributeError, reason="Logging API is no longer available")
 def test_get_log_types(driver, pages):
     pages.load("blank.html")
     assert isinstance(driver.log_types, list)
 
 
-@pytest.mark.xfail_firefox(raises=WebDriverException)
-@pytest.mark.xfail_remote
-@pytest.mark.xfail_safari
+@pytest.mark.xfail_ie(raises=AttributeError, reason="Logging API is no longer available")
+@pytest.mark.xfail_firefox(raises=AttributeError, reason="Logging API is no longer available")
+@pytest.mark.xfail_remote(raises=AttributeError, reason="Logging API is no longer available")
+@pytest.mark.xfail_safari(raises=AttributeError, reason="Logging API is no longer available")
+@pytest.mark.xfail_webkitgtk(raises=AttributeError, reason="Logging API is no longer available")
+@pytest.mark.xfail_wpewebkit()(raises=AttributeError, reason="Logging API is no longer available")
 def test_get_log(driver, pages):
     pages.load("blank.html")
     for log_type in driver.log_types:

py/test/selenium/webdriver/common/window_tests.py

@@ -45,6 +45,7 @@ def test_should_get_the_size_of_the_current_window(driver):
     assert size.get("height") > 0
 
 
+@pytest.mark.xfail_edge
 def test_should_set_the_size_of_the_current_window(driver):
     size = driver.get_window_size()
 
@@ -57,13 +58,15 @@ def test_should_set_the_size_of_the_current_window(driver):
     assert new_size.get("height") == target_height
 
 
-@pytest.mark.xfail_chrome
 def test_should_get_the_position_of_the_current_window(driver):
     position = driver.get_window_position()
     assert position.get("x") >= 0
     assert position.get("y") >= 0
 
 
+@pytest.mark.xfail_chrome
+@pytest.mark.xfail_edge
+@pytest.mark.xfail_firefox(reason="https://github.com/mozilla/geckodriver/issues/2224")
 def test_should_set_the_position_of_the_current_window(driver):
     position = driver.get_window_position()
 
@@ -81,7 +84,6 @@ def test_should_set_the_position_of_the_current_window(driver):
 
 
 @pytest.mark.xfail_safari(raises=WebDriverException, reason="Get Window Rect command not implemented")
-@pytest.mark.xfail_chrome
 def test_should_get_the_rect_of_the_current_window(driver):
     rect = driver.get_window_rect()
     assert rect.get("x") >= 0
@@ -90,6 +92,8 @@ def test_should_get_the_rect_of_the_current_window(driver):
     assert rect.get("height") >= 0
 
 
+@pytest.mark.xfail_edge
+@pytest.mark.xfail_firefox(reason="https://github.com/mozilla/geckodriver/issues/2224")
 @pytest.mark.xfail_safari(raises=WebDriverException, reason="Get Window Rect command not implemented")
 def test_should_set_the_rect_of_the_current_window(driver):
     rect = driver.get_window_rect()

py/test/selenium/webdriver/edge/edge_service_tests.py

@@ -14,18 +14,19 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
+
 import os
 import subprocess
 import time
 from unittest.mock import patch
 
 import pytest
 
-from selenium.common.exceptions import WebDriverException
+from selenium.common.exceptions import SessionNotCreatedException
+from selenium.webdriver.edge.options import Options
 from selenium.webdriver.edge.service import Service
 
 
-@pytest.mark.xfail_edge(raises=WebDriverException)
 @pytest.mark.no_driver_after_test
 def test_uses_edgedriver_logging(clean_driver, driver_executable) -> None:
     log_file = "msedgedriver.log"
@@ -107,6 +108,17 @@ def test_log_output_null_default(driver, capfd) -> None:
     driver.quit()
 
 
+@pytest.mark.no_driver_after_test
+def test_driver_is_stopped_if_browser_cant_start(clean_driver) -> None:
+    options = Options()
+    options.add_argument("--user-data-dir=/no/such/location")
+    service = Service()
+    with pytest.raises(SessionNotCreatedException):
+        clean_driver(options=options, service=service)
+    assert not service.is_connectable()
+    assert service.process.poll() is not None
+
+
 @pytest.fixture
 def service():
     return Service()