playwright-ruby-client 1.63.0 → 1.64.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 275e62d0e3c798dd08cdb59a52299af990f93b7fd5fe1cf2a1f9b1c5441a1680
-  data.tar.gz: 1711ed5665344b5c52b6f45c2621e03e2ac8983d698e6717303cad3bbb80659b
+  metadata.gz: 3d790738449c6398b19249ce438000db7f00a06a46b8db59307f2595d849781b
+  data.tar.gz: 7010d04e7614128ad40443dae1f3745b0588915c5af4e1d8c81c21f962b9d4c5
 SHA512:
-  metadata.gz: 9180d7ceb51f46c828e8a08aaffdd1e813bc57b842f268556990030a9003686841842cd8d3f5c98ea8b5c2ea3e6fdb63a4ff45afb6e44adb2b2a9a6c7c6ef861
-  data.tar.gz: 5efd8cd40f2e8b5d2cf2e22943ae6df4e3791b66874ca3cb0f72bbb66a1bd50442e8e481c990eed9fe958f4bfe82102e58634c5bfd2bc1823a0ff25b16036bbf
+  metadata.gz: c1ff297b16ee61f37ece9c223280dc7ea31c1ecbe5aab4ec130348e6c0c74ca5ab86769328c2810daee6166bb4153a7a703d3bcac99472cdc43920089a60a37c
+  data.tar.gz: 9a899659118c9b797a368c956538496fad57df2bb6b33d282af420095eecea459a323d2f046ba61d67e6c7d0bed9cb181fdcc4d2b7e57ac1d7bd8a05f0215e71

data/documentation/docs/api/api_request_context.md

@@ -57,6 +57,53 @@ playwright.chromium.launch do |browser|
 end
 ```
 
+## add_cookies
+
+```
+def add_cookies(cookies)
+```
+
+
+Adds cookies into this request context. They will be sent with matching subsequent requests. For [BrowserContext#request](./browser_context#request)
+and [Page#request](./page#request), this is equivalent to calling [BrowserContext#add_cookies](./browser_context#add_cookies) on the corresponding browser context.
+
+**Usage**
+
+```ruby
+request.add_cookies([cookie_object1, cookie_object2])
+```
+
+## clear_cookies
+
+```
+def clear_cookies(domain: nil, name: nil, path: nil)
+```
+
+
+Removes cookies from this request context. Accepts optional filter. For [BrowserContext#request](./browser_context#request)
+and [Page#request](./page#request), this is equivalent to calling [BrowserContext#clear_cookies](./browser_context#clear_cookies) on the corresponding browser context.
+
+**Usage**
+
+```ruby
+request.clear_cookies
+request.clear_cookies(name: "session-id")
+request.clear_cookies(domain: "my-origin.com")
+request.clear_cookies(path: "/api/v1")
+request.clear_cookies(name: "session-id", domain: "my-origin.com")
+```
+
+## cookies
+
+```
+def cookies(urls: nil)
+```
+
+
+If no URLs are specified, this method returns all cookies. If URLs are specified, only cookies that affect those URLs
+are returned. For [BrowserContext#request](./browser_context#request) and [Page#request](./page#request), this is equivalent to calling
+[BrowserContext#cookies](./browser_context#cookies) on the corresponding browser context.
+
 ## delete
 
 ```

data/documentation/docs/api/browser.md

