playwright-ruby-client 1.37.1 → 1.39.0

data/documentation/docs/api/page.md

@@ -12,12 +12,21 @@ instance might have multiple [Page](./page) instances.
 
 This example creates a page, navigates it to a URL, and then saves a screenshot:
 
-```ruby
-playwright.webkit.launch do |browser|
-  page = browser.new_page
-  page.goto('https://example.com/')
-  page.screenshot(path: 'screenshot.png')
-end
+```python sync title=example_94e620cdbdfd41e2c9b14d561052ffa89535fc346038c4584ea4dd8520f5401c.py
+from playwright.sync_api import sync_playwright, Playwright
+
+def run(playwright: Playwright):
+    webkit = playwright.webkit
+    browser = webkit.launch()
+    context = browser.new_context()
+    page = context.new_page()
+    page.goto("https://example.com")
+    page.screenshot(path="screenshot.png")
+    browser.close()
+
+with sync_playwright() as playwright:
+    run(playwright)
+
 ```
 
 The Page class emits various events (described below) which can be handled using any of Node's native
@@ -462,18 +471,29 @@ See [BrowserContext#expose_binding](./browser_context#expose_binding) for the co
 
 An example of exposing page URL to all frames in a page:
 
-```ruby
-page.expose_binding("pageURL", ->(source) { source[:page].url })
-page.content = <<~HTML
-<script>
-  async function onClick() {
-    document.querySelector('div').textContent = await window.pageURL();
-  }
-</script>
-<button onclick="onClick()">Click me</button>
-<div></div>
-HTML
-page.locator("button").click
+```python sync title=example_4f7d99a72aaea957cc5678ed8728965338d78598d7772f47fbf23c28f0eba52d.py
+from playwright.sync_api import sync_playwright, Playwright
+
+def run(playwright: Playwright):
+    webkit = playwright.webkit
+    browser = webkit.launch(headless=false)
+    context = browser.new_context()
+    page = context.new_page()
+    page.expose_binding("pageURL", lambda source: source["page"].url)
+    page.set_content("""
+    <script>
+      async function onClick() {
+        document.querySelector('div').textContent = await window.pageURL();
+      }
+    </script>
+    <button onclick="onClick()">Click me</button>
+    <div></div>
+    """)
+    page.click("button")
+
+with sync_playwright() as playwright:
+    run(playwright)
+
 ```
 
 An example of passing an element handle:
