playwright-ruby-client 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8e3e3982a30add91ed67641a29dcff9778c40788c8434d2ef581cb926951968
-  data.tar.gz: bc7c51236c2d9c2632c53dfe25ae7f9f357c1118a434bb1c41f735a0c67c7625
+  metadata.gz: 05e5dff936dc4eda78a295d4f6935b5b92d6e82046de9a36c9f4b67aba24e89f
+  data.tar.gz: 85f30ee725facdc21d77645007cbeca689cd322dacb559146234fab1de0aab79
 SHA512:
-  metadata.gz: b438126a715d3c427408fb4d0b13483bb6f96444cb9c359a946da70125f00b0eee488e5753493a5f9e37ff1294209fd58a044721e0c7b0b2e5c06ef2a8611aef
-  data.tar.gz: a13605776cfca08333630a2e18cf53035d71b6b0ea454a27f76bf0562ef1d505844c70b1119bdca2c2cfd400d402d2c62e06fe38d53abf561c005b6127900c83
+  metadata.gz: 3c0fefff97e051805fb7d48aa134456d6a45ed5ab6b6818ea506251d93a1991c47bc6fc30aa1e2eae9369b1188564c08e23d083b6f8f8a896efe52d008cf6889
+  data.tar.gz: ebaf0d10fea440818cc182496b72c5ac16d192c76825db8aa271b89f891059b496ffdaaecdcfbaf7482ceb37ea868ac13feae678eee81b76c4e856f419627209

data/README.md

@@ -159,6 +159,32 @@ end
 
 ```
 
+### Communicate with Playwright server
+
+If your environment doesn't accept installing browser or creating browser process, consider separating Ruby client and Playwright server.
+
+![structure](https://user-images.githubusercontent.com/11763113/124934448-ad4d0700-e03f-11eb-942e-b9f3282bb703.png)
+
+For launching Playwright server, just execute:
+
+```
+npx playwright install && npx playwright run-server 8080
+```
+
+and we can connect to the server with the code like this:
+
+```ruby
+Playwright.connect_to_playwright_server('ws://127.0.0.1:8080') do |playwright|
+  playwright.chromium.launch do |browser|
+    page = browser.new_page
+    page.goto('https://github.com/YusukeIwaki')
+    page.screenshot(path: './YusukeIwaki.png')
+  end
+end
+```
+
+When `Playwright.connect_to_playwright_server` is used, playwright_cli_executable_path is not required.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/documentation/docs/api/element_handle.md

@@ -232,7 +232,7 @@ feed_handle.eval_on_selector_all(".tweet", "nodes => nodes.map(n => n.innerText)
 ## fill
 
 ```
-def fill(value, noWaitAfter: nil, timeout: nil)
+def fill(value, force: nil, noWaitAfter: nil, timeout: nil)
 ```
 
 This method waits for [actionability](https://playwright.dev/python/docs/actionability) checks, focuses the element, fills it and triggers an `input`
@@ -300,6 +300,14 @@ def inner_text
 
 Returns the `element.innerText`.
 
+## input_value
+
+```
+def input_value(timeout: nil)
+```
+
+Returns `input.value` for `<input>` or `<textarea>` element. Throws for non-input elements.
+
 ## checked?
 
 ```
@@ -436,6 +444,7 @@ def select_option(
       index: nil,
       value: nil,
       label: nil,
+      force: nil,
       noWaitAfter: nil,
       timeout: nil)
 ```
@@ -470,7 +479,7 @@ element_handle.select_option(value: "blue", index: 2, label: "red")
 ## select_text
 
 ```
-def select_text(timeout: nil)
+def select_text(force: nil, timeout: nil)
 ```
 
 This method waits for [actionability](https://playwright.dev/python/docs/actionability) checks, then focuses the element and selects all its text

data/documentation/docs/api/frame.md

@@ -326,7 +326,12 @@ result_handle.dispose
 ## fill
 
 ```
-def fill(selector, value, noWaitAfter: nil, timeout: nil)
+def fill(
+      selector,
+      value,
+      force: nil,
+      noWaitAfter: nil,
+      timeout: nil)
 ```
 
 This method waits for an element matching `selector`, waits for [actionability](https://playwright.dev/python/docs/actionability) checks, focuses the
@@ -443,6 +448,14 @@ def inner_text(selector, timeout: nil)
 
 Returns `element.innerText`.
 
+## input_value
+
+```
+def input_value(selector, timeout: nil)
+```
+
+Returns `input.value` for the selected `<input>` or `<textarea>` element. Throws for non-input elements.
+
 ## checked?
 
 ```
@@ -588,6 +601,7 @@ def select_option(
       index: nil,
       value: nil,
       label: nil,
+      force: nil,
       noWaitAfter: nil,
       timeout: nil)
 ```

data/documentation/docs/api/page.md

@@ -499,7 +499,12 @@ page.click("button")
 ## fill
 
 ```
