playwright-ruby-client 1.51.0 → 1.56.0

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.51.0'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.51.0'
+  VERSION = '1.56.0'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.56.1'
 end

data/lib/playwright/web_socket_client.rb

@@ -62,9 +62,12 @@ module Playwright
     STATE_CLOSING = 2
     STATE_CLOSED = 3
 
-    def initialize(url:, max_payload_size:)
+    def initialize(url:, max_payload_size:, headers:)
       @impl = DriverImpl.new(url)
       @driver = ::WebSocket::Driver.client(@impl, max_length: max_payload_size)
+      headers.each do |key, value|
+        @driver.set_header(key, value)
+      end
 
       setup
     end

data/lib/playwright/web_socket_transport.rb

@@ -6,8 +6,9 @@ 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:)
+    def initialize(ws_endpoint:, headers:)
       @ws_endpoint = ws_endpoint
+      @headers = headers
       @debug = ENV['DEBUG'].to_s == 'true' || ENV['DEBUG'].to_s == '1'
     end
 
@@ -63,6 +64,7 @@ module Playwright
       ws = WebSocketClient.new(
         url: @ws_endpoint,
         max_payload_size: 256 * 1024 * 1024, # 256MB
+        headers: @headers,
       )
       promise = Concurrent::Promises.resolvable_future
       ws.on_open do

data/lib/playwright.rb

@@ -102,14 +102,7 @@ module Playwright
     end
   end
 
-  # Connects to Playwright server, launched by `npx playwright run-server` via WebSocket transport.
-  #
-  # Playwright.connect_to_playwright_server(...) do |playwright|
-  #   browser = playwright.chromium.launch
-  #   ...
-  # end
-  #
-  # @experimental
+  # @Deprecated. Playwright >= 1.54 does not support this method.
   module_function def connect_to_playwright_server(ws_endpoint, &block)
     require 'playwright/web_socket_client'
     require 'playwright/web_socket_transport'
@@ -138,7 +131,7 @@ module Playwright
     end
   end
 
-  # Connects to Playwright server, launched by `npx playwright launch-server chromium` or `playwright.chromium.launchServer()`
+  # Connects to Playwright server, launched by `npx playwright launch-server --browser chromium` or `npx playwright run-server`
   #
   # Playwright.connect_to_browser_server('ws://....') do |browser|
   #   page = browser.new_page
@@ -146,11 +139,19 @@ module Playwright
   # end
   #
   # @experimental
-  module_function def connect_to_browser_server(ws_endpoint, &block)
+  module_function def connect_to_browser_server(ws_endpoint, browser_type: 'chromium', &block)
+    known_browser_types = ['chromium', 'firefox', 'webkit']
+    unless known_browser_types.include?(browser_type)
+      raise ArgumentError, "Unknown browser type: #{browser_type}. Known types are: #{known_browser_types.join(', ')}"
+    end
+
     require 'playwright/web_socket_client'
     require 'playwright/web_socket_transport'
 
-    transport = WebSocketTransport.new(ws_endpoint: ws_endpoint)
+    transport = WebSocketTransport.new(
+      ws_endpoint: ws_endpoint,
+      headers: { 'x-playwright-browser' => browser_type },
+    )
     connection = Connection.new(transport)
     connection.mark_as_remote
     connection.async_run
@@ -159,8 +160,7 @@ module Playwright
       begin
         playwright = connection.initialize_playwright
         browser = playwright.send(:pre_launched_browser)
-        browser.send(:update_browser_type, playwright.chromium) # Just workaround for nil reference error.
-        browser.browser_type.send(:did_launch_browser, browser)
+        browser.send(:connect_to_browser_type, playwright.send(browser_type), nil)
         browser.send(:should_close_connection_on_close!)
         Execution.new(connection, PlaywrightApi.wrap(playwright), PlaywrightApi.wrap(browser))
       rescue
@@ -179,7 +179,7 @@ module Playwright
     end
   end
 
-    # Connects to Playwright server, launched by `npx playwright launch-server chromium` or `playwright.chromium.launchServer()`
+  # Connects to Playwright server, launched by `npx playwright launch-server --browser _android` or `playwright._android.launchServer()`
   #
   # Playwright.connect_to_android_server('ws://....') do |browser|
   #   page = browser.new_page

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

@@ -15,6 +15,7 @@ module Playwright
           failOnStatusCode: nil,
           httpCredentials: nil,
           ignoreHTTPSErrors: nil,
+          maxRedirects: nil,
           proxy: nil,
           storageState: nil,
           timeout: nil,

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

@@ -72,15 +72,15 @@ 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
 
     #
-    # 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
@@ -464,23 +464,23 @@ module Playwright
     end
 
     # @nodoc
-    def owner_page=(req)
-      wrap_impl(@impl.owner_page=(unwrap_impl(req)))
+    def enable_debug_console!
+      wrap_impl(@impl.enable_debug_console!)
     end
 
     # @nodoc
-    def options=(req)
-      wrap_impl(@impl.options=(unwrap_impl(req)))
+    def pause
+      wrap_impl(@impl.pause)
     end
 
     # @nodoc
-    def enable_debug_console!
-      wrap_impl(@impl.enable_debug_console!)
+    def owner_page=(req)
+      wrap_impl(@impl.owner_page=(unwrap_impl(req)))
     end
 
     # @nodoc
-    def pause
-      wrap_impl(@impl.pause)
+    def options=(req)
+      wrap_impl(@impl.options=(unwrap_impl(req)))
     end
 
     # @nodoc
@@ -490,20 +490,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_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.
@@ -1043,6 +1044,11 @@ module Playwright
       wrap_impl(@impl.highlight(unwrap_impl(selector)))
     end
 
+    # @nodoc
+    def expect(selector, expression, options, title)
+      wrap_impl(@impl.expect(unwrap_impl(selector), unwrap_impl(expression), unwrap_impl(options), unwrap_impl(title)))
+    end
+
     # @nodoc
     def detached=(req)
       wrap_impl(@impl.detached=(unwrap_impl(req)))
@@ -1050,20 +1056,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_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