playwright-ruby-client 1.34.0 → 1.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64c373804c3cc418f35774036436563714c4e7a42ce87d9ce242d961814c28f9
-  data.tar.gz: 3dccf880e4d4911279bbac84575f03872284c379fdcac468fa4e16940b51c352
+  metadata.gz: 3bd6b36250957e5968a5314944dc9327980d93e225a9aea86d3958268f8e089c
+  data.tar.gz: e787bb96692cb1d47b1f56d359d3ed63559f477993f1d14250398403a08359e9
 SHA512:
-  metadata.gz: e911b7eac54e773e83c18efcc13562500e736b75fc259da2f63abed7bc31b716d86b568215c410245fd613a379a3c0fdb63a3a9d942b33042eaf14019829474b
-  data.tar.gz: 47ce8a3dd0a37c79c4786f3d1b34ce99009ee3a572b1d88345d3ae6da767c81cc4f6f0bb9e14c93292dfe4e007f229dd37861a1e358544f787f1aa463792b1f0
+  metadata.gz: 5a9e9da2b00c688fb256a770cacb32e9762ccd1df1965f30653d30c62810e6c3fae54c9838006461d02427520a071bec13000c754c4790fe85f1f9086592436c
+  data.tar.gz: e9e74a9558c418ce736ccbc0aa61ba6cac55b484ba961255de8dc8e22bdbf67db90f3c00de470b3cd94846c9fb5b76afcf3773f2680e9f8ba5d317f2cf318474

data/documentation/docs/api/element_handle.md

