playwright-ruby-client 1.60.0 → 1.62.0

data/lib/playwright/api_response_impl.rb

@@ -39,6 +39,30 @@ module Playwright
       @headers.headers_array
     end
 
+    def security_details
+      @initializer['securityDetails']
+    end
+
+    def server_addr
+      @initializer['serverAddr']
+    end
+
+    def timing
+      response_end = @initializer['responseEndTiming']
+      {
+        'startTime' => -1,
+        'domainLookupStart' => -1,
+        'domainLookupEnd' => -1,
+        'connectStart' => -1,
+        'secureConnectionStart' => -1,
+        'connectEnd' => -1,
+        'requestStart' => -1,
+        'responseStart' => -1,
+      }.merge(@initializer['timing'] || {}).merge(
+        'responseEnd' => response_end.nil? ? -1 : response_end,
+      )
+    end
+
     class AlreadyDisposedError < StandardError
       def initialize
         super('Response has been disposed')

data/lib/playwright/channel_owners/browser_context.rb

@@ -5,7 +5,7 @@ module Playwright
 
     attr_accessor :browser
     attr_writer :owner_page, :options
-    attr_reader :clock, :tracing, :request
+    attr_reader :clock, :tracing, :request, :credentials
 
     private def after_initialize
       @options = @initializer['options']
@@ -20,6 +20,7 @@ module Playwright
       @request = ChannelOwners::APIRequestContext.from(@initializer['requestContext'])
       @request.send(:_update_timeout_settings, @timeout_settings)
       @clock = ClockImpl.new(self)
+      @credentials = CredentialsImpl.new(self)
 
       @channel.on('bindingCall', ->(params) { on_binding(ChannelOwners::BindingCall.from(params['binding'])) })
       @channel.once('close', ->(_) { on_close })
@@ -461,8 +462,12 @@ module Playwright
       @channel.send_message_to_server('pause')
     end
 
-    def storage_state(path: nil, indexedDB: nil)
-      @channel.send_message_to_server_result('storageState', { indexedDB: indexedDB }.compact).tap do |result|
+    def storage_state(path: nil, indexedDB: nil, credentials: nil)
+      params = {
+        indexedDB: indexedDB,
+        credentials: credentials,
+      }.compact
+      @channel.send_message_to_server_result('storageState', params).tap do |result|
         if path
           File.open(path, 'w') do |f|
             f.write(JSON.dump(result))

data/lib/playwright/channel_owners/browser_type.rb

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

data/lib/playwright/channel_owners/element_handle.rb

@@ -1,4 +1,5 @@
 require_relative './js_handle'
+require_relative '../screenshot_utils'
 
 module Playwright
   module ChannelOwners
@@ -86,6 +87,7 @@ module Playwright
             modifiers: nil,
             noWaitAfter: nil,
             position: nil,
+            scroll: nil,
             timeout: nil,
             trial: nil)
         params = {
@@ -93,6 +95,7 @@ module Playwright
           modifiers: modifiers,
           noWaitAfter: noWaitAfter,
           position: position,
+          scroll: scroll,
           timeout: _timeout(timeout),
           trial: trial,
         }.compact
@@ -109,6 +112,7 @@ module Playwright
             modifiers: nil,
             noWaitAfter: nil,
             position: nil,
+            scroll: nil,
             timeout: nil,
             trial: nil,
             steps: nil)
@@ -121,6 +125,7 @@ module Playwright
           modifiers: modifiers,
           noWaitAfter: noWaitAfter,
           position: position,
+          scroll: scroll,
           timeout: _timeout(timeout),
           trial: trial,
           steps: steps,
@@ -137,6 +142,7 @@ module Playwright
             modifiers: nil,
             noWaitAfter: nil,
             position: nil,
+            scroll: nil,
             timeout: nil,
             trial: nil,
             steps: nil)
@@ -148,6 +154,7 @@ module Playwright
           modifiers: modifiers,
           noWaitAfter: noWaitAfter,
           position: position,