@@ -517,24 +537,35 @@ See [BrowserContext#expose_function](./browser_context#expose_function) for cont
 
 An example of adding a `sha256` function to the page:
 
-```ruby
-require 'digest'
+```python sync title=example_0f68a39bdff02a3df161c74e81cabb8a2ff1f09f0d09f6ef9b799a6f2f19a280.py
+import hashlib
+from playwright.sync_api import sync_playwright, Playwright
 
-def sha1(text)
-  Digest::SHA256.hexdigest(text)
-end
+def sha256(text):
+    m = hashlib.sha256()
+    m.update(bytes(text, "utf8"))
+    return m.hexdigest()
+
+
+def run(playwright: Playwright):
+    webkit = playwright.webkit
+    browser = webkit.launch(headless=False)
+    page = browser.new_page()
+    page.expose_function("sha256", sha256)
+    page.set_content("""
+        <script>
+          async function onClick() {
+            document.querySelector('div').textContent = await window.sha256('PLAYWRIGHT');
+          }
+        </script>
+        <button onclick="onClick()">Click me</button>
+        <div></div>
+    """)
+    page.click("button")
+
+with sync_playwright() as playwright:
+    run(playwright)
 
-page.expose_function("sha256", method(:sha256))
-page.content = <<~HTML
-<script>
-  async function onClick() {
-    document.querySelector('div').textContent = await window.sha256('PLAYWRIGHT');
-  }
-</script>
-<button onclick="onClick()">Click me</button>
-<div></div>
-HTML
-page.locator("button").click
 ```
 
 ## fill
@@ -554,7 +585,7 @@ This method waits for an element matching `selector`, waits for [actionability](
 
 If the target element is not an `<input>`, `<textarea>` or `[contenteditable]` element, this method throws an error. However, if the element is inside the `<label>` element that has an associated [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), the control will be filled instead.
 
-To send fine-grained keyboard events, use [Page#type](./page#type).
+To send fine-grained keyboard events, use [Locator#press_sequentially](./locator#press_sequentially).
 
 ## focus
 
@@ -1324,13 +1355,14 @@ Triggers a `change` and `input` event once all the provided options have been se
 
 **Usage**
 
-```ruby
-# single selection matching the value
-page.select_option("select#colors", value: "blue")
+```python sync title=example_8260034c740933903e5a39d30a4f4e388bdffa9e82acd9a5fe1fb774752a505a.py
+# Single selection matching the value or label
+page.select_option("select#colors", "blue")
 # single selection matching both the label
-page.select_option("select#colors", label: "blue")
+page.select_option("select#colors", label="blue")
 # multiple selection
-page.select_option("select#colors", value: ["red", "green", "blue"])
+page.select_option("select#colors", value=["red", "green", "blue"])
+
 ```
 
 ## set_checked
@@ -1519,11 +1551,6 @@ To press a special key, like `Control` or `ArrowDown`, use [Keyboard#press](./ke
 
 **Usage**
 
-```ruby
-page.type("#mytextarea", "hello") # types instantly
-page.type("#mytextarea", "world", delay: 100) # types slower, like a user
-```
-
 ## uncheck
 
 ```
@@ -1649,9 +1676,20 @@ Returns when the `expression` returns a truthy value. It resolves to a JSHandle
 
 The [Page#wait_for_function](./page#wait_for_function) can be used to observe viewport size change:
 
-```ruby
-page.evaluate("window.x = 0; setTimeout(() => { window.x = 100 }, 1000);")
-page.wait_for_function("() => window.x > 0")
+```python sync title=example_83eed1f1f00ad73f641bf4a49f672e81c4faf1ca098a4a5070afeeabb88312f5.py
+from playwright.sync_api import sync_playwright, Playwright
+
+def run(playwright: Playwright):
+    webkit = playwright.webkit
+    browser = webkit.launch()
+    page = browser.new_page()
+    page.evaluate("window.x = 0; setTimeout(() => { window.x = 100 }, 1000);")
+    page.wait_for_function("() => window.x > 0")
+    browser.close()
+
+with sync_playwright() as playwright:
+    run(playwright)
+
 ```
 
 To pass an argument to the predicate of [Page#wait_for_function](./page#wait_for_function) function:
@@ -1819,12 +1857,22 @@ function will throw.
 
 This method works across navigations:
 
-```ruby
-%w[https://google.com https://bbc.com].each do |current_url|
-  page.goto(current_url, waitUntil: "domcontentloaded")
-  element = page.wait_for_selector("img")
-  puts "Loaded image: #{element["src"]}"
-end
+```python sync title=example_903c7325fd65fcdf6f22c77fc159922a568841abce60ae1b7c54ab5837401862.py
+from playwright.sync_api import sync_playwright, Playwright
+
+def run(playwright: Playwright):
+    chromium = playwright.chromium
+    browser = chromium.launch()
+    page = browser.new_page()
+    for current_url in ["https://google.com", "https://bbc.com"]:
+        page.goto(current_url, wait_until="domcontentloaded")
+        element = page.wait_for_selector("img")
+        print("Loaded image: " + str(element.get_attribute("src")))
+    browser.close()
+
+with sync_playwright() as playwright:
+    run(playwright)
+
 ```
 
 ## wait_for_timeout

data/documentation/docs/api/playwright.md

@@ -8,19 +8,20 @@ sidebar_position: 10
 Playwright module provides a method to launch a browser instance. The following is a typical example of using Playwright
 to drive automation:
 
-```ruby
-require 'playwright'
+```python sync title=example_6647e5a44b0440884026a6142606dfddad75ba1e643919b015457df4ed2e198f.py
+from playwright.sync_api import sync_playwright, Playwright
 
-Playwright.create(playwright_cli_executable_path: 'npx playwright') do |playwright|
-  chromium = playwright.chromium # or "firefox" or "webkit".
-  chromium.launch do |browser|
-    page = browser.new_page
-    page.goto('https://example.com/')
+def run(playwright: Playwright):
+    chromium = playwright.chromium # or "firefox" or "webkit".
+    browser = chromium.launch()
+    page = browser.new_page()
+    page.goto("http://example.com")
+    # other actions...
+    browser.close()
 
-    # other actions
+with sync_playwright() as playwright:
+    run(playwright)
 
-  end
-end
 ```
 
 ## chromium
@@ -33,20 +34,22 @@ This object can be used to launch or connect to Chromium, returning instances of
 
 Returns a dictionary of devices to be used with [Browser#new_context](./browser#new_context) or [Browser#new_page](./browser#new_page).
 
-```ruby
-require 'playwright'
+```python sync title=example_14d627977a4ad16a605ec5472d768a3324812fa8e7c57685561408fa6601e352.py
+from playwright.sync_api import sync_playwright, Playwright
 
-Playwright.create(playwright_cli_executable_path: 'npx playwright') do |playwright|
-  iphone = playwright.devices["iPhone 6"]
-  playwright.webkit.launch do |browser|
+def run(playwright: Playwright):
+    webkit = playwright.webkit
+    iphone = playwright.devices["iPhone 6"]
+    browser = webkit.launch()
     context = browser.new_context(**iphone)
-    page = context.new_page
-    page.goto('https://example.com/')
+    page = context.new_page()
+    page.goto("http://example.com")
+    # other actions...
+    browser.close()
 
-    # other actions
+with sync_playwright() as playwright:
+    run(playwright)
 
-  end
-end
 ```
 
 ## firefox

data/documentation/docs/api/request.md

@@ -54,6 +54,20 @@ def frame
 
 Returns the [Frame](./frame) that initiated this request.
 
+**Usage**
+
+```ruby
+frame_url = request.frame.url
+```
+
+**Details**
+
+Note that in some cases the frame is not available, and this method will throw.
+- When request originates in the Service Worker. You can use `request.serviceWorker()` to check that.
+- When navigation request is issued before the corresponding frame is created. You can use [Request#navigation_request?](./request#navigation_request?) to check that.
+
+Here is an example that handles all the cases:
+
 ## headers
 
 ```
@@ -93,6 +107,9 @@ def navigation_request?
 
 Whether this request is driving frame's navigation.
 
+Some navigation requests are issued before the corresponding frame is created, and therefore
+do not have [Request#frame](./request#frame) available.
+
 ## method
 
 ```

data/documentation/docs/api/selectors.md

@@ -21,33 +21,38 @@ Selectors must be registered before creating the page.
 
 An example of registering selector engine that queries elements based on a tag name:
 
-```ruby
-tag_selector = <<~JAVASCRIPT
-{
-    // Returns the first element matching given selector in the root's subtree.
-    query(root, selector) {
-        return root.querySelector(selector);
-    },
-    // Returns all elements matching given selector in the root's subtree.
-    queryAll(root, selector) {
-        return Array.from(root.querySelectorAll(selector));
-    }
-}
-JAVASCRIPT
-
-# Register the engine. Selectors will be prefixed with "tag=".
-playwright.selectors.register("tag", script: tag_selector)
-playwright.chromium.launch do |browser|
-  page = browser.new_page
-  page.content = '<div><button>Click me</button></div>'
-
-  # Use the selector prefixed with its name.
-  button = page.locator('tag=button')
-  # Combine it with other selector engines.
-  page.locator('tag=div').get_by_text('Click me').click
-
-  # Can use it in any methods supporting selectors.
-  button_count = page.locator('tag=button').count
-  button_count # => 1
-end
+```python sync title=example_3e739d4f0e30e20a6a698e0e17605a841c35e65e75aa3c2642f8bfc368b33f9e.py
+from playwright.sync_api import sync_playwright, Playwright
+
+def run(playwright: Playwright):
+    tag_selector = """
+      {
+          // Returns the first element matching given selector in the root's subtree.
+          query(root, selector) {
+              return root.querySelector(selector);
+          },
+          // Returns all elements matching given selector in the root's subtree.
+          queryAll(root, selector) {
+              return Array.from(root.querySelectorAll(selector));
+          }
+      }"""
+
+    # Register the engine. Selectors will be prefixed with "tag=".
+    playwright.selectors.register("tag", tag_selector)
+    browser = playwright.chromium.launch()
+    page = browser.new_page()
+    page.set_content('<div><button>Click me</button></div>')
+
+    # Use the selector prefixed with its name.
+    button = page.locator('tag=button')
+    # Combine it with built-in locators.
+    page.locator('tag=div').get_by_text('Click me').click()
+    # Can use it in any methods supporting selectors.
+    button_count = page.locator('tag=button').count()
+    print(button_count)
+    browser.close()
+
+with sync_playwright() as playwright:
+    run(playwright)
+
 ```

data/documentation/docs/include/api_coverage.md

@@ -470,6 +470,7 @@
 * or
 * page
 * press
+* press_sequentially
 * screenshot
 * scroll_into_view_if_needed
 * select_option

data/lib/playwright/channel.rb

@@ -30,6 +30,7 @@ module Playwright
     # @param params [Hash]
     # @return [Hash]
     def send_message_to_server_result(method, params)
+      check_not_collected
       with_logging do |metadata|
         @connection.send_message_to_server(@guid, method, params, metadata: metadata)
       end
@@ -39,6 +40,7 @@ module Playwright
     # @param params [Hash]
     # @returns [Concurrent::Promises::Future]
     def async_send_message_to_server(method, params = {})
+      check_not_collected
       with_logging do |metadata|
         @connection.async_send_message_to_server(@guid, method, params, metadata: metadata)
       end
@@ -74,5 +76,11 @@ module Playwright
         end,
       }
     end
+
+    private def check_not_collected
+      if @object.was_collected?
+        raise "The object has been collected to prevent unbounded heap growth."
+      end
+    end
   end
 end

data/lib/playwright/channel_owner.rb

@@ -50,13 +50,18 @@ module Playwright
       child.send(:update_parent, self)
     end
 
+    def was_collected?
+      @was_collected
+    end
+
     # used only from Connection. Not intended for public use. So keep private.
-    private def dispose!
+    private def dispose!(reason: nil)
       # Clean up from parent and connection.
       @connection.send(:delete_object_from_channel_owner, @guid)
+      @was_collected = reason == 'gc'
 
       # Dispose all children.
-      @objects.each_value { |object| object.send(:dispose!) }
+      @objects.each_value { |object| object.send(:dispose!, reason: reason) }
       @objects.clear
     end
 

data/lib/playwright/channel_owners/browser_context.rb

@@ -36,7 +36,13 @@ module Playwright
         on_service_worker(ChannelOwners::Worker.from(params['worker']))
       })
       @channel.on('console', ->(params) {
-        on_console_message(ChannelOwners::ConsoleMessage.from(params['message']))
+        on_console_message(ConsoleMessageImpl.new(params))
+      })
+      @channel.on('pageError', ->(params) {
+        on_page_error(
+          Error.parse(params['error']['error']),
+          ChannelOwners::Page.from_nullable(params['page']),
+        )
       })
       @channel.on('dialog', ->(params) {
         on_dialog(ChannelOwners::Dialog.from(params['dialog']))
@@ -97,6 +103,8 @@ module Playwright
     end
 
     private def on_route(route)
+      route.send(:update_context, self)
+
       # It is not desired to use PlaywrightApi.wrap directly.
       # However it is a little difficult to define wrapper for `handler` parameter in generate_api.
       # Just a workaround...
@@ -177,6 +185,13 @@ module Playwright
       end
     end
 
+    private def on_page_error(error, page)
+      emit(Events::BrowserContext::WebError, WebError.new(error, page))
+      if page
+        page.emit(Events::Page::PageError, error)
+      end
+    end
+
     private def on_request(request, page)
       emit(Events::BrowserContext::Request, request)
       page&.emit(Events::Page::Request, request)

data/lib/playwright/channel_owners/local_utils.rb

@@ -1,5 +1,11 @@
 module Playwright
   define_channel_owner :LocalUtils do
+    def devices
+      @devices ||= @initializer['deviceDescriptors'].map do |device|
+        [device['name'], parse_device_descriptor(device['descriptor'])]
+      end.to_h
+    end
+
     # @param zip_file [String]
     def zip(params)
       @channel.send_message_to_server('zip', params)
@@ -51,5 +57,26 @@ module Playwright
       @channel.async_send_message_to_server('addStackToTracingNoReply', callData: { id: id, stack: stack })
       nil
     end
+
+    private def parse_device_descriptor(descriptor)
+      # This return value can be passed into Browser#new_context as it is.
+      # ex:
+      # ```
+      #   iPhone = playwright.devices['iPhone 6']
+      #   context = browser.new_context(**iPhone)
+      #   page = context.new_page
+      #
+      # ```
+      {
+        userAgent: descriptor['userAgent'],
+        viewport: {
+          width: descriptor['viewport']['width'],
+          height: descriptor['viewport']['height'],
+        },
+        deviceScaleFactor: descriptor['deviceScaleFactor'],
+        isMobile: descriptor['isMobile'],
+        hasTouch: descriptor['hasTouch'],
+      }
+    end
   end
 end

data/lib/playwright/channel_owners/page.rb

@@ -96,6 +96,8 @@ module Playwright
     end
 
     private def on_route(route)
+      route.send(:update_context, self)
+
       # It is not desired to use PlaywrightApi.wrap directly.
       # However it is a little difficult to define wrapper for `handler` parameter in generate_api.
       # Just a workaround...

data/lib/playwright/channel_owners/playwright.rb

@@ -25,9 +25,7 @@ module Playwright
     end
 
     def devices
-      @devices ||= @initializer['deviceDescriptors'].map do |item|
-        [item['name'], parse_device_descriptor(item['descriptor'])]
-      end.to_h
+      @connection.local_utils.devices
     end
 
     # used only from Playwright#connect_to_browser_server
@@ -44,26 +42,5 @@ module Playwright
       end
       ::Playwright::ChannelOwners::AndroidDevice.from(@initializer['preConnectedAndroidDevice'])
     end
-
-    private def parse_device_descriptor(descriptor)
-      # This return value can be passed into Browser#new_context as it is.
-      # ex:
-      # ```
-      #   iPhone = playwright.devices['iPhone 6']
-      #   context = browser.new_context(**iPhone)
-      #   page = context.new_page
-      #
-      # ```
-      {
-        userAgent: descriptor['userAgent'],
-        viewport: {
-          width: descriptor['viewport']['width'],
-          height: descriptor['viewport']['height'],
-        },
-        deviceScaleFactor: descriptor['deviceScaleFactor'],
-        isMobile: descriptor['isMobile'],
-        hasTouch: descriptor['hasTouch'],
-      }
-    end
   end
 end

data/lib/playwright/channel_owners/request.rb

@@ -86,8 +86,24 @@ module Playwright
       ChannelOwners::Response.from_nullable(resp)
     end
 
+    class FramePageNotReadyError < StandardError
+      MESSAGE = [
+        'Frame for this navigation request is not available, because the request',
+        'was issued before the frame is created. You can check whether the request',
+        'is a navigation request by calling isNavigationRequest() method.',
+      ].join('\n').freeze
+
+      def initialize
+        super(MESSAGE)
+      end
+    end
+
     def frame
-      ChannelOwners::Frame.from(@initializer['frame'])
+      ChannelOwners::Frame.from(@initializer['frame']).tap do |result|
+        unless result.page
+          raise FramePageNotReadyError.new
+        end
+      end
     end
 
     def navigation_request?

data/lib/playwright/channel_owners/route.rb

@@ -111,7 +111,7 @@ module Playwright
     end
 
     def fetch(headers: nil, method: nil, postData: nil, url: nil, maxRedirects: nil, timeout: nil)
-      api_request_context = request.frame.page.context.request
+      api_request_context = @context.request
       api_request_context.send(:_inner_fetch,
         request,
         url,
@@ -172,5 +172,9 @@ module Playwright
       mime_types = MIME::Types.type_for(filepath)
       mime_types.first.to_s || 'application/octet-stream'
     end
+
+    private def update_context(context)
+      @context = context
+    end
   end
 end

data/lib/playwright/connection.rb

@@ -181,7 +181,7 @@ module Playwright
       end
 
       if method == "__dispose__"
-        object.send(:dispose!)
+        object.send(:dispose!, reason: params["reason"])
         return
       end
 

data/lib/playwright/console_message_impl.rb

@@ -0,0 +1,29 @@
+module Playwright
+  define_api_implementation :ConsoleMessageImpl do
+    def initialize(event)
+      @event = event
+    end
+
+    def page
+      @page ||= ChannelOwners::Page.from_nullable(@event['page'])
+    end
+
+    def type
+      @event['type']
+    end
+
+    def text
+      @event['text']
+    end
+
+    def args
+      @event['args']&.map do |arg|
+        ChannelOwner.from(arg)
+      end
+    end
+
+    def location
+      @event['location']
+    end
+  end
+end