@@ -450,6 +450,7 @@ def screenshot(
       animations: nil,
       caret: nil,
       mask: nil,
+      maskColor: nil,
       omitBackground: nil,
       path: nil,
       quality: nil,

data/documentation/docs/api/locator.md

@@ -1040,6 +1040,7 @@ def screenshot(
       animations: nil,
       caret: nil,
       mask: nil,
+      maskColor: nil,
       omitBackground: nil,
       path: nil,
       quality: nil,

data/documentation/docs/api/page.md

@@ -1286,6 +1286,7 @@ def screenshot(
       clip: nil,
       fullPage: nil,
       mask: nil,
+      maskColor: nil,
       omitBackground: nil,
       path: nil,
       quality: nil,

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

@@ -14,14 +14,14 @@ This all-in-one architecture is reasonable for browser automation in our own com
 
 However we may have trouble with bringing Playwright into:
 
-* Docker
-  * Alpine Linux
-* Serverless computing
-  * AWS Lambda
-  * Google Cloud Functions
-* PaaS
-  * Heroku
-  * Google App Engine
+- Docker
+  - Alpine Linux
+- Serverless computing
+  - AWS Lambda
+  - Google Cloud Functions
+- PaaS
+  - Heroku
+  - Google App Engine
 
 This article introduces a way to separate environments into client (for executing Playwright script) and server (for working with browsers). The main use-case assumes Docker (using Alpine Linux), however the way can be applied also into other use-cases.
 
@@ -39,16 +39,22 @@ Playwright provides two kind of methods to share the browser environments for cl
 
 When you want to share only one browser environment, Browser server is suitable. This feature is officially supported in Playwright.
 
-* Server can be launched with [BrowserType#launchServer](https://playwright.dev/docs/api/class-browsertype#browser-type-launch-server) instead of `BrowserType#launch`.
-* Client can connect to server with [BrowserType#connect](https://playwright.dev/docs/api/class-browsertype#browser-type-connect). In playwright-ruby-client, `BrowserType#connect` and not implemented yet and use `Playwright#connect_to_browser_server()` instead.
+- Server can be launched with [BrowserType#launchServer](https://playwright.dev/docs/api/class-browsertype#browser-type-launch-server) instead of `BrowserType#launch`.
+- Client can connect to server with [BrowserType#connect](https://playwright.dev/docs/api/class-browsertype#browser-type-connect). In playwright-ruby-client, `BrowserType#connect` and not implemented yet and use `Playwright#connect_to_browser_server()` instead.
 
 Another method is sharing all browser environment. This method is very simple, but not an official feature, and can be changed in future.
 
-* Server can be launched with `playwright run-server` (CLI command).
-* Client can connect to server with `Playwright.connect_to_playwright_server` instead of `Playwright.create`
+- Server can be launched with `playwright run-server` (CLI command).
+- Client can connect to server with `Playwright.connect_to_playwright_server` instead of `Playwright.create`
 
 ## Playwright server/client
 
+:::caution
+
+This method is no longer supported on Playwright driver >= 1.35. See [this issue](https://github.com/YusukeIwaki/playwright-ruby-client/issues/254) for detail, and use Browser server/client method instead.
+
+:::
+
 ### Client code
 
 Many example uses `Playwright#create`, which internally uses Pipe (stdin/stdout) transport for Playwright-protocol messaging. Instead, **just use `Playwright#connect_to_playwright_server(endpoint)`** for WebSocket transport.
@@ -74,10 +80,10 @@ With the [official Docker image](https://hub.docker.com/_/microsoft-playwright)
 If custom Docker image is preferred, build it as follows:
 
 ```Dockerfile
-FROM mcr.microsoft.com/playwright:focal
+FROM mcr.microsoft.com/playwright
 
 WORKDIR /root
-RUN npm install playwright@1.12.3 && ./node_modules/.bin/playwright install
+RUN npm install playwright && ./node_modules/.bin/playwright install
 
 ENV PORT 8888
 CMD ["./node_modules/.bin/playwright", "run-server", "--port", "$PORT", "--path", "/ws"]
@@ -105,15 +111,17 @@ For instant use, `npx playwright launch-server --browser chromium` generates a W
 More customization can be done by implementing JavaScript server like below:
 
 ```js
-const playwright = require('playwright')
+const playwright = require("playwright");
 
 option = {
-  channel: 'chrome-canary',
+  channel: "chrome-canary",
   headless: false,
   port: 8080,
-  wsPath: 'ws',
-}
-playwright.chromium.launchServer(option).then((server) => { console.log(server.wsEndpoint()) })
+  wsPath: "ws",
+};
+playwright.chromium.launchServer(option).then((server) => {
+  console.log(server.wsEndpoint());
+});
 ```
 
 `port` and `wsPath` would be useful for generating static WebSocket endpoint URL.
@@ -132,13 +140,12 @@ Just set an environment variable `DEBUG=1`.
 DEBUG=1 bundle exec ruby some-automation-with-playwright.rb
 ```
 
-
 ### Enable verbose logging on server
 
 Just set an environment variable `DEBUG=pw:*` or `DEBUG=pw:server`
 
 ```
-DEBUG=pw:* npx playwright run-server --port 8888 --path /ws
+DEBUG=pw:* npx playwright launch-server --browser chromium
 ```
 
 See [the official documentation](https://playwright.dev/docs/debug/#verbose-api-logs) for details.

data/lib/playwright/channel_owners/browser_context.rb

@@ -121,7 +121,7 @@ module Playwright
         end
 
         unless handled
-          route.send(:async_continue_route).rescue do |err|
+          route.send(:async_continue_route, internal: true).rescue do |err|
             puts err, err.backtrace
           end
         end

data/lib/playwright/channel_owners/element_handle.rb

@@ -296,6 +296,7 @@ module Playwright
         animations: nil,
         caret: nil,
         mask: nil,
+        maskColor: nil,
         omitBackground: nil,
         path: nil,
         quality: nil,
@@ -306,6 +307,7 @@ module Playwright
         params = {
           animations: animations,
           caret: caret,
+          maskColor: maskColor,
           omitBackground: omitBackground,
           path: path,
           quality: quality,

data/lib/playwright/channel_owners/page.rb

@@ -438,6 +438,7 @@ module Playwright
       clip: nil,
       fullPage: nil,
       mask: nil,
+      maskColor: nil,
       omitBackground: nil,
       path: nil,
       quality: nil,
@@ -450,6 +451,7 @@ module Playwright
         quality: quality,
         fullPage: fullPage,
         clip: clip,
+        maskColor: maskColor,
         omitBackground: omitBackground,
         animations: animations,
         caret: caret,
@@ -484,7 +486,7 @@ module Playwright
       end
       nil
     rescue => err
-      raise unless safe_close_error?(err)
+      raise if !safe_close_error?(err) || !runBeforeUnload
     end
 
     def closed?

data/lib/playwright/channel_owners/playwright.rb

@@ -35,7 +35,6 @@ module Playwright
       unless @initializer['preLaunchedBrowser']
         raise 'Malformed endpoint. Did you use launchServer method?'
       end
-
       ::Playwright::ChannelOwners::Browser.from(@initializer['preLaunchedBrowser'])
     end
 

data/lib/playwright/channel_owners/route.rb

@@ -137,7 +137,7 @@ module Playwright
       end
     end
 
-    private def async_continue_route
+    private def async_continue_route(internal: false)
       post_data_for_wire =
         if (post_data_from_overrides = request.send(:fallback_overrides)[:postData])
           post_data_for_wire = Base64.strict_encode64(post_data_from_overrides)
@@ -155,6 +155,7 @@ module Playwright
         params[:postData] = post_data_for_wire
       end
       params[:requestUrl] = request.send(:internal_url)
+      params[:isFallback] = internal
 
       # TODO _race_with_page_close
       @channel.async_send_message_to_server('continue', params)

data/lib/playwright/locator_impl.rb

@@ -362,6 +362,7 @@ module Playwright
           animations: nil,
           caret: nil,
           mask: nil,
+          maskColor: nil,
           omitBackground: nil,
           path: nil,
           quality: nil,
@@ -374,6 +375,7 @@ module Playwright
           animations: animations,
           caret: caret,
           mask: mask,
+          maskColor: maskColor,
           omitBackground: omitBackground,
           path: path,
           quality: quality,

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.34.0'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.34.3'
+  VERSION = '1.35.0'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.35.0'
 end

data/lib/playwright.rb

@@ -159,8 +159,9 @@ module Playwright
       begin
         playwright = connection.initialize_playwright
         browser = playwright.send(:pre_launched_browser)
+        browser.send(:update_browser_type, playwright.chromium) # Just workaround for nil reference error.
         browser.browser_type.send(:did_launch_browser, browser)
-        browser.should_close_connection_on_close!
+        browser.send(:should_close_connection_on_close!)
         Execution.new(connection, PlaywrightApi.wrap(playwright), PlaywrightApi.wrap(browser))
       rescue
         connection.stop

data/lib/playwright_api/element_handle.rb

@@ -374,13 +374,14 @@ module Playwright
           animations: nil,
           caret: nil,
           mask: nil,
+          maskColor: nil,
           omitBackground: nil,
           path: nil,
           quality: nil,
           scale: nil,
           timeout: nil,
           type: nil)
-      wrap_impl(@impl.screenshot(animations: unwrap_impl(animations), caret: unwrap_impl(caret), mask: unwrap_impl(mask), omitBackground: unwrap_impl(omitBackground), path: unwrap_impl(path), quality: unwrap_impl(quality), scale: unwrap_impl(scale), timeout: unwrap_impl(timeout), type: unwrap_impl(type)))
+      wrap_impl(@impl.screenshot(animations: unwrap_impl(animations), caret: unwrap_impl(caret), mask: unwrap_impl(mask), maskColor: unwrap_impl(maskColor), omitBackground: unwrap_impl(omitBackground), path: unwrap_impl(path), quality: unwrap_impl(quality), scale: unwrap_impl(scale), timeout: unwrap_impl(timeout), type: unwrap_impl(type)))
     end
 
     #

data/lib/playwright_api/frame.rb

@@ -1038,13 +1038,13 @@ module Playwright
     end
 
     # @nodoc
-    def highlight(selector)
-      wrap_impl(@impl.highlight(unwrap_impl(selector)))
+    def detached=(req)
+      wrap_impl(@impl.detached=(unwrap_impl(req)))
     end
 
     # @nodoc
-    def detached=(req)
-      wrap_impl(@impl.detached=(unwrap_impl(req)))
+    def highlight(selector)
+      wrap_impl(@impl.highlight(unwrap_impl(selector)))
     end
 
     # -- inherited from EventEmitter --

data/lib/playwright_api/locator.rb

@@ -781,7 +781,7 @@ module Playwright
     # **Usage**
     #
     # ```python sync
-    # banana = page.get_by_role("listitem").last()
+    # banana = page.get_by_role("listitem").last
     # ```
     def last
       wrap_impl(@impl.last)
@@ -898,13 +898,14 @@ module Playwright
           animations: nil,
           caret: nil,
           mask: nil,
+          maskColor: nil,
           omitBackground: nil,
           path: nil,
           quality: nil,
           scale: nil,
           timeout: nil,
           type: nil)
-      wrap_impl(@impl.screenshot(animations: unwrap_impl(animations), caret: unwrap_impl(caret), mask: unwrap_impl(mask), omitBackground: unwrap_impl(omitBackground), path: unwrap_impl(path), quality: unwrap_impl(quality), scale: unwrap_impl(scale), timeout: unwrap_impl(timeout), type: unwrap_impl(type)))
+      wrap_impl(@impl.screenshot(animations: unwrap_impl(animations), caret: unwrap_impl(caret), mask: unwrap_impl(mask), maskColor: unwrap_impl(maskColor), omitBackground: unwrap_impl(omitBackground), path: unwrap_impl(path), quality: unwrap_impl(quality), scale: unwrap_impl(scale), timeout: unwrap_impl(timeout), type: unwrap_impl(type)))
     end
 
     #

data/lib/playwright_api/page.rb

@@ -1154,13 +1154,14 @@ module Playwright
           clip: nil,
           fullPage: nil,
           mask: nil,
+          maskColor: nil,
           omitBackground: nil,
           path: nil,
           quality: nil,
           scale: nil,
           timeout: nil,
           type: nil)
-      wrap_impl(@impl.screenshot(animations: unwrap_impl(animations), caret: unwrap_impl(caret), clip: unwrap_impl(clip), fullPage: unwrap_impl(fullPage), mask: unwrap_impl(mask), omitBackground: unwrap_impl(omitBackground), path: unwrap_impl(path), quality: unwrap_impl(quality), scale: unwrap_impl(scale), timeout: unwrap_impl(timeout), type: unwrap_impl(type)))
+      wrap_impl(@impl.screenshot(animations: unwrap_impl(animations), caret: unwrap_impl(caret), clip: unwrap_impl(clip), fullPage: unwrap_impl(fullPage), mask: unwrap_impl(mask), maskColor: unwrap_impl(maskColor), omitBackground: unwrap_impl(omitBackground), path: unwrap_impl(path), quality: unwrap_impl(quality), scale: unwrap_impl(scale), timeout: unwrap_impl(timeout), type: unwrap_impl(type)))
     end
 
     #

data/lib/playwright_api/playwright.rb

@@ -83,7 +83,7 @@ module Playwright
     #
     # >>> browser = playwright.chromium.launch()
     # >>> page = browser.new_page()
-    # >>> page.goto("http://whatsmyuseragent.org/")
+    # >>> page.goto("https://playwright.dev/")
     # >>> page.screenshot(path="example.png")
     # >>> browser.close()
     #

data/lib/playwright_api/response.rb

@@ -118,13 +118,13 @@ module Playwright
     end
 
     # @nodoc
-    def ok?
-      wrap_impl(@impl.ok?)
+    def from_service_worker?
+      wrap_impl(@impl.from_service_worker?)
     end
 
     # @nodoc
-    def from_service_worker?
-      wrap_impl(@impl.from_service_worker?)
+    def ok?
+      wrap_impl(@impl.ok?)
     end
 
     # -- inherited from EventEmitter --

data/sig/playwright.rbs

@@ -118,7 +118,7 @@ module Playwright
     def press: (String key, ?delay: Float, ?noWaitAfter: bool, ?timeout: Float) -> void
     def query_selector: (String selector) -> (nil | ElementHandle)
     def query_selector_all: (String selector) -> Array[untyped]
-    def screenshot: (?animations: ("disabled" | "allow"), ?caret: ("hide" | "initial"), ?mask: Array[untyped], ?omitBackground: bool, ?path: (String | File), ?quality: Integer, ?scale: ("css" | "device"), ?timeout: Float, ?type: ("png" | "jpeg")) -> String
+    def screenshot: (?animations: ("disabled" | "allow"), ?caret: ("hide" | "initial"), ?mask: Array[untyped], ?maskColor: String, ?omitBackground: bool, ?path: (String | File), ?quality: Integer, ?scale: ("css" | "device"), ?timeout: Float, ?type: ("png" | "jpeg")) -> String
     def scroll_into_view_if_needed: (?timeout: Float) -> void
     def select_option: (?element: (ElementHandle | Array[untyped]), ?index: (Integer | Array[untyped]), ?value: (String | Array[untyped]), ?label: (String | Array[untyped]), ?force: bool, ?noWaitAfter: bool, ?timeout: Float) -> Array[untyped]
     def select_text: (?force: bool, ?timeout: Float) -> void
@@ -306,7 +306,7 @@ module Playwright
     def reload: (?timeout: Float, ?waitUntil: ("load" | "domcontentloaded" | "networkidle" | "commit")) -> (nil | Response)
     def route: ((String | Regexp | function) url, function handler, ?times: Integer) -> void
     def route_from_har: ((String | File) har, ?notFound: ("abort" | "fallback"), ?update: bool, ?updateContent: ("embed" | "attach"), ?updateMode: ("full" | "minimal"), ?url: (String | Regexp)) -> void
-    def screenshot: (?animations: ("disabled" | "allow"), ?caret: ("hide" | "initial"), ?clip: Hash[untyped, untyped], ?fullPage: bool, ?mask: Array[untyped], ?omitBackground: bool, ?path: (String | File), ?quality: Integer, ?scale: ("css" | "device"), ?timeout: Float, ?type: ("png" | "jpeg")) -> String
+    def screenshot: (?animations: ("disabled" | "allow"), ?caret: ("hide" | "initial"), ?clip: Hash[untyped, untyped], ?fullPage: bool, ?mask: Array[untyped], ?maskColor: String, ?omitBackground: bool, ?path: (String | File), ?quality: Integer, ?scale: ("css" | "device"), ?timeout: Float, ?type: ("png" | "jpeg")) -> String
     def select_option: (String selector, ?element: (ElementHandle | Array[untyped]), ?index: (Integer | Array[untyped]), ?value: (String | Array[untyped]), ?label: (String | Array[untyped]), ?force: bool, ?noWaitAfter: bool, ?strict: bool, ?timeout: Float) -> Array[untyped]
     def set_checked: (String selector, bool checked, ?force: bool, ?noWaitAfter: bool, ?position: Hash[untyped, untyped], ?strict: bool, ?timeout: Float, ?trial: bool) -> void
     def set_content: (String html, ?timeout: Float, ?waitUntil: ("load" | "domcontentloaded" | "networkidle" | "commit")) -> void
@@ -483,7 +483,7 @@ module Playwright
     def or: (Locator locator) -> Locator
     def page: -> Page
     def press: (String key, ?delay: Float, ?noWaitAfter: bool, ?timeout: Float) -> void
-    def screenshot: (?animations: ("disabled" | "allow"), ?caret: ("hide" | "initial"), ?mask: Array[untyped], ?omitBackground: bool, ?path: (String | File), ?quality: Integer, ?scale: ("css" | "device"), ?timeout: Float, ?type: ("png" | "jpeg")) -> String
+    def screenshot: (?animations: ("disabled" | "allow"), ?caret: ("hide" | "initial"), ?mask: Array[untyped], ?maskColor: String, ?omitBackground: bool, ?path: (String | File), ?quality: Integer, ?scale: ("css" | "device"), ?timeout: Float, ?type: ("png" | "jpeg")) -> String
     def scroll_into_view_if_needed: (?timeout: Float) -> void
     def select_option: (?element: (ElementHandle | Array[untyped]), ?index: (Integer | Array[untyped]), ?value: (String | Array[untyped]), ?label: (String | Array[untyped]), ?force: bool, ?noWaitAfter: bool, ?timeout: Float) -> Array[untyped]
     def select_text: (?force: bool, ?timeout: Float) -> void

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.34.0
+  version: 1.35.0
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-29 00:00:00.000000000 Z
+date: 2023-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -401,5 +401,5 @@ requirements: []
 rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
-summary: The Ruby binding of playwright driver 1.34.3
+summary: The Ruby binding of playwright driver 1.35.0
 test_files: []