playwright-ruby-client 0.7.0 → 0.9.0

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

@@ -202,4 +202,4 @@ end
 
 * Playwright doesn't allow clicking invisible DOM elements or moving elements. `click` sometimes doesn't work as Selenium does. See the detail in https://playwright.dev/docs/actionability/
 * `current_window.maximize` and `current_window.fullscreen` work only on headful (non-headless) mode, as selenium driver does.
-* `Capybara::Node::Element#drag_to` does not accept `html5` parameter.
+* `Capybara::Node::Element#drag_to` does not accept `html5` parameter. HTML5 drag and drop is not fully supported in Playwright.

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

@@ -1,3 +1,7 @@
+---
+sidebar_position: 5
+---
+
 # Semi-automation
 
 Playwright Browser context is isolated and not persisted by default. But we can also use persistent browser context using [BrowserType#launch_persistent_context](/docs/api/browser_type#launch_persistent_context).
@@ -10,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

@@ -26,6 +26,8 @@
 * json
 * ok
 * request
+* security_details
+* server_addr
 * status
 * status_text
 * text
@@ -91,6 +93,7 @@
 * hover
 * inner_html
 * inner_text
+* input_value
 * checked?
 * disabled?
 * editable?
@@ -134,6 +137,7 @@
 * content
 * dblclick
 * dispatch_event
+* drag_and_drop
 * eval_on_selector
 * eval_on_selector_all
 * evaluate
@@ -146,6 +150,7 @@
 * hover
 * inner_html
 * inner_text
+* input_value
 * checked?
 * detached?
 * disabled?
@@ -153,6 +158,7 @@
 * enabled?
 * hidden?
 * visible?
+* locator
 * name
 * page
 * parent_frame
@@ -200,6 +206,17 @@
 * message
 * type
 
+## Download
+
+* cancel
+* delete
+* failure
+* page
+* path
+* save_as
+* suggested_filename
+* url
+
 ## Page
 
 * add_init_script
@@ -213,6 +230,7 @@
 * context
 * dblclick
 * dispatch_event
+* drag_and_drop
 * emulate_media
 * eval_on_selector
 * eval_on_selector_all
@@ -231,6 +249,7 @@
 * hover
 * inner_html
 * inner_text
+* input_value
 * checked?
 * closed?
 * disabled?
@@ -238,9 +257,10 @@
 * enabled?
 * hidden?
 * visible?
+* locator
 * main_frame
 * opener
-* ~~pause~~
+* pause
 * pdf
 * press
 * query_selector
@@ -273,7 +293,7 @@
 * expect_navigation
 * expect_popup
 * expect_request
-* ~~expect_request_finished~~
+* expect_request_finished
 * expect_response
 * wait_for_selector
 * ~~wait_for_timeout~~
@@ -300,7 +320,7 @@
 * expose_binding
 * expose_function
 * grant_permissions
-* ~~new_cdp_session~~
+* new_cdp_session
 * new_page
 * pages
 * route
@@ -317,17 +337,17 @@
 * ~~wait_for_event~~
 * tracing
 
-## ~~CDPSession~~
+## CDPSession
 
-* ~~detach~~
-* ~~send_message~~
+* detach
+* send_message
 
 ## Browser
 
 * close
 * contexts
 * connected?
-* ~~new_browser_cdp_session~~
+* new_browser_cdp_session
 * new_context
 * new_page
 * start_tracing
@@ -357,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'
@@ -59,7 +58,8 @@ module Playwright
   # and we *must* call execution.stop on the end.
   # The instance of playwright is available by calling execution.playwright
   module_function def create(playwright_cli_executable_path:, &block)
-    connection = Connection.new(playwright_cli_executable_path: playwright_cli_executable_path)
+    transport = Transport.new(playwright_cli_executable_path: playwright_cli_executable_path)
+    connection = Connection.new(transport)
     connection.async_run
 
     execution =
@@ -82,7 +82,39 @@ module Playwright
     end
   end
 
-  module_function def instance
-    @playwright_instance
+  # Connects to Playwright server, launched by `npx playwright run-server` via WebSocket transport.
+  #
+  # Playwright.connect_to_playwright_server(...) do |playwright|
+  #   browser = playwright.chromium.launch
+  #   ...
+  # end
+  #
+  # @experimental
+  module_function def connect_to_playwright_server(ws_endpoint, &block)
+    require 'playwright/web_socket_client'
+    require 'playwright/web_socket_transport'
+
+    transport = WebSocketTransport.new(ws_endpoint: ws_endpoint)
+    connection = Connection.new(transport)
+    connection.async_run
+
+    execution =
+      begin
+        playwright = connection.wait_for_object_with_known_name('Playwright')
+        Execution.new(connection, PlaywrightApi.wrap(playwright))
+      rescue
+        connection.stop
+        raise
+      end
+
+    if block
+      begin
+        block.call(execution.playwright)
+      ensure
+        execution.stop
+      end
+    else
+      execution
+    end
   end
 end

data/lib/playwright/channel_owners/artifact.rb

@@ -26,5 +26,9 @@ module Playwright
     def delete
       @channel.send_message_to_server('delete')
     end
+
+    def cancel
+      @channel.send_message_to_server('cancel')
+    end
   end
 end

data/lib/playwright/channel_owners/browser.rb

@@ -67,6 +67,11 @@ module Playwright
       @initializer['version']
     end
 
+    def new_browser_cdp_session
+      resp = @channel.send_message_to_server('newBrowserCDPSession')
+      ChannelOwners::CDPSession.from(resp)
+    end
+
     def start_tracing(page: nil, categories: nil, path: nil, screenshots: nil)
       params = {
         page: page&.channel,

data/lib/playwright/channel_owners/browser_context.rb

@@ -8,7 +8,7 @@ module Playwright
 
     private def after_initialize
       @pages = Set.new
-      @routes = Set.new
+      @routes = []
       @bindings = {}
       @timeout_settings = TimeoutSettings.new
 
@@ -98,6 +98,11 @@ module Playwright
       page&.emit(Events::Page::Response, response)
     end
 
+    def new_cdp_session(page)
+      resp = @channel.send_message_to_server('newCDPSession', page: page.channel)
+      ChannelOwners::CDPSession.from(resp)
+    end
+
     def set_default_navigation_timeout(timeout)
       @timeout_settings.default_navigation_timeout = timeout
       @channel.send_message_to_server('setDefaultNavigationTimeoutNoReply', timeout: timeout)
@@ -205,8 +210,8 @@ module Playwright
     end
 
     def route(url, handler)
-      entry = RouteHandlerEntry.new(url, handler)
-      @routes << entry
+      entry = RouteHandlerEntry.new(url, base_url, handler)
+      @routes.unshift(entry)
       if @routes.count >= 1
         @channel.send_message_to_server('setNetworkInterceptionEnabled', enabled: true)
       end
@@ -245,7 +250,32 @@ 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
 
@@ -270,5 +300,9 @@ module Playwright
     private def has_record_video_option?
       @options.key?(:recordVideo)
     end
+
+    private def base_url
+      @options[:baseURL]
+    end
   end
 end

data/lib/playwright/channel_owners/cdp_session.rb

@@ -0,0 +1,19 @@
+module Playwright
+  define_channel_owner :CDPSession do
+    private def after_initialize
+      @channel.on('event', method(:on_event))
+    end
+
+    private def on_event(params)
+      emit(params['method'], params['params'])
+    end
+
+    def send_message(method, params: {})
+      @channel.send_message_to_server('send', method: method, params: params)
+    end
+
+    def detach
+      @channel.send_message_to_server('detach')
+    end
+  end
+end

data/lib/playwright/channel_owners/element_handle.rb

@@ -146,6 +146,7 @@ module Playwright
             index: nil,
             value: nil,
             label: nil,
+            force: nil,
             noWaitAfter: nil,
             timeout: nil)
         base_params = SelectOptionValues.new(
@@ -154,7 +155,7 @@ module Playwright
           value: value,
           label: label,
         ).as_params
-        params = base_params.merge({ noWaitAfter: noWaitAfter, timeout: timeout }.compact)
+        params = base_params.merge({ force: force, noWaitAfter: noWaitAfter, timeout: timeout }.compact)
         @channel.send_message_to_server('selectOption', params)
       end
 
@@ -179,9 +180,10 @@ module Playwright
         nil
       end
 
-      def fill(value, noWaitAfter: nil, timeout: nil)
+      def fill(value, force: nil, noWaitAfter: nil, timeout: nil)
         params = {
           value: value,
+          force: force,
           noWaitAfter: noWaitAfter,
           timeout: timeout,
         }.compact
@@ -190,13 +192,18 @@ module Playwright
         nil
       end
 
-      def select_text(timeout: nil)
-        params = { timeout: timeout }.compact
+      def select_text(force: nil, timeout: nil)
+        params = { force: force, timeout: timeout }.compact
         @channel.send_message_to_server('selectText', params)
 
         nil
       end
 
+      def input_value(timeout: nil)
+        params = { timeout: timeout }.compact
+        @channel.send_message_to_server('inputValue', params)
+      end
+
       def set_input_files(files, noWaitAfter: nil, timeout: nil)
         file_payloads = InputFiles.new(files).as_params
         params = { files: file_payloads, noWaitAfter: noWaitAfter, timeout: timeout }.compact

data/lib/playwright/channel_owners/frame.rb

@@ -71,7 +71,7 @@ module Playwright
 
       predicate =
         if url
-          matcher = UrlMatcher.new(url)
+          matcher = UrlMatcher.new(url, base_url: @page.context.send(:base_url))
           ->(event) { event['error'] || matcher.match?(event['url']) }
         else
           ->(_) { true }
@@ -99,7 +99,7 @@ module Playwright
     end
 
     def wait_for_url(url, timeout: nil, waitUntil: nil)
-      matcher = UrlMatcher.new(url)
+      matcher = UrlMatcher.new(url, base_url: @page.context.send(:base_url))
       if matcher.match?(@url)
         wait_for_load_state(state: waitUntil, timeout: timeout)
       else
@@ -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
@@ -293,6 +304,28 @@ module Playwright
       nil
     end
 
+    def drag_and_drop(
+          source,
+          target,
+          force: nil,
+          noWaitAfter: nil,
+          strict: nil,
+          timeout: nil,
+          trial: nil)
+      params = {
+        source: source,
+        target: target,
+        force: force,
+        noWaitAfter: noWaitAfter,
+        strict: strict,
+        timeout: timeout,
+        trial: trial,
+      }.compact
+      @channel.send_message_to_server('dragAndDrop', params)
+
+      nil
+    end
+
     def dblclick(
           selector,
           button: nil,
@@ -301,6 +334,7 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
+          strict: nil,
           timeout: nil,
           trial: nil)
 
@@ -312,6 +346,7 @@ module Playwright
         modifiers: modifiers,
         noWaitAfter: noWaitAfter,
         position: position,
+        strict: strict,
         timeout: timeout,
         trial: trial,
       }.compact
