playwright-ruby-client 1.61.0 → 1.63.0

data/lib/playwright/frame_locator_impl.rb

@@ -13,6 +13,21 @@ module Playwright
       @frame.send(:_timeout, timeout)
     end
 
+    private def child_selector(selector)
+      if @frame_selector == 'internal:control=any-frame'
+        "#{@frame_selector} >> #{selector}"
+      else
+        "#{@frame_selector} >> internal:control=enter-frame >> #{selector}"
+      end
+    end
+
+    private def nth_selector(index)
+      if @frame_selector == 'internal:control=any-frame'
+        raise 'Selecting the nth frame is not allowed on frameLocator().'
+      end
+      "#{@frame_selector} >> nth=#{index}"
+    end
+
     def locator(
       selector,
       has: nil,
@@ -21,7 +36,7 @@ module Playwright
       hasText: nil)
       LocatorImpl.new(
         frame: @frame,
-        selector: "#{@frame_selector} >> internal:control=enter-frame >> #{selector}",
+        selector: child_selector(selector),
         has: has,
         hasNot: hasNot,
         hasNotText: hasNotText,
@@ -38,28 +53,28 @@ module Playwright
     def frame_locator(selector)
       FrameLocatorImpl.new(
         frame: @frame,
-        frame_selector: "#{@frame_selector} >> internal:control=enter-frame >> #{selector}",
+        frame_selector: child_selector(selector),
       )
     end
 
     def first
       FrameLocatorImpl.new(
         frame: @frame,
-        frame_selector: "#{@frame_selector} >> nth=0",
+        frame_selector: nth_selector(0),
       )
     end
 
     def last
       FrameLocatorImpl.new(
         frame: @frame,
-        frame_selector: "#{@frame_selector} >> nth=-1",
+        frame_selector: nth_selector(-1),
       )
     end
 
     def nth(index)
       FrameLocatorImpl.new(
         frame: @frame,
-        frame_selector: "#{@frame_selector} >> nth=#{index}",
+        frame_selector: nth_selector(index),
       )
     end
   end

data/lib/playwright/locator_assertions_impl.rb

@@ -214,7 +214,20 @@ module Playwright
     end
     _define_negation :to_have_accessible_error_message
 
-    def to_have_attribute(name, value, ignoreCase: nil, timeout: nil)
+    def to_have_attribute(name, value: nil, ignoreCase: nil, timeout: nil)
+      if value.nil?
+        return expect_impl(
+          'to.have.attribute',
+          {
+            expressionArg: name,
+            timeout: timeout,
+          },
+          nil,
+          'Locator expected to have attribute',
+          'Expect "to_have_attribute"',
+        )
+      end
+
       expected_text = to_expected_text_values([value], ignore_case: ignoreCase)
       expect_impl(
         "to.have.attribute.value",

data/lib/playwright/locator_impl.rb

@@ -105,6 +105,7 @@ module Playwright
           force: nil,
           noWaitAfter: nil,
           position: nil,
+          scroll: nil,
           timeout: nil,
           trial: nil)
 
@@ -113,6 +114,7 @@ module Playwright
         force: force,
         noWaitAfter: noWaitAfter,
         position: position,
+        scroll: scroll,
         timeout: timeout,
         trial: trial)
     end
@@ -125,6 +127,7 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
+          scroll: nil,
           timeout: nil,
           trial: nil,
           steps: nil)
@@ -138,6 +141,7 @@ module Playwright
         modifiers: modifiers,
         noWaitAfter: noWaitAfter,
         position: position,
+        scroll: scroll,
         timeout: timeout,
         trial: trial,
         steps: steps)
@@ -150,6 +154,7 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
+          scroll: nil,
           timeout: nil,
           trial: nil,
           steps: nil)
@@ -162,6 +167,7 @@ module Playwright
         modifiers: modifiers,
         noWaitAfter: noWaitAfter,
         position: position,
+        scroll: scroll,
         timeout: timeout,
         trial: trial,
         steps: steps)