+          scroll: scroll,
           timeout: _timeout(timeout),
           trial: trial,
           steps: steps,
@@ -180,6 +187,7 @@ module Playwright
             modifiers: nil,
             noWaitAfter: nil,
             position: nil,
+            scroll: nil,
             timeout: nil,
             trial: nil)
 
@@ -188,6 +196,7 @@ module Playwright
           modifiers: modifiers,
           noWaitAfter: noWaitAfter,
           position: position,
+          scroll: scroll,
           timeout: _timeout(timeout),
           trial: trial,
         }.compact
@@ -263,11 +272,12 @@ module Playwright
         nil
       end
 
-      def check(force: nil, noWaitAfter: nil, position: nil, timeout: nil, trial: nil)
+      def check(force: nil, noWaitAfter: nil, position: nil, scroll: nil, timeout: nil, trial: nil)
         params = {
           force: force,
           noWaitAfter:  noWaitAfter,
           position: position,
+          scroll: scroll,
           timeout: _timeout(timeout),
           trial: trial,
         }.compact
@@ -276,11 +286,12 @@ module Playwright
         nil
       end
 
-      def uncheck(force: nil, noWaitAfter: nil, position: nil, timeout: nil, trial: nil)
+      def uncheck(force: nil, noWaitAfter: nil, position: nil, scroll: nil, timeout: nil, trial: nil)
         params = {
           force: force,
           noWaitAfter:  noWaitAfter,
           position: position,
+          scroll: scroll,
           timeout: _timeout(timeout),
           trial: trial,
         }.compact
@@ -319,12 +330,11 @@ module Playwright
           caret: caret,
           maskColor: maskColor,
           omitBackground: omitBackground,
-          path: path,
           quality: quality,
           scale: scale,
           style: style,
           timeout: _timeout(timeout),
-          type: type,
+          type: ScreenshotUtils.determine_type(path: path, type: type),
         }.compact
         if mask.is_a?(Enumerable)
           params[:mask] = mask.map do |locator|

data/lib/playwright/channel_owners/frame.rb

@@ -338,6 +338,7 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
+          scroll: nil,
           strict: nil,
           timeout: nil,
           trial: nil,
@@ -352,6 +353,7 @@ module Playwright
         modifiers: modifiers,
         noWaitAfter: noWaitAfter,
         position: position,
+        scroll: scroll,
         strict: strict,
         timeout: _timeout(timeout),
         trial: trial,
@@ -367,6 +369,7 @@ module Playwright
           target,
           force: nil,
           noWaitAfter: nil,
+          scroll: nil,
           sourcePosition: nil,
           strict: nil,
           targetPosition: nil,
@@ -379,6 +382,7 @@ module Playwright
         target: target,
         force: force,
         noWaitAfter: noWaitAfter,
+        scroll: scroll,
         sourcePosition: sourcePosition,
         strict: strict,
         targetPosition: targetPosition,
@@ -416,6 +420,7 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
+          scroll: nil,
           strict: nil,
           timeout: nil,
           trial: nil,
@@ -429,6 +434,7 @@ module Playwright
         modifiers: modifiers,
         noWaitAfter: noWaitAfter,
         position: position,
+        scroll: scroll,
         strict: strict,
         timeout: _timeout(timeout),
         trial: trial,
@@ -445,6 +451,7 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
+          scroll: nil,
           strict: nil,
           timeout: nil,
           trial: nil)
@@ -454,6 +461,7 @@ module Playwright
         modifiers: modifiers,
         noWaitAfter: noWaitAfter,
         position: position,
+        scroll: scroll,
         strict: strict,
         timeout: _timeout(timeout),
         trial: trial,
@@ -539,6 +547,7 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
+          scroll: nil,
           strict: nil,
           timeout: nil,
           trial: nil)
@@ -548,6 +557,7 @@ module Playwright
         modifiers: modifiers,
         noWaitAfter: noWaitAfter,
         position: position,
