User description

Description

This PR adds support to handle network responses and intercept them

It also refactors the previous implementations for network auth in ruby and allows to pass any method the user wants to the network methods

Now it's possible to call network.add_response_handler

It's also possible to call add_request_handler as follows:

it 'adds a request handler with attributes' do
  reset_driver!(web_socket_url: true) do |driver|
    network = described_class.new(driver)
    network.add_request_handler do |request|
      request.method = 'GET'
      request.url = url_for('formPage.html')
      request.headers['foo'] = 'bar'
      request.headers['baz'] = 'qux'
      request.cookies['foo'] = 'bar'
      request.body = ({test: 'example'})
      request.continue
    end
    driver.navigate.to url_for('formPage.html')
      expect(driver.current_url).to eq(url_for('formPage.html'))
      expect(network.callbacks.count).to be 1
    end
 end

And add auth handler should be called as:

network.add_authentication_handler(username, password)

It's also possible to use URL based filters to only allow selected URLs to be intercepted:

 it 'adds an auth handler with a filter' do
        reset_driver!(web_socket_url: true) do |driver|
          network = described_class.new(driver)
          network.add_authentication_handler(username, password, url_for('basicAuth'))
          driver.navigate.to url_for('basicAuth')
          expect(driver.find_element(tag_name: 'h1').text).to eq('authorized')
          expect(network.callbacks.count).to be 1
        end
      end

      it 'adds an auth handler with multiple filters' do
        reset_driver!(web_socket_url: true) do |driver|
          network = described_class.new(driver)
          network.add_authentication_handler(username, password, url_for('basicAuth'), url_for('formPage.html'))
          driver.navigate.to url_for('basicAuth')
          expect(driver.find_element(tag_name: 'h1').text).to eq('authorized')
          expect(network.callbacks.count).to be 1
        end
      end

Here is a video of all the test passing, 25 integration tests passing on common/network, and 10 integration tests passing on bidi/network:

Formatting results locally on the latest PR:

Motivation and Context

To complete the specification stated on #13993 and to get closer to having a full BiDi implementation for the Ruby bindings that the user can use for all their Network related needs

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• I have read the contributing document.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my changes.
• All new and existing tests passed.

PR Type

Enhancement

Description

• Added comprehensive network response handling capabilities with new continue_with_response method
• Implemented new authentication methods: continue_without_auth and cancel_auth
• Enhanced network handler management with improved add, remove, and clear operations
• Added extensive test coverage for new network response and auth functionality
• Implemented proper request ID extraction and event handling
• Updated type signatures and documentation for new methods
• Added session subscription in event handling
• Improved code organization using delegation pattern

Changes walkthrough 📝

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information