playwright-ruby-client 1.20.2 → 1.23.0

data/lib/playwright/transport.rb

@@ -110,12 +110,22 @@ module Playwright
 
     def debug_send_message(message)
       metadata = message.delete(:metadata)
-      puts "\x1b[33mSEND>\x1b[0m#{message}"
+      puts "\x1b[33mSEND>\x1b[0m#{shorten_double_quoted_string(message)}"
       message[:metadata] = metadata
     end
 
     def debug_recv_message(message)
-      puts "\x1b[33mRECV>\x1b[0m#{message}"
+      puts "\x1b[33mRECV>\x1b[0m#{shorten_double_quoted_string(message)}"
+    end
+
+    def shorten_double_quoted_string(message, maxlen: 512)
+      message.to_s.gsub(/"([^"]+)"/) do |str|
+        if $1.length > maxlen
+          "\"#{$1[0...maxlen]}...\""
+        else
+          str
+        end
+      end
     end
   end
 end

data/lib/playwright/utils.rb

@@ -1,6 +1,36 @@
 module Playwright
   module Utils
     module PrepareBrowserContextOptions
+      private def prepare_record_har_options(params)
+        out_params = {
+          path: params.delete(:record_har_path)
+        }
+        if params[:record_har_url_filter]
+          opt = params.delete(:record_har_url_filter)
+          if opt.is_a?(Regexp)
+            regex = ::Playwright::JavaScript::Regex.new(opt)
+            out_params[:urlRegexSource] = regex.source
+            out_params[:urlRegexFlags] = regex.flag
+          elsif opt.is_a?(String)
+            out_params[:urlGlob] = opt
+          end
+        end
+        if params[:record_har_mode]
+          out_params[:mode] = params.delete(:record_har_mode)
+        end
+        if params[:record_har_content]
+          out_params[:content] = params.delete(:record_har_content)
+        end
+        if params[:record_har_omit_content]
+          old_api_omit_content = params.delete(:record_har_omit_content)
+          if old_api_omit_content
+            out_params[:content] ||= 'omit'
+          end
+        end
+
+        out_params
+      end
+
       # @see https://github.com/microsoft/playwright/blob/5a2cfdbd47ed3c3deff77bb73e5fac34241f649d/src/client/browserContext.ts#L265
       private def prepare_browser_context_options(params)
         if params[:noViewport] == 0
@@ -11,12 +41,7 @@ module Playwright
           params[:extraHTTPHeaders] = ::Playwright::HttpHeaders.new(params[:extraHTTPHeaders]).as_serialized
         end
         if params[:record_har_path]
-          params[:recordHar] = {
-            path: params.delete(:record_har_path)
-          }
-          if params[:record_har_omit_content]
-            params[:recordHar][:omitContent] = params.delete(:record_har_omit_content)
-          end
+          params[:recordHar] = prepare_record_har_options(params)
         end
         if params[:record_video_dir]
           params[:recordVideo] = {

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.20.2'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.20.2'
+  VERSION = '1.23.0'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.23.4'
 end

data/lib/playwright.rb

@@ -20,6 +20,7 @@ require 'playwright/channel_owner'
 require 'playwright/http_headers'
 require 'playwright/input_files'
 require 'playwright/connection'
+require 'playwright/har_router'
 require 'playwright/raw_headers'
 require 'playwright/route_handler'
 require 'playwright/select_option_values'
@@ -143,6 +144,7 @@ module Playwright
         playwright = connection.initialize_playwright
         browser = playwright.send(:pre_launched_browser)
         browser.should_close_connection_on_close!
+        browser.send(:update_browser_type, browser.browser_type)
         Execution.new(connection, PlaywrightApi.wrap(playwright), PlaywrightApi.wrap(browser))
       rescue
         connection.stop

data/lib/playwright_api/accessibility.rb

@@ -35,7 +35,8 @@ module Playwright
     #         return node
     #     for child in (node.get("children") or []):
     #         found_node = find_focused_node(child)
-    #         return found_node
+    #         if (found_node)
+    #             return found_node
     #     return None
     #
     # snapshot = page.accessibility.snapshot()

data/lib/playwright_api/android.rb

@@ -26,8 +26,8 @@ module Playwright
   class Android < PlaywrightApi
 
     # Returns the list of detected Android devices.
-    def devices(port: nil)
-      wrap_impl(@impl.devices(port: unwrap_impl(port)))
+    def devices(host: nil, omitDriverInstall: nil, port: nil)
+      wrap_impl(@impl.devices(host: unwrap_impl(host), omitDriverInstall: unwrap_impl(omitDriverInstall), port: unwrap_impl(port)))
     end
 
     # This setting will change the default maximum time for all the methods accepting `timeout` option.

data/lib/playwright_api/android_device.rb

@@ -57,18 +57,22 @@ module Playwright
           noViewport: nil,
           offline: nil,
           permissions: nil,
+          record_har_content: nil,
+          record_har_mode: nil,
           record_har_omit_content: nil,
           record_har_path: nil,
+          record_har_url_filter: nil,
           record_video_dir: nil,
           record_video_size: nil,
           reducedMotion: nil,
           screen: nil,
+          serviceWorkers: nil,
           strictSelectors: nil,
           timezoneId: nil,
           userAgent: nil,
           viewport: nil,
           &block)
