playwright-ruby-client 1.57.0 → 1.59.0

data/documentation/docs/include/api_coverage.md

@@ -17,6 +17,8 @@
 * redirected_to
 * resource_type
 * response
+* existing_response
+* ~~service_worker~~
 * sizes
 * timing
 * url
@@ -32,6 +34,7 @@
 * headers_array
 * header_value
 * header_values
+* http_version
 * json
 * ok
 * request
@@ -227,6 +230,7 @@
 * location
 * page
 * text
+* timestamp
 * type
 * worker
 
@@ -256,6 +260,7 @@
 * add_script_tag
 * add_style_tag
 * bring_to_front
+* cancel_pick_locator
 * check
 * click
 * close
@@ -299,6 +304,8 @@
 * enabled?
 * hidden?
 * visible?
+* clear_console_messages
+* clear_page_errors
 * console_messages
 * page_errors
 * locator
@@ -306,6 +313,7 @@
 * opener
 * pause
 * pdf
+* pick_locator
 * press
 * query_selector
 * query_selector_all
@@ -325,6 +333,7 @@
 * set_extra_http_headers
 * set_input_files
 * set_viewport_size
+* aria_snapshot
 * tap_point
 * text_content
 * title
@@ -357,6 +366,7 @@
 * keyboard
 * mouse
 * request
+* screencast
 * touchscreen
 
 ## BrowserContext
@@ -372,6 +382,7 @@
 * expose_binding
 * expose_function
 * grant_permissions
+* closed?
 * new_cdp_session
 * new_page
 * pages
@@ -385,6 +396,7 @@
 * set_geolocation
 * set_offline
 * storage_state
+* set_storage_state
 * unroute_all
 * unroute
 * expect_console_message
@@ -392,6 +404,7 @@
 * expect_page
 * ~~wait_for_event~~
 * clock
+* ~~debugger~~
 * request
 * tracing
 
@@ -409,8 +422,10 @@
 * new_browser_cdp_session
 * new_context
 * new_page
+* ~~bind~~
 * start_tracing
 * stop_tracing
+* ~~unbind~~
 * version
 
 ## BrowserType
@@ -491,6 +506,7 @@
 * visible?
 * last
 * locator
+* normalize
 * nth
 * or
 * page

data/lib/playwright/channel_owners/api_request_context.rb

@@ -1,5 +1,5 @@
 require 'base64'
-require 'cgi'
+require 'cgi/escape'
 
 module Playwright
   define_channel_owner :APIRequestContext do
@@ -197,7 +197,7 @@ module Playwright
     end
 
     private def query_string_to_array(query_string)
-      params = CGI.parse(query_string)
+      params = cgi_parse(query_string)
 
       params.map do |key, values|
         values.map do |value|
@@ -206,6 +206,28 @@ module Playwright
       end.flatten
     end
 
+    # https://bugs.ruby-lang.org/issues/21258
+    # CGI.parse is defined in 'cgi' library.
+    # But it produces an error in Ruby 2.4 environment: undefined method `delete_prefix' for "CONTENT_LENGTH":String
+    # So we implement our own version of CGI.parse here.
+    private def cgi_parse(query)
+      # https://github.com/ruby/cgi/blob/master/lib/cgi/core.rb#L396
+      params = {}
+
+      query.split(/[&;]/).each do |pairs|
+        key, value = pairs.split('=',2).map do |v|
+          CGI.unescape(v)
+        end
+
+        next unless key
+        params[key] ||= []
+        next unless value
+        params[key] << value
+      end
+
+      params
+    end
+
     private def object_to_array(hash)
       hash&.map do |key, value|
         { name: key, value: value.to_s }

data/lib/playwright/channel_owners/binding_call.rb

@@ -1,11 +1,45 @@
 module Playwright
   define_channel_owner :BindingCall do
+    class << self
+      def call_queue
+        @call_queue ||= Queue.new
+      end
+
+      def worker_mutex
+        @worker_mutex ||= Mutex.new
+      end
+
+      def ensure_worker
+        worker_mutex.synchronize do
+          return if @worker&.alive?
+
+          @worker = Thread.new do
+            loop do
+              job = call_queue.pop
+              begin
+                job.call
+              rescue => err
+                $stderr.write("BindingCall worker error: #{err.class}: #{err.message}\n")
+                err.backtrace&.each { |line| $stderr.write("#{line}\n") }
+              end
+            end
+          end
+        end
+      end
+    end
+
     def name
       @initializer['name']
     end
 
     def call_async(callback)
-      Thread.new(callback) { call(callback) }
+      # Binding callbacks can be fired concurrently from multiple threads.
+      # Enqueue and execute them on a single worker thread so we:
+      # - preserve the delivery order of binding calls
+      # - avoid spawning a thread per call (bursty timers create many callbacks)
+      # - keep the protocol dispatch thread unblocked
+      self.class.ensure_worker
+      self.class.call_queue << -> { call(callback) }
     end
 
     # @param callback [Proc]
@@ -31,9 +65,9 @@ module Playwright
 
       begin
         result = PlaywrightApi.unwrap(callback.call(source, *args))
-        @channel.send_message_to_server('resolve', result: JavaScript::ValueSerializer.new(result).serialize)
+        @channel.async_send_message_to_server('resolve', result: JavaScript::ValueSerializer.new(result).serialize)
       rescue => err
-        @channel.send_message_to_server('reject', error: { error: { message: err.message, name: 'Error' }})
+        @channel.async_send_message_to_server('reject', error: { error: { message: err.message, name: 'Error' }})
       end
     end
   end

data/lib/playwright/channel_owners/browser_context.rb

@@ -333,8 +333,8 @@ module Playwright
           raise ArgumentError.new('Either path or script parameter must be specified')
         end
 
-      @channel.send_message_to_server('addInitScript', source: source)
-      nil
+      result = @channel.send_message_to_server_result('addInitScript', source: source)
+      ChannelOwners::Disposable.from(result['disposable'])
     end
 
     def expose_binding(name, callback, handle: nil)
@@ -349,17 +349,19 @@ module Playwright
         needsHandle: handle,
       }.compact
       @bindings[name] = callback
-      @channel.send_message_to_server('exposeBinding', params)
+      result = @channel.send_message_to_server_result('exposeBinding', params)
+      ChannelOwners::Disposable.from(result['disposable'])
     end
 
     def expose_function(name, callback)
-      expose_binding(name, ->(_source, *args) { callback.call(*args) }, )
+      expose_binding(name, ->(_source, *args) { callback.call(*args) })
     end
 
     def route(url, handler, times: nil)
       entry = RouteHandler.new(url, base_url, handler, times)
       @routes.unshift(entry)
       update_interception_patterns
+      DisposableStub.new { unroute(url, handler: handler) }
     end
 
     def unroute_all(behavior: nil)
@@ -547,6 +549,24 @@ module Playwright
       @timeout_settings
     end
 
+    def set_storage_state(storageState)
+      payload = case storageState
+                when String
+                  begin
+                    JSON.parse(File.read(storageState))
+                  rescue => e
+                    raise ::Playwright::Error.new(message: "Failed to read storage state from '#{storageState}': #{e.message}")
+                  end
+                else
+                  storageState
+                end
+      @channel.send_message_to_server('setStorageState', storageState: payload)
+    end
+
+    def closed?
+      @close_was_called
+    end
+
     private def has_record_video_option?
       @options.key?(:recordVideo)
     end

data/lib/playwright/channel_owners/browser_type.rb

@@ -60,12 +60,13 @@ module Playwright
       end
     end
 
-    def connect_over_cdp(endpointURL, headers: nil, slowMo: nil, timeout: nil, &block)
+    def connect_over_cdp(endpointURL, headers: nil, isLocal: nil, slowMo: nil, timeout: nil, &block)
       raise 'Connecting over CDP is only supported in Chromium.' unless name == 'chromium'
 
       params = {
         endpointURL: endpointURL,
         headers: headers,
+        isLocal: isLocal,
         slowMo: slowMo,
         timeout: @timeout_settings.timeout(timeout),
       }.compact

