playwright-ruby-client 1.42.1 → 1.43.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79e99154b04a3b18273674554754ce1b06e49ae03f334b7e780f89d3b2b8c50c
-  data.tar.gz: e0939e8cde7fd6e57ec24896bf26cf0c19a371a500be3f79fa5f284ca7b047b8
+  metadata.gz: e22c38ec1a50889adfbb6664dcb445db3635bcfd3d0240113f5b7250f5a16f91
+  data.tar.gz: 74f4b27cbc4d4e0b903c46621fa7dea13249d97b17bd780436fd5635d90f3e83
 SHA512:
-  metadata.gz: 3b9a52e358b44a45294c244e88f1a7646011db15cf02d14f717b69bbaca4a81df90607a3425079a00c63bc185c8a1e4d5859244da007e67a84d9d399a40a5211
-  data.tar.gz: 1f3a94d32ce82afdd196b2cd928f590bd0278f1ea0eb1cf2cc8ae22a31fbaa5a5ab4414b6dbb0916fd0f42cc6c5609d73da48bcb960b4299215516cbe9b1ac99
+  metadata.gz: f4201f5fa8a9353daecb78860b4a142a477c64b9634560b262faaea2c53491c0b5909ec3ada0e6ece917de08a91390b479a0aca34e7d607c0c14e9cf0999579a
+  data.tar.gz: 63968771197cee749d2780fa3f822f9e154088c0ea53062b86dda770f05704344a3f1f5dd696387d419252c2d1466a83e1ffbf8810ee25f069cf48c5662804ad

data/README.md

@@ -168,13 +168,13 @@ If your environment doesn't accept installing browser or creating browser proces
 For launching Playwright server, just execute:
 
 ```
-npx playwright install && npx playwright run-server --port 8080
+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') do |playwright|
+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')

data/documentation/docs/api/browser_context.md

@@ -91,11 +91,21 @@ Returns the browser instance of the context. If it was launched as a persistent
 ## clear_cookies
 
 ```