-def fill(selector, value, noWaitAfter: nil, timeout: nil)
+def fill(
+      selector,
+      value,
+      force: nil,
+      noWaitAfter: nil,
+      timeout: nil)
 ```
 
 This method waits for an element matching `selector`, waits for [actionability](https://playwright.dev/python/docs/actionability) checks, focuses the
@@ -650,6 +655,14 @@ def inner_text(selector, timeout: nil)
 
 Returns `element.innerText`.
 
+## input_value
+
+```
+def input_value(selector, timeout: nil)
+```
+
+Returns `input.value` for the selected `<input>` or `<textarea>` element. Throws for non-input elements.
+
 ## checked?
 
 ```
@@ -934,6 +947,7 @@ def select_option(
       index: nil,
       value: nil,
       label: nil,
+      force: nil,
       noWaitAfter: nil,
       timeout: nil)
 ```

data/documentation/docs/api/response.md

@@ -64,6 +64,22 @@ def request
 
 Returns the matching [Request](./request) object.
 
+## security_details
+
+```
+def security_details
+```
+
+Returns SSL and other security information.
+
+## server_addr
+
+```
+def server_addr
+```
+
+Returns the IP address and port of the server.
+
 ## status
 
 ```

data/documentation/docs/include/api_coverage.md

@@ -26,6 +26,8 @@
 * json
 * ok
 * request
+* security_details
+* server_addr
 * status
 * status_text
 * text
@@ -36,6 +38,7 @@
 * abort
 * continue
 * fulfill
+* ~~intercept~~
 * request
 
 ## WebSocket
@@ -91,6 +94,7 @@
 * hover
 * inner_html
 * inner_text
+* input_value
 * checked?
 * disabled?
 * editable?
@@ -146,6 +150,7 @@
 * hover
 * inner_html
 * inner_text
+* input_value
 * checked?
 * detached?
 * disabled?
@@ -231,6 +236,7 @@
 * hover
 * inner_html
 * inner_text
+* input_value
 * checked?
 * closed?
 * disabled?

data/lib/playwright.rb

@@ -59,7 +59,8 @@ module Playwright
   # and we *must* call execution.stop on the end.
   # The instance of playwright is available by calling execution.playwright
   module_function def create(playwright_cli_executable_path:, &block)
-    connection = Connection.new(playwright_cli_executable_path: playwright_cli_executable_path)
+    transport = Transport.new(playwright_cli_executable_path: playwright_cli_executable_path)
+    connection = Connection.new(transport)
     connection.async_run
 
     execution =
@@ -82,7 +83,39 @@ module Playwright
     end
   end
 
-  module_function def instance
-    @playwright_instance
+  # 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
+  module_function def connect_to_playwright_server(ws_endpoint, &block)
+    require 'playwright/web_socket_client'
+    require 'playwright/web_socket_transport'
+
+    transport = WebSocketTransport.new(ws_endpoint: ws_endpoint)
+    connection = Connection.new(transport)
+    connection.async_run
+
+    execution =
+      begin
+        playwright = connection.wait_for_object_with_known_name('Playwright')
+        Execution.new(connection, PlaywrightApi.wrap(playwright))
+      rescue
+        connection.stop
+        raise
+      end
+
+    if block
+      begin
+        block.call(execution.playwright)
+      ensure
+        execution.stop
+      end
+    else
+      execution
+    end
   end
 end

data/lib/playwright/channel_owners/element_handle.rb

@@ -146,6 +146,7 @@ module Playwright
             index: nil,
             value: nil,
             label: nil,
+            force: nil,
             noWaitAfter: nil,
             timeout: nil)
         base_params = SelectOptionValues.new(
@@ -154,7 +155,7 @@ module Playwright
           value: value,
           label: label,
         ).as_params
-        params = base_params.merge({ noWaitAfter: noWaitAfter, timeout: timeout }.compact)
+        params = base_params.merge({ force: force, noWaitAfter: noWaitAfter, timeout: timeout }.compact)
         @channel.send_message_to_server('selectOption', params)
       end
 
@@ -179,9 +180,10 @@ module Playwright
         nil
       end
 
-      def fill(value, noWaitAfter: nil, timeout: nil)
+      def fill(value, force: nil, noWaitAfter: nil, timeout: nil)
         params = {
           value: value,
+          force: force,
           noWaitAfter: noWaitAfter,
           timeout: timeout,
         }.compact
@@ -190,13 +192,18 @@ module Playwright
         nil
       end
 
-      def select_text(timeout: nil)
-        params = { timeout: timeout }.compact
+      def select_text(force: nil, timeout: nil)
+        params = { force: force, timeout: timeout }.compact
         @channel.send_message_to_server('selectText', params)
 
         nil
       end
 
