Class: Selenium::WebDriver::Remote::Bridge Private

Inherits:
Object
  • Object
show all
Includes:
Atoms
Defined in:
rb/lib/selenium/webdriver/remote/bridge/commands.rb,
rb/lib/selenium/webdriver/remote/bridge.rb,
rb/lib/selenium/webdriver/remote/bridge/locator_converter.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

w3c.github.io/webdriver/#endpoints

Direct Known Subclasses

BiDiBridge

Defined Under Namespace

Classes: LocatorConverter

Constant Summary collapse

PORT = 
4444
QUIT_ERRORS = 
[IOError].freeze
COMMANDS =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

{
  status: [:get, 'status'],

  #
  # session handling
  #

  new_session: [:post, 'session'],
  delete_session: [:delete, 'session/:session_id'],

  #
  # basic driver
  #

  get: [:post, 'session/:session_id/url'],
  get_current_url: [:get, 'session/:session_id/url'],
  back: [:post, 'session/:session_id/back'],
  forward: [:post, 'session/:session_id/forward'],
  refresh: [:post, 'session/:session_id/refresh'],
  get_title: [:get, 'session/:session_id/title'],

  #
  # window and Frame handling
  #

  get_window_handle: [:get, 'session/:session_id/window'],
  new_window: [:post, 'session/:session_id/window/new'],
  close_window: [:delete, 'session/:session_id/window'],
  switch_to_window: [:post, 'session/:session_id/window'],
  get_window_handles: [:get, 'session/:session_id/window/handles'],
  fullscreen_window: [:post, 'session/:session_id/window/fullscreen'],
  minimize_window: [:post, 'session/:session_id/window/minimize'],
  maximize_window: [:post, 'session/:session_id/window/maximize'],
  set_window_rect: [:post, 'session/:session_id/window/rect'],
  get_window_rect: [:get, 'session/:session_id/window/rect'],
  switch_to_frame: [:post, 'session/:session_id/frame'],
  switch_to_parent_frame: [:post, 'session/:session_id/frame/parent'],

  #
  # element
  #

  find_element: [:post, 'session/:session_id/element'],
  find_elements: [:post, 'session/:session_id/elements'],
  find_child_element: [:post, 'session/:session_id/element/:id/element'],
  find_child_elements: [:post, 'session/:session_id/element/:id/elements'],
  find_shadow_child_element: [:post, 'session/:session_id/shadow/:id/element'],
  find_shadow_child_elements: [:post, 'session/:session_id/shadow/:id/elements'],
  get_active_element: [:get, 'session/:session_id/element/active'],
  get_element_shadow_root: [:get, 'session/:session_id/element/:id/shadow'],
  is_element_selected: [:get, 'session/:session_id/element/:id/selected'],
  get_element_attribute: [:get, 'session/:session_id/element/:id/attribute/:name'],
  get_element_property: [:get, 'session/:session_id/element/:id/property/:name'],
  get_element_css_value: [:get, 'session/:session_id/element/:id/css/:property_name'],
  get_element_aria_role: [:get, 'session/:session_id/element/:id/computedrole'],
  get_element_aria_label: [:get, 'session/:session_id/element/:id/computedlabel'],
  get_element_text: [:get, 'session/:session_id/element/:id/text'],
  get_element_tag_name: [:get, 'session/:session_id/element/:id/name'],
  get_element_rect: [:get, 'session/:session_id/element/:id/rect'],
  is_element_enabled: [:get, 'session/:session_id/element/:id/enabled'],

  #
  # document handling
  #

  get_page_source: [:get, 'session/:session_id/source'],
  execute_script: [:post, 'session/:session_id/execute/sync'],
  execute_async_script: [:post, 'session/:session_id/execute/async'],

  #
  # cookies
  #

  get_all_cookies: [:get, 'session/:session_id/cookie'],
  get_cookie: [:get, 'session/:session_id/cookie/:name'],
  add_cookie: [:post, 'session/:session_id/cookie'],
  delete_cookie: [:delete, 'session/:session_id/cookie/:name'],
  delete_all_cookies: [:delete, 'session/:session_id/cookie'],

  #
  # timeouts
  #

  get_timeouts: [:get, 'session/:session_id/timeouts'],
  set_timeout: [:post, 'session/:session_id/timeouts'],

  #
  # actions
  #

  actions: [:post, 'session/:session_id/actions'],
  release_actions: [:delete, 'session/:session_id/actions'],
  print_page: [:post, 'session/:session_id/print'],

  #
  # Element Operations
  #

  element_click: [:post, 'session/:session_id/element/:id/click'],
  element_clear: [:post, 'session/:session_id/element/:id/clear'],
  element_send_keys: [:post, 'session/:session_id/element/:id/value'],

  #
  # alerts
  #

  dismiss_alert: [:post, 'session/:session_id/alert/dismiss'],
  accept_alert: [:post, 'session/:session_id/alert/accept'],
  get_alert_text: [:get, 'session/:session_id/alert/text'],
  send_alert_text: [:post, 'session/:session_id/alert/text'],

  #
  # screenshot
  #

  take_screenshot: [:get, 'session/:session_id/screenshot'],
  take_element_screenshot: [:get, 'session/:session_id/element/:id/screenshot'],

  #
  # virtual-authenticator
  #

  add_virtual_authenticator: [:post, 'session/:session_id/webauthn/authenticator'],
  remove_virtual_authenticator: [:delete, 'session/:session_id/webauthn/authenticator/:authenticatorId'],
  add_credential: [:post, 'session/:session_id/webauthn/authenticator/:authenticatorId/credential'],
  get_credentials: [:get, 'session/:session_id/webauthn/authenticator/:authenticatorId/credentials'],
  remove_credential: [:delete,
                      'session/:session_id/webauthn/authenticator/:authenticatorId/credentials/:credentialId'],
  remove_all_credentials: [:delete, 'session/:session_id/webauthn/authenticator/:authenticatorId/credentials'],
  set_user_verified: [:post, 'session/:session_id/webauthn/authenticator/:authenticatorId/uv'],

  #
  # federated-credential management
  #

  get_fedcm_title: [:get, 'session/:session_id/fedcm/gettitle'],
  get_fedcm_dialog_type: [:get, 'session/:session_id/fedcm/getdialogtype'],
  get_fedcm_account_list: [:get, 'session/:session_id/fedcm/accountlist'],
  click_fedcm_dialog_button: [:post, 'session/:session_id/fedcm/clickdialogbutton'],
  cancel_fedcm_dialog: [:post, 'session/:session_id/fedcm/canceldialog'],
  select_fedcm_account: [:post, 'session/:session_id/fedcm/selectaccount'],
  set_fedcm_delay: [:post, 'session/:session_id/fedcm/setdelayenabled'],
  reset_fedcm_cooldown: [:post, 'session/:session_id/fedcm/resetcooldown']
}.freeze

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Atoms

