playwright-ruby-client 1.16.0 → 1.18.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6230bd49d8e914d2ba9f4d23910e69fcc003f983cf51abb142d4361e1332fd6
-  data.tar.gz: 9cf6be0bde1f294a50604f22f8be756040a02af94c61fff376354c5b1ec8d9fe
+  metadata.gz: 36a3c1f293b4d9a4a27ac780ebce4eb4098af2cefeba6d4e66f4ddb8c49490d7
+  data.tar.gz: 3520c8afc689c71a27d9af6516461cb1871a206bc6c416aee5f99742217191c8
 SHA512:
-  metadata.gz: 97bcd9185a7ac82910dcbae93c0131cf285b9c73d881705ae9b88b01fef388b999b4001e37f866f229dba2a0cb0d81af65bee34cb4301eaf16389b927aaba334
-  data.tar.gz: 047dd6e73800e629a439341d720df9e9281e9456f5f94eeeeaf475de7d439c5b0bf97332242497937684ae919e8b603f1b532a97cf6880f16c77f4f42d400ab2
+  metadata.gz: 69a7ff8c2880d9ce5bad599f102e5a0c4e710eaa25f9d5c9323cbd579cfaac6a4252eef9321a0ee453f0200fb2ac985f79f00c5ddb5717549a8d78c5f3348afe
+  data.tar.gz: b589f69e462f5dfba205af8ee98cb58a6bcb35b4ea6742fa8bd3f3bc26e4783e9ee7cbed2fe8dced6272c64de144465d767b00859e32f602ecb08b28b2cfc399

data/documentation/docs/api/api_request_context.md

@@ -8,3 +8,52 @@ This API is used for the Web API testing. You can use it to trigger API endpoint
 environment or the service to your e2e test. When used on [Page](./page) or a [BrowserContext](./browser_context), this API will automatically use
 the cookies from the corresponding [BrowserContext](./browser_context). This means that if you log in using this API, your e2e test will be
 logged in and vice versa.
+
+```python sync title=example_6db210740dd2dcb4551c2207b3204fde7127b24c7850226b273d15c0d6624ba5.py
+import os
+from playwright.sync_api import sync_playwright
+
+REPO = "test-repo-1"
+USER = "github-username"
+API_TOKEN = os.getenv("GITHUB_API_TOKEN")
+
+with sync_playwright() as p:
+    # This will launch a new browser, create a context and page. When making HTTP
+    # requests with the internal APIRequestContext (e.g. `context.request` or `page.request`)
+    # it will automatically set the cookies to the browser page and vise versa.
+    browser = playwright.chromium.launch()
+    context = browser.new_context(base_url="https://api.github.com")
+    api_request_context = context.request
+    page = context.new_page()
+
+    # Alternatively you can create a APIRequestContext manually without having a browser context attached:
+    # api_request_context = playwright.request.new_context(base_url="https://api.github.com")
+
+
+    # Create a repository.
+    response = api_request_context.post(
+        "/user/repos",
+        headers={
+            "Accept": "application/vnd.github.v3+json",
+            # Add GitHub personal access token.
+            "Authorization": f"token {API_TOKEN}",
+        },
+        data={"name": REPO},
+    )
+    assert response.ok
+    assert response.json()["name"] == REPO
+
+    # Delete a repository.
+    response = api_request_context.delete(
+        f"/repos/{USER}/{REPO}",
+        headers={
+            "Accept": "application/vnd.github.v3+json",
+            # Add GitHub personal access token.
+            "Authorization": f"token {API_TOKEN}",
+        },
+    )
+    assert response.ok
+    assert await response.body() == '{"status": "ok"}'
+
+```
+

data/documentation/docs/api/download.md