+      def input_value(timeout: nil)
+        params = { timeout: timeout }.compact
+        @channel.send_message_to_server('inputValue', params)
+      end
+
       def set_input_files(files, noWaitAfter: nil, timeout: nil)
         file_payloads = InputFiles.new(files).as_params
         params = { files: file_payloads, noWaitAfter: noWaitAfter, timeout: timeout }.compact

data/lib/playwright/channel_owners/frame.rb

@@ -342,10 +342,16 @@ module Playwright
       nil
     end
 
-    def fill(selector, value, noWaitAfter: nil, timeout: nil)
+    def fill(
+          selector,
+          value,
+          force: nil,
+          noWaitAfter: nil,
+          timeout: nil)
       params = {
         selector: selector,
         value: value,
+        force: force,
         noWaitAfter: noWaitAfter,
         timeout: timeout,
       }.compact
@@ -410,6 +416,7 @@ module Playwright
           index: nil,
           value: nil,
           label: nil,
+          force: nil,
           noWaitAfter: nil,
           timeout: nil)
       base_params = SelectOptionValues.new(
@@ -418,10 +425,15 @@ module Playwright
         value: value,
         label: label,
       ).as_params
-      params = base_params.merge({ selector: selector, noWaitAfter: noWaitAfter, timeout: timeout }.compact)
+      params = base_params.merge({ selector: selector, force: force, noWaitAfter: noWaitAfter, timeout: timeout }.compact)
       @channel.send_message_to_server('selectOption', params)
     end
 
+    def input_value(selector, timeout: nil)
+      params = { selector: selector, timeout: timeout }.compact
+      @channel.send_message_to_server('inputValue', params)
+    end
+
     def set_input_files(selector, files, noWaitAfter: nil, timeout: nil)
       file_payloads = InputFiles.new(files).as_params
       params = { files: file_payloads, selector: selector, noWaitAfter: noWaitAfter, timeout: timeout }.compact

data/lib/playwright/channel_owners/page.rb

@@ -505,8 +505,13 @@ module Playwright
       )
     end
 
-    def fill(selector, value, noWaitAfter: nil, timeout: nil)
-      @main_frame.fill(selector, value, noWaitAfter: noWaitAfter, timeout: timeout)
+    def fill(
+      selector,
+      value,
+      force: nil,
+      noWaitAfter: nil,
+      timeout: nil)
+      @main_frame.fill(selector, value, force: force, noWaitAfter: noWaitAfter, timeout: timeout)
     end
 
     def focus(selector, timeout: nil)
@@ -552,6 +557,7 @@ module Playwright
           index: nil,
           value: nil,
           label: nil,
+          force: nil,
           noWaitAfter: nil,
           timeout: nil)
       @main_frame.select_option(
@@ -560,11 +566,16 @@ module Playwright
         index: index,
         value: value,
         label: label,
+        force: force,
         noWaitAfter: noWaitAfter,
         timeout: timeout,
       )
     end
 
+    def input_value(selector, timeout: nil)
+      @main_frame.input_value(selector, timeout: timeout)
+    end
+
     def set_input_files(selector, files, noWaitAfter: nil, timeout: nil)
       @main_frame.set_input_files(selector, files, noWaitAfter: noWaitAfter, timeout: timeout)
     end

data/lib/playwright/channel_owners/response.rb

@@ -44,6 +44,14 @@ module Playwright
       end.to_h
     end
 
+    def server_addr
+      @channel.send_message_to_server('serverAddr')
+    end
+
+    def security_details
+      @channel.send_message_to_server('securityDetails')
+    end
+
     def finished
       @channel.send_message_to_server('finished')
     end

data/lib/playwright/connection.rb

@@ -5,10 +5,8 @@ module Playwright
   # https://github.com/microsoft/playwright-python/blob/master/playwright/_impl/_connection.py
   # https://github.com/microsoft/playwright-java/blob/master/playwright/src/main/java/com/microsoft/playwright/impl/Connection.java
   class Connection
-    def initialize(playwright_cli_executable_path:)
-      @transport = Transport.new(
-        playwright_cli_executable_path: playwright_cli_executable_path
-      )
+    def initialize(transport)
+      @transport = transport
       @transport.on_message_received do |message|
         dispatch(message)
       end

data/lib/playwright/transport.rb

@@ -8,7 +8,6 @@ module Playwright
   # ref: https://github.com/microsoft/playwright-python/blob/master/playwright/_impl/_transport.py
   class Transport
     # @param playwright_cli_executable_path [String] path to playwright-cli.
-    # @param debug [Boolean]
     def initialize(playwright_cli_executable_path:)
       @driver_executable_path = playwright_cli_executable_path
       @debug = ENV['DEBUG'].to_s == 'true' || ENV['DEBUG'].to_s == '1'