#atom_script

Constructor Details

#initialize(url:, http_client: nil) ⇒ Bridge

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Initializes the bridge with the given server URL

Parameters:

  • url (String, URI) —

    url for the remote server

  • http_client (Object) (defaults to: nil) —

    an HTTP client instance that implements the same protocol as Http::Default



60
61
62
63
64
65
66
67
68
69
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 60

def initialize(url:, http_client: nil)
  uri = url.is_a?(URI) ? url : URI.parse(url)
  uri.path += '/' unless uri.path.end_with?('/')

  @http = http_client || Http::Default.new
  @http.server_url = uri
  @file_detector = nil

  @locator_converter = self.class.locator_converter
end

Class Attribute Details

.element_class ⇒ Object 



48
49
50
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 48

def element_class
  @element_class ||= Element
end

.extra_commands ⇒ Object (readonly)

Returns the value of attribute extra_commands.



35
36
37
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 35

def extra_commands
  @extra_commands
end

.locator_converter ⇒ Object 



44
45
46
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 44

def locator_converter
  @locator_converter ||= LocatorConverter.new
end

Instance Attribute Details

#capabilities ⇒ Object (readonly)

Returns the value of attribute capabilities.



32
33
34
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 32

def capabilities
  @capabilities
end

#file_detector ⇒ Object

Returns the value of attribute file_detector.



31
32
33
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 31

def file_detector
  @file_detector
end

#http ⇒ Object

Returns the value of attribute http.



31
32
33
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 31

def http
  @http
end

Class Method Details

.add_command(name, verb, url, &block) ⇒ Object 



