playwright-ruby-client 1.56.0 → 1.57.1

data/lib/playwright/channel_owners/api_request_context.rb

@@ -1,5 +1,5 @@
 require 'base64'
-require 'cgi'
+require 'cgi/escape'
 
 module Playwright
   define_channel_owner :APIRequestContext do
@@ -197,7 +197,7 @@ module Playwright
     end
 
     private def query_string_to_array(query_string)
-      params = CGI.parse(query_string)
+      params = cgi_parse(query_string)
 
       params.map do |key, values|
         values.map do |value|
@@ -206,6 +206,28 @@ module Playwright
       end.flatten
     end
 
+    # https://bugs.ruby-lang.org/issues/21258
+    # CGI.parse is defined in 'cgi' library.
+    # But it produces an error in Ruby 2.4 environment: undefined method `delete_prefix' for "CONTENT_LENGTH":String
+    # So we implement our own version of CGI.parse here.
+    private def cgi_parse(query)
+      # https://github.com/ruby/cgi/blob/master/lib/cgi/core.rb#L396
+      params = {}
+
+      query.split(/[&;]/).each do |pairs|
+        key, value = pairs.split('=',2).map do |v|
+          CGI.unescape(v)
+        end
+
+        next unless key
+        params[key] ||= []
+        next unless value
+        params[key] << value
+      end
+
+      params
+    end
+
     private def object_to_array(hash)
       hash&.map do |key, value|
         { name: key, value: value.to_s }

data/lib/playwright/channel_owners/browser_context.rb

@@ -30,7 +30,7 @@ module Playwright
         on_service_worker(ChannelOwners::Worker.from(params['worker']))
       })
       @channel.on('console', ->(params) {
-        on_console_message(ConsoleMessageImpl.new(params, ChannelOwners::Page.from_nullable(params['page'])))
+        on_console_message(ConsoleMessageImpl.new(params, ChannelOwners::Page.from_nullable(params['page']), ChannelOwners::Worker.from_nullable(params['worker'])))
       })
       @channel.on('pageError', ->(params) {
         on_page_error(
@@ -162,10 +162,13 @@ module Playwright
     end
 
     private def on_console_message(message)
-      emit(Events::BrowserContext::Console, message)
+      if (worker = message.worker)
+        worker.emit(Events::Worker::Console, message)
+      end
       if (page = message.page)
         page.emit(Events::Page::Console, message)
       end
+      emit(Events::BrowserContext::Console, message)
     end
 
     private def on_dialog(dialog)

data/lib/playwright/channel_owners/element_handle.rb

@@ -110,7 +110,8 @@ module Playwright
             noWaitAfter: nil,
             position: nil,
             timeout: nil,
-            trial: nil)
+            trial: nil,
+            steps: nil)
 
         params = {
           button: button,
@@ -122,6 +123,7 @@ module Playwright
           position: position,
           timeout: _timeout(timeout),
           trial: trial,
+          steps: steps,
         }.compact
         @channel.send_message_to_server('click', params)
 
@@ -136,7 +138,8 @@ module Playwright
             noWaitAfter: nil,
             position: nil,
             timeout: nil,
-            trial: nil)
+            trial: nil,
+            steps: nil)
 
         params = {
           button: button,
@@ -147,6 +150,7 @@ module Playwright
           position: position,
           timeout: _timeout(timeout),
           trial: trial,
+          steps: steps,
         }.compact
         @channel.send_message_to_server('dblclick', params)
 

data/lib/playwright/channel_owners/frame.rb

@@ -337,7 +337,8 @@ module Playwright
           position: nil,
           strict: nil,
           timeout: nil,
-          trial: nil)
+          trial: nil,
+          steps: nil)
 
       params = {
         selector: selector,
@@ -351,6 +352,7 @@ module Playwright
         strict: strict,
         timeout: _timeout(timeout),
         trial: trial,
+        steps: steps,
       }.compact
       @channel.send_message_to_server('click', params)
 