@@ -174,6 +180,7 @@ module Playwright
     def drag_to(target,
           force: nil,
           noWaitAfter: nil,
+          scroll: nil,
           sourcePosition: nil,
           targetPosition: nil,
           timeout: nil,
@@ -185,6 +192,7 @@ module Playwright
         target.instance_variable_get(:@selector),
         force: force,
         noWaitAfter: noWaitAfter,
+        scroll: scroll,
         sourcePosition: sourcePosition,
         targetPosition: targetPosition,
         timeout: timeout,
@@ -288,6 +296,10 @@ module Playwright
       )
     end
 
+    def visible
+      filter(visible: true)
+    end
+
     def first
       LocatorImpl.new(
         frame: @frame,
@@ -363,6 +375,7 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
+          scroll: nil,
           timeout: nil,
           trial: nil)
       @frame.hover(@selector,
@@ -371,6 +384,7 @@ module Playwright
         modifiers: modifiers,
         noWaitAfter: noWaitAfter,
         position: position,
+        scroll: scroll,
         timeout: timeout,
         trial: trial)
     end
@@ -426,7 +440,7 @@ module Playwright
       end
     end
 
-    def aria_snapshot(boxes: nil, depth: nil, mode: nil, timeout: nil, _track: nil)
+    def aria_snapshot(boxes: nil, depth: nil, mode: nil, timeout: nil)
       params = {
         selector: @selector,
         timeout: _timeout(timeout),
@@ -434,10 +448,6 @@ module Playwright
       params[:boxes] = boxes unless boxes.nil?
       params[:depth] = depth if depth
       params[:mode] = mode if mode
-      if _track
-        params.delete(:selector)
-        params[:track] = _track
-      end
       result = @frame.channel.send_message_to_server_result('ariaSnapshot', params.compact)
       result['snapshot']
     end
@@ -499,6 +509,7 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
+          scroll: nil,
           timeout: nil,
           trial: nil)
       @frame.tap_point(@selector,
@@ -507,6 +518,7 @@ module Playwright
         modifiers: modifiers,
         noWaitAfter: noWaitAfter,
         position: position,
+        scroll: scroll,
         timeout: timeout,
         trial: trial)
     end
@@ -527,6 +539,7 @@ module Playwright
           force: nil,
           noWaitAfter: nil,
           position: nil,
+          scroll: nil,
           timeout: nil,
           trial: nil)
       @frame.uncheck(@selector,
@@ -534,10 +547,24 @@ module Playwright
         force: force,
         noWaitAfter: noWaitAfter,
         position: position,
+        scroll: scroll,
         timeout: timeout,
         trial: trial)
     end
 
+    def wait_for_function(expression, arg: nil, timeout: nil)
+      @frame.channel.send_message_to_server(
+        'waitForFunction',
+        selector: @selector,
+        strict: true,
+        expression: expression,
+        isFunction: true,
+        arg: JavaScript::ValueSerializer.new(arg).serialize,
+        timeout: _timeout(timeout),
+      )
+      nil
+    end
+
     def wait_for(state: nil, timeout: nil)
       @frame.wait_for_selector(@selector, strict: true, state: state, timeout: timeout)
     end

data/lib/playwright/screencast.rb

@@ -86,12 +86,26 @@ module Playwright
     end
 
     private def handle_screencast_frame(event)
-      @on_frame&.call({
-        data: Base64.strict_decode64(event['data']),
-        timestamp: event['timestamp'],
-        viewportWidth: event['viewportWidth'],
-        viewportHeight: event['viewportHeight'],
-      })
+      on_frame = @on_frame
+      Thread.new do
+        begin
+          on_frame&.call({
+            data: Base64.strict_decode64(event['data']),
+            timestamp: event['timestamp'],
+            viewportWidth: event['viewportWidth'],
+            viewportHeight: event['viewportHeight'],
+          })
+        ensure
+          begin
+            @page.send(:channel).async_send_message_to_server(
+              'screencastFrameAck',
+              frameId: event['frameId'],
+            )
+          rescue Transport::AlreadyDisconnectedError
+            # The page or driver may close while a callback is running.
+          end
+        end
+      end
     end
   end
 end

data/lib/playwright/screenshot_utils.rb

