playwright-ruby-client 1.51.0 → 1.56.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f0c4c8f2c68d03a9009e450794670263e74a7bff0f94307ac38222ac402b06b
-  data.tar.gz: a21fee77abeef39269d2d84b511a37ac3df6a6f9bb0b3e881be20bd4fb055073
+  metadata.gz: 8640cc3446239876e19fb40cfca695bde42bfe4e88d2bbd6659ccde5ff6d99d4
+  data.tar.gz: e8b748b832438a286de6786e8a44317aae282604815d9b7803f19fe47d24b876
 SHA512:
-  metadata.gz: c744d68230d2f37b6ce1894d55156ecfc943739c8d713332098ed73eb2c12533fab814685eaf3efdabd5561227c1deef042aad50e22e98b91e3be2e61f9974a2
-  data.tar.gz: 8b1e2a83b1eac587c1df0963c586a64361191384018175972bf40eab3dcdb86d9b01a3d202f9d24e6b611f250ca8ead38f112252970ed0f292e4bd2fa5b5f27e
+  metadata.gz: 39c49ab82a8bb4fe056dbbba337aa266a9b1b25ec8227fbffa8b2c7e4c19ef4f63148928d42bf3252784617efc99ea7571f32a98d6a77752079e97465a402e37
+  data.tar.gz: 20d89735083a1dc2e533cffdfc41da1fe366c9ff1d309138d2894dbca1d506252f579aff1f475caea8565e8229970e3601b4d7a52e5a97de9f7593b1f8f9c744

data/CONTRIBUTING.md

@@ -0,0 +1,5 @@
+# Contributing
+
+Thanks for your interest in contributing to `playwright-ruby-client`!
+
+For development setup instructions and guidelines, please see [development/README.md](development/README.md).

data/README.md

@@ -187,6 +187,10 @@ When `Playwright.connect_to_playwright_server` is used, playwright_cli_executabl
 
 For more detailed instraction, refer this article: https://playwright-ruby-client.vercel.app/docs/article/guides/playwright_on_alpine_linux
 
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and contributing guidelines.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/documentation/docs/api/browser_context.md

@@ -73,10 +73,14 @@ browser_context.add_init_script(path: "preload.js")
 def background_pages
 ```
 
+:::warning
 
-**NOTE**: Background pages are only supported on Chromium-based browsers.
+Background pages have been removed from Chromium together with Manifest V2 extensions.
 
-All existing background pages in the context.
+:::
+
+
+Returns an empty list.
 
 ## browser
 
@@ -85,7 +89,7 @@ def browser
 ```
 
 
-Returns the browser instance of the context. If it was launched as a persistent context null gets returned.
+Gets the browser instance that owns the context. Returns `null` if the context is created outside of normal browser, e.g. Android or Electron.
 
 ## clear_cookies
 

data/documentation/docs/api/console_message.md

@@ -74,6 +74,3 @@ def type
 ```
 
 
-One of the following values: `'log'`, `'debug'`, `'info'`, `'error'`, `'warning'`, `'dir'`, `'dirxml'`, `'table'`,
-`'trace'`, `'clear'`, `'startGroup'`, `'startGroupCollapsed'`, `'endGroup'`, `'assert'`, `'profile'`, `'profileEnd'`,
-`'count'`, `'timeEnd'`.

data/documentation/docs/api/experimental/android.md

@@ -30,3 +30,13 @@ def devices(host: nil, omitDriverInstall: nil, port: nil)
 
 
 Returns the list of detected Android devices.
+
+## set_default_timeout
+
+```
+def set_default_timeout(timeout)
+```
+alias: `default_timeout=`
+
+
+This setting will change the default maximum time for all the methods accepting `timeout` option.

data/documentation/docs/api/frame.md

@@ -530,6 +530,7 @@ Many html elements have an implicitly [defined role](https://w3c.github.io/html-
 ```
 def get_by_test_id(testId)
 ```
+alias: `get_by_testid`
 
 
 Locate element by the test id.

data/documentation/docs/api/frame_locator.md

@@ -176,6 +176,7 @@ Many html elements have an implicitly [defined role](https://w3c.github.io/html-
 ```
 def get_by_test_id(testId)
 ```
+alias: `get_by_testid`
 
 
 Locate element by the test id.

data/documentation/docs/api/locator.md

@@ -317,6 +317,23 @@ When all steps combined have not finished during the specified `timeout`, this m
 
 **NOTE**: `element.dblclick()` dispatches two `click` events and a single `dblclick` event.
 
+## describe
+
+```
+def describe(description)
+```
+
+
+Describes the locator, description is used in the trace viewer and reports.
+Returns the locator pointing to the same element.
+
+**Usage**
+
+```ruby
+button = page.get_by_test_id("btn-sub").describe("Subscribe button")
+button.click
+```
+
 ## dispatch_event
 
 ```
