123456789_123456789_123456789_123456789_123456789_

Class: Selenium::WebDriver::Remote::BiDiBridge

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Bridge
Instance Chain:
self, Bridge, ::Selenium::WebDriver::Atoms
Inherits: Selenium::WebDriver::Remote::Bridge
Defined in: rb/lib/selenium/webdriver/remote/bidi_bridge.rb

Constant Summary

Bridge - Inherited

COMMANDS, PORT, QUIT_ERRORS

Class Attribute Summary

Bridge - Inherited

.element_class, .element_class=, .extra_commands, .locator_converter, .locator_converter=

Class Method Summary

Bridge - Inherited

.add_command, .new

Instance Attribute Summary

Bridge - Inherited

#alert=, #bidi?, #capabilities, #file_detector, #http,
#timeouts

timeouts.
#timeouts=

Instance Method Summary

Bridge - Inherited

#accept_alert

alerts.
#action

actions.
#actions

Alias for Bridge#action.
#active_element

finding elements.
#add_cookie, #add_credential,
#add_virtual_authenticator

virtual-authenticator.
#alert_text, #bidi, #browser,
#cancel_fedcm_dialog

federated-credential management.
#clear_element, #click_element, #click_fedcm_dialog_button, #close, #command_list,
#connection

Alias for Bridge#bidi.
#cookie, #cookies,
#create_session

Creates session.
#credentials, #delete_all_cookies, #delete_cookie, #dismiss_alert, #element_aria_label, #element_aria_role, #element_attribute, #element_displayed?, #element_dom_attribute, #element_enabled?, #element_location, #element_location_once_scrolled_into_view, #element_property, #element_rect, #element_screenshot, #element_selected?, #element_size,
#element_tag_name

element properties.
#element_text, #element_value, #element_value_of_css_property, #execute_async_script,
#execute_script

javascript execution.
#fedcm_account_list, #fedcm_delay, #fedcm_dialog_type, #fedcm_subtitle, #fedcm_title, #find_element_by, #find_elements_by, #full_screen_window, #get,
#go_back

navigation.
#go_forward,
#install_web_extension

Alias for Bridge#bidi.
#manage

cookies.
#maximize_window, #minimize_window,
#new_window

Create a new top-level browsing context https://w3c.github.io/webdriver/#new-window.
#page_source, #print_page, #quit, #refresh, #release_actions, #remove_all_credentials, #remove_credential, #remove_virtual_authenticator, #reposition_window, #reset_fedcm_cooldown, #resize_window, #screenshot, #select_fedcm_account, #send_actions, #send_keys_to_element,
#session_id

Returns the current session ID.
#set_window_rect, #shadow_root, #status, #submit_element,
#switch_to_active_element

Alias for Bridge#active_element.
#switch_to_default_content, #switch_to_frame, #switch_to_parent_frame, #switch_to_window, #title,
#uninstall_web_extension

Alias for Bridge#bidi.
#url, #user_verified, #window_handle,
#window_handles

window handling.
#window_position, #window_rect, #window_size, #commands, #element_id_from, #encode_extension, #escaper,
#execute

executes a command on the remote server.
#prepare_capabilities_payload, #shadow_root_id_from, #unwrap_script_result,
#web_extension

Alias for Bridge#bidi.

::Selenium::WebDriver::Atoms - Included

#atom_script, #execute_atom, #read_atom

Constructor Details

This class inherits a constructor from Selenium::WebDriver::Remote::Bridge

Instance Attribute Details

#bidi (readonly)

[ GitHub ] 

  


# File 'rb/lib/selenium/webdriver/remote/bidi_bridge.rb', line 27



attr_reader :bidi, :connection


  








  

    #connection   (readonly)
  

  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/remote/bidi_bridge.rb', line 27



attr_reader :bidi, :connection


  







Instance Method Details



  

    #browsing_context   (private)
  

  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/remote/bidi_bridge.rb', line 100



def browsing_context
  @browsing_context ||= BiDi::Protocol::BrowsingContext.new(connection)
end


  








  

    #close  
  

  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/remote/bidi_bridge.rb', line 86



def close
  execute(:close_window).tap { |handles| bidi.close if handles.empty? }
end


  








  

    #create_session(capabilities)  
  

  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/remote/bidi_bridge.rb', line 35



def create_session(capabilities)
  super

  begin
    @bidi = Selenium::WebDriver::BiDi.new(url: validated_socket_url)
    # Reuse the BiDi object's socket as the connection until the bridge owns it directly.
    @connection = @bidi.ws
  rescue StandardError
    quit
    raise
  end
end


  








  

    #get(url)  
  

  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/remote/bidi_bridge.rb', line 58



def get(url)
  browsing_context.navigate(context: window_handle, url: url, wait: readiness_state)
  nil
end


  








  

    #go_back  
  

  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/remote/bidi_bridge.rb', line 63



def go_back
  browsing_context.traverse_history(context: window_handle, delta: -1)
  nil
end


  








  

    #go_forward  
  

  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/remote/bidi_bridge.rb', line 68



def go_forward
  browsing_context.traverse_history(context: window_handle, delta: 1)
  nil
end


  








  

    #install_web_extension(path)  
  

  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/remote/bidi_bridge.rb', line 48



def install_web_extension(path)
  result = web_extension.install(extension_data: web_extension_data(path))
  WebExtension.new(result.extension)
end


  








  

    #quit  
  

  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/remote/bidi_bridge.rb', line 78



def quit
  bidi&.close
rescue *QUIT_ERRORS
  nil
ensure
  super
end


  








  

    #readiness_state   (private)
  

  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/remote/bidi_bridge.rb', line 117



def readiness_state
  READINESS_STATE.fetch(capabilities[:page_load_strategy] || 'normal')
end


  








  

    #refresh  
  

  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/remote/bidi_bridge.rb', line 73



def refresh
  browsing_context.reload(context: window_handle, wait: readiness_state)
  nil
end


  








  

    #uninstall_web_extension(id)  
  

  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/remote/bidi_bridge.rb', line 53



def uninstall_web_extension(id)
  web_extension.uninstall(extension: id)
  nil
end


  








  

    #validated_socket_url   (private)
  



  

    
  





  
Raises:





  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/remote/bidi_bridge.rb', line 92



def validated_socket_url
  url = @capabilities[:web_socket_url]
  return url if url.is_a?(String) && url.start_with?('ws://', 'wss://')

  raise Error::WebDriverError,
        "BiDi was enabled, but the remote end did not return a valid webSocketUrl: #{url.inspect}."
end


  








  

    #web_extension   (private)
  

  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/remote/bidi_bridge.rb', line 104



def web_extension
  @web_extension ||= BiDi::Protocol::WebExtension.new(connection)
end


  








  

    #web_extension_data(path)   (private)
  



  

    
A directory only resolves on the machine running the browser, so upload it to the remote
end and reference the returned path; archives and base64 bytes travel inline.

  



  [ GitHub ]


  

  


# File 'rb/lib/selenium/webdriver/remote/bidi_bridge.rb', line 110



def web_extension_data(path)
  return web_extension.extension_base64_encoded(value: encode_extension(path)) unless File.directory?(path)

  path = upload(path) if respond_to?(:upload)
  web_extension.extension_path(path: path)
end