@@ -0,0 +1,24 @@
+require 'mime/types'
+
+module Playwright
+  module ScreenshotUtils
+    module_function
+
+    def determine_type(path:, type:)
+      return type if type
+      return nil unless path
+
+      mime_type = MIME::Types.type_for(path).first
+      case mime_type&.content_type
+      when 'image/png'
+        'png'
+      when 'image/jpeg'
+        'jpeg'
+      when 'image/webp'
+        'webp'
+      else
+        raise ArgumentError.new("path: unsupported mime type \"#{mime_type}\"")
+      end
+    end
+  end
+end

data/lib/playwright/test.rb

@@ -30,7 +30,7 @@ module Playwright
         end
 
         def matches?(actual)
-          assertions_for(actual, false).send(@method, *@args, **@kwargs)
+          call_assertion(actual, false)
           true
         rescue AssertionError => e
           @failure_message = e.full_message
@@ -38,7 +38,7 @@ module Playwright
         end
 
         def does_not_match?(actual)
-          assertions_for(actual, true).send(@method, *@args, **@kwargs)
+          call_assertion(actual, true)
           true
         rescue AssertionError => e
           @failure_message = e.full_message
@@ -55,6 +55,16 @@ module Playwright
 
         private
 
+        def call_assertion(actual, is_not)
+          args = @args
+          kwargs = @kwargs
+          if ['to_have_attribute', 'not_to_have_attribute'].include?(@method) && args.length == 2 && !kwargs.key?(:value)
+            args = [args.first]
+            kwargs = kwargs.merge(value: @args.last)
+          end
+          assertions_for(actual, is_not).send(@method, *args, **kwargs)
+        end
+
         def assertions_for(actual, is_not)
           if actual.respond_to?(:_assertions)
             actual._assertions(::Playwright::Test.expect_timeout, is_not, nil)

data/lib/playwright/url_matcher.rb

@@ -23,7 +23,7 @@ module Playwright
     def match?(target_url)
       case @url
       when String
-        joined_url == target_url || File.fnmatch?(@url, target_url)
+        joined_url == target_url || File.fnmatch?(joined_url, target_url)
       when Regexp
         @url.match?(target_url)
       else
@@ -32,13 +32,129 @@ module Playwright
     end
 
     private def joined_url
-      if @base_url && !@url.start_with?('*')
-        URI.join(@base_url, @url).to_s
+      normalized_url = normalize_literal_url(@url)
+      if @base_url && !normalized_url.start_with?('*')
+        normalize_literal_url(URI.join(normalize_literal_url(@base_url), normalized_url).to_s)
       else
-        @url
+        normalized_url
       end
     end
 
