playwright-ruby-client 1.61.0 → 1.63.0

data/lib/playwright/api_request_impl.rb

@@ -3,6 +3,8 @@ require 'json'
 
 module Playwright
   define_api_implementation :APIRequestImpl do
+    include Utils::PrepareHttpCredentials
+
     def initialize(playwright)
       @playwright = playwright
     end
@@ -24,7 +26,7 @@ module Playwright
         clientCertificates: prepare_client_certificates(clientCertificates),
         extraHTTPHeaders: extraHTTPHeaders ? HttpHeaders.new(extraHTTPHeaders).as_serialized : nil,
         failOnStatusCode: failOnStatusCode,
-        httpCredentials: httpCredentials,
+        httpCredentials: prepare_http_credentials(httpCredentials),
         ignoreHTTPSErrors: ignoreHTTPSErrors,
         maxRedirects: maxRedirects,
         proxy: proxy,

data/lib/playwright/api_response_impl.rb

@@ -47,6 +47,22 @@ module Playwright
       @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.rb

@@ -75,7 +75,8 @@ module Playwright
         wallTime: (Time.now.to_f * 1000).to_i,
         apiName: api_name,
         stack: stacks.map do |loc|
-          { file: loc.absolute_path || '', line: loc.lineno, function: loc.label }
+          # Ruby backtraces do not provide a column, but the trace protocol requires one.
+          { file: loc.absolute_path || '', line: loc.lineno, column: 0, function: loc.label }
         end,
       }
     end

data/lib/playwright/channel_owners/browser.rb

@@ -156,6 +156,7 @@ module Playwright
 
     private def setup_browser_context(context)
       context.tracing.send(:update_traces_dir, @traces_dir)
+      context.request.tracing.send(:update_traces_dir, @traces_dir)
       @browser_type.send(:playwright_selectors_browser_contexts) << context
     end
 

data/lib/playwright/channel_owners/browser_context.rb

@@ -42,6 +42,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 +74,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 +99,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)
@@ -418,6 +425,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 +435,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
 
@@ -462,8 +476,13 @@ 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, opfs: nil, credentials: nil)
+      params = {
+        indexedDB: indexedDB,
+        opfs: opfs,
+        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/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,
@@ -498,8 +506,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)
@@ -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,

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
@@ -71,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",
@@ -483,7 +485,7 @@ module Playwright
       type: nil)
 
       params = {
-        type: type,
+        type: ScreenshotUtils.determine_type(path: path, type: type),
         quality: quality,
         fullPage: fullPage,
         clip: clip,
@@ -545,6 +547,7 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
+          scroll: nil,
           strict: nil,
           timeout: nil,
           trial: nil,
@@ -559,6 +562,7 @@ module Playwright
         modifiers: modifiers,
         noWaitAfter: noWaitAfter,
         position: position,
+        scroll: scroll,
         strict: strict,
         timeout: timeout,
         trial: trial,
@@ -571,6 +575,7 @@ module Playwright
           target,
           force: nil,
           noWaitAfter: nil,
+          scroll: nil,
           sourcePosition: nil,
           strict: nil,
           targetPosition: nil,
@@ -583,6 +588,7 @@ module Playwright
         target,
         force: force,
         noWaitAfter: noWaitAfter,
+        scroll: scroll,
         sourcePosition: sourcePosition,
         strict: strict,
         targetPosition: targetPosition,
@@ -600,6 +606,7 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
+          scroll: nil,
           strict: nil,
           timeout: nil,
           trial: nil,
@@ -612,6 +619,7 @@ module Playwright
         modifiers: modifiers,
         noWaitAfter: noWaitAfter,
         position: position,
+        scroll: scroll,
         strict: strict,
         timeout: timeout,
         trial: trial,
@@ -625,6 +633,7 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
+          scroll: nil,
           strict: nil,
           timeout: nil,
           trial: nil)
@@ -634,6 +643,7 @@ module Playwright
         modifiers: modifiers,
         noWaitAfter: noWaitAfter,
         position: position,
+        scroll: scroll,
         strict: strict,
         timeout: timeout,
         trial: trial,
@@ -690,16 +700,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
@@ -718,7 +724,7 @@ module Playwright
         hasText: hasText)
     end
 
-    def frame_locator(selector)
+    def frame_locator(selector = nil)
       @main_frame.frame_locator(selector)
     end
 
@@ -748,6 +754,7 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
+          scroll: nil,
           strict: nil,
           timeout: nil,
           trial: nil)
@@ -757,6 +764,7 @@ module Playwright
         modifiers: modifiers,
         noWaitAfter: noWaitAfter,
         position: position,
+        scroll: scroll,
         strict: strict,
         timeout: timeout,
         trial: trial,
@@ -838,6 +846,7 @@ module Playwright
       force: nil,
       noWaitAfter: nil,
       position: nil,
+      scroll: nil,
       strict: nil,
       timeout: nil,
       trial: nil)
@@ -847,6 +856,7 @@ module Playwright
         force: force,
         noWaitAfter: noWaitAfter,
         position: position,
+        scroll: scroll,
         strict: strict,
         timeout: timeout,
         trial: trial)
@@ -857,6 +867,7 @@ module Playwright
       force: nil,
       noWaitAfter: nil,
       position: nil,
+      scroll: nil,
       strict: nil,
       timeout: nil,
       trial: nil)
@@ -866,6 +877,7 @@ module Playwright
         force: force,
         noWaitAfter: noWaitAfter,
         position: position,
+        scroll: scroll,
         strict: strict,
         timeout: timeout,
         trial: trial)
@@ -962,8 +974,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/channel_owners/tracing.rb

@@ -5,15 +5,16 @@ 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)
@@ -38,19 +39,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 +91,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 +103,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 +112,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 +125,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

@@ -87,6 +87,13 @@ module Playwright
         # @see https://github.com/YusukeIwaki/puppeteer-ruby/pull/34
         @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 = []
         if metadata
@@ -99,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,
         }
 

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',