playwright-ruby-client 1.55.0 → 1.57.0

data/lib/playwright/channel_owners/browser_context.rb

@@ -14,7 +14,6 @@ module Playwright
       @bindings = {}
       @timeout_settings = TimeoutSettings.new
       @service_workers = Set.new
-      @background_pages = Set.new
       @owner_page = nil
 
       @tracing = ChannelOwners::Tracing.from(@initializer['tracing'])
@@ -27,14 +26,11 @@ module Playwright
       @channel.once('close', ->(_) { on_close })
       @channel.on('page', ->(params) { on_page(ChannelOwners::Page.from(params['page']) )})
       @channel.on('route', ->(params) { on_route(ChannelOwners::Route.from(params['route'])) })
-      @channel.on('backgroundPage', ->(params) {
-        on_background_page(ChannelOwners::Page.from(params['page']))
-      })
       @channel.on('serviceWorker', ->(params) {
         on_service_worker(ChannelOwners::Worker.from(params['worker']))
       })
       @channel.on('console', ->(params) {
-        on_console_message(ConsoleMessageImpl.new(params))
+        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(
@@ -104,11 +100,6 @@ module Playwright
       page.send(:emit_popup_event_from_browser_context)
     end
 
-    private def on_background_page(page)
-      @background_pages << page
-      emit(Events::BrowserContext::BackgroundPage, page)
-    end
-
     private def on_route(route)
       route.send(:update_context, self)
 
@@ -171,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)
@@ -216,7 +210,8 @@ module Playwright
     end
 
     def background_pages
-      @background_pages.to_a
+      puts '[WARNING] BrowserContext#background_pages is deprecated. Returns an empty list.'
+      []
     end
 
     def service_workers
@@ -543,10 +538,6 @@ module Playwright
       @pages.delete(page)
     end
 
-    private def remove_background_page(page)
-      @background_pages.delete(page)
-    end
-
     private def remove_service_worker(worker)
       @service_workers.delete(worker)
     end

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,
@@ -149,7 +147,6 @@ module Playwright
     private def on_close
       @closed = true
       @browser_context.send(:remove_page, self)
-      @browser_context.send(:remove_background_page, self)
       if @closed_or_crashed_promise.pending?
         @closed_or_crashed_promise.fulfill(close_error_with_reason)
       end
@@ -537,7 +534,8 @@ module Playwright
           position: nil,
           strict: nil,
           timeout: nil,
-          trial: nil)
+          trial: nil,
+          steps: nil)
 
       @main_frame.click(
         selector,
@@ -551,6 +549,7 @@ module Playwright
         strict: strict,
         timeout: timeout,
         trial: trial,
+        steps: steps,
       )
     end
 
@@ -563,7 +562,8 @@ module Playwright
           strict: nil,
           targetPosition: nil,
           timeout: nil,
-          trial: nil)
+          trial: nil,
+          steps: nil)
 
       @main_frame.drag_and_drop(
         source,
@@ -574,7 +574,9 @@ module Playwright
         strict: strict,
         targetPosition: targetPosition,
         timeout: timeout,
-        trial: trial)
+        trial: trial,
+        steps: steps,
+      )
     end
 
     def dblclick(
@@ -587,7 +589,8 @@ module Playwright
           position: nil,
           strict: nil,
           timeout: nil,
-          trial: nil)
+          trial: nil,
+          steps: nil)
       @main_frame.dblclick(
         selector,
         button: button,
@@ -599,6 +602,7 @@ module Playwright
         strict: strict,
         timeout: timeout,
         trial: trial,
+        steps: steps,
       )
     end
 
@@ -639,6 +643,20 @@ module Playwright
         timeout: timeout)
     end
 
+    def console_messages
+      messages = @channel.send_message_to_server('consoleMessages')
+      messages.map do |message|
+        ConsoleMessageImpl.new(message, self, nil)
+      end
+    end
+
+    def page_errors
+      errors = @channel.send_message_to_server('pageErrors')
+      errors.map do |error|
+        Error.parse(error['error'])
+      end
+    end
+
     def locator(
       selector,
       has: nil,
@@ -826,6 +844,12 @@ module Playwright
       @workers.to_a
     end
 
+    def requests
+      @channel.send_message_to_server('requests').map do |req|
+        ChannelOwners::Request.from(req)
+      end
+    end
+
     def request
       @browser_context.request
     end
@@ -882,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)
@@ -1013,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,12 +1,12 @@
 module Playwright
   define_api_implementation :ConsoleMessageImpl do
