Class: Capybara::Playwright::Browser

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
TmpdirOwner
Defined in:
lib/capybara/playwright/browser.rb

Overview

Responsibility of this class is:

  • Handling Capybara::Driver commands.

  • Managing Playwright browser contexts and pages.

Note that this class doesn’t manage Playwright::Browser. We should not use Playwright::Browser#close in this class.

Defined Under Namespace

Classes: NoSuchWindowError

Instance Method Summary collapse

Methods included from TmpdirOwner

#remove_tmpdir, #tmpdir

Constructor Details

#initialize(driver:, internal_logger:, playwright_browser:, page_options:, record_video: false, callback_on_save_trace: nil, default_timeout: nil, default_navigation_timeout: nil) ⇒ Browser

Returns a new instance of Browser.



18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/capybara/playwright/browser.rb', line 18

def initialize(driver:, internal_logger:, playwright_browser:, page_options:, record_video: false, callback_on_save_trace: nil, default_timeout: nil, default_navigation_timeout: nil)
  @driver = driver
  @internal_logger = internal_logger
  @playwright_browser = playwright_browser
  @page_options = page_options
  if record_video
    @page_options[:record_video_dir] ||= tmpdir
  end
  @callback_on_save_trace = callback_on_save_trace
  @default_timeout = default_timeout
  @default_navigation_timeout = default_navigation_timeout
  @playwright_page = create_page(create_browser_context)
end

Instance Method Details

#accept_modal(dialog_type, **options, &block) ⇒ Object 



350
351
352
353
354
 
# File 'lib/capybara/playwright/browser.rb', line 350

def accept_modal(dialog_type, **options, &block)
  assert_page_alive {
    @playwright_page.capybara_accept_modal(dialog_type, **options, &block)
  }
end

#active_element ⇒ Object 



190
191
192
193
194
195
196
197
 
# File 'lib/capybara/playwright/browser.rb', line 190

def active_element
  el = @playwright_page.capybara_current_frame.evaluate_handle('() => document.activeElement')
  if el
    Node.new(@driver, @internal_logger, @playwright_page, el)
  else
    nil
  end
end

#clear_browser_contexts ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/capybara/playwright/browser.rb', line 58

def clear_browser_contexts
  if @callback_on_save_trace
    @playwright_browser.contexts.each do |browser_context|
      filename = SecureRandom.hex(8)
      zip_path = File.join(tmpdir, "#{filename}.zip")
      browser_context.tracing.stop(path: zip_path)
      @callback_on_save_trace.call(zip_path)
    end
  end
  @playwright_browser.contexts.each(&:close)
end

#close_window(handle) ⇒ Object 



309
310
311
312
313
314
315
316
317
 
# File 'lib/capybara/playwright/browser.rb', line 309

def close_window(handle)
  on_window(handle) do |page|
    page.close

    if @playwright_page&.guid == handle
      @playwright_page = nil
    end
  end
end

#current_url ⇒ Object 



70
71
72
73
74
 
# File 'lib/capybara/playwright/browser.rb', line 70

def current_url
  assert_page_alive {
    @playwright_page.url
  }
end

#current_window_handle ⇒ Object 



277
278
279
 
# File 'lib/capybara/playwright/browser.rb', line 277

def current_window_handle
  @playwright_page&.guid
end

#dismiss_modal(dialog_type, **options, &block) ⇒ Object 



356
357
358
359
360
 
# File 'lib/capybara/playwright/browser.rb', line 356

def dismiss_modal(dialog_type, **options, &block)
  assert_page_alive {
    @playwright_page.capybara_dismiss_modal(dialog_type, **options, &block)
  }
end

#evaluate_async_script(script, *args) ⇒ Object 



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/capybara/playwright/browser.rb', line 174

