playwright-ruby-client 0.8.1 → 1.14.beta3

data/documentation/docs/api/worker.md

@@ -22,3 +22,40 @@ for worker in page.workers:
 ```
 
 
+
+## evaluate
+
+```
+def evaluate(expression, arg: nil)
+```
+
+Returns the return value of `expression`.
+
+If the function passed to the [Worker#evaluate](./worker#evaluate) returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise), then [Worker#evaluate](./worker#evaluate) would
+wait for the promise to resolve and return its value.
+
+If the function passed to the [Worker#evaluate](./worker#evaluate) returns a non-[Serializable](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#description) value, then
+[Worker#evaluate](./worker#evaluate) returns `undefined`. Playwright also supports transferring some additional values that are
+not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`.
+
+## evaluate_handle
+
+```
+def evaluate_handle(expression, arg: nil)
+```
+
+Returns the return value of `expression` as a [JSHandle](./js_handle).
+
+The only difference between [Worker#evaluate](./worker#evaluate) and [Worker#evaluate_handle](./worker#evaluate_handle) is that
+[Worker#evaluate_handle](./worker#evaluate_handle) returns [JSHandle](./js_handle).
+
+If the function passed to the [Worker#evaluate_handle](./worker#evaluate_handle) returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise), then
+[Worker#evaluate_handle](./worker#evaluate_handle) would wait for the promise to resolve and return its value.
+
+## url
+
+```
+def url
+```
+
+

data/documentation/docs/article/guides/inspector.md

@@ -0,0 +1,31 @@
+---
+sidebar_position: 6
+---
+
+# Playwright inspector
+
+Playwright provides an useful inspector.
+https://playwright.dev/docs/inspector/
+
+## Overview
+
+```ruby {4,8}
+playwright.chromium.launch(headless: false) do |browser|
+  browser.new_context do |context|
+    # This method call should be put just after creating BrowserContext.
+    context.enable_debug_console!
+
+    page = context.new_pagè
+    page.goto('http://example.com/')
+    page.pause
+  end
+end
+```
+
+`page.pause` requires Playwright debug session, and it can be enabled by calling `BrowserContext#enable_debug_console!` in advance.
+
+Note that since Ruby is not officially supported in Playwright, many limitations exist. We CANNOT
+
+* Launch inspector via `PWDEBUG=1`
+* Debug without inspector UI (`PWDEBUG=console` is not working well)
+* Show Ruby code in inspector

data/documentation/docs/article/guides/playwright_on_alpine_linux.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 6
+sidebar_position: 7
 ---
 
 # Playwright on Alpine Linux

data/documentation/docs/article/guides/semi_automation.md

@@ -14,7 +14,7 @@ Keep in mind repeatedly that persistent browser context is NOT RECOMMENDED for m
 
 ## Pause automation for manual operation
 
-`Page#pause` is not implemented yet, however we can use `binding.pry`  (with `pry-byebug` installed) instead.
+We can simply use `binding.pry`  (with `pry-byebug` installed).
 
 ```ruby {4}
 playwright.chromium.launch_persistent_context('./data/', headless: false) do |context|

data/documentation/docs/include/api_coverage.md

@@ -65,7 +65,7 @@
 
 ## Touchscreen
 
-* ~~tap_point~~
+* tap_point
 
 ## JSHandle
 
@@ -116,9 +116,9 @@
 * wait_for_element_state
 * wait_for_selector
 
-## ~~Accessibility~~
+## Accessibility
 
-* ~~snapshot~~
+* snapshot
 
 ## FileChooser
 
@@ -158,6 +158,7 @@
 * enabled?
 * hidden?
 * visible?
+* locator
 * name
 * page
 * parent_frame
@@ -177,14 +178,14 @@
 * wait_for_load_state
 * expect_navigation
 * wait_for_selector
-* ~~wait_for_timeout~~
+* wait_for_timeout
 * wait_for_url
 
 ## Worker
 
-* ~~evaluate~~
-* ~~evaluate_handle~~
-* ~~url~~
+* evaluate
+* evaluate_handle
+* url
 
 ## Selectors
 
@@ -205,6 +206,17 @@
 * message
 * type
 
+## Download
+
+* cancel
+* delete
+* failure
+* page
+* path
+* save_as
+* suggested_filename
+* url
+
 ## Page
 
 * add_init_script
@@ -245,9 +257,10 @@
 * enabled?
 * hidden?
 * visible?
+* locator
 * main_frame
 * opener
-* ~~pause~~
+* pause
 * pdf
 * press
 * query_selector
@@ -283,11 +296,11 @@
 * expect_request_finished
 * expect_response
 * wait_for_selector
-* ~~wait_for_timeout~~
+* wait_for_timeout
 * wait_for_url
 * expect_websocket
-* ~~expect_worker~~
-* ~~workers~~
+* expect_worker
+* workers
 * ~~wait_for_event~~
 * accessibility
 * keyboard
@@ -298,7 +311,7 @@
 
 * add_cookies
 * add_init_script
-* ~~background_pages~~
+* background_pages
 * browser
 * clear_cookies
 * clear_permissions
@@ -311,13 +324,13 @@
 * new_page
 * pages
 * route
-* ~~service_workers~~
+* service_workers
 * set_default_navigation_timeout
 * set_default_timeout
 * set_extra_http_headers
 * set_geolocation
 * set_offline
-* ~~storage_state~~
+* storage_state
 * unroute
 * expect_event
 * expect_page
@@ -364,6 +377,49 @@
 * start
 * stop
 
+## Locator
+
+* all_inner_texts
+* all_text_contents
+* bounding_box
+* check
+* click
+* count
+* dblclick
+* dispatch_event
+* element_handle
+* element_handles
+* evaluate
+* evaluate_all
+* evaluate_handle
+* fill
+* first
+* focus
+* get_attribute
+* hover
+* inner_html
+* inner_text
+* input_value
+* checked?
+* disabled?
+* editable?
+* enabled?
+* hidden?
+* visible?
+* last
+* locator
+* nth
+* press
+* screenshot
+* scroll_into_view_if_needed
+* select_option
+* select_text
+* set_input_files
+* tap_point
+* text_content
+* type
+* uncheck
+
 ## Android
 
 * devices

data/lib/playwright.rb

@@ -17,7 +17,6 @@ require 'playwright/utils'
 require 'playwright/api_implementation'
 require 'playwright/channel'
 require 'playwright/channel_owner'
-require 'playwright/download'
 require 'playwright/http_headers'
 require 'playwright/input_files'
 require 'playwright/connection'

data/lib/playwright/accessibility_impl.rb

@@ -0,0 +1,50 @@
+module Playwright
+  define_api_implementation :AccessibilityImpl do
+    def initialize(channel)
+      @channel = channel
+    end
+
+    def snapshot(interestingOnly: nil, root: nil)
+      params = {
+        interestingOnly: interestingOnly,
+        root: root&.channel,
+      }.compact
+      result = @channel.send_message_to_server('accessibilitySnapshot', params)
+      format_ax_node_from_protocol(result) if result
+      result
+    end
+
+    # original JS implementation create a new Hash from ax_node,
+    # but this implementation directly modify ax_node and don't return hash.
+    private def format_ax_node_from_protocol(ax_node)
+      value = ax_node.delete('valueNumber') || ax_node.delete('valueString')
+      ax_node['value'] = value unless value.nil?
+
+      checked =
+        case ax_node['checked']
+        when 'checked'
+          true
+        when 'unchecked'
+          false
+        else
+          ax_node['checked']
+        end
+      ax_node['checked'] = checked unless checked.nil?
+
+      pressed =
+        case ax_node['pressed']
+        when 'pressed'
+          true
+        when 'released'
+          false
+        else
+          ax_node['pressed']
+        end
+      ax_node['pressed'] = pressed unless pressed.nil?
+
+      ax_node['children']&.each do |child|
+        format_ax_node_from_protocol(child)
+      end
+    end
+  end
+end

data/lib/playwright/channel_owners/browser_context.rb

@@ -11,6 +11,8 @@ module Playwright
       @routes = []
       @bindings = {}
       @timeout_settings = TimeoutSettings.new
+      @service_workers = Set.new
+      @background_pages = Set.new
 
       @tracing = TracingImpl.new(@channel, self)
       @channel.on('bindingCall', ->(params) { on_binding(ChannelOwners::BindingCall.from(params['binding'])) })
@@ -19,6 +21,12 @@ module Playwright
       @channel.on('route', ->(params) {
         on_route(ChannelOwners::Route.from(params['route']), ChannelOwners::Request.from(params['request']))
       })
+      @channel.on('backgroundPage', ->(params) {
+        on_background_page(ChannelOwners::Page.from(params['page']))
+      })
+      @channel.on('serviceWorker', ->(params) {
+        on_service_worker(ChannelOwners::Worker.from(params['worker']))
+      })
       @channel.on('request', ->(params) {
         on_request(
           ChannelOwners::Request.from(params['request']),
@@ -56,6 +64,11 @@ module Playwright
       page.send(:emit_popup_event_from_browser_context)
     end
 
+    private def on_background_page(page)
+      @background_pages << page
+      emit(Events::BrowserContext::BackgroundPage, page)
+    end
+
     private def on_route(route, request)
       # It is not desired to use PlaywrightApi.wrap directly.
       # However it is a little difficult to define wrapper for `handler` parameter in generate_api.
@@ -98,6 +111,20 @@ module Playwright
       page&.emit(Events::Page::Response, response)
     end
 
+    private def on_service_worker(worker)
+      worker.context = self
+      @service_workers << worker
+      emit(Events::BrowserContext::ServiceWorker, worker)
+    end
+
+    def background_pages
+      @background_pages.to_a
+    end
+
+    def service_workers
+      @service_workers.to_a
+    end
+
     def new_cdp_session(page)
       resp = @channel.send_message_to_server('newCDPSession', page: page.channel)
       ChannelOwners::CDPSession.from(resp)
@@ -250,10 +277,45 @@ module Playwright
       raise unless safe_close_error?(err)
     end
 
+    # REMARK: enable_debug_console is playwright-ruby-client specific method.
+    def enable_debug_console!
+      # Ruby is not supported in Playwright officially,
+      # and causes error:
+      #
+      #  Error:
+      #  ===============================
+      #  Unsupported language: 'ruby'
+      #  ===============================
+      #
+      # So, launch inspector as Python app.
+      # NOTE: This should be used only for Page#pause at this moment.
+      @channel.send_message_to_server('recorderSupplementEnable', language: :python)
+      @debug_console_enabled = true
+    end
+
+    class DebugConsoleNotEnabledError < StandardError
+      def initialize
+        super('Debug console should be enabled in advance, by calling `browser_context.enable_debug_console!`')
+      end
+    end
+
     def pause
+      unless @debug_console_enabled
+        raise DebugConsoleNotEnabledError.new
+      end
       @channel.send_message_to_server('pause')
     end
 
+    def storage_state(path: nil)
+      @channel.send_message_to_server_result('storageState', {}).tap do |result|
+        if path
+          File.open(path, 'w') do |f|
+            f.write(JSON.dump(result))
+          end
+        end
+      end
+    end
+
     def expect_page(predicate: nil, timeout: nil)
       params = {
         predicate: predicate,
@@ -267,6 +329,14 @@ module Playwright
       @pages.delete(page)
     end
 
+    private def remove_background_page(page)
+      @background_pages.delete(page)
+    end
+
+    private def remove_service_worker(worker)
+      @service_workers.delete(worker)
+    end
+
     # called from Page with send(:_timeout_settings), so keep private.
     private def _timeout_settings
       @timeout_settings

data/lib/playwright/channel_owners/frame.rb

@@ -139,8 +139,12 @@ module Playwright
       JavaScript::Expression.new(pageFunction, arg).evaluate_handle(@channel)
     end
 
-    def query_selector(selector)
-      resp = @channel.send_message_to_server('querySelector', selector: selector)
+    def query_selector(selector, strict: nil)
+      params = {
+        selector: selector,
+        strict: strict,
+      }.compact
+      resp = @channel.send_message_to_server('querySelector', params)
       ChannelOwners::ElementHandle.from_nullable(resp)
     end
 
@@ -150,48 +154,53 @@ module Playwright
       end
     end
 
-    def wait_for_selector(selector, state: nil, timeout: nil)
-      params = { selector: selector, state: state, timeout: timeout }.compact
+    def wait_for_selector(selector, state: nil, strict: nil, timeout: nil)
+      params = { selector: selector, state: state, strict: strict, timeout: timeout }.compact
       resp = @channel.send_message_to_server('waitForSelector', params)
 
       ChannelOwners::ElementHandle.from_nullable(resp)
     end
 
-    def checked?(selector, timeout: nil)
-      params = { selector: selector, timeout: timeout }.compact
+    def checked?(selector, strict: nil, timeout: nil)
+      params = { selector: selector, strict: strict, timeout: timeout }.compact
       @channel.send_message_to_server('isChecked', params)
     end
 
-    def disabled?(selector, timeout: nil)
-      params = { selector: selector, timeout: timeout }.compact
+    def disabled?(selector, strict: nil, timeout: nil)
+      params = { selector: selector, strict: strict, timeout: timeout }.compact
       @channel.send_message_to_server('isDisabled', params)
     end
 
-    def editable?(selector, timeout: nil)
-      params = { selector: selector, timeout: timeout }.compact
+    def editable?(selector, strict: nil, timeout: nil)
+      params = { selector: selector, strict: strict, timeout: timeout }.compact
       @channel.send_message_to_server('isEditable', params)
     end
 
-    def enabled?(selector, timeout: nil)
-      params = { selector: selector, timeout: timeout }.compact
+    def enabled?(selector, strict: nil, timeout: nil)
+      params = { selector: selector, strict: strict, timeout: timeout }.compact
       @channel.send_message_to_server('isEnabled', params)
     end
 
-    def hidden?(selector, timeout: nil)
-      params = { selector: selector, timeout: timeout }.compact
+    def hidden?(selector, strict: nil, timeout: nil)
+      params = { selector: selector, strict: strict, timeout: timeout }.compact
       @channel.send_message_to_server('isHidden', params)
     end
 
-    def visible?(selector, timeout: nil)
-      params = { selector: selector, timeout: timeout }.compact
+    def visible?(selector, strict: nil, timeout: nil)
+      params = { selector: selector, strict: strict, timeout: timeout }.compact
       @channel.send_message_to_server('isVisible', params)
     end
 
-    def dispatch_event(selector, type, eventInit: nil, timeout: nil)
+    def locator(selector)
+      LocatorImpl.new(frame: self, timeout_settings: @page.send(:timeout_settings), selector: selector)
+    end
+
+    def dispatch_event(selector, type, eventInit: nil, strict: nil, timeout: nil)
       params = {
         selector: selector,
         type: type,
         eventInit: JavaScript::ValueSerializer.new(eventInit).serialize,
+        strict: strict,
         timeout: timeout,
       }.compact
       @channel.send_message_to_server('dispatchEvent', params)
@@ -199,8 +208,8 @@ module Playwright
       nil
     end
 
-    def eval_on_selector(selector, pageFunction, arg: nil)
-      JavaScript::Expression.new(pageFunction, arg).eval_on_selector(@channel, selector)
+    def eval_on_selector(selector, pageFunction, arg: nil, strict: nil)
+      JavaScript::Expression.new(pageFunction, arg).eval_on_selector(@channel, selector, strict: strict)
     end
 
     def eval_on_selector_all(selector, pageFunction, arg: nil)
@@ -273,6 +282,7 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
+          strict: nil,
           timeout: nil,
           trial: nil)
 
@@ -285,6 +295,7 @@ module Playwright
         modifiers: modifiers,
         noWaitAfter: noWaitAfter,
         position: position,
+        strict: strict,
         timeout: timeout,
         trial: trial,
       }.compact
@@ -298,13 +309,20 @@ module Playwright
           target,
           force: nil,
           noWaitAfter: nil,
+          sourcePosition: nil,
+          strict: nil,
+          targetPosition: nil,
           timeout: nil,
           trial: nil)
+
       params = {
         source: source,
         target: target,
         force: force,
         noWaitAfter: noWaitAfter,
+        sourcePosition: sourcePosition,
+        strict: strict,
+        targetPosition: targetPosition,
         timeout: timeout,
         trial: trial,
       }.compact
@@ -321,6 +339,7 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
+          strict: nil,
           timeout: nil,
           trial: nil)
 
@@ -332,6 +351,7 @@ module Playwright
         modifiers: modifiers,
         noWaitAfter: noWaitAfter,
         position: position,
+        strict: strict,
         timeout: timeout,
         trial: trial,
       }.compact
@@ -346,6 +366,7 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
+          strict: nil,
           timeout: nil,
           trial: nil)
       params = {
@@ -354,6 +375,7 @@ module Playwright
         modifiers: modifiers,
         noWaitAfter: noWaitAfter,
         position: position,
+        strict: strict,
         timeout: timeout,
         trial: trial,
       }.compact
@@ -367,12 +389,14 @@ module Playwright
           value,
           force: nil,
           noWaitAfter: nil,
+          strict: nil,
           timeout: nil)
       params = {
         selector: selector,
         value: value,
         force: force,
         noWaitAfter: noWaitAfter,
+        strict: strict,
         timeout: timeout,
       }.compact
       @channel.send_message_to_server('fill', params)
@@ -380,31 +404,32 @@ module Playwright
       nil
     end
 
-    def focus(selector, timeout: nil)
-      params = { selector: selector, timeout: timeout }.compact
+    def focus(selector, strict: nil, timeout: nil)
+      params = { selector: selector, strict: strict, timeout: timeout }.compact
       @channel.send_message_to_server('focus', params)
       nil
     end
 
-    def text_content(selector, timeout: nil)
-      params = { selector: selector, timeout: timeout }.compact
+    def text_content(selector, strict: nil, timeout: nil)
+      params = { selector: selector, strict: strict, timeout: timeout }.compact
       @channel.send_message_to_server('textContent', params)
     end
 
-    def inner_text(selector, timeout: nil)
-      params = { selector: selector, timeout: timeout }.compact
+    def inner_text(selector, strict: nil, timeout: nil)
+      params = { selector: selector, strict: strict, timeout: timeout }.compact
       @channel.send_message_to_server('innerText', params)
     end
 
-    def inner_html(selector, timeout: nil)
-      params = { selector: selector, timeout: timeout }.compact
+    def inner_html(selector, strict: nil, timeout: nil)
+      params = { selector: selector, strict: strict, timeout: timeout }.compact
       @channel.send_message_to_server('innerHTML', params)
     end
 
-    def get_attribute(selector, name, timeout: nil)
+    def get_attribute(selector, name, strict: nil, timeout: nil)
       params = {
         selector: selector,
         name: name,
+        strict: strict,
         timeout: timeout,
       }.compact
       @channel.send_message_to_server('getAttribute', params)
@@ -415,6 +440,7 @@ module Playwright
           force: nil,
           modifiers: nil,
           position: nil,
+          strict: nil,
           timeout: nil,
           trial: nil)
       params = {
@@ -422,6 +448,7 @@ module Playwright
         force: force,
         modifiers: modifiers,
         position: position,
+        strict: strict,
         timeout: timeout,
         trial: trial,
       }.compact
@@ -438,6 +465,7 @@ module Playwright
           label: nil,
           force: nil,
           noWaitAfter: nil,
+          strict: nil,
           timeout: nil)
       base_params = SelectOptionValues.new(
         element: element,
@@ -445,18 +473,24 @@ module Playwright
         value: value,
         label: label,
       ).as_params
-      params = base_params.merge({ selector: selector, force: force, noWaitAfter: noWaitAfter, timeout: timeout }.compact)
+      params = base_params.merge({ selector: selector, force: force, noWaitAfter: noWaitAfter, strict: strict, timeout: timeout }.compact)
       @channel.send_message_to_server('selectOption', params)
     end
 
-    def input_value(selector, timeout: nil)
-      params = { selector: selector, timeout: timeout }.compact
+    def input_value(selector, strict: nil, timeout: nil)
+      params = { selector: selector, strict: strict, timeout: timeout }.compact
       @channel.send_message_to_server('inputValue', params)
     end
 
-    def set_input_files(selector, files, noWaitAfter: nil, timeout: nil)
+    def set_input_files(selector, files, noWaitAfter: nil, strict: nil, timeout: nil)
       file_payloads = InputFiles.new(files).as_params
-      params = { files: file_payloads, selector: selector, noWaitAfter: noWaitAfter, timeout: timeout }.compact
+      params = {
+        files: file_payloads,
+        selector: selector,
+        noWaitAfter: noWaitAfter,
+        strict: strict,
+        timeout: timeout,
+      }.compact
       @channel.send_message_to_server('setInputFiles', params)
 
       nil
@@ -467,6 +501,7 @@ module Playwright
           text,
           delay: nil,
           noWaitAfter: nil,
+          strict: nil,
           timeout: nil)
 
       params = {
@@ -474,6 +509,7 @@ module Playwright
         text: text,
         delay: delay,
         noWaitAfter: noWaitAfter,
+        strict: strict,
         timeout: timeout,
       }.compact
       @channel.send_message_to_server('type', params)
@@ -486,6 +522,7 @@ module Playwright
           key,
           delay: nil,
           noWaitAfter: nil,
+          strict: nil,
           timeout: nil)
 
       params = {
@@ -493,6 +530,7 @@ module Playwright
         key: key,
         delay: delay,
         noWaitAfter: noWaitAfter,
+        strict: strict,
         timeout: timeout,
       }.compact
       @channel.send_message_to_server('press', params)
@@ -505,6 +543,7 @@ module Playwright
       force: nil,
       noWaitAfter: nil,
       position: nil,
+      strict: nil,
       timeout: nil,
       trial: nil)
 
@@ -513,6 +552,7 @@ module Playwright
         force: force,
         noWaitAfter:  noWaitAfter,
         position: position,
+        strict: strict,
         timeout: timeout,
         trial: trial,
       }.compact
@@ -526,6 +566,7 @@ module Playwright
       force: nil,
       noWaitAfter: nil,
       position: nil,
+      strict: nil,
       timeout: nil,
       trial: nil)
 
@@ -534,6 +575,7 @@ module Playwright
         force: force,
         noWaitAfter:  noWaitAfter,
         position: position,
+        strict: strict,
         timeout: timeout,
         trial: trial,
       }.compact
@@ -542,6 +584,10 @@ module Playwright
       nil
     end
 
+    def wait_for_timeout(timeout)
+      sleep(timeout / 1000.0)
+    end
+
     def wait_for_function(pageFunction, arg: nil, polling: nil, timeout: nil)
       if polling.is_a?(String) && polling != 'raf'
         raise ArgumentError.new("Unknown polling option: #{polling}")