-      wrap_impl(@impl.launch_browser(acceptDownloads: unwrap_impl(acceptDownloads), baseURL: unwrap_impl(baseURL), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), command: unwrap_impl(command), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), forcedColors: unwrap_impl(forcedColors), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), noViewport: unwrap_impl(noViewport), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), reducedMotion: unwrap_impl(reducedMotion), screen: unwrap_impl(screen), strictSelectors: unwrap_impl(strictSelectors), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
+      wrap_impl(@impl.launch_browser(acceptDownloads: unwrap_impl(acceptDownloads), baseURL: unwrap_impl(baseURL), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), command: unwrap_impl(command), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), forcedColors: unwrap_impl(forcedColors), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), noViewport: unwrap_impl(noViewport), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), record_har_content: unwrap_impl(record_har_content), record_har_mode: unwrap_impl(record_har_mode), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_har_url_filter: unwrap_impl(record_har_url_filter), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), reducedMotion: unwrap_impl(reducedMotion), screen: unwrap_impl(screen), serviceWorkers: unwrap_impl(serviceWorkers), strictSelectors: unwrap_impl(strictSelectors), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
     end
 
     # Performs a long tap on the widget defined by `selector`.

data/lib/playwright_api/api_request.rb

@@ -1,7 +1,7 @@
 module Playwright
-  # Exposes API that can be used for the Web API testing. Each Playwright browser context has a APIRequestContext instance
-  # attached which shares cookies with the page context. Its also possible to create a new APIRequestContext instance
-  # manually. For more information see [here](./class-apirequestcontext).
+  # Exposes API that can be used for the Web API testing. This class is used for creating `APIRequestContext` instance which
+  # in turn can be used for sending web requests. An instance of this class can be obtained via
+  # [`property: Playwright.request`]. For more information see `APIRequestContext`.
   class APIRequest < PlaywrightApi
 
     # Creates new instances of `APIRequestContext`.

data/lib/playwright_api/api_request_context.rb

@@ -1,9 +1,22 @@
 module Playwright
   # This API is used for the Web API testing. You can use it to trigger API endpoints, configure micro-services, prepare
-  # environment or the service to your e2e test. When used on `Page` or a `BrowserContext`, this API will automatically use
-  # the cookies from the corresponding `BrowserContext`. This means that if you log in using this API, your e2e test will be
+  # environment or the service to your e2e test.
+  #
+  # Each Playwright browser context has associated with it `APIRequestContext` instance which shares cookie storage with the
+  # browser context and can be accessed via [`property: BrowserContext.request`] or [`property: Page.request`]. It is also
+  # possible to create a new APIRequestContext instance manually by calling [`method: APIRequest.newContext`].
+  #
+  # **Cookie management**
+  #
+  # `APIRequestContext` retuned by [`property: BrowserContext.request`] and [`property: Page.request`] shares cookie storage
+  # with the corresponding `BrowserContext`. Each API request will have `Cookie` header populated with the values from the
+  # browser context. If the API response contains `Set-Cookie` header it will automatically update `BrowserContext` cookies
+  # and requests made from the page will pick them up. This means that if you log in using this API, your e2e test will be
   # logged in and vice versa.
   #
