playwright-ruby-client 1.57.2.alpha1 → 1.58.1.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d2a03c73551065e1c8bf121c3784103fb51b5dd4d9fd3b8f63cb2e86907369a
-  data.tar.gz: 7a66180bf3f8eae379ae8a4cbd5e1d67d8531cdfc0689719cf96524f294c5b89
+  metadata.gz: 78c64e38b462ad2449eda1349128c44ae6dbe7adae66570b76cd886e005f418f
+  data.tar.gz: d410ab0adf418bbf8f43925984a95663b7f947519b85e9afa93bec64daf76f06
 SHA512:
-  metadata.gz: 7ec32a794ca503b5d95c147834bbd7dd0b0e6c4b8b803df15c35cbe6f2044062cbc709eab9641a55da9aff084f549b98296ffe64d20a44e0ad2a41099e521927
-  data.tar.gz: 6bfce7e393d7ab498639dca2342dfe3434b87ce0bee462b7e8c42017965ff9512e1d232de2126de0b92983dc0eb9faa1c084283eac1521b2bceb4a2d8b152be3
+  metadata.gz: 319787778e82280859a291247e01b4fc5626b12974e9d7e08fd7331beb596696f15cc83c09d9b6f2cb5a76c15ef30308cc9e9eb7f2f16462188d08bc72546ddc
+  data.tar.gz: df5b988a9124a42006720bee860c3ebc91804ebc9ce396a922b0dbd0e1a1c81798912cd42530f91dcde49da83432b60be17cded55408548d7e795a7991b8276b

data/AGENTS.md

@@ -0,0 +1,4 @@
+# AGENTS.md
+
+When working in this repository, read `CLAUDE.md` first and follow its mandatory checks.  
+For detailed rules and workflows, refer to `CLAUDE/*.md`.

data/CLAUDE/api_generation.md

@@ -0,0 +1,28 @@
+# API Generation
+
+## Source of generated artifacts
+
+- Input: `development/api.json`
+- Generator script: `development/generate_api.rb`
+
+## Generated outputs
+
+- `lib/playwright_api/*.rb`
+- `documentation/docs/api/**/*.md`
+- `documentation/docs/include/api_coverage.md`
+- `sig/playwright.rbs`
+- `development/unimplemented_examples.md`
+
+## Critical rules
+
+- `lib/playwright_api/` is not tracked by Git (`lib/playwright_api/.gitignore` only).
+- Do not manually edit `lib/playwright_api/*.rb`.
+- Re-run `development/generate_api.rb` whenever API specs change.
+
+## Typical command set
+
+```sh
+rm lib/playwright_api/*.rb
+find documentation/docs -name "*.md" | grep -v documentation/docs/article/ | xargs rm
+bundle exec ruby development/generate_api.rb
+```

data/CLAUDE/ci_expectations.md

@@ -0,0 +1,23 @@
+# CI Expectations
+
+## Main guardrails
+
+`/.github/workflows/check.yml` detects stale generated artifacts.
+
+Checked paths:
+
+- `development/api.json`
+- `documentation/docs/**`
+- `development/unimplemented_examples.md`
+
+## Practical implication
+
+- If API-related code changes, regenerate artifacts before finishing.
+- If you open a PR without regeneration, `check.yml` will likely fail.
+
+## Related workflows
+
+- `/.github/workflows/rspec.yml`
+- `/.github/workflows/deploy.yml`
+
+These workflows also depend on `bundle exec ruby development/generate_api.rb`.

data/CLAUDE/gem_release_flow.md

@@ -0,0 +1,39 @@
+# Gem Release Flow
+
+## Overview
+
+Pushing a Git tag triggers `.github/workflows/deploy.yml`, which builds and publishes the gem to RubyGems.
+
+## Tag format
+
+The deploy workflow triggers on tags matching these patterns:
+
+- `X.Y.Z` — stable release (e.g. `1.58.0`)
+- `X.Y.betaN` — beta release (e.g. `1.58.beta1`)
+- `X.Y.Z.alphaN` — alpha release (e.g. `1.58.1.alpha1`)
+
+## Steps to release
+
+1. Update `lib/playwright/version.rb`:
+   - Set `Playwright::VERSION` to the target version string.
+   - `COMPATIBLE_PLAYWRIGHT_VERSION` stays at the base Playwright version.
+
+2. Commit the version change.
+
+3. Create and push a Git tag matching the version exactly:
+   ```sh
+   git tag 1.58.1.alpha1
+   git push origin 1.58.1.alpha1
+   ```
+
+4. The deploy workflow will:
+   - Check out the tagged commit.
+   - Verify `Playwright::VERSION == RELEASE_TAG` (must match exactly).
+   - Run `bundle exec ruby development/generate_api.rb` to generate API code.
+   - Run `rake build` to build the gem.
+   - Push the gem to RubyGems using the `RUBYGEMS_API_KEY` secret.
+
+## Important notes
+
+- The `Playwright::VERSION` in `lib/playwright/version.rb` **must exactly match** the Git tag name. If they differ, the deploy job fails at the version check step.
+- Alpha/beta tags do NOT require a separate branch — they can be tagged on any commit.