38
39
40
41
42
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 38

def add_command(name, verb, url, &block)
  @extra_commands ||= {}
  @extra_commands[name] = [verb, url]
  define_method(name, &block)
end

Instance Method Details

#accept_alert ⇒ Object

alerts



138
139
140
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 138

def accept_alert
  execute :accept_alert
end

#action(async: false, devices: [], duration: 250) ⇒ Object Also known as: actions

actions



407
408
409
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 407

def action(async: false, devices: [], duration: 250)
  ActionBuilder.new self, async: async, devices: devices, duration: duration
end

#active_element ⇒ Object Also known as: switch_to_active_element

finding elements



535
536
537
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 535

def active_element
  Bridge.element_class.new self, element_id_from(execute(:get_active_element))
end

#add_cookie(cookie) ⇒ Object 



383
384
385
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 383

def add_cookie(cookie)
  execute :add_cookie, {}, {cookie: cookie}
end

#add_credential(credential, id) ⇒ Object 



595
596
597
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 595

def add_credential(credential, id)
  execute :add_credential, {authenticatorId: id}, credential
end

#add_virtual_authenticator(options) ⇒ Object

virtual-authenticator



586
587
588
589
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 586

def add_virtual_authenticator(options)
  authenticator_id = execute :add_virtual_authenticator, {}, options.as_json
  VirtualAuthenticator.new(self, authenticator_id, options)
end

#alert=(keys) ⇒ Object 



146
147
148
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 146

def alert=(keys)
  execute :send_alert_text, {}, {value: keys.chars, text: keys}
end

#alert_text ⇒ Object 



150
151
152
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 150

def alert_text
  execute :get_alert_text
end

#bidi ⇒ Object

Raises:



655
656
657
658
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 655

def bidi
  msg = 'BiDi must be enabled by setting #web_socket_url to true in options class'
  raise(WebDriver::Error::WebDriverError, msg)
end

#browser ⇒ Object 



107
108
109
110
111
112
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 107

def browser
  @browser ||= begin
    name = @capabilities.browser_name
    name ? name.tr(' -', '_').downcase.to_sym : 'unknown'
  end
end

#cancel_fedcm_dialog ⇒ Object

federated-credential management



619
620
621
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 619

def cancel_fedcm_dialog
  execute :cancel_fedcm_dialog
end

#clear_element(element) ⇒ Object 



434
435
436
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 434

def clear_element(element)
  execute :element_clear, id: element
end

#clear_local_storage ⇒ Object 



322
323
324
325
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 322

def clear_local_storage
  WebDriver.logger.deprecate('clear_local_storage', id: :clear_local_storage)
  execute_script('localStorage.clear()')
end

#clear_session_storage ⇒ Object 



351
352
353
354
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 351

def clear_session_storage
  WebDriver.logger.deprecate('clear_session_storage', id: :clear_session_storage)
  execute_script('sessionStorage.clear()')
end

#click_element(element) ⇒ Object 



424
425
426
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 424

def click_element(element)
  execute :element_click, id: element
end

#click_fedcm_dialog_button ⇒ Object 



651
652
653
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 651

def click_fedcm_dialog_button
  execute :click_fedcm_dialog_button, {}, {dialogButton: 'ConfirmIdpLoginContinue'}
end

#close ⇒ Object 



218
219
220
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 218

def close
  execute :close_window
end

#command_list ⇒ Object 



660
661
662
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 660

def command_list
  COMMANDS
end

#cookie(name) ⇒ Object 



391
392
393
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 391

def cookie(name)
  execute :get_cookie, name: name
end

#cookies ⇒ Object 



395
396
397
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 395

def cookies
  execute :get_all_cookies
end

#create_session(capabilities) ⇒ Object

Creates session.

Raises:



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 75

def create_session(capabilities)
  response = execute(:new_session, {}, prepare_capabilities_payload(capabilities))

  @session_id = response['sessionId']
  capabilities = response['capabilities']

  raise Error::WebDriverError, 'no sessionId in returned payload' unless @session_id

  @capabilities = Capabilities.json_create(capabilities)

  case @capabilities[:browser_name]
  when 'chrome', 'chrome-headless-shell'
    extend(WebDriver::Chrome::Features)
  when 'firefox'
    extend(WebDriver::Firefox::Features)
  when 'msedge', 'MicrosoftEdge'
    extend(WebDriver::Edge::Features)
  when 'Safari', 'Safari Technology Preview'
    extend(WebDriver::Safari::Features)
  when 'internet explorer'
    extend(WebDriver::IE::Features)
  end