+  # If you want API requests to not interfere with the browser cookies you shoud create a new `APIRequestContext` by calling
+  # [`method: APIRequest.newContext`]. Such `APIRequestContext` object will have its own isolated cookie storage.
+  #
   # ```python sync
   # import os
   # from playwright.sync_api import sync_playwright

data/lib/playwright_api/browser.rb

@@ -18,6 +18,11 @@ module Playwright
   # ```
   class Browser < PlaywrightApi
 
+    # Get the browser type (chromium, firefox or webkit) that the browser belongs to.
+    def browser_type
+      wrap_impl(@impl.browser_type)
+    end
+
     # In case this browser is obtained using [`method: BrowserType.launch`], closes the browser and all of its pages (if any
     # were opened).
     #
@@ -82,19 +87,23 @@ module Playwright
           offline: nil,
           permissions: nil,
           proxy: nil,
+          record_har_content: nil,
+          record_har_mode: nil,
           record_har_omit_content: nil,
           record_har_path: nil,
+          record_har_url_filter: nil,
           record_video_dir: nil,
           record_video_size: nil,
           reducedMotion: nil,
           screen: nil,
+          serviceWorkers: nil,
           storageState: nil,
           strictSelectors: nil,
           timezoneId: nil,
           userAgent: nil,
           viewport: nil,
           &block)
-      wrap_impl(@impl.new_context(acceptDownloads: unwrap_impl(acceptDownloads), baseURL: unwrap_impl(baseURL), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), forcedColors: unwrap_impl(forcedColors), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), noViewport: unwrap_impl(noViewport), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), proxy: unwrap_impl(proxy), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), reducedMotion: unwrap_impl(reducedMotion), screen: unwrap_impl(screen), storageState: unwrap_impl(storageState), strictSelectors: unwrap_impl(strictSelectors), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
+      wrap_impl(@impl.new_context(acceptDownloads: unwrap_impl(acceptDownloads), baseURL: unwrap_impl(baseURL), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), forcedColors: unwrap_impl(forcedColors), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), noViewport: unwrap_impl(noViewport), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), proxy: unwrap_impl(proxy), record_har_content: unwrap_impl(record_har_content), record_har_mode: unwrap_impl(record_har_mode), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_har_url_filter: unwrap_impl(record_har_url_filter), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), reducedMotion: unwrap_impl(reducedMotion), screen: unwrap_impl(screen), serviceWorkers: unwrap_impl(serviceWorkers), storageState: unwrap_impl(storageState), strictSelectors: unwrap_impl(strictSelectors), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
     end
 
     # Creates a new page in a new browser context. Closing this page will close the context as well.
@@ -121,19 +130,23 @@ module Playwright
           offline: nil,
           permissions: nil,
           proxy: nil,
+          record_har_content: nil,
+          record_har_mode: nil,
           record_har_omit_content: nil,
           record_har_path: nil,
+          record_har_url_filter: nil,
           record_video_dir: nil,
           record_video_size: nil,
           reducedMotion: nil,
           screen: nil,
+          serviceWorkers: nil,
           storageState: nil,
           strictSelectors: nil,
           timezoneId: nil,
           userAgent: nil,
           viewport: nil,
           &block)
-      wrap_impl(@impl.new_page(acceptDownloads: unwrap_impl(acceptDownloads), baseURL: unwrap_impl(baseURL), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), forcedColors: unwrap_impl(forcedColors), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), noViewport: unwrap_impl(noViewport), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), proxy: unwrap_impl(proxy), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), reducedMotion: unwrap_impl(reducedMotion), screen: unwrap_impl(screen), storageState: unwrap_impl(storageState), strictSelectors: unwrap_impl(strictSelectors), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
+      wrap_impl(@impl.new_page(acceptDownloads: unwrap_impl(acceptDownloads), baseURL: unwrap_impl(baseURL), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), forcedColors: unwrap_impl(forcedColors), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), noViewport: unwrap_impl(noViewport), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), proxy: unwrap_impl(proxy), record_har_content: unwrap_impl(record_har_content), record_har_mode: unwrap_impl(record_har_mode), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_har_url_filter: unwrap_impl(record_har_url_filter), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), reducedMotion: unwrap_impl(reducedMotion), screen: unwrap_impl(screen), serviceWorkers: unwrap_impl(serviceWorkers), storageState: unwrap_impl(storageState), strictSelectors: unwrap_impl(strictSelectors), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
     end
 
     # > NOTE: This API controls [Chromium Tracing](https://www.chromium.org/developers/how-tos/trace-event-profiling-tool)