@@ -366,7 +368,8 @@ module Playwright
           strict: nil,
           targetPosition: nil,
           timeout: nil,
-          trial: nil)
+          trial: nil,
+          steps: nil)
 
       params = {
         source: source,
@@ -378,6 +381,7 @@ module Playwright
         targetPosition: targetPosition,
         timeout: _timeout(timeout),
         trial: trial,
+        steps: steps,
       }.compact
       @channel.send_message_to_server('dragAndDrop', params)
 
@@ -394,7 +398,8 @@ module Playwright
           position: nil,
           strict: nil,
           timeout: nil,
-          trial: nil)
+          trial: nil,
+          steps: nil)
 
       params = {
         selector: selector,
@@ -407,6 +412,7 @@ module Playwright
         strict: strict,
         timeout: _timeout(timeout),
         trial: trial,
+        steps: steps,
       }.compact
       @channel.send_message_to_server('dblclick', params)
 

data/lib/playwright/channel_owners/page.rb

@@ -11,7 +11,6 @@ module Playwright
     private def after_initialize
       @browser_context = @parent
       @timeout_settings = TimeoutSettings.new(@browser_context.send(:_timeout_settings))
-      @accessibility = AccessibilityImpl.new(@channel)
       @keyboard = KeyboardImpl.new(@channel)
       @mouse = MouseImpl.new(@channel)
       @touchscreen = TouchscreenImpl.new(@channel)
@@ -79,7 +78,6 @@ module Playwright
     end
 
     attr_reader \
-      :accessibility,
       :keyboard,
       :mouse,
       :touchscreen,
@@ -536,7 +534,8 @@ module Playwright
           position: nil,
           strict: nil,
           timeout: nil,
-          trial: nil)
+          trial: nil,
+          steps: nil)
 
       @main_frame.click(
         selector,
@@ -550,6 +549,7 @@ module Playwright
         strict: strict,
         timeout: timeout,
         trial: trial,
+        steps: steps,
       )
     end
 
@@ -562,7 +562,8 @@ module Playwright
           strict: nil,
           targetPosition: nil,
           timeout: nil,
-          trial: nil)
+          trial: nil,
+          steps: nil)
 
       @main_frame.drag_and_drop(
         source,
@@ -573,7 +574,9 @@ module Playwright
         strict: strict,
         targetPosition: targetPosition,
         timeout: timeout,
-        trial: trial)
+        trial: trial,
+        steps: steps,
+      )
     end
 
     def dblclick(
@@ -586,7 +589,8 @@ module Playwright
           position: nil,
           strict: nil,
           timeout: nil,
-          trial: nil)
+          trial: nil,
+          steps: nil)
       @main_frame.dblclick(
         selector,
         button: button,
@@ -598,6 +602,7 @@ module Playwright
         strict: strict,
         timeout: timeout,
         trial: trial,
+        steps: steps,
       )
     end
 
@@ -641,7 +646,7 @@ module Playwright
     def console_messages
       messages = @channel.send_message_to_server('consoleMessages')
       messages.map do |message|
-        ConsoleMessageImpl.new(message, self)
+        ConsoleMessageImpl.new(message, self, nil)
       end
     end
 
@@ -901,8 +906,23 @@ module Playwright
       @video ||= Video.new(self)
     end
 
-    def snapshot_for_ai(timeout: nil)
-      @channel.send_message_to_server('snapshotForAI', timeout: @timeout_settings.timeout(timeout))
+    def snapshot_for_ai(timeout: nil, mode: nil, track: nil)
+      option_mode = mode || 'full'
+      unless ['full', 'incremental'].include?(option_mode)
+        raise ArgumentError.new("mode must be either 'full' or 'incremental'")
+      end
+
+      options = {
+        timeout: @timeout_settings.timeout(timeout),
+        mode: option_mode,
+      }
+      options[:track] = track if track
+      result = @channel.send_message_to_server_result('snapshotForAI', options)
+      if option_mode == 'full'
+        result['full']
+      elsif option_mode == 'incremental'
+        result['incremental']
+      end
     end
 
     def start_js_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
