[rb][BiDi] Add support for provide response command #15080

aguspe · 2025-01-14T17:57:19Z

User description

Description

This PR adds support for the provide response method and allows the provide_response method to be passed to response

it 'adds a response handler that provides a response' do
        reset_driver!(web_socket_url: true) do |driver|
          network = described_class.new(driver)
          network.add_response_handler do |response|
            response.status = 200
            response.headers['foo'] = 'bar'
            response.body = '<html><head><title>Hello World!</title></head><body/></html>'
            response.provide_response
          end
          driver.navigate.to url_for('formPage.html')
          expect(driver.page_source).to include('Hello World!')
        end
      end

network.provide_response:

network.provide_response(
                id: request_id,
                status: 200,
                headers: [
                  {
                    name: 'foo',
                    value: {
                      type: 'string',
                      value: 'bar'
                    }
                  }
                ],
                body: {
                  type: 'string',
                  value: '<html><head><title>Hello World!</title></head><body/></html>'
                }
              )
            end

Motivation and Context

This PR continues the work done on #14900 to add full access to all the BiDi network commands

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, Tests

Description

Introduced BiDi network interception capabilities for requests and responses.
Added support for authentication handling, including skipping, canceling, and providing credentials.
Implemented serialization for cookies, headers, and set-cookie headers.
Enhanced test coverage for BiDi network features and added unit tests for new components.

Changes walkthrough 📝

Relevant files

Enhancement

14 files

bidi.rb `Added autoload for new BiDi network interception classes`	+4/-0
network.rb `Enhanced BiDi network with interception and response handling`	+69/-16
cookies.rb `Added cookie serialization support for BiDi network`	+43/-0
credentials.rb `Added credentials handling for BiDi network authentication`	+43/-0
headers.rb `Added header serialization support for BiDi network`	+38/-0
intercepted_auth.rb `Added intercepted authentication handling for BiDi network`	+38/-0
intercepted_item.rb `Introduced base class for intercepted network items`	+37/-0
intercepted_request.rb `Added intercepted request handling for BiDi network`	+69/-0
intercepted_response.rb `Added intercepted response handling for BiDi network`	+81/-0
set_cookie_headers.rb `Added set-cookie header serialization for BiDi network`	+52/-0
url_pattern.rb `Added URL pattern formatting for BiDi network interception`	+65/-0
network.rb `Integrated BiDi network interception into common network module`	+61/-23
bidi.rbs `Updated BiDi type signatures for new capabilities`	+1/-1
network.rbs `Added type signatures for BiDi network interception methods`	+15/-5

Tests

6 files

network_spec.rb `Added integration tests for BiDi network interception`	+110/-5
network_spec.rb `Enhanced integration tests for network handlers`	+233/-6
cookies_spec.rb `Added unit tests for cookie serialization`	+49/-0
credentials_spec.rb `Added unit tests for credentials handling`	+80/-0
headers_spec.rb `Added unit tests for header serialization`	+48/-0
set_cookie_headers_spec.rb `Added unit tests for set-cookie header serialization`	+49/-0

Additional files

11 files

cookies.rbs	+11/-0
credentials.rbs	+19/-0
headers.rbs	+11/-0
intercepted_auth.rbs	+13/-0
intercepted_item.rbs	+21/-0
intercepted_request.rbs	+35/-0
intercepted_response.rbs	+35/-0
set_cookie_headers.rbs	+11/-0
url_pattern.rbs	+13/-0
session.rbs	+1/-1
network.rbs	+14/-4

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

…esponse_handler

…o add_support_for_provide_response_command

qodo-merge-pro · 2025-01-14T17:58:00Z

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 4 🔵🔵🔵🔵⚪
🧪 PR contains tests
🔒 No security concerns identified
⚡ Recommended focus areas for review Possible Issue The body serialization in the body= method uses to_json which could fail for non-JSON serializable objects. Should validate/handle invalid input. def body=(value) @body = { type: 'string', value: value.to_json } end Error Handling The provide_response method lacks validation of required fields like status code. Should validate required parameters before making the network call. def provide_response network.provide_response( id: id, cookies: set_cookie_headers.serialize, headers: headers.serialize, body: body, reason: reason, status: status ) end

