playwright-ruby-client 1.52.0 → 1.54.0

data/lib/playwright/test.rb

@@ -2,10 +2,28 @@ module Playwright
   # this module is responsible for running playwright assertions and integrating
   # with test frameworks.
   module Test
+    @@expect_timeout = nil
+
+    def self.expect_timeout
+      @@expect_timeout || 5000 # default timeout is 5000ms
+    end
+
+    def self.expect_timeout=(timeout)
+      @@expect_timeout = timeout
+    end
+
+    def self.with_timeout(expect_timeout, &block)
+      old_timeout = @@expect_timeout
+      @@expect_timeout = expect_timeout
+      block.call
+    ensure
+      @@expect_timeout = old_timeout
+    end
+
     # ref: https://github.com/microsoft/playwright-python/blob/main/playwright/sync_api/__init__.py#L90
     class Expect
       def initialize
-        @timeout_settings = TimeoutSettings.new
+        @default_expect_timeout = ::Playwright::Test.expect_timeout
       end
 
       def call(actual, is_not)
@@ -14,7 +32,7 @@ module Playwright
           PageAssertions.new(
             PageAssertionsImpl.new(
               actual,
-              @timeout_settings.timeout,
+              @default_expect_timeout,
               is_not,
               nil,
             )
@@ -23,7 +41,7 @@ module Playwright
           LocatorAssertions.new(
             LocatorAssertionsImpl.new(
               actual,
-              @timeout_settings.timeout,
+              @default_expect_timeout,
               is_not,
               nil,
             )

data/lib/playwright/timeout_settings.rb

@@ -1,6 +1,7 @@
 module Playwright
   class TimeoutSettings
     DEFAULT_TIMEOUT = 30000
+    DEFAULT_LAUNCH_TIMEOUT = 180000 # 3 minutes
 
     def initialize(parent = nil)
       @parent = parent
@@ -15,5 +16,9 @@ module Playwright
     def timeout(timeout_override = nil)
       timeout_override || @default_timeout || @parent&.timeout || DEFAULT_TIMEOUT
     end
+
+    def launch_timeout(timeout_override = nil)
+      timeout_override || @default_timeout || @parent&.launch_timeout || DEFAULT_LAUNCH_TIMEOUT
+    end
   end
 end

data/lib/playwright/transport.rb

@@ -43,7 +43,7 @@ module Playwright
     # Terminate playwright-cli driver.
     def stop
       [@stdin, @stdout, @stderr].each { |io| io.close unless io.closed? }
-      @thread&.terminate
+      @thread&.join
     end
 
     # Start `playwright-cli run-driver`

data/lib/playwright/utils.rb

@@ -3,36 +3,6 @@ require 'base64'
 module Playwright
   module Utils
     module PrepareBrowserContextOptions
-      private def prepare_record_har_options(params)
-        out_params = {
-          path: params.delete(:record_har_path)
-        }
-        if params[:record_har_url_filter]
-          opt = params.delete(:record_har_url_filter)
-          if opt.is_a?(Regexp)
-            regex = ::Playwright::JavaScript::Regex.new(opt)
-            out_params[:urlRegexSource] = regex.source
-            out_params[:urlRegexFlags] = regex.flag
-          elsif opt.is_a?(String)
-            out_params[:urlGlob] = opt
-          end
-        end
-        if params[:record_har_mode]
-          out_params[:mode] = params.delete(:record_har_mode)
-        end
-        if params[:record_har_content]
-          out_params[:content] = params.delete(:record_har_content)
-        end
-        if params[:record_har_omit_content]
-          old_api_omit_content = params.delete(:record_har_omit_content)
-          if old_api_omit_content
-            out_params[:content] ||= 'omit'
-          end
-        end
-
-        out_params
-      end
-
       # @see https://github.com/microsoft/playwright/blob/5a2cfdbd47ed3c3deff77bb73e5fac34241f649d/src/client/browserContext.ts#L265
       private def prepare_browser_context_options(params)
         if params[:noViewport] == 0
@@ -42,9 +12,6 @@ module Playwright
         if params[:extraHTTPHeaders]
           params[:extraHTTPHeaders] = ::Playwright::HttpHeaders.new(params[:extraHTTPHeaders]).as_serialized
         end
-        if params[:record_har_path]
-          params[:recordHar] = prepare_record_har_options(params)
-        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.52.0'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.52.0'
+  VERSION = '1.54.0'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.54.1'
 end

data/lib/playwright_api/android.rb

@@ -34,26 +34,31 @@ module Playwright
     #
     # This setting will change the default maximum time for all the methods accepting `timeout` option.
     def set_default_timeout(timeout)
-      raise NotImplementedError.new('set_default_timeout is not implemented yet.')
+      wrap_impl(@impl.set_default_timeout(unwrap_impl(timeout)))
     end
     alias_method :default_timeout=, :set_default_timeout
 
+    # @nodoc
+    def set_default_navigation_timeout(timeout)
+      wrap_impl(@impl.set_default_navigation_timeout(unwrap_impl(timeout)))
+    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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/android_device.rb

@@ -194,14 +194,20 @@ module Playwright
       raise NotImplementedError.new('web_views is not implemented yet.')
     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
+
     # @nodoc
     def should_close_connection_on_close!
       wrap_impl(@impl.should_close_connection_on_close!)
     end
 
+    # -- inherited from EventEmitter --
     # @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)))
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
@@ -216,12 +222,6 @@ module Playwright
       event_emitter_proxy.off(event, callback)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
-    end
-
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/api_request_context.rb

@@ -288,20 +288,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/browser.rb

@@ -205,20 +205,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/browser_context.rb

@@ -80,7 +80,7 @@ module Playwright
     end
 
     #
-    # Returns the browser instance of the context. If it was launched as a persistent context null gets returned.
+    # Gets the browser instance that owns the context. Returns `null` if the context is created outside of normal browser, e.g. Android or Electron.
     def browser
       wrap_impl(@impl.browser)
     end
@@ -474,8 +474,8 @@ module Playwright
     end
 
     # @nodoc
-    def browser=(req)
-      wrap_impl(@impl.browser=(unwrap_impl(req)))
+    def owner_page=(req)
+      wrap_impl(@impl.owner_page=(unwrap_impl(req)))
     end
 
     # @nodoc
@@ -484,26 +484,26 @@ module Playwright
     end
 
     # @nodoc
-    def owner_page=(req)
-      wrap_impl(@impl.owner_page=(unwrap_impl(req)))
+    def browser=(req)
+      wrap_impl(@impl.browser=(unwrap_impl(req)))
     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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/browser_type.rb

@@ -182,20 +182,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/cdp_session.rb

@@ -33,20 +33,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/console_message.rb

@@ -45,10 +45,6 @@ module Playwright
       wrap_impl(@impl.text)
     end
 
-    #
-    # One of the following values: `'log'`, `'debug'`, `'info'`, `'error'`, `'warning'`, `'dir'`, `'dirxml'`, `'table'`,
-    # `'trace'`, `'clear'`, `'startGroup'`, `'startGroupCollapsed'`, `'endGroup'`, `'assert'`, `'profile'`, `'profileEnd'`,
-    # `'count'`, `'timeEnd'`.
     def type
       wrap_impl(@impl.type)
     end

data/lib/playwright_api/dialog.rb

@@ -70,20 +70,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/element_handle.rb

@@ -574,20 +574,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/frame.rb

@@ -487,6 +487,7 @@ module Playwright
     def get_by_test_id(testId)
       wrap_impl(@impl.get_by_test_id(unwrap_impl(testId)))
     end
+    alias_method :get_by_testid, :get_by_test_id
 
     #
     # Allows locating elements that contain given text.
@@ -1038,32 +1039,37 @@ module Playwright
       wrap_impl(@impl.wait_for_url(unwrap_impl(url), timeout: unwrap_impl(timeout), waitUntil: unwrap_impl(waitUntil)))
     end
 
+    # @nodoc
+    def detached=(req)
+      wrap_impl(@impl.detached=(unwrap_impl(req)))
+    end
+
     # @nodoc
     def highlight(selector)
       wrap_impl(@impl.highlight(unwrap_impl(selector)))
     end
 
     # @nodoc
-    def detached=(req)
-      wrap_impl(@impl.detached=(unwrap_impl(req)))
+    def expect(selector, expression, options, title)
+      wrap_impl(@impl.expect(unwrap_impl(selector), unwrap_impl(expression), unwrap_impl(options), unwrap_impl(title)))
     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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/frame_locator.rb

@@ -170,6 +170,7 @@ module Playwright
     def get_by_test_id(testId)
       wrap_impl(@impl.get_by_test_id(unwrap_impl(testId)))
     end
+    alias_method :get_by_testid, :get_by_test_id
 
     #
     # Allows locating elements that contain given text.

data/lib/playwright_api/js_handle.rb

@@ -100,20 +100,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/locator.rb

@@ -103,8 +103,8 @@ module Playwright
     #   - listitem:
     #     - link "About"
     # ```
-    def aria_snapshot(ref: nil, timeout: nil)
-      wrap_impl(@impl.aria_snapshot(ref: unwrap_impl(ref), timeout: unwrap_impl(timeout)))
+    def aria_snapshot(timeout: nil)
+      wrap_impl(@impl.aria_snapshot(timeout: unwrap_impl(timeout)))
     end
 
     #
@@ -274,6 +274,20 @@ module Playwright
       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)))
     end
 