+        scroll: scroll,
         strict: strict,
         timeout: _timeout(timeout),
         trial: trial,
@@ -642,6 +652,7 @@ module Playwright
       force: nil,
       noWaitAfter: nil,
       position: nil,
+      scroll: nil,
       strict: nil,
       timeout: nil,
       trial: nil)
@@ -651,6 +662,7 @@ module Playwright
         force: force,
         noWaitAfter:  noWaitAfter,
         position: position,
+        scroll: scroll,
         strict: strict,
         timeout: _timeout(timeout),
         trial: trial,
@@ -665,6 +677,7 @@ module Playwright
       force: nil,
       noWaitAfter: nil,
       position: nil,
+      scroll: nil,
       strict: nil,
       timeout: nil,
       trial: nil)
@@ -674,6 +687,7 @@ module Playwright
         force: force,
         noWaitAfter:  noWaitAfter,
         position: position,
+        scroll: scroll,
         strict: strict,
         timeout: _timeout(timeout),
         trial: trial,
@@ -725,25 +739,44 @@ module Playwright
           .serialize
       end
 
-      result = @channel.send_message_to_server_result(
-        title, # title
-        "expect", # method
-        { # params
-          selector: selector,
-          expression: expression,
-          **options,
-        }.compact
-      )
-
-      if result.key?('received')
-        if result['received'].is_a?(Hash) && result['received'].key?('value')
-          result['received']['value'] = JavaScript::ValueParser.new(result['received']['value']).parse
-        elsif !result['received'].is_a?(Hash)
-          result['received'] = JavaScript::ValueParser.new(result['received']).parse
+      is_not = options[:isNot] || false
+
+      # Since Playwright 1.61, the `expect` command resolves on a successful
+      # match and rejects with FrameExpectErrorDetails on a mismatch/timeout.
+      begin
+        @channel.send_message_to_server_result(
+          title, # title
+          "expect", # method
+          { # params
+            selector: selector,
+            expression: expression,
+            **options,
+          }.compact
+        )
+        { 'matches' => !is_not }
+      rescue ::Playwright::Error => err
+        details = err.details || {}
+        received = details['received']
+        if received.is_a?(Hash)
+          received = received.dup
+          if received.key?('value')
+            received['value'] = JavaScript::ValueParser.new(received['value']).parse
+          end
         end
-      end
 
-      result
+        error_message =
+          if details['customErrorMessage']
+            "Error: #{details['customErrorMessage']}"
+          end
+
+        {
+          'matches' => is_not,
+          'received' => received,
+          'log' => err.raw_log,
+          'timedOut' => details['timedOut'],
+          'errorMessage' => error_message,
+        }.compact
+      end
     end
 
     private def drop_payload_params(payload)

data/lib/playwright/channel_owners/page.rb

@@ -1,5 +1,6 @@
 require 'base64'
 require_relative '../locator_utils'
+require_relative '../screenshot_utils'
 
 module Playwright
   # @ref https://github.com/microsoft/playwright-python/blob/master/playwright/_impl/_page.py
@@ -86,6 +87,14 @@ module Playwright
       :viewport_size,
       :main_frame
 
+    def local_storage
+      @local_storage ||= WebStorageImpl.new(self, 'local')
+    end
+
+    def session_storage
+      @session_storage ||= WebStorageImpl.new(self, 'session')
+    end
+
     private def on_frame_attached(frame)
       frame.send(:update_page_from_page, self)
       @frames << frame