qodo-merge-pro · 2025-01-14T17:58:24Z

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Possible issue	Add validation for credential inputs to prevent authentication failures with invalid data Add input validation for username and password to ensure they are strings and not empty when provided. rb/lib/selenium/webdriver/bidi/network/credentials.rb [26-29] def initialize(username: nil, password: nil) + if username \|\| password + raise ArgumentError, "Username must be a non-empty string" if username.nil? \|\| username.empty? + raise ArgumentError, "Password must be a non-empty string" if password.nil? \|\| password.empty? + end @username = username @password = password end Apply this suggestion Suggestion importance[1-10]: 8 Why: The suggestion adds critical validation for authentication credentials, preventing potential security issues and authentication failures by ensuring credentials are non-empty strings when provided.	8
	Add validation to ensure request ID is an integer to prevent type-related errors The `id` method assumes `@request['request']` returns an Integer but this is not validated. Add type checking and error handling to ensure the request ID is valid. rb/lib/selenium/webdriver/bidi/network/intercepted_item.rb [31-33] def id - @id \|\|= @request['request'] + @id \|\|= begin + request_id = @request['request'] + raise ArgumentError, 'Invalid request ID' unless request_id.is_a?(Integer) + request_id + end end Apply this suggestion Suggestion importance[1-10]: 8 Why: The suggestion addresses a potential runtime error by adding type validation for the request ID, which is critical for proper object identification and could prevent hard-to-debug issues in production.	8
	Add validation and error handling when setting request body to prevent runtime errors from invalid data Add input validation for the body value to ensure it's in a valid format before serializing to JSON, as invalid data could cause runtime errors. rb/lib/selenium/webdriver/bidi/network/intercepted_request.rb [52-57] def body=(value) - @body = { - type: 'string', - value: value.to_json - } + raise ArgumentError, "Body value must not be nil" if value.nil? + begin + @body = { + type: 'string', + value: value.to_json + } + rescue JSON::GeneratorError => e + raise ArgumentError, "Invalid body value: #{e.message}" + end end Apply this suggestion Suggestion importance[1-10]: 7 Why: The suggestion adds important input validation and error handling for the body setter method, which could prevent runtime errors and provide clearer error messages when invalid data is provided.	7
General	Add missing parameter type in method signature to prevent potential type errors The `body=` method signature is incomplete - it's missing the parameter type which could lead to type-related bugs. rb/sig/lib/selenium/webdriver/bidi/network/intercepted_response.rbs [21] -def body=: -> untyped +def body=: (untyped value) -> untyped Apply this suggestion Suggestion importance[1-10]: 7 Why: The suggestion fixes an incomplete method signature in the type definition file, which is important for maintaining type safety and preventing potential type-related bugs during development.	7

…_command' into add_support_for_provide_response_command

rb/spec/integration/selenium/webdriver/network_spec.rb

…_command' into add_support_for_provide_response_command

* Add response handler * Update auth handlers and improve the :on method * Request and response working as expected * Add test for continue without auth and cancel auth * Finish implementation * Correct rubocop offenses * Add alias for user to do network.bidi instead of network.network * Fix rust file causing formatting error * Handle requests and responses in block * Add ability to pass handlers to each different intercepted element * Headers working * All tests passing and signatures simplified * remove unnecessary changes * remove unnecessary changes * Added credentials and set cookie header to intercepted response * Fix rubocop issues * Make auth handler more user friendly * Add filtering an url pattern support * Fix formatting issues * Modify tests to avoid element related failures on firefox * Fix styling of comments * Improve types and hash consistency * Update all the places that use 9.4.8.0 * Serialize request values * Refactor cookies, headers and set cookie headers * Simplify serialization * Add extra type support * remove unnecessary comment * Improve typing * add provide response support * Correct rubocop offenses * Remove set cookie headers * Remove set cookie headers * Fix failing tests * Add negative scenario --------- Co-authored-by: Puja Jagani <[email protected]>

aguspe and others added 30 commits December 14, 2024 15:22

Add response handler

7ef9d83

Update auth handlers and improve the :on method

2f2012a

Merge branch 'trunk' into add_response_handler

487a6e3

Request and response working as expected

28cf363

Add test for continue without auth and cancel auth

314b458

Finish implementation

305135e

Correct rubocop offenses

ff2ba0d

Add alias for user to do network.bidi instead of network.network

0b41266

Fix rust file causing formatting error

25c201b

Merge branch 'trunk' into add_response_handler

