playwright-ruby-client 1.57.0 → 1.59.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 430aa6a1bab67d9edca2cce8f72c76578402ec3aab93f296366335d23894d3dd
-  data.tar.gz: 0efe7aba9e4c2e45f6374c957dad31630e66157124f4b1b5dc2589815d39e6fc
+  metadata.gz: 959a33f7494fd33763cd54ddcf1e1c17fa0d9d37c89643aef2198f0dd452bbc9
+  data.tar.gz: ce343d14b0541fdf0ba0892b2e79456eea0ea5340b9f651f77b50c4e9a835cf6
 SHA512:
-  metadata.gz: 5d19738002e6edef932c3eba936a99ffc3b54d805640a806cb3e255542d56b72be7526cf69c6752ed409c1337899f9c132494335c76b0231601c5cd7a596a677
-  data.tar.gz: 5864d506cb7f6cfc4d0a35a65900241ca7a686f2b5e59716f16e4d4f588e832153bcff19bf71fae82bda9b91e55a7c9ee1f974e33d1541ad1a49e78a51e4b341
+  metadata.gz: bab8717bee2ff89d4735682f4e4b68b545a9812b01143fe082028aded03dcac856e63db430de66ac87cbcbfd397c16ddd1f5a774d6c33e951272e8c701b0149c
+  data.tar.gz: bba6fa2ebc246f538ccd074630c59f57c206d2942e299514c3d42b4717ae859943e42e4e2c4bc9b8a84e3680b2559f94ec1d7a0c34e7c56c7740468483ebf93e

data/README.md

@@ -174,16 +174,16 @@ npx playwright install && npx playwright run-server --port 8080 --path /ws
 and we can connect to the server with the code like this:
 
 ```ruby
-Playwright.connect_to_playwright_server('ws://127.0.0.1:8080/ws?browser=chromium') do |playwright|
-  playwright.chromium.launch do |browser|
-    page = browser.new_page
-    page.goto('https://github.com/YusukeIwaki')
-    page.screenshot(path: './YusukeIwaki.png')
-  end
+require 'playwright'
+
+Playwright.connect_to_browser_server('wss://example.com:8888/ws') do |browser|
+  page = browser.new_page
+  page.goto('https://github.com/YusukeIwaki')
+  page.screenshot(path: './YusukeIwaki.png')
 end
 ```
 
-When `Playwright.connect_to_playwright_server` is used, playwright_cli_executable_path is not required.
+When `Playwright.connect_to_browser_server` is used, playwright_cli_executable_path is not required.
 
 For more detailed instraction, refer this article: https://playwright-ruby-client.vercel.app/docs/article/guides/playwright_on_alpine_linux
 

data/documentation/docs/api/browser_context.md

@@ -238,6 +238,15 @@ def grant_permissions(permissions, origin: nil)
 Grants specified permissions to the browser context. Only grants corresponding permissions to the given origin if
 specified.
 
+## closed?
+
+```
+def closed?
+```
+
+
+Indicates that the browser context is in the process of closing or has already been closed.
+
 ## new_cdp_session
 
 ```
@@ -431,6 +440,23 @@ def storage_state(indexedDB: nil, path: nil)
 
 Returns storage state for this browser context, contains current cookies, local storage snapshot and IndexedDB snapshot.
 
+## set_storage_state
+
+```
+def set_storage_state(storageState)
+```
+alias: `storage_state=`
+
+
+Clears the existing cookies, local storage and IndexedDB entries for all origins and sets the new storage state.
+
+**Usage**
+
+```ruby
+# Load storage state from a file and apply it to the context.
+context.set_storage_state("state.json")
+```
+
 ## unroute_all
 
 ```

data/documentation/docs/api/browser_type.md

@@ -25,6 +25,7 @@ end
 def connect_over_cdp(
       endpointURL,
       headers: nil,
+      isLocal: nil,
       slowMo: nil,
       timeout: nil,
       &block)