+    #
+    # Describes the locator, description is used in the trace viewer and reports.
+    # Returns the locator pointing to the same element.
+    #
+    # **Usage**
+    #
+    # ```python sync
+    # button = page.get_by_test_id("btn-sub").describe("Subscribe button")
+    # button.click()
+    # ```
+    def describe(description)
+      wrap_impl(@impl.describe(unwrap_impl(description)))
+    end
+
     #
     # Programmatically dispatch an event on the matching element.
     #
@@ -393,6 +407,13 @@ module Playwright
     # If `expression` throws or rejects, this method throws.
     #
     # **Usage**
+    #
+    # Passing argument to `expression`:
+    #
+    # ```python sync
+    # result = page.get_by_testid("myId").evaluate("(element, [x, y]) => element.textContent + ' ' + x * y", [7, 8])
+    # print(result) # prints "myId text 56"
+    # ```
     def evaluate(expression, arg: nil, timeout: nil)
       wrap_impl(@impl.evaluate(unwrap_impl(expression), arg: unwrap_impl(arg), timeout: unwrap_impl(timeout)))
     end
@@ -640,6 +661,7 @@ module Playwright
     def get_by_test_id(testId)
       wrap_impl(@impl.get_by_test_id(unwrap_impl(testId)))
     end
+    alias_method :get_by_testid, :get_by_test_id
 
     #
     # Allows locating elements that contain given text.