@@ -458,6 +475,12 @@ If `expression` throws or rejects, this method throws.
 
 **Usage**
 
+Passing argument to `expression`:
+
+```ruby
+page.get_by_test_id("myId").evaluate("(element, [x, y]) => element.textContent + ' ' + x * y", arg: [7, 8]) # => "myId text 56"
+```
+
 ## evaluate_all
 
 ```
@@ -718,6 +741,7 @@ Many html elements have an implicitly [defined role](https://w3c.github.io/html-
 ```
 def get_by_test_id(testId)
 ```
+alias: `get_by_testid`
 
 
 Locate element by the test id.

data/documentation/docs/api/locator_assertions.md

@@ -116,6 +116,15 @@ expect(locator).not_to be_visible(timeout: nil, visible: nil)
 
 The opposite of [LocatorAssertions#to_be_visible](./locator_assertions#to_be_visible).
 
+## not_to_contain_class
+
+```ruby
+expect(locator).not_to contain_class(expected, timeout: nil)
+```
+
+
+The opposite of [LocatorAssertions#to_contain_class](./locator_assertions#to_contain_class).
+
 ## not_to_contain_text
 
 ```ruby
@@ -436,6 +445,43 @@ expect(
 ).to be_visible
 ```
 
+## to_contain_class
+
+```ruby
+expect(locator).to contain_class(expected, timeout: nil)
+```
+
+
+Ensures the [Locator](./locator) points to an element with given CSS classes. All classes from the asserted value, separated by spaces, must be present in the [Element.classList](https://developer.mozilla.org/en-US/docs/Web/API/Element/classList) in any order.
+
+**Usage**
+
+```html
+<div class='middle selected row' id='component'></div>
+```
+
+```ruby
+locator = page.locator("#component")
+expect(locator).to contain_class("middle selected row")
+expect(locator).to contain_class("selected")
+expect(locator).to contain_class("row middle")
+```
+
+When an array is passed, the method asserts that the list of elements located matches the corresponding list of expected class lists. Each element's class attribute is matched against the corresponding class in the array:
+
+```html
+<div class='list'>
+  <div class='component inactive'></div>
+  <div class='component active'></div>
+  <div class='component inactive'></div>
+</div>
+```
+
+```ruby
+locator = page.locator(".list > .component")
+expect(locator).to contain_class(["inactive", "active", "inactive"])
+```
+
 ## to_contain_text
 
 ```ruby
@@ -561,7 +607,7 @@ expect(locator).to have_class(expected, timeout: nil)
 ```
 
 
-Ensures the [Locator](./locator) points to an element with given CSS classes. When a string is provided, it must fully match the element's `class` attribute. To match individual classes or perform partial matches, use a regular expression:
+Ensures the [Locator](./locator) points to an element with given CSS classes. When a string is provided, it must fully match the element's `class` attribute. To match individual classes use [LocatorAssertions#to_contain_class](./locator_assertions#to_contain_class).
 
 **Usage**
 

data/documentation/docs/api/mouse.md

@@ -7,6 +7,8 @@ sidebar_position: 10
 
 The Mouse class operates in main-frame CSS pixels relative to the top-left corner of the viewport.
 
+**NOTE**: If you want to debug where the mouse moved, you can use the [Trace viewer](https://playwright.dev/python/docs/trace-viewer-intro) or [Playwright Inspector](https://playwright.dev/python/docs/running-tests). A red dot showing the location of the mouse will be shown for every mouse action.
+
 Every `page` object has its own Mouse, accessible with [Page#mouse](./page#mouse).
 
 ```ruby

