playwright-ruby-client 0.3.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbaaa0e61bbc515a26d0f0e6af6ca8c36bbf3db5cc6913a6895f175154ba893b
-  data.tar.gz: cdc467f161030497d4efb94689bef4901c0e15bd24e9cc8be189106f5dfe4493
+  metadata.gz: 8979977d78ed7f62007ac6049ccf50a4c865093ac0d4c8828a8f8b8fdd69beef
+  data.tar.gz: 20346e5f5a373b49441c81a1fc77cc15ed0afb3bd47479e7cb6e545935fb7dfa
 SHA512:
-  metadata.gz: 585d3989547fd8e38e1e9503bf8aee20e732b1234bd62783c51b2e77a6061325c9a0c44de0de2b65557726dbebd6dc944ab44f72ffb8cbba69449ff3c0886a59
-  data.tar.gz: e50bd506a34d5fe1d84d6f75d0fbe8bc1128c0f93c3529dc94ba6af7dabf59e564625e6ca0b5a16cf7ad8066ffe91aeeda369599a30c0bb9e5629f54dfe54fd1
+  metadata.gz: f74fc9b91dccf461603ef6be94c7dbb6aae4899f7246fb4db1456018cc16c9e4fc63d6bf8c9912623b69d20d2901fcd5aab6e128638afc799fa20caac989ddaf
+  data.tar.gz: f25f60d3d258fc5fa3592201a45e46e6b111a8508b4493c4308a206d4b33f7909925a1b8760e433a2b7139223e7670b4c9fa0474eccfc3ec2bf2c46061af04b4

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/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

@@ -179,7 +179,7 @@ module Playwright
           value: value,
           noWaitAfter: noWaitAfter,
           timeout: timeout,
-        }
+        }.compact
         @channel.send_message_to_server('fill', params)
 
         nil

data/lib/playwright/channel_owners/frame.rb

@@ -98,6 +98,15 @@ module Playwright
       request&.response
     end
 
+    def wait_for_url(url, timeout: nil, waitUntil: nil)
+      matcher = UrlMatcher.new(url)
+      if matcher.match?(@url)
+        wait_for_load_state(state: waitUntil, timeout: timeout)
+      else
+        expect_navigation(timeout: timeout, url: url, waitUntil: waitUntil)
+      end
+    end
+
     def wait_for_load_state(state: nil, timeout: nil)
       option_state = state || 'load'
       option_timeout = timeout || @page.send(:timeout_settings).navigation_timeout
@@ -464,11 +473,18 @@ module Playwright
       nil
     end
 
-    def check(selector, force: nil, noWaitAfter: nil, timeout: nil)
+    def check(
+      selector,
+      force: nil,
+      noWaitAfter: nil,
+      position: nil,
+      timeout: nil)
+
       params = {
         selector: selector,
         force: force,
         noWaitAfter:  noWaitAfter,
+        position: position,
         timeout: timeout,
       }.compact
       @channel.send_message_to_server('check', params)
@@ -476,11 +492,18 @@ module Playwright
       nil
     end
 
-    def uncheck(selector, force: nil, noWaitAfter: nil, timeout: nil)
+    def uncheck(
+      selector,
+      force: nil,
+      noWaitAfter: nil,
+      position: nil,
+      timeout: nil)
+
       params = {
         selector: selector,
         force: force,
         noWaitAfter:  noWaitAfter,
+        position: position,
         timeout: timeout,
       }.compact
       @channel.send_message_to_server('uncheck', params)

data/lib/playwright/channel_owners/js_handle.rb

@@ -9,8 +9,8 @@ module Playwright
       @preview
     end
 
-    private def on_preview_updated(preview)
-      @preview = preview
+    private def on_preview_updated(params)
+      @preview = params['preview']
     end
 
     def evaluate(pageFunction, arg: nil)

data/lib/playwright/channel_owners/page.rb

@@ -28,6 +28,7 @@ module Playwright
       @main_frame.send(:update_page_from_page, self)
       @frames = Set.new
       @frames << @main_frame
