[rb] implement client config class

Author: titusfortner

rb/lib/selenium/webdriver/common.rb

@@ -18,6 +18,7 @@
 # under the License.
 
 require 'selenium/webdriver/common/error'
+require 'selenium/webdriver/common/client_config'
 require 'selenium/webdriver/common/local_driver'
 require 'selenium/webdriver/common/driver_finder'
 require 'selenium/webdriver/common/platform'

rb/lib/selenium/webdriver/common/client_config.rb

@@ -0,0 +1,46 @@
+# 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.
+
+module Selenium
+  module WebDriver
+    #
+    # Immutable Configuration for HTTP clients.
+    #
+
+    ClientConfig = Data.define(
+      :open_timeout,
+      :read_timeout,
+      :proxy,
+      :extra_headers,
+      :user_agent,
+      :server_url
+    ) do
+      def initialize(
+        open_timeout: nil,
+        read_timeout: nil,
+        proxy: nil,
+        extra_headers: nil,
+        user_agent: nil,
+        server_url: nil
+      )
+        super
+      end
+    end
+  end
+end

rb/lib/selenium/webdriver/common/driver.rb

@@ -319,9 +319,9 @@ def ref
 
       attr_reader :bridge
 
-      def create_bridge(caps:, url:, http_client: nil)
+      def create_bridge(caps:, url: nil, http_client: nil, client_config: nil)
         klass = caps['webSocketUrl'] ? Remote::BiDiBridge : Remote::Bridge
-        klass.new(http_client: http_client, url: url).tap do |bridge|
+        klass.new(http_client: http_client, url: url, client_config: client_config).tap do |bridge|
           bridge.create_session(caps)
         end
       end

rb/lib/selenium/webdriver/remote/bridge.rb

@@ -54,17 +54,18 @@ def element_class
         # Initializes the bridge with the given server URL
         # @param [String, URI] url url for the remote server
         # @param [Object] http_client an HTTP client instance that implements the same protocol as Http::Default
+        # @param [ClientConfig] client_config configuration for the HTTP client
         # @api private
         #
 
-        def initialize(url:, http_client: nil)
-          uri = url.is_a?(URI) ? url : URI.parse(url)
-          uri.path += '/' unless uri.path.end_with?('/')
+        def initialize(url: nil, http_client: nil, client_config: nil)
+          if http_client && client_config
+            raise Error::WebDriverError, 'Cannot specify both http_client and client_config'
+          end
 
-          @http = http_client || Http::Default.new
-          @http.server_url = uri
-          @file_detector = nil
+          @http = http_client || create_http_client(client_config, url: url)
 
+          @file_detector = nil
           @locator_converter = self.class.locator_converter
         end
 
@@ -93,6 +94,8 @@ def create_session(capabilities)
             extend(WebDriver::Safari::Features)
           when 'internet explorer'
             extend(WebDriver::IE::Features)
+          else
+            raise Error::WebDriverError, "Unknown browser name: #{@capabilities[:browser_name]}"
           end
         end
 
@@ -662,6 +665,41 @@ def prepare_capabilities_payload(capabilities)
           capabilities = {alwaysMatch: capabilities} if !capabilities['alwaysMatch'] && !capabilities['firstMatch']
           {capabilities: capabilities}
         end
+
+        def create_http_client(client_config, url: nil)
+          http = build_http_client(client_config)
+          validate_server_url_args(url, client_config)
+          http.server_url = normalize_url(url || client_config&.server_url)
+          http
+        end
+
+        def build_http_client(client_config)
+          if client_config
+            http = Http::Default.new(open_timeout: client_config.open_timeout,
+                                     read_timeout: client_config.read_timeout)
+            http.proxy = client_config.proxy if client_config.proxy
+
+            Http::Common.extra_headers = client_config.extra_headers if client_config.extra_headers
+            Http::Common.user_agent = client_config.user_agent if client_config.user_agent
+          else
+            http = Http::Default.new
+          end
+          http
+        end
+
+        def validate_server_url_args(url, client_config)
+          if url && client_config&.server_url
+            raise Error::WebDriverError, 'Cannot specify url in both keyword and http_client'
+          elsif url.nil? && !client_config&.server_url
+            raise Error::WebDriverError, 'No server URL provided'
+          end
+        end
+
+        def normalize_url(url)
+          url = URI.parse(url) if url && !url.is_a?(URI)
+          url&.path += '/' unless url&.path&.end_with?('/')
+          url
+        end
       end # Bridge
     end # Remote
   end # WebDriver

rb/lib/selenium/webdriver/remote/http/common.rb

@@ -40,6 +40,10 @@ def user_agent
 
           attr_writer :server_url
 