@@ -61,9 +62,9 @@ A path where Playwright expects to find a bundled browser executable.
 ```
 def launch(
       args: nil,
+      artifactsDir: nil,
       channel: nil,
       chromiumSandbox: nil,
-      devtools: nil,
       downloadsPath: nil,
       env: nil,
       executablePath: nil,
@@ -118,6 +119,7 @@ def launch_persistent_context(
       userDataDir,
       acceptDownloads: nil,
       args: nil,
+      artifactsDir: nil,
       baseURL: nil,
       bypassCSP: nil,
       channel: nil,
@@ -126,7 +128,6 @@ def launch_persistent_context(
       colorScheme: nil,
       contrast: nil,
       deviceScaleFactor: nil,
-      devtools: nil,
       downloadsPath: nil,
       env: nil,
       executablePath: nil,

data/documentation/docs/api/console_message.md

@@ -67,6 +67,15 @@ def text
 
 The text of the console message.
 
+## timestamp
+
+```
+def timestamp
+```
+
+
+The timestamp of the console message in milliseconds since the Unix epoch.
+
 ## type
 
 ```

data/documentation/docs/api/frame.md

@@ -512,7 +512,7 @@ Consider the following DOM structure.
 <button>Submit</button>
 ```
 
-You can locate each element by it's implicit role:
+You can locate each element by its implicit role:
 
 ```ruby
 page.get_by_role("heading", name: "Sign up").visible? # => true
@@ -544,7 +544,7 @@ Consider the following DOM structure.
 <button data-testid="directions">Itinéraire</button>
 ```
 
-You can locate the element by it's test id:
+You can locate the element by its test id:
 
 ```ruby
 page.get_by_test_id("directions").click

data/documentation/docs/api/frame_locator.md

@@ -157,7 +157,7 @@ Consider the following DOM structure.
 <button>Submit</button>
 ```
 
-You can locate each element by it's implicit role:
+You can locate each element by its implicit role:
 
 ```ruby
 page.get_by_role("heading", name: "Sign up").visible? # => true
@@ -189,7 +189,7 @@ Consider the following DOM structure.
 <button data-testid="directions">Itinéraire</button>
 ```
 
-You can locate the element by it's test id:
+You can locate the element by its test id:
 
 ```ruby
 page.get_by_test_id("directions").click

data/documentation/docs/api/locator.md

@@ -87,7 +87,7 @@ button = page.get_by_role("button").and(page.get_by_title("Subscribe"))
 ## aria_snapshot
 
 ```
-def aria_snapshot(timeout: nil)
+def aria_snapshot(depth: nil, mode: nil, timeout: nil)
 ```
 
 
@@ -127,6 +127,9 @@ Below is the HTML markup and the respective ARIA snapshot:
     - link "About"
 ```
 
+An AI-optimized snapshot, controlled by `mode`, is different from a default snapshot:
+1. Includes element references `[ref=e2]`. 2. Does not wait for an element matching the locator, and throws when no elements match. 3. Includes snapshots of `<iframe>`s inside the target.
+
 ## blur
 
 ```
@@ -343,7 +346,7 @@ def description
 ```
 
 
-Returns locator description previously set with [Locator#describe](./locator#describe). Returns `null` if no custom description has been set. Prefer `Locator.toString()` for a human-readable representation, as it uses the description when available.
+Returns locator description previously set with [Locator#describe](./locator#describe). Returns `null` if no custom description has been set.
 
 **Usage**
 
@@ -744,7 +747,7 @@ Consider the following DOM structure.
 <button>Submit</button>
 ```
 
-You can locate each element by it's implicit role:
+You can locate each element by its implicit role:
 
 ```ruby
 page.get_by_role("heading", name: "Sign up").visible? # => true
@@ -776,7 +779,7 @@ Consider the following DOM structure.
 <button data-testid="directions">Itinéraire</button>
 ```
 
-You can locate the element by it's test id:
+You can locate the element by its test id:
 
 ```ruby
 page.get_by_test_id("directions").click
@@ -1082,6 +1085,16 @@ The method finds an element matching the specified selector in the locator's sub
 
 [Learn more about locators](https://playwright.dev/python/docs/locators).
 
+## normalize
+
+```
+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.
+
 ## nth
 
 ```

data/documentation/docs/api/locator_assertions.md

@@ -524,7 +524,7 @@ Let's see how we can use the assertion:
 
 ```ruby
 # ✓ Contains the right items in the right order
-expect(page.locator("ul > li")).to contain_text(["Text 1", "Text 3", "Text 4"])
+expect(page.locator("ul > li")).to contain_text(["Text 1", "Text 3"])
 
 # ✖ Wrong order
 expect(page.locator("ul > li")).to contain_text(["Text 3", "Text 2"])

data/documentation/docs/api/page.md

@@ -94,6 +94,16 @@ def bring_to_front
 
 Brings page to front (activates tab).
 