data/CLAUDE/past_upgrade_pr_patterns.md

@@ -0,0 +1,42 @@
+# Past Upgrade PR Patterns
+
+Common patterns observed from `Update Playwright driver to 1.xx.x` PRs reviewed with `gh`.
+
+## PR sample
+
+- `#366` (1.58.0)
+- `#360` (1.57.0)
+- `#354` (1.56.1)
+- `#348` (1.55.0)
+- `#341` (1.54.1)
+- `#336` (1.53.0)
+- `#331` (1.52.0)
+- `#327` (1.51.0)
+
+## Frequently changed files
+
+Almost every time:
+
+- `development/CLI_VERSION`
+- `development/api.json`
+- `lib/playwright/version.rb`
+
+High frequency:
+
+- `documentation/docs/api/*.md`
+- `documentation/docs/include/api_coverage.md`
+- `development/generate_api/example_codes.rb`
+- `spec/integration/example_spec.rb`
+- `lib/playwright/channel_owners/page.rb`
+- `lib/playwright/locator_impl.rb`
+
+Sometimes:
+
+- `development/generate_api.rb`
+- `development/unimplemented_examples.md`
+
+## Work style trend
+
+- The first commit often updates version files and generated API artifacts.
+- Follow-up commits often add/update specs and then implement `lib/playwright/**` changes.
+- Broader upstream changes usually increase docs/example/assets updates.

data/CLAUDE/playwright_upgrade_workflow.md

@@ -0,0 +1,35 @@
+# Playwright Upgrade Workflow
+
+## Scope
+
+Standard process for `Update Playwright driver to 1.xx.x` tasks.
+
+## Order (Do not reorder)
+
+1. Update versions
+- `development/CLI_VERSION`
+- `lib/playwright/version.rb` (`VERSION`, `COMPATIBLE_PLAYWRIGHT_VERSION`)
+
+2. Update API definition
+- Set `PLAYWRIGHT_CLI_EXECUTABLE_PATH`
+- `$PLAYWRIGHT_CLI_EXECUTABLE_PATH print-api-json | jq . > development/api.json`
+
+3. Clean before generation + regenerate
+- `rm lib/playwright_api/*.rb`
+- `find documentation/docs -name "*.md" | grep -v documentation/docs/article/ | xargs rm`
+- `bundle exec ruby development/generate_api.rb`
+
+4. Update tests first
+- Add/update `spec/` changes that represent upstream behavior differences.
+
+5. Implement
+- Apply minimal implementation changes in `lib/playwright/**`.
+
+6. Run tests
+- `bundle exec rspec`
+- Run focused specs first while iterating, then run the full suite.
+
+## Notes
+
+- During upgrade work, prefer the steps in `development/README.md`.
+- `development/update_playwright_driver.sh` can be used as a helper script.

data/CLAUDE/rspec_debugging.md

@@ -0,0 +1,30 @@
+# RSpec Debugging
+
+## Critical execution rule
+
+- Run RSpec via `rbenv exec`.
+- Some environments fail with plain `bundle exec rspec`, so always use `rbenv exec bundle exec rspec ...`.
+
+## Debug rule when spec fails
+
+- On failure, rerun with `DEBUG=1`.
+- Use `DEBUG=1` output to inspect Playwright protocol logs and isolate the issue.
+
+## Example
+
+```sh
+rbenv exec bundle exec rspec spec/integration/page/aria_snapshot_ai_spec.rb
+```
+
+```sh
+DEBUG=1 rbenv exec bundle exec rspec spec/integration/page/aria_snapshot_ai_spec.rb
+```
+
+## Node.js Playwright protocol log
+
+- Node.js Playwright protocol logs can be captured with `DEBUG=pw:*`.
+- This is useful when comparing behavior against the Ruby client.
+
+```sh
+DEBUG=pw:* node script.mjs 2>&1 | head -200
+```

data/CLAUDE/unimplemented_examples.md

@@ -0,0 +1,18 @@
+# unimplemented_examples.md
+
+## What it is
+
+- `development/unimplemented_examples.md` is a generated artifact.
+- It lists examples from API docs that could not be converted to Ruby examples.
+
+## How examples are converted
+
+- Source: API doc comments
+- Conversion rules: `development/generate_api/example_codes.rb`
+- Unmapped examples remain in Python in docs and are listed in `development/unimplemented_examples.md`.
+
+## When this file changes
+
+1. Review the diff to identify unmapped examples.
+2. Add conversion mappings to `development/generate_api/example_codes.rb` when needed.
+3. Re-run `bundle exec ruby development/generate_api.rb`.

