playwright-ruby-client 0.3.0 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbaaa0e61bbc515a26d0f0e6af6ca8c36bbf3db5cc6913a6895f175154ba893b
-  data.tar.gz: cdc467f161030497d4efb94689bef4901c0e15bd24e9cc8be189106f5dfe4493
+  metadata.gz: 00cad3443e3aa3e8f527ceda91858789a4ab9ed2853a99f48c24abae1e0e1a0e
+  data.tar.gz: f326aa14284545710e95eb53986053325fbf37b5ddc3a82edc9fecf1454afccf
 SHA512:
-  metadata.gz: 585d3989547fd8e38e1e9503bf8aee20e732b1234bd62783c51b2e77a6061325c9a0c44de0de2b65557726dbebd6dc944ab44f72ffb8cbba69449ff3c0886a59
-  data.tar.gz: e50bd506a34d5fe1d84d6f75d0fbe8bc1128c0f93c3529dc94ba6af7dabf59e564625e6ca0b5a16cf7ad8066ffe91aeeda369599a30c0bb9e5629f54dfe54fd1
+  metadata.gz: 81d0d106ae9bdc7dd12e001dd82aec2e5cfe507cb04330df67e480127f8cd07f92f92dcca078900069ba134bcd34c9643ec17c1629ee288037d85e062cda741f
+  data.tar.gz: 6ff3bf21ddcf009eb5eda9365ad324796692993166ead922d71a145b0c861161c6062f0ddb3fe0f6471eb5c5c6de6bbb52399ad5fa128ebd070c7fc322a624c2

data/README.md

@@ -9,22 +9,34 @@ Note: Currently, this Gem is just a PoC (Proof of Concept). If you want to devel
 At this point, playwright-ruby-client doesn't include the downloader of playwright driver, so **we have to install [playwright](https://github.com/microsoft/playwright) in advance**.
 
 ```sh
+npx playwright install
+```
+
+and then, set `playwright_cli_executable_path: "npx playwright"` at `Playwright.create`.
+
+**Prefer npm install instead of npx?**
+
+Actually `npx playwright` is a bit slow. We can also use `npm install` to setup.
+
+Instead of `npx playwright install`:
+
+```
 npm install playwright
 ./node_modules/.bin/playwright install
 ```
 
-and then, set `playwright_cli_executable_path: ./node_modules/.bin/playwright` at `Playwright.create`.
+And set `playwright_cli_executable_path: './node_modules/.bin/playwright'`
 
 **Prefer playwrighting without Node.js?**
 
