playwright-ruby-client 1.51.0 → 1.56.0

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,20 +8,17 @@ 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 = {}
       @timeout_settings = TimeoutSettings.new
       @service_workers = Set.new
-      @background_pages = Set.new
       @owner_page = nil
 
       @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 = {}
 
@@ -29,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'])))
       })
       @channel.on('pageError', ->(params) {
         on_page_error(
@@ -83,14 +77,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
 
@@ -100,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)
 
@@ -212,7 +207,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
@@ -226,12 +222,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 +371,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 +434,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
@@ -531,10 +535,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
@@ -614,5 +614,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
@@ -78,8 +93,22 @@ module Playwright
       context.send(:update_options, context_options: context_options, browser_options: browser_options)
     end
 
-    private def did_launch_browser(browser)
-      browser.send(:update_browser_type, self)
+    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

data/lib/playwright/channel_owners/element_handle.rb

@@ -3,6 +3,11 @@ require_relative './js_handle'
 module Playwright
   module ChannelOwners
     class ElementHandle < JSHandle
+      private def _timeout(timeout)
+        # @parent is Frame
+        @parent.send(:_timeout, timeout)
+      end
+
       def as_element
         self
       end
@@ -69,7 +74,7 @@ module Playwright
 
       def scroll_into_view_if_needed(timeout: nil)
         params = {
-          timeout: timeout,
+          timeout: _timeout(timeout),
         }.compact
         @channel.send_message_to_server('scrollIntoViewIfNeeded', params)
 
@@ -88,7 +93,7 @@ module Playwright
           modifiers: modifiers,
           noWaitAfter: noWaitAfter,
           position: position,
-          timeout: timeout,
+          timeout: _timeout(timeout),
           trial: trial,
         }.compact
         @channel.send_message_to_server('hover', params)
@@ -115,7 +120,7 @@ module Playwright
           modifiers: modifiers,
           noWaitAfter: noWaitAfter,
           position: position,
-          timeout: timeout,
+          timeout: _timeout(timeout),
           trial: trial,
         }.compact
         @channel.send_message_to_server('click', params)
@@ -140,7 +145,7 @@ module Playwright
           modifiers: modifiers,
           noWaitAfter: noWaitAfter,
           position: position,
-          timeout: timeout,
+          timeout: _timeout(timeout),
           trial: trial,
         }.compact
         @channel.send_message_to_server('dblclick', params)
@@ -162,7 +167,7 @@ module Playwright
           value: value,
           label: label,
         ).as_params
-        params = base_params.merge({ force: force, noWaitAfter: noWaitAfter, timeout: timeout }.compact)
+        params = base_params.merge({ force: force, noWaitAfter: noWaitAfter, timeout: _timeout(timeout) }.compact)
         @channel.send_message_to_server('selectOption', params)
       end
 
@@ -179,7 +184,7 @@ module Playwright
           modifiers: modifiers,
           noWaitAfter: noWaitAfter,
           position: position,
-          timeout: timeout,
+          timeout: _timeout(timeout),
           trial: trial,
         }.compact
         @channel.send_message_to_server('tap', params)
@@ -192,7 +197,7 @@ module Playwright
           value: value,
           force: force,
           noWaitAfter: noWaitAfter,
-          timeout: timeout,
+          timeout: _timeout(timeout),
         }.compact
         @channel.send_message_to_server('fill', params)
 
@@ -200,14 +205,14 @@ module Playwright
       end
 
       def select_text(force: nil, timeout: nil)
-        params = { force: force, timeout: timeout }.compact
+        params = { force: force, timeout: _timeout(timeout) }.compact
         @channel.send_message_to_server('selectText', params)
 
         nil
       end
 
       def input_value(timeout: nil)
-        params = { timeout: timeout }.compact
+        params = { timeout: _timeout(timeout) }.compact
         @channel.send_message_to_server('inputValue', params)
       end
 
@@ -218,7 +223,7 @@ module Playwright
         end
 
         method_name, params = InputFiles.new(frame.page.context, files).as_method_and_params
-        params.merge!({ noWaitAfter: noWaitAfter, timeout: timeout }.compact)
+        params.merge!({ noWaitAfter: noWaitAfter, timeout: _timeout(timeout) }.compact)
         @channel.send_message_to_server(method_name, params)
 
         nil
@@ -235,7 +240,7 @@ module Playwright
           text: text,
           delay: delay,
           noWaitAfter: noWaitAfter,
-          timeout: timeout,
+          timeout: _timeout(timeout),
         }.compact
         @channel.send_message_to_server('type', params)
 
@@ -247,7 +252,7 @@ module Playwright
           key: key,
           delay: delay,
           noWaitAfter: noWaitAfter,
-          timeout: timeout,
+          timeout: _timeout(timeout),
         }.compact
         @channel.send_message_to_server('press', params)
 
@@ -259,7 +264,7 @@ module Playwright
           force: force,
           noWaitAfter:  noWaitAfter,
           position: position,
-          timeout: timeout,
+          timeout: _timeout(timeout),
           trial: trial,
         }.compact
         @channel.send_message_to_server('check', params)
@@ -272,7 +277,7 @@ module Playwright
           force: force,
           noWaitAfter:  noWaitAfter,
           position: position,
-          timeout: timeout,
+          timeout: _timeout(timeout),
           trial: trial,
         }.compact
         @channel.send_message_to_server('uncheck', params)
@@ -314,7 +319,7 @@ module Playwright
           quality: quality,
           scale: scale,
           style: style,
-          timeout: timeout,
+          timeout: _timeout(timeout),
           type: type,
         }.compact
         if mask.is_a?(Enumerable)
@@ -352,14 +357,14 @@ module Playwright
       end
 
       def wait_for_element_state(state, timeout: nil)
-        params = { state: state, timeout: timeout }.compact
+        params = { state: state, timeout: _timeout(timeout) }.compact
         @channel.send_message_to_server('waitForElementState', params)
 
         nil
       end
 
       def wait_for_selector(selector, state: nil, strict: nil, timeout: nil)
-        params = { selector: selector, state: state, strict: strict, timeout: timeout }.compact
+        params = { selector: selector, state: state, strict: strict, timeout: _timeout(timeout) }.compact
         resp = @channel.send_message_to_server('waitForSelector', params)
 
         ChannelOwners::ElementHandle.from_nullable(resp)