data/lib/playwright_api/browser_context.rb

@@ -225,9 +225,9 @@ module Playwright
     # Routing provides the capability to modify network requests that are made by any page in the browser context. Once route
     # is enabled, every request matching the url pattern will stall unless it's continued, fulfilled or aborted.
     #
-    # > NOTE: [`method: Page.route`] will not intercept requests intercepted by Service Worker. See
+    # > NOTE: [`method: BrowserContext.route`] will not intercept requests intercepted by Service Worker. See
     # [this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when using
-    # request interception. Via `await context.addInitScript(() => delete window.navigator.serviceWorker);`
+    # request interception by setting `Browser.newContext.serviceWorkers` to `'block'`.
     #
     # An example of a naive handler that aborts all image requests:
     #
@@ -273,6 +273,16 @@ module Playwright
       wrap_impl(@impl.route(unwrap_impl(url), unwrap_impl(handler), times: unwrap_impl(times)))
     end
 
+    # If specified the network requests that are made in the context will be served from the HAR file. Read more about
+    # [Replaying from HAR](../network.md#replaying-from-har).
+    #
+    # Playwright will not serve requests intercepted by Service Worker from the HAR file. See
+    # [this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when using
+    # request interception by setting `Browser.newContext.serviceWorkers` to `'block'`.
+    def route_from_har(har, notFound: nil, update: nil, url: nil)
+      wrap_impl(@impl.route_from_har(unwrap_impl(har), notFound: unwrap_impl(notFound), update: unwrap_impl(update), url: unwrap_impl(url)))
+    end
+
     # > NOTE: Service workers are only supported on Chromium-based browsers.
     #
     # All existing service workers in the context.
@@ -376,6 +386,11 @@ module Playwright
       wrap_impl(@impl.pause)
     end
 
+    # @nodoc
+    def options=(req)
+      wrap_impl(@impl.options=(unwrap_impl(req)))
+    end
+
     # @nodoc
     def enable_debug_console!
       wrap_impl(@impl.enable_debug_console!)
@@ -391,11 +406,6 @@ module Playwright
       wrap_impl(@impl.owner_page=(unwrap_impl(req)))
     end
 
-    # @nodoc
-    def options=(req)
-      wrap_impl(@impl.options=(unwrap_impl(req)))
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)

data/lib/playwright_api/browser_type.rb

@@ -18,12 +18,12 @@ module Playwright
   # ```
   class BrowserType < PlaywrightApi
 
-    # This methods attaches Playwright to an existing browser instance.
+    # This method attaches Playwright to an existing browser instance.
     def connect(wsEndpoint, headers: nil, slowMo: nil, timeout: nil)
       raise NotImplementedError.new('connect is not implemented yet.')
     end
 
-    # This methods attaches Playwright to an existing browser instance using the Chrome DevTools Protocol.
+    # This method attaches Playwright to an existing browser instance using the Chrome DevTools Protocol.
     #
     # The default browser context is accessible via [`method: Browser.contexts`].
     #
@@ -124,12 +124,16 @@ module Playwright
           offline: nil,
           permissions: nil,
           proxy: nil,
+          record_har_content: nil,
+          record_har_mode: nil,
           record_har_omit_content: nil,
           record_har_path: nil,
+          record_har_url_filter: nil,
           record_video_dir: nil,
           record_video_size: nil,
           reducedMotion: nil,
           screen: nil,
+          serviceWorkers: nil,
           slowMo: nil,
           strictSelectors: nil,
           timeout: nil,
@@ -138,7 +142,7 @@ module Playwright
           userAgent: nil,
           viewport: nil,
           &block)