@@ -326,6 +361,7 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
+          strict: nil,
           timeout: nil,
           trial: nil)
       params = {
@@ -334,6 +370,7 @@ module Playwright
         modifiers: modifiers,
         noWaitAfter: noWaitAfter,
         position: position,
+        strict: strict,
         timeout: timeout,
         trial: trial,
       }.compact
@@ -342,11 +379,19 @@ module Playwright
       nil
     end
 
-    def fill(selector, value, noWaitAfter: nil, timeout: nil)
+    def fill(
+          selector,
+          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)
@@ -354,31 +399,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)
@@ -389,6 +435,7 @@ module Playwright
           force: nil,
           modifiers: nil,
           position: nil,
+          strict: nil,
           timeout: nil,
           trial: nil)
       params = {
@@ -396,6 +443,7 @@ module Playwright
         force: force,
         modifiers: modifiers,
         position: position,
+        strict: strict,
         timeout: timeout,
         trial: trial,
       }.compact
@@ -410,7 +458,9 @@ module Playwright
           index: nil,
           value: nil,
           label: nil,
+          force: nil,
           noWaitAfter: nil,
+          strict: nil,
           timeout: nil)
       base_params = SelectOptionValues.new(
         element: element,
@@ -418,13 +468,24 @@ module Playwright
         value: value,
         label: label,
       ).as_params
