playwright-ruby-client 1.52.0 → 1.53.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bcda43c43e75e840a897607afdc89d2b01cd463b937944ad33522d7a36713a1
-  data.tar.gz: f92d747e11ef4c55cc9769bc053194a18c2183d13862fe1c7bbb641a6ab6cbfd
+  metadata.gz: 22ec489327d6ba1f70552c2ff0d73b41e4a4ba6c02a898aa608dfe86cfdb3b14
+  data.tar.gz: e41e3084aae362754ad8980bde6ef20e178edc87db72d4e845844802af02d77d
 SHA512:
-  metadata.gz: 246d118dcb834c6d6a266286c1b2758d57e1480f8c40ffec06e2d08401f1e0b87934a8d1701c400053a5a226a81c22a2a4994ce3615a21e46d8ec689cd1289a2
-  data.tar.gz: 1537e5f55e68ff8c11c5d23a1dd1cb973e6aa3df9f8d528e6e93ecc4c744b663a75b8e0cafd38650b39d50d33cd930c3b1c87ebd889ef0cdb7a1481a7ee1c0c2
+  metadata.gz: 3232bcc3f42fc1ab80c1027f1b2af825d21903c9024c8253015d5892dc1f5022a2ef31a9689350e33a4a9e6ce9425a31e55dc38ed75e0142e674c66135ca82f8
+  data.tar.gz: 29497adfd1e1bbcbef55eda2cdbc496e9a270d4500a082a071024afd519f01a9976bae5cc06c63a9c2f1825ca5afe86ed618017356add5015a5e0f15128bc72d

data/documentation/docs/api/experimental/android.md

@@ -30,3 +30,13 @@ def devices(host: nil, omitDriverInstall: nil, port: nil)
 
 
 Returns the list of detected Android devices.
+
+## set_default_timeout
+
+```
+def set_default_timeout(timeout)
+```
+alias: `default_timeout=`
+
+
+This setting will change the default maximum time for all the methods accepting `timeout` option.

data/documentation/docs/api/locator.md

@@ -87,7 +87,7 @@ button = page.get_by_role("button").and(page.get_by_title("Subscribe"))
 ## aria_snapshot
 
 ```
-def aria_snapshot(ref: nil, timeout: nil)
+def aria_snapshot(timeout: nil)
 ```
 
 
@@ -317,6 +317,23 @@ When all steps combined have not finished during the specified `timeout`, this m
 
 **NOTE**: `element.dblclick()` dispatches two `click` events and a single `dblclick` event.
 
+## describe
+
+```
+def describe(description)
+```
+
+
+Describes the locator, description is used in the trace viewer and reports.
+Returns the locator pointing to the same element.
+
+**Usage**
+
+```ruby
+button = page.get_by_test_id("btn-sub").describe("Subscribe button")
+button.click
+```
+
 ## dispatch_event
 
 ```
@@ -458,6 +475,12 @@ If `expression` throws or rejects, this method throws.
 
 **Usage**
 
+Passing argument to `expression`:
+
+```ruby
+page.get_by_test_id("myId").evaluate("(element, [x, y]) => element.textContent + ' ' + x * y", arg: [7, 8]) # => "myId text 56"
+```
+
 ## evaluate_all
 
 ```

data/documentation/docs/api/locator_assertions.md

@@ -470,7 +470,7 @@ expect(locator).to contain_class("row middle")
 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>
@@ -615,13 +615,10 @@ Ensures the [Locator](./locator) points to an element with given CSS classes. Wh
 <div class='middle selected row' id='component'></div>
 ```
 
-```python title="example_a596f37c41d76277b59ed7eb46969c178c89770d0da91bdff20f36d438aa32cd.py"
-from playwright.sync_api import expect
-
+```ruby
 locator = page.locator("#component")
-expect(locator).to_have_class("middle selected row")
-expect(locator).to_have_class(re.compile(r"(^|\\s)selected(\\s|$)"))
-
+expect(locator).to have_class(/(^|\s)selected(\s|$)/)
+expect(locator).to have_class("middle selected row")
 ```
 
 When an array is passed, the method asserts that the list of elements located matches the corresponding list of expected class values. Each element's class attribute is matched against the corresponding string or regular expression in the array:

data/documentation/docs/api/page.md