+          def server_url?
+            !@server_url.nil?
+          end
+
           def quit_errors
             [IOError]
           end

rb/sig/lib/selenium/webdriver/common/client_config.rbs

@@ -0,0 +1,28 @@
+module Selenium
+  module WebDriver
+
+    ClientConfig: Class
+
+    class ClientConfig
+      attr_reader open_timeout: Integer?
+      attr_reader read_timeout: Integer?
+      attr_reader proxy: Selenium::WebDriver::Proxy?
+      attr_reader extra_headers: Hash[String, String]?
+      attr_reader user_agent: String?
+      attr_reader server_url: (String | URI)?
+
+      def initialize: (
+          ?open_timeout: Integer?,
+          ?read_timeout: Integer?,
+          ?proxy: Selenium::WebDriver::Proxy?,
+          ?extra_headers: Hash[String, String]?,
+          ?user_agent: String?,
+          ?server_url: (String | URI)?
+        ) -> void
+
+      def with: (**untyped) -> ClientConfig
+      def to_h: -> Hash[Symbol, untyped]
+      def deconstruct_keys: (Array[Symbol]?) -> Hash[Symbol, untyped]
+    end
+  end
+end

rb/sig/lib/selenium/webdriver/common/driver.rbs

@@ -69,7 +69,7 @@ module Selenium
 
       attr_reader bridge: untyped
 
-      def create_bridge: (caps: untyped, url: untyped, ?http_client: untyped) -> untyped
+      def create_bridge: (caps: Remote::Capabilities, url: (String | URI)?, ?http_client: Remote::Http::Common?, ?client_config: ClientConfig?) -> Remote::Bridge
 
       def service_url: (untyped service) -> untyped
 

rb/sig/lib/selenium/webdriver/remote/bridge.rbs

@@ -30,7 +30,7 @@ module Selenium
 
         attr_reader capabilities: untyped
 
-        def initialize: (url: String | URI, ?http_client: untyped?) -> void
+        def initialize: (?url: (String | URI)?, ?http_client: untyped?, ?client_config: ClientConfig?) -> void
 
         def bidi: -> WebDriver::Error::WebDriverError
 
@@ -248,6 +248,14 @@ module Selenium
 
         def convert_locator: (untyped how, untyped what) -> ::Array[untyped]
 
+        def create_http_client: (?ClientConfig? client_config, ?url: (String | URI)?) -> Http::Common
+
+        def build_http_client: (ClientConfig? client_config) -> Http::Common
+
+        def validate_server_url_args: ((String | URI)? url, ClientConfig? client_config) -> void
+
+        def normalize_url: ((String | URI)? url) -> URI?
+
         ESCAPE_CSS_REGEXP: ::Regexp
 
         UNICODE_CODE_POINT: 30

rb/sig/lib/selenium/webdriver/remote/http/common.rbs

@@ -11,25 +11,27 @@ module Selenium
 
           @common_headers: Hash[String, untyped]
 
-          attr_accessor self.extra_headers: Hash[String, untyped]
+          attr_accessor self.extra_headers: Hash[String, untyped]?
 
-          attr_writer self.user_agent: String
+          attr_writer self.user_agent: String?
 
           def self.user_agent: -> String
 
-          attr_writer server_url: String
+          attr_writer server_url?: URI
 
           def quit_errors: () -> Array[untyped]
 
           def close: () -> nil
 
           def call: (untyped verb, untyped url, untyped command_hash) -> untyped
 
+          def server_url?: -> bool
+
           private
 
           def common_headers: -> Hash[String, untyped]
 
-          def server_url: () -> String
+          def server_url: () -> URI
 
           def request: (*untyped) -> untyped
 

rb/sig/lib/selenium/webdriver/remote/http/default.rbs

@@ -4,21 +4,21 @@ module Selenium
       module Http
         # @api private
         class Default < Common
-          @open_timeout: untyped
+          @open_timeout: Integer
 
-          @read_timeout: untyped
+          @read_timeout: Integer
 
           @http: untyped
 
-          @proxy: untyped
+          @proxy: Proxy
 
-          attr_writer proxy: untyped
+          attr_writer proxy: Proxy?
 
-          attr_accessor open_timeout: untyped
+          attr_accessor open_timeout: Integer
 
-          attr_accessor read_timeout: untyped
+          attr_accessor read_timeout: Integer
 
-          def initialize: (?open_timeout: untyped?, ?read_timeout: untyped?) -> void
+          def initialize: (?open_timeout: Integer?, ?read_timeout: Integer?) -> void
 
           def close: () -> untyped
 
@@ -40,7 +40,7 @@ module Selenium
 
           def proxy: () -> untyped
 
-          def use_proxy?: () -> untyped
+          def use_proxy?: () -> bool
         end
       end
     end