data/documentation/docs/api/page.md

@@ -724,6 +724,7 @@ Many html elements have an implicitly [defined role](https://w3c.github.io/html-
 ```
 def get_by_test_id(testId)
 ```
+alias: `get_by_testid`
 
 
 Locate element by the test id.
@@ -993,6 +994,24 @@ 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.
 
+## console_messages
+
+```
+def console_messages
+```
+
+
+Returns up to (currently) 200 last console messages from this page. See [`event: Page.console`] for more details.
+
+## page_errors
+
+```
+def page_errors
+```
+
+
+Returns up to (currently) 200 last page errors from this page. See [`event: Page.pageError`] for more details.
+
 ## locator
 
 ```
@@ -1035,7 +1054,7 @@ def pause
 ```
 
 
-Pauses script execution. Playwright will stop executing the script and wait for the user to either press 'Resume'
+Pauses script execution. Playwright will stop executing the script and wait for the user to either press the 'Resume'
 button in the page overlay or to call `playwright.resume()` in the DevTools console.
 
 User can inspect selectors or perform manual steps while paused. Resume will continue running the original script from
@@ -1178,6 +1197,19 @@ def query_selector_all(selector)
 The method finds all elements matching the specified selector within the page. If no elements match the selector, the
 return value resolves to `[]`.
 
+## requests
+
+```
+def requests
+```
+
+
+Returns up to (currently) 100 last network request from this page. See [`event: Page.request`] for more details.
+
+Returned requests should be accessed immediately, otherwise they might be collected to prevent unbounded memory growth as new requests come in. Once collected, retrieving most information about the request is impossible.
+
+Note that requests reported through the [`event: Page.request`] request are not collected, so there is a trade off between efficient memory usage with [Page#requests](./page#requests) and the amount of available information reported through [`event: Page.request`].
+
 ## reload
 
 ```
@@ -1820,7 +1852,7 @@ function will throw.
 This method works across navigations:
 
 ```ruby
-%w[https://google.com https://bbc.com].each do |current_url|
+%w[https://playwright.dev/ https://playwright-ruby-client.vercel.app/].each do |current_url|
   page.goto(current_url, waitUntil: "domcontentloaded")
   element = page.wait_for_selector("img")
   puts "Loaded image: #{element["src"]}"

data/documentation/docs/api/route.md

@@ -49,6 +49,8 @@ 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).
+
 ## fallback
 
 ```

data/documentation/docs/api/selectors.md

@@ -51,3 +51,13 @@ playwright.chromium.launch do |browser|
   button_count # => 1
 end
 ```
+
+## set_test_id_attribute
+
+```
+def set_test_id_attribute(attributeName)
+```
+alias: `test_id_attribute=`
+
+
+Defines custom attribute name to be used in [Page#get_by_test_id](./page#get_by_test_id). `data-testid` is used by default.

data/documentation/docs/api/tracing.md

@@ -7,6 +7,10 @@ sidebar_position: 10
 
 API for collecting and saving Playwright traces. Playwright traces can be opened in [Trace Viewer](https://playwright.dev/python/docs/trace-viewer) after Playwright script runs.
 
+**NOTE**: You probably want to [enable tracing in your config file](https://playwright.dev/docs/api/class-testoptions#test-options-trace) instead of using `context.tracing`.
+
+The `context.tracing` API captures browser operations and network activity, but it doesn't record test assertions (like `expect` calls). We recommend [enabling tracing through Playwright Test configuration](https://playwright.dev/docs/api/class-testoptions#test-options-trace), which includes those assertions and provides a more complete trace for debugging test failures.
+
 Start recording a trace before performing actions. At the end, stop tracing and save it to a file.
 
 ```ruby
@@ -32,6 +36,10 @@ def start(
 
 Start tracing.
 
+**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`.
+
+The `context.tracing` API captures browser operations and network activity, but it doesn't record test assertions (like `expect` calls). We recommend [enabling tracing through Playwright Test configuration](https://playwright.dev/docs/api/class-testoptions#test-options-trace), which includes those assertions and provides a more complete trace for debugging test failures.
+
 **Usage**
 
 ```ruby

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

@@ -15,7 +15,7 @@ playwright.chromium.launch(headless: false) do |browser|
     # This method call should be put just after creating BrowserContext.
     context.enable_debug_console!
 
-    page = context.new_pagè
+    page = context.new_page
     page.goto('http://example.com/')
     page.pause
   end

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

@@ -25,6 +25,8 @@ However we may have trouble with bringing Playwright into:
 
 This article introduces a way to separate environments into client (for executing Playwright script) and server (for working with browsers). The main use-case assumes Docker (using Alpine Linux), however the way can be applied also into other use-cases.
 
+ref: https://playwright.dev/docs/docker#remote-connection
+
 ## Overview
 
 Playwright Ruby client is running on Alpine Linux. It just sends/receives JSON messages of Playwright-protocol via WebSocket.
@@ -33,48 +35,25 @@ Playwright server is running on a container of [official Docker image](https://h
 
 ![overview](https://user-images.githubusercontent.com/11763113/124934448-ad4d0700-e03f-11eb-942e-b9f3282bb703.png)
 
-### Playwright Server v.s. Browser Server
-
-Playwright provides two kind of methods to share the browser environments for clients.
-
-When you want to share only one browser environment, Browser server is suitable. This feature is officially supported in Playwright.
-
-- Server can be launched with [BrowserType#launchServer](https://playwright.dev/docs/api/class-browsertype#browser-type-launch-server) instead of `BrowserType#launch`.
+- Server can be launched with `npx playwright run-server` CLI command.
 - Client can connect to server with [BrowserType#connect](https://playwright.dev/docs/api/class-browsertype#browser-type-connect). In playwright-ruby-client, `BrowserType#connect` and not implemented yet and use `Playwright#connect_to_browser_server()` instead.
 
-Another method is sharing all browser environment. This method is very simple, but not an official feature, and can be changed in future.
-
-- Server can be launched with `playwright run-server` (CLI command).
-- Client can connect to server with `Playwright.connect_to_playwright_server` instead of `Playwright.create`
-
-## Playwright server/client
-
-:::caution
-
-This method is no longer supported on Playwright driver >= 1.35. See [this issue](https://github.com/YusukeIwaki/playwright-ruby-client/issues/254) for detail, and use Browser server/client method instead.
-
-:::
-
 ### Client code
 
-Many example uses `Playwright#create`, which internally uses Pipe (stdin/stdout) transport for Playwright-protocol messaging. Instead, **just use `Playwright#connect_to_playwright_server(endpoint)`** for WebSocket transport.
+Many example uses `Playwright#create`, which internally uses Pipe (stdin/stdout) transport for Playwright-protocol messaging. Instead, **use `Playwright#connect_to_browser_server(endpoint)`** for WebSocket transport.
 
 ```ruby {3}
 require 'playwright'
 
-Playwright.connect_to_playwright_server('wss://example.com:8888/ws?browser=chromium') do |playwright|
-  playwright.chromium.launch do |browser|
-    page = browser.new_page
-    page.goto('https://github.com/microsoft/playwright')
-    page.screenshot(path: 'github-microsoft-playwright.png')
-  end
+Playwright.connect_to_browser_server('wss://example.com:8888/ws') do |browser|
+  page = browser.new_page
+  page.goto('https://github.com/microsoft/playwright')
+  page.screenshot(path: 'github-microsoft-playwright.png')
 end
 ```
 
 `wss://example.com:8888/ws` is an example of endpoint URL of the Playwright server. In local development environment, it is typically `"ws://127.0.0.1:#{port}/ws"`.
 
-Note that `?browser=chromium` is important for server to determine which browser to prepare.
-
 ### Server code
 
 With the [official Docker image](https://hub.docker.com/_/microsoft-playwright) or in the local development environment with Node.js, just execute `npx playwright install && npx playwright run-server --port $PORT --path /ws`. (`$PORT` is a port number of the server)
@@ -91,45 +70,6 @@ ENV PORT 8888
 CMD ["./node_modules/.bin/playwright", "run-server", "--port", "$PORT", "--path", "/ws"]
 ```
 
-## Browser server/client
-
-### Client code
-
-Use `Playwright#connect_to_playwright_server` and pass the WebSocket URL for browser server.
-Note that this method requires a block with `Browser`, not `Playwright` or `BrowserType`.
-
-```ruby
-Playwright.connect_to_playwright_server(ws_url) do |browser|
-  page = browser.new_page
-  page.goto(...)
-  ...
-end
-```
-
-### Server code
-
-For instant use, `npx playwright launch-server --browser chromium` generates a WebSocket endpoint URL with a random path.
-
-More customization can be done by implementing JavaScript server like below:
-
-```js
-const playwright = require("playwright");
-
-option = {
-  channel: "chrome-canary",
-  headless: false,
-  port: 8080,
-  wsPath: "ws",
-};
-playwright.chromium.launchServer(option).then((server) => {
-  console.log(server.wsEndpoint());
-});
-```
-
-`port` and `wsPath` would be useful for generating static WebSocket endpoint URL.
-Other available options for `BrowserType#launchServer` can be found here:
-https://playwright.dev/docs/api/class-browsertype#browser-type-launch-server
-
 ## Debugging for connection
 
 The client and server are really quiet. This chapter shows how to check if the communication on the WebSocket works well or not.
@@ -147,7 +87,7 @@ DEBUG=1 bundle exec ruby some-automation-with-playwright.rb
 Just set an environment variable `DEBUG=pw:*` or `DEBUG=pw:server`
 
 ```
-DEBUG=pw:* npx playwright launch-server --browser chromium
+DEBUG=pw:* npx playwright run-server --browser chromium
 ```
 
 See [the official documentation](https://playwright.dev/docs/debug/#verbose-api-logs) for details.

data/documentation/docs/include/api_coverage.md

@@ -212,7 +212,7 @@
 ## Selectors
 
 * register
-* ~~set_test_id_attribute~~
+* set_test_id_attribute
 
 ## Clock
 
@@ -301,6 +301,8 @@
 * enabled?
 * hidden?
 * visible?
+* console_messages
+* page_errors
 * locator
 * main_frame
 * opener
@@ -309,6 +311,7 @@
 * press
 * query_selector
 * query_selector_all
+* requests
 * ~~add_locator_handler~~
 * ~~remove_locator_handler~~
 * reload
@@ -455,6 +458,7 @@
 * click
 * count
 * dblclick
+* describe
 * dispatch_event
 * drag_to
 * element_handle
@@ -563,6 +567,7 @@
 * not_to_be_hidden
 * not_to_be_in_viewport
 * not_to_be_visible
+* not_to_contain_class
 * not_to_contain_text
 * not_to_have_accessible_description
 * not_to_have_accessible_error_message
@@ -588,6 +593,7 @@
 * to_be_hidden
 * to_be_in_viewport
 * to_be_visible
+* to_contain_class
 * to_contain_text
 * to_have_accessible_description
 * to_have_accessible_error_message
@@ -615,7 +621,7 @@
 
 * ~~connect~~
 * devices
-* ~~set_default_timeout~~
+* set_default_timeout
 
 ## AndroidDevice
 

data/documentation/package.json

@@ -14,9 +14,9 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "^3.1.1",
-    "@docusaurus/preset-classic": "^3.1.1",
-    "@mdx-js/react": "^3.0.0",
+    "@docusaurus/core": "^3.8.1",
+    "@docusaurus/preset-classic": "^3.8.1",
+    "@mdx-js/react": "^3.1.1",
     "@svgr/webpack": "^8.1.0",
     "clsx": "^2.0.0",
     "file-loader": "^6.2.0",