playwright-ruby-client 1.60.0 → 1.62.0

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,
@@ -363,6 +371,7 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
+          scroll: nil,
           timeout: nil,
           trial: nil)
       @frame.hover(@selector,
@@ -371,6 +380,7 @@ module Playwright
         modifiers: modifiers,
         noWaitAfter: noWaitAfter,
         position: position,
+        scroll: scroll,
         timeout: timeout,
         trial: trial)
     end
@@ -426,7 +436,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 +444,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 +505,7 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
+          scroll: nil,
           timeout: nil,
           trial: nil)
       @frame.tap_point(@selector,
@@ -507,6 +514,7 @@ module Playwright
         modifiers: modifiers,
         noWaitAfter: noWaitAfter,
         position: position,
+        scroll: scroll,
         timeout: timeout,
         trial: trial)
     end
@@ -527,6 +535,7 @@ module Playwright
           force: nil,
           noWaitAfter: nil,
           position: nil,
+          scroll: nil,
           timeout: nil,
           trial: nil)
       @frame.uncheck(@selector,
@@ -534,10 +543,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/locator_utils.rb

@@ -39,7 +39,15 @@ module Playwright
     end
 
     private def get_by_test_id_selector(test_id_attribute_name, test_id)
-      "internal:testid=[#{test_id_attribute_name}=#{escape_for_attribute_selector_or_regex(test_id, true)}]"
+      "internal:testid=[#{encode_test_id_attribute_name(test_id_attribute_name)}=#{escape_for_attribute_selector_or_regex(test_id, true)}]"
+    end
+
+    private def encode_test_id_attribute_name(test_id_attribute_name)
+      if test_id_attribute_name.include?(',')
+        JSON.generate(test_id_attribute_name)
+      else
+        test_id_attribute_name
+      end
     end
 
     private def get_by_label_selector(text, exact:)

data/lib/playwright/screencast.rb

@@ -63,11 +63,12 @@ module Playwright
       @page.send(:channel).send_message_to_server('screencastChapter', params)
     end
 
-    def show_actions(duration: nil, fontSize: nil, position: nil)
+    def show_actions(duration: nil, fontSize: nil, position: nil, cursor: nil)
       params = {}
       params[:duration] = duration if duration
       params[:fontSize] = fontSize if fontSize
       params[:position] = position if position
+      params[:cursor] = cursor if cursor
       @page.send(:channel).send_message_to_server('screencastShowActions', params)
       DisposableStub.new { hide_actions }
     end
@@ -85,11 +86,26 @@ module Playwright
     end
 
     private def handle_screencast_frame(event)
-      @on_frame&.call({
-        data: Base64.strict_decode64(event['data']),
-        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/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.60.0'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.60.0'
+  VERSION = '1.62.0'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.62.1'
 end

data/lib/playwright/waiter.rb

@@ -12,33 +12,14 @@ module Playwright
       @registered_listeners = Set.new
       @listeners_mutex = Mutex.new
       @logs = []
-      wait_for_event_info_before
+      send_wait_info(waitId: @wait_id, phase: 'before', event: @event)
     end
 
-    private def wait_for_event_info_before
-      @channel.async_send_message_to_server(
-        "waitForEventInfo",
-        {
-          "info": {
-            "waitId": @wait_id,
-            "phase": "before",
-            "event": @event,
-          }
-        },
-      )
-    end
-
-    private def wait_for_event_info_after(error: nil)
-      @channel.async_send_message_to_server(
-        "waitForEventInfo",
-        {
-          "info": {
-            "waitId": @wait_id,
-            "phase": "after",
-            "error": error,
-          }.compact,
-        },
-      )
+    private def send_wait_info(params)
+      @channel.async_send_message_to_server('__waitInfo__', params.compact)
+    rescue
+      # Fire-and-forget. The server intentionally does not reply and this must
+      # not affect the API call that is being waited for.
     end
 
     def reject_on_event(emitter, event, error_or_proc, predicate: nil)
@@ -89,7 +70,7 @@ module Playwright
       cleanup
       return if @result.resolved?
       @result.fulfill(result)
-      wait_for_event_info_after
+      send_wait_info(waitId: @wait_id, phase: 'after')
     end
 
     private def reject(error)
@@ -98,7 +79,7 @@ module Playwright
       klass = error.is_a?(TimeoutError) ? TimeoutError : Error
       ex = klass.new(message: "#{error.message}#{format_log_recording(@logs)}")
       @result.reject(ex)
-      wait_for_event_info_after(error: ex)
+      send_wait_info(waitId: @wait_id, phase: 'after', error: ex.message)
     end
 
     # @param [Playwright::EventEmitter]
@@ -135,20 +116,7 @@ module Playwright
 
     def log(message)
       @logs << message
-      begin
-        @channel.async_send_message_to_server(
-          "waitForEventInfo",
-          {
-            "info": {
-              "waitId": @wait_id,
-              "phase": "log",
-              "message": message,
-            },
-          },
-        )
-      rescue => err
-        # ignore
-      end
+      send_wait_info(waitId: @wait_id, phase: 'log', message: message)
     end
 
     # @param logs [Array<String>]

data/lib/playwright/web_storage_impl.rb

@@ -0,0 +1,34 @@
+module Playwright
+  # ref: https://github.com/microsoft/playwright/blob/main/packages/playwright-core/src/client/webStorage.ts
+  define_api_implementation :WebStorageImpl do
+    # @param page [ChannelOwners::Page]
+    # @param kind [String] 'local' or 'session'
+    def initialize(page, kind)
+      @page = page
+      @kind = kind
+    end
+
+    def items
+      @page.channel.send_message_to_server('webStorageItems', kind: @kind)
+    end
+
+    def get_item(name)
+      @page.channel.send_message_to_server('webStorageGetItem', kind: @kind, name: name)
+    end
+
+    def set_item(name, value)
+      @page.channel.send_message_to_server('webStorageSetItem', kind: @kind, name: name, value: value)
+      nil
+    end
+
+    def remove_item(name)
+      @page.channel.send_message_to_server('webStorageRemoveItem', kind: @kind, name: name)
+      nil
+    end
+
+    def clear
+      @page.channel.send_message_to_server('webStorageClear', kind: @kind)
+      nil
+    end
+  end
+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

@@ -292,20 +292,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/api_response.rb

@@ -55,6 +55,18 @@ module Playwright
       wrap_impl(@impl.ok)
     end
 
+    #
+    # Returns SSL and other security information. Resolves to `null` for non-HTTPS responses. For redirected requests, returns the information for the last request in the redirect chain.
+    def security_details
+      wrap_impl(@impl.security_details)
+    end
+
+    #
+    # Returns the IP address and port of the server. Resolves to `null` if the server address is not available. For redirected requests, returns the information for the last request in the redirect chain.
+    def server_addr
+      wrap_impl(@impl.server_addr)
+    end
+
     #
     # Contains the status code of the response (e.g., 200 for a success).
     def status
@@ -73,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.rb

@@ -217,20 +217,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