+    private def normalize_literal_url(url)
+      match = url.match(/\A([a-z][a-z0-9+.-]*):\/\/([^\/?#]*)(.*)\z/i)
+      return percent_encode_literal_characters(url) unless match
+
+      scheme = match[1].downcase
+      authority = match[2]
+      suffix = percent_encode_literal_characters(match[3])
+
+      before, separator, after = authority.rpartition('@')
+      if separator.empty?
+        userinfo = nil
+        host_port = authority
+      else
+        userinfo = before
+        host_port = after
+      end
+
+      if host_port.start_with?('[')
+        host = host_port
+        port = nil
+      else
+        host, separator, candidate_port = host_port.rpartition(':')
+        if separator.empty? || candidate_port !~ /\A\d+\z/
+          host = host_port
+          port = nil
+        else
+          port = candidate_port
+        end
+        host = host.split('.').map { |label| punycode_label(label.downcase) }.join('.')
+      end
+
+      port = nil if (scheme == 'http' && port == '80') || (scheme == 'https' && port == '443')
+      normalized_authority = String.new
+      normalized_authority << "#{userinfo}@" if userinfo
+      normalized_authority << host
+      normalized_authority << ":#{port}" if port
+      "#{scheme}://#{normalized_authority}#{suffix}"
+    end
+
+    private def percent_encode_literal_characters(value)
+      value.each_char.map do |char|
+        if char == ' '
+          '%20'
+        elsif char.ascii_only?
+          char
+        else
+          char.encode(Encoding::UTF_8).bytes.map { |byte| format('%%%02X', byte) }.join
+        end
+      end.join
+    end
+
+    # RFC 3492 Punycode encoder for the non-ASCII URL host labels normalized by WHATWG URL.
+    private def punycode_label(label)
+      return label if label.ascii_only?
+
+      codepoints = label.codepoints
+      output = codepoints.select { |codepoint| codepoint < 0x80 }.map(&:chr).join
+      basic_length = output.length
+      output << '-' if basic_length > 0
+
+      handled = basic_length
+      n = 128
+      delta = 0
+      bias = 72
+      while handled < codepoints.length
+        next_codepoint = codepoints.select { |codepoint| codepoint >= n }.min
+        delta += (next_codepoint - n) * (handled + 1)
+        n = next_codepoint
+
+        codepoints.each do |codepoint|
+          delta += 1 if codepoint < n
+          next unless codepoint == n
+
+          q = delta
+          k = 36
+          loop do
+            threshold = if k <= bias
+                          1
+                        elsif k >= bias + 26
+                          26
+                        else
+                          k - bias
+                        end
+            break if q < threshold
+
+            output << punycode_digit(threshold + ((q - threshold) % (36 - threshold)))
+            q = (q - threshold) / (36 - threshold)
+            k += 36
+          end
+          output << punycode_digit(q)
+          bias = adapt_punycode_bias(delta, handled + 1, handled == basic_length)
+          delta = 0
+          handled += 1
+        end
+        delta += 1
+        n += 1
+      end
+      "xn--#{output}"
+    end
+
+    private def punycode_digit(value)
+      value < 26 ? (value + 97).chr : (value - 26 + 48).chr
+    end
+
+    private def adapt_punycode_bias(delta, points, first_time)
+      delta = first_time ? delta / 700 : delta / 2
+      delta += delta / points
+      k = 0
+      while delta > 455
+        delta /= 35
+        k += 36
+      end
+      k + ((36 * delta) / (delta + 38))
+    end
+
     private def validate_glob_pattern
       in_group = false
       escaped = false

data/lib/playwright/utils.rb

@@ -18,9 +18,21 @@ module Playwright
   end
 
   module Utils
+    module PrepareHttpCredentials
+      private def prepare_http_credentials(credentials)
+        return nil unless credentials
+
+        list = credentials.is_a?(Array) ? credentials : [credentials]
+        list.empty? ? nil : list
+      end
+    end
+
     module PrepareBrowserContextOptions
+      include PrepareHttpCredentials
+
       # @see https://github.com/microsoft/playwright/blob/5a2cfdbd47ed3c3deff77bb73e5fac34241f649d/src/client/browserContext.ts#L265
       private def prepare_browser_context_options(params)
+        params[:httpCredentials] = prepare_http_credentials(params[:httpCredentials])
         if params[:noViewport] == 0
           params.delete(:noViewport)
           params[:noDefaultViewport] = true

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.61.0'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.61.1'
+  VERSION = '1.63.0'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.63.0'
 end

data/lib/playwright.rb

@@ -138,7 +138,7 @@ module Playwright
     end
   end
 
-  # Connects to Playwright server, launched by `npx playwright launch-server --browser chromium` or `npx playwright run-server`
+  # Connects to Playwright server, launched by `playwright-core launch-server --browser chromium` or `playwright-core run-server`
   #
   # Playwright.connect_to_browser_server('ws://....') do |browser|
   #   page = browser.new_page
@@ -186,7 +186,7 @@ module Playwright
     end
   end
 
-  # Connects to Playwright server, launched by `npx playwright launch-server --browser _android` or `playwright._android.launchServer()`
+  # Connects to Playwright server, launched by `playwright-core launch-server --browser _android` or `playwright._android.launchServer()`
   #
   # Playwright.connect_to_android_server('ws://....') do |browser|
   #   page = browser.new_page

data/lib/playwright_api/api_request_context.rb

@@ -67,6 +67,8 @@ module Playwright
   # ```
   class APIRequestContext < PlaywrightApi
 
+    #
+    # Tracing recorder for requests made through this API request context.
     def tracing # property
       wrap_impl(@impl.tracing)
     end
@@ -286,7 +288,7 @@ module Playwright
 
     #
     # Returns storage state for this request context, contains current cookies and local storage snapshot if it was passed to the constructor.
-    def storage_state(indexedDB: nil, path: nil)
+    def storage_state(indexedDB: nil, opfs: nil, path: nil)
       raise NotImplementedError.new('storage_state is not implemented yet.')
     end
 

data/lib/playwright_api/api_response.rb

@@ -85,6 +85,15 @@ module Playwright
       wrap_impl(@impl.text)
     end
 
+    #
+    # Returns resource timing information for given response. For redirected requests, returns the information for the last
+    # request in the redirect chain. When the response is served [from the HAR file](../mock.md#replaying-from-har), timing
+    # information is not available and all the values are -1. Find more information at
+    # [Resource Timing API](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming).
+    def timing
+      wrap_impl(@impl.timing)
+    end
+
     #
     # Contains the URL of the response.
     def url

data/lib/playwright_api/browser_context.rb

@@ -423,13 +423,15 @@ module Playwright
     alias_method :offline=, :set_offline
 
     #
-    # Returns storage state for this browser context, contains current cookies, local storage snapshot and IndexedDB snapshot.
-    def storage_state(indexedDB: nil, path: nil)
-      wrap_impl(@impl.storage_state(indexedDB: unwrap_impl(indexedDB), path: unwrap_impl(path)))
+    # Returns storage state for this browser context, contains current cookies, local storage snapshot, IndexedDB snapshot, origin private file system snapshot and virtual WebAuthn credentials.
+    def storage_state(credentials: nil, indexedDB: nil, opfs: nil, path: nil)
+      wrap_impl(@impl.storage_state(credentials: unwrap_impl(credentials), indexedDB: unwrap_impl(indexedDB), opfs: unwrap_impl(opfs), path: unwrap_impl(path)))
     end
 
     #
-    # Clears the existing cookies, local storage and IndexedDB entries for all origins and sets the new storage state.
+    # Clears the existing cookies, local storage, IndexedDB entries, origin private file system entries and virtual WebAuthn credentials, and sets the new storage
+    # state. When the storage state contains credentials, the virtual WebAuthn authenticator is installed (equivalent to
+    # [`method: Credentials.install`]), preventing all real authenticators from working in this context.
     #
     # **Usage**
     #
@@ -497,28 +499,28 @@ 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
-    def enable_debug_console!
-      wrap_impl(@impl.enable_debug_console!)
+    def browser=(req)
+      wrap_impl(@impl.browser=(unwrap_impl(req)))
     end
 
     # @nodoc
-    def pause
-      wrap_impl(@impl.pause)
+    def options=(req)
+      wrap_impl(@impl.options=(unwrap_impl(req)))
     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
 
     # -- inherited from EventEmitter --

data/lib/playwright_api/browser_type.rb

@@ -42,6 +42,8 @@ module Playwright
     #
     # **NOTE**: This connection is significantly lower fidelity than the Playwright protocol connection via [`method: BrowserType.connect`]. If you are experiencing issues or attempting to use advanced functionality, you probably want to use [`method: BrowserType.connect`].
     #
+    # **NOTE**: Playwright maintains a curated list of arguments for launching the browser. If you launch the browser without Playwright and do not pass the exact same arguments, some of Playwright functionality may be broken upon connecting to the browser.
+    #
     # **Usage**
     #
     # ```python sync

data/lib/playwright_api/credentials.rb

@@ -4,7 +4,7 @@ module Playwright
   # register passkeys and answer `navigator.credentials.create()` / `navigator.credentials.get()`
   # ceremonies in the page, without a real authenticator or hardware security key.
   #
-  # There are two common ways to use it:
+  # There are three common ways to use it:
   #
   # **Usage: seed a known credential**
   #
@@ -26,7 +26,7 @@ module Playwright
   # # The page's navigator.credentials.get() is answered with the seeded passkey.
   # ```
   #
-  # **Usage: capture a passkey, then reuse it**
+  # **Usage: capture a credential, then reuse it**
   #
   # ```python sync
   # # setup test: let the app register a passkey, then save it.
@@ -62,6 +62,10 @@ module Playwright
   # # navigator.credentials.get() resolves the captured passkey — already signed in.
   # ```
   #
+  # **Usage: save credentials in the storage state, restore later**
+  #
+  # See [authentication guide](../auth.md) for examples of using saving and resotring the storage state.
+  #
   # **Defaults**
   class Credentials < PlaywrightApi