@@ -19,9 +19,7 @@ end
 path = download.path
 ```
 
-> NOTE: Browser context **must** be created with the `acceptDownloads` set to `true` when user needs access to the
-downloaded content. If `acceptDownloads` is not set, download events are emitted, but the actual download is not
-performed and user has no access to the downloaded files.
+
 
 ## cancel
 

data/documentation/docs/api/element_handle.md

@@ -9,6 +9,8 @@ sidebar_position: 10
 ElementHandle represents an in-page DOM element. ElementHandles can be created with the [Page#query_selector](./page#query_selector)
 method.
 
+> NOTE: The use of ElementHandle is discouraged, use [Locator](./locator) objects and web-first assertions instead.
+
 ```ruby
 href_element = page.query_selector("a")
 href_element.click
@@ -20,9 +22,6 @@ ElementHandle prevents DOM element from garbage collection unless the handle is
 ElementHandle instances can be used as an argument in [Page#eval_on_selector](./page#eval_on_selector) and [Page#evaluate](./page#evaluate)
 methods.
 
-> NOTE: In most cases, you would want to use the [Locator](./locator) object instead. You should only use [ElementHandle](./element_handle) if you
-want to retain a handle to a particular DOM Node that you intend to pass into [Page#evaluate](./page#evaluate) as an argument.
-
 The difference between the [Locator](./locator) and ElementHandle is that the ElementHandle points to a particular element, while
 [Locator](./locator) captures the logic of how to retrieve an element.
 

data/documentation/docs/api/frame.md

@@ -218,6 +218,9 @@ def eval_on_selector(selector, expression, arg: nil, strict: nil)
 
 Returns the return value of `expression`.
 
+> NOTE: This method does not wait for the element to pass actionability checks and therefore can lead to the flaky
+tests. Use [Locator#evaluate](./locator#evaluate), other [Locator](./locator) helper methods or web-first assertions instead.
+
 The method finds an element matching the specified selector within the frame and passes it as a first argument to
 `expression`. See [Working with selectors](https://playwright.dev/python/docs/selectors) for more details. If no elements match the selector, the
 method throws an error.
@@ -243,6 +246,9 @@ def eval_on_selector_all(selector, expression, arg: nil)
 
 Returns the return value of `expression`.
 
+> NOTE: In most cases, [Locator#evaluate_all](./locator#evaluate_all), other [Locator](./locator) helper methods and web-first assertions do a
+better job.
+
 The method finds all elements matching the specified selector within the frame and passes an array of matched elements
 as a first argument to `expression`. See [Working with selectors](https://playwright.dev/python/docs/selectors) for more details.
 
@@ -384,6 +390,23 @@ puts frame == content_frame # => true
 
 
 
+## frame_locator
+
+```
+def frame_locator(selector)
+```
+
+When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements in
+that iframe. Following snippet locates element with text "Submit" in the iframe with id `my-frame`, like `<iframe
+id="my-frame">`:
+
+```ruby
+locator = frame.frame_locator("#my-iframe").locator("text=Submit")
+locator.click
+```
+
+
+
 ## get_attribute
 
 ```
@@ -526,7 +549,7 @@ considered not visible.
 ## locator
 
 ```
-def locator(selector)
+def locator(selector, hasText: nil)
 ```
 
 The method returns an element locator that can be used to perform actions in the frame. Locator is resolved to the
@@ -598,6 +621,8 @@ def query_selector(selector, strict: nil)
 
 Returns the ElementHandle pointing to the frame element.
 
+> NOTE: The use of [ElementHandle](./element_handle) is discouraged, use [Locator](./locator) objects and web-first assertions instead.
+
 The method finds an element matching the specified selector within the frame. See
 [Working with selectors](https://playwright.dev/python/docs/selectors) for more details. If no elements match the selector, returns `null`.
 
@@ -609,6 +634,8 @@ def query_selector_all(selector)
 
 Returns the ElementHandles pointing to the frame elements.
 
+> NOTE: The use of [ElementHandle](./element_handle) is discouraged, use [Locator](./locator) objects instead.
+
 The method finds all elements matching the specified selector within the frame. See
 [Working with selectors](https://playwright.dev/python/docs/selectors) for more details. If no elements match the selector, returns empty array.
 
@@ -878,6 +905,9 @@ def wait_for_selector(selector, state: nil, strict: nil, timeout: nil)
 Returns when element specified by selector satisfies `state` option. Returns `null` if waiting for `hidden` or
 `detached`.
 
+> NOTE: Playwright automatically waits for element to be ready before performing an action. Using [Locator](./locator) objects and
+web-first assertions make the code wait-for-selector-free.
+
 Wait for the `selector` to satisfy `state` option (either appear/disappear from dom, or become visible/hidden). If at
 the moment of calling the method `selector` already satisfies the condition, the method will return immediately. If the
 selector doesn't satisfy the condition for the `timeout` milliseconds, the function will throw.

data/documentation/docs/api/frame_locator.md

@@ -0,0 +1,79 @@
+---
+sidebar_position: 10
+---
+
+# FrameLocator
+
+FrameLocator represents a view to the `iframe` on the page. It captures the logic sufficient to retrieve the `iframe`
+and locate elements in that iframe. FrameLocator can be created with either [Page#frame_locator](./page#frame_locator) or
+[Locator#frame_locator](./locator#frame_locator) method.
+
+```ruby
+locator = page.frame_locator("my-frame").locator("text=Submit")
+locator.click
+```
+
+**Strictness**
+
+Frame locators are strict. This means that all operations on frame locators will throw if more than one element matches
+given selector.
+
+```ruby
+# Throws if there are several frames in DOM:
+page.frame_locator('.result-frame').locator('button').click
+
+# Works because we explicitly tell locator to pick the first frame:
+page.frame_locator('.result-frame').first.locator('button').click
+```
+
+**Converting Locator to FrameLocator**
+
+If you have a [Locator](./locator) object pointing to an `iframe` it can be converted to [FrameLocator](./frame_locator) using
+[`:scope`](https://developer.mozilla.org/en-US/docs/Web/CSS/:scope) CSS selector:
+
+```ruby
+frame_locator = locator.frame_locator(':scope')
+```
+
+
+
+## first
+
+```
+def first
+```
+
+Returns locator to the first matching frame.
+
+## frame_locator
+
+```
+def frame_locator(selector)
+```
+
+When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements in
+that iframe.
+
+## last
+
+```
+def last
+```
+
+Returns locator to the last matching frame.
+
+## locator
+
+```
+def locator(selector, hasText: nil)
+```
+
+The method finds an element matching the specified selector in the FrameLocator's subtree.
+
+## nth
+
+```
+def nth(index)
+```
+
+Returns locator to the n-th matching frame.

data/documentation/docs/api/locator.md

@@ -4,53 +4,10 @@ sidebar_position: 10
 
 # Locator
 
-Locator represents a view to the element(s) on the page. It captures the logic sufficient to retrieve the element at any
-given moment. Locator can be created with the [Page#locator](./page#locator) method.
-
-```ruby
-locator = page.locator("text=Submit")
-locator.click
-```
-
-The difference between the Locator and [ElementHandle](./element_handle) is that the latter points to a particular element, while Locator
-captures the logic of how to retrieve that element.
-
-In the example below, handle points to a particular DOM element on page. If that element changes text or is used by
-React to render an entirely different component, handle is still pointing to that very DOM element. This can lead to
-unexpected behaviors.
-
-```ruby
-handle = page.query_selector("text=Submit")
-handle.hover
-handle.click
-```
-
-With the locator, every time the `element` is used, up-to-date DOM element is located in the page using the selector. So
-in the snippet below, underlying DOM element is going to be located twice.
-
-```ruby
-locator = page.locator("text=Submit")
-locator.hover
-locator.click
-```
-
-**Strictness**
-
-Locators are strict. This means that all operations on locators that imply some target DOM element will throw if more
-than one element matches given selector.
-
-```ruby
-# Throws if there are several buttons in DOM:
-page.locator('button').click
-
-# Works because we explicitly tell locator to pick the first element:
-page.locator('button').first.click
-
-# Works because count knows what to do with multiple matches:
-page.locator('button').count
-```
-
+Locators are the central piece of Playwright's auto-waiting and retry-ability. In a nutshell, locators represent a way
+to find element(s) on the page at any moment. Locator can be created with the [Page#locator](./page#locator) method.
 
+[Learn more about locators](https://playwright.dev/python/docs/locators).
 
 ## all_inner_texts
 
@@ -220,6 +177,21 @@ element.dispatch_event("dragstart", eventInit: { dataTransfer: data_transfer })
 
 
 
+## drag_to
+
+```
+def drag_to(
+      target,
+      force: nil,
+      noWaitAfter: nil,
+      sourcePosition: nil,
+      targetPosition: nil,
+      timeout: nil,
+      trial: nil)
+```
+
+
+
 ## element_handle
 
 ```
@@ -329,6 +301,22 @@ def focus(timeout: nil)
 
 Calls [focus](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the element.
 
+## frame_locator
+
+```
+def frame_locator(selector)
+```
+
+When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements in
+that iframe:
+
+```ruby
+locator = page.frame_locator("text=Submit").locator("text=Submit")
+locator.click
+```
+
+
+
 ## get_attribute
 
 ```
@@ -442,11 +430,10 @@ Returns locator to the last matching element.
 ## locator
 
 ```
-def locator(selector)
+def locator(selector, hasText: nil)
 ```
 
-The method finds an element matching the specified selector in the [Locator](./locator)'s subtree. See
-[Working with selectors](https://playwright.dev/python/docs/selectors) for more details.
+The method finds an element matching the specified selector in the [Locator](./locator)'s subtree.
 
 ## nth
 

data/documentation/docs/api/page.md

@@ -315,6 +315,9 @@ page.evaluate("matchMedia('(prefers-color-scheme: no-preference)').matches") # =
 def eval_on_selector(selector, expression, arg: nil, strict: nil)
 ```
 
+> NOTE: This method does not wait for the element to pass actionability checks and therefore can lead to the flaky
+tests. Use [Locator#evaluate](./locator#evaluate), other [Locator](./locator) helper methods or web-first assertions instead.
+
 The method finds an element matching the specified selector within the page and passes it as a first argument to
 `expression`. If no elements match the selector, the method throws an error. Returns the value of `expression`.
 
@@ -337,6 +340,9 @@ Shortcut for main frame's [Frame#eval_on_selector](./frame#eval_on_selector).
 def eval_on_selector_all(selector, expression, arg: nil)
 ```
 
+> NOTE: In most cases, [Locator#evaluate_all](./locator#evaluate_all), other [Locator](./locator) helper methods and web-first assertions do a
+better job.
+
 The method finds all elements matching the specified selector within the page and passes an array of matched elements as
 a first argument to `expression`. Returns the result of `expression` invocation.
 
@@ -575,6 +581,23 @@ frame = page.frame(url: /.*domain.*/)
 
 
 
+## frame_locator
+
+```
+def frame_locator(selector)
+```
+
+When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements in
+that iframe. Following snippet locates element with text "Submit" in the iframe with id `my-frame`, like `<iframe
+id="my-frame">`:
+
+```ruby
+locator = page.frame_locator("#my-iframe").locator("text=Submit")
+locator.click
+```
+
+
+
 ## frames
 
 ```
@@ -751,7 +774,7 @@ considered not visible.
 ## locator
 
 ```
-def locator(selector)
+def locator(selector, hasText: nil)
 ```
 
 The method returns an element locator that can be used to perform actions on the page. Locator is resolved to the
@@ -905,8 +928,10 @@ page.screenshot(path: "o.png")
 def query_selector(selector, strict: nil)
 ```
 
+> NOTE: The use of [ElementHandle](./element_handle) is discouraged, use [Locator](./locator) objects and web-first assertions instead.
+
 The method finds an element matching the specified selector within the page. If no elements match the selector, the
-return value resolves to `null`. To wait for an element on the page, use [Page#wait_for_selector](./page#wait_for_selector).
+return value resolves to `null`. To wait for an element on the page, use [Locator#wait_for](./locator#wait_for).
 
 Shortcut for main frame's [Frame#query_selector](./frame#query_selector).
 
@@ -916,6 +941,8 @@ Shortcut for main frame's [Frame#query_selector](./frame#query_selector).
 def query_selector_all(selector)
 ```
 
+> NOTE: The use of [ElementHandle](./element_handle) is discouraged, use [Locator](./locator) objects and web-first assertions instead.
+
 The method finds all elements matching the specified selector within the page. If no elements match the selector, the
 return value resolves to `[]`.
 
@@ -927,8 +954,8 @@ Shortcut for main frame's [Frame#query_selector_all](./frame#query_selector_all)
 def reload(timeout: nil, waitUntil: nil)
 ```
 
-Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the
-last redirect.
+This method reloads the current page, in the same way as if the user had triggered a browser refresh. Returns the main
+resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.
 
 ## route
 
@@ -1484,6 +1511,9 @@ def wait_for_selector(selector, state: nil, strict: nil, timeout: nil)
 Returns when element specified by selector satisfies `state` option. Returns `null` if waiting for `hidden` or
 `detached`.
 
+> NOTE: Playwright automatically waits for element to be ready before performing an action. Using [Locator](./locator) objects and
+web-first assertions make the code wait-for-selector-free.
+
 Wait for the `selector` to satisfy `state` option (either appear/disappear from dom, or become visible/hidden). If at
 the moment of calling the method `selector` already satisfies the condition, the method will return immediately. If the
 selector doesn't satisfy the condition for the `timeout` milliseconds, the function will throw.

data/documentation/docs/api/request.md

@@ -127,10 +127,10 @@ def redirected_from
 Request that was redirected by the server to this one, if any.
 
 When the server responds with a redirect, Playwright creates a new [Request](./request) object. The two requests are connected by
-`redirectedFrom()` and `redirectedTo()` methods. When multiple server redirects has happened, it is possible to
-construct the whole redirect chain by repeatedly calling `redirectedFrom()`.
+[redirected_from](./request#redirected_from) and [redirected_to](./request#redirected_to) methods. When multiple server redirects has happened, it is possible to
+construct the whole redirect chain by repeatedly calling [redirected_from](./request#redirected_from).
 
-For example, if the website `http://example.com` redirects to `https://example.com`:
+For example, if the website `http://github.com` redirects to `https://github.com`:
 
 ```ruby
 response = page.goto("http://github.com")

data/documentation/docs/api/selectors.md

@@ -41,7 +41,7 @@ playwright.chromium.launch do |browser|
   page.click('tag=div >> text="Click me"')
 
   # Can use it in any methods supporting selectors.
-  button_count = page.eval_on_selector_all('tag=button', 'buttons => buttons.length')
+  button_count = page.locator('tag=button').count
   button_count # => 1
 end
 ```

data/documentation/docs/api/tracing.md

@@ -23,7 +23,7 @@ end
 ## start
 
 ```
-def start(name: nil, screenshots: nil, snapshots: nil)
+def start(name: nil, screenshots: nil, snapshots: nil, title: nil)
 ```
 
 Start tracing.
@@ -40,7 +40,7 @@ context.tracing.stop(path: 'trace.zip')
 ## start_chunk
 
 ```
-def start_chunk
+def start_chunk(title: nil)
 ```
 
 Start a new trace chunk. If you'd like to record multiple traces on the same [BrowserContext](./browser_context), use

data/documentation/docs/include/api_coverage.md

@@ -167,6 +167,7 @@
 * fill
 * focus
 * frame_element
+* frame_locator
 * get_attribute
 * goto
 * hover
@@ -264,6 +265,7 @@
 * fill
 * focus
 * frame
+* frame_locator
 * frames
 * get_attribute
 * go_back
@@ -329,6 +331,7 @@
 * accessibility
 * keyboard
 * mouse
+* ~~request~~
 * touchscreen
 
 ## BrowserContext
@@ -359,6 +362,7 @@
 * expect_event
 * expect_page
 * ~~wait_for_event~~
+* ~~request~~
 * tracing
 
 ## CDPSession
@@ -393,6 +397,7 @@
 * chromium
 * devices
 * firefox
+* ~~request~~
 * selectors
 * webkit
 
@@ -413,6 +418,7 @@
 * count
 * dblclick
 * dispatch_event
+* drag_to
 * element_handle
 * element_handles
 * evaluate
@@ -421,6 +427,7 @@
 * fill
 * first
 * focus
+* frame_locator
 * get_attribute
 * hover
 * inner_html
@@ -448,6 +455,17 @@
 * uncheck
 * wait_for
 
+## FrameLocator
+
+* first
+* frame_locator
+* last
+* locator
+* nth
+
+## LocalUtils
+
+
 ## Android
 
 * devices

data/lib/playwright/channel.rb

@@ -71,7 +71,7 @@ module Playwright
       {
         apiName: api_name,
         stack: stacks.map do |loc|
-          { file: loc.absolute_path, line: loc.lineno, function: loc.label }
+          { file: loc.absolute_path || '', line: loc.lineno, function: loc.label }
         end,
       }
     end

data/lib/playwright/channel_owners/artifact.rb

@@ -1,14 +1,13 @@
 module Playwright
   define_channel_owner :Artifact do
     private def after_initialize
-      @remote = false
       @absolute_path = @initializer['absolutePath']
     end
 
     attr_reader :absolute_path
 
     def path_after_finished
-      if @remote
+      if @connection.remote?
         raise "Path is not available when using browser_type.connect(). Use save_as() to save a local copy."
       end
       @channel.send_message_to_server('pathAfterFinished')
@@ -30,9 +29,5 @@ module Playwright
     def cancel
       @channel.send_message_to_server('cancel')
     end
-
-    private def update_as_remote
-      @remote = true
-    end
   end
 end

data/lib/playwright/channel_owners/browser.rb

@@ -7,7 +7,7 @@ module Playwright
     private def after_initialize
       @connected = true
       @closed_or_closing = false
-      @remote = false
+      @should_close_connection_on_close = false
 
       @contexts = Set.new
       @channel.on('close', method(:on_close))
@@ -58,6 +58,9 @@ module Playwright
       return if @closed_or_closing
       @closed_or_closing = true
       @channel.send_message_to_server('close')
+      if @should_close_connection_on_close
+        @connection.stop
+      end
       nil
     rescue => err
       raise unless safe_close_error?(err)
@@ -99,13 +102,8 @@ module Playwright
       @contexts << context
     end
 
-    # called from BrowserType#connectOverCDP
-    private def update_as_remote
-      @remote = true
-    end
-
-    private def remote?
-      @remote
+    private def should_close_connection_on_close!
+      @should_close_connection_on_close = true
     end
 
     # called from BrowserContext#on_close with send(:remove_context), so keep private.

data/lib/playwright/channel_owners/browser_context.rb

@@ -276,9 +276,6 @@ module Playwright
     def close
       if @options && @options.key?(:recordHar)
         har = ChannelOwners::Artifact.from(@channel.send_message_to_server('harExport'))
-        if @browser.send(:remote?)
-          har.update_as_remote
-        end
         har.save_as(@options[:recordHar][:path])
         har.delete
       end
@@ -361,5 +358,10 @@ module Playwright
     private def base_url
       @options[:baseURL]
     end
+
+    # called from Tracing
+    private def remote_connection?
+      @connection.remote?
+    end
   end
 end

data/lib/playwright/channel_owners/browser_type.rb

@@ -54,7 +54,6 @@ module Playwright
 
       result = @channel.send_message_to_server_result('connectOverCDP', params)
       browser = ChannelOwners::Browser.from(result['browser'])
-      browser.send(:update_as_remote)
 
       if result['defaultContext']
         context = ChannelOwners::BrowserContext.from(result['defaultContext'])