-    def initialize(event)
+    def initialize(event, page, worker)
       @event = event
+      @page = page
+      @worker = worker
     end
 
-    def page
-      @page ||= ChannelOwners::Page.from_nullable(@event['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_assertions_impl.rb

@@ -49,8 +49,11 @@ module Playwright
             "\n#{message}"
           end
 
-          out = "#{out_message}\nActual value #{actual} #{log}"
-          raise AssertionError.new(out)
+        if result['errorMessage']
+          error_message = "\n#{result['errorMessage']}"
+        end
+        out = "#{out_message}\nActual value #{actual}#{error_message} #{log}"
+        raise AssertionError.new(out)
       else
         true
       end

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/page_assertions_impl.rb

@@ -50,8 +50,11 @@ module Playwright
             "\n#{message}"
           end
 
-          out = "#{out_message}\nActual value #{actual} #{log}"
-          raise AssertionError.new(out)
+        if result['errorMessage']
+          error_message = "\n#{result['errorMessage']}"
+        end
+        out = "#{out_message}\nActual value #{actual}#{error_message} #{log}"
+        raise AssertionError.new(out)
       else
         true
       end

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.55.0'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.55.0'
+  VERSION = '1.57.0'
+  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/browser_context.rb

@@ -72,9 +72,9 @@ module Playwright
     end
 
     #
-    # **NOTE**: Background pages are only supported on Chromium-based browsers.
+    # Returns an empty list.
     #
-    # All existing background pages in the context.
+    # @deprecated Background pages have been removed from Chromium together with Manifest V2 extensions.
     def background_pages
       wrap_impl(@impl.background_pages)
     end

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

data/lib/playwright_api/frame.rb

@@ -180,11 +180,12 @@ module Playwright
           force: nil,
           noWaitAfter: nil,
           sourcePosition: nil,
+          steps: nil,
           strict: nil,
           targetPosition: nil,
           timeout: nil,
           trial: nil)
-      wrap_impl(@impl.drag_and_drop(unwrap_impl(source), unwrap_impl(target), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), sourcePosition: unwrap_impl(sourcePosition), strict: unwrap_impl(strict), targetPosition: unwrap_impl(targetPosition), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
+      wrap_impl(@impl.drag_and_drop(unwrap_impl(source), unwrap_impl(target), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), sourcePosition: unwrap_impl(sourcePosition), steps: unwrap_impl(steps), strict: unwrap_impl(strict), targetPosition: unwrap_impl(targetPosition), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
     #

data/lib/playwright_api/locator.rb

@@ -61,7 +61,7 @@ module Playwright
     # The following example finds a button with a specific title.
     #
     # ```python sync
-    # button = page.get_by_role("button").and_(page.getByTitle("Subscribe"))
+    # button = page.get_by_role("button").and_(page.get_by_title("Subscribe"))
     # ```
     def and(locator)
       wrap_impl(@impl.and(unwrap_impl(locator)))
@@ -227,9 +227,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
 
     #
@@ -269,9 +270,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
 
     #
@@ -288,6 +290,22 @@ module Playwright
       wrap_impl(@impl.describe(unwrap_impl(description)))
     end
 
+    #
+    # Returns locator description previously set with [`method: Locator.describe`]. Returns `null` if no custom description has been set. Prefer `Locator.toString()` for a human-readable representation, as it uses the description when available.
+    #
+    # **Usage**
+    #
+    # ```python sync
+    # button = page.get_by_role("button").describe("Subscribe button")
+    # print(button.description())  # "Subscribe button"
+    #
+    # input = page.get_by_role("textbox")
+    # print(input.description())  # None
+    # ```
+    def description
+      wrap_impl(@impl.description)
+    end
+
     #
     # Programmatically dispatch an event on the matching element.
     #
@@ -358,10 +376,11 @@ module Playwright
           force: nil,
           noWaitAfter: nil,
           sourcePosition: nil,
+          steps: nil,
           targetPosition: nil,
           timeout: nil,
           trial: nil)
-      wrap_impl(@impl.drag_to(unwrap_impl(target), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), sourcePosition: unwrap_impl(sourcePosition), targetPosition: unwrap_impl(targetPosition), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
+      wrap_impl(@impl.drag_to(unwrap_impl(target), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), sourcePosition: unwrap_impl(sourcePosition), steps: unwrap_impl(steps), targetPosition: unwrap_impl(targetPosition), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
     #