@@ -475,7 +484,7 @@ module Playwright
       type: nil)
 
       params = {
-        type: type,
+        type: ScreenshotUtils.determine_type(path: path, type: type),
         quality: quality,
         fullPage: fullPage,
         clip: clip,
@@ -513,13 +522,15 @@ module Playwright
       end
       if @owned_context
         @owned_context.close
+      elsif runBeforeUnload
+        @channel.send_message_to_server('runBeforeUnload')
       else
-        options = { runBeforeUnload: runBeforeUnload }.compact
+        options = { reason: reason }.compact
         @channel.send_message_to_server('close', options)
       end
       nil
     rescue => err
-      raise if !target_closed_error?(err) || !runBeforeUnload
+      raise if !target_closed_error?(err) || runBeforeUnload
     end
 
     def closed?
@@ -535,6 +546,7 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
+          scroll: nil,
           strict: nil,
           timeout: nil,
           trial: nil,
@@ -549,6 +561,7 @@ module Playwright
         modifiers: modifiers,
         noWaitAfter: noWaitAfter,
         position: position,
+        scroll: scroll,
         strict: strict,
         timeout: timeout,
         trial: trial,
@@ -561,6 +574,7 @@ module Playwright
           target,
           force: nil,
           noWaitAfter: nil,
+          scroll: nil,
           sourcePosition: nil,
           strict: nil,
           targetPosition: nil,
@@ -573,6 +587,7 @@ module Playwright
         target,
         force: force,
         noWaitAfter: noWaitAfter,
+        scroll: scroll,
         sourcePosition: sourcePosition,
         strict: strict,
         targetPosition: targetPosition,
@@ -590,6 +605,7 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
+          scroll: nil,
           strict: nil,
           timeout: nil,
           trial: nil,
@@ -602,6 +618,7 @@ module Playwright
         modifiers: modifiers,
         noWaitAfter: noWaitAfter,
         position: position,
+        scroll: scroll,
         strict: strict,
         timeout: timeout,
         trial: trial,
@@ -615,6 +632,7 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
+          scroll: nil,
           strict: nil,
           timeout: nil,
           trial: nil)
@@ -624,6 +642,7 @@ module Playwright
         modifiers: modifiers,
         noWaitAfter: noWaitAfter,
         position: position,
+        scroll: scroll,
         strict: strict,
         timeout: timeout,
         trial: trial,
@@ -680,16 +699,12 @@ module Playwright
       @channel.send_message_to_server('hideHighlight')
     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: 'body' }
       params[:timeout] = @timeout_settings.timeout(timeout)
       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 = @main_frame.channel.send_message_to_server_result('ariaSnapshot', params)
       result['snapshot']
     end
@@ -738,6 +753,7 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
+          scroll: nil,
           strict: nil,
           timeout: nil,
           trial: nil)
@@ -747,6 +763,7 @@ module Playwright
         modifiers: modifiers,
         noWaitAfter: noWaitAfter,
         position: position,
+        scroll: scroll,
         strict: strict,
         timeout: timeout,
         trial: trial,
@@ -828,6 +845,7 @@ module Playwright
       force: nil,
       noWaitAfter: nil,
       position: nil,
+      scroll: nil,
       strict: nil,
       timeout: nil,
       trial: nil)
@@ -837,6 +855,7 @@ module Playwright
         force: force,
         noWaitAfter: noWaitAfter,
         position: position,
+        scroll: scroll,
         strict: strict,
         timeout: timeout,
         trial: trial)
@@ -847,6 +866,7 @@ module Playwright
       force: nil,
       noWaitAfter: nil,
       position: nil,
+      scroll: nil,
       strict: nil,
       timeout: nil,
       trial: nil)
@@ -856,6 +876,7 @@ module Playwright
         force: force,
         noWaitAfter: noWaitAfter,
         position: position,
+        scroll: scroll,
         strict: strict,
         timeout: timeout,
         trial: trial)
@@ -952,8 +973,8 @@ module Playwright
       @main_frame.locator(result['selector'])
     end
 
-    def snapshot_for_ai(timeout: nil, depth: nil, boxes: nil, _track: nil)
-      aria_snapshot(mode: 'ai', timeout: timeout, depth: depth, boxes: boxes, _track: _track)
+    def snapshot_for_ai(timeout: nil, depth: nil, boxes: nil)
+      aria_snapshot(mode: 'ai', timeout: timeout, depth: depth, boxes: boxes)
     end
 
     def _assertions(timeout, is_not, message)

