Serialize request values

SeleniumHQ · aguspe · Jan 23, 2025 · Dec 14, 2024 · Dec 18, 2024 · Dec 18, 2024
commit c7552aa6546681ed58c35c7fb33ac7417502952f
diff --git a/rb/lib/selenium/webdriver/bidi/network/cookies.rb b/rb/lib/selenium/webdriver/bidi/network/cookies.rb
@@ -20,36 +20,45 @@
 module Selenium
   module WebDriver
     class BiDi
-      module Cookies
+      class Cookies
+        def initialize
+          @cookies = {}
+        end
+
+        def all
+          @cookies
+        end
+
         def add_cookie(name, value)
-          cookies.push(
-            name: name,
-            value: {
-              type: 'string',
-              value: value
-            }
-          )
+          @cookies[name] = value
         end
 
         def remove_cookie(name)
-          cookies.delete_if { |cookie| cookie[:name] == name }
-        end
-
-        def set_cookie_header(**args)
-          cookies.push(
-            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]
-          )
+          @cookies.delete(name)
+        end
+
+        def []=(key, value)
+          add_cookie(key, value)
+        end
+
+        def [](key)
+          @cookies[key]
+        end
+
+        def delete(key)
+          remove_cookie(key)
+        end
+
+        def serialize
+          @cookies.map do |name, value|
+            {
+              name: name.to_s,
+              value: {
+                type: 'string',
+                value: value.to_s
+              }
+            }
+          end
         end
       end
     end # BiDi

diff --git a/rb/lib/selenium/webdriver/bidi/network/credentials.rb b/rb/lib/selenium/webdriver/bidi/network/credentials.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.
+
+module Selenium
+  module WebDriver
+    class BiDi
+      class Credentials
+        attr_accessor :username, :password
+
+        def initialize(username: nil, password: nil)
+          @username = username
+          @password = password
+        end
+
+        def serialize
+          return nil unless username && password
+
+          {
+            type: 'password',
+            username: username,
+            password: password
+          }
+        end
+      end
+    end # BiDi
+  end # WebDriver
+end # Selenium
diff --git a/rb/lib/selenium/webdriver/bidi/network/headers.rb b/rb/lib/selenium/webdriver/bidi/network/headers.rb
@@ -20,19 +20,45 @@
 module Selenium
   module WebDriver
     class BiDi
-      module Headers
+      class Headers
+        def initialize
+          @headers = {}
+        end
+
+        def all
+          @headers
+        end
+
         def add_header(name, value)
-          headers.push(
-            name: name,
-            value: {
-              type: 'string',
-              value: value
-            }
-          )
+          @headers[name] = value
         end
 
         def remove_header(name)
-          headers.delete_if { |header| header[:name] == name }
+          @headers.delete(name)
+        end
+
+        def []=(key, value)
+          add_header(key, value)
+        end
+
+        def [](key)
+          @headers[key]
+        end
+
+        def delete(key)
+          remove_header(key)
+        end
+
+        def serialize
+          @headers.map do |name, val|
+            {
+              name: name.to_s,
+              value: {
+                type: 'string',
+                value: val.to_s
+              }
+            }
+          end
         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
@@ -24,23 +24,26 @@ module Selenium
   module WebDriver
     class BiDi
       class InterceptedRequest < InterceptedItem
-        include Cookies
-        include Headers
-
-        attr_accessor :cookies, :headers, :method, :url
+        attr_accessor :method, :url
         attr_reader :body
 
         def initialize(network, request)
           super
-          @body = nil
-          @cookies = []
-          @headers = []
+          # We now rely on the modules above to initialize @headers and @cookies as Hashes
           @method = nil
           @url = nil
+          @body = nil
         end
 
         def continue
-          network.continue_request(id:, body:, cookies:, headers:, method:, url:)
+          network.continue_request(
+            id: id,
+            body: body,
+            cookies: cookies.serialize,
+            headers: headers.serialize,
+            method: method,
+            url: url
+          )
         end
 
         def fail
@@ -53,6 +56,14 @@ def body=(value)
             value: value.to_json
           }
         end
+
+        def headers
+          @headers ||= Headers.new
+        end
+
+        def cookies
+          @cookies ||= Cookies.new
+        end
       end
     end # BiDi
   end # WebDriver

diff --git a/rb/lib/selenium/webdriver/bidi/network/intercepted_response.rb b/rb/lib/selenium/webdriver/bidi/network/intercepted_response.rb
@@ -17,37 +17,41 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require_relative 'cookies'
+require_relative 'credentials'
 require_relative 'headers'
+require_relative 'set_cookie_headers'
 
 module Selenium
   module WebDriver
     class BiDi
       class InterceptedResponse < InterceptedItem
-        include Cookies
-        include Headers
-
-        attr_accessor :cookies, :headers, :reason
-        attr_reader :credentials
+        attr_accessor :reason
 
         def initialize(network, request)
           super
-          @cookies = []
-          @headers = []
-          @credentials = nil
           @reason = nil
         end
 
         def continue
-          network.continue_response(id:, cookies:, headers:, credentials:, reason:)
+          network.continue_response(
+            id: id,
+            cookies: set_cookie_headers.serialize,
+            headers: headers.serialize,
+            credentials: credentials.serialize,
+            reason: reason
+          )
+        end
+
+        def credentials(username: nil, password: nil)
+          @credentials ||= Credentials.new(username: username, password: password)
+        end
+
+        def headers
+          @headers ||= Headers.new
         end
 
-        def add_credentials(username, password)
-          @credentials = {
-            type: 'password',
-            username: username,
-            password: password
-          }
+        def set_cookie_headers(set_cookie_headers = nil)
+          @set_cookie_headers ||= SetCookieHeaders.new(set_cookie_headers)
         end
       end
     end # BiDi

diff --git a/rb/lib/selenium/webdriver/bidi/network/set_cookie_headers.rb b/rb/lib/selenium/webdriver/bidi/network/set_cookie_headers.rb
@@ -0,0 +1,94 @@
+# 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
+    class BiDi
+      class SetCookieHeaders
+        def initialize(set_cookie_headers)
+          @set_cookie_headers = set_cookie_headers
+        end
+
+        def all
+          @set_cookie_headers
+        end
+
+        def add_set_cookie_header(name, value)
+          @set_cookie_headers[name] = {value: value}
+        end
+
+        def remove_set_cookie_header(name)
+          @set_cookie_headers.delete(name)
+        end
+
+        def set_cookie_header(**args)
+          set_cookie_header = args[:name]
+
+          set_cookie_header_data = {
+            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]
+          }
+
+          @set_cookie_headers[set_cookie_header] = set_cookie_header_data
+        end
+
+        def []=(key, value)
+          add_set_cookie_header(key, value)
+        end
+
+        def [](key)
+          @set_cookie_headers[key]
+        end
+
+        def delete(key)
+          remove_set_cookie_header(key)
+        end
+
+        def serialize
+          return [] unless @set_cookie_headers
+
+          @set_cookie_headers.map do |name, data|
+            data = {value: data} unless data.is_a?(Hash)
+
+            {
+              name: name.to_s,
+              value: {
+                type: 'string',
+                value: data[:value].to_s
+              },
+              domain: data[:domain],
+              httpOnly: data[:httpOnly],
+              expiry: data[:expiry],
+              maxAge: data[:maxAge],
+              path: data[:path],
+              sameSite: data[:sameSite],
+              secure: data[:secure]
+            }.compact
+          end
+        end
+      end
+    end # BiDi
+  end # WebDriver
+end # Selenium