@@ -1246,8 +1268,13 @@ module Playwright
     end
 
     # @nodoc
-    def expect(expression, options)
-      wrap_impl(@impl.expect(unwrap_impl(expression), unwrap_impl(options)))
+    def expect(expression, options, title)
+      wrap_impl(@impl.expect(unwrap_impl(expression), unwrap_impl(options), unwrap_impl(title)))
+    end
+
+    # @nodoc
+    def generate_locator_string
+      wrap_impl(@impl.generate_locator_string)
     end
 
     # @nodoc

data/lib/playwright_api/locator_assertions.rb

@@ -355,7 +355,7 @@ module Playwright
     # When an array is passed, the method asserts that the list of elements located matches the corresponding list of expected class lists. Each element's class attribute is matched against the corresponding class in the array:
     #
     # ```html
-    # <div class='list'></div>
+    # <div class='list'>
     #   <div class='component inactive'></div>
     #   <div class='component active'></div>
     #   <div class='component inactive'></div>
@@ -365,7 +365,7 @@ module Playwright
     # ```python sync
     # from playwright.sync_api import expect
     #
-    # locator = page.locator("list > .component")
+    # locator = page.locator(".list > .component")
     # await expect(locator).to_contain_class(["inactive", "active", "inactive"])
     # ```
     def to_contain_class(expected, timeout: nil)
@@ -504,7 +504,7 @@ module Playwright
     # ```python sync
     # from playwright.sync_api import expect
     #
-    # locator = page.locator("list > .component")
+    # locator = page.locator(".list > .component")
     # expect(locator).to_have_class(["component", "component selected", "component"])
     # ```
     def to_have_class(expected, timeout: nil)

data/lib/playwright_api/mouse.rb

@@ -2,6 +2,8 @@ module Playwright
   #
   # The Mouse class operates in main-frame CSS pixels relative to the top-left corner of the viewport.
   #
+  # **NOTE**: If you want to debug where the mouse moved, you can use the [Trace viewer](../trace-viewer-intro.md) or [Playwright Inspector](../running-tests.md). A red dot showing the location of the mouse will be shown for every mouse action.
+  #
   # Every `page` object has its own Mouse, accessible with [`property: Page.mouse`].
   #
   # ```python sync