-      wrap_impl(@impl.launch_persistent_context(unwrap_impl(userDataDir), acceptDownloads: unwrap_impl(acceptDownloads), args: unwrap_impl(args), baseURL: unwrap_impl(baseURL), bypassCSP: unwrap_impl(bypassCSP), channel: unwrap_impl(channel), chromiumSandbox: unwrap_impl(chromiumSandbox), colorScheme: unwrap_impl(colorScheme), deviceScaleFactor: unwrap_impl(deviceScaleFactor), devtools: unwrap_impl(devtools), downloadsPath: unwrap_impl(downloadsPath), env: unwrap_impl(env), executablePath: unwrap_impl(executablePath), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), forcedColors: unwrap_impl(forcedColors), geolocation: unwrap_impl(geolocation), handleSIGHUP: unwrap_impl(handleSIGHUP), handleSIGINT: unwrap_impl(handleSIGINT), handleSIGTERM: unwrap_impl(handleSIGTERM), hasTouch: unwrap_impl(hasTouch), headless: unwrap_impl(headless), httpCredentials: unwrap_impl(httpCredentials), ignoreDefaultArgs: unwrap_impl(ignoreDefaultArgs), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), noViewport: unwrap_impl(noViewport), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), proxy: unwrap_impl(proxy), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), reducedMotion: unwrap_impl(reducedMotion), screen: unwrap_impl(screen), slowMo: unwrap_impl(slowMo), strictSelectors: unwrap_impl(strictSelectors), timeout: unwrap_impl(timeout), timezoneId: unwrap_impl(timezoneId), tracesDir: unwrap_impl(tracesDir), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
+      wrap_impl(@impl.launch_persistent_context(unwrap_impl(userDataDir), acceptDownloads: unwrap_impl(acceptDownloads), args: unwrap_impl(args), baseURL: unwrap_impl(baseURL), bypassCSP: unwrap_impl(bypassCSP), channel: unwrap_impl(channel), chromiumSandbox: unwrap_impl(chromiumSandbox), colorScheme: unwrap_impl(colorScheme), deviceScaleFactor: unwrap_impl(deviceScaleFactor), devtools: unwrap_impl(devtools), downloadsPath: unwrap_impl(downloadsPath), env: unwrap_impl(env), executablePath: unwrap_impl(executablePath), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), forcedColors: unwrap_impl(forcedColors), geolocation: unwrap_impl(geolocation), handleSIGHUP: unwrap_impl(handleSIGHUP), handleSIGINT: unwrap_impl(handleSIGINT), handleSIGTERM: unwrap_impl(handleSIGTERM), hasTouch: unwrap_impl(hasTouch), headless: unwrap_impl(headless), httpCredentials: unwrap_impl(httpCredentials), ignoreDefaultArgs: unwrap_impl(ignoreDefaultArgs), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), noViewport: unwrap_impl(noViewport), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), proxy: unwrap_impl(proxy), record_har_content: unwrap_impl(record_har_content), record_har_mode: unwrap_impl(record_har_mode), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_har_url_filter: unwrap_impl(record_har_url_filter), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), reducedMotion: unwrap_impl(reducedMotion), screen: unwrap_impl(screen), serviceWorkers: unwrap_impl(serviceWorkers), slowMo: unwrap_impl(slowMo), strictSelectors: unwrap_impl(strictSelectors), timeout: unwrap_impl(timeout), timezoneId: unwrap_impl(timezoneId), tracesDir: unwrap_impl(tracesDir), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
     end
 
     # Returns browser name. For example: `'chromium'`, `'webkit'` or `'firefox'`.

data/lib/playwright_api/console_message.rb

@@ -1,5 +1,24 @@
 module Playwright
-  # `ConsoleMessage` objects are dispatched by page via the [`event: Page.console`] event.
+  # `ConsoleMessage` objects are dispatched by page via the [`event: Page.console`] event. For each console messages logged
+  # in the page there will be corresponding event in the Playwright context.
+  #
+  # ```python sync
+  # # Listen for all console logs
+  # page.on("console", lambda msg: print(msg.text))
+  #
+  # # Listen for all console events and handle errors
+  # page.on("console", lambda msg: print(f"error: {msg.text}") if msg.type == "error" else None)
+  #
+  # # Get the next console log
+  # with page.expect_console_message() as msg_info:
+  #     # Issue console.log inside the page
+  #     page.evaluate("console.log('hello', 42, { foo: 'bar' })")
+  # msg = msg_info.value
+  #
+  # # Deconstruct print arguments
+  # msg.args[0].json_value() # hello
+  # msg.args[1].json_value() # 42
+  # ```
   class ConsoleMessage < PlaywrightApi
 
     # List of arguments passed to a `console` function call. See also [`event: Page.console`].