Merge branch 'not-null-response' of https://github.com/RenderMichael/selenium into not-null-response

RenderMichael · RenderMichael · commit 84052475e091 · 2025-02-05T17:45:55.000-05:00
diff --git a/dotnet/src/webdriver/DevTools/DevToolsDomains.cs b/dotnet/src/webdriver/DevTools/DevToolsDomains.cs
@@ -82,7 +82,7 @@ public abstract class DevToolsDomains
         /// Initializes the supplied DevTools session's domains for the specified browser version.
         /// </summary>
         /// <param name="protocolVersion">The version of the DevTools Protocol to use.</param>
-        /// <param name="session">The <see cref="DevToolsSession"/> for which to initialiize the domains.</param>
+        /// <param name="session">The <see cref="DevToolsSession"/> for which to initialize the domains.</param>
         /// <returns>The <see cref="DevToolsDomains"/> object containing the version-specific domains.</returns>
         /// <exception cref="ArgumentException">If <paramref name="protocolVersion"/> is negative.</exception>
         /// <exception cref="WebDriverException">If the desired protocol version is not supported.</exception>
@@ -95,7 +95,7 @@ public static DevToolsDomains InitializeDomains(int protocolVersion, DevToolsSes
         /// Initializes the supplied DevTools session's domains for the specified browser version within the specified number of versions.
         /// </summary>
         /// <param name="protocolVersion">The version of the DevTools Protocol to use.</param>
-        /// <param name="session">The <see cref="DevToolsSession"/> for which to initialiize the domains.</param>
+        /// <param name="session">The <see cref="DevToolsSession"/> for which to initialize the domains.</param>
         /// <param name="versionRange">The range of versions within which to match the provided version number. Defaults to 5 versions.</param>
         /// <returns>The <see cref="DevToolsDomains"/> object containing the version-specific domains.</returns>
         /// <exception cref="ArgumentException">If <paramref name="protocolVersion"/> is negative.</exception>
diff --git a/dotnet/src/webdriver/DevTools/v130/V130Domains.cs b/dotnet/src/webdriver/DevTools/v130/V130Domains.cs
@@ -17,22 +17,27 @@
 // under the License.
 // </copyright>
 
+using System;
+
+#nullable enable
+
 namespace OpenQA.Selenium.DevTools.V130
 {
     /// <summary>
     /// Class containing the domain implementation for version 130 of the DevTools Protocol.
     /// </summary>
     public class V130Domains : DevToolsDomains
     {
-        private DevToolsSessionDomains domains;
+        private readonly DevToolsSessionDomains domains;
 
         /// <summary>
         /// Initializes a new instance of the V130Domains class.
         /// </summary>
         /// <param name="session">The DevToolsSession to use with this set of domains.</param>
+        /// <exception cref="ArgumentNullException">If <paramref name="session"/> is <see langword="null"/>.</exception>
         public V130Domains(DevToolsSession session)
         {
-            this.domains = new DevToolsSessionDomains(session);
+            this.domains = new DevToolsSessionDomains(session ?? throw new ArgumentNullException(nameof(session)));
         }
 
         /// <summary>
diff --git a/dotnet/src/webdriver/DevTools/v131/V131Domains.cs b/dotnet/src/webdriver/DevTools/v131/V131Domains.cs
@@ -17,22 +17,27 @@
 // under the License.
 // </copyright>
 
+using System;
+
+#nullable enable
+
 namespace OpenQA.Selenium.DevTools.V131
 {
     /// <summary>
     /// Class containing the domain implementation for version 131 of the DevTools Protocol.
     /// </summary>
     public class V131Domains : DevToolsDomains
     {
-        private DevToolsSessionDomains domains;
+        private readonly DevToolsSessionDomains domains;
 
         /// <summary>
         /// Initializes a new instance of the V131Domains class.
         /// </summary>
         /// <param name="session">The DevToolsSession to use with this set of domains.</param>
+        /// <exception cref="ArgumentNullException">If <paramref name="session"/> is <see langword="null"/>.</exception>
         public V131Domains(DevToolsSession session)
         {
-            this.domains = new DevToolsSessionDomains(session);
+            this.domains = new DevToolsSessionDomains(session ?? throw new ArgumentNullException(nameof(session)));
         }
 
         /// <summary>
diff --git a/dotnet/src/webdriver/DevTools/v132/V132Domains.cs b/dotnet/src/webdriver/DevTools/v132/V132Domains.cs
@@ -17,22 +17,27 @@
 // under the License.
 // </copyright>
 
+using System;
+
+#nullable enable
+
 namespace OpenQA.Selenium.DevTools.V132
 {
     /// <summary>
     /// Class containing the domain implementation for version 132 of the DevTools Protocol.
     /// </summary>
     public class V132Domains : DevToolsDomains
     {
-        private DevToolsSessionDomains domains;
+        private readonly DevToolsSessionDomains domains;
 
         /// <summary>
         /// Initializes a new instance of the V132Domains class.
         /// </summary>
         /// <param name="session">The DevToolsSession to use with this set of domains.</param>
+        /// <exception cref="ArgumentNullException">If <paramref name="session"/> is <see langword="null"/>.</exception>
         public V132Domains(DevToolsSession session)
         {
-            this.domains = new DevToolsSessionDomains(session);
+            this.domains = new DevToolsSessionDomains(session ?? throw new ArgumentNullException(nameof(session)));
         }
 
         /// <summary>
diff --git a/dotnet/src/webdriver/DevTools/v85/V85Domains.cs b/dotnet/src/webdriver/DevTools/v85/V85Domains.cs
@@ -17,22 +17,27 @@
 // under the License.
 // </copyright>
 
+using System;
+
+#nullable enable
+
 namespace OpenQA.Selenium.DevTools.V85
 {
     /// <summary>
     /// Class containing the domain implementation for version 86 of the DevTools Protocol.
     /// </summary>
     public class V85Domains : DevToolsDomains
     {
-        private DevToolsSessionDomains domains;
+        private readonly DevToolsSessionDomains domains;
 
         /// <summary>
         /// Initializes a new instance of the V85Domains class.
         /// </summary>
         /// <param name="session">The DevToolsSession to use with this set of domains.</param>
+        /// <exception cref="ArgumentNullException">If <paramref name="session"/> is <see langword="null"/>.</exception>
         public V85Domains(DevToolsSession session)
         {
-            this.domains = new DevToolsSessionDomains(session);
+            this.domains = new DevToolsSessionDomains(session ?? throw new ArgumentNullException(nameof(session)));
         }
 
         /// <summary>
diff --git a/javascript/node/selenium-webdriver/bidi/network.js b/javascript/node/selenium-webdriver/bidi/network.js
@@ -29,6 +29,11 @@ const NetworkEvent = {
   FETCH_ERROR: 'network.fetchError',
 }
 
+const CacheBehavior = Object.freeze({
+  DEFAULT: 'default',
+  BYPASS: 'bypass',
+})
+
 /**
  * Represents all commands and events of Network module.
  * Described in https://w3c.github.io/webdriver-bidi/#module-network.
@@ -355,6 +360,40 @@ class Network {
     await this.bidi.send(command)
   }
 
+  /**
+   * Sets the cache behavior for network requests.
+   *
+   * @param {string} behavior - The cache behavior ("default" or "bypass")
+   * @param {Array<string>} [contexts] - Optional array of browsing context IDs
+   * @returns {Promise<void>} A promise that resolves when the cache behavior is set
+   * @throws {Error} If behavior is invalid or context IDs are invalid
+   */
+  async setCacheBehavior(behavior, contexts = null) {
+    if (!Object.values(CacheBehavior).includes(behavior)) {
+      throw new Error(`Cache behavior must be either "${CacheBehavior.DEFAULT}" or "${CacheBehavior.BYPASS}"`)
+    }
+
+    const command = {
+      method: 'network.setCacheBehavior',
+      params: {
+        cacheBehavior: behavior,
+      },
+    }
+
+    if (contexts !== null) {
+      if (
+        !Array.isArray(contexts) ||
+        contexts.length === 0 ||
+        contexts.some((c) => typeof c !== 'string' || c.trim() === '')
+      ) {
+        throw new Error('Contexts must be an array of non-empty strings')
+      }
+      command.params.contexts = contexts
+    }
+
+    await this.bidi.send(command)
+  }
+
   /**
    * Unsubscribes from network events for all browsing contexts.
    * @returns {Promise<void>} A promise that resolves when the network connection is closed.
@@ -389,4 +428,4 @@ async function getNetworkInstance(driver, browsingContextIds = null) {
   return instance
 }
 
-module.exports = getNetworkInstance
+module.exports = { Network: getNetworkInstance, CacheBehavior }
diff --git a/javascript/node/selenium-webdriver/lib/network.js b/javascript/node/selenium-webdriver/lib/network.js
@@ -15,7 +15,7 @@
 // specific language governing permissions and limitations
 // under the License.
 
-const network = require('../bidi/network')
+const { Network: getNetwork } = require('../bidi/network')
 const { InterceptPhase } = require('../bidi/interceptPhase')
 const { AddInterceptParameters } = require('../bidi/addInterceptParameters')
 
@@ -39,7 +39,7 @@ class Network {
     if (this.#network !== undefined) {
       return
     }
-    this.#network = await network(this.#driver)
+    this.#network = await getNetwork(this.#driver)
 
     await this.#network.addIntercept(new AddInterceptParameters(InterceptPhase.AUTH_REQUIRED))
 
diff --git a/javascript/node/selenium-webdriver/test/bidi/add_intercept_parameters_test.js b/javascript/node/selenium-webdriver/test/bidi/add_intercept_parameters_test.js
@@ -20,7 +20,7 @@
 const assert = require('node:assert')
 const { Browser } = require('selenium-webdriver')
 const { suite } = require('../../lib/test')
-const Network = require('selenium-webdriver/bidi/network')
+const { Network } = require('selenium-webdriver/bidi/network')
 const { AddInterceptParameters } = require('selenium-webdriver/bidi/addInterceptParameters')
 const { InterceptPhase } = require('selenium-webdriver/bidi/interceptPhase')
 const { UrlPattern } = require('selenium-webdriver/bidi/urlPattern')
diff --git a/javascript/node/selenium-webdriver/test/bidi/network_commands_test.js b/javascript/node/selenium-webdriver/test/bidi/network_commands_test.js
@@ -20,7 +20,7 @@
 const assert = require('node:assert')
 const { Browser, By } = require('selenium-webdriver')
 const { Pages, suite } = require('../../lib/test')
-const Network = require('selenium-webdriver/bidi/network')
+const { Network } = require('selenium-webdriver/bidi/network')
 const { AddInterceptParameters } = require('selenium-webdriver/bidi/addInterceptParameters')
 const { InterceptPhase } = require('selenium-webdriver/bidi/interceptPhase')
 const { until } = require('selenium-webdriver/index')
diff --git a/javascript/node/selenium-webdriver/test/bidi/network_test.js b/javascript/node/selenium-webdriver/test/bidi/network_test.js
@@ -20,7 +20,8 @@
 const assert = require('node:assert')
 const { Browser } = require('selenium-webdriver')
 const { Pages, suite, ignore } = require('../../lib/test')
-const Network = require('selenium-webdriver/bidi/network')
+const { Network, CacheBehavior } = require('selenium-webdriver/bidi/network')
+const BrowsingContext = require('selenium-webdriver/bidi/browsingContext')
 const until = require('selenium-webdriver/lib/until')
 
 suite(
@@ -212,6 +213,52 @@ suite(
         assert(onResponseCompleted[0].response.mimeType.includes('text/plain'))
       })
     })
+
+    describe('setCacheBehavior', function () {
+      it('can set cache behavior to bypass for a context', async function () {
+        await driver.get(Pages.emptyPage)
+        const browsingContext = await BrowsingContext(driver, {
+          type: 'tab',
+        })
+        const contextId = browsingContext.id
+        await network.setCacheBehavior(CacheBehavior.BYPASS, [contextId])
+      })
+
+      it('can set cache behavior to default for a context', async function () {
+        await driver.get(Pages.emptyPage)
+        const browsingContext = await BrowsingContext(driver, {
+          type: 'tab',
+        })
+        const contextId = browsingContext.id
+        await network.setCacheBehavior(CacheBehavior.DEFAULT, [contextId])
+      })
+
+      it('can set cache behavior to default/bypass with no context id', async function () {
+        await driver.get(Pages.emptyPage)
+        await network.setCacheBehavior(CacheBehavior.DEFAULT)
+        await network.setCacheBehavior(CacheBehavior.BYPASS)
+      })
+
+      it('throws error for invalid cache behavior', async function () {
+        await driver.get(Pages.emptyPage)
+        await assert.rejects(
+          async () => await network.setCacheBehavior('invalid'),
+          /Cache behavior must be either "default" or "bypass"/,
+        )
+      })
+
+      it('throws error for invalid context id types', async function () {
+        await driver.get(Pages.emptyPage)
+        await assert.rejects(
+          async () => await network.setCacheBehavior(CacheBehavior.BYPASS, ''),
+          /Contexts must be an array of non-empty strings/,
+        )
+        await assert.rejects(
+          async () => await network.setCacheBehavior(CacheBehavior.BYPASS, ['', ' ']),
+          /Contexts must be an array of non-empty strings/,
+        )
+      })
+    })
   },
   { browsers: [Browser.FIREFOX, Browser.CHROME, Browser.EDGE] },
 )
diff --git a/rb/lib/selenium/webdriver/bidi/network.rb b/rb/lib/selenium/webdriver/bidi/network.rb
@@ -112,6 +112,18 @@ def continue_response(**args)
           )
         end
 
+        def provide_response(**args)
+          @bidi.send_cmd(
+            'network.provideResponse',
+            request: args[:id],
+            body: args[:body],
+            cookies: args[:cookies],
+            headers: args[:headers],
+            reasonPhrase: args[:reason],
+            statusCode: args[:status]
+          )
+        end
+
         def on(event, &)
           event = EVENTS[event] if event.is_a?(Symbol)
           @bidi.add_callback(event, &)
diff --git a/rb/lib/selenium/webdriver/bidi/network/intercepted_response.rb b/rb/lib/selenium/webdriver/bidi/network/intercepted_response.rb
@@ -25,11 +25,14 @@ module Selenium
   module WebDriver
     class BiDi
       class InterceptedResponse < InterceptedItem
-        attr_accessor :reason
+        attr_accessor :reason, :status
+        attr_reader :body
 
         def initialize(network, request)
           super
           @reason = nil
+          @status = nil
+          @body = nil
         end
 
         def continue
@@ -38,7 +41,19 @@ def continue
             cookies: cookies.as_json,
             headers: headers.as_json,
             credentials: credentials.as_json,
-            reason: reason
+            reason: reason,
+            status: status
+          )
+        end
+
+        def provide_response
+          network.provide_response(
+            id: id,
+            cookies: cookies.as_json,
+            headers: headers.as_json,
+            body: body,
+            reason: reason,
+            status: status
           )
         end
 
@@ -53,6 +68,13 @@ def headers
         def cookies(cookies = {})
           @cookies ||= Cookies.new(cookies)
         end
+
+        def body=(value)
+          @body = {
+            type: 'string',
+            value: value.to_json
+          }
+        end
       end
     end # BiDi
   end # WebDriver
diff --git a/rb/sig/lib/selenium/webdriver/bidi/network.rbs b/rb/sig/lib/selenium/webdriver/bidi/network.rbs
@@ -26,6 +26,8 @@ module Selenium
 
         def continue_with_auth: (String request_id, String username, String password) -> Hash[nil, nil]
 
+        def provide_response: -> Hash[nil, nil]
+
         def on: (Symbol event) { (?) -> untyped } -> Hash[nil, nil]
       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,8 +2,6 @@ module Selenium
   module WebDriver
     class BiDi
       class Cookies
-        KNOWN_KEYS: Array[Symbol]
-
         def initialize: (Hash[Symbol, String | Integer | bool] cookies) -> void
 
         def as_json: () -> Array[Hash[Symbol, untyped]]
diff --git a/rb/sig/lib/selenium/webdriver/bidi/network/intercepted_response.rbs b/rb/sig/lib/selenium/webdriver/bidi/network/intercepted_response.rbs
diff --git a/rb/sig/lib/selenium/webdriver/bidi/network/set_cookie_headers.rbs b/rb/sig/lib/selenium/webdriver/bidi/network/set_cookie_headers.rbs
diff --git a/rb/spec/integration/selenium/webdriver/bidi/network_spec.rb b/rb/spec/integration/selenium/webdriver/bidi/network_spec.rb
diff --git a/rb/spec/integration/selenium/webdriver/network_spec.rb b/rb/spec/integration/selenium/webdriver/network_spec.rb
