playwright-ruby-client 1.14.beta2 → 1.15.beta2

data/lib/playwright/connection.rb

@@ -31,17 +31,12 @@ module Playwright
       @transport.stop
     end
 
-    def wait_for_object_with_known_name(guid)
-      if @objects[guid]
-        return @objects[guid]
-      end
-
-      callback = Concurrent::Promises.resolvable_future
-      @waiting_for_object[guid] = callback
-      callback.value!
+    def initialize_playwright
+      result = send_message_to_server('', 'initialize', { sdkLanguage: 'ruby' })
+      ChannelOwners::Playwright.from(result['playwright'])
     end
 
-    def async_send_message_to_server(guid, method, params)
+    def async_send_message_to_server(guid, method, params, metadata: nil)
       callback = Concurrent::Promises.resolvable_future
 
       with_generated_id do |id|
@@ -54,7 +49,9 @@ module Playwright
           guid: guid,
           method: method,
           params: replace_channels_with_guids(params),
+          metadata: metadata || {},
         }
+
         begin
           @transport.send_message(message)
         rescue => err
@@ -67,8 +64,8 @@ module Playwright
       callback
     end
 
-    def send_message_to_server(guid, method, params)
-      async_send_message_to_server(guid, method, params).value!
+    def send_message_to_server(guid, method, params, metadata: nil)
+      async_send_message_to_server(guid, method, params, metadata: metadata).value!
     end
 
     private

data/lib/playwright/http_headers.rb

@@ -11,10 +11,15 @@ module Playwright
       end
     end
 
-    def self.parse_serialized(serialized_headers)
-      new(serialized_headers.map do |header|
-        [header['name'].downcase, header['value']]
-      end.to_h)
+    module Parser
+      def parse_headers_as_array(serialized_headers, downcase)
+        serialized_headers.map do |header|
+          name = downcase ? header['name'].downcase : header['name']
+          value = header['value']
+
+          [name, value]
+        end
+      end
     end
   end
 end

data/lib/playwright/locator_impl.rb

@@ -142,7 +142,7 @@ module Playwright
       LocatorImpl.new(
         frame: @frame,
         timeout_settings: @timeout_settings,
-        selector: "#{@selector} >> _nth=first",
+        selector: "#{@selector} >> nth=0",
       )
     end
 
@@ -150,7 +150,7 @@ module Playwright
       LocatorImpl.new(
         frame: @frame,
         timeout_settings: @timeout_settings,
-        selector: "#{@selector} >> _nth=last",
+        selector: "#{@selector} >> nth=-1",
       )
     end
 
@@ -158,7 +158,7 @@ module Playwright
       LocatorImpl.new(
         frame: @frame,
         timeout_settings: @timeout_settings,
-        selector: "#{@selector} >> _nth=#{index}",
+        selector: "#{@selector} >> nth=#{index}",
       )
     end
 
@@ -303,6 +303,14 @@ module Playwright
         trial: trial)
     end
 
+    def set_checked(checked, **options)
+      if checked
+        check(**options)
+      else
+        uncheck(**options)
+      end
+    end
+
     def all_inner_texts
       @frame.eval_on_selector_all(@selector, 'ee => ee.map(e => e.innerText)')
     end

data/lib/playwright/{route_handler_entry.rb → route_handler.rb}

@@ -1,15 +1,43 @@
 module Playwright
-  class RouteHandlerEntry
+  class RouteHandler
+    class CountDown
+      def initialize(count)
+        @count = count
+      end
+
+      def handle
+        return false if @count <= 0
+
+        @count = @count - 1
+        true
+      end
+    end
+
+    class StubCounter
+      def handle
+        true
+      end
+    end
+
     # @param url [String]
     # @param base_url [String|nil]
     # @param handler [Proc]
-    def initialize(url, base_url, handler)
+    # @param times [Integer|nil]
+    def initialize(url, base_url, handler, times)
       @url_value = url
       @url_matcher = UrlMatcher.new(url, base_url: base_url)
       @handler = handler