-Instead of npm install, you can also directly download playwright driver from playwright.azureedge.net/builds/. The URL can be easily detected from [here](https://github.com/microsoft/playwright-python/blob/79f6ce0a6a69c480573372706df84af5ef99c4a4/setup.py#L56-L61)
+Instead of npm, you can also directly download playwright driver from playwright.azureedge.net/builds/. The URL can be easily detected from [here](https://github.com/microsoft/playwright-python/blob/79f6ce0a6a69c480573372706df84af5ef99c4a4/setup.py#L56-L61)
 
 ### Capture a site
 
 ```ruby
 require 'playwright'
 
-Playwright.create(playwright_cli_executable_path: '/path/to/playwright') do |playwright|
+Playwright.create(playwright_cli_executable_path: 'npx playwright') do |playwright|
   playwright.chromium.launch(headless: false) do |browser|
     page = browser.new_page
     page.goto('https://github.com/YusukeIwaki')
@@ -40,7 +52,7 @@ end
 ```ruby
 require 'playwright'
 
-Playwright.create(playwright_cli_executable_path: './node_modules/.bin/playwright') do |playwright|
+Playwright.create(playwright_cli_executable_path: 'npx playwright') do |playwright|
   playwright.chromium.launch(headless: false) do |browser|
     page = browser.new_page
     page.goto('https://github.com/')
@@ -82,7 +94,7 @@ $ bundle exec ruby main.rb
 ```ruby
 require 'playwright'
 
-Playwright.create(playwright_cli_executable_path: './node_modules/.bin/playwright') do |playwright|
+Playwright.create(playwright_cli_executable_path: 'npx playwright') do |playwright|
   devices = playwright.android.devices
   unless devices.empty?
     device = devices.last

data/docs/api_coverage.md

@@ -55,11 +55,11 @@
 
 ## Mouse
 
-* ~~click~~
-* ~~dblclick~~
-* ~~down~~
-* ~~move~~
-* ~~up~~
+* click
+* dblclick
+* down
+* move
+* up
 
 ## Touchscreen
 
@@ -173,6 +173,7 @@
 * expect_navigation
 * wait_for_selector
 * ~~wait_for_timeout~~
+* wait_for_url
 
 ## ~~Worker~~
 
@@ -199,19 +200,6 @@
 * message
 * type
 
-## Download
-
-* delete
-* failure
-* path
-* save_as
-* suggested_filename
-* url
-
-## ~~Video~~
-
-* ~~path~~
-
 ## Page
 
 * add_init_script
@@ -274,7 +262,7 @@
 * uncheck
 * unroute
 * url
-* ~~video~~
+* video
 * viewport_size
 * expect_console_message
 * expect_download
@@ -288,6 +276,7 @@
 * expect_response
 * wait_for_selector
 * ~~wait_for_timeout~~
+* wait_for_url
 * ~~expect_worker~~
 * ~~workers~~
 * ~~wait_for_event~~
@@ -300,6 +289,7 @@
 
 * add_cookies
 * add_init_script
+* ~~background_pages~~
 * browser
 * clear_cookies
 * clear_permissions
@@ -308,9 +298,11 @@
 * expose_binding
 * expose_function
 * grant_permissions
+* ~~new_cdp_session~~
 * new_page
 * pages
 * route
+* ~~service_workers~~
 * set_default_navigation_timeout
 * set_default_timeout
 * set_extra_http_headers
@@ -327,19 +319,16 @@
 * ~~detach~~
 * ~~send_message~~
 
-## ChromiumBrowserContext
-
-* ~~background_pages~~
-* ~~new_cdp_session~~
-* ~~service_workers~~
-
 ## Browser
 
 * close
 * contexts
 * connected?
+* ~~new_browser_cdp_session~~
 * new_context
 * new_page
+* start_tracing
+* stop_tracing
 * version
 
 ## BrowserType

data/lib/playwright.rb

@@ -17,6 +17,7 @@ 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'
@@ -26,6 +27,7 @@ require 'playwright/timeout_settings'
 require 'playwright/transport'
 require 'playwright/url_matcher'
 require 'playwright/version'
+require 'playwright/video'
 require 'playwright/wait_helper'
 
 require 'playwright/playwright_api'
@@ -33,18 +35,54 @@ require 'playwright/playwright_api'
 Dir[File.join(__dir__, 'playwright_api', '*.rb')].each { |f| require f }
 
 module Playwright
-  module_function def create(playwright_cli_executable_path:, &block)
-    raise ArgumentError.new("block must be provided") unless block
+  class Execution
+    def initialize(connection, playwright)
+      @connection = connection
+      @playwright = playwright
+    end
+
+    def stop
+      @connection.stop
+    end
+
+    attr_reader :playwright
+  end
 
+  # Recommended to call this method with block.
+  #
+  # Playwright.create(...) do |playwright|
+  #   browser = playwright.chromium.launch
+  #   ...
+  # end
+  #
+  # When we use this method without block, an instance of Puppeteer::Execution is returned
+  # 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)
+    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
 
-    playwright_promise = connection.async_wait_for_object_with_known_name('Playwright')
-    Thread.new { connection.run }
-    playwright = PlaywrightApi.wrap(playwright_promise.value!)
-    begin
-      block.call(playwright)
-    ensure
-      connection.stop
+    if block
+      begin
+        block.call(execution.playwright)
+      ensure
+        execution.stop
+      end
+    else
+      execution
     end
   end
+
+  module_function def instance
+    @playwright_instance
+  end
 end

data/lib/playwright/channel.rb

@@ -15,21 +15,31 @@ module Playwright
 
     # @param method [String]
     # @param params [Hash]
+    # @return [Playwright::ChannelOwner|nil]
     def send_message_to_server(method, params = {})
-      async_send_message_to_server(method, params).value!
+      result = send_message_to_server_result(method, params)
+      if result.is_a?(Hash)
+        _type, channel_owner = result.first
+        channel_owner
+      else
+        nil
+      end
     end
 
     # @param method [String]
     # @param params [Hash]
+    # @return [Hash]
+    def send_message_to_server_result(method, params)
+      @connection.send_message_to_server(@guid, method, params)
+    end
+
+    # @param method [String]
+    # @param params [Hash]
+    # @returns nil
     def async_send_message_to_server(method, params = {})
-      @connection.async_send_message_to_server(@guid, method, params).then do |result|
-        if result.is_a?(Hash)
-          _type, channel_owner = result.first
-          channel_owner
-        else
-          nil
-        end
-      end
+      @connection.async_send_message_to_server(@guid, method, params)
+
+      nil
     end
   end
 end

data/lib/playwright/channel_owners/artifact.rb

@@ -0,0 +1,30 @@
+module Playwright
+  define_channel_owner :Artifact do
+    private def after_initialize
+      @is_remote = false
+      @absolute_path = @initializer['absolutePath']
+    end
+
+    attr_reader :absolute_path
+
+    def path_after_finished
+      if @is_remote
+        raise "Path is not available when using browser_type.connect(). Use save_as() to save a local copy."
+      end
+      @channel.send_message_to_server('pathAfterFinished')
+    end
+
+    def save_as(path)
+      stream = ChannelOwners::Stream.from(@channel.send_message_to_server('saveAsStream'))
+      stream.save_as(path)
+    end
+
+    def failure
+      @channel.send_message_to_server('failure')
+    end
+
+    def delete
+      @channel.send_message_to_server('delete')
+    end
+  end
+end

data/lib/playwright/channel_owners/browser.rb

@@ -59,12 +59,33 @@ module Playwright
       @initializer['version']
     end
 
+    def start_tracing(page: nil, categories: nil, path: nil, screenshots: nil)
+      params = {
+        page: page&.channel,
+        categories: categories,
+        path: path,
+        screenshots: screenshots,
+      }.compact
+
+      @channel.send_message_to_server('startTracing', params)
+    end
+
+    def stop_tracing
+      encoded_binary = @channel.send_message_to_server("stopTracing")
+      return Base64.strict_decode64(encoded_binary)
+    end
+
     private def on_close(_ = {})
       @connected = false
       emit(Events::Browser::Disconnected)
       @closed_or_closing = false
     end
 
+    # called from BrowserType#connectOverCDP
+    private def add_context(context)
+      @contexts << context
+    end
+
     # called from BrowserContext#on_close with send(:remove_context), so keep private.
     private def remove_context(context)
       @contexts.delete(context)

data/lib/playwright/channel_owners/browser_context.rb

@@ -23,6 +23,7 @@ module Playwright
       page.send(:update_browser_context, self)
       @pages << page
       emit(Events::BrowserContext::Page, page)
+      page.send(:emit_popup_event_from_browser_context)
     end
 
     private def on_route(route, request)
@@ -206,5 +207,9 @@ module Playwright
     private def _timeout_settings
       @timeout_settings
     end
+
+    private def has_record_video_option?
+      @options.key?(:recordVideo)
+    end
   end
 end

data/lib/playwright/channel_owners/browser_type.rb

@@ -22,5 +22,33 @@ module Playwright
         browser
       end
     end
+
+    def connect_over_cdp(endpointURL, slowMo: nil, timeout: nil, &block)
+      raise 'Connecting over CDP is only supported in Chromium.' unless name == 'chromium'
+
+      params = {
+        sdkLanguage: 'ruby',
+        endpointURL: endpointURL,
+        slowMo: slowMo,
+        timeout: timeout,
+      }.compact
+      result = @channel.send_message_to_server_result('connectOverCDP', params)
+      browser = ChannelOwners::Browser.from(result['browser'])
+
+      if result['defaultContext']
+        context = ChannelOwners::BrowserContext.from(result['defaultContext'])
+        browser.send(:add_context, context)
+      end
+
+      if block
+        begin
+          block.call(browser)
+        ensure
+          browser.close
+        end
+      else
+        browser
+      end
+    end
   end
 end

data/lib/playwright/channel_owners/element_handle.rb

@@ -82,7 +82,7 @@ module Playwright
           modifiers: modifiers,
           position: position,
           timeout: timeout,
-        }
+        }.compact
         @channel.send_message_to_server('hover', params)
 
         nil
@@ -149,10 +149,8 @@ module Playwright
           value: value,
           label: label,
         ).as_params
-        params = base_params + { noWaitAfter: noWaitAfter, timeout: timeout }.compact
+        params = base_params.merge({ noWaitAfter: noWaitAfter, timeout: timeout }.compact)
         @channel.send_message_to_server('selectOption', params)
-
-        nil
       end
 
       def tap_point(
@@ -179,7 +177,7 @@ module Playwright
           value: value,
           noWaitAfter: noWaitAfter,
           timeout: timeout,
-        }
+        }.compact
         @channel.send_message_to_server('fill', params)
 
         nil
@@ -230,10 +228,11 @@ module Playwright
         nil
       end
 
-      def check(force: nil, noWaitAfter: nil, timeout: nil)
+      def check(force: nil, noWaitAfter: nil, position: nil, timeout: nil)
         params = {
           force: force,
           noWaitAfter:  noWaitAfter,
+          position: position,
           timeout: timeout,
         }.compact
         @channel.send_message_to_server('check', params)
@@ -241,10 +240,11 @@ module Playwright
         nil
       end
 
-      def uncheck(force: nil, noWaitAfter: nil, timeout: nil)
+      def uncheck(force: nil, noWaitAfter: nil, position: nil, timeout: nil)
         params = {
           force: force,
           noWaitAfter:  noWaitAfter,
+          position: position,
           timeout: timeout,
         }.compact
         @channel.send_message_to_server('uncheck', params)