@@ -1820,7 +1820,7 @@ function will throw.
 This method works across navigations:
 
 ```ruby
-%w[https://google.com https://bbc.com].each do |current_url|
+%w[https://playwright.dev/ https://playwright-ruby-client.vercel.app/].each do |current_url|
   page.goto(current_url, waitUntil: "domcontentloaded")
   element = page.wait_for_selector("img")
   puts "Loaded image: #{element["src"]}"

data/documentation/docs/api/selectors.md

@@ -51,3 +51,13 @@ playwright.chromium.launch do |browser|
   button_count # => 1
 end
 ```
+
+## set_test_id_attribute
+
+```
+def set_test_id_attribute(attributeName)
+```
+alias: `test_id_attribute=`
+
+
+Defines custom attribute name to be used in [Page#get_by_test_id](./page#get_by_test_id). `data-testid` is used by default.

data/documentation/docs/api/tracing.md

@@ -7,6 +7,10 @@ sidebar_position: 10
 
 API for collecting and saving Playwright traces. Playwright traces can be opened in [Trace Viewer](https://playwright.dev/python/docs/trace-viewer) after Playwright script runs.
 
+**NOTE**: You probably want to [enable tracing in your config file](https://playwright.dev/docs/api/class-testoptions#test-options-trace) instead of using `context.tracing`.
+
+The `context.tracing` API captures browser operations and network activity, but it doesn't record test assertions (like `expect` calls). We recommend [enabling tracing through Playwright Test configuration](https://playwright.dev/docs/api/class-testoptions#test-options-trace), which includes those assertions and provides a more complete trace for debugging test failures.
+
 Start recording a trace before performing actions. At the end, stop tracing and save it to a file.
 
 ```ruby
@@ -32,6 +36,10 @@ def start(
 
 Start tracing.
 
+**NOTE**: You probably want to [enable tracing in your config file](https://playwright.dev/docs/api/class-testoptions#test-options-trace) instead of using `Tracing.start`.
+
+The `context.tracing` API captures browser operations and network activity, but it doesn't record test assertions (like `expect` calls). We recommend [enabling tracing through Playwright Test configuration](https://playwright.dev/docs/api/class-testoptions#test-options-trace), which includes those assertions and provides a more complete trace for debugging test failures.
+
 **Usage**
 
 ```ruby

data/documentation/docs/include/api_coverage.md

@@ -212,7 +212,7 @@
 ## Selectors
 
 * register
-* ~~set_test_id_attribute~~
+* set_test_id_attribute
 
 ## Clock
 
@@ -455,6 +455,7 @@
 * click
 * count
 * dblclick
+* describe
 * dispatch_event
 * drag_to
 * element_handle
@@ -617,7 +618,7 @@
 
 * ~~connect~~
 * devices
-* ~~set_default_timeout~~
+* set_default_timeout
 
 ## AndroidDevice
 

data/lib/playwright/channel.rb

@@ -29,9 +29,9 @@ module Playwright
     # @param method [String]
     # @param params [Hash]
     # @return [Hash]
-    def send_message_to_server_result(method, params)
+    def send_message_to_server_result(title = nil, method, params)
       check_not_collected
-      with_logging do |metadata|
+      with_logging(title) do |metadata|
         @connection.send_message_to_server(@guid, method, params, metadata: metadata)
       end
     end
@@ -46,7 +46,7 @@ module Playwright
       end
     end
 
-    private def with_logging(&block)
+    private def with_logging(title = nil, &block)
       locations = caller_locations
       first_api_call_location_idx = locations.index { |loc| loc.absolute_path&.include?('playwright_api') }
       unless first_api_call_location_idx
@@ -64,6 +64,9 @@ module Playwright
       stacks = locations
 
       metadata = build_metadata_payload_from(api_name, stacks)
+      if title
+        metadata[:title] = title
+      end
       block.call(metadata)
     end
 

data/lib/playwright/channel_owners/android.rb

@@ -4,6 +4,18 @@ module Playwright
       @timeout_settings = TimeoutSettings.new
     end
 
+    def set_default_navigation_timeout(timeout)
+      @timeout_settings.default_navigation_timeout = timeout
+    end
+
+    def set_default_timeout(timeout)
+      @timeout_settings.default_timeout = timeout
+    end
+
+    private def _timeout_settings
+      @timeout_settings
+    end
+
     def devices(host: nil, omitDriverInstall: nil, port: nil)
       params = { host: host, port: port, omitDriverInstall: omitDriverInstall }.compact
       resp = @channel.send_message_to_server('devices', params)

data/lib/playwright/channel_owners/android_device.rb

@@ -5,6 +5,7 @@ module Playwright
     private def after_initialize
       @input = AndroidInputImpl.new(@channel)
       @should_close_connection_on_close = false
+      @timeout_settings = @parent.send(:_timeout_settings)
     end
 
     def should_close_connection_on_close!
@@ -46,9 +47,9 @@ module Playwright
         enabled: selector[:enabled],
         focusable: selector[:focusable],
         focused: selector[:focused],
-        hasChild: selector[:hasChild] ? { selector: to_selector_channel(selector[:hasChild][:selector]) } : nil,
+        hasChild: selector[:hasChild] ? { androidSelector: to_selector_channel(selector[:hasChild][:selector]) } : nil,
         hasDescendant: selector[:hasDescendant] ? {
-          selector: to_selector_channel(selector[:hasDescendant][:selector]),
+          androidSelector: to_selector_channel(selector[:hasDescendant][:selector]),
           maxDepth: selector[:hasDescendant][:maxDepth],
         } : nil,
         longClickable: selector[:longClickable],
@@ -59,15 +60,15 @@ module Playwright
 
     def tap_on(selector, duration: nil, timeout: nil)
       params = {
-        selector: to_selector_channel(selector),
+        androidSelector: to_selector_channel(selector),
         duration: duration,
-        timeout: timeout,
+        timeout: @timeout_settings.timeout(timeout),
       }.compact
       @channel.send_message_to_server('tap', params)
     end
 
     def info(selector)
-      @channel.send_message_to_server('info', selector: to_selector_channel(selector))
+      @channel.send_message_to_server('info', androidSelector: to_selector_channel(selector))
     end
 
     def screenshot(path: nil)

data/lib/playwright/channel_owners/api_request_context.rb

@@ -5,6 +5,11 @@ module Playwright
   define_channel_owner :APIRequestContext do
     private def after_initialize
       @tracing = ChannelOwners::Tracing.from(@initializer['tracing'])
+      @timeout_settings = TimeoutSettings.new
+    end
+
+    private def _update_timeout_settings(timeout_settings)
+      @timeout_settings = timeout_settings
     end
 
     def dispose(reason: nil)
@@ -156,7 +161,7 @@ module Playwright
       fetch_params[:jsonData] = json_data
       fetch_params[:formData] = form_data
       fetch_params[:multipartData] = multipart_data
-      fetch_params[:timeout] = timeout
+      fetch_params[:timeout] = @timeout_settings.timeout(timeout)
       fetch_params[:failOnStatusCode] = failOnStatusCode
       fetch_params[:ignoreHTTPSErrors] = ignoreHTTPSErrors
       fetch_params[:maxRedirects] = maxRedirects

data/lib/playwright/channel_owners/browser.rb

@@ -7,11 +7,11 @@ module Playwright
     include Utils::PrepareBrowserContextOptions
 
     private def after_initialize
-      @browser_type = @parent
       @connected = true
       @should_close_connection_on_close = false
 
       @contexts = Set.new
+      @channel.on('context', ->(params) { did_create_context(ChannelOwners::BrowserContext.from(params['context'])) })
       @channel.on('close', method(:on_close))
       @close_reason = nil
     end
@@ -34,10 +34,18 @@ module Playwright
 
     def new_context(**options, &block)
       params = options.dup
+      @browser_type.send(:update_with_playwright_selectors_options, params)
       prepare_browser_context_options(params)
 
       resp = @channel.send_message_to_server('newContext', params.compact)
       context = ChannelOwners::BrowserContext.from(resp)
+      context.send(:initialize_har_from_options,
+        record_har_content: params[:record_har_content],
+        record_har_mode: params[:record_har_mode],
+        record_har_omit_content: params[:record_har_omit_content],
+        record_har_path: params[:record_har_path],
+        record_har_url_filter: params[:record_har_url_filter],
+      )
       @browser_type.send(:did_create_context, context, params)
       return context unless block
 
@@ -63,10 +71,6 @@ module Playwright
       end
     end
 
-    private def update_browser_type(browser_type)
-      @browser_type = browser_type
-    end
-
     def close(reason: nil)
       @close_reason = reason
       if @should_close_connection_on_close
@@ -111,13 +115,40 @@ module Playwright
       data
     end
 
+    # called from BrowserType
+    private def connect_to_browser_type(browser_type, traces_dir)
+      # Note: when using connect(), `browserType` is different from `this.parent`.
+      # This is why browser type is not wired up in the constructor, and instead this separate method is called later on.
+      @browser_type = browser_type
+      @traces_dir = traces_dir
+      @contexts.each do |context|
+        setup_browser_context(context)
+      end
+    end
+
+    private def did_create_context(context)
+      context.browser = self
+      @contexts << context
+
+      # Note: when connecting to a browser, initial contexts arrive before `_browserType` is set,
+      # and will be configured later in `ConnectToBrowserType`.
+      if @browser_type
+        setup_browser_context(context)
+      end
+    end
+
+    private def setup_browser_context(context)
+      context.tracing.send(:update_traces_dir, @traces_dir)
+      @browser_type.send(:playwright_selectors_browser_contexts) << context
+    end
+
     private def on_close(_ = {})
       @connected = false
       emit(Events::Browser::Disconnected, self)
       @closed_or_closing = true
     end
 
-    # called from BrowserContext#initialize, BrowserType#connectOverCDP
+    # called from BrowserContext#initialize
     private def add_context(context)
       @contexts << context
     end

data/lib/playwright/channel_owners/browser_context.rb

@@ -8,10 +8,7 @@ module Playwright
     attr_reader :clock, :tracing, :request
 
     private def after_initialize
-      if @parent.is_a?(ChannelOwners::Browser)
-        @browser = @parent
-        @browser.send(:add_context, self)
-      end
+      @options = @initializer['options']
       @pages = Set.new
       @routes = []
       @bindings = {}
@@ -22,6 +19,7 @@ module Playwright
 
       @tracing = ChannelOwners::Tracing.from(@initializer['tracing'])
       @request = ChannelOwners::APIRequestContext.from(@initializer['requestContext'])
+      @request.send(:_update_timeout_settings, @timeout_settings)
       @clock = ClockImpl.new(self)
       @har_recorders = {}
 
@@ -83,14 +81,20 @@ module Playwright
       @close_was_called = false
     end
 
+    private def initialize_har_from_options(record_har_path:, record_har_content:, record_har_omit_content:, record_har_url_filter:, record_har_mode:)
+      return unless record_har_path
+
+      default_policy = record_har_path.end_with?('.zip') ? 'attach' : 'embed'
+      content_policy = record_har_content || (record_har_omit_content ? 'omit' : default_policy)
+      record_into_har(record_har_path, nil,
+        url: record_har_url_filter,
+        update_content: content_policy,
+        update_mode: record_har_mode || 'full',
+      )
+    end
+
     private def update_options(context_options:, browser_options:)
       @options = context_options
-      if @options[:recordHar]
-        @har_recorders[''] = {
-          path: @options[:recordHar][:path],
-          content: @options[:recordHar][:content]
-        }
-      end
       @tracing.send(:update_traces_dir, browser_options[:tracesDir])
     end
 
@@ -226,12 +230,10 @@ module Playwright
 
     def set_default_navigation_timeout(timeout)
       @timeout_settings.default_navigation_timeout = timeout
-      @channel.send_message_to_server('setDefaultNavigationTimeoutNoReply', timeout: timeout)
     end
 
     def set_default_timeout(timeout)
       @timeout_settings.default_timeout = timeout
-      @channel.send_message_to_server('setDefaultTimeoutNoReply', timeout: timeout)
     end
 
     def pages
@@ -377,25 +379,32 @@ module Playwright
       update_interception_patterns
     end
 
-    private def record_into_har(har, page, notFound:, url:, updateContent:, updateMode:)
-      params = {
-        options: prepare_record_har_options(
-          record_har_path: har,
-          record_har_content: updateContent || 'attach',
-          record_har_mode: updateMode || 'minimal',
-          record_har_url_filter: url,
-        )
+    private def record_into_har(har, page, url:, update_content:, update_mode:)
+      options = {
+        zip: har.end_with?('.zip'),
+        content: update_content || 'attach',
       }
+
+      if url.is_a?(Regexp)
+        regex = ::Playwright::JavaScript::Regex.new(url)
+        options[:urlRegexSource] = regex.source
+        options[:urlRegexFlags] = regex.flag
+      elsif url.is_a?(String)
+        options[:urlGlob] = url
+      end
+
+      params = { options: options }
       if page
         params[:page] = page.channel
       end
+
       har_id = @channel.send_message_to_server('harStart', params)
-      @har_recorders[har_id] = { path: har, content: 'attach' }
+      @har_recorders[har_id] = { path: har, content: update_content || 'attach' }
     end
 
     def route_from_har(har, notFound: nil, update: nil, updateContent: nil, updateMode: nil, url: nil)
       if update
-        record_into_har(har, nil, notFound: notFound, url: url, updateContent: updateContent, updateMode: updateMode)
+        record_into_har(har, nil, url: url, update_content: updateContent, update_mode: updateMode)
         return
       end
 
@@ -433,7 +442,10 @@ module Playwright
     end
 
     private def on_close
-      @browser&.send(:remove_context, self)
+      if @browser
+        @browser.send(:remove_context, self)
+        @browser.browser_type.send(:playwright_selectors_browser_contexts).delete(self)
+      end
       emit(Events::BrowserContext::Close)
       @closed_promise.fulfill(true)
     end
@@ -614,5 +626,14 @@ module Playwright
     private def clock_set_system_time(time_params)
       @channel.send_message_to_server('clockSetSystemTime', time_params)
     end
+
+    private def register_selector_engine(selector_engine)
+      @channel.send_message_to_server('registerSelectorEngine', { selectorEngine: selector_engine })
+    end
+
+    private def set_test_id_attribute_name(test_id_attribute_name)
+      @channel.send_message_to_server('setTestIdAttributeName', { testIdAttributeName: test_id_attribute_name })
+      ::Playwright::LocatorUtils.instance_variable_set(:@test_id_attribute_name, test_id_attribute_name)
+    end
   end
 end

data/lib/playwright/channel_owners/browser_type.rb

@@ -2,6 +2,14 @@ module Playwright
   define_channel_owner :BrowserType do
     include Utils::PrepareBrowserContextOptions
 
+    private def after_initialize
+      @timeout_settings = TimeoutSettings.new
+    end
+
+    private def update_playwright(playwright)
+      @playwright = playwright
+    end
+
     def name
       @initializer['name']
     end
@@ -11,9 +19,11 @@ module Playwright
     end
 
     def launch(options, &block)
-      resp = @channel.send_message_to_server('launch', options.compact)
+      params = options.dup
+      params[:timeout] ||= @timeout_settings.launch_timeout
+      resp = @channel.send_message_to_server('launch', params.compact)
       browser = ChannelOwners::Browser.from(resp)
-      did_launch_browser(browser)
+      browser.send(:connect_to_browser_type, self, params[:tracesDir])
       return browser unless block
 
       begin
@@ -27,10 +37,20 @@ module Playwright
       params = options.dup
       prepare_browser_context_options(params)
       params['userDataDir'] = userDataDir
+      params[:timeout] ||= @timeout_settings.launch_timeout
+
+      result = @channel.send_message_to_server_result('launchPersistentContext', params.compact)
+      browser = ChannelOwners::Browser.from(result['browser'])
+      browser.send(:connect_to_browser_type, self, params[:tracesDir])
+      context = ChannelOwners::BrowserContext.from(result['context'])
+      context.send(:initialize_har_from_options,
+        record_har_content: params[:record_har_content],
+        record_har_mode: params[:record_har_mode],
+        record_har_omit_content: params[:record_har_omit_content],
+        record_har_path: params[:record_har_path],
+        record_har_url_filter: params[:record_har_url_filter],
+      )
 
-      resp = @channel.send_message_to_server('launchPersistentContext', params.compact)
-      context = ChannelOwners::Browser.from(resp)
-      did_create_context(context, params, params)
       return context unless block
 
       begin
@@ -47,7 +67,7 @@ module Playwright
         endpointURL: endpointURL,
         headers: headers,
         slowMo: slowMo,
-        timeout: timeout,
+        timeout: @timeout_settings.timeout(timeout),
       }.compact
 
       if headers
@@ -56,12 +76,7 @@ module Playwright
 
       result = @channel.send_message_to_server_result('connectOverCDP', params)
       browser = ChannelOwners::Browser.from(result['browser'])
-      did_launch_browser(browser)
-
-      if result['defaultContext']
-        default_context = ChannelOwners::BrowserContext.from(result['defaultContext'])
-        did_create_context(default_context)
-      end
+      browser.send(:connect_to_browser_type, self, nil)
 
       if block
         begin
@@ -81,5 +96,23 @@ module Playwright
     private def did_launch_browser(browser)
       browser.send(:update_browser_type, self)
     end
+
+    private def update_with_playwright_selectors_options(options)
+      selectors = @playwright&.selectors
+      if selectors
+        selectors.send(:update_with_selector_options, options)
+      else
+        options
+      end
+    end
+
+    private def playwright_selectors_browser_contexts
+      selectors = @playwright&.selectors
+      if selectors
+        selectors.send(:contexts_for_selectors)
+      else
+        []
+      end
+    end
   end
 end