playwright-ruby-client 1.21.0 → 1.24.0

data/lib/playwright/connection.rb

@@ -24,6 +24,8 @@ module Playwright
       @remote = false
     end
 
+    attr_reader :local_utils
+
     def mark_as_remote
       @remote = true
     end
@@ -127,12 +129,15 @@ module Playwright
       params = msg['params']
 
       if method == "__create__"
-        create_remote_object(
+        remote_object = create_remote_object(
           parent_guid: guid,
           type: params["type"],
           guid: params["guid"],
           initializer: params["initializer"],
         )
+        if remote_object.is_a?(ChannelOwners::LocalUtils)
+          @local_utils = remote_object
+        end
         return
       end
 

data/lib/playwright/har_router.rb

@@ -0,0 +1,82 @@
+module Playwright
+  class HarRouter
+    # @param local_utils [LocalUtils]
+    # @param file [String]
+    # @param not_found_action [String] 'abort' or 'fallback'
+    # @param url_match [String||Regexp|nil]
+    def self.create(local_utils, file, not_found_action, url_match: nil)
+      har_id = local_utils.har_open(file)
+
+      new(
+        local_utils: local_utils,
+        har_id: har_id,
+        not_found_action: not_found_action,
+        url_match: url_match,
+      )
+    end
+
+    # @param local_utils [LocalUtils]
+    # @param har_id [String]
+    # @param not_found_action [String] 'abort' or 'fallback'
+    # @param url_match [String||Regexp|nil]
+    def initialize(local_utils:, har_id:, not_found_action:,  url_match: nil)
+      unless ['abort', 'fallback'].include?(not_found_action)
+        raise ArgumentError.new("not_found_action must be either 'abort' or 'fallback'. '#{not_found_action}' is specified.")
+      end
+
+      @local_utils = local_utils
+      @har_id = har_id
+      @not_found_action = not_found_action
+      @url_match = url_match || '**/*'
+      @debug = ENV['DEBUG'].to_s == 'true' || ENV['DEBUG'].to_s == '1'
+    end
+
+    private def handle(route, request)
+      response = @local_utils.har_lookup(
+        har_id: @har_id,
+        url: request.url,
+        method: request.method,
+        headers: request.headers_array,
+        post_data: request.post_data_buffer,
+        is_navigation_request: request.navigation_request?,
+      )
+      case response['action']
+      when 'redirect'
+        redirect_url = response['redirectURL']
+        puts "pw:api HAR: #{request.url} redirected to #{redirect_url}" if @debug
+        route.redirect_navigation_request(redirect_url)
+      when 'fulfill'
+        route.fulfill(
+          status: response['status'],
+          headers: response['headers'].map { |header| [header['name'], header['value']] }.to_h,
+          body: Base64.strict_decode64(response['body']),
+        )
+      else
+        # Report the error, but fall through to the default handler.
+        if response['action'] == 'error'
+          puts "pw:api HAR: #{response['message']} redirected to #{redirect_url}" if @debug
+        end
+
+        if @not_found_action == 'abort'
+          route.abort
+        else
+          route.fallback
+        end
+      end
+    end
+
+    def add_context_route(context)
+      context.route(@url_match, method(:handle))
+      context.once(Events::BrowserContext::Close, method(:dispose))
+    end
+
+    def add_page_route(page)
+      page.route(@url_match, method(:handle))
+      page.once(Events::Page::Close, method(:dispose))
+    end
+
+    def dispose
+      @local_utils.async_har_close(@har_id)
+    end
+  end
+end

data/lib/playwright/http_headers.rb

@@ -7,7 +7,7 @@ module Playwright
 
     def as_serialized
       @headers.map do |key, value|
-        { name: key, value: value }
+        { 'name' => key, 'value' => value }
       end
     end
   end

data/lib/playwright/javascript/regex.rb

@@ -0,0 +1,23 @@
+module Playwright
+  module JavaScript
+    class Regex
+      def initialize(regexp)
+        unless regexp.is_a?(Regexp)
+          raise ArgumentError("Argument must be a Regexp: #{regexp} (#{regexp.class})")
+        end
+
+        @source = regexp.source
+        @flag = flag_for(regexp)
+      end
+
+      attr_reader :source, :flag
+
+      private def flag_for(regexp)
+        flags = []
+        flags << 'ms' if (regexp.options & Regexp::MULTILINE) != 0
+        flags << 'i' if (regexp.options & Regexp::IGNORECASE) != 0
+        flags.join('')
+      end
+    end
+  end
+end

data/lib/playwright/javascript/value_parser.rb

@@ -5,6 +5,7 @@ module Playwright
     class ValueParser
       def initialize(hash)
         @hash = hash
+        @refs = {}
       end
 
       # @return [Hash]
@@ -23,6 +24,10 @@ module Playwright
           return hash[key] if hash.key?(key)
         end
 
+        if hash.key?('ref')
+          return @refs[hash['ref']]
+        end
+
         if hash.key?('v')
           return case hash['v']
                  when 'undefined'
@@ -43,6 +48,10 @@ module Playwright
           return DateTime.parse(hash['d'])
         end
 
+        if hash.key?('u')
+          return URI(hash['u'])
+        end
+
         if hash.key?('r')
           # @see https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/RegExp
           # @see https://docs.ruby-lang.org/ja/latest/class/Regexp.html
@@ -55,11 +64,21 @@ module Playwright
         end
 
         if hash.key?('a')
-          return hash['a'].map { |value| parse_hash(value) }
+          result = []
+          if hash['id']
+            @refs[hash['id']] = result
+          end
+          hash['a'].each { |value| result << parse_hash(value) }
+          return result
         end
 
         if hash.key?('o')
-          return hash['o'].map { |obj| [obj['k'], parse_hash(obj['v'])] }.to_h
+          result = {}
+          if hash['id']
+            @refs[hash['id']] = result
+          end
+          hash['o'].each { |obj| result[obj['k']] = parse_hash(obj['v']) }
+          return result
         end
 
         if hash.key?('h')

data/lib/playwright/javascript/value_serializer.rb

@@ -1,8 +1,12 @@
+require_relative './visitor_info'
+require_relative './regex'
+
 module Playwright
   module JavaScript
     class ValueSerializer
       def initialize(ruby_value)
         @value = ruby_value
+        @visited = VisitorInfo.new
       end
 
       # @return [Hash]
@@ -36,15 +40,23 @@ module Playwright
         when Time
           require 'time'
           { d: value.utc.iso8601 }
+        when URI
+          { u: value.to_s }
         when Regexp
-          flags = []
-          flags << 'ms' if (value.options & Regexp::MULTILINE) != 0
-          flags << 'i' if (value.options & Regexp::IGNORECASE) != 0
-          { r: { p: value.source, f: flags.join('') } }
+          regex_value = Regex.new(value)
+          { r: { p: regex_value.source, f: regex_value.flag } }
+        when -> (value) { @visited.ref(value) }
+          { ref: @visited.ref(value) }
         when Array
-          { a: value.map { |v| serialize_value(v) } }
+          id = @visited.log(value)
+          result = []
+          value.each { |v| result << serialize_value(v) }
+          { a: result, id: id }
         when Hash
-          { o: value.map { |key, v| { k: key, v: serialize_value(v) } } }
+          id = @visited.log(value)
+          result = []
+          value.each { |key, v| result << { k: key, v: serialize_value(v) } }
+          { o: result, id: id }
         else
           raise ArgumentError.new("Unexpected value: #{value}")
         end

data/lib/playwright/javascript/visitor_info.rb

@@ -0,0 +1,26 @@
+module Playwright
+  module JavaScript
+    class VisitorInfo
+      def initialize
+        @data = {}
+        @last_id = 0
+      end
+
+      # returns [Integer|nil]
+      def ref(object)
+        @data[object]
+      end
+
+      def log(object)
+        if @data[object]
+          raise ArgumentError.new("Already visited")
+        end
+
+        id = @last_id + 1
+        @last_id = id # FIXME: should thread-safe
+
+        @data[object] = id
+      end
+    end
+  end
+end

data/lib/playwright/javascript.rb

@@ -1,3 +1,4 @@
 require_relative './javascript/expression'
 require_relative './javascript/value_parser'
 require_relative './javascript/value_serializer'
+require_relative './javascript/regex'

data/lib/playwright/locator_impl.rb

@@ -31,11 +31,9 @@ module Playwright
 
       case hasText
       when Regexp
-        source = EscapeWithQuotes.new(hasText.source, '"')
-        flags = []
-        flags << 'ms' if (hasText.options & Regexp::MULTILINE) != 0
-        flags << 'i' if (hasText.options & Regexp::IGNORECASE) != 0
-        selector_scopes << ":scope:text-matches(#{source}, \"#{flags.join('')}\")"
+        regex = JavaScript::Regex.new(hasText)
+        source = EscapeWithQuotes.new(regex.source, '"')
+        selector_scopes << "has=#{"text=/#{regex.source}/#{regex.flag}".to_json}"
       when String
         text = EscapeWithQuotes.new(hasText, '"')
         selector_scopes << ":scope:has-text(#{text})"
@@ -239,6 +237,16 @@ module Playwright
       @frame.query_selector_all(@selector)
     end
 
+    def filter(has: nil, hasText: nil)
+      LocatorImpl.new(
+        frame: @frame,
+        timeout_settings: @timeout_settings,
+        selector: @selector,
+        hasText: hasText,
+        has: has,
+      )
+    end
+
     def first
       LocatorImpl.new(
         frame: @frame,

data/lib/playwright/playwright_api.rb

@@ -122,21 +122,41 @@ module Playwright
       }
     end
 
-    private def wrap_impl(object)
+    private def wrap_impl(object, visited: {})
       if object.is_a?(Array)
-        object.map { |obj| wrap_impl(obj) }
+        unless visited[object]
+          visited[object] = []
+          object.each { |obj| visited[object] << wrap_impl(obj) }
+        end
+        visited[object]
       elsif object.is_a?(Hash)
-        object.map { |key, obj| [key, wrap_impl(obj)] }.to_h
+        unless visited[object]
+          visited[object] = {}
+          object.each do |key, obj|
+            visited[object][key] = wrap_impl(obj, visited: visited)
+          end
+        end
+        visited[object]
       else
         ::Playwright::PlaywrightApi.wrap(object)
       end
     end
 
-    private def unwrap_impl(object)
+    private def unwrap_impl(object, visited: {})
       if object.is_a?(Array)
-        object.map { |obj| unwrap_impl(obj) }
+        unless visited[object]
+          visited[object] = []
+          object.each { |obj| visited[object] << unwrap_impl(obj) }
+        end
+        visited[object]
       elsif object.is_a?(Hash)
-        object.map { |key, obj| [key, unwrap_impl(obj)] }.to_h
+        unless visited[object]
+          visited[object] = {}
+          object.each do |key, obj|
+            visited[object][key] = unwrap_impl(obj, visited: visited)
+          end
+        end
+        visited[object]
       elsif object.is_a?(PlaywrightApi)
         ::Playwright::PlaywrightApi.unwrap(object)
       else

data/lib/playwright/route_handler.rb

@@ -50,12 +50,8 @@ module Playwright
     def async_handle(route, request)
       @counter.increment
 
-      Concurrent::Promises.future do
-        begin
-          @handler.call(route, request)
-        rescue => err
-          puts err, err.backtrace
-        end
+      Concurrent::Promises.future { @handler.call(route, request) }.rescue do |err|
+        puts err, err.backtrace
       end
     end
 

data/lib/playwright/utils.rb

@@ -1,6 +1,36 @@
 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
@@ -11,12 +41,7 @@ module Playwright
           params[:extraHTTPHeaders] = ::Playwright::HttpHeaders.new(params[:extraHTTPHeaders]).as_serialized
         end
         if params[:record_har_path]
-          params[:recordHar] = {
-            path: params.delete(:record_har_path)
-          }
-          if params[:record_har_omit_content]
-            params[:recordHar][:omitContent] = params.delete(:record_har_omit_content)
-          end
+          params[:recordHar] = prepare_record_har_options(params)
         end
         if params[:record_video_dir]
           params[:recordVideo] = {

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.21.0'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.21.1'
+  VERSION = '1.24.0'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.24.2'
 end

data/lib/playwright.rb

@@ -20,6 +20,7 @@ require 'playwright/channel_owner'
 require 'playwright/http_headers'
 require 'playwright/input_files'
 require 'playwright/connection'
+require 'playwright/har_router'
 require 'playwright/raw_headers'
 require 'playwright/route_handler'
 require 'playwright/select_option_values'
@@ -143,6 +144,7 @@ module Playwright
         playwright = connection.initialize_playwright
         browser = playwright.send(:pre_launched_browser)
         browser.should_close_connection_on_close!
+        browser.send(:update_browser_type, browser.browser_type)
         Execution.new(connection, PlaywrightApi.wrap(playwright), PlaywrightApi.wrap(browser))
       rescue
         connection.stop

data/lib/playwright_api/android.rb

@@ -26,8 +26,8 @@ module Playwright
   class Android < PlaywrightApi
 
     # Returns the list of detected Android devices.
-    def devices(omitDriverInstall: nil, port: nil)
-      wrap_impl(@impl.devices(omitDriverInstall: unwrap_impl(omitDriverInstall), port: unwrap_impl(port)))
+    def devices(host: nil, omitDriverInstall: nil, port: nil)
+      wrap_impl(@impl.devices(host: unwrap_impl(host), omitDriverInstall: unwrap_impl(omitDriverInstall), port: unwrap_impl(port)))
     end
 
     # This setting will change the default maximum time for all the methods accepting `timeout` option.
@@ -38,20 +38,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/android_device.rb

@@ -57,18 +57,22 @@ module Playwright
           noViewport: nil,
           offline: nil,
           permissions: nil,
+          record_har_content: nil,
+          record_har_mode: nil,
           record_har_omit_content: nil,
           record_har_path: nil,
+          record_har_url_filter: nil,
           record_video_dir: nil,
           record_video_size: nil,
           reducedMotion: nil,
           screen: nil,
+          serviceWorkers: nil,
           strictSelectors: nil,
           timezoneId: nil,
           userAgent: nil,
           viewport: nil,
           &block)
-      wrap_impl(@impl.launch_browser(acceptDownloads: unwrap_impl(acceptDownloads), baseURL: unwrap_impl(baseURL), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), command: unwrap_impl(command), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), forcedColors: unwrap_impl(forcedColors), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), noViewport: unwrap_impl(noViewport), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), reducedMotion: unwrap_impl(reducedMotion), screen: unwrap_impl(screen), strictSelectors: unwrap_impl(strictSelectors), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
+      wrap_impl(@impl.launch_browser(acceptDownloads: unwrap_impl(acceptDownloads), baseURL: unwrap_impl(baseURL), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), command: unwrap_impl(command), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), forcedColors: unwrap_impl(forcedColors), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), noViewport: unwrap_impl(noViewport), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), record_har_content: unwrap_impl(record_har_content), record_har_mode: unwrap_impl(record_har_mode), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_har_url_filter: unwrap_impl(record_har_url_filter), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), reducedMotion: unwrap_impl(reducedMotion), screen: unwrap_impl(screen), serviceWorkers: unwrap_impl(serviceWorkers), strictSelectors: unwrap_impl(strictSelectors), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
     end
 
     # Performs a long tap on the widget defined by `selector`.
@@ -171,20 +175,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/api_request_context.rb

@@ -186,20 +186,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy