playwright-ruby-client 1.62.0 → 1.64.0

data/lib/playwright/channel_owners/browser_context.rb

@@ -1,6 +1,8 @@
 module Playwright
   # @ref https://github.com/microsoft/playwright-python/blob/master/playwright/_impl/_browser_context.py
   define_channel_owner :BrowserContext do
+    include Utils::ClearCookiesParameters
+
     include Utils::PrepareBrowserContextOptions
 
     attr_accessor :browser
@@ -42,6 +44,11 @@ module Playwright
       @channel.on('dialog', ->(params) {
         on_dialog(ChannelOwners::Dialog.from(params['dialog']))
       })
+      @channel.on('dialogClosed', ->(params) {
+        dialog = ChannelOwners::Dialog.from(params['dialog'])
+        emit(Events::BrowserContext::DialogClosed, dialog)
+        dialog.page&.emit(Events::Page::DialogClosed, dialog)
+      })
       @channel.on('request', ->(params) {
         on_request(
           ChannelOwners::Request.from(params['request']),
@@ -69,6 +76,7 @@ module Playwright
       set_event_to_subscription_mapping({
         Events::BrowserContext::Console => 'console',
         Events::BrowserContext::Dialog => 'dialog',
+        Events::BrowserContext::DialogClosed => 'dialogClosed',
         Events::BrowserContext::Request => "request",
         Events::BrowserContext::Response => "response",
         Events::BrowserContext::RequestFinished => "requestFinished",
@@ -93,6 +101,7 @@ module Playwright
     private def update_options(context_options:, browser_options:)
       @options = context_options
       @tracing.send(:update_traces_dir, browser_options[:tracesDir])
+      @request.tracing.send(:update_traces_dir, browser_options[:tracesDir])
     end
 
     private def on_page(page)
@@ -267,36 +276,7 @@ module Playwright
     end
 
     def clear_cookies(domain: nil, name: nil, path: nil)
-      params = {}
-
-      case name
-      when String
-        params[:name] = name
-      when Regexp
-        regex = JavaScript::Regex.new(name)
-        params[:nameRegexSource] = regex.source
-        params[:nameRegexFlags] = regex.flag
-      end
-
-      case domain
-      when String
-        params[:domain] = domain
-      when Regexp
-        regex = JavaScript::Regex.new(domain)
-        params[:domainRegexSource] = regex.source
-        params[:domainRegexFlags] = regex.flag
-      end
-
-      case path
-      when String
-        params[:path] = path
-      when Regexp
-        regex = JavaScript::Regex.new(path)
-        params[:pathRegexSource] = regex.source
-        params[:pathRegexFlags] = regex.flag
-      end
-
-      @channel.send_message_to_server('clearCookies', params)
+      @channel.send_message_to_server('clearCookies', clear_cookies_params(domain: domain, name: name, path: path))
     end
 
     def grant_permissions(permissions, origin: nil)
@@ -418,6 +398,7 @@ module Playwright
         @browser.browser_type.send(:playwright_selectors_browser_contexts).delete(self)
       end
       @tracing.send(:reset_stack_counter)
+      @request.tracing.send(:reset_stack_counter)
       emit(Events::BrowserContext::Close)
       @closed_promise.fulfill(true)
     end
@@ -427,9 +408,15 @@ module Playwright
       @close_was_called = true
       @close_reason = reason
       @request.dispose(reason: reason)
-      @tracing.send(:export_all_hars)
+      har_error = nil
+      begin
+        @tracing.send(:export_all_hars)
+      rescue => error
+        har_error = error
+      end
       @channel.send_message_to_server('close', { reason: reason }.compact)
       @closed_promise.value!
+      raise har_error if har_error
       nil
     end
 
@@ -445,7 +432,7 @@ module Playwright
       #
       # So, launch inspector as Python app.
       # NOTE: This should be used only for Page#pause at this moment.
-      @channel.send_message_to_server('enableRecorder', language: :python)
+      @channel.send_message_to_server('showRecorder', language: :python)
       @debug_console_enabled = true
     end
 
@@ -462,9 +449,10 @@ module Playwright
       @channel.send_message_to_server('pause')
     end
 
-    def storage_state(path: nil, indexedDB: nil, credentials: nil)
+    def storage_state(path: nil, indexedDB: nil, opfs: nil, credentials: nil)
       params = {
         indexedDB: indexedDB,
+        opfs: opfs,
         credentials: credentials,
       }.compact
       @channel.send_message_to_server_result('storageState', params).tap do |result|

data/lib/playwright/channel_owners/frame.rb

@@ -17,6 +17,7 @@ module Playwright
       @child_frames = Set.new
       @load_states = Set.new(@initializer['loadStates'])
       @event_emitter = Object.new.extend(EventEmitter)
+      @webmcp = WebMCPImpl.new(self)
 
       @channel.on('loadstate', ->(params) {
         on_load_state(add: params['add'], remove: params['remove'])
@@ -24,7 +25,7 @@ module Playwright
       @channel.on('navigated', method(:on_frame_navigated))
     end
 
-    attr_reader :page, :parent_frame
+    attr_reader :page, :parent_frame, :webmcp
     attr_writer :detached
 
     private def _timeout(timeout)
@@ -272,8 +273,8 @@ module Playwright
       JavaScript::Expression.new(pageFunction, arg).eval_on_selector_all(@channel, selector)
     end
 
-    def content
-      @channel.send_message_to_server('content')
+    def content(includeShadow: nil)
+      @channel.send_message_to_server('content', { includeShadow: includeShadow }.compact)
     end
 
     def set_content(html, timeout: nil, waitUntil: nil)
@@ -506,8 +507,8 @@ module Playwright
         hasText: hasText)
     end
 
-    def frame_locator(selector)
-      FrameLocatorImpl.new(frame: self, frame_selector: selector)
+    def frame_locator(selector = nil)
+      FrameLocatorImpl.new(frame: self, frame_selector: selector || 'internal:control=any-frame')
     end
 
     def focus(selector, strict: nil, timeout: nil)

data/lib/playwright/channel_owners/local_utils.rb

@@ -62,6 +62,11 @@ module Playwright
       nil
     end
 
+    def as_locator_description(selector)
+      # Ruby uses the Python SDK language for upstream code generation and the inspector.
+      @channel.send_message_to_server('asLocatorDescription', selector: selector, sdkLanguage: 'python')
+    end
+
     def connect(params)
       result = @channel.send_message_to_server_result('connect', params)
       ChannelOwners::JsonPipe.from(result['pipe'])

data/lib/playwright/channel_owners/page.rb

@@ -72,6 +72,7 @@ module Playwright
       set_event_to_subscription_mapping({
         Events::Page::Console => "console",
         Events::Page::Dialog => "dialog",
+        Events::Page::DialogClosed => "dialogClosed",
         Events::Page::Request => "request",
         Events::Page::Response => "response",
         Events::Page::RequestFinished => "requestFinished",
@@ -337,8 +338,16 @@ module Playwright
       @main_frame.url
     end
 
-    def content
-      @main_frame.content
+    def content(includeShadow: nil)
+      @main_frame.content(includeShadow: includeShadow)
+    end
+
+    def webmcp
+      @main_frame.webmcp
+    end
+
+    def get_by_ref(ref)
+      locator("aria-ref=#{ref}")
     end
 
     def set_content(html, timeout: nil, waitUntil: nil)
@@ -723,7 +732,7 @@ module Playwright
         hasText: hasText)
     end
 
-    def frame_locator(selector)
+    def frame_locator(selector = nil)
       @main_frame.frame_locator(selector)
     end
 

data/lib/playwright/channel_owners/tracing.rb

@@ -5,23 +5,26 @@ module Playwright
       @har_id = nil
     end
 
-    def start(name: nil, title: nil, screenshots: nil, snapshots: nil, sources: nil, live: nil)
+    def start(name: nil, title: nil, screenshots: nil, snapshots: nil, ariaSnapshots: nil, screenSnapshots: nil, sources: nil, live: nil)
       params = {
         name: name,
-        screenshots: screenshots,
-        snapshots: snapshots,
-        sources: sources,
+        screencast: screenshots,
+        snapshotDom: snapshots,
+        snapshotAria: ariaSnapshots,
+        snapshotScreen: screenSnapshots,
         live: live,
       }.compact
-      @include_sources = params[:sources] || false
+      @include_sources = sources || false
       @channel.send_message_to_server('tracingStart', params)
       trace_name = @channel.send_message_to_server('tracingStartChunk', { title: title, name: name }.compact)
       start_collecting_stacks(trace_name)
+      DisposableStub.new { stop }
     end
 
     def start_chunk(title: nil, name: nil)
       trace_name = @channel.send_message_to_server('tracingStartChunk', { title: title, name: name }.compact)
       start_collecting_stacks(trace_name)
+      DisposableStub.new { stop_chunk }
     end
 
     private def start_collecting_stacks(trace_name)
@@ -38,19 +41,43 @@ module Playwright
     end
 
     def stop(path: nil)
-      do_stop_chunk(file_path: path)
+      save_error = nil
+      begin
+        do_stop_chunk(file_path: path)
+      rescue => error
+        save_error = error
+      end
       @channel.send_message_to_server('tracingStop')
+      raise save_error if save_error
     end
 
     private def do_stop_chunk(file_path:)
       reset_stack_counter
+      stacks_id = @stacks_id
+      @stacks_id = nil
+      begin
+        save_chunk(file_path: file_path, stacks_id: stacks_id)
+      rescue
+        # Release the session even if saving fails so subsequent traces start fresh.
+        if stacks_id
+          begin
+            @connection.local_utils&.trace_discarded(stacks_id)
+          rescue
+            # Preserve the error from saving the trace.
+          end
+        end
+        raise
+      end
+    end
+
+    private def save_chunk(file_path:, stacks_id:)
       local_utils = @connection.local_utils
 
       unless file_path
         # Not interested in any artifacts
         @channel.send_message_to_server('tracingStopChunk', mode: 'discard')
-        if @stacks_id
-          local_utils.trace_discarded(@stacks_id) if local_utils
+        if stacks_id
+          local_utils.trace_discarded(stacks_id) if local_utils
         end
 
         return
@@ -66,7 +93,7 @@ module Playwright
         local_utils.zip(
           zipFile: file_path,
           entries: result['entries'],
-          stacksId: @stacks_id,
+          stacksId: stacks_id,
           mode: 'write',
           includeSources: @include_sources,
         )
@@ -78,8 +105,8 @@ module Playwright
       result = @channel.send_message_to_server_result('tracingStopChunk', mode: 'archive')
       # The artifact may be missing if the browser closed while stopping tracing.
       unless result['artifact']
-        if @stacks_id
-          local_utils.trace_discarded(@stacks_id) if local_utils
+        if stacks_id
+          local_utils.trace_discarded(stacks_id) if local_utils
         end
 
         return
@@ -87,7 +114,12 @@ module Playwright
 
       # Save trace to the final local file.
       artifact = ChannelOwners::Artifact.from(result['artifact'])
-      artifact.save_as(file_path)
+      begin
+        artifact.save_as(file_path)
+      rescue
+        artifact.delete rescue nil
+        raise
+      end
       artifact.delete
 
       return unless local_utils
@@ -95,7 +127,7 @@ module Playwright
       local_utils.zip(
         zipFile: file_path,
         entries: [],
-        stacksId: @stacks_id,
+        stacksId: stacks_id,
         mode: 'append',
         includeSources: @include_sources,
       )

data/lib/playwright/connection.rb

@@ -24,6 +24,7 @@ module Playwright
       @waiting_for_object = {} # Hash[ guid => Promise<ChannelOwner> ]
       @callbacks = {} # Hash [ guid => Promise<ChannelOwner> ]
       @callbacks_mutex = Mutex.new
+      @call_id_prefix = Array.new(4) { ('a'..'z').to_a.sample }.join
       @root_object = RootChannelOwner.new(self)
       @remote = false
       @tracing_count = 0
@@ -77,7 +78,10 @@ module Playwright
       if method == '__waitInfo__' && @closed_error
         return Concurrent::Promises.fulfilled_future(nil)
       end
-      return if @closed_error
+      # After the driver is gone, fail fast with the close error instead of
+      # returning nil (which would blow up with NoMethodError on .value!).
+      # ref: https://github.com/YusukeIwaki/playwright-ruby-client/issues/392
+      return Concurrent::Promises.rejected_future(@closed_error) if @closed_error
 
       callback = Concurrent::Promises.resolvable_future
       fire_and_forget = method == '__waitInfo__'
@@ -150,7 +154,7 @@ module Playwright
         @last_id ||= 0
         @last_id += 1
       end
-      block.call(id)
+      block.call("#{@call_id_prefix}@#{id}")
     end
 
     # @param guid [String]

data/lib/playwright/credentials_impl.rb

@@ -11,13 +11,14 @@ module Playwright
       nil
     end
 
-    def create(rpId, id: nil, userHandle: nil, privateKey: nil, publicKey: nil)
+    def create(rpId, id: nil, userHandle: nil, privateKey: nil, publicKey: nil, signCount: nil)
       params = {
         rpId: rpId,
         id: id,
         userHandle: userHandle,
         privateKey: privateKey,
         publicKey: publicKey,
+        signCount: signCount,
       }.compact
       @browser_context.channel.send_message_to_server('credentialsCreate', params)
     end

data/lib/playwright/errors.rb

@@ -2,7 +2,7 @@ module Playwright
   class Error < StandardError
     # ref: https://github.com/microsoft/playwright-python/blob/0b4a980fed366c4c1dee9bfcdd72662d629fdc8d/playwright/_impl/_helper.py#L155
     def self.parse(error_payload)
-      if error_payload['name'] == 'TimeoutError'
+      error = if error_payload['name'] == 'TimeoutError'
         TimeoutError.new(
           message: error_payload['message'],
           stack: error_payload['stack'],
@@ -19,6 +19,8 @@ module Playwright
           stack: error_payload['stack'],
         )
       end
+      error.code = error_payload['code']
+      error
     end
 
     # @param name [String]
@@ -34,6 +36,7 @@ module Playwright
     attr_reader :name, :message, :stack, :raw_log
     # Error details for `expect` failures (received value, timedOut, customErrorMessage).
     attr_accessor :details
+    attr_accessor :code
 
     def log=(log)
       return unless log

data/lib/playwright/events.rb

@@ -29,6 +29,7 @@ end
     Close: 'close',
     Console: 'console',
     Dialog: 'dialog',
+    DialogClosed: 'dialogclosed',
     Download: 'download',
     FrameAttached: 'frameattached',
     FrameDetached: 'framedetached',
@@ -53,6 +54,7 @@ end
     Crash: 'crash',
     Console: 'console',
     Dialog: 'dialog',
+    DialogClosed: 'dialogclosed',
     Download: 'download',
     FileChooser: 'filechooser',
     DOMContentLoaded: 'domcontentloaded',

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

@@ -5,8 +5,9 @@ module Playwright
   define_api_implementation :LocatorImpl do
     include LocatorUtils
 
-    def initialize(frame:, selector:, has: nil, hasNot: nil, hasNotText: nil, hasText: nil, visible: nil)
+    def initialize(frame:, selector:, has: nil, hasNot: nil, hasNotText: nil, hasText: nil, visible: nil, locator_code: nil)
       @frame = frame
+      @locator_code = locator_code
       selector_scopes = [selector]
 
       if hasText
@@ -39,11 +40,18 @@ module Playwright
     end
 
     def to_s
-      if @description
-        "Locator@#{@selector} (#{@description})"
-      else
-        "Locator@#{@selector}"
-      end
+      custom_description = description
+      return custom_description if custom_description
+      return @locator_code if @locator_code
+
+      local_utils = @frame.instance_variable_get(:@connection).local_utils
+      return "Locator@#{@selector}" unless local_utils
+
+      local_utils.as_locator_description(@selector)
+    end
+
+    def within(locator)
+      locator.locator(self)
     end
 
     private def to_protocol
@@ -232,6 +240,11 @@ module Playwright
       hasNot: nil,
       hasNotText: nil,
       hasText: nil)
+      if selector.is_a?(LocatorImpl)
+        raise ArgumentError, 'Locators must belong to the same frame.' unless same_frame?(selector)
+
+        selector = "internal:chain=#{selector.send(:selector_json)}"
+      end
       LocatorImpl.new(
         frame: @frame,
         selector: "#{@selector} >> #{selector}",
@@ -296,6 +309,10 @@ module Playwright
       )
     end
 
+    def visible
+      filter(visible: true)
+    end
+
     def first
       LocatorImpl.new(
         frame: @frame,
@@ -449,10 +466,11 @@ module Playwright
     end
 
     def normalize
-      resolved_selector = @frame.channel.send_message_to_server('resolveSelector', { selector: @selector })
+      result = @frame.channel.send_message_to_server_result('resolveSelector', { selector: @selector, sdkLanguage: 'python' })
       LocatorImpl.new(
         frame: @frame,
-        selector: resolved_selector,
+        selector: result['resolvedSelector'],
+        locator_code: result['locatorCode'],
       )
     end
 

data/lib/playwright/screencast.rb

@@ -11,7 +11,7 @@ module Playwright
       @page.send(:channel).on('screencastFrame', method(:handle_screencast_frame))
     end
 
-    def start(path: nil, size: nil, quality: nil, &on_frame)
+    def start(path: nil, size: nil, quality: nil, fps: nil, &on_frame)
       raise 'Screencast is already started' if @started
 
       @started = true
@@ -21,6 +21,7 @@ module Playwright
       params[:record] = true if path
       params[:size] = size if size
       params[:quality] = quality if quality
+      params[:fps] = fps unless fps.nil?
       params[:sendFrames] = true if on_frame
 
       result = @page.send(:channel).send_message_to_server_result('screencastStart', params)
@@ -63,12 +64,13 @@ module Playwright
       @page.send(:channel).send_message_to_server('screencastChapter', params)
     end
 
-    def show_actions(duration: nil, fontSize: nil, position: nil, cursor: nil)
+    def show_actions(duration: nil, fontSize: nil, position: nil, cursor: nil, style: nil)
       params = {}
       params[:duration] = duration if duration
       params[:fontSize] = fontSize if fontSize
       params[:position] = position if position
       params[:cursor] = cursor if cursor
+      params[:style] = style if style
       @page.send(:channel).send_message_to_server('screencastShowActions', params)
       DisposableStub.new { hide_actions }
     end

data/lib/playwright/transport.rb

@@ -32,10 +32,15 @@ module Playwright
     def send_message(message)
       debug_send_message(message) if @debug
       msg = JSON.dump(message)
-      @mutex.synchronize {
-        @stdin.write([msg.bytes.length].pack('V')) # unsigned 32bit, little endian, real byte size instead of chars
-        @stdin.write(msg) # write UTF-8 in binary mode as byte stream
-      }
+      # Build the whole frame (4-byte little-endian length header + JSON payload) in a
+      # single buffer, and write it at once. Two separate writes can be torn by an
+      # asynchronous exception (e.g. Timeout::Error from Timeout.timeout, delivered via
+      # Thread#raise), which crashes the driver with a JSON parse error.
+      # ref: https://github.com/YusukeIwaki/playwright-ruby-client/issues/392
+      frame = [msg.bytesize].pack('V') + msg.b # unsigned 32bit, little endian, real byte size instead of chars
+      Thread.handle_interrupt(Object => :never) do
+        @mutex.synchronize { @stdin.write(frame) } # write UTF-8 in binary mode as byte stream
+      end
     rescue Errno::EPIPE, IOError
       raise AlreadyDisconnectedError.new('send_message failed')
     end
@@ -85,6 +90,10 @@ module Playwright
         debug_recv_message(obj) if @debug
         @on_message&.call(obj)
       end
+      # exited the loop on clean EOF. The driver is gone, so reject pending
+      # callbacks instead of hanging forever on promises that will never resolve.
+      # ref: https://github.com/YusukeIwaki/playwright-ruby-client/issues/392
+      @on_driver_closed&.call
     rescue IOError
       # disconnected by remote.
       @on_driver_closed&.call
@@ -92,6 +101,9 @@ module Playwright
 
     def handle_stderr
       while err = @stderr.read
+        # IO#read without length on a pipe returns "" (not nil) at EOF.
+        # Bail out instead of spinning forever on empty reads.
+        break if err.empty?
         # sometimed driver crashes with the error below.
         # --------
         # undefined:1
@@ -103,7 +115,11 @@ module Playwright
         #     at Transport.transport.onmessage (/home/runner/work/playwright-ruby-client/playwright-ruby-client/node_modules/playwright/lib/cli/driver.js:42:73)
         #     at Immediate.<anonymous> (/home/runner/work/playwright-ruby-client/playwright-ruby-client/node_modules/playwright/lib/protocol/transport.js:74:26)
         #     at processImmediate (internal/timers.js:461:21)
-        if err.include?('undefined:1')
+        #
+        # Node >= 16 prints '<anonymous_script>:1' instead of 'undefined:1'.
+        # ref: https://github.com/YusukeIwaki/playwright-ruby-client/issues/392
+        if err.include?('undefined:1') || err.include?('<anonymous_script>:1') ||
+            err.include?('is not valid JSON')
           @on_driver_crashed&.call
           break
         end

data/lib/playwright/utils.rb

@@ -18,9 +18,38 @@ module Playwright
   end
 
   module Utils
+    module ClearCookiesParameters
+      private def clear_cookies_params(domain:, name:, path:)
+        params = {}
+        { domain: domain, name: name, path: path }.each do |key, value|
+          case value
+          when String
+            params[key] = value
+          when Regexp
+            regex = JavaScript::Regex.new(value)
+            params["#{key}RegexSource".to_sym] = regex.source
+            params["#{key}RegexFlags".to_sym] = regex.flag
+          end
+        end
+        params
+      end
+    end
+
+    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
@@ -35,6 +64,9 @@ module Playwright
           if params[:record_video_size]
             params[:recordVideo][:size] = params.delete(:record_video_size)
           end
+          unless params[:record_video_fps].nil?
+            params[:recordVideo][:fps] = params.delete(:record_video_fps)
+          end
           if params[:record_video_show_actions]
             params[:recordVideo][:showActions] = params.delete(:record_video_show_actions)
           end