+      @opener = ChannelOwners::Page.from_nullable(@initializer['opener'])
 
       @channel.once('close', ->(_) { on_close })
       @channel.on('console', ->(params) {
@@ -37,9 +38,7 @@ module Playwright
       @channel.on('crash', ->(_) { emit(Events::Page::Crash) })
       @channel.on('dialog', method(:on_dialog))
       @channel.on('domcontentloaded', ->(_) { emit(Events::Page::DOMContentLoaded) })
-      @channel.on('download', ->(params) {
-        emit(Events::Page::Download, ChannelOwners::Download.from(params['download']))
-      })
+      @channel.on('download', method(:on_download))
       @channel.on('fileChooser', ->(params) {
         chooser = FileChooserImpl.new(
                     page: self,
@@ -57,9 +56,6 @@ module Playwright
       @channel.on('pageError', ->(params) {
         emit(Events::Page::PageError, Error.parse(params['error']['error']))
       })
-      @channel.on('popup', ->(params) {
-        emit(Events::Page::Popup, ChannelOwners::Page.from(params['page']))
-      })
       @channel.on('request', ->(params) {
         emit(Events::Page::Request, ChannelOwners::Request.from(params['request']))
       })
@@ -82,9 +78,7 @@ module Playwright
       @channel.on('route', ->(params) {
         on_route(ChannelOwners::Route.from(params['route']), ChannelOwners::Request.from(params['request']))
       })
-      @channel.on('video', ->(params) {
-        video.send(:update_relative_path, params['relativePath'])
-      })
+      @channel.on('video', method(:on_video))
       @channel.on('webSocket', ->(params) {
         emit(Events::Page::WebSocket, ChannelOwners::WebSocket.from(params['webSocket']))
       })
@@ -149,6 +143,20 @@ module Playwright
       end
     end
 
+    private def on_download(params)
+      download = Download.new(
+        url: params['url'],
+        suggested_filename: params['suggestedFilename'],
+        artifact: ChannelOwners::Artifact.from(params['artifact']),
+      )
+      emit(Events::Page::Download, download)
+    end
+
+    private def on_video(params)
+      artifact = ChannelOwners::Artifact.from(params['artifact'])
+      video.send(:set_artifact, artifact)
+    end
+
     # @override
     def on(event, callback)
       if event == Events::Page::FileChooser && listener_count(event) == 0
@@ -178,8 +186,17 @@ module Playwright
     end
 
     def opener
-      resp = @channel.send_message_to_server('opener')
-      ChannelOwners::Page.from(resp)
+      if @opener&.closed?
+        nil
+      else
+        @opener
+      end
+    end
+
+    private def emit_popup_event_from_browser_context
+      if @opener && !@opener.closed?
+        @opener.emit(Events::Page::Popup, self)
+      end
     end
 
     def frame(name: nil, url: nil)
@@ -326,6 +343,10 @@ module Playwright
       @main_frame.wait_for_load_state(state: state, timeout: timeout)
     end
 
+    def wait_for_url(url, timeout: nil, waitUntil: nil)
+      @main_frame.wait_for_url(url, timeout: timeout,  waitUntil: waitUntil)
+    end
+
     def go_back(timeout: nil, waitUntil: nil)
       params = { timeout: timeout, waitUntil: waitUntil }.compact
       resp = @channel.send_message_to_server('goBack', params)
@@ -578,12 +599,24 @@ module Playwright
       @main_frame.press(selector, key, delay: delay, noWaitAfter: noWaitAfter, timeout: timeout)
     end
 
-    def check(selector, force: nil, noWaitAfter: nil, timeout: nil)
-      @main_frame.check(selector, force: force, noWaitAfter: noWaitAfter, timeout: timeout)
+    def check(
+      selector,
+      force: nil,
+      noWaitAfter: nil,
+      position: nil,
+      timeout: nil)
+
+      @main_frame.check(selector, force: force, noWaitAfter: noWaitAfter, position: position, timeout: timeout)
     end
 
-    def uncheck(selector, force: nil, noWaitAfter: nil, timeout: nil)
-      @main_frame.uncheck(selector, force: force, noWaitAfter: noWaitAfter, timeout: timeout)
+    def uncheck(
+      selector,
+      force: nil,
+      noWaitAfter: nil,
+      position: nil,
+      timeout: nil)
+
+      @main_frame.uncheck(selector, force: force, noWaitAfter: noWaitAfter, position: position, timeout: timeout)
     end
 
     def wait_for_function(pageFunction, arg: nil, polling: nil, timeout: nil)
@@ -629,6 +662,36 @@ module Playwright
       decoded_binary
     end
 
+    def video
+      return nil unless @browser_context.send(:has_record_video_option?)
+      @video ||= Video.new(self)
+    end
+
+    def start_js_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
+      params = {
+        resetOnNavigation: resetOnNavigation,
+        reportAnonymousScripts: reportAnonymousScripts,
+      }.compact
+
+      @channel.send_message_to_server('startJSCoverage', params)
+    end
+
+    def stop_js_coverage
+      @channel.send_message_to_server('stopJSCoverage')
+    end
+
+    def start_css_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
+      params = {
+        resetOnNavigation: resetOnNavigation,
+      }.compact
+
+      @channel.send_message_to_server('startCSSCoverage', params)
+    end
+
+    def stop_css_coverage
+      @channel.send_message_to_server('stopCSSCoverage')
+    end
+
     class CrashedError < StandardError
       def initialize
         super('Page crashed')

data/lib/playwright/channel_owners/playwright.rb

@@ -24,38 +24,31 @@ module Playwright
       @selectors ||= ::Playwright::ChannelOwners::Selectors.from(@initializer['selectors'])
     end
 
-    class DeviceDescriptor
-      class Viewport
-        def initialize(hash)
-          @width = hash['width']
-          @heirhgt = hash['height']
-        end
-        attr_reader :width, :height
-      end
-
-      def initialize(hash)
-        @user_agent = hash["userAgent"]
-        @viewport = Viewport.new(hash["viewport"])
-        @device_scale_factor = hash["deviceScaleFactor"]
-        @is_mobile = hash["isMobile"]
-        @has_touch = hash["hasTouch"]
-      end
-
-      attr_reader :user_agent, :viewport, :device_scale_factor
-
-      def mobile?
-        @is_mobile
-      end
-
-      def has_touch?
-        @has_touch
-      end
-    end
-
     def devices
       @devices ||= @initializer['deviceDescriptors'].map do |item|
-        [item['name'], DeviceDescriptor.new(item['descriptor'])]
+        [item['name'], parse_device_descriptor(item['descriptor'])]
       end.to_h
     end
+
+    private def parse_device_descriptor(descriptor)
+      # This return value can be passed into Browser#new_context as it is.
+      # ex:
+      # ```
+      #   iPhone = playwright.devices['iPhone 6']
+      #   context = browser.new_context(**iPhone)
+      #   page = context.new_page
+      #
+      # ```
+      {
+        userAgent: descriptor['userAgent'],
+        viewport: {
+          width: descriptor['viewport']['width'],
+          height: descriptor['viewport']['height'],
+        },
+        deviceScaleFactor: descriptor['deviceScaleFactor'],
+        isMobile: descriptor['isMobile'],
+        hasTouch: descriptor['hasTouch'],
+      }
+    end
   end
 end

data/lib/playwright/channel_owners/stream.rb

@@ -0,0 +1,15 @@
+require 'base64'
+
+module Playwright
+  define_channel_owner :Stream do
+    def save_as(path)
+      File.open(path, 'wb') do |f|
+        loop do
+          binary = @channel.send_message_to_server('read')
+          break if !binary || binary.length == 0
+          f.write(Base64.strict_decode64(binary))
+        end
+      end
+    end
+  end
+end