data/lib/playwright/connection.rb

@@ -74,14 +74,25 @@ module Playwright
     end
 
     def async_send_message_to_server(guid, method, params, metadata: nil)
+      if method == '__waitInfo__' && @closed_error
+        return Concurrent::Promises.fulfilled_future(nil)
+      end
       return if @closed_error
 
       callback = Concurrent::Promises.resolvable_future
+      fire_and_forget = method == '__waitInfo__'
 
       with_generated_id do |id|
         # register callback promise object first.
         # @see https://github.com/YusukeIwaki/puppeteer-ruby/pull/34
-        @callbacks_mutex.synchronize { @callbacks[id] = callback }
+        @callbacks_mutex.synchronize { @callbacks[id] = callback } unless fire_and_forget
+
+        wire_params = params.dup
+        timeout = if wire_params.key?(:timeout)
+                    wire_params.delete(:timeout)
+                  elsif wire_params.key?('timeout')
+                    wire_params.delete('timeout')
+                  end
 
         _metadata = {}
         frames = []
@@ -95,13 +106,14 @@ module Playwright
             _metadata[:title] = metadata[:title]
           end
         end
+        _metadata[:timeout] = timeout unless timeout.nil?
         _metadata.compact!
 
         message = {
           id: id,
           guid: guid,
           method: method,
-          params: replace_channels_with_guids(params),
+          params: replace_channels_with_guids(wire_params),
           metadata: _metadata,
         }
 
@@ -112,6 +124,7 @@ module Playwright
           callback.reject(err)
           raise unless err.is_a?(Transport::AlreadyDisconnectedError)
         end
+        callback.fulfill(nil) if fire_and_forget
 
         if @tracing_count > 0 && !frames.empty? && guid != 'localUtils' && !remote?
           @local_utils.add_stack_to_tracing_no_reply(id, frames)
@@ -168,6 +181,7 @@ module Playwright
         if error && !msg['result']
           parsed_error = ::Playwright::Error.parse(error['error'])
           parsed_error.log = msg['log']
+          parsed_error.details = msg['errorDetails']
           callback.reject(parsed_error)
         else
           result = replace_guids_with_channels(msg['result'])

data/lib/playwright/credentials_impl.rb

@@ -0,0 +1,35 @@
+module Playwright
+  # ref: https://github.com/microsoft/playwright/blob/main/packages/playwright-core/src/client/credentials.ts
+  define_api_implementation :CredentialsImpl do
+    # @param browser_context [ChannelOwners::BrowserContext]
+    def initialize(browser_context)
+      @browser_context = browser_context
+    end
+
+    def install
+      @browser_context.channel.send_message_to_server('credentialsInstall')
+      nil
+    end
+
+    def create(rpId, id: nil, userHandle: nil, privateKey: nil, publicKey: nil)
+      params = {
+        rpId: rpId,
+        id: id,
+        userHandle: userHandle,
+        privateKey: privateKey,
+        publicKey: publicKey,
+      }.compact
+      @browser_context.channel.send_message_to_server('credentialsCreate', params)
+    end
+
+    def get(id: nil, rpId: nil)
+      params = { id: id, rpId: rpId }.compact
+      @browser_context.channel.send_message_to_server('credentialsGet', params)
+    end
+
+    def delete(id)
+      @browser_context.channel.send_message_to_server('credentialsDelete', id: id)
+      nil
+    end
+  end
+end

data/lib/playwright/errors.rb

@@ -31,10 +31,13 @@ module Playwright
       @stack = stack
     end
 
-    attr_reader :name, :message, :stack
+    attr_reader :name, :message, :stack, :raw_log
+    # Error details for `expect` failures (received value, timedOut, customErrorMessage).
+    attr_accessor :details
 
     def log=(log)
       return unless log
+      @raw_log = log
       format_call_log = log.join("\n  - ")
       @message = "#{@message}\nCall log:\n#{format_call_log}\n"
     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",