-      params = base_params.merge({ selector: selector, 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 set_input_files(selector, files, noWaitAfter: nil, timeout: nil)
+    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, 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
@@ -435,6 +496,7 @@ module Playwright
           text,
           delay: nil,
           noWaitAfter: nil,
+          strict: nil,
           timeout: nil)
 
       params = {
@@ -442,6 +504,7 @@ module Playwright
         text: text,
         delay: delay,
         noWaitAfter: noWaitAfter,
+        strict: strict,
         timeout: timeout,
       }.compact
       @channel.send_message_to_server('type', params)
@@ -454,6 +517,7 @@ module Playwright
           key,
           delay: nil,
           noWaitAfter: nil,
+          strict: nil,
           timeout: nil)
 
       params = {
@@ -461,6 +525,7 @@ module Playwright
         key: key,
         delay: delay,
         noWaitAfter: noWaitAfter,
+        strict: strict,
         timeout: timeout,
       }.compact
       @channel.send_message_to_server('press', params)
@@ -473,6 +538,7 @@ module Playwright
       force: nil,
       noWaitAfter: nil,
       position: nil,
+      strict: nil,
       timeout: nil,
       trial: nil)
 
@@ -481,6 +547,7 @@ module Playwright
         force: force,
         noWaitAfter:  noWaitAfter,
         position: position,
+        strict: strict,
         timeout: timeout,
         trial: trial,
       }.compact
@@ -494,6 +561,7 @@ module Playwright
       force: nil,
       noWaitAfter: nil,
       position: nil,
+      strict: nil,
       timeout: nil,
       trial: nil)
 
@@ -502,6 +570,7 @@ module Playwright
         force: force,
         noWaitAfter:  noWaitAfter,
         position: position,
+        strict: strict,
         timeout: timeout,
         trial: trial,
       }.compact