+## cancel_pick_locator
+
+```
+def cancel_pick_locator
+```
+
+
+Cancels an ongoing [Page#pick_locator](./page#pick_locator) call by deactivating pick locator mode.
+If no pick locator mode is active, this method is a no-op.
+
 ## check
 
 ```
@@ -706,7 +716,7 @@ Consider the following DOM structure.
 <button>Submit</button>
 ```
 
-You can locate each element by it's implicit role:
+You can locate each element by its implicit role:
 
 ```ruby
 page.get_by_role("heading", name: "Sign up").visible? # => true
@@ -738,7 +748,7 @@ Consider the following DOM structure.
 <button data-testid="directions">Itinéraire</button>
 ```
 
-You can locate the element by it's test id:
+You can locate the element by its test id:
 
 ```ruby
 page.get_by_test_id("directions").click
@@ -995,10 +1005,28 @@ def visible?(selector, strict: nil, timeout: nil)
 
 Returns whether the element is [visible](https://playwright.dev/python/docs/actionability#visible). `selector` that does not match any elements is considered not visible.
 
+## clear_console_messages
+
+```
+def clear_console_messages
+```
+
+
+Clears all stored console messages from this page. Subsequent calls to [Page#console_messages](./page#console_messages) will only return messages logged after the clear.
+
+## clear_page_errors
+
+```
+def clear_page_errors
+```
+
+
+Clears all stored page errors from this page. Subsequent calls to [Page#page_errors](./page#page_errors) will only return errors thrown after the clear.
+
 ## console_messages
 
 ```
-def console_messages
+def console_messages(filter: nil)
 ```
 
 
@@ -1007,7 +1035,7 @@ Returns up to (currently) 200 last console messages from this page. See [`event:
 ## page_errors
 
 ```
-def page_errors
+def page_errors(filter: nil)
 ```
 
 
@@ -1132,6 +1160,23 @@ The `format` options are:
 **NOTE**: `headerTemplate` and `footerTemplate` markup have the following limitations: > 1. Script tags inside
 templates are not evaluated. > 2. Page styles are not visible inside templates.
 
+## pick_locator
+
+```
+def pick_locator
+```
+
+
+Enters pick locator mode where hovering over page elements highlights them and shows the corresponding locator.
+Once the user clicks an element, the mode is deactivated and the [Locator](./locator) for the picked element is returned.
+
+**Usage**
+
+```ruby
+locator = page.pick_locator
+puts locator
+```
+
 ## press
 
 ```
@@ -1269,6 +1314,8 @@ end
 page.route("/api/**", method(:handle_route))
 ```
 
+If a request matches multiple registered routes, the most recently registered route takes precedence.
+
 Page routes take precedence over browser context routes (set up with [BrowserContext#route](./browser_context#route)) when request
 matches both handlers.
 
@@ -1471,6 +1518,15 @@ page.viewport_size = { width: 640, height: 480 }
 page.goto("https://example.com")
 ```
 
+## aria_snapshot
+
+```
+def aria_snapshot(depth: nil, mode: nil, timeout: nil)
+```
+
+
+Captures the aria snapshot of the page. Read more about [aria snapshots](https://playwright.dev/python/docs/aria-snapshots).
+
 ## tap_point
 
 ```
@@ -1600,7 +1656,7 @@ def video
 ```
 
 
-Video object associated with this page.
+Video object associated with this page. Can be used to access the video file when using the `recordVideo` context option.
 
 ## viewport_size
 
@@ -1943,4 +1999,11 @@ Playwright has ability to mock clock and passage of time.
 API testing helper associated with this page. This method returns the same instance as
 [BrowserContext#request](./browser_context#request) on the page's context. See [BrowserContext#request](./browser_context#request) for more details.
 
+## screencast
+
+
+`Screencast` object associated with this page.
+
+**Usage**
+
 ## touchscreen

data/documentation/docs/api/request.md

@@ -216,6 +216,19 @@ def response
 
 Returns the matching [Response](./response) object, or `null` if the response was not received due to error.
 
+## existing_response
+
+```
+def existing_response
+```
+
+
+Returns the [Response](./response) object if the response has already been received, `null` otherwise.
+
+Unlike [Request#response](./request#response), this method does not wait for the response to arrive. It returns
+immediately with the response object if the response has been received, or `null` if the response
+has not been received yet.
+
 ## sizes
 
 ```

data/documentation/docs/api/response.md

@@ -92,6 +92,15 @@ def header_values(name)
 
 Returns all values of the headers matching the name, for example `set-cookie`. The name is case-insensitive.
 
+## http_version
+
+```
+def http_version
+```
+
+
+Returns the http version used by the response.
+
 ## json
 
 ```

data/documentation/docs/api/route.md

@@ -49,7 +49,10 @@ The `headers` option applies to both the routed request and any redirects it ini
 
 [Route#continue](./route#continue) will immediately send the request to the network, other matching handlers won't be invoked. Use [Route#fallback](./route#fallback) If you want next matching handler in the chain to be invoked.
 
-**NOTE**: The `Cookie` header cannot be overridden using this method. If a value is provided, it will be ignored, and the cookie will be loaded from the browser's cookie store. To set custom cookies, use [BrowserContext#add_cookies](./browser_context#add_cookies).
+**NOTE**: Some request headers are **forbidden** and cannot be overridden (for example, `Cookie`, `Host`, `Content-Length` and others, see [this MDN page](https://developer.mozilla.org/en-US/docs/Glossary/Forbidden_request_header) for full list).
+If an override is provided for a forbidden header, it will be ignored and the original request header will be used.
+
+To set custom cookies, use [BrowserContext#add_cookies](./browser_context#add_cookies).
 
 ## fallback
 

data/documentation/docs/api/tracing.md

@@ -26,6 +26,7 @@ end
 
 ```
 def start(
+      live: nil,
       name: nil,
       screenshots: nil,
       snapshots: nil,

data/documentation/docs/article/getting_started.md

@@ -19,7 +19,7 @@ $ npx playwright install
 
 and then set `playwright_cli_executable_path: "npx playwright"` into `Playwright.create`.
 
-Other methods of installation is also available. See the detail in [Download Playwright driver](./guides/download_playwright_driver)
+Other methods of installation are also available. See the detail in [Download Playwright driver](./guides/download_playwright_driver)
 
 ## Enjoy with examples
 

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

@@ -4,7 +4,7 @@ sidebar_position: 30
 
 # Playwright inspector
 
-Playwright provides an useful inspector.
+Playwright provides a useful inspector.
 https://playwright.dev/docs/inspector/
 
 ## Overview

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

@@ -8,7 +8,7 @@ sidebar_position: 2
 
 ## Create Playwright session
 
-In oder to launch browser, it is required to create Playwright session.
+In order to launch browser, it is required to create Playwright session.
 
 In previous examples,
 
@@ -18,7 +18,7 @@ Playwright.create(playwright_cli_executable_path: 'npx playwright') do |playwrig
 end
 ```
 
-this is the exact procedure for creating Playwright session. Choose either of method for creating the session.
+this is the exact procedure for creating Playwright session. Choose either method for creating the session.
 
 ### Define scoped Playwright session with block
 
@@ -28,13 +28,13 @@ Playwright.create(playwright_cli_executable_path: 'npx playwright') do |playwrig
 end
 ```
 
-As is described repetedly, this is the recommended way for creating Playwright session. Even when any exception happens, Playwright session is safely ended on leaving the block.
+As described repeatedly, this is the recommended way for creating a Playwright session. Even when any exception happens, Playwright session is safely ended on leaving the block.
 
 Internally `playwright run-driver` session is alive during the block.
 
 ### Define start/end of the Playwright session separately without block.
 
-Sometimes we have to define separated start/end definition. `playwright-ruby-client` also allows it.
+Sometimes we have to define separate start/end definitions. `playwright-ruby-client` also allows it.
 
 ```rb
 class SomeClass
@@ -103,7 +103,7 @@ Also we can use `Browser#new_page` to create a new window and new tab at once.
 
 ```rb
 Playwright.create(playwright_cli_executable_path: 'npx playwright') do |playwright|
-  playwright.chromium.launch(headless: false) do |browser| # Chromium task icon appers in.
+  playwright.chromium.launch(headless: false) do |browser| # Chromium task icon appears.
     context = browser.new_context # Prepare new window.
     page = context.new_page # Open new window and new tab here. (about:blank)
     page.goto('https://example.com') # Navigate to a site.

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

@@ -43,9 +43,9 @@ If Playwright is running in an independent container, with docker-compose.yaml c
 
 ```
   playwright: # this is our PLAYWRIGHT_HOST value
-    image: mcr.microsoft.com/playwright:v1.56.1-noble
+    image: mcr.microsoft.com/playwright:v1.57.0-noble
     command: >
-      /bin/sh -c "npx -y playwright@1.56.1 run-server --port 3000 --host 0.0.0.0 --path /ws"
+      /bin/sh -c "npx -y playwright@1.57.0 run-server --port 3000 --host 0.0.0.0 --path /ws"
     init: true
     restart: unless-stopped
 ```
@@ -217,7 +217,7 @@ before do |example|
 end
 ```
 
-![sceenrecord](https://user-images.githubusercontent.com/11763113/121126629-71b5f600-c863-11eb-8f88-7924ab669946.gif)
+![screenrecord](https://user-images.githubusercontent.com/11763113/121126629-71b5f600-c863-11eb-8f88-7924ab669946.gif)
 
 For more details, refer [Recording video](./recording_video.md#using-screen-recording-from-capybara-driver)
 

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

@@ -85,6 +85,52 @@ describe 'example', driver: :null do
 end
 ```
 
+## Share one browser across all tests
+
+Launching a new browser for every test is slow. A better approach is to launch the browser once for the entire suite and give each test its own `BrowserContext` for isolation (fresh cookies, localStorage, and session state).
+
+The challenge is that `Playwright.create` and `playwright.chromium.launch` are block-scoped APIs — the browser shuts down when the block exits. RSpec has `before(:suite)` and `after(:suite)` but no `around(:suite)`. A `Fiber` bridges the gap: `start!` resumes the fiber until it yields the browser back, and `stop!` resumes it again so both blocks exit cleanly.
+
+```rb
+module PlaywrightBrowser
+  class << self
+    attr_reader :browser
+
+    def start!
+      @fiber = Fiber.new do
+        Playwright.create(playwright_cli_executable_path: './node_modules/.bin/playwright') do |playwright|
+          playwright.chromium.launch(headless: false) do |browser|
+            Fiber.yield(browser)
+          end
+        end
+      end
+      @browser = @fiber.resume
+    end
+
+    def stop!
+      @fiber.resume
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.before(:suite) { PlaywrightBrowser.start! }
+  config.after(:suite)  { PlaywrightBrowser.stop! }
+
+  config.around(driver: :null) do |example|
+    Capybara.current_driver = :null
+    base_url = Capybara.current_session.server.base_url
+
+    PlaywrightBrowser.browser.new_context(baseURL: base_url) do |browser_context|
+      @playwright_page = browser_context.new_page
+      example.run
+    end
+  end
+end
+```
+
+Each test gets a fresh `BrowserContext` (equivalent to a new incognito window), so cookies and storage never leak between tests. The block form of `new_context` ensures the context is always closed — even if the test raises an exception.
+
 ## Minitest Usage
 
 We can do something similar with the default Rails setup using Minitest. Here's the same example written with Minitest:

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

@@ -33,7 +33,7 @@ playwright.chromium.launch do |browser|
 
 Playwright puts videos on the directory specified at `record_video_dir`.
 
-The previous example uses [Dir#mktmpdir](https://docs.ruby-lang.org/ja/latest/method/Dir/s/mktmpdir.html) for storing videos into a temprary directory. Also we simply specify a relative or absolute path like `./my_videos/` or `/path/to/videos`.
+The previous example uses [Dir#mktmpdir](https://docs.ruby-lang.org/ja/latest/method/Dir/s/mktmpdir.html) for storing videos into a temporary directory. Also we simply specify a relative or absolute path like `./my_videos/` or `/path/to/videos`.
 
 ## Getting video path and recorded video
 
@@ -42,7 +42,7 @@ This is really confusing for beginners, but in Playwright
 * We can get the video path **only when page is alive (before calling BrowserContext#close or Page#close)**
 * We can acquire the completely saved video **only after calling  BrowserContext#close**
 
-So in most case, we have to store the video path in advance, and handle the saved video after BrowserContext is closed, as is shown the previous example code.
+So in most cases, we have to store the video path in advance, and handle the saved video after BrowserContext is closed, as shown in the previous example code.
 
 ### Using `video#save_as(path)`
 

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

@@ -5,7 +5,7 @@ sidebar_position: 20
 # Semi-automation
 
 Playwright Browser context is isolated and not persisted by default. But we can also use persistent browser context using [BrowserType#launch_persistent_context](/docs/api/browser_type#launch_persistent_context).
-This allow us to intermediate into automation, for example
+This allows us to intervene in automation, for example
 
 * Authenticate with OAuth2 manually before automation
 * Testing a page after some chrome extensions are installed manually