+      @counter =
+        if times
+          CountDown.new(times)
+        else
+          StubCounter.new
+        end
     end
 
     def handle(route, request)
+      return false unless @counter.handle
+
       if @url_matcher.match?(request.url)
         @handler.call(route, request)
         true

data/lib/playwright/tracing_impl.rb

@@ -12,19 +12,30 @@ module Playwright
         snapshots: snapshots,
       }.compact
       @channel.send_message_to_server('tracingStart', params)
+      @channel.send_message_to_server('tracingStartChunk')
+    end
+
+    def start_chunk
+      @channel.send_message_to_server('tracingStartChunk')
+    end
+
+    def stop_chunk(path: nil)
+      do_stop_chunk(path: path)
     end
 
-    # Stop tracing.
     def stop(path: nil)
-      export(path: path) if path
+      do_stop_chunk(path: path)
       @channel.send_message_to_server('tracingStop')
     end
 
-    private def export(path:)
-      resp = @channel.send_message_to_server('tracingExport')
-      artifact = ChannelOwners::Artifact.from(resp)
-      # if self._context._browser:
-      #   artifact._is_remote = self._context._browser._is_remote
+    private def do_stop_chunk(path:)
+      resp = @channel.send_message_to_server('tracingStopChunk', save: !path.nil?)
+      artifact = ChannelOwners::Artifact.from_nullable(resp)
+      return unless artifact
+
+      if @context.browser.send(:remote?)
+        artifact.update_as_remote
+      end
       artifact.save_as(path)
       artifact.delete
     end

data/lib/playwright/transport.rb

@@ -97,7 +97,9 @@ module Playwright
     end
 
     def debug_send_message(message)
+      metadata = message.delete(:metadata)
       puts "\x1b[33mSEND>\x1b[0m#{message}"
+      message[:metadata] = metadata
     end
 
     def debug_recv_message(message)

data/lib/playwright/utils.rb

@@ -3,7 +3,6 @@ module Playwright
     module PrepareBrowserContextOptions
       # @see https://github.com/microsoft/playwright/blob/5a2cfdbd47ed3c3deff77bb73e5fac34241f649d/src/client/browserContext.ts#L265
       private def prepare_browser_context_options(params)
-        params[:sdkLanguage] = 'ruby'
         if params[:noViewport] == 0
           params.delete(:noViewport)
           params[:noDefaultViewport] = true
@@ -11,6 +10,14 @@ module Playwright
         if params[:extraHTTPHeaders]
           params[:extraHTTPHeaders] = ::Playwright::HttpHeaders.new(params[:extraHTTPHeaders]).as_serialized
         end