data/CLAUDE.md

@@ -0,0 +1,32 @@
+# CLAUDE.md
+
+This file contains only the checks that must be verified first.  
+For detailed rules, see `CLAUDE/*.md`.
+
+## Must Check First
+
+1. Determine first whether the task is a Playwright version upgrade.
+2. Confirm generated-code handling.
+- `lib/playwright_api/*.rb` is auto-generated by `development/generate_api.rb`.
+- `lib/playwright_api/` is not tracked by Git. Do not edit generated files manually.
+3. Confirm change order.
+- For version upgrade work, update tests first, then implement `lib/playwright/**`.
+4. Confirm generation and diff consistency.
+- Update `development/api.json`, run generation, and verify generated diffs.
+5. Confirm CI-required generated files.
+- `development/api.json`
+- `documentation/docs/**`
+- `development/unimplemented_examples.md`
+6. Confirm RSpec execution mode (critical).
+- Run RSpec via `rbenv exec`.
+- On failure, rerun with `DEBUG=1` and inspect protocol logs.
+
+## Topic Docs
+
+- `CLAUDE/playwright_upgrade_workflow.md`
+- `CLAUDE/api_generation.md`
+- `CLAUDE/unimplemented_examples.md`
+- `CLAUDE/ci_expectations.md`
+- `CLAUDE/past_upgrade_pr_patterns.md`
+- `CLAUDE/rspec_debugging.md`
+- `CLAUDE/gem_release_flow.md`

data/documentation/docs/api/browser_type.md

@@ -25,6 +25,7 @@ end
 def connect_over_cdp(
       endpointURL,
       headers: nil,
+      isLocal: nil,
       slowMo: nil,
       timeout: nil,
       &block)