-def clear_cookies
+def clear_cookies(domain: nil, name: nil, path: nil)
 ```
 
 
-Clears context cookies.
+Removes cookies from context. Accepts optional filter.
+
+**Usage**
+
+```ruby
+context.clear_cookies()
+context.clear_cookies(name: "session-id")
+context.clear_cookies(domain: "my-origin.com")
+context.clear_cookies(path: "/api/v1")
+context.clear_cookies(name: "session-id", domain: "my-origin.com")
+```
 
 ## clear_permissions
 
@@ -311,14 +321,16 @@ page.goto("https://example.com")
 
 It is possible to examine the request to decide the route action. For example, mocking all requests that contain some post data, and leaving all other requests as is:
 
-```python sync title=example_c78483d1434363f907c28aecef3a1c6d83c0136d98bb07c2bd326cd19e006aa9.py
-def handle_route(route: Route):
-  if ("my-string" in route.request.post_data):
-    route.fulfill(body="mocked-data")
-  else:
-    route.continue_()
-context.route("/api/**", handle_route)
-
+```ruby
+def handle_route(route, request)
+  if request.post_data["my-string"]
+    mocked_data = request.post_data.merge({ "my-string" => 'mocked-data'})
+    route.fulfill(postData: mocked_data)
+  else
+    route.continue
+  end
+end
+context.route("/api/**", method(:handle_route))
 ```
 
 Page routes (set up with [Page#route](./page#route)) take precedence over browser context routes when request matches both

data/documentation/docs/api/frame_locator.md

@@ -26,11 +26,11 @@ page.frame_locator('.result-frame').first.get_by_role('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:
+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).
 
-```ruby
-frame_locator = locator.frame_locator(':scope')
-```
+**Converting FrameLocator to Locator**
+
+If you have a [FrameLocator](./frame_locator) object it can be converted to [Locator](./locator) pointing to the same `iframe` using [FrameLocator#owner](./frame_locator#owner).
 
 ## first
 
@@ -305,3 +305,25 @@ def nth(index)
 
 
 Returns locator to the n-th matching frame. It's zero based, `nth(0)` selects the first frame.
+
+## owner
+
+```
+def owner
+```
+
+
+Returns a [Locator](./locator) object pointing to the same `iframe` as this frame locator.
+
+Useful when you have a [FrameLocator](./frame_locator) object obtained somewhere, and later on would like to interact with the `iframe` element.
+
+For a reverse operation, use [Locator#content_frame](./locator#content_frame).
+
+**Usage**
+
+```ruby
+frame_locator = page.frame_locator('iframe[name="embedded"]')
+# ...
+locator = frame_locator.owner
+locator.get_attribute('src') # => frame1.html
+```

data/documentation/docs/api/locator.md

@@ -377,6 +377,28 @@ def element_handles
 
 Resolves given locator to all matching DOM elements. If there are no matching elements, returns an empty list.
 
+## content_frame
+
+```
+def content_frame
+```
+
+
+Returns a [FrameLocator](./frame_locator) object pointing to the same `iframe` as this locator.
+
+Useful when you have a [Locator](./locator) object obtained somewhere, and later on would like to interact with the content inside the frame.
+
+For a reverse operation, use [FrameLocator#owner](./frame_locator#owner).
+
+**Usage**
+
+```ruby
+locator = page.locator('iframe[name="embedded"]')
+# ...
+frame_locator = locator.content_frame
+frame_locator.get_by_role("button").click
+```
+
 ## evaluate
 
 ```

data/documentation/docs/api/page.md

@@ -1246,14 +1246,16 @@ page.goto("https://example.com")
 
 It is possible to examine the request to decide the route action. For example, mocking all requests that contain some post data, and leaving all other requests as is:
 
-```python sync title=example_0ef62eead1348f28a69716a047f3b75c979d3230569d3720d4e7bdd0a22ef647.py
-def handle_route(route: Route):
-  if ("my-string" in route.request.post_data):
-    route.fulfill(body="mocked-data")
-  else:
-    route.continue_()
-page.route("/api/**", handle_route)
-
+```ruby
+def handle_route(route, request)
+  if request.post_data["my-string"]
+    mocked_data = request.post_data.merge({ "my-string" => 'mocked-data'})
+    route.fulfill(postData: mocked_data)
+  else
+    route.continue
+  end
+end
+page.route("/api/**", method(:handle_route))
 ```
 
 Page routes take precedence over browser context routes (set up with [BrowserContext#route](./browser_context#route)) when request

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

@@ -8,16 +8,16 @@ sidebar_position: 1
 
 Choose any of the three ways as you prefer to download the driver:
 
-* `npx`: suitable for playground use, and not suitable for continuous usage.
-* `npm install`: the best choice for most use cases, with existing Node.js environment.
-* Direct download: maybe a good choice for Docker :whale: integration.
+- `npx`: suitable for playground use, and not suitable for continuous usage.
+- `npm install`: the best choice for most use cases, with existing Node.js environment.
+- Direct download: maybe a good choice for Docker :whale: integration.
 
 :::note
 
 Also the article [Playwright on Alpine Linux](./playwright_on_alpine_linux) would be helpful if you plan to
 
-* Build a browser server/container like Selenium Grid
-* Run automation scripts on Alpine Linux
+- Build a browser server/container like Selenium Grid
+- Run automation scripts on Alpine Linux
 
 :::
 
@@ -29,7 +29,6 @@ $ npx playwright install
 
 and then set `playwright_cli_executable_path: "npx playwright"` at `Playwright.create`.
 
-
 ## Using `npm install`
 
 Actually `npx playwright` is a bit slow. We can also use `npm install` to setup.
@@ -44,15 +43,13 @@ $ ./node_modules/.bin/playwright install
 
 and then set `playwright_cli_executable_path: './node_modules/.bin/playwright'`
 
-
 ## Directly download driver without Node.js installation.
 
-Instead of npm, you can also directly download playwright driver from playwright.azureedge.net.  (The URL can be easily detected from [here](https://github.com/microsoft/playwright-python/blob/cfc1030a69d1e934cac579687a680eac53d4b9ee/setup.py#L75))
-
+Instead of npm, you can also directly download playwright driver from playwright.azureedge.net. (The URL can be easily detected from [here](https://github.com/microsoft/playwright-python/blob/cfc1030a69d1e934cac579687a680eac53d4b9ee/setup.py#L75))
 
 ```shell
 $ export PLAYWRIGHT_CLI_VERSION=$(bundle exec ruby -e 'puts Playwright::COMPATIBLE_PLAYWRIGHT_VERSION.strip')
 $ wget https://playwright.azureedge.net/builds/driver/playwright-$PLAYWRIGHT_CLI_VERSION-linux.zip
 ```
 
-and then extract it, and set `playwright_cli_executable_path: '/path/to/playwright-1.11.0-linux/playwright.sh'`
+and then extract it, and set `playwright_cli_executable_path: '/path/to/playwright-$PLAYWRIGHT_CLI_VERSION-linux/node /path/to/playwright-$PLAYWRIGHT_CLI_VERSION-linux/package/cli.js'`

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

@@ -62,7 +62,7 @@ Many example uses `Playwright#create`, which internally uses Pipe (stdin/stdout)
 ```ruby {3}
 require 'playwright'
 
-Playwright.connect_to_playwright_server('wss://example.com:8888/ws') do |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')
@@ -73,6 +73,8 @@ 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)

data/documentation/docs/include/api_coverage.md

@@ -440,6 +440,7 @@
 * drag_to
 * element_handle
 * element_handles
+* content_frame
 * evaluate
 * evaluate_all
 * evaluate_handle
@@ -500,6 +501,7 @@
 * last
 * locator
 * nth
+* owner
 
 ## APIResponse
 

data/lib/playwright/channel_owners/browser_context.rb

@@ -267,8 +267,37 @@ module Playwright
       @channel.send_message_to_server('addCookies', cookies: cookies)
     end
 
-    def clear_cookies
-      @channel.send_message_to_server('clearCookies')
+    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)
     end
 
     def grant_permissions(permissions, origin: nil)

data/lib/playwright/channel_owners/js_handle.rb

@@ -1,5 +1,7 @@
 module Playwright
   define_channel_owner :JSHandle do
+    include Utils::Errors::TargetClosedErrorMethods
+
     private def after_initialize
       @preview = @initializer['preview']
       @channel.on('previewUpdated', method(:on_preview_updated))
@@ -37,6 +39,8 @@ module Playwright
 
     def dispose
       @channel.send_message_to_server('dispose')
+    rescue => err
+      raise if !target_closed_error?(err)
     end
 
     def json_value

data/lib/playwright/channel_owners/request.rb

@@ -62,7 +62,7 @@ module Playwright
       content_type = headers['content-type']
       return unless content_type
 
-      if content_type == "application/x-www-form-urlencoded"
+      if content_type.include?("application/x-www-form-urlencoded")
         URI.decode_www_form(data).to_h
       else
         JSON.parse(data)

data/lib/playwright/connection.rb

@@ -16,6 +16,9 @@ module Playwright
         end
         raise ::Playwright::DriverCrashedError.new
       end
+      @transport.on_driver_closed do
+        cleanup
+      end
 
       @objects = {} # Hash[ guid => ChannelOwner ]
       @waiting_for_object = {} # Hash[ guid => Promise<ChannelOwner> ]

data/lib/playwright/frame_locator_impl.rb

@@ -26,6 +26,14 @@ module Playwright
         hasText: hasText)
     end
 
+    def owner
+      LocatorImpl.new(
+        frame: @frame,
+        timeout_settings: @timeout_settings,
+        selector: @frame_selector,
+      )
+    end
+
     def frame_locator(selector)
       FrameLocatorImpl.new(
         frame: @frame,

data/lib/playwright/locator_impl.rb

@@ -233,6 +233,14 @@ module Playwright
       @frame.query_selector_all(@selector)
     end
 
+    def content_frame
+      FrameLocatorImpl.new(
+        frame: @frame,
+        timeout_settings: @timeout_settings,
+        frame_selector: @selector,
+      )
+    end
+
     def filter(has: nil, hasNot: nil, hasNotText: nil, hasText: nil)
       LocatorImpl.new(
         frame: @frame,

data/lib/playwright/transport.rb

@@ -18,6 +18,10 @@ module Playwright
       @on_message = block
     end
 
+    def on_driver_closed(&block)
+      @on_driver_closed = block
+    end
+
     def on_driver_crashed(&block)
       @on_driver_crashed = block
     end
@@ -83,6 +87,7 @@ module Playwright
       end
     rescue IOError
       # disconnected by remote.
+      @on_driver_closed&.call
     end
 
     def handle_stderr
@@ -106,6 +111,7 @@ module Playwright
       end
     rescue IOError
       # disconnected by remote.
+      @on_driver_closed&.call
     end
 
     def debug_send_message(message)

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.42.1'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.42.1'
+  VERSION = '1.43.0'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.43.1'
 end

data/lib/playwright/web_socket_transport.rb

@@ -15,6 +15,10 @@ module Playwright
       @on_message = block
     end
 
+    def on_driver_closed(&block)
+      @on_driver_closed = block
+    end
+
     def on_driver_crashed(&block)
       @on_driver_crashed = block
     end
@@ -76,6 +80,10 @@ module Playwright
 
       ws.start
       @ws = promise.value!
+      @ws.on_close do |reason, code|
+        puts "[WebSocketTransport] closed with code: #{code}, reason: #{reason}"
+        @on_driver_closed&.call(reason, code)
+      end
       @ws.on_error do |error|
         puts "[WebSocketTransport] error: #{error}"
         @on_driver_crashed&.call

data/lib/playwright.rb

@@ -181,7 +181,7 @@ module Playwright
 
     # Connects to Playwright server, launched by `npx playwright launch-server chromium` or `playwright.chromium.launchServer()`
   #
-  # Playwright.connect_to_browser_server('ws://....') do |browser|
+  # Playwright.connect_to_android_server('ws://....') do |browser|
   #   page = browser.new_page
   #   ...
   # end

data/lib/playwright_api/android.rb

@@ -40,20 +40,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/android_device.rb

@@ -205,20 +205,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/api_request_context.rb

@@ -280,20 +280,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/browser.rb

@@ -202,20 +202,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/browser_context.rb

@@ -81,9 +81,19 @@ module Playwright
     end
 
     #
-    # Clears context cookies.
-    def clear_cookies
-      wrap_impl(@impl.clear_cookies)
+    # Removes cookies from context. Accepts optional filter.
+    #
+    # **Usage**
+    #
+    # ```python sync
+    # context.clear_cookies()
+    # context.clear_cookies(name="session-id")
+    # context.clear_cookies(domain="my-origin.com")
+    # context.clear_cookies(path="/api/v1")
+    # context.clear_cookies(name="session-id", domain="my-origin.com")
+    # ```
+    def clear_cookies(domain: nil, name: nil, path: nil)
+      wrap_impl(@impl.clear_cookies(domain: unwrap_impl(domain), name: unwrap_impl(name), path: unwrap_impl(path)))
     end
 
     #
@@ -438,6 +448,11 @@ module Playwright
       raise NotImplementedError.new('wait_for_event is not implemented yet.')
     end
 
+    # @nodoc
+    def owner_page=(req)
+      wrap_impl(@impl.owner_page=(unwrap_impl(req)))
+    end
+
     # @nodoc
     def pause
       wrap_impl(@impl.pause)
@@ -448,11 +463,6 @@ module Playwright
       wrap_impl(@impl.options=(unwrap_impl(req)))
     end
 
-    # @nodoc
-    def owner_page=(req)
-      wrap_impl(@impl.owner_page=(unwrap_impl(req)))
-    end
-
     # @nodoc
     def enable_debug_console!
       wrap_impl(@impl.enable_debug_console!)
@@ -465,20 +475,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/browser_type.rb

@@ -176,20 +176,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/cdp_session.rb

@@ -34,20 +34,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/dialog.rb

@@ -70,20 +70,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/element_handle.rb

@@ -575,20 +575,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/frame.rb

@@ -1049,20 +1049,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/frame_locator.rb

@@ -21,11 +21,11 @@ module Playwright
   #
   # **Converting Locator to FrameLocator**
   #
-  # If you have a `Locator` object pointing to an `iframe` it can be converted to `FrameLocator` using [`:scope`](https://developer.mozilla.org/en-US/docs/Web/CSS/:scope) CSS selector:
+  # If you have a `Locator` object pointing to an `iframe` it can be converted to `FrameLocator` using [`method: Locator.contentFrame`].
   #
-  # ```python sync
-  # frameLocator = locator.frame_locator(":scope")
-  # ```
+  # **Converting FrameLocator to Locator**
+  #
+  # If you have a `FrameLocator` object it can be converted to `Locator` pointing to the same `iframe` using [`method: FrameLocator.owner`].
   class FrameLocator < PlaywrightApi
 
     #
@@ -255,5 +255,24 @@ module Playwright
     def nth(index)
       wrap_impl(@impl.nth(unwrap_impl(index)))
     end
+
+    #
+    # Returns a `Locator` object pointing to the same `iframe` as this frame locator.
+    #
+    # Useful when you have a `FrameLocator` object obtained somewhere, and later on would like to interact with the `iframe` element.
+    #
+    # For a reverse operation, use [`method: Locator.contentFrame`].
+    #
+    # **Usage**
+    #
+    # ```python sync
+    # frame_locator = page.frame_locator("iframe[name=\"embedded\"]")
+    # # ...
+    # locator = frame_locator.owner
+    # expect(locator).to_be_visible()
+    # ```
+    def owner
+      wrap_impl(@impl.owner)
+    end
   end
 end

data/lib/playwright_api/js_handle.rb

@@ -100,20 +100,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/locator.rb

@@ -325,6 +325,25 @@ module Playwright
       wrap_impl(@impl.element_handles)
     end
 
+    #
+    # Returns a `FrameLocator` object pointing to the same `iframe` as this locator.
+    #
+    # Useful when you have a `Locator` object obtained somewhere, and later on would like to interact with the content inside the frame.
+    #
+    # For a reverse operation, use [`method: FrameLocator.owner`].
+    #
+    # **Usage**
+    #
+    # ```python sync
+    # locator = page.locator("iframe[name=\"embedded\"]")
+    # # ...
+    # frame_locator = locator.content_frame
+    # frame_locator.get_by_role("button").click()
+    # ```
+    def content_frame
+      wrap_impl(@impl.content_frame)
+    end
+
     #
     # Execute JavaScript code in the page, taking the matching element as an argument.
     #

data/lib/playwright_api/page.rb

@@ -1080,31 +1080,35 @@ module Playwright
     end
 
     #
-    # Sometimes, the web page can show an overlay that obstructs elements behind it and prevents certain actions, like click, from completing. When such an overlay is shown predictably, we recommend dismissing it as a part of your test flow. However, sometimes such an overlay may appear non-deterministically, for example certain cookies consent dialogs behave this way. In this case, [`method: Page.addLocatorHandler`] allows handling an overlay during an action that it would block.
+    # **NOTE**: This method is experimental and its behavior may change in the upcoming releases.
     #
-    # This method registers a handler for an overlay that is executed once the locator is visible on the page. The handler should get rid of the overlay so that actions blocked by it can proceed. This is useful for nondeterministic interstitial pages or dialogs, like a cookie consent dialog.
+    # When testing a web page, sometimes unexpected overlays like a "Sign up" dialog appear and block actions you want to automate, e.g. clicking a button. These overlays don't always show up in the same way or at the same time, making them tricky to handle in automated tests.
     #
-    # Note that execution time of the handler counts towards the timeout of the action/assertion that executed the handler.
+    # This method lets you set up a special function, called a handler, that activates when it detects that overlay is visible. The handler's job is to remove the overlay, allowing your test to continue as if the overlay wasn't there.
     #
-    # You can register multiple handlers. However, only a single handler will be running at a time. Any actions inside a handler must not require another handler to run.
+    # Things to keep in mind:
+    # - When an overlay is shown predictably, we recommend explicitly waiting for it in your test and dismissing it as a part of your normal test flow, instead of using [`method: Page.addLocatorHandler`].
+    # - Playwright checks for the overlay every time before executing or retrying an action that requires an [actionability check](../actionability.md), or before performing an auto-waiting assertion check. When overlay is visible, Playwright calls the handler first, and then proceeds with the action/assertion. Note that the handler is only called when you perform an action/assertion - if the overlay becomes visible but you don't perform any actions, the handler will not be triggered.
+    # - The execution time of the handler counts towards the timeout of the action/assertion that executed the handler. If your handler takes too long, it might cause timeouts.
+    # - You can register multiple handlers. However, only a single handler will be running at a time. Make sure the actions within a handler don't depend on another handler.
     #
-    # **NOTE**: Running the interceptor will alter your page state mid-test. For example it will change the currently focused element and move the mouse. Make sure that the actions that run after the interceptor are self-contained and do not rely on the focus and mouse state.
+    # **NOTE**: Running the handler will alter your page state mid-test. For example it will change the currently focused element and move the mouse. Make sure that actions that run after the handler are self-contained and do not rely on the focus and mouse state being unchanged.
     # <br />
     # <br />
     # For example, consider a test that calls [`method: Locator.focus`] followed by [`method: Keyboard.press`]. If your handler clicks a button between these two actions, the focused element most likely will be wrong, and key press will happen on the unexpected element. Use [`method: Locator.press`] instead to avoid this problem.
     # <br />
     # <br />
-    # Another example is a series of mouse actions, where [`method: Mouse.move`] is followed by [`method: Mouse.down`]. Again, when the handler runs between these two actions, the mouse position will be wrong during the mouse down. Prefer methods like [`method: Locator.click`] that are self-contained.
+    # Another example is a series of mouse actions, where [`method: Mouse.move`] is followed by [`method: Mouse.down`]. Again, when the handler runs between these two actions, the mouse position will be wrong during the mouse down. Prefer self-contained actions like [`method: Locator.click`] that do not rely on the state being unchanged by a handler.
     #
     # **Usage**
     #
-    # An example that closes a cookie dialog when it appears:
+    # An example that closes a "Sign up to the newsletter" dialog when it appears:
     #
     # ```python sync
     # # Setup the handler.
     # def handler():
-    #   page.get_by_role("button", name="Reject all cookies").click()
-    # page.add_locator_handler(page.get_by_role("button", name="Accept all cookies"), handler)
+    #   page.get_by_role("button", name="No thanks").click()
+    # page.add_locator_handler(page.get_by_text("Sign up to the newsletter"), handler)
     #
     # # Write the test as usual.
     # page.goto("https://example.com")
@@ -1743,6 +1747,16 @@ module Playwright
       raise NotImplementedError.new('wait_for_event is not implemented yet.')
     end
 
+    # @nodoc
+    def owned_context=(req)
+      wrap_impl(@impl.owned_context=(unwrap_impl(req)))
+    end
+
+    # @nodoc
+    def guid
+      wrap_impl(@impl.guid)
+    end
+
     # @nodoc
     def start_css_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
       wrap_impl(@impl.start_css_coverage(resetOnNavigation: unwrap_impl(resetOnNavigation), reportAnonymousScripts: unwrap_impl(reportAnonymousScripts)))
@@ -1763,14 +1777,10 @@ module Playwright
       wrap_impl(@impl.stop_js_coverage)
     end
 
+    # -- inherited from EventEmitter --
     # @nodoc
-    def owned_context=(req)
-      wrap_impl(@impl.owned_context=(unwrap_impl(req)))
-    end
-
-    # @nodoc
-    def guid
-      wrap_impl(@impl.guid)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     # -- inherited from EventEmitter --
@@ -1785,12 +1795,6 @@ module Playwright
       event_emitter_proxy.once(event, callback)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
-    end
-
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/playwright.rb

@@ -105,20 +105,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/request.rb

@@ -207,20 +207,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/response.rb

@@ -129,20 +129,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/route.rb

@@ -167,20 +167,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/selectors.rb

@@ -63,20 +63,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/tracing.rb

@@ -72,20 +72,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/web_socket.rb

@@ -34,20 +34,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/lib/playwright_api/worker.rb

@@ -58,20 +58,20 @@ module Playwright
 
     # -- 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
 
     # -- 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
 
     private def event_emitter_proxy

data/sig/playwright.rbs

@@ -360,7 +360,7 @@ module Playwright
     def add_init_script: (?path: (String | File), ?script: String) -> void
     def background_pages: -> Array[untyped]
     def browser: -> (nil | Browser)
-    def clear_cookies: -> void
+    def clear_cookies: (?domain: (String | Regexp), ?name: (String | Regexp), ?path: (String | Regexp)) -> void
     def clear_permissions: -> void
     def close: (?reason: String) -> void
     def cookies: (?urls: (String | Array[untyped])) -> Array[untyped]
@@ -451,6 +451,7 @@ module Playwright
     def drag_to: (Locator target, ?force: bool, ?noWaitAfter: bool, ?sourcePosition: Hash[untyped, untyped], ?targetPosition: Hash[untyped, untyped], ?timeout: Float, ?trial: bool) -> void
     def element_handle: (?timeout: Float) -> ElementHandle
     def element_handles: -> Array[untyped]
+    def content_frame: -> FrameLocator
     def evaluate: (String expression, ?arg: untyped, ?timeout: Float) -> untyped
     def evaluate_all: (String expression, ?arg: untyped) -> untyped
     def evaluate_handle: (String expression, ?arg: untyped, ?timeout: Float) -> JSHandle
@@ -514,6 +515,7 @@ module Playwright
     def last: -> FrameLocator
     def locator: ((String | Locator) selectorOrLocator, ?has: Locator, ?hasNot: Locator, ?hasNotText: (String | Regexp), ?hasText: (String | Regexp)) -> Locator
     def nth: (Integer index) -> FrameLocator
+    def owner: -> Locator
   end
 
   class APIResponse

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.42.1
+  version: 1.43.0
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-03-06 00:00:00.000000000 Z
+date: 2024-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -407,5 +407,5 @@ requirements: []
 rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
-summary: The Ruby binding of playwright driver 1.42.1
+summary: The Ruby binding of playwright driver 1.43.1
 test_files: []