Improve types and hash consistency

SeleniumHQ · aguspe · Jan 23, 2025 · Dec 14, 2024 · Dec 18, 2024 · Dec 18, 2024
commit eb3f378aef1d5ecacf6fc843358bcd0b4a2b524b
diff --git a/rb/lib/selenium/webdriver/bidi/network.rb b/rb/lib/selenium/webdriver/bidi/network.rb
@@ -55,41 +55,41 @@ def remove_intercept(intercept)
         def continue_with_auth(request_id, username, password)
           @bidi.send_cmd(
             'network.continueWithAuth',
-            'request' => request_id,
-            'action' => 'provideCredentials',
-            'credentials' => {
-              'type' => 'password',
-              'username' => username,
-              'password' => password
+            request: request_id,
+            action: 'provideCredentials',
+            credentials: {
+              type: 'password',
+              username: username,
+              password: password
             }
           )
         end
 
         def continue_without_auth(request_id)
           @bidi.send_cmd(
             'network.continueWithAuth',
-            'request' => request_id,
-            'action' => 'default'
+            request: request_id,
+            action: 'default'
           )
         end
 
         def cancel_auth(request_id)
           @bidi.send_cmd(
             'network.continueWithAuth',
-            'request' => request_id,
-            'action' => 'cancel'
+            request: request_id,
+            action: 'cancel'
           )
         end
 
         def continue_request(**args)
           @bidi.send_cmd(
             'network.continueRequest',
             request: args[:id],
-            'body' => args[:body],
-            'cookies' => args[:cookies],
-            'headers' => args[:headers],
-            'method' => args[:method],
-            'url' => args[:url]
+            body: args[:body],
+            cookies: args[:cookies],
+            headers: args[:headers],
+            method: args[:method],
+            url: args[:url]
           )
         end
 
@@ -104,11 +104,11 @@ def continue_response(**args)
           @bidi.send_cmd(
             'network.continueResponse',
             request: args[:id],
-            'cookies' => args[:cookies],
-            'credentials' => args[:credentials],
-            'headers' => args[:headers],
-            'reasonPhrase' => args[:reason],
-            'statusCode' => args[:status]
+            cookies: args[:cookies],
+            credentials: args[:credentials],
+            headers: args[:headers],
+            reasonPhrase: args[:reason],
+            statusCode: args[:status]
           )
         end
 

diff --git a/rb/lib/selenium/webdriver/bidi/network/cookies.rb b/rb/lib/selenium/webdriver/bidi/network/cookies.rb
@@ -23,32 +23,32 @@ class BiDi
       module Cookies
         def add_cookie(name, value)
           cookies.push(
-            'name' => name,
-            'value' => {
-              'type' => 'string',
-              'value' => value
+            name: name,
+            value: {
+              type: 'string',
+              value: value
             }
           )
         end
 
         def remove_cookie(name)
-          cookies.delete_if { |cookie| cookie['name'] == name }
+          cookies.delete_if { |cookie| cookie[:name] == name }
         end
 
         def set_cookie_header(**args)
           cookies.push(
-            'name' => args[:name],
-            'value' => {
-              'type' => 'string',
-              'value' => 'input'
+            name: args[:name],
+            value: {
+              type: 'string',
+              value: 'input'
             },
-            'domain' => args[:domain],
-            'httpOnly' => args[:http_only],
-            'expiry' => args[:expiry],
-            'maxAge' => args[:max_age],
-            'path' => args[:path],
-            'sameSite' => args[:same_site],
-            'secure' => args[:secure]
+            domain: args[:domain],
+            httpOnly: args[:http_only],
+            expiry: args[:expiry],
+            maxAge: args[:max_age],
+            path: args[:path],
+            sameSite: args[:same_site],
+            secure: args[:secure]
           )
         end
       end

diff --git a/rb/lib/selenium/webdriver/bidi/network/headers.rb b/rb/lib/selenium/webdriver/bidi/network/headers.rb
@@ -23,16 +23,16 @@ class BiDi
       module Headers
         def add_header(name, value)
           headers.push(
-            'name' => name,
-            'value' => {
-              'type' => 'string',
-              'value' => value
+            name: name,
+            value: {
+              type: 'string',
+              value: value
             }
           )
         end
 
         def remove_header(name)
-          headers.delete_if { |header| header['name'] == name }
+          headers.delete_if { |header| header[:name] == name }
         end
       end
     end # BiDi

diff --git a/rb/lib/selenium/webdriver/bidi/network/intercepted_request.rb b/rb/lib/selenium/webdriver/bidi/network/intercepted_request.rb
@@ -49,8 +49,8 @@ def fail
 
         def body=(value)
           @body = {
-            'type' => 'string',
-            'value' => value.to_json
+            type: 'string',
+            value: value.to_json
           }
         end
       end

diff --git a/rb/lib/selenium/webdriver/bidi/network/intercepted_response.rb b/rb/lib/selenium/webdriver/bidi/network/intercepted_response.rb
@@ -44,9 +44,9 @@ def continue
 
         def add_credentials(username, password)
           @credentials = {
-            'type' => 'password',
-            'username' => username,
-            'password' => password
+            type: 'password',
+            username: username,
+            password: password
           }
         end
       end

diff --git a/rb/sig/lib/selenium/webdriver/bidi/network.rbs b/rb/sig/lib/selenium/webdriver/bidi/network.rbs
@@ -10,23 +10,23 @@ module Selenium
 
         def initialize: (BiDi bidi) -> void
 
-        def add_intercept: (?phases: Array[String], ?contexts: BrowsingContext?, ?url_patterns: untyped?) -> Hash[String, String]
+        def add_intercept: (?phases: Array[String], ?contexts: BrowsingContext?, ?url_patterns: String | Array[String]?) -> Hash[String, String]
 
-        def cancel_auth: -> untyped
+        def cancel_auth: -> Hash[nil, nil]
 
-        def continue_request: -> untyped
+        def continue_request: -> Hash[nil, nil]
 
-        def continue_response: -> untyped
+        def continue_response: -> Hash[nil, nil]
 
-        def continue_without_auth: -> untyped
+        def continue_without_auth: -> Hash[nil, nil]
 
-        def fail_request: -> untyped
+        def fail_request: -> Hash[nil, nil]
 
-        def remove_intercept: (String intercept) -> untyped
+        def remove_intercept: (String intercept) -> Hash[nil, nil]
 
-        def continue_with_auth: (String request_id, String username, String password) -> untyped
+        def continue_with_auth: (String request_id, String username, String password) -> Hash[nil, nil]
 
-        def on: (Symbol event) { (?) -> untyped } -> untyped
+        def on: (Symbol event) { (?) -> untyped } -> Hash[nil, nil]
       end
     end
   end

diff --git a/rb/sig/lib/selenium/webdriver/bidi/network/cookies.rbs b/rb/sig/lib/selenium/webdriver/bidi/network/cookies.rbs
@@ -2,11 +2,11 @@ module Selenium
   module WebDriver
     class BiDi
       module Cookies
-        def add_cookie: (untyped name, untyped value) -> untyped
+        def add_cookie: (String name, String value) -> Array[Hash[Symbol, String]]
 
-        def remove_cookie: (untyped name) -> untyped
+        def remove_cookie: (String name) -> Array[Hash[Symbol, String]]
 
-        def set_cookie_header: (**untyped args) -> untyped
+        def set_cookie_header: (**Hash[Symbol, String | bool | Numeric] args) -> Array[Hash[Symbol, String | bool | Numeric]]
       end
     end
   end

diff --git a/rb/sig/lib/selenium/webdriver/bidi/network/headers.rbs b/rb/sig/lib/selenium/webdriver/bidi/network/headers.rbs
@@ -2,9 +2,9 @@ module Selenium
   module WebDriver
     class BiDi
       module Headers
-        def add_header: (untyped name, untyped value) -> untyped
+        def add_header: (String name, String value) -> Array[Hash[Symbol, String]]
 
-        def remove_header: (untyped name) -> untyped
+        def remove_header: (String name) -> Array[Hash[Symbol, String]]
       end
     end
   end

diff --git a/rb/sig/lib/selenium/webdriver/bidi/network/intercepted_item.rbs b/rb/sig/lib/selenium/webdriver/bidi/network/intercepted_item.rbs
@@ -0,0 +1,21 @@
+module Selenium
+  module WebDriver
+    class BiDi
+      class InterceptedItem
+        @network: untyped
+
+        @request: untyped
+
+        @id: untyped
+
+        attr_reader network: untyped
+
+        attr_reader request: untyped
+
+        def initialize: (untyped network, untyped request) -> void
+
+        def id: () -> untyped
+      end
+    end
+  end
+end
diff --git a/rb/sig/lib/selenium/webdriver/bidi/network/intercepted_request.rbs b/rb/sig/lib/selenium/webdriver/bidi/network/intercepted_request.rbs
@@ -0,0 +1,39 @@
+module Selenium
+  module WebDriver
+    class BiDi
+      class InterceptedRequest < InterceptedItem
+        @body: untyped
+
+        @cookies: untyped
+
+        @headers: untyped
+
+        @method: untyped
+
+        @url: untyped
+
+        include Cookies
+
+        include Headers
+
+        attr_accessor cookies: untyped
+
+        attr_accessor headers: untyped
+
+        attr_accessor method: untyped
+
+        attr_accessor url: untyped
+
+        attr_reader body: untyped
+
+        def initialize: (untyped network, untyped request) -> void
+
+        def continue: () -> untyped
+
+        def fail: () -> untyped
+
+        def body=: (untyped value) -> untyped
+      end
+    end
+  end
+end
diff --git a/rb/sig/lib/selenium/webdriver/bidi/network/intercepted_response.rbs b/rb/sig/lib/selenium/webdriver/bidi/network/intercepted_response.rbs
@@ -0,0 +1,33 @@
+module Selenium
+  module WebDriver
+    class BiDi
+      class InterceptedResponse < InterceptedItem
+        @cookies: untyped
+
+        @headers: untyped
+
+        @credentials: untyped
+
+        @reason: untyped
+
+        include Cookies
+
+        include Headers
+
+        attr_accessor cookies: untyped
+
+        attr_accessor headers: untyped
+
+        attr_accessor reason: untyped
+
+        attr_reader credentials: untyped
+
+        def initialize: (untyped network, untyped request) -> void
+
+        def continue: () -> untyped
+
+        def add_credentials: (untyped username, untyped password) -> untyped
+      end
+    end
+  end
+end
diff --git a/rb/sig/lib/selenium/webdriver/bidi/network/url_pattern.rbs b/rb/sig/lib/selenium/webdriver/bidi/network/url_pattern.rbs
@@ -2,11 +2,11 @@ module Selenium
   module WebDriver
     class BiDi
       module UrlPattern
-        def self?.format_pattern: (untyped url_patterns, untyped pattern_type) -> untyped
+        def self?.format_pattern: (Array[String] | String url_patterns, Symbol pattern_type) -> Array[Hash[Symbol, String]]
 
-        def self?.to_url_pattern: (*untyped url_patterns) -> untyped
+        def self?.to_url_pattern: (*String url_patterns) -> Array[Hash[Symbol, String]]
 
-        def self?.to_url_string_pattern: (*untyped url_patterns) -> untyped
+        def self?.to_url_string_pattern: (*String url_patterns) -> Array[Hash[Symbol, String]]
       end
     end
   end

diff --git a/rb/sig/lib/selenium/webdriver/bidi/session.rbs b/rb/sig/lib/selenium/webdriver/bidi/session.rbs
@@ -10,7 +10,7 @@ module Selenium
 
         def status: () -> untyped
 
-        def subscribe: (untyped events, ?untyped? browsing_contexts) -> untyped
+        def subscribe: (untyped events, ?untyped? browsing_contexts) -> Hash[nil, nil]
 
         def unsubscribe: (untyped events, ?untyped? browsing_contexts) -> untyped
       end

diff --git a/rb/sig/lib/selenium/webdriver/common/network.rbs b/rb/sig/lib/selenium/webdriver/common/network.rbs
@@ -7,25 +7,25 @@ module Selenium
 
       attr_reader callbacks: Hash[String, String]
 
-      attr_reader network: untyped
+      attr_reader network: BiDi::Network
 
-      def initialize: (Remote::Bridge bridge) -> void
+      alias bidi network
 
-      def add_authentication_handler: (String username, String password) -> String
+      def initialize: (Remote::Bridge bridge) -> void
 
-      def add_request_handler: -> Integer
+      def remove_handler: (Numeric id) -> untyped
 
-      def add_response_handler: -> String
+      def clear_handlers: () -> untyped
 
-      alias bidi network
+      def add_authentication_handler: (?String? username, ?String? password, *String filter, ?pattern_type: Symbol?) { (?) -> untyped } -> untyped
 
-      def clear_handlers: -> Hash[nil, nil]
+      def add_request_handler: (*String filter, ?pattern_type: Symbol?) -> Hash[String, String]
 
-      def remove_handler: (Integer id) -> nil
+      def add_response_handler: (*String filter, ?pattern_type: Symbol?) -> Hash[String, String]
 
       private
 
-      def add_handler: -> untyped
+      def add_handler: (Symbol event_type, String phase, BiDi::InterceptedItem intercept_type, Array[String] filter, ?pattern_type: Symbol?) { (untyped) -> untyped } -> untyped
     end
   end
 end