end

#credentials(authenticator_id) ⇒ Object 



599
600
601
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 599

def credentials(authenticator_id)
  execute :get_credentials, {authenticatorId: authenticator_id}
end

#delete_all_cookies ⇒ Object 



399
400
401
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 399

def delete_all_cookies
  execute :delete_all_cookies
end

#delete_cookie(name) ⇒ Object 



387
388
389
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 387

def delete_cookie(name)
  execute :delete_cookie, name: name
end

#dismiss_alert ⇒ Object 



142
143
144
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 142

def dismiss_alert
  execute :dismiss_alert
end

#element_aria_label(element) ⇒ Object 



479
480
481
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 479

def element_aria_label(element)
  execute :get_element_aria_label, id: element
end

#element_aria_role(element) ⇒ Object 



475
476
477
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 475

def element_aria_role(element)
  execute :get_element_aria_role, id: element
end

#element_attribute(element, name) ⇒ Object 



462
463
464
465
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 462

def element_attribute(element, name)
  WebDriver.logger.debug "Using script for :getAttribute of #{name}", id: :script
  execute_atom :getAttribute, element, name
end

#element_displayed?(element) ⇒ Boolean

Returns:

  • (Boolean) 


522
523
524
525
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 522

def element_displayed?(element)
  WebDriver.logger.debug 'Using script for :isDisplayed', id: :script
  execute_atom :isDisplayed, element
end

#element_dom_attribute(element, name) ⇒ Object 



467
468
469
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 467

def element_dom_attribute(element, name)
  execute :get_element_attribute, id: element, name: name
end

#element_enabled?(element) ⇒ Boolean

Returns:

  • (Boolean) 


514
515
516
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 514

def element_enabled?(element)
  execute :is_element_enabled, id: element
end

#element_location(element) ⇒ Object 



491
492
493
494
495
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 491

def element_location(element)
  data = execute :get_element_rect, id: element

  Point.new data['x'], data['y']
end

#element_location_once_scrolled_into_view(element) ⇒ Object 



503
504
505
506
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 503

def element_location_once_scrolled_into_view(element)
  send_keys_to_element(element, [''])
  element_location(element)
end

#element_property(element, name) ⇒ Object 



471
472
473
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 471

def element_property(element, name)
  execute :get_element_property, id: element, name: name
end

#element_rect(element) ⇒ Object 



497
498
499
500
501
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 497

def element_rect(element)
  data = execute :get_element_rect, id: element

  Rectangle.new data['x'], data['y'], data['width'], data['height']
end

#element_screenshot(element) ⇒ Object 



295
296
297
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 295

def element_screenshot(element)
  execute :take_element_screenshot, id: element
end

#element_selected?(element) ⇒ Boolean

Returns:

  • (Boolean) 


518
519
520
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 518

def element_selected?(element)
  execute :is_element_selected, id: element
end

#element_size(element) ⇒ Object 



508
509
510
511
512
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 508

def element_size(element)
  data = execute :get_element_rect, id: element

  Dimension.new data['width'], data['height']
end

#element_tag_name(element) ⇒ Object

element properties



458
459
460
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 458

def element_tag_name(element)
  execute :get_element_tag_name, id: element
end

#element_text(element) ⇒ Object 



487
488
489
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 487

def element_text(element)
  execute :get_element_text, id: element
end

#element_value(element) ⇒ Object 



483
484
485
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 483

def element_value(element)
  element_property element, 'value'
end

#element_value_of_css_property(element, prop) ⇒ Object 



527
528
529
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 527

def element_value_of_css_property(element, prop)
  execute :get_element_css_value, id: element, property_name: prop
end

#execute_async_script(script, *args) ⇒ Object 



370
371
372
373
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 370

def execute_async_script(script, *args)
  result = execute :execute_async_script, {}, {script: script, args: args}
  unwrap_script_result result
end

#execute_script(script, *args) ⇒ Object

javascript execution



365
366
367
368
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 365