@@ -1032,7 +1052,7 @@ module Playwright
       expect_event(Events::Page::Worker, predicate: predicate, timeout: timeout, &block)
     end
 
-    # called from Frame with send(:timeout_settings)
+    # called from Frame with send(:_timeout_settings)
     private def _timeout_settings
       @timeout_settings
     end

data/lib/playwright/channel_owners/worker.rb

@@ -4,6 +4,10 @@ module Playwright
 
     private def after_initialize
       @channel.once('close', ->(_) { on_close })
+
+      set_event_to_subscription_mapping({
+        Events::Worker::Console => "console",
+      })
     end
 
     private def on_close
@@ -23,5 +27,20 @@ module Playwright
     def evaluate_handle(expression, arg: nil)
       JavaScript::Expression.new(expression, arg).evaluate_handle(@channel)
     end
+
+    def expect_event(event, predicate: nil, timeout: nil, &block)
+      waiter = Waiter.new(self, wait_name: "Worker.expect_event(#{event})")
+      timeout_value = timeout || @page&.send(:_timeout_settings)&.timeout || @context&.send(:_timeout_settings)&.timeout
+      waiter.reject_on_timeout(timeout_value, "Timeout #{timeout_value}ms exceeded while waiting for event \"#{event}\"")
+
+      unless event == Events::Worker::Close
+        waiter.reject_on_event(self, Events::Worker::Close, TargetClosedError.new)
+      end
+
+      waiter.wait_for_event(self, event, predicate: predicate)
+      block&.call
+
+      waiter.result.value!
+    end
   end
 end

data/lib/playwright/console_message_impl.rb

@@ -1,13 +1,12 @@
 module Playwright
   define_api_implementation :ConsoleMessageImpl do
-    def initialize(event, page)
+    def initialize(event, page, worker)
       @event = event
       @page = page
+      @worker = worker
     end
 
-    def page
-      @page
-    end
+    attr_reader :page, :worker
 
     def type
       @event['type']

data/lib/playwright/events.rb

@@ -74,6 +74,7 @@ end
 
   Worker: {
     Close: 'close',
+    Console: 'console',
   },
 
   ElectronApplication: {

data/lib/playwright/locator_impl.rb

@@ -126,7 +126,8 @@ module Playwright
           noWaitAfter: nil,
           position: nil,
           timeout: nil,
-          trial: nil)
+          trial: nil,
+          steps: nil)
 
       @frame.click(@selector,
         strict: true,
@@ -138,7 +139,8 @@ module Playwright
         noWaitAfter: noWaitAfter,
         position: position,
         timeout: timeout,
-        trial: trial)
+        trial: trial,
+        steps: steps)
     end
 
     def dblclick(
@@ -149,7 +151,8 @@ module Playwright
           noWaitAfter: nil,
           position: nil,
           timeout: nil,
-          trial: nil)
+          trial: nil,
+          steps: nil)
 
       @frame.dblclick(@selector,
         strict: true,
@@ -160,7 +163,8 @@ module Playwright
         noWaitAfter: noWaitAfter,
         position: position,
         timeout: timeout,
-        trial: trial)
+        trial: trial,
+        steps: steps)
     end
 
     def dispatch_event(type, eventInit: nil, timeout: nil)
@@ -173,7 +177,8 @@ module Playwright
           sourcePosition: nil,
           targetPosition: nil,
           timeout: nil,
-          trial: nil)
+          trial: nil,
+          steps: nil)
 
       @frame.drag_and_drop(
         @selector,
@@ -185,6 +190,7 @@ module Playwright
         timeout: timeout,
         trial: trial,
         strict: true,
+        steps: steps,
       )
     end
 
@@ -256,6 +262,20 @@ module Playwright
       )
     end
 