92ea3ef

Handle requests and responses in block

7e22239

Merge remote-tracking branch 'origin/add_response_handler' into add_r…

ad82e86

…esponse_handler

Merge branch 'trunk' into add_response_handler

b2cea1d

Add ability to pass handlers to each different intercepted element

ae80832

Merge remote-tracking branch 'origin/add_response_handler' into add_r…

b4a4fe7

…esponse_handler

Merge branch 'trunk' into add_response_handler

13a0912

Headers working

c21f643

Merge branch 'trunk' into add_response_handler

f390699

All tests passing and signatures simplified

69b5690

remove unnecessary changes

bb1ece5

remove unnecessary changes

996c527

Merge remote-tracking branch 'origin/add_response_handler' into add_r…

f8f3f7f

…esponse_handler

Added credentials and set cookie header to intercepted response

f2f9e01

Merge branch 'trunk' into add_response_handler

38d0b9a

Fix rubocop issues

71f5fa6

Merge branch 'trunk' into add_response_handler

9c23adf

Make auth handler more user friendly

d9e0ffc

Add filtering an url pattern support

87dc1e6

Merge branch 'trunk' into add_response_handler

9612939

Fix formatting issues

7c49b93

aguspe and others added 8 commits January 13, 2025 13:50

Merge branch 'trunk' into add_response_handler

0484ee2

Merge branch 'trunk' into add_response_handler

7760eb3

Merge branch 'trunk' into add_response_handler

5596a53

merge latest

52fd7b0

Merge branch 'trunk' into add_response_handler

71da231

Merge branch 'add_response_handler' of github.com:aguspe/selenium int…

26253b8

…o add_support_for_provide_response_command

add provide response support

3557bfb

Correct rubocop offenses

5d276c2

qodo-merge-pro bot added the Review effort [1-5]: 4 label Jan 14, 2025

aguspe added the C-rb Ruby Bindings label Jan 14, 2025

aguspe changed the title ~~Add support for provide response command~~ [rb] Add support for provide response command Jan 14, 2025

aguspe mentioned this pull request Jan 14, 2025

[rb] Add Bidi Network Response Handler #14900

Merged

8 tasks

Merge branch 'trunk' into add_support_for_provide_response_command

313d0f6

aguspe changed the title ~~[rb] Add support for provide response command~~ [rb][BiDi] Add support for provide response command Jan 25, 2025

aguspe added 5 commits January 25, 2025 09:42

Merge trunk

86626e0

Merge remote-tracking branch 'origin/add_support_for_provide_response…

56dd637

…_command' into add_support_for_provide_response_command

Remove set cookie headers

816ba51

Remove set cookie headers

74a0545

Fix failing tests

6a2255d

luke-hill reviewed Jan 30, 2025

View reviewed changes

rb/spec/integration/selenium/webdriver/network_spec.rb Outdated Show resolved Hide resolved

aguspe and others added 4 commits January 30, 2025 17:05

Merge branch 'trunk' into add_support_for_provide_response_command

6e88cfc

Merge branch 'trunk' into add_support_for_provide_response_command

d5e2726

Add negative scenario

894883c

Merge remote-tracking branch 'origin/add_support_for_provide_response…

0a38fee

…_command' into add_support_for_provide_response_command

luke-hill approved these changes Feb 5, 2025

View reviewed changes

aguspe merged commit 73607ee into SeleniumHQ:trunk Feb 5, 2025
17 of 23 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

[rb][BiDi] Add support for provide response command #15080

[rb][BiDi] Add support for provide response command #15080

Uh oh!

aguspe commented Jan 14, 2025 •

edited

Loading

Uh oh!

qodo-merge-pro bot commented Jan 14, 2025

Uh oh!

qodo-merge-pro bot commented Jan 14, 2025

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

[rb][BiDi] Add support for provide response command #15080

[rb][BiDi] Add support for provide response command #15080

Uh oh!

Conversation

aguspe commented Jan 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

User description

Description

Motivation and Context

Types of changes

Checklist

PR Type

Description

Changes walkthrough 📝

Uh oh!

qodo-merge-pro bot commented Jan 14, 2025

PR Reviewer Guide 🔍

Uh oh!

qodo-merge-pro bot commented Jan 14, 2025

PR Code Suggestions ✨

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

aguspe commented Jan 14, 2025 •

edited

Loading