def execute_script(script, *args)
  result = execute :execute_script, {}, {script: script, args: args}
  unwrap_script_result result
end

#fedcm_account_list ⇒ Object 



639
640
641
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 639

def 
  execute :get_fedcm_account_list
end

#fedcm_delay(enabled) ⇒ Object 



643
644
645
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 643

def fedcm_delay(enabled)
  execute :set_fedcm_delay, {}, {enabled: enabled}
end

#fedcm_dialog_type ⇒ Object 



627
628
629
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 627

def fedcm_dialog_type
  execute :get_fedcm_dialog_type
end

#fedcm_subtitle ⇒ Object 



635
636
637
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 635

def fedcm_subtitle
  execute(:get_fedcm_title).fetch('subtitle', nil)
end

#fedcm_title ⇒ Object 



631
632
633
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 631

def fedcm_title
  execute(:get_fedcm_title).fetch('title')
end

#find_element_by(how, what, parent_ref = []) ⇒ Object 



541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 541

def find_element_by(how, what, parent_ref = [])
  how, what = @locator_converter.convert(how, what)

  return execute_atom(:findElements, Support::RelativeLocator.new(what).as_json).first if how == 'relative'

  parent_type, parent_id = parent_ref
  id = case parent_type
       when :element
         execute :find_child_element, {id: parent_id}, {using: how, value: what.to_s}
       when :shadow_root
         execute :find_shadow_child_element, {id: parent_id}, {using: how, value: what.to_s}
       else
         execute :find_element, {}, {using: how, value: what.to_s}
       end

  Bridge.element_class.new self, element_id_from(id)
end

#find_elements_by(how, what, parent_ref = []) ⇒ Object 



559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 559

def find_elements_by(how, what, parent_ref = [])
  how, what = @locator_converter.convert(how, what)

  return execute_atom :findElements, Support::RelativeLocator.new(what).as_json if how == 'relative'

  parent_type, parent_id = parent_ref
  ids = case parent_type
        when :element
          execute :find_child_elements, {id: parent_id}, {using: how, value: what.to_s}
        when :shadow_root
          execute :find_shadow_child_elements, {id: parent_id}, {using: how, value: what.to_s}
        else
          execute :find_elements, {}, {using: how, value: what.to_s}
        end

  ids.map { |id| Bridge.element_class.new self, element_id_from(id) }
end

#full_screen_window ⇒ Object 



267
268
269
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 267

def full_screen_window
  execute :fullscreen_window
end

#get(url) ⇒ Object 



118
119
120
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 118

def get(url)
  execute :get, {}, {url: url}
end

#go_back ⇒ Object

navigation



158
159
160
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 158

def go_back
  execute :back
end

#go_forward ⇒ Object 



162
163
164
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 162

def go_forward
  execute :forward
end

#local_storage_item(key, value = nil) ⇒ Object

HTML 5



303
304
305
306
307
308
309
310
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 303

def local_storage_item(key, value = nil)
  WebDriver.logger.deprecate('local_storage_item(key, value)', id: :local_storage_item)
  if value
    execute_script("localStorage.setItem('#{key}', '#{value}')")
  else
    execute_script("return localStorage.getItem('#{key}')")
  end
end

#local_storage_keys ⇒ Object 



317
318
319
320
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 317

def local_storage_keys
  WebDriver.logger.deprecate('local_storage_keys', id: :local_storage_keys)
  execute_script('return Object.keys(localStorage)')
end

#local_storage_size ⇒ Object 



327
328
329
330
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 327

def local_storage_size
  WebDriver.logger.deprecate('local_storage_size', id: :local_storage_size)
  execute_script('return localStorage.length')
end

#manage ⇒ Object

cookies



379
380
381
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 379

def manage
  @manage ||= WebDriver::Manager.new(self)
end

#maximize_window(handle = :current) ⇒ Object 



258
259
260
261
262
263
264
265
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 258

def maximize_window(handle = :current)
  unless handle == :current
    raise Error::UnsupportedOperationError,
          'Switch to desired window before changing its size'
  end

  execute :maximize_window
end

#minimize_window ⇒ Object 



254
255
256
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 254

def minimize_window
  execute :minimize_window
end

#new_window(type) ⇒ Hash