+    def description
+      if @selector =~ / >> internal:describe=("(?:[^"\\]|\\.)*")$/
+        begin
+          description = JSON.parse($1)
+          if description.is_a?(String)
+            return description
+          end
+        rescue JSON::ParserError
+        end
+      end
+
+      nil
+    end
+
     def filter(has: nil, hasNot: nil, hasNotText: nil, hasText: nil, visible: nil)
       LocatorImpl.new(
         frame: @frame,

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.56.0'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.56.1'
+  VERSION = '1.57.1'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.57.0'
 end

data/lib/playwright/web_socket_transport.rb

@@ -6,7 +6,7 @@ module Playwright
   # ref: https://github.com/microsoft/playwright-python/blob/master/playwright/_impl/_transport.py
   class WebSocketTransport
     # @param ws_endpoint [String] EndpointURL of WebSocket
-    def initialize(ws_endpoint:, headers:)
+    def initialize(ws_endpoint:, headers: {})
       @ws_endpoint = ws_endpoint
       @headers = headers
       @debug = ENV['DEBUG'].to_s == 'true' || ENV['DEBUG'].to_s == '1'

data/lib/playwright.rb

@@ -104,6 +104,10 @@ module Playwright
 
   # @Deprecated. Playwright >= 1.54 does not support this method.
   module_function def connect_to_playwright_server(ws_endpoint, &block)
+    if Gem::Version.new(COMPATIBLE_PLAYWRIGHT_VERSION) >= Gem::Version.new('1.54.0')
+      raise NotImplementedError, 'connect_to_playwright_server is deprecated and not supported in Playwright >= 1.54. Use connect_to_browser_server instead.'
+    end
+
     require 'playwright/web_socket_client'
     require 'playwright/web_socket_transport'
 

data/lib/playwright_api/android.rb

@@ -45,8 +45,8 @@ 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 --
@@ -57,8 +57,8 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/android_device.rb

@@ -206,8 +206,8 @@ 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 --
@@ -218,8 +218,8 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/api_request_context.rb

@@ -288,8 +288,8 @@ 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 --
@@ -300,8 +300,8 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/browser.rb

@@ -205,8 +205,8 @@ 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 --
@@ -217,8 +217,8 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/browser_context.rb

@@ -490,8 +490,8 @@ 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 --
@@ -502,8 +502,8 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/browser_type.rb

@@ -182,8 +182,8 @@ 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 --
@@ -194,8 +194,8 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/cdp_session.rb

@@ -33,8 +33,8 @@ 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 --
@@ -45,8 +45,8 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/console_message.rb

@@ -48,5 +48,11 @@ module Playwright
     def type
       wrap_impl(@impl.type)
     end
+
+    #
+    # The web worker or service worker that produced this console message, if any. Note that console messages from web workers also have non-null [`method: ConsoleMessage.page`].
+    def worker
+      wrap_impl(@impl.worker)
+    end
   end
 end

data/lib/playwright_api/dialog.rb

@@ -70,8 +70,8 @@ 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 --
@@ -82,8 +82,8 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/element_handle.rb

@@ -100,9 +100,10 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
+          steps: nil,
           timeout: nil,
           trial: nil)
-      wrap_impl(@impl.click(button: unwrap_impl(button), clickCount: unwrap_impl(clickCount), delay: unwrap_impl(delay), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
+      wrap_impl(@impl.click(button: unwrap_impl(button), clickCount: unwrap_impl(clickCount), delay: unwrap_impl(delay), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), steps: unwrap_impl(steps), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
     #
@@ -130,9 +131,10 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
+          steps: nil,
           timeout: nil,
           trial: nil)
-      wrap_impl(@impl.dblclick(button: unwrap_impl(button), delay: unwrap_impl(delay), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
+      wrap_impl(@impl.dblclick(button: unwrap_impl(button), delay: unwrap_impl(delay), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), steps: unwrap_impl(steps), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
     #
@@ -574,8 +576,8 @@ 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 --
@@ -586,8 +588,8 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     private def event_emitter_proxy