@@ -113,6 +113,7 @@ def new_context(
       record_har_path: nil,
       record_har_url_filter: nil,
       record_video_dir: nil,
+      record_video_fps: nil,
       record_video_size: nil,
       reducedMotion: nil,
       screen: nil,
@@ -174,6 +175,7 @@ def new_page(
       record_har_path: nil,
       record_har_url_filter: nil,
       record_video_dir: nil,
+      record_video_fps: nil,
       record_video_size: nil,
       reducedMotion: nil,
       screen: nil,

data/documentation/docs/api/browser_type.md

@@ -177,6 +177,7 @@ def launch_persistent_context(
       record_har_path: nil,
       record_har_url_filter: nil,
       record_video_dir: nil,
+      record_video_fps: nil,
       record_video_size: nil,
       reducedMotion: nil,
       screen: nil,

data/documentation/docs/api/clock.md

@@ -36,6 +36,7 @@ def install(time: nil)
 
 Install fake implementations for the following time-related functions:
 - `Date`
+- `Temporal.Now`
 - `setTimeout`
 - `clearTimeout`
 - `setInterval`

data/documentation/docs/api/credentials.md

@@ -57,6 +57,7 @@ context.credentials.create(
   userHandle: credential["userHandle"],
   privateKey: credential["privateKey"],
   publicKey: credential["publicKey"],
+  signCount: credential["signCount"],
 )
 context.credentials.install
 
@@ -67,7 +68,7 @@ page.goto("https://example.com/login")
 
 **Usage: save credentials in the storage state, restore later**
 
-See [authentication guide](https://playwright.dev/python/docs/auth) for examples of using saving and resotring the storage state.
+See [authentication guide](https://playwright.dev/python/docs/auth) for examples of using saving and restoring the storage state.
 
 **Defaults**
 
@@ -95,6 +96,7 @@ def create(
       id: nil,
       privateKey: nil,
       publicKey: nil,
+      signCount: nil,
       userHandle: nil)
 ```
 
@@ -106,7 +108,8 @@ seeded credential is discoverable (resident), so the page can resolve it from bo
 username-then-passkey and usernameless passkey flows. The returned object carries the private and public keys, so it can be persisted to disk and re-seeded in a later test.
 
 To **import a known credential**, supply all four of `id`, `userHandle`, `privateKey` and
-`publicKey` together.
+`publicKey` together. Pass `signCount` as well to continue from the
+signature counter the relying party has already seen.
 
 Call [Credentials#install](./credentials#install) before navigating to a page that uses WebAuthn.
 
@@ -132,5 +135,5 @@ Returns every credential currently held by the authenticator, optionally filtere
 `id`. This includes both credentials seeded with [Credentials#create](./credentials#create) and credentials
 the page registered itself by calling `navigator.credentials.create()`.
 
-Each returned credential includes its private and public keys, so a passkey the app just
+Each returned credential includes its private and public keys and the current signature counter, so a passkey the app just
 registered can be saved and re-seeded into a later test with [Credentials#create](./credentials#create) — see the second example in the class overview.

data/documentation/docs/api/frame.md

@@ -116,7 +116,7 @@ When all steps combined have not finished during the specified `timeout`, this m
 ## content
 
 ```
-def content
+def content(includeShadow: nil)
 ```
 
 
@@ -1236,3 +1236,8 @@ Waits for the frame to navigate to the given URL.
 frame.click("a.delayed-navigation") # clicking the link will indirectly cause a navigation
 frame.wait_for_url("**/target.html")
 ```
+
+## webmcp
+
+
+Tools that the frame registers through the experimental [WebMCP](./web_mcp) browser API. See [WebMCP](./web_mcp) for details.

data/documentation/docs/api/locator.md

@@ -1135,6 +1135,26 @@ def normalize
 Returns a new locator that uses best practices for referencing the matched element, prioritizing test ids,
 aria roles, and other user-facing attributes over CSS selectors. This is useful for converting implementation-detail selectors into more resilient, human-readable locators.
 
+**Usage**
+
+An agent can pick an element by its ref from an [Page#aria_snapshot](./page#aria_snapshot) taken in the `"ai"` mode. Refs only
+work for the latest snapshot. Normalize the ref locator and convert it to a string to get resilient locator code
+in your language, the same way `codegen` does.
+
+Consider the following aria snapshot.
+
+```yaml
+- button "Submit" [ref=e2]
+```
+
+You can turn the ref into locator code:
+
+```ruby
+normalized = page.get_by_ref("e2").normalize
+puts normalized.to_s
+# get_by_role("button", name="Submit")
+```
+
 ## nth
 
 ```
@@ -1598,3 +1618,21 @@ If `expression` throws or rejects, this method throws.
 Wait for an attribute to appear:
 
 Passing argument to `expression`:
+
+## within
+
+```
+def within(locator)
+```
+
+
+Returns a locator that matches this locator's elements inside each element matched by `locator`.
+
+Note that relative locators, such as [Locator#nth](./locator#nth) or [Locator#first](./locator#first), are resolved separately inside each matched parent. In the example below, `page.getByRole('cell').nth(2)` picks the third cell of every row, not the third cell in the whole table.
+
+**Usage**
+
+```ruby
+third_column = page.get_by_role("cell").nth(2).within(page.get_by_role("row"))
+expect(third_column).to have_text(["Apple", "Banana", "Cherry"])
+```

data/documentation/docs/api/page.md

@@ -177,7 +177,7 @@ manually via [`event: Page.dialog`] event.
 ## content
 
 ```
-def content
+def content(includeShadow: nil)
 ```
 
 
@@ -699,6 +699,30 @@ You can fill the input after locating it by the placeholder text:
 page.get_by_placeholder("name@example.com").fill("playwright@microsoft.com")
 ```
 
+## get_by_ref
+
+```
+def get_by_ref(ref)
+```
+
+
+Locate element by its aria ref. Refs like `[ref=e2]` are reported by [Page#aria_snapshot](./page#aria_snapshot) when called with
+the `"ai"` mode, and resolve against the latest snapshot taken in the element's frame.
+
+**Usage**
+
+Consider the following aria snapshot.
+
+```yaml
+- button "Submit" [ref=e2]
+```
+
+You can locate the button by its ref:
+
+```ruby
+page.get_by_ref("e2").click
+```
+
 ## get_by_role
 
 ```
@@ -2052,3 +2076,10 @@ API testing helper associated with this page. This method returns the same insta
 **Usage**
 
 ## touchscreen
+
+## webmcp
+
+
+Tools that the main frame registers through the experimental [WebMCP](./web_mcp) browser API. Shortcut for [Frame#webmcp](./frame#webmcp) of [Page#main_frame](./page#main_frame), see [WebMCP](./web_mcp) for details.
+
+**Usage**

data/documentation/docs/api/request.md

@@ -205,7 +205,7 @@ def resource_type
 
 Contains the request's resource type as it was perceived by the rendering engine. ResourceType will be one of the
 following: `document`, `stylesheet`, `image`, `media`, `font`, `script`, `texttrack`, `xhr`, `fetch`, `eventsource`,
-`websocket`, `manifest`, `other`.
+`websocket`, `manifest`, `beacon`, `ping`, `cspreport`, `other`.
 
 ## response
 

data/documentation/docs/api/response.md

@@ -70,8 +70,9 @@ def headers_array
 ```
 
 
-An array with all the request HTTP headers associated with this response. Unlike [Response#all_headers](./response#all_headers), header names are NOT lower-cased.
+An array with all the response HTTP headers associated with this response. Unlike [Response#all_headers](./response#all_headers), header names are NOT lower-cased.
 Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times.
+Some browser network stacks combine multiple field values before reporting them, so separate entries are not always available.
 
 ## header_value
 

data/documentation/docs/api/tracing.md

@@ -37,7 +37,7 @@ def start(
 ```
 
 
-Start tracing.
+Start tracing. Disposing the returned `Disposable` stops tracing without saving the trace, similarly to calling [Tracing#stop](./tracing#stop) without a path.
 
 **NOTE**: You probably want to [enable tracing in your config file](https://playwright.dev/docs/api/class-testoptions#test-options-trace) instead of using `Tracing.start`.
 
@@ -59,7 +59,7 @@ def start_chunk(name: nil, title: nil)
 ```
 
 
-Start a new trace chunk. If you'd like to record multiple traces on the same [BrowserContext](./browser_context), use [Tracing#start](./tracing#start) once, and then create multiple trace chunks with [Tracing#start_chunk](./tracing#start_chunk) and [Tracing#stop_chunk](./tracing#stop_chunk).
+Start a new trace chunk. Disposing the returned `Disposable` stops the chunk without saving it, similarly to calling [Tracing#stop_chunk](./tracing#stop_chunk) without a path. If you'd like to record multiple traces on the same [BrowserContext](./browser_context), use [Tracing#start](./tracing#start) once, and then create multiple trace chunks with [Tracing#start_chunk](./tracing#start_chunk) and [Tracing#stop_chunk](./tracing#stop_chunk).
 
 **Usage**
 

data/documentation/docs/api/web_mcp.md

@@ -0,0 +1,34 @@
+---
+sidebar_position: 10
+---
+
+# WebMCP
+
+
+[WebMCP](./web_mcp) exposes the tools that a frame registers through the experimental [WebMCP](./web_mcp) browser API, `navigator.modelContext`. It lists the tools and calls them.
+
+Instances are accessed through [Frame#webmcp](./frame#webmcp). [Page#webmcp](./page#webmcp) is the instance of the main frame.
+
+**NOTE**: WebMCP is an experimental browser feature. Chromium enables it with the `--enable-features=WebMCP` launch argument, Firefox with the `dom.modelcontext.enabled` and `dom.modelcontext.testing.enabled` preferences. WebKit does not implement it.
+
+Tool names, descriptions, input schemas and results are provided by the page, so treat them as untrusted input.
+
+## call_tool
+
+```
+def call_tool(name, input: nil, timeout: nil)
+```
+
+
+Calls a tool registered by the frame and returns its result. The result is whatever the tool's `execute` function resolved to, typically an object with a `content` array. A result with `isError: true` is returned as is. The method throws when the tool is not registered or its `execute` function throws.
+
+## tools
+
+```
+def tools(timeout: nil)
+```
+
+
+Returns the tools currently registered by the frame. Throws if the browser was launched without WebMCP support, see the note above for the launch options that enable it.
+
+[Page#webmcp](./page#webmcp) covers the main frame only, child frames list their tools through their own [Frame#webmcp](./frame#webmcp).

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.63.0
+ARG PLAYWRIGHT_CORE_VERSION=1.64.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

@@ -201,6 +201,7 @@
 * wait_for_selector
 * wait_for_timeout
 * wait_for_url
+* webmcp
 
 ## Worker
 
@@ -285,6 +286,7 @@
 * get_by_alt_text
 * get_by_label
 * get_by_placeholder
+* get_by_ref
 * get_by_role
 * get_by_test_id
 * get_by_text
@@ -371,6 +373,7 @@
 * request
 * screencast
 * touchscreen
+* webmcp
 
 ## BrowserContext
 
@@ -533,6 +536,7 @@
 * visible
 * wait_for
 * wait_for_function
+* within
 
 ## FrameLocator
 
@@ -568,6 +572,9 @@
 
 ## APIRequestContext
 
+* add_cookies
+* clear_cookies
+* cookies
 * delete
 * dispose
 * fetch
@@ -661,3 +668,8 @@
 * create
 * delete
 * get
+
+## WebMCP
+
+* call_tool
+* tools

data/lib/playwright/channel_owners/api_request_context.rb

@@ -3,6 +3,8 @@ require 'cgi/escape'
 
 module Playwright
   define_channel_owner :APIRequestContext do
+    include Utils::ClearCookiesParameters
+
     private def after_initialize
       @tracing = ChannelOwners::Tracing.from(@initializer['tracing'])
       @timeout_settings = TimeoutSettings.new
@@ -10,6 +12,20 @@ module Playwright
 
     attr_reader :tracing
 
+    def cookies(urls: nil)
+      @channel.send_message_to_server('cookies', urls: urls.nil? ? [] : Array(urls))
+    end
+
+    def add_cookies(cookies)
+      @channel.send_message_to_server('addCookies', cookies: cookies)
+      nil
+    end
+
+    def clear_cookies(domain: nil, name: nil, path: nil)
+      @channel.send_message_to_server('clearCookies', clear_cookies_params(domain: domain, name: name, path: path))
+      nil
+    end
+
     private def _update_timeout_settings(timeout_settings)
       @timeout_settings = timeout_settings
     end

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
@@ -274,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)
@@ -459,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
 

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)

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

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

data/lib/playwright/channel_owners/tracing.rb

@@ -18,11 +18,13 @@ module Playwright
       @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)

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