+        if params[:record_har_path]
+          params[:recordHar] = {
+            path: params.delete(:record_har_path)
+          }
+          if params[:record_har_omit_content]
+            params[:recordHar][:omitContent] = params.delete(:record_har_omit_content)
+          end
+        end
         if params[:record_video_dir]
           params[:recordVideo] = {
             dir: params.delete(:record_video_dir)

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.14.beta2'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.14.0'
+  VERSION = '1.15.beta2'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.15.0'
 end

data/lib/playwright/web_socket_transport.rb

@@ -94,7 +94,9 @@ module Playwright
     end
 
     def debug_send_message(message)
+      metadata = message.delete(:metadata)
       puts "\x1b[33mSEND>\x1b[0m#{message}"
+      message[:metadata] = metadata
     end
 
     def debug_recv_message(message)

data/lib/playwright.rb

@@ -20,7 +20,7 @@ require 'playwright/channel_owner'
 require 'playwright/http_headers'
 require 'playwright/input_files'
 require 'playwright/connection'
-require 'playwright/route_handler_entry'
+require 'playwright/route_handler'
 require 'playwright/select_option_values'
 require 'playwright/timeout_settings'
 require 'playwright/transport'
@@ -35,16 +35,18 @@ Dir[File.join(__dir__, 'playwright_api', '*.rb')].each { |f| require f }
 
 module Playwright
   class Execution
-    def initialize(connection, playwright)
+    def initialize(connection, playwright, browser = nil)
       @connection = connection
       @playwright = playwright
+      @browser = browser
     end
 
     def stop
+      @browser&.close
       @connection.stop
     end
 
-    attr_reader :playwright
+    attr_reader :playwright, :browser
   end
 
   # Recommended to call this method with block.
@@ -64,7 +66,7 @@ module Playwright
 
     execution =
       begin
-        playwright = connection.wait_for_object_with_known_name('Playwright')
+        playwright = connection.initialize_playwright
         Execution.new(connection, PlaywrightApi.wrap(playwright))
       rescue
         connection.stop
@@ -100,7 +102,7 @@ module Playwright
 
     execution =
       begin
-        playwright = connection.wait_for_object_with_known_name('Playwright')
+        playwright = connection.initialize_playwright
         Execution.new(connection, PlaywrightApi.wrap(playwright))
       rescue
         connection.stop
@@ -117,4 +119,42 @@ module Playwright
       execution
     end
   end
+
+  # Connects to Playwright server, launched by `npx playwright launch-server chromium` or `playwright.chromium.launchServer()`
+  #
+  # Playwright.connect_to_browser_server('ws://....') do |browser|
+  #   page = browser.new_page
+  #   ...
+  # end
+  #
+  # @experimental
+  module_function def connect_to_browser_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.initialize_playwright
+        browser = playwright.send(:pre_launched_browser)
+        browser.send(:update_as_remote)
+        Execution.new(connection, PlaywrightApi.wrap(playwright), PlaywrightApi.wrap(browser))
+      rescue
+        connection.stop
+        raise
+      end
+
+    if block
+      begin
+        block.call(execution.browser)
+      ensure
+        execution.stop
+      end
+    else
+      execution
+    end
+  end
 end

data/lib/playwright_api/android.rb

@@ -1,6 +1,19 @@
 module Playwright
-  # Playwright has **experimental** support for Android automation. See [here](./mobile.md) for more information. You can
-  # access android namespace via:
+  # Playwright has **experimental** support for Android automation. This includes Chrome for Android and Android WebView.
+  #
+  # *Requirements*
+  # - Android device or AVD Emulator.
+  # - [ADB daemon](https://developer.android.com/studio/command-line/adb) running and authenticated with your device.
+  #   Typically running `adb devices` is all you need to do.
+  # - [`Chrome 87`](https://play.google.com/store/apps/details?id=com.android.chrome) or newer installed on the device
+  # - "Enable command line on non-rooted devices" enabled in `chrome://flags`.
+  #
+  # *Known limitations*
+  # - Raw USB operation is not yet supported, so you need ADB.
+  # - Device needs to be awake to produce screenshots. Enabling "Stay awake" developer mode will help.
+  # - We didn't run all the tests against the device, so not everything works.
+  #
+  # *How to run*
   #
   # An example of the Android automation script would be:
   #
@@ -25,20 +38,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/android_device.rb

@@ -46,6 +46,7 @@ module Playwright
           command: nil,
           deviceScaleFactor: nil,
           extraHTTPHeaders: nil,
+          forcedColors: nil,
           geolocation: nil,
           hasTouch: nil,
           httpCredentials: nil,
@@ -62,11 +63,12 @@ module Playwright
           record_video_size: nil,
           reducedMotion: nil,
           screen: nil,
+          strictSelectors: nil,
           timezoneId: nil,
           userAgent: nil,
           viewport: nil,
           &block)
-      wrap_impl(@impl.launch_browser(acceptDownloads: unwrap_impl(acceptDownloads), baseURL: unwrap_impl(baseURL), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), command: unwrap_impl(command), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), noViewport: unwrap_impl(noViewport), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), reducedMotion: unwrap_impl(reducedMotion), screen: unwrap_impl(screen), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
+      wrap_impl(@impl.launch_browser(acceptDownloads: unwrap_impl(acceptDownloads), baseURL: unwrap_impl(baseURL), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), command: unwrap_impl(command), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), forcedColors: unwrap_impl(forcedColors), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), noViewport: unwrap_impl(noViewport), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), reducedMotion: unwrap_impl(reducedMotion), screen: unwrap_impl(screen), strictSelectors: unwrap_impl(strictSelectors), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
     end
 
     # Performs a long tap on the widget defined by `selector`.