def evaluate_async_script(script, *args)
  assert_page_alive {
    js = <<~JAVASCRIPT
    function(_arguments){
      let args = Array.prototype.slice.call(_arguments);
      return new Promise((resolve, reject) => {
        args.push(resolve);
        (function(){ #{script} }).apply(this, args);
      });
    }
    JAVASCRIPT
    result = @playwright_page.capybara_current_frame.evaluate_handle(js, arg: unwrap_node(args))
    wrap_node(result)
  }
end

#evaluate_script(script, *args) ⇒ Object 



167
168
169
170
171
172
 
# File 'lib/capybara/playwright/browser.rb', line 167

def evaluate_script(script, *args)
  assert_page_alive {
    result = @playwright_page.capybara_current_frame.evaluate_handle("function (arguments) { return #{script} }", arg: unwrap_node(args))
    wrap_node(result)
  }
end

#execute_script(script, *args) ⇒ Object 



160
161
162
163
164
165
 
# File 'lib/capybara/playwright/browser.rb', line 160

def execute_script(script, *args)
  assert_page_alive {
    @playwright_page.capybara_current_frame.evaluate("function (arguments) { #{script} }", arg: unwrap_node(args))
  }
  nil
end

#find_css(query, **options) ⇒ Object 



106
107
108
109
110
111
112
 
# File 'lib/capybara/playwright/browser.rb', line 106

def find_css(query, **options)
  assert_page_alive {
    @playwright_page.capybara_current_frame.query_selector_all(query).map do |el|
      Node.new(@driver, @internal_logger, @playwright_page, el)
    end
  }
end

#find_xpath(query, **options) ⇒ Object 



98
99
100
101
102
103
104
 
# File 'lib/capybara/playwright/browser.rb', line 98

def find_xpath(query, **options)
  assert_page_alive {
    @playwright_page.capybara_current_frame.query_selector_all("xpath=#{query}").map do |el|
      Node.new(@driver, @internal_logger, @playwright_page, el)
    end
  }
end

#fullscreen_window(handle) ⇒ Object 



341
342
343
344
345
346
347
348
 
# File 'lib/capybara/playwright/browser.rb', line 341

def fullscreen_window(handle)
  @internal_logger.warn("fullscreen_window is not supported in Playwright driver")
  # incomplete in Playwright
  # ref: https://github.com/twalpole/apparition/blob/11aca464b38b77585191b7e302be2e062bdd369d/lib/capybara/apparition/page.rb#L341
  on_window(handle) do |page|
    page.evaluate('() => document.body.requestFullscreen()')
  end
end

#go_back ⇒ Object 



146
147
148
149
150
151
 
# File 'lib/capybara/playwright/browser.rb', line 146

def go_back
  assert_page_alive {
    response = @playwright_page.go_back
    @playwright_page.capybara_set_last_response(response)
  }
end

#go_forward ⇒ Object 



153
154
155
156
157
158
 
# File 'lib/capybara/playwright/browser.rb', line 153

def go_forward
  assert_page_alive {
    response = @playwright_page.go_forward
    @playwright_page.capybara_set_last_response(response)
  }
end

#html ⇒ Object 



126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/capybara/playwright/browser.rb', line 126

def html
  assert_page_alive {
    js = <<~JAVASCRIPT
    () => {
      let html = '';
      if (document.doctype) html += new XMLSerializer().serializeToString(document.doctype);
      if (document.documentElement) html += document.documentElement.outerHTML;
      return html;
    }
    JAVASCRIPT
    @playwright_page.capybara_current_frame.evaluate(js)
  }
end

#maximize_window(handle) ⇒ Object 



331
332
333
334
335
336
337
338
339
 
# File 'lib/capybara/playwright/browser.rb', line 331

def maximize_window(handle)
  @internal_logger.warn("maximize_window is not supported in Playwright driver")
  # incomplete in Playwright
  # ref: https://github.com/twalpole/apparition/blob/11aca464b38b77585191b7e302be2e062bdd369d/lib/capybara/apparition/page.rb#L346
  on_window(handle) do |page|
    screen_size = page.evaluate('() => ({ width: window.screen.width, height: window.screen.height})')
    page.viewport_size = screen_size
  end
end

#open_new_window(kind = :tab) ⇒ Object 



281
282
283
284
285
286
287
288
289
290
 
# File 'lib/capybara/playwright/browser.rb', line 281

def open_new_window(kind = :tab)
  browser_context =
    if kind == :tab
      @playwright_page&.context || create_browser_context
    else
      create_browser_context
    end

  create_page(browser_context)
end

#raw_screenshot(**options) ⇒ Object

Not used by Capybara::Session. Intended to be directly called by user.



209
210
211
212
213
 
# File 'lib/capybara/playwright/browser.rb', line 209

def raw_screenshot(**options)
  return nil if !@playwright_page || @playwright_page.closed?

  @playwright_page.screenshot(**options)
end

#refresh ⇒ Object 



92
93
94
95
96
 
# File 'lib/capybara/playwright/browser.rb', line 92

def refresh
  assert_page_alive {
    @playwright_page.capybara_current_frame.evaluate('() => { location.reload(true) }')
  }
end

#resize_window_to(handle, width, height) ⇒ Object 



325
326
327
328
329
 
# File 'lib/capybara/playwright/browser.rb', line 325

def resize_window_to(handle, width, height)
  on_window(handle) do |page|
    page.viewport_size = { width: width, height: height }
  end
end

#response_headers ⇒ Object 



114
115
116
117
118
 
# File 'lib/capybara/playwright/browser.rb', line 114

def response_headers
  assert_page_alive {
    @playwright_page.capybara_response_headers
  }
end

#save_screenshot(path, **options) ⇒ Object 



215
216
217
218
219
 
# File 'lib/capybara/playwright/browser.rb', line 215

def save_screenshot(path, **options)
  assert_page_alive {
    @playwright_page.screenshot(path: path)
  }
end

#send_keys(*args) ⇒ Object 



221
222
223
 
# File 'lib/capybara/playwright/browser.rb', line 221

def send_keys(*args)
  Node::SendKeys.new(@playwright_page.keyboard, args).execute
end

#status_code ⇒ Object 



120
121
122
123
124
 
# File 'lib/capybara/playwright/browser.rb', line 120

def status_code
  assert_page_alive {
    @playwright_page.capybara_status_code
  }
end

#switch_to_frame(frame) ⇒ Object 



225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/capybara/playwright/browser.rb', line 225

def switch_to_frame(frame)
  assert_page_alive {
    case frame
    when :top
      @playwright_page.capybara_reset_frames
    when :parent
      @playwright_page.capybara_pop_frame
    else
      playwright_frame = frame.native.content_frame
      raise ArgumentError.new("Not a frame element: #{frame}") unless playwright_frame
      @playwright_page.capybara_push_frame(playwright_frame)
    end
  }
end

#switch_to_window(handle) ⇒ Object 



301
302
303
304
305
306
307
 
# File 'lib/capybara/playwright/browser.rb', line 301

def switch_to_window(handle)
  if @playwright_page&.guid != handle
    on_window(handle) do |page|
      @playwright_page = page.tap(&:bring_to_front)
    end
  end
end

#title ⇒ Object 



140
141
142
143
144
 
# File 'lib/capybara/playwright/browser.rb', line 140

def title
  assert_page_alive {
    @playwright_page.title
  }
end

#video_path ⇒ Object

Not used by Capybara::Session. Intended to be directly called by user.



201
202
203
204
205
 
# File 'lib/capybara/playwright/browser.rb', line 201

def video_path
  return nil if !@playwright_page || @playwright_page.closed?

  @playwright_page.video&.path
end

#visit(path) ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/capybara/playwright/browser.rb', line 76

def visit(path)
  assert_page_alive {
    url =
    if Capybara.app_host
      Addressable::URI.parse(Capybara.app_host) + path
    elsif Capybara.default_host
      Addressable::URI.parse(Capybara.default_host) + path
    else
      path
    end

    response = @playwright_page.capybara_current_frame.goto(url)
    @playwright_page.capybara_set_last_response(response)
  }
end

#window_handles ⇒ Object 



273
274
275
 
# File 'lib/capybara/playwright/browser.rb', line 273

def window_handles
  pages.map(&:guid)
end

#window_size(handle) ⇒ Object 



319
320
321
322
323
 
# File 'lib/capybara/playwright/browser.rb', line 319

def window_size(handle)
  on_window(handle) do |page|
    page.evaluate('() => [window.innerWidth, window.innerHeight]')
  end
end

#with_playwright_page(&block) ⇒ Object 



408
409
410
411
412
 
# File 'lib/capybara/playwright/browser.rb', line 408

def with_playwright_page(&block)
  assert_page_alive {
    block.call(@playwright_page)
  }
end