Create a new top-level browsing context w3c.github.io/webdriver/#new-window

Parameters:

  • type (String) —

    Supports two values: ‘tab’ and ‘window’. Use ‘tab’ if you’d like the new window to share an OS-level window with the current browsing context. Use ‘window’ otherwise

Returns:

  • (Hash) —

    Containing ‘handle’ with the value of the window handle and ‘type’ with the value of the created window type



188
189
190
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 188

def new_window(type)
  execute :new_window, {}, {type: type}
end

#page_source ⇒ Object 



174
175
176
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 174

def page_source
  execute :get_page_source
end

#print_page(options = {}) ⇒ Object 



420
421
422
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 420

def print_page(options = {})
  execute :print_page, {}, {options: options}
end

#quit ⇒ Object 



211
212
213
214
215
216
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 211

def quit
  execute :delete_session
  http.close
rescue *QUIT_ERRORS
  nil
end

#refresh ⇒ Object 



222
223
224
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 222

def refresh
  execute :refresh
end

#release_actions ⇒ Object 



416
417
418
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 416

def release_actions
  execute :release_actions
end

#remove_all_credentials(authenticator_id) ⇒ Object 



607
608
609
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 607

def remove_all_credentials(authenticator_id)
  execute :remove_all_credentials, {authenticatorId: authenticator_id}
end

#remove_credential(credential_id, authenticator_id) ⇒ Object 



603
604
605
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 603

def remove_credential(credential_id, authenticator_id)
  execute :remove_credential, {credentialId: credential_id, authenticatorId: authenticator_id}
end

#remove_local_storage_item(key) ⇒ Object 



312
313
314
315
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 312

def remove_local_storage_item(key)
  WebDriver.logger.deprecate('remove_local_storage_item(key)', id: :remove_local_storage_item)
  execute_script("localStorage.removeItem('#{key}')")
end

#remove_session_storage_item(key) ⇒ Object 



341
342
343
344
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 341

def remove_session_storage_item(key)
  WebDriver.logger.deprecate('remove_session_storage_item(key)', id: :remove_session_storage_item)
  execute_script("sessionStorage.removeItem('#{key}')")
end

#remove_virtual_authenticator(id) ⇒ Object 



591
592
593
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 591

def remove_virtual_authenticator(id)
  execute :remove_virtual_authenticator, {authenticatorId: id}
end

#reposition_window(x, y) ⇒ Object 



271
272
273
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 271

def reposition_window(x, y)
  set_window_rect(x: x, y: y)
end

#reset_fedcm_cooldown ⇒ Object 



647
648
649
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 647

def reset_fedcm_cooldown
  execute :reset_fedcm_cooldown
end

#resize_window(width, height, handle = :current) ⇒ Object

Raises:



238
239
240
241
242
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 238

def resize_window(width, height, handle = :current)
  raise Error::WebDriverError, 'Switch to desired window before changing its size' unless handle == :current

  set_window_rect(width: width, height: height)
end

#screenshot ⇒ Object 



291
292
293
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 291

def screenshot
  execute :take_screenshot
end

#select_fedcm_account(index) ⇒ Object 



623
624
625
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 623

def (index)
  execute :select_fedcm_account, {}, {accountIndex: index}
end

#send_actions(data) ⇒ Object 



412
413
414
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 412

def send_actions(data)
  execute :actions, {}, {actions: data}
end

#send_keys_to_element(element, keys) ⇒ Object 



428
429
430
431
432
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 428

def send_keys_to_element(element, keys)
  keys = upload_if_necessary(keys) if @file_detector
  text = keys.join
  execute :element_send_keys, {id: element}, {value: text.chars, text: text}
end

#session_id ⇒ Object

Returns the current session ID.



103
104
105
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 103

def session_id
  @session_id || raise(Error::WebDriverError, 'no current session exists')
end

#session_storage_item(key, value = nil) ⇒ Object 



332
333
334
335
336
337
338
339
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 332

def session_storage_item(key, value = nil)
  WebDriver.logger.deprecate('session_storage_item(key, value)', id: :session_storage_item)
  if value
    execute_script("sessionStorage.setItem('#{key}', '#{value}')")
  else
    execute_script("return sessionStorage.getItem('#{key}')")
  end
end

#session_storage_keys ⇒ Object 



346
347
348
349
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 346

def session_storage_keys
  WebDriver.logger.deprecate('session_storage_keys', id: :session_storage_keys)
  execute_script('return Object.keys(sessionStorage)')
end

#session_storage_size ⇒ Object 



356
357
358
359
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 356

def session_storage_size
  WebDriver.logger.deprecate('session_storage_size', id: :session_storage_size)
  execute_script('return sessionStorage.length')
end

#set_window_rect(x: nil, y: nil, width: nil, height: nil) ⇒ Object 



280
281
282
283
284
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 280

def set_window_rect(x: nil, y: nil, width: nil, height: nil)
  params = {x: x, y: y, width: width, height: height}
  params.update(params) { |_k, v| Integer(v) unless v.nil? }
  execute :set_window_rect, {}, params
end

#shadow_root(element) ⇒ Object 



577
578
579
580
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 577

def shadow_root(element)
  id = execute :get_element_shadow_root, id: element
  ShadowRoot.new self, shadow_root_id_from(id)
end

#status ⇒ Object 



114
115
116
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 114

def status
  execute :status
end

#submit_element(element) ⇒ Object 



438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 438

def submit_element(element)
  script = "/* submitForm */ var form = arguments[0];\n" \
           "while (form.nodeName != \"FORM\" && form.parentNode) {\n  " \
           "form = form.parentNode;\n" \
           "}\n" \
           "if (!form) { throw Error('Unable to find containing form element'); }\n" \
           "if (!form.ownerDocument) { throw Error('Unable to find owning document'); }\n" \
           "var e = form.ownerDocument.createEvent('Event');\n" \
           "e.initEvent('submit', true, true);\n" \
           "if (form.dispatchEvent(e)) { HTMLFormElement.prototype.submit.call(form) }\n"

  execute_script(script, Bridge.element_class::ELEMENT_KEY => element)
rescue Error::JavascriptError
  raise Error::UnsupportedOperationError, 'To submit an element, it must be nested inside a form element'
end

#switch_to_default_content ⇒ Object 



205
206
207
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 205

def switch_to_default_content
  switch_to_frame nil
end

#switch_to_frame(id) ⇒ Object 



196
197
198
199
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 196

def switch_to_frame(id)
  id = find_element_by('id', id) if id.is_a? String
  execute :switch_to_frame, {}, {id: id}
end

#switch_to_parent_frame ⇒ Object 



201
202
203
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 201

def switch_to_parent_frame
  execute :switch_to_parent_frame
end

#switch_to_window(name) ⇒ Object 



192
193
194
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 192

def switch_to_window(name)
  execute :switch_to_window, {}, {handle: name}
end

#timeouts ⇒ Object

timeouts



126
127
128
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 126

def timeouts
  execute :get_timeouts, {}
end

#timeouts=(timeouts) ⇒ Object 



130
131
132
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 130

def timeouts=(timeouts)
  execute :set_timeout, {}, timeouts
end

#title ⇒ Object 



170
171
172
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 170

def title
  execute :get_title
end

#url ⇒ Object 



166
167
168
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 166

def url
  execute :get_current_url
end

#user_verified(verified, authenticator_id) ⇒ Object 



611
612
613
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 611

def user_verified(verified, authenticator_id)
  execute :set_user_verified, {authenticatorId: authenticator_id}, {isUserVerified: verified}
end

#window_handle ⇒ Object 



234
235
236
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 234

def window_handle
  execute :get_window_handle
end

#window_handles ⇒ Object

window handling



230
231
232
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 230

def window_handles
  execute :get_window_handles
end

#window_position ⇒ Object 



275
276
277
278
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 275

def window_position
  data = execute :get_window_rect
  Point.new data['x'], data['y']
end

#window_rect ⇒ Object 



286
287
288
289
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 286

def window_rect
  data = execute :get_window_rect
  Rectangle.new data['x'], data['y'], data['width'], data['height']
end

#window_size(handle = :current) ⇒ Object 



244
245
246
247
248
249
250
251
252
 
# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 244

def window_size(handle = :current)
  unless handle == :current
    raise Error::UnsupportedOperationError,
          'Switch to desired window before getting its size'
  end

  data = execute :get_window_rect
  Dimension.new data['width'], data['height']
end