@@ -162,14 +164,20 @@ module Playwright
       raise NotImplementedError.new('web_views is not implemented yet.')
     end
 
+    # @nodoc
+    def tree
+      wrap_impl(@impl.tree)
+    end
+
     # @nodoc
     def tap_on(selector, duration: nil, timeout: nil)
       wrap_impl(@impl.tap_on(unwrap_impl(selector), duration: unwrap_impl(duration), timeout: unwrap_impl(timeout)))
     end
 
+    # -- inherited from EventEmitter --
     # @nodoc
-    def tree
-      wrap_impl(@impl.tree)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
@@ -184,12 +192,6 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/browser.rb

@@ -70,6 +70,7 @@ module Playwright
           colorScheme: nil,
           deviceScaleFactor: nil,
           extraHTTPHeaders: nil,
+          forcedColors: nil,
           geolocation: nil,
           hasTouch: nil,
           httpCredentials: nil,
@@ -88,11 +89,12 @@ module Playwright
           reducedMotion: nil,
           screen: nil,
           storageState: nil,
+          strictSelectors: nil,
           timezoneId: nil,
           userAgent: nil,
           viewport: nil,
           &block)
-      wrap_impl(@impl.new_context(acceptDownloads: unwrap_impl(acceptDownloads), baseURL: unwrap_impl(baseURL), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), noViewport: unwrap_impl(noViewport), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), proxy: unwrap_impl(proxy), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), reducedMotion: unwrap_impl(reducedMotion), screen: unwrap_impl(screen), storageState: unwrap_impl(storageState), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
+      wrap_impl(@impl.new_context(acceptDownloads: unwrap_impl(acceptDownloads), baseURL: unwrap_impl(baseURL), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), forcedColors: unwrap_impl(forcedColors), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), noViewport: unwrap_impl(noViewport), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), proxy: unwrap_impl(proxy), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), reducedMotion: unwrap_impl(reducedMotion), screen: unwrap_impl(screen), storageState: unwrap_impl(storageState), strictSelectors: unwrap_impl(strictSelectors), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
     end
 
     # Creates a new page in a new browser context. Closing this page will close the context as well.
@@ -107,6 +109,7 @@ module Playwright
           colorScheme: nil,
           deviceScaleFactor: nil,
           extraHTTPHeaders: nil,
+          forcedColors: nil,
           geolocation: nil,
           hasTouch: nil,
           httpCredentials: nil,
@@ -125,11 +128,12 @@ module Playwright
           reducedMotion: nil,
           screen: nil,
           storageState: nil,
+          strictSelectors: nil,
           timezoneId: nil,
           userAgent: nil,
           viewport: nil,
           &block)
-      wrap_impl(@impl.new_page(acceptDownloads: unwrap_impl(acceptDownloads), baseURL: unwrap_impl(baseURL), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), noViewport: unwrap_impl(noViewport), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), proxy: unwrap_impl(proxy), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), reducedMotion: unwrap_impl(reducedMotion), screen: unwrap_impl(screen), storageState: unwrap_impl(storageState), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
+      wrap_impl(@impl.new_page(acceptDownloads: unwrap_impl(acceptDownloads), baseURL: unwrap_impl(baseURL), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), forcedColors: unwrap_impl(forcedColors), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), noViewport: unwrap_impl(noViewport), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), proxy: unwrap_impl(proxy), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), reducedMotion: unwrap_impl(reducedMotion), screen: unwrap_impl(screen), storageState: unwrap_impl(storageState), strictSelectors: unwrap_impl(strictSelectors), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
     end
 
     # > NOTE: This API controls [Chromium Tracing](https://www.chromium.org/developers/how-tos/trace-event-profiling-tool)
@@ -164,20 +168,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy