playwright-ruby-client 1.62.0 → 1.63.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c78e6a1f2ee45aadb2b8a027d08a0264560172b843419e23376c80f74095ccd
-  data.tar.gz: b31e8c1c972865e68312f65ee23a821535f14592affadcc65580b10169819b81
+  metadata.gz: 275e62d0e3c798dd08cdb59a52299af990f93b7fd5fe1cf2a1f9b1c5441a1680
+  data.tar.gz: 1711ed5665344b5c52b6f45c2621e03e2ac8983d698e6717303cad3bbb80659b
 SHA512:
-  metadata.gz: de6ea998c746c0fa3107850695144b7204105c01daa6209f646c2a172bd59eb906e169b4b7ed7dca436e8084611496def05fc81bb23134d8475bedbc480d6fd5
-  data.tar.gz: 907612d4a87117af9d0c57ada0ec4144f7451f7a75176b2b93d3cf896ff6ce8492f7e72ff8a2c04ce1d5d2871fdf9af2f967de9e5175010574d09c276b160300
+  metadata.gz: 9180d7ceb51f46c828e8a08aaffdd1e813bc57b842f268556990030a9003686841842cd8d3f5c98ea8b5c2ea3e6fdb63a4ff45afb6e44adb2b2a9a6c7c6ef861
+  data.tar.gz: 5efd8cd40f2e8b5d2cf2e22943ae6df4e3791b66874ca3cb0f72bbb66a1bd50442e8e481c990eed9fe958f4bfe82102e58634c5bfd2bc1823a0ff25b16036bbf

data/documentation/docs/api/api_request_context.md

@@ -298,3 +298,6 @@ The method will populate request cookies from the context and update
 context cookies from the response. The method will automatically follow redirects.
 
 ## tracing
+
+
+Tracing recorder for requests made through this API request context.

data/documentation/docs/api/browser_context.md

@@ -434,11 +434,11 @@ alias: `offline=`
 ## storage_state
 
 ```
-def storage_state(credentials: nil, indexedDB: nil, path: nil)
+def storage_state(credentials: nil, indexedDB: nil, opfs: nil, path: nil)
 ```
 
 
-Returns storage state for this browser context, contains current cookies, local storage snapshot, IndexedDB snapshot and virtual WebAuthn credentials.
+Returns storage state for this browser context, contains current cookies, local storage snapshot, IndexedDB snapshot, origin private file system snapshot and virtual WebAuthn credentials.
 
 ## set_storage_state
 
@@ -448,7 +448,7 @@ def set_storage_state(storageState)
 alias: `storage_state=`
 
 
-Clears the existing cookies, local storage, IndexedDB entries and virtual WebAuthn credentials, and sets the new storage
+Clears the existing cookies, local storage, IndexedDB entries, origin private file system entries and virtual WebAuthn credentials, and sets the new storage
 state. When the storage state contains credentials, the virtual WebAuthn authenticator is installed (equivalent to
 [Credentials#install](./credentials#install)), preventing all real authenticators from working in this context.
 

data/documentation/docs/api/frame.md

@@ -391,13 +391,17 @@ puts frame == content_frame # => true
 ## frame_locator
 
 ```
-def frame_locator(selector)
+def frame_locator(selector = nil)
 ```
 
 
 When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements
 in that iframe.
 
+When called without `selector`, the search starts in this frame or in any of the iframes inside it,
+so that you don't need to locate each iframe first. Note that the rest of the locator is resolved inside a single
+frame, just like any other locator. If it matches elements inside multiple frames, an error is thrown.
+
 **Usage**
 
 Following snippet locates element with text "Submit" in the iframe with id `my-frame`, like `<iframe id="my-frame">`:
@@ -407,6 +411,13 @@ locator = frame.frame_locator("#my-iframe").get_by_text("Submit")
 locator.click
 ```
 
+Following snippet locates a button, either in the frame or in one of the iframes inside it:
+
+```ruby
+locator = frame.frame_locator.get_by_role('button')
+locator.click
+```
+
 ## get_attribute
 
 ```

data/documentation/docs/api/frame_locator.md

@@ -24,6 +24,26 @@ page.locator('.result-frame').content_frame.get_by_role('button').click
 page.locator('.result-frame').first.content_frame.get_by_role('button').click
 ```
 
+**Any frame**
+
+Calling [Page#frame_locator](./page#frame_locator) or [Frame#frame_locator](./frame#frame_locator) without a selector creates a frame locator that
+starts the search in any frame of the subtree - so that you don't
+need to locate the iframe first.
+
+```ruby
+# Finds the button in any frame on the page:
+page.frame_locator.get_by_role('button').click
+
+# Finds the iframe anywhere on the page and clicks the button inside it:
+page.frame_locator.locator('#my-frame').content_frame.get_by_role('button').click
+```
+
+Only the start of the search is affected - the rest of the locator is resolved inside a single frame, just like any
+other locator. Following the strictness rules above, an error is thrown when elements are matched in multiple frames.
+
+Such a frame locator does not point to a particular `iframe`, so [FrameLocator#owner](./frame_locator#owner),
+[FrameLocator#first](./frame_locator#first), [FrameLocator#last](./frame_locator#last) and [FrameLocator#nth](./frame_locator#nth) are not supported on it.
+
 **Converting Locator to FrameLocator**
 
 If you have a [Locator](./locator) object pointing to an `iframe` it can be converted to [FrameLocator](./frame_locator) using [Locator#content_frame](./locator#content_frame).

data/documentation/docs/api/locator.md

@@ -1531,6 +1531,34 @@ If the element is detached from the DOM at any moment during the action, this me
 When all steps combined have not finished during the specified `timeout`, this method throws a
 `TimeoutError`. Passing zero timeout disables this.
 
+## visible
+
+```
+def visible
+```
+
+
+Returns a locator that matches only [visible](https://playwright.dev/python/docs/actionability#visible) elements, ignoring the invisible ones. This is the recommended way to distinguish elements by visibility, as opposed to the `:visible` CSS pseudo-class.
+
+Note that visibility is checked every time the locator is used, and not at the moment of the [Locator#visible](./locator#visible) call.
+
+**Usage**
+
+Consider a page with two buttons, the first invisible and the second visible.
+
+```html
+<button style='display: none'>Invisible</button>
+<button>Visible</button>
+```
+
+This will only find the second button, because it is visible, and then click it.
+
+```ruby
+page.locator('button').visible.click
+```
+
+To match invisible elements instead, use [Locator#filter](./locator#filter) with the `visible` option set to `false`.
+
 ## wait_for
 
 ```

data/documentation/docs/api/page.md

@@ -585,13 +585,17 @@ frame = page.frame(url: /.*domain.*/)
 ## frame_locator
 
 ```
-def frame_locator(selector)
+def frame_locator(selector = nil)
 ```
 
 
 When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements
 in that iframe.
 
+When called without `selector`, the search starts in any frame on the page - the main frame or any of
+the iframes - so that you don't need to locate each iframe first. Note that the rest of the locator is resolved
+inside a single frame, just like any other locator. If it matches elements inside multiple frames, an error is thrown.
+
 **Usage**
 
 Following snippet locates element with text "Submit" in the iframe with id `my-frame`,
@@ -602,6 +606,13 @@ locator = page.frame_locator("#my-iframe").get_by_text("Submit")
 locator.click
 ```
 
+Following snippet locates a button, either in the main frame or in one of the iframes:
+
+```ruby
+locator = page.frame_locator.get_by_role('button')
+locator.click
+```
+
 ## frames
 
 ```

data/documentation/docs/api/tracing.md

@@ -26,9 +26,11 @@ end
 
 ```
 def start(
+      ariaSnapshots: nil,
       live: nil,
       name: nil,
       screenshots: nil,
+      screenSnapshots: nil,
       snapshots: nil,
       sources: nil,
       title: nil)
@@ -86,7 +88,7 @@ def start_har(path, content: nil, mode: nil, urlFilter: nil)
 
 Start recording a HAR (HTTP Archive) of network activity in this context. The HAR file is written to disk when [Tracing#stop_har](./tracing#stop_har) is called, or when the returned `Disposable` is disposed.
 
-Only one HAR recording can be active at a time per [BrowserContext](./browser_context).
+Only one HAR recording can be active at a time per [Tracing](./tracing) instance.
 
 **Usage**
 

data/documentation/docs/article/guides/playwright_on_alpine_linux.md

@@ -83,7 +83,7 @@ If custom Docker image is preferred, build it as follows:
 FROM mcr.microsoft.com/playwright
 
 WORKDIR /root
-ARG PLAYWRIGHT_CORE_VERSION=1.62.1
+ARG PLAYWRIGHT_CORE_VERSION=1.63.0
 RUN npm install "playwright-core@$PLAYWRIGHT_CORE_VERSION" && ./node_modules/.bin/playwright-core install
 
 ENV PORT 8888

data/documentation/docs/include/api_coverage.md

@@ -530,6 +530,7 @@
 * text_content
 * type
 * uncheck
+* visible
 * wait_for
 * wait_for_function
 

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/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,9 +476,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

@@ -506,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)

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",
@@ -723,7 +724,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,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/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

@@ -296,6 +296,10 @@ module Playwright
       )
     end
 
+    def visible
+      filter(visible: true)
+    end
+
     def first
       LocatorImpl.new(
         frame: @frame,

data/lib/playwright/utils.rb

@@ -18,9 +18,21 @@ module Playwright
   end
 
   module Utils
+    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

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.62.0'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.62.1'
+  VERSION = '1.63.0'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.63.0'
 end

data/lib/playwright_api/api_request_context.rb

@@ -67,6 +67,8 @@ module Playwright
   # ```
   class APIRequestContext < PlaywrightApi
 
+    #
+    # Tracing recorder for requests made through this API request context.
     def tracing # property
       wrap_impl(@impl.tracing)
     end
@@ -286,26 +288,26 @@ module Playwright
 
     #
     # Returns storage state for this request context, contains current cookies and local storage snapshot if it was passed to the constructor.
-    def storage_state(indexedDB: nil, path: nil)
+    def storage_state(indexedDB: nil, opfs: nil, path: nil)
       raise NotImplementedError.new('storage_state is not implemented yet.')
     end
 
     # -- 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/browser.rb

@@ -217,20 +217,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