@@ -63,7 +64,6 @@ def launch(
       args: nil,
       channel: nil,
       chromiumSandbox: nil,
-      devtools: nil,
       downloadsPath: nil,
       env: nil,
       executablePath: nil,
@@ -126,7 +126,6 @@ def launch_persistent_context(
       colorScheme: nil,
       contrast: nil,
       deviceScaleFactor: nil,
-      devtools: nil,
       downloadsPath: nil,
       env: nil,
       executablePath: nil,

data/documentation/docs/api/locator.md

@@ -343,7 +343,7 @@ def description
 ```
 
 
-Returns locator description previously set with [Locator#describe](./locator#describe). Returns `null` if no custom description has been set. Prefer `Locator.toString()` for a human-readable representation, as it uses the description when available.
+Returns locator description previously set with [Locator#describe](./locator#describe). Returns `null` if no custom description has been set.
 
 **Usage**
 

data/documentation/docs/api/locator_assertions.md

@@ -524,7 +524,7 @@ Let's see how we can use the assertion:
 
 ```ruby
 # ✓ Contains the right items in the right order
-expect(page.locator("ul > li")).to contain_text(["Text 1", "Text 3", "Text 4"])
+expect(page.locator("ul > li")).to contain_text(["Text 1", "Text 3"])
 
 # ✖ Wrong order
 expect(page.locator("ul > li")).to contain_text(["Text 3", "Text 2"])

data/documentation/docs/api/route.md

@@ -49,7 +49,10 @@ The `headers` option applies to both the routed request and any redirects it ini
 
 [Route#continue](./route#continue) will immediately send the request to the network, other matching handlers won't be invoked. Use [Route#fallback](./route#fallback) If you want next matching handler in the chain to be invoked.
 
-**NOTE**: The `Cookie` header cannot be overridden using this method. If a value is provided, it will be ignored, and the cookie will be loaded from the browser's cookie store. To set custom cookies, use [BrowserContext#add_cookies](./browser_context#add_cookies).
+**NOTE**: Some request headers are **forbidden** and cannot be overridden (for example, `Cookie`, `Host`, `Content-Length` and others, see [this MDN page](https://developer.mozilla.org/en-US/docs/Glossary/Forbidden_request_header) for full list).
+If an override is provided for a forbidden header, it will be ignored and the original request header will be used.
+
+To set custom cookies, use [BrowserContext#add_cookies](./browser_context#add_cookies).
 
 ## fallback
 

data/documentation/docs/article/getting_started.md

@@ -19,7 +19,7 @@ $ npx playwright install
 
 and then set `playwright_cli_executable_path: "npx playwright"` into `Playwright.create`.
 
-Other methods of installation is also available. See the detail in [Download Playwright driver](./guides/download_playwright_driver)
+Other methods of installation are also available. See the detail in [Download Playwright driver](./guides/download_playwright_driver)
 
 ## Enjoy with examples
 

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

@@ -4,7 +4,7 @@ sidebar_position: 30
 
 # Playwright inspector
 
-Playwright provides an useful inspector.
+Playwright provides a useful inspector.
 https://playwright.dev/docs/inspector/
 
 ## Overview

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

@@ -8,7 +8,7 @@ sidebar_position: 2
 
 ## Create Playwright session
 
-In oder to launch browser, it is required to create Playwright session.
+In order to launch browser, it is required to create Playwright session.
 
 In previous examples,
 
@@ -18,7 +18,7 @@ Playwright.create(playwright_cli_executable_path: 'npx playwright') do |playwrig
 end
 ```
 
-this is the exact procedure for creating Playwright session. Choose either of method for creating the session.
+this is the exact procedure for creating Playwright session. Choose either method for creating the session.
 
 ### Define scoped Playwright session with block
 
@@ -28,13 +28,13 @@ Playwright.create(playwright_cli_executable_path: 'npx playwright') do |playwrig
 end
 ```
 
-As is described repetedly, this is the recommended way for creating Playwright session. Even when any exception happens, Playwright session is safely ended on leaving the block.
+As described repeatedly, this is the recommended way for creating a Playwright session. Even when any exception happens, Playwright session is safely ended on leaving the block.
 
 Internally `playwright run-driver` session is alive during the block.
 
 ### Define start/end of the Playwright session separately without block.
 
-Sometimes we have to define separated start/end definition. `playwright-ruby-client` also allows it.
+Sometimes we have to define separate start/end definitions. `playwright-ruby-client` also allows it.
 
 ```rb
 class SomeClass
@@ -103,7 +103,7 @@ Also we can use `Browser#new_page` to create a new window and new tab at once.
 
 ```rb
 Playwright.create(playwright_cli_executable_path: 'npx playwright') do |playwright|
-  playwright.chromium.launch(headless: false) do |browser| # Chromium task icon appers in.
+  playwright.chromium.launch(headless: false) do |browser| # Chromium task icon appears.
     context = browser.new_context # Prepare new window.
     page = context.new_page # Open new window and new tab here. (about:blank)
     page.goto('https://example.com') # Navigate to a site.

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

@@ -217,7 +217,7 @@ before do |example|
 end
 ```
 
-![sceenrecord](https://user-images.githubusercontent.com/11763113/121126629-71b5f600-c863-11eb-8f88-7924ab669946.gif)
+![screenrecord](https://user-images.githubusercontent.com/11763113/121126629-71b5f600-c863-11eb-8f88-7924ab669946.gif)
 
 For more details, refer [Recording video](./recording_video.md#using-screen-recording-from-capybara-driver)
 

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

@@ -33,7 +33,7 @@ playwright.chromium.launch do |browser|
 
 Playwright puts videos on the directory specified at `record_video_dir`.
 
-The previous example uses [Dir#mktmpdir](https://docs.ruby-lang.org/ja/latest/method/Dir/s/mktmpdir.html) for storing videos into a temprary directory. Also we simply specify a relative or absolute path like `./my_videos/` or `/path/to/videos`.
+The previous example uses [Dir#mktmpdir](https://docs.ruby-lang.org/ja/latest/method/Dir/s/mktmpdir.html) for storing videos into a temporary directory. Also we simply specify a relative or absolute path like `./my_videos/` or `/path/to/videos`.
 
 ## Getting video path and recorded video
 
@@ -42,7 +42,7 @@ This is really confusing for beginners, but in Playwright
 * We can get the video path **only when page is alive (before calling BrowserContext#close or Page#close)**
 * We can acquire the completely saved video **only after calling  BrowserContext#close**
 
-So in most case, we have to store the video path in advance, and handle the saved video after BrowserContext is closed, as is shown the previous example code.
+So in most cases, we have to store the video path in advance, and handle the saved video after BrowserContext is closed, as shown in the previous example code.
 
 ### Using `video#save_as(path)`
 

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

@@ -5,7 +5,7 @@ sidebar_position: 20
 # Semi-automation
 
 Playwright Browser context is isolated and not persisted by default. But we can also use persistent browser context using [BrowserType#launch_persistent_context](/docs/api/browser_type#launch_persistent_context).
-This allow us to intermediate into automation, for example
+This allows us to intervene in automation, for example
 
 * Authenticate with OAuth2 manually before automation
 * Testing a page after some chrome extensions are installed manually

data/documentation/docs/include/api_coverage.md

@@ -17,6 +17,7 @@
 * redirected_to
 * resource_type
 * response
+* ~~service_worker~~
 * sizes
 * timing
 * url

data/lib/playwright/channel_owners/browser_type.rb

@@ -60,12 +60,13 @@ module Playwright
       end
     end
 
-    def connect_over_cdp(endpointURL, headers: nil, slowMo: nil, timeout: nil, &block)
+    def connect_over_cdp(endpointURL, headers: nil, isLocal: nil, slowMo: nil, timeout: nil, &block)
       raise 'Connecting over CDP is only supported in Chromium.' unless name == 'chromium'
 
       params = {
         endpointURL: endpointURL,
         headers: headers,
+        isLocal: isLocal,
         slowMo: slowMo,
         timeout: @timeout_settings.timeout(timeout),
       }.compact

data/lib/playwright/channel_owners/page.rb

@@ -98,7 +98,7 @@ module Playwright
 
     private def on_route(route)
       route.send(:update_context, self)
-
+      return if @close_was_called
       # 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...
@@ -508,6 +508,9 @@ module Playwright
 
     def close(runBeforeUnload: nil, reason: nil)
       @close_reason = reason
+      unless runBeforeUnload
+        @close_was_called = true
+      end
       if @owned_context
         @owned_context.close
       else

data/lib/playwright/channel_owners/tracing.rb

@@ -23,7 +23,8 @@ module Playwright
         @is_tracing = true
         @connection.set_in_tracing(true)
       end
-      @stacks_id = @connection.local_utils.tracing_started(@traces_dir, trace_name)
+      local_utils = @connection.local_utils
+      @stacks_id = local_utils&.tracing_started(@traces_dir, trace_name)
     end
 
     def stop_chunk(path: nil)
@@ -40,20 +41,26 @@ module Playwright
         @is_tracing = false
         @connection.set_in_tracing(false)
       end
+      local_utils = @connection.local_utils
 
       unless file_path
         # Not interested in any artifacts
         @channel.send_message_to_server('tracingStopChunk', mode: 'discard')
         if @stacks_id
-          @connection.local_utils.trace_discarded(@stacks_id)
+          local_utils.trace_discarded(@stacks_id) if local_utils
         end
 
         return
       end
 
-      unless @connection.remote?
+      is_local = !@connection.remote?
+      if is_local
+        unless local_utils
+          raise 'Cannot save trace because localUtils is unavailable.'
+        end
+
         result = @channel.send_message_to_server_result('tracingStopChunk', mode: 'entries')
-        @connection.local_utils.zip(
+        local_utils.zip(
           zipFile: file_path,
           entries: result['entries'],
           stacksId: @stacks_id,
@@ -69,7 +76,7 @@ module Playwright
       # The artifact may be missing if the browser closed while stopping tracing.
       unless result['artifact']
         if @stacks_id
-          @connection.local_utils.trace_discarded(@stacks_id)
+          local_utils.trace_discarded(@stacks_id) if local_utils
         end
 
         return
@@ -80,7 +87,9 @@ module Playwright
       artifact.save_as(file_path)
       artifact.delete
 
-      @connection.local_utils.zip(
+      return unless local_utils
+
+      local_utils.zip(
         zipFile: file_path,
         entries: [],
         stacksId: @stacks_id,

data/lib/playwright/locator_assertions_impl.rb

@@ -21,7 +21,7 @@ module Playwright
     private def expect_impl(expression, expect_options, expected, message, title)
       expect_options[:timeout] ||= @default_expect_timeout
       expect_options[:isNot] = @is_not
-      message.gsub!("expected to", "not expected to") if @is_not
+      message = message.gsub("expected to", "not expected to") if @is_not
       expect_options.delete(:useInnerText) if expect_options.key?(:useInnerText) && expect_options[:useInnerText].nil?
 
       result = @locator.expect(expression, expect_options, title)

data/lib/playwright/page_assertions_impl.rb

@@ -22,7 +22,7 @@ module Playwright
     private def expect_impl(expression, expect_options, expected, message, title)
       expect_options[:timeout] ||= @default_expect_timeout
       expect_options[:isNot] = @is_not
-      message.gsub!("expected to", "not expected to") if @is_not
+      message = message.gsub("expected to", "not expected to") if @is_not
       expect_options.delete(:useInnerText) if expect_options.key?(:useInnerText) && expect_options[:useInnerText].nil?
 
       result = @frame.expect(nil, expression, expect_options, title)

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.57.2.alpha1'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.57.0'
+  VERSION = '1.58.1.alpha1'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.58.0'
 end

data/lib/playwright_api/browser_type.rb

@@ -51,10 +51,11 @@ module Playwright
     def connect_over_cdp(
           endpointURL,
           headers: nil,
+          isLocal: nil,
           slowMo: nil,
           timeout: nil,
           &block)
-      wrap_impl(@impl.connect_over_cdp(unwrap_impl(endpointURL), headers: unwrap_impl(headers), slowMo: unwrap_impl(slowMo), timeout: unwrap_impl(timeout), &wrap_block_call(block)))
+      wrap_impl(@impl.connect_over_cdp(unwrap_impl(endpointURL), headers: unwrap_impl(headers), isLocal: unwrap_impl(isLocal), slowMo: unwrap_impl(slowMo), timeout: unwrap_impl(timeout), &wrap_block_call(block)))
     end
 
     #
@@ -95,7 +96,6 @@ module Playwright
           args: nil,
           channel: nil,
           chromiumSandbox: nil,
-          devtools: nil,
           downloadsPath: nil,
           env: nil,
           executablePath: nil,
@@ -110,7 +110,7 @@ module Playwright
           timeout: nil,
           tracesDir: nil,
           &block)
-      wrap_impl(@impl.launch(args: unwrap_impl(args), channel: unwrap_impl(channel), chromiumSandbox: unwrap_impl(chromiumSandbox), devtools: unwrap_impl(devtools), downloadsPath: unwrap_impl(downloadsPath), env: unwrap_impl(env), executablePath: unwrap_impl(executablePath), firefoxUserPrefs: unwrap_impl(firefoxUserPrefs), handleSIGHUP: unwrap_impl(handleSIGHUP), handleSIGINT: unwrap_impl(handleSIGINT), handleSIGTERM: unwrap_impl(handleSIGTERM), headless: unwrap_impl(headless), ignoreDefaultArgs: unwrap_impl(ignoreDefaultArgs), proxy: unwrap_impl(proxy), slowMo: unwrap_impl(slowMo), timeout: unwrap_impl(timeout), tracesDir: unwrap_impl(tracesDir), &wrap_block_call(block)))
+      wrap_impl(@impl.launch(args: unwrap_impl(args), channel: unwrap_impl(channel), chromiumSandbox: unwrap_impl(chromiumSandbox), downloadsPath: unwrap_impl(downloadsPath), env: unwrap_impl(env), executablePath: unwrap_impl(executablePath), firefoxUserPrefs: unwrap_impl(firefoxUserPrefs), handleSIGHUP: unwrap_impl(handleSIGHUP), handleSIGINT: unwrap_impl(handleSIGINT), handleSIGTERM: unwrap_impl(handleSIGTERM), headless: unwrap_impl(headless), ignoreDefaultArgs: unwrap_impl(ignoreDefaultArgs), proxy: unwrap_impl(proxy), slowMo: unwrap_impl(slowMo), timeout: unwrap_impl(timeout), tracesDir: unwrap_impl(tracesDir), &wrap_block_call(block)))
     end
 
     #
@@ -130,7 +130,6 @@ module Playwright
           colorScheme: nil,
           contrast: nil,
           deviceScaleFactor: nil,
-          devtools: nil,
           downloadsPath: nil,
           env: nil,
           executablePath: nil,
@@ -171,7 +170,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), clientCertificates: unwrap_impl(clientCertificates), colorScheme: unwrap_impl(colorScheme), contrast: unwrap_impl(contrast), deviceScaleFactor: unwrap_impl(deviceScaleFactor), devtools: unwrap_impl(devtools), downloadsPath: unwrap_impl(downloadsPath), env: unwrap_impl(env), executablePath: unwrap_impl(executablePath), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), firefoxUserPrefs: unwrap_impl(firefoxUserPrefs), 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)))
+      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), clientCertificates: unwrap_impl(clientCertificates), colorScheme: unwrap_impl(colorScheme), contrast: unwrap_impl(contrast), deviceScaleFactor: unwrap_impl(deviceScaleFactor), downloadsPath: unwrap_impl(downloadsPath), env: unwrap_impl(env), executablePath: unwrap_impl(executablePath), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), firefoxUserPrefs: unwrap_impl(firefoxUserPrefs), 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
 
     #

data/lib/playwright_api/locator.rb

@@ -291,7 +291,7 @@ module Playwright
     end
 
     #
-    # Returns locator description previously set with [`method: Locator.describe`]. Returns `null` if no custom description has been set. Prefer `Locator.toString()` for a human-readable representation, as it uses the description when available.
+    # Returns locator description previously set with [`method: Locator.describe`]. Returns `null` if no custom description has been set.
     #
     # **Usage**
     #

data/lib/playwright_api/locator_assertions.rb

@@ -413,7 +413,7 @@ module Playwright
     # from playwright.sync_api import expect
     #
     # # ✓ Contains the right items in the right order
-    # expect(page.locator("ul > li")).to_contain_text(["Text 1", "Text 3", "Text 4"])
+    # expect(page.locator("ul > li")).to_contain_text(["Text 1", "Text 3"])
     #
     # # ✖ Wrong order
     # expect(page.locator("ul > li")).to_contain_text(["Text 3", "Text 2"])

data/lib/playwright_api/page.rb

@@ -1827,11 +1827,6 @@ module Playwright
       wrap_impl(@impl.start_js_coverage(resetOnNavigation: unwrap_impl(resetOnNavigation), reportAnonymousScripts: unwrap_impl(reportAnonymousScripts)))
     end
 
-    # @nodoc
-    def stop_css_coverage
-      wrap_impl(@impl.stop_css_coverage)
-    end
-
     # @nodoc
     def stop_js_coverage
       wrap_impl(@impl.stop_js_coverage)
@@ -1847,6 +1842,11 @@ module Playwright
       wrap_impl(@impl.owned_context=(unwrap_impl(req)))
     end
 
+    # @nodoc
+    def stop_css_coverage
+      wrap_impl(@impl.stop_css_coverage)
+    end
+
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)

data/lib/playwright_api/request.rb

@@ -166,6 +166,18 @@ module Playwright
       wrap_impl(@impl.response)
     end
 
+    #
+    # The Service `Worker` that is performing the request.
+    #
+    # **Details**
+    #
+    # This method is Chromium only. It's safe to call when using other browsers, but it will always be `null`.
+    #
+    # Requests originated in a Service Worker do not have a [`method: Request.frame`] available.
+    def service_worker
+      raise NotImplementedError.new('service_worker is not implemented yet.')
+    end
+
     #
     # Returns resource size information for given request.
     def sizes

data/lib/playwright_api/route.rb

@@ -36,7 +36,10 @@ module Playwright
     #
     # [`method: Route.continue`] will immediately send the request to the network, other matching handlers won't be invoked. Use [`method: Route.fallback`] If you want next matching handler in the chain to be invoked.
     #
-    # **NOTE**: The `Cookie` header cannot be overridden using this method. If a value is provided, it will be ignored, and the cookie will be loaded from the browser's cookie store. To set custom cookies, use [`method: BrowserContext.addCookies`].
+    # **NOTE**: Some request headers are **forbidden** and cannot be overridden (for example, `Cookie`, `Host`, `Content-Length` and others, see [this MDN page](https://developer.mozilla.org/en-US/docs/Glossary/Forbidden_request_header) for full list).
+    # If an override is provided for a forbidden header, it will be ignored and the original request header will be used.
+    #
+    # To set custom cookies, use [`method: BrowserContext.addCookies`].
     def continue(headers: nil, method: nil, postData: nil, url: nil)
       wrap_impl(@impl.continue(headers: unwrap_impl(headers), method: unwrap_impl(method), postData: unwrap_impl(postData), url: unwrap_impl(url)))
     end

data/sig/playwright.rbs

@@ -237,7 +237,7 @@ module Playwright
     def location: -> Hash[untyped, untyped]
     def page: -> (nil | Page)
     def text: -> String
-    def type: -> ("log" | "debug" | "info" | "error" | "warning" | "dir" | "dirxml" | "table" | "trace" | "clear" | "startGroup" | "startGroupCollapsed" | "endGroup" | "assert" | "profile" | "profileEnd" | "count" | "timeEnd")
+    def type: -> ("log" | "debug" | "info" | "error" | "warning" | "dir" | "dirxml" | "table" | "trace" | "clear" | "startGroup" | "startGroupCollapsed" | "endGroup" | "assert" | "profile" | "profileEnd" | "count" | "time" | "timeEnd")
     def worker: -> (nil | Worker)
   end
 
@@ -431,10 +431,10 @@ module Playwright
   end
 
   class BrowserType
-    def connect_over_cdp: (String endpointURL, ?headers: Hash[untyped, untyped], ?slowMo: Float, ?timeout: Float) ?{ (untyped) -> untyped } -> Browser
+    def connect_over_cdp: (String endpointURL, ?headers: Hash[untyped, untyped], ?isLocal: bool, ?slowMo: Float, ?timeout: Float) ?{ (untyped) -> untyped } -> Browser
     def executable_path: -> String
-    def launch: (?args: Array[untyped], ?channel: String, ?chromiumSandbox: bool, ?devtools: bool, ?downloadsPath: (String | File), ?env: Hash[untyped, untyped], ?executablePath: (String | File), ?firefoxUserPrefs: Hash[untyped, untyped], ?handleSIGHUP: bool, ?handleSIGINT: bool, ?handleSIGTERM: bool, ?headless: bool, ?ignoreDefaultArgs: (bool | Array[untyped]), ?proxy: Hash[untyped, untyped], ?slowMo: Float, ?timeout: Float, ?tracesDir: (String | File)) ?{ (Browser) -> untyped } -> Browser
-    def launch_persistent_context: ((String | File) userDataDir, ?acceptDownloads: bool, ?args: Array[untyped], ?baseURL: String, ?bypassCSP: bool, ?channel: String, ?chromiumSandbox: bool, ?clientCertificates: Array[untyped], ?colorScheme: ("light" | "dark" | "no-preference" | "null"), ?contrast: ("no-preference" | "more" | "null"), ?deviceScaleFactor: Float, ?devtools: bool, ?downloadsPath: (String | File), ?env: Hash[untyped, untyped], ?executablePath: (String | File), ?extraHTTPHeaders: Hash[untyped, untyped], ?firefoxUserPrefs: Hash[untyped, untyped], ?forcedColors: ("active" | "none" | "null"), ?geolocation: Hash[untyped, untyped], ?handleSIGHUP: bool, ?handleSIGINT: bool, ?handleSIGTERM: bool, ?hasTouch: bool, ?headless: bool, ?httpCredentials: Hash[untyped, untyped], ?ignoreDefaultArgs: (bool | Array[untyped]), ?ignoreHTTPSErrors: bool, ?isMobile: bool, ?javaScriptEnabled: bool, ?locale: String, ?noViewport: bool, ?offline: bool, ?permissions: Array[untyped], ?proxy: Hash[untyped, untyped], ?record_har_content: ("omit" | "embed" | "attach"), ?record_har_mode: ("full" | "minimal"), ?record_har_omit_content: bool, ?record_har_path: (String | File), ?record_har_url_filter: (String | Regexp), ?record_video_dir: (String | File), ?record_video_size: Hash[untyped, untyped], ?reducedMotion: ("reduce" | "no-preference" | "null"), ?screen: Hash[untyped, untyped], ?serviceWorkers: ("allow" | "block"), ?slowMo: Float, ?strictSelectors: bool, ?timeout: Float, ?timezoneId: String, ?tracesDir: (String | File), ?userAgent: String, ?viewport: (nil | Hash[untyped, untyped])) ?{ (untyped) -> untyped } -> BrowserContext
+    def launch: (?args: Array[untyped], ?channel: String, ?chromiumSandbox: bool, ?downloadsPath: (String | File), ?env: Hash[untyped, untyped], ?executablePath: (String | File), ?firefoxUserPrefs: Hash[untyped, untyped], ?handleSIGHUP: bool, ?handleSIGINT: bool, ?handleSIGTERM: bool, ?headless: bool, ?ignoreDefaultArgs: (bool | Array[untyped]), ?proxy: Hash[untyped, untyped], ?slowMo: Float, ?timeout: Float, ?tracesDir: (String | File)) ?{ (Browser) -> untyped } -> Browser
+    def launch_persistent_context: ((String | File) userDataDir, ?acceptDownloads: bool, ?args: Array[untyped], ?baseURL: String, ?bypassCSP: bool, ?channel: String, ?chromiumSandbox: bool, ?clientCertificates: Array[untyped], ?colorScheme: ("light" | "dark" | "no-preference" | "null"), ?contrast: ("no-preference" | "more" | "null"), ?deviceScaleFactor: Float, ?downloadsPath: (String | File), ?env: Hash[untyped, untyped], ?executablePath: (String | File), ?extraHTTPHeaders: Hash[untyped, untyped], ?firefoxUserPrefs: Hash[untyped, untyped], ?forcedColors: ("active" | "none" | "null"), ?geolocation: Hash[untyped, untyped], ?handleSIGHUP: bool, ?handleSIGINT: bool, ?handleSIGTERM: bool, ?hasTouch: bool, ?headless: bool, ?httpCredentials: Hash[untyped, untyped], ?ignoreDefaultArgs: (bool | Array[untyped]), ?ignoreHTTPSErrors: bool, ?isMobile: bool, ?javaScriptEnabled: bool, ?locale: String, ?noViewport: bool, ?offline: bool, ?permissions: Array[untyped], ?proxy: Hash[untyped, untyped], ?record_har_content: ("omit" | "embed" | "attach"), ?record_har_mode: ("full" | "minimal"), ?record_har_omit_content: bool, ?record_har_path: (String | File), ?record_har_url_filter: (String | Regexp), ?record_video_dir: (String | File), ?record_video_size: Hash[untyped, untyped], ?reducedMotion: ("reduce" | "no-preference" | "null"), ?screen: Hash[untyped, untyped], ?serviceWorkers: ("allow" | "block"), ?slowMo: Float, ?strictSelectors: bool, ?timeout: Float, ?timezoneId: String, ?tracesDir: (String | File), ?userAgent: String, ?viewport: (nil | Hash[untyped, untyped])) ?{ (untyped) -> untyped } -> BrowserContext
     def name: -> String
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.57.2.alpha1
+  version: 1.58.1.alpha1
 platform: ruby
 authors:
 - YusukeIwaki
@@ -226,6 +226,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
+- AGENTS.md
+- CLAUDE.md
+- CLAUDE/api_generation.md
+- CLAUDE/ci_expectations.md
+- CLAUDE/gem_release_flow.md
+- CLAUDE/past_upgrade_pr_patterns.md
+- CLAUDE/playwright_upgrade_workflow.md
+- CLAUDE/rspec_debugging.md
+- CLAUDE/unimplemented_examples.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
@@ -435,5 +444,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: The Ruby binding of playwright driver 1.57.0
+summary: The Ruby binding of playwright driver 1.58.0
 test_files: []