data/lib/playwright/channel_owners/debugger.rb

@@ -0,0 +1,4 @@
+module Playwright
+  define_channel_owner :Debugger do
+  end
+end

data/lib/playwright/channel_owners/dialog.rb

@@ -26,7 +26,9 @@ module Playwright
     end
 
     def dismiss
-      @channel.async_send_message_to_server('dismiss')
+      @channel.send_message_to_server('dismiss')
+    rescue TargetClosedError
+      # Swallow target-closed errors for beforeunload dialogs.
     end
   end
 end

data/lib/playwright/channel_owners/disposable.rb

@@ -0,0 +1,9 @@
+module Playwright
+  define_channel_owner :Disposable do
+    def dispose
+      @channel.send_message_to_server('dispose')
+    rescue TargetClosedError
+      nil
+    end
+  end
+end

data/lib/playwright/channel_owners/overlay.rb

@@ -0,0 +1,4 @@
+module Playwright
+  define_channel_owner :Overlay do
+  end
+end

data/lib/playwright/channel_owners/page.rb

@@ -56,7 +56,9 @@ module Playwright
         emit(Events::Page::PageError, Error.parse(params['error']['error']))
       })
       @channel.on('route', ->(params) { on_route(ChannelOwners::Route.from(params['route'])) })
-      @channel.on('video', method(:on_video))
+      if @initializer['video']
+        @video_artifact = ChannelOwners::Artifact.from(@initializer['video'])
+      end
       @channel.on('viewportSizeChanged', method(:on_viewport_size_changed))
       @channel.on('webSocket', ->(params) {
         emit(Events::Page::WebSocket, ChannelOwners::WebSocket.from(params['webSocket']))
@@ -98,7 +100,7 @@ module Playwright
 
     private def on_route(route)
       route.send(:update_context, self)
-
+      return if @close_was_called
       # It is not desired to use PlaywrightApi.wrap directly.
       # However it is a little difficult to define wrapper for `handler` parameter in generate_api.
       # Just a workaround...
@@ -171,11 +173,6 @@ module Playwright
       emit(Events::Page::Download, download)
     end
 
-    private def on_video(params)
-      artifact = ChannelOwners::Artifact.from(params['artifact'])
-      video.send(:set_artifact, artifact)
-    end
-
     private def on_viewport_size_changed(params)
       @viewport_size = {
         width: params['viewportSize']['width'],
@@ -307,8 +304,9 @@ module Playwright
     end
 
     def expose_function(name, callback)
-      @channel.send_message_to_server('exposeBinding', name: name)
+      result = @channel.send_message_to_server_result('exposeBinding', name: name)
       @bindings[name] = ->(_source, *args) { callback.call(*args) }
+      ChannelOwners::Disposable.from(result['disposable'])
     end
 
     def expose_binding(name, callback, handle: nil)
@@ -316,8 +314,9 @@ module Playwright
         name: name,
         needsHandle: handle,
       }.compact
-      @channel.send_message_to_server('exposeBinding', params)
+      result = @channel.send_message_to_server_result('exposeBinding', params)
       @bindings[name] = callback
+      ChannelOwners::Disposable.from(result['disposable'])
     end
 
     def set_extra_http_headers(headers)
@@ -412,14 +411,15 @@ module Playwright
           raise ArgumentError.new('Either path or script parameter must be specified')
         end
 
-      @channel.send_message_to_server('addInitScript', source: source)
-      nil
+      result = @channel.send_message_to_server_result('addInitScript', source: source)
+      ChannelOwners::Disposable.from(result['disposable'])
     end
 
     def route(url, handler, times: nil)
       entry = RouteHandler.new(url, @browser_context.send(:base_url), handler, times)
       @routes.unshift(entry)
       update_interception_patterns
+      DisposableStub.new { unroute(url, handler: handler) }
     end
 
     def unroute_all(behavior: nil)
@@ -508,6 +508,9 @@ module Playwright
 
     def close(runBeforeUnload: nil, reason: nil)
       @close_reason = reason
+      unless runBeforeUnload
+        @close_was_called = true
+      end
       if @owned_context
         @owned_context.close
       else
@@ -643,20 +646,49 @@ module Playwright
         timeout: timeout)
     end
 
-    def console_messages
-      messages = @channel.send_message_to_server('consoleMessages')
+    def console_messages(filter: nil)
+      params = {}
+      params[:filter] = filter if filter
+      messages = @channel.send_message_to_server('consoleMessages', params)
       messages.map do |message|
         ConsoleMessageImpl.new(message, self, nil)
       end
     end
 
-    def page_errors
-      errors = @channel.send_message_to_server('pageErrors')
+    def page_errors(filter: nil)
+      params = {}
+      params[:filter] = filter if filter
+      errors = @channel.send_message_to_server('pageErrors', params)
       errors.map do |error|
         Error.parse(error['error'])
       end
     end
 
+    def clear_console_messages
+      @channel.send_message_to_server('clearConsoleMessages')
+    end
+
+    def clear_page_errors
+      @channel.send_message_to_server('clearPageErrors')
+    end
+
+    def cancel_pick_locator
+      @channel.send_message_to_server('cancelPickLocator')
+    end
+
+    def aria_snapshot(depth: nil, mode: nil, timeout: nil, _track: nil)
+      params = { selector: 'body' }
+      params[:timeout] = @timeout_settings.timeout(timeout)
+      params[:depth] = depth if depth
+      params[:mode] = mode if mode
+      if _track
+        params.delete(:selector)
+        params[:track] = _track
+      end
+      result = @main_frame.channel.send_message_to_server_result('ariaSnapshot', params)
+      result['snapshot']
+    end
+
     def locator(
       selector,
       has: nil,
@@ -901,28 +933,22 @@ module Playwright
       decoded_binary
     end
 
+    def screencast
+      @screencast ||= Screencast.new(self)
+    end
+
     def video
       return nil unless @browser_context.send(:has_record_video_option?)
-      @video ||= Video.new(self)
+      @video ||= Video.new(self, artifact: @video_artifact)
     end
 
-    def snapshot_for_ai(timeout: nil, mode: nil, track: nil)
-      option_mode = mode || 'full'
-      unless ['full', 'incremental'].include?(option_mode)
-        raise ArgumentError.new("mode must be either 'full' or 'incremental'")
-      end
+    def pick_locator
+      result = @channel.send_message_to_server_result('pickLocator', {})
+      @main_frame.locator(result['selector'])
+    end
 
-      options = {
-        timeout: @timeout_settings.timeout(timeout),
-        mode: option_mode,
-      }
-      options[:track] = track if track
-      result = @channel.send_message_to_server_result('snapshotForAI', options)
-      if option_mode == 'full'
-        result['full']
-      elsif option_mode == 'incremental'
-        result['incremental']
-      end
+    def snapshot_for_ai(timeout: nil, depth: nil, _track: nil)
+      aria_snapshot(mode: 'ai', timeout: timeout, depth: depth, _track: _track)
     end
 
     def start_js_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)

data/lib/playwright/channel_owners/request.rb

@@ -81,6 +81,10 @@ module Playwright
       end
     end
 
+    def existing_response
+      @response
+    end
+
     def response
       resp = @channel.send_message_to_server('response')
       ChannelOwners::Response.from_nullable(resp)
@@ -162,6 +166,10 @@ module Playwright
       res.send(:sizes)
     end
 
+    private def update_response(response)
+      @response = response
+    end
+
     private def update_redirected_to(request)
       @redirected_to = request
     end

data/lib/playwright/channel_owners/response.rb

@@ -7,6 +7,7 @@ module Playwright
     private def after_initialize
       @provisional_headers = RawHeaders.new(@initializer['headers'])
       @request = ChannelOwners::Request.from(@initializer['request'])
+      @request.send(:update_response, self)
       timing = @initializer['timing']
       @request.send(:update_timings,
         start_time: timing["startTime"],
@@ -74,6 +75,10 @@ module Playwright
       actual_headers.get_all(name)
     end
 
+    def http_version
+      @channel.send_message_to_server('httpVersion')
+    end
+
     def server_addr
       @channel.send_message_to_server('serverAddr')
     end

data/lib/playwright/channel_owners/stream.rb

@@ -1,8 +1,12 @@
 require 'base64'
+require 'fileutils'
 
 module Playwright
   define_channel_owner :Stream do
     def save_as(path)
+      parent_dir = File.dirname(path)
+      FileUtils.mkdir_p(parent_dir) unless parent_dir == '.'
+
       File.open(path, 'wb') do |f|
         read_with_block do |chunk|
           f.write(chunk)

data/lib/playwright/channel_owners/tracing.rb

@@ -1,11 +1,12 @@
 module Playwright
   define_channel_owner :Tracing do
-    def start(name: nil, title: nil, screenshots: nil, snapshots: nil, sources: nil)
+    def start(name: nil, title: nil, screenshots: nil, snapshots: nil, sources: nil, live: nil)
       params = {
         name: name,
         screenshots: screenshots,
         snapshots: snapshots,
         sources: sources,
+        live: live,
       }.compact
       @include_sources = params[:sources] || false
       @channel.send_message_to_server('tracingStart', params)
@@ -23,7 +24,8 @@ module Playwright
         @is_tracing = true
         @connection.set_in_tracing(true)
       end
-      @stacks_id = @connection.local_utils.tracing_started(@traces_dir, trace_name)
+      local_utils = @connection.local_utils
+      @stacks_id = local_utils&.tracing_started(@traces_dir, trace_name)
     end
 
     def stop_chunk(path: nil)
@@ -40,20 +42,26 @@ module Playwright
         @is_tracing = false
         @connection.set_in_tracing(false)
       end
+      local_utils = @connection.local_utils
 
       unless file_path
         # Not interested in any artifacts
         @channel.send_message_to_server('tracingStopChunk', mode: 'discard')
         if @stacks_id
-          @connection.local_utils.trace_discarded(@stacks_id)
+          local_utils.trace_discarded(@stacks_id) if local_utils
         end
 
         return
       end
 
-      unless @connection.remote?
+      is_local = !@connection.remote?
+      if is_local
+        unless local_utils
+          raise 'Cannot save trace because localUtils is unavailable.'
+        end
+
         result = @channel.send_message_to_server_result('tracingStopChunk', mode: 'entries')
-        @connection.local_utils.zip(
+        local_utils.zip(
           zipFile: file_path,
           entries: result['entries'],
           stacksId: @stacks_id,
@@ -69,7 +77,7 @@ module Playwright
       # The artifact may be missing if the browser closed while stopping tracing.
       unless result['artifact']
         if @stacks_id
-          @connection.local_utils.trace_discarded(@stacks_id)
+          local_utils.trace_discarded(@stacks_id) if local_utils
         end
 
         return
@@ -80,7 +88,9 @@ module Playwright
       artifact.save_as(file_path)
       artifact.delete
 
-      @connection.local_utils.zip(
+      return unless local_utils
+
+      local_utils.zip(
         zipFile: file_path,
         entries: [],
         stacksId: @stacks_id,

data/lib/playwright/channel_owners/web_socket.rb

@@ -48,7 +48,21 @@ module Playwright
 
       waiter.reject_on_event(@parent, 'close', -> { @parent.send(:close_error_with_reason) })
       waiter.wait_for_event(self, event, predicate: predicate)
+      if @closed
+        if event == Events::WebSocket::Close
+          waiter.force_fulfill(nil)
+        else
+          waiter.force_reject(SocketClosedError.new)
+        end
+      end
       block&.call
+      if @closed
+        if event == Events::WebSocket::Close
+          waiter.force_fulfill(nil)
+        else
+          waiter.force_reject(SocketClosedError.new)
+        end
+      end
 
       waiter.result.value!
     end