playwright-ruby-client 0.6.4 → 0.8.0

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

@@ -117,3 +117,5 @@ Playwright.create(playwright_cli_executable_path: 'npx playwright') do |playwrig
   end
 end
 ```
+
+Note that each browser context is isolated and not persisted by default. When persistent browser context is needed, we can use [BrowserType#launch_persistent_context](/docs/api/browser_type#launch_persistent_context).

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

@@ -41,7 +41,7 @@ Capybara.default_max_wait_time = 15
 
 ### (Optional) Update default driver
 
-By default, Capybara driver is set to `:rack_test`, which works only with non-JS contents. If your Rails application has many JavaScript contents, it is recommended to change the default driver to `:playwrite`.
+By default, Capybara driver is set to `:rack_test`, which works only with non-JS contents. If your Rails application has many JavaScript contents, it is recommended to change the default driver to `:playwright`.
 
 ```rb
 Capybara.default_driver = :playwright
@@ -202,4 +202,4 @@ end
 
 * Playwright doesn't allow clicking invisible DOM elements or moving elements. `click` sometimes doesn't work as Selenium does. See the detail in https://playwright.dev/docs/actionability/
 * `current_window.maximize` and `current_window.fullscreen` work only on headful (non-headless) mode, as selenium driver does.
-* `Capybara::Node::Element#drag_to` does not accept `html5` parameter, since [Playwright doesn't implement the feature yet](https://github.com/microsoft/playwright/pull/6207).
+* `Capybara::Node::Element#drag_to` does not accept `html5` parameter. HTML5 drag and drop is not fully supported in Playwright.

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

@@ -0,0 +1,67 @@
+# 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
+
+* Authenticate with OAuth2 manually before automation
+* Testing a page after some chrome extensions are installed manually
+
+Keep in mind repeatedly that persistent browser context is NOT RECOMMENDED for most cases because it would bring many side effects.
+
+## Pause automation for manual operation
+
+`Page#pause` is not implemented yet, however we can use `binding.pry`  (with `pry-byebug` installed) instead.
+
+```ruby {4}
+playwright.chromium.launch_persistent_context('./data/', headless: false) do |context|
+  page = context.new_page
+  page.goto('https://example.com/')
+  binding.pry
+end
+```
+
+When script is executed, it is paused as below.
+
+```
+    3:
+    4: playwright.chromium.launch_persistent_context('./data/', headless: false) do |context|
+    5:   page = context.new_page
+    6:   page.goto('https://example.com/')
+ => 7:   binding.pry
+    8: end
+
+[1] pry(main)>
+```
+
+We can inspect using `page`, `context` and also we can operate something manually during the pause.
+
+See https://github.com/deivid-rodriguez/pry-byebug for more detailed debugging options.
+
+## Working with Chrome extensions
+
+**Playwright disables the Chrome extension feature by default.**
+We have to enable it for installing Chrome extension, by passing these 3 parameters on launch.
+
+* `acceptDownloads: true`
+* `headless: false`
+* `ignoreDefaultArgs: ['--disable-extensions']`
+
+```ruby
+require 'playwright'
+require 'pry'
+
+Playwright.create(playwright_cli_executable_path: './node_modules/.bin/playwright') do |playwright|
+  launch_params = {
+    acceptDownloads: true,
+    channel: 'chrome',
+    headless: false,
+    ignoreDefaultArgs: ['--disable-extensions'],
+  }
+
+  playwright.chromium.launch_persistent_context('./data/', **launch_params) do |context|
+    page = context.new_page
+    page.goto('https://example.com/')
+    binding.pry
+  end
+end
+```

data/documentation/docs/include/api_coverage.md

@@ -26,6 +26,8 @@
 * json
 * ok
 * request
+* security_details
+* server_addr
 * status
 * status_text
 * text
@@ -36,14 +38,15 @@
 * abort
 * continue
 * fulfill
+* ~~intercept~~
 * request
 
-## ~~WebSocket~~
+## WebSocket
 
-* ~~closed?~~
-* ~~url~~
-* ~~expect_event~~
-* ~~wait_for_event~~
+* closed?
+* url
+* expect_event
+* wait_for_event
 
 ## Keyboard
 
@@ -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?
@@ -273,12 +279,12 @@
 * expect_navigation
 * expect_popup
 * expect_request
-* ~~expect_request_finished~~
+* expect_request_finished
 * expect_response
 * wait_for_selector
 * ~~wait_for_timeout~~
 * wait_for_url
-* ~~expect_websocket~~
+* expect_websocket
 * ~~expect_worker~~
 * ~~workers~~
 * ~~wait_for_event~~
@@ -300,7 +306,7 @@
 * expose_binding
 * expose_function
 * grant_permissions
-* ~~new_cdp_session~~
+* new_cdp_session
 * new_page
 * pages
 * route
@@ -317,17 +323,17 @@
 * ~~wait_for_event~~
 * tracing
 
-## ~~CDPSession~~
+## CDPSession
 
-* ~~detach~~
-* ~~send_message~~
+* detach
+* send_message
 
 ## Browser
 
 * close
 * contexts
 * connected?
-* ~~new_browser_cdp_session~~
+* new_browser_cdp_session
 * new_context
 * new_page
 * start_tracing
@@ -340,7 +346,7 @@
 * connect_over_cdp
 * executable_path
 * launch
-* ~~launch_persistent_context~~
+* launch_persistent_context
 * name
 
 ## Playwright

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/browser.rb

@@ -67,6 +67,11 @@ module Playwright
       @initializer['version']
     end
 
+    def new_browser_cdp_session
+      resp = @channel.send_message_to_server('newBrowserCDPSession')
+      ChannelOwners::CDPSession.from(resp)
+    end
+
     def start_tracing(page: nil, categories: nil, path: nil, screenshots: nil)
       params = {
         page: page&.channel,

data/lib/playwright/channel_owners/browser_context.rb

@@ -98,6 +98,11 @@ module Playwright
       page&.emit(Events::Page::Response, response)
     end
 
+    def new_cdp_session(page)
+      resp = @channel.send_message_to_server('newCDPSession', page: page.channel)
+      ChannelOwners::CDPSession.from(resp)
+    end
+
     def set_default_navigation_timeout(timeout)
       @timeout_settings.default_navigation_timeout = timeout
       @channel.send_message_to_server('setDefaultNavigationTimeoutNoReply', timeout: timeout)

data/lib/playwright/channel_owners/browser_type.rb

@@ -1,5 +1,7 @@
 module Playwright
   define_channel_owner :BrowserType do
+    include Utils::PrepareBrowserContextOptions
+
     def name
       @initializer['name']
     end
@@ -20,6 +22,22 @@ module Playwright
       end
     end
 
+    def launch_persistent_context(userDataDir, **options, &block)
+      params = options.dup
+      prepare_browser_context_options(params)
+      params['userDataDir'] = userDataDir
+
+      resp = @channel.send_message_to_server('launchPersistentContext', params.compact)
+      context = ChannelOwners::Browser.from(resp)
+      return context unless block
+
+      begin
+        block.call(context)
+      ensure
+        context.close
+      end
+    end
+
     def connect_over_cdp(endpointURL, headers: nil, slowMo: nil, timeout: nil, &block)
       raise 'Connecting over CDP is only supported in Chromium.' unless name == 'chromium'
 

data/lib/playwright/channel_owners/cdp_session.rb

@@ -0,0 +1,19 @@
+module Playwright
+  define_channel_owner :CDPSession do
+    private def after_initialize
+      @channel.on('event', method(:on_event))
+    end
+
+    private def on_event(params)
+      emit(params['method'], params['params'])
+    end
+
+    def send_message(method, params: {})
+      @channel.send_message_to_server('send', method: method, params: params)
+    end
+
+    def detach
+      @channel.send_message_to_server('detach')
+    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
@@ -759,6 +770,10 @@ module Playwright
       expect_event(Events::Page::Request, predicate: predicate, timeout: timeout, &block)
     end
 
+    def expect_request_finished(predicate: nil, timeout: nil, &block)
+      expect_event(Events::Page::RequestFinished, predicate: predicate, timeout: timeout, &block)
+    end
+
     def expect_response(urlOrPredicate, timeout: nil, &block)
       predicate =
         case urlOrPredicate
@@ -774,6 +789,10 @@ module Playwright
       expect_event(Events::Page::Response, predicate: predicate, timeout: timeout, &block)
     end
 
+    def expect_websocket(predicate: nil, timeout: nil, &block)
+      expect_event(Events::Page::WebSocket, predicate: predicate, timeout: timeout, &block)
+    end
+
     # called from Frame with send(:timeout_settings)
     private def timeout_settings
       @timeout_settings