playwright-ruby-client 1.54.0 → 1.54.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d26f10b0192fbc1b4fd2e1724fca389df99b9857388d57b35f30913f15bb3767
-  data.tar.gz: 6d13481a4553b0a91dc138179254973afdcaf27e06071a703aec338894f13266
+  metadata.gz: 292b93df8ac7c9ea103673f017935907d53ea53a6e84b66d13723cb41c6c7fd9
+  data.tar.gz: b1d0d3325715881e7ae2ffc9fe04f32e8379189de794a498a041e36d1594ecaf
 SHA512:
-  metadata.gz: d4ec72f8748fc736afa98fdfb0f01022170714422fc1be92b024cb88f87a40aa7539850c3b0127c935ab0cb848c0c6a9a4f7841021dca6c4669a2ac9c8600bd0
-  data.tar.gz: 530c3ac3a4dd1343ccac9af49d7f1fa85c45e296f496f398bb1d6d05532e66d7d6ecab0f27a5810801f41d3d04bfea29de8bc3709462a5d94598b3fa1e3bfe47
+  metadata.gz: 4bd08ce76baa61e7dc6b3aa724f20cc3d05ff576ab1b42cc93fed1c0a38c3fb205f8fd90530c95dd5349bcd650688104a34d1e79023b40fd1241d6b8c6f8c5d1
+  data.tar.gz: 63d9a00c126ed1fee420e530173b30970f7854522adc15f00e52aaa4049015b2461bd5512210e966ab0178ef18af19ce63de648a3bef88b668ff0cc39330680d

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

@@ -15,7 +15,7 @@ playwright.chromium.launch(headless: false) do |browser|
     # This method call should be put just after creating BrowserContext.
     context.enable_debug_console!
 
-    page = context.new_pagè
+    page = context.new_page
     page.goto('http://example.com/')
     page.pause
   end

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

@@ -25,6 +25,8 @@ However we may have trouble with bringing Playwright into:
 
 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.
 
+ref: https://playwright.dev/docs/docker#remote-connection
+
 ## Overview
 
 Playwright Ruby client is running on Alpine Linux. It just sends/receives JSON messages of Playwright-protocol via WebSocket.
@@ -33,48 +35,25 @@ Playwright server is running on a container of [official Docker image](https://h
 
 ![overview](https://user-images.githubusercontent.com/11763113/124934448-ad4d0700-e03f-11eb-942e-b9f3282bb703.png)
 
-### Playwright Server v.s. Browser Server
-
-Playwright provides two kind of methods to share the browser environments for clients.
-
-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`.
+- Server can be launched with `npx playwright run-server` CLI command.
 - 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`
-
-## 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.
+Many example uses `Playwright#create`, which internally uses Pipe (stdin/stdout) transport for Playwright-protocol messaging. Instead, **use `Playwright#connect_to_browser_server(endpoint)`** for WebSocket transport.
 
 ```ruby {3}
 require 'playwright'
 
-Playwright.connect_to_playwright_server('wss://example.com:8888/ws?browser=chromium') do |playwright|
-  playwright.chromium.launch do |browser|
-    page = browser.new_page
-    page.goto('https://github.com/microsoft/playwright')
-    page.screenshot(path: 'github-microsoft-playwright.png')
-  end
+Playwright.connect_to_browser_server('wss://example.com:8888/ws') do |browser|
+  page = browser.new_page
+  page.goto('https://github.com/microsoft/playwright')
+  page.screenshot(path: 'github-microsoft-playwright.png')
 end
 ```
 
 `wss://example.com:8888/ws` is an example of endpoint URL of the Playwright server. In local development environment, it is typically `"ws://127.0.0.1:#{port}/ws"`.
 
-Note that `?browser=chromium` is important for server to determine which browser to prepare.
-
 ### Server code
 
 With the [official Docker image](https://hub.docker.com/_/microsoft-playwright) or in the local development environment with Node.js, just execute `npx playwright install && npx playwright run-server --port $PORT --path /ws`. (`$PORT` is a port number of the server)
@@ -91,45 +70,6 @@ ENV PORT 8888
 CMD ["./node_modules/.bin/playwright", "run-server", "--port", "$PORT", "--path", "/ws"]
 ```
 
-## Browser server/client
-
-### Client code
-
-Use `Playwright#connect_to_playwright_server` and pass the WebSocket URL for browser server.
-Note that this method requires a block with `Browser`, not `Playwright` or `BrowserType`.
-
-```ruby
-Playwright.connect_to_playwright_server(ws_url) do |browser|
-  page = browser.new_page
-  page.goto(...)
-  ...
-end
-```
-
-### Server code
-
-For instant use, `npx playwright launch-server --browser chromium` generates a WebSocket endpoint URL with a random path.
-
-More customization can be done by implementing JavaScript server like below:
-
-```js
-const playwright = require("playwright");
-
-option = {
-  channel: "chrome-canary",
-  headless: false,
-  port: 8080,
-  wsPath: "ws",
-};
-playwright.chromium.launchServer(option).then((server) => {
-  console.log(server.wsEndpoint());
-});
-```
-
-`port` and `wsPath` would be useful for generating static WebSocket endpoint URL.
-Other available options for `BrowserType#launchServer` can be found here:
-https://playwright.dev/docs/api/class-browsertype#browser-type-launch-server
-
 ## Debugging for connection
 
 The client and server are really quiet. This chapter shows how to check if the communication on the WebSocket works well or not.
@@ -147,7 +87,7 @@ DEBUG=1 bundle exec ruby some-automation-with-playwright.rb
 Just set an environment variable `DEBUG=pw:*` or `DEBUG=pw:server`
 
 ```
-DEBUG=pw:* npx playwright launch-server --browser chromium
+DEBUG=pw:* npx playwright run-server --browser chromium
 ```
 
 See [the official documentation](https://playwright.dev/docs/debug/#verbose-api-logs) for details.

data/lib/playwright/channel_owners/browser_type.rb

@@ -93,10 +93,6 @@ module Playwright
       context.send(:update_options, context_options: context_options, browser_options: browser_options)
     end
 
-    private def did_launch_browser(browser)
-      browser.send(:update_browser_type, self)
-    end
-
     private def update_with_playwright_selectors_options(options)
       selectors = @playwright&.selectors
       if selectors

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.54.0'
+  VERSION = '1.54.1'
   COMPATIBLE_PLAYWRIGHT_VERSION = '1.54.1'
 end

data/lib/playwright/web_socket_client.rb

@@ -62,9 +62,12 @@ module Playwright
     STATE_CLOSING = 2
     STATE_CLOSED = 3
 
-    def initialize(url:, max_payload_size:)
+    def initialize(url:, max_payload_size:, headers:)
       @impl = DriverImpl.new(url)
       @driver = ::WebSocket::Driver.client(@impl, max_length: max_payload_size)
+      headers.each do |key, value|
+        @driver.set_header(key, value)
+      end
 
       setup
     end

data/lib/playwright/web_socket_transport.rb

@@ -6,8 +6,9 @@ module Playwright
   # ref: https://github.com/microsoft/playwright-python/blob/master/playwright/_impl/_transport.py
   class WebSocketTransport
     # @param ws_endpoint [String] EndpointURL of WebSocket
-    def initialize(ws_endpoint:)
+    def initialize(ws_endpoint:, headers:)
       @ws_endpoint = ws_endpoint
+      @headers = headers
       @debug = ENV['DEBUG'].to_s == 'true' || ENV['DEBUG'].to_s == '1'
     end
 
@@ -63,6 +64,7 @@ module Playwright
       ws = WebSocketClient.new(
         url: @ws_endpoint,
         max_payload_size: 256 * 1024 * 1024, # 256MB
+        headers: @headers,
       )
       promise = Concurrent::Promises.resolvable_future
       ws.on_open do

data/lib/playwright.rb

@@ -102,14 +102,7 @@ module Playwright
     end
   end
 
-  # Connects to Playwright server, launched by `npx playwright run-server` via WebSocket transport.
-  #
-  # Playwright.connect_to_playwright_server(...) do |playwright|
-  #   browser = playwright.chromium.launch
-  #   ...
-  # end
-  #
-  # @experimental
+  # @Deprecated. Playwright >= 1.54 does not support this method.
   module_function def connect_to_playwright_server(ws_endpoint, &block)
     require 'playwright/web_socket_client'
     require 'playwright/web_socket_transport'
@@ -138,7 +131,7 @@ module Playwright
     end
   end
 
-  # Connects to Playwright server, launched by `npx playwright launch-server chromium` or `playwright.chromium.launchServer()`
+  # Connects to Playwright server, launched by `npx playwright launch-server --browser chromium` or `npx playwright run-server`
   #
   # Playwright.connect_to_browser_server('ws://....') do |browser|
   #   page = browser.new_page
@@ -146,11 +139,19 @@ module Playwright
   # end
   #
   # @experimental
-  module_function def connect_to_browser_server(ws_endpoint, &block)
+  module_function def connect_to_browser_server(ws_endpoint, browser_type: 'chromium', &block)
+    known_browser_types = ['chromium', 'firefox', 'webkit']
+    unless known_browser_types.include?(browser_type)
+      raise ArgumentError, "Unknown browser type: #{browser_type}. Known types are: #{known_browser_types.join(', ')}"
+    end
+
     require 'playwright/web_socket_client'
     require 'playwright/web_socket_transport'
 
-    transport = WebSocketTransport.new(ws_endpoint: ws_endpoint)
+    transport = WebSocketTransport.new(
+      ws_endpoint: ws_endpoint,
+      headers: { 'x-playwright-browser' => browser_type },
+    )
     connection = Connection.new(transport)
     connection.mark_as_remote
     connection.async_run
@@ -159,8 +160,7 @@ 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.send(:connect_to_browser_type, playwright.send(browser_type), nil)
         browser.send(:should_close_connection_on_close!)
         Execution.new(connection, PlaywrightApi.wrap(playwright), PlaywrightApi.wrap(browser))
       rescue
@@ -179,7 +179,7 @@ module Playwright
     end
   end
 
-    # Connects to Playwright server, launched by `npx playwright launch-server chromium` or `playwright.chromium.launchServer()`
+  # Connects to Playwright server, launched by `npx playwright launch-server --browser _android` or `playwright._android.launchServer()`
   #
   # Playwright.connect_to_android_server('ws://....') do |browser|
   #   page = browser.new_page

data/lib/playwright_api/frame.rb

@@ -1039,11 +1039,6 @@ module Playwright
       wrap_impl(@impl.wait_for_url(unwrap_impl(url), timeout: unwrap_impl(timeout), waitUntil: unwrap_impl(waitUntil)))
     end
 
-    # @nodoc
-    def detached=(req)
-      wrap_impl(@impl.detached=(unwrap_impl(req)))
-    end
-
     # @nodoc
     def highlight(selector)
       wrap_impl(@impl.highlight(unwrap_impl(selector)))
@@ -1054,6 +1049,11 @@ module Playwright
       wrap_impl(@impl.expect(unwrap_impl(selector), unwrap_impl(expression), unwrap_impl(options), unwrap_impl(title)))
     end
 
+    # @nodoc
+    def detached=(req)
+      wrap_impl(@impl.detached=(unwrap_impl(req)))
+    end
+
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)

data/lib/playwright_api/playwright.rb

@@ -94,13 +94,13 @@ module Playwright
     end
 
     # @nodoc
-    def electron
-      wrap_impl(@impl.electron)
+    def android
+      wrap_impl(@impl.android)
     end
 
     # @nodoc
-    def android
-      wrap_impl(@impl.android)
+    def electron
+      wrap_impl(@impl.electron)
     end
 
     # -- inherited from EventEmitter --

data/lib/playwright_api/response.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.54.0
+  version: 1.54.1
 platform: ruby
 authors:
 - YusukeIwaki