playwright-ruby-client 0.5.6 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00cad3443e3aa3e8f527ceda91858789a4ab9ed2853a99f48c24abae1e0e1a0e
-  data.tar.gz: f326aa14284545710e95eb53986053325fbf37b5ddc3a82edc9fecf1454afccf
+  metadata.gz: a283a84899327e4b56db01800535c7231c1c2e94e7cbf11bd72ec60b1415c92c
+  data.tar.gz: 5e929e57b0b8d3b0970c2a0cb5029acd6cc5bd23e419bf06bc1b0a45e2f5e781
 SHA512:
-  metadata.gz: 81d0d106ae9bdc7dd12e001dd82aec2e5cfe507cb04330df67e480127f8cd07f92f92dcca078900069ba134bcd34c9643ec17c1629ee288037d85e062cda741f
-  data.tar.gz: 6ff3bf21ddcf009eb5eda9365ad324796692993166ead922d71a145b0c861161c6062f0ddb3fe0f6471eb5c5c6de6bbb52399ad5fa128ebd070c7fc322a624c2
+  metadata.gz: d13545073c8a110c55098547c7f7c5c4adae5c542b6b18f78be4cf3e5187cf2c92d8ccc86484c0e7bdfbeaf619ff6c8f77ce2f9c82b5eccad4c72dffb22603a5
+  data.tar.gz: ea4a751f747e5738121c8603eb3e495dd2ef32082d1fbd92841c2a0182637300b7c3bde0a00acbf1b25bdc572b140ff4e8a5a694dda95152f568ea5aa2760fef

data/README.md

@@ -2,7 +2,7 @@
 
 # 🎭 Playwright client for Ruby
 
-Note: Currently, this Gem is just a PoC (Proof of Concept). If you want to develop browser-automation for Chrome with Ruby, consider using [puppeteer-ruby](https://github.com/YusukeIwaki/puppeteer-ruby). The list of the available APIs of playwright-ruby-client is [here](./docs/api_coverage.md)
+#### [Docs](https://playwright-ruby-client.vercel.app/docs/article/getting_started) | [API](https://playwright-ruby-client.vercel.app/docs/api/playwright)
 
 ## Getting Started
 

data/docs/api_coverage.md

@@ -140,7 +140,7 @@
 * evaluate_handle
 * fill
 * focus
-* ~~frame_element~~
+* frame_element
 * get_attribute
 * goto
 * hover
@@ -313,6 +313,7 @@
 * expect_event
 * expect_page
 * ~~wait_for_event~~
+* tracing
 
 ## ~~CDPSession~~
 
@@ -333,6 +334,8 @@
 
 ## BrowserType
 
+* ~~connect~~
+* connect_over_cdp
 * executable_path
 * launch
 * ~~launch_persistent_context~~
@@ -347,6 +350,12 @@
 * selectors
 * webkit
 
+## Tracing
+
+* export
+* start
+* stop
+
 ## Android
 
 * devices

data/lib/playwright/channel_owner.rb

@@ -10,6 +10,9 @@ module Playwright
       channel&.object
     end
 
+    # hidden field for caching API instance.
+    attr_accessor :_api
+
     # @param parent [Playwright::ChannelOwner|Playwright::Connection]
     # @param type [String]
     # @param guid [String]

data/lib/playwright/channel_owners/browser.rb

@@ -5,6 +5,10 @@ module Playwright
     include Utils::PrepareBrowserContextOptions
 
     private def after_initialize
+      @connected = true
+      @closed_or_closing = false
+      @remote = true
+
       @contexts = Set.new
       @channel.on('close', method(:on_close))
     end
@@ -48,6 +52,14 @@ module Playwright
 
     def close
       return if @closed_or_closing
+      if @remote
+        @contexts.each do |context|
+          context.pages.each do |page|
+            page.send(:on_close)
+          end
+          context.send(:on_close)
+        end
+      end
       @closed_or_closing = true
       @channel.send_message_to_server('close')
       nil
@@ -77,8 +89,16 @@ module Playwright
 
     private def on_close(_ = {})
       @connected = false
-      emit(Events::Browser::Disconnected)
-      @closed_or_closing = false
+      if @remote
+        @contexts.each do |context|
+          context.pages.each do |page|
+            page.send(:on_close)
+          end
+          context.send(:on_close)
+        end
+      end
+      emit(Events::Browser::Disconnected, self)
+      @closed_or_closing = true
     end
 
     # called from BrowserType#connectOverCDP
@@ -86,6 +106,11 @@ module Playwright
       @contexts << context
     end
 
+    # called from BrowserType#connectOverCDP
+    private def update_as_remote
+      @remote = true
+    end
+
     # called from BrowserContext#on_close with send(:remove_context), so keep private.
     private def remove_context(context)
       @contexts.delete(context)

data/lib/playwright/channel_owners/browser_context.rb

@@ -4,6 +4,7 @@ module Playwright
     include Utils::Errors::SafeCloseError
     attr_accessor :browser
     attr_writer :owner_page, :options
+    attr_reader :tracing
 
     private def after_initialize
       @pages = Set.new
@@ -11,16 +12,43 @@ module Playwright
       @bindings = {}
       @timeout_settings = TimeoutSettings.new
 
+      @tracing = TracingImpl.new(@channel, self)
       @channel.on('bindingCall', ->(params) { on_binding(ChannelOwners::BindingCall.from(params['binding'])) })
       @channel.once('close', ->(_) { on_close })
       @channel.on('page', ->(params) { on_page(ChannelOwners::Page.from(params['page']) )})
       @channel.on('route', ->(params) {
         on_route(ChannelOwners::Route.from(params['route']), ChannelOwners::Request.from(params['request']))
       })
+      @channel.on('request', ->(params) {
+        on_request(
+          ChannelOwners::Request.from(params['request']),
+          ChannelOwners::Request.from_nullable(params['page']),
+        )
+      })
+      @channel.on('requestFailed', ->(params) {
+        on_request_failed(
+          ChannelOwners::Request.from(params['request']),
+          params['responseEndTiming'],
+          params['failureText'],
+          ChannelOwners::Request.from_nullable(params['page']),
+        )
+      })
+      @channel.on('requestFinished', ->(params) {
+        on_request_finished(
+          ChannelOwners::Request.from(params['request']),
+          params['responseEndTiming'],
+          ChannelOwners::Request.from_nullable(params['page']),
+        )
+      })
+      @channel.on('response', ->(params) {
+        on_response(
+          ChannelOwners::Response.from(params['response']),
+          ChannelOwners::Request.from_nullable(params['page']),
+        )
+      })
     end
 
     private def on_page(page)
-      page.send(:update_browser_context, self)
       @pages << page
       emit(Events::BrowserContext::Page, page)
       page.send(:emit_popup_event_from_browser_context)
@@ -45,6 +73,29 @@ module Playwright
       end
     end
 
+    private def on_request_failed(request, response_end_timing, failure_text, page)
+      request.send(:update_failure_text, failure_text)
+      request.send(:update_response_end_timing, response_end_timing)
+      emit(Events::BrowserContext::RequestFailed, request)
+      page&.emit(Events::Page::RequestFailed, request)
+    end
+
+    private def on_request_finished(request, response_end_timing, page)
+      request.send(:update_response_end_timing, response_end_timing)
+      emit(Events::BrowserContext::RequestFinished, request)
+      page&.emit(Events::Page::RequestFinished, request)
+    end
+
+    private def on_request(request, page)
+      emit(Events::BrowserContext::Request, request)
+      page&.emit(Events::Page::Request, request)
+    end
+
+    private def on_response(response, page)
+      emit(Events::BrowserContext::Response, response)
+      page&.emit(Events::Page::Response, response)
+    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

@@ -23,17 +23,24 @@ module Playwright
       end
     end
 
-    def connect_over_cdp(endpointURL, slowMo: nil, timeout: nil, &block)
+    def connect_over_cdp(endpointURL, headers: nil, slowMo: nil, timeout: nil, &block)
       raise 'Connecting over CDP is only supported in Chromium.' unless name == 'chromium'
 
       params = {
         sdkLanguage: 'ruby',
         endpointURL: endpointURL,
+        headers: headers,
         slowMo: slowMo,
         timeout: timeout,
       }.compact
+
+      if headers
+        params[:headers] = HttpHeaders.new(headers).as_serialized
+      end
+
       result = @channel.send_message_to_server_result('connectOverCDP', params)
       browser = ChannelOwners::Browser.from(result['browser'])
+      browser.send(:update_as_remote)
 
       if result['defaultContext']
         context = ChannelOwners::BrowserContext.from(result['defaultContext'])

data/lib/playwright/channel_owners/element_handle.rb

@@ -76,12 +76,13 @@ module Playwright
         nil
       end
 
-      def hover(force: nil, modifiers: nil, position: nil, timeout: nil)
+      def hover(force: nil, modifiers: nil, position: nil, timeout: nil, trial: nil)
         params = {
           force: force,
           modifiers: modifiers,
           position: position,
           timeout: timeout,
+          trial: trial,
         }.compact
         @channel.send_message_to_server('hover', params)
 
@@ -96,7 +97,8 @@ module Playwright
             modifiers: nil,
             noWaitAfter: nil,
             position: nil,
-            timeout: nil)
+            timeout: nil,
+            trial: nil)
 
         params = {
           button: button,
@@ -107,6 +109,7 @@ module Playwright
           noWaitAfter: noWaitAfter,
           position: position,
           timeout: timeout,
+          trial: trial,
         }.compact
         @channel.send_message_to_server('click', params)
 
@@ -120,7 +123,8 @@ module Playwright
             modifiers: nil,
             noWaitAfter: nil,
             position: nil,
-            timeout: nil)
+            timeout: nil,
+            trial: nil)
 
         params = {
           button: button,
@@ -130,6 +134,7 @@ module Playwright
           noWaitAfter: noWaitAfter,
           position: position,
           timeout: timeout,
+          trial: trial,
         }.compact
         @channel.send_message_to_server('dblclick', params)
 
@@ -158,7 +163,8 @@ module Playwright
             modifiers: nil,
             noWaitAfter: nil,
             position: nil,
-            timeout: nil)
+            timeout: nil,
+            trial: nil)
 
         params = {
           force: force,
@@ -166,6 +172,7 @@ module Playwright
           noWaitAfter: noWaitAfter,
           position: position,
           timeout: timeout,
+          trial: trial,
         }.compact
         @channel.send_message_to_server('tap', params)
 
@@ -228,24 +235,26 @@ module Playwright
         nil
       end
 
-      def check(force: nil, noWaitAfter: nil, position: nil, timeout: nil)
+      def check(force: nil, noWaitAfter: nil, position: nil, timeout: nil, trial: nil)
         params = {
           force: force,
           noWaitAfter:  noWaitAfter,
           position: position,
           timeout: timeout,
+          trial: trial,
         }.compact
         @channel.send_message_to_server('check', params)
 
         nil
       end
 
-      def uncheck(force: nil, noWaitAfter: nil, position: nil, timeout: nil)
+      def uncheck(force: nil, noWaitAfter: nil, position: nil, timeout: nil, trial: nil)
         params = {
           force: force,
           noWaitAfter:  noWaitAfter,
           position: position,
           timeout: timeout,
+          trial: trial,
         }.compact
         @channel.send_message_to_server('uncheck', params)
 

data/lib/playwright/channel_owners/frame.rb

@@ -126,6 +126,11 @@ module Playwright
       nil
     end
 
+    def frame_element
+      resp = @channel.send_message_to_server('frameElement')
+      ChannelOwners::ElementHandle.from(resp)
+    end
+
     def evaluate(pageFunction, arg: nil)
       if JavaScript.function?(pageFunction)
         JavaScript::Function.new(pageFunction, arg).evaluate(@channel)
@@ -284,7 +289,8 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
-          timeout: nil)
+          timeout: nil,
+          trial: nil)
 
       params = {
         selector: selector,
@@ -296,6 +302,7 @@ module Playwright
         noWaitAfter: noWaitAfter,
         position: position,
         timeout: timeout,
+        trial: trial,
       }.compact
       @channel.send_message_to_server('click', params)
 
@@ -310,7 +317,8 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
-          timeout: nil)
+          timeout: nil,
+          trial: nil)
 
       params = {
         selector: selector,
@@ -321,6 +329,7 @@ module Playwright
         noWaitAfter: noWaitAfter,
         position: position,
         timeout: timeout,
+        trial: trial,
       }.compact
       @channel.send_message_to_server('dblclick', params)
 
@@ -333,7 +342,8 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
-          timeout: nil)
+          timeout: nil,
+          trial: nil)
       params = {
         selector: selector,
         force: force,
@@ -341,6 +351,7 @@ module Playwright
         noWaitAfter: noWaitAfter,
         position: position,
         timeout: timeout,
+        trial: trial,
       }.compact
       @channel.send_message_to_server('tap', params)
 
@@ -394,13 +405,15 @@ module Playwright
           force: nil,
           modifiers: nil,
           position: nil,
-          timeout: nil)
+          timeout: nil,
+          trial: nil)
       params = {
         selector: selector,
         force: force,
         modifiers: modifiers,
         position: position,
         timeout: timeout,
+        trial: trial,
       }.compact
       @channel.send_message_to_server('hover', params)
 
@@ -476,7 +489,8 @@ module Playwright
       force: nil,
       noWaitAfter: nil,
       position: nil,
-      timeout: nil)
+      timeout: nil,
+      trial: nil)
 
       params = {
         selector: selector,
@@ -484,6 +498,7 @@ module Playwright
         noWaitAfter:  noWaitAfter,
         position: position,
         timeout: timeout,
+        trial: trial,
       }.compact
       @channel.send_message_to_server('check', params)
 
@@ -495,7 +510,8 @@ module Playwright
       force: nil,
       noWaitAfter: nil,
       position: nil,
-      timeout: nil)
+      timeout: nil,
+      trial: nil)
 
       params = {
         selector: selector,
@@ -503,6 +519,7 @@ module Playwright
         noWaitAfter:  noWaitAfter,
         position: position,
         timeout: timeout,
+        trial: trial,
       }.compact
       @channel.send_message_to_server('uncheck', params)
 

data/lib/playwright/channel_owners/page.rb

@@ -56,25 +56,6 @@ module Playwright
       @channel.on('pageError', ->(params) {
         emit(Events::Page::PageError, Error.parse(params['error']['error']))
       })
-      @channel.on('request', ->(params) {
-        emit(Events::Page::Request, ChannelOwners::Request.from(params['request']))
-      })
-      @channel.on('requestFailed', ->(params) {
-        on_request_failed(
-          ChannelOwners::Request.from(params['request']),
-          params['responseEndTiming'],
-          params['failureText'],
-        )
-      })
-      @channel.on('requestFinished', ->(params) {
-        on_request_finished(
-          ChannelOwners::Request.from(params['request']),
-          params['responseEndTiming'],
-        )
-      })
-      @channel.on('response', ->(params) {
-        emit(Events::Page::Response, ChannelOwners::Response.from(params['response']))
-      })
       @channel.on('route', ->(params) {
         on_route(ChannelOwners::Route.from(params['route']), ChannelOwners::Request.from(params['request']))
       })
@@ -95,17 +76,6 @@ module Playwright
       :viewport_size,
       :main_frame
 
-    private def on_request_failed(request, response_end_timing, failure_text)
-      request.send(:update_failure_text, failure_text)
-      request.send(:update_response_end_timing, response_end_timing)
-      emit(Events::Page::RequestFailed, request)
-    end
-
-    private def on_request_finished(request, response_end_timing)
-      request.send(:update_response_end_timing, response_end_timing)
-      emit(Events::Page::RequestFinished, request)
-    end
-
     private def on_frame_attached(frame)
       frame.send(:update_page_from_page, self)
       @frames << frame
@@ -145,6 +115,7 @@ module Playwright
 
     private def on_download(params)
       download = Download.new(
+        page: self,
         url: params['url'],
         suggested_filename: params['suggestedFilename'],
         artifact: ChannelOwners::Artifact.from(params['artifact']),
@@ -464,7 +435,8 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
-          timeout: nil)
+          timeout: nil,
+          trial: nil)
 
       @main_frame.click(
         selector,
@@ -476,6 +448,7 @@ module Playwright
         noWaitAfter: noWaitAfter,
         position: position,
         timeout: timeout,
+        trial: trial,
       )
     end
 
@@ -487,7 +460,8 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
-          timeout: nil)
+          timeout: nil,
+          trial: nil)
       @main_frame.dblclick(
         selector,
         button: button,
@@ -497,6 +471,7 @@ module Playwright
         noWaitAfter: noWaitAfter,
         position: position,
         timeout: timeout,
+        trial: trial,
       )
     end
 
@@ -506,7 +481,8 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
-          timeout: nil)
+          timeout: nil,
+          trial: nil)
       @main_frame.tap_point(
         selector,
         force: force,
@@ -514,6 +490,7 @@ module Playwright
         noWaitAfter: noWaitAfter,
         position: position,
         timeout: timeout,
+        trial: trial,
       )
     end
 
@@ -546,13 +523,15 @@ module Playwright
           force: nil,
           modifiers: nil,
           position: nil,
-          timeout: nil)
+          timeout: nil,
+          trial: nil)
       @main_frame.hover(
         selector,
         force: force,
         modifiers: modifiers,
         position: position,
         timeout: timeout,
+        trial: trial,
       )
     end
 
@@ -604,9 +583,10 @@ module Playwright
       force: nil,
       noWaitAfter: nil,
       position: nil,
-      timeout: nil)
+      timeout: nil,
+      trial: nil)
 
-      @main_frame.check(selector, force: force, noWaitAfter: noWaitAfter, position: position, timeout: timeout)
+      @main_frame.check(selector, force: force, noWaitAfter: noWaitAfter, position: position, timeout: timeout, trial: trial)
     end
 
     def uncheck(
@@ -614,9 +594,10 @@ module Playwright
       force: nil,
       noWaitAfter: nil,
       position: nil,
-      timeout: nil)
+      timeout: nil,
+      trial: nil)
 
-      @main_frame.uncheck(selector, force: force, noWaitAfter: noWaitAfter, position: position, timeout: timeout)
+      @main_frame.uncheck(selector, force: force, noWaitAfter: noWaitAfter, position: position, timeout: timeout, trial: trial)
     end
 
     def wait_for_function(pageFunction, arg: nil, polling: nil, timeout: nil)
@@ -783,12 +764,6 @@ module Playwright
       expect_event(Events::Page::Response, predicate: predicate, timeout: timeout)
     end
 
-    # called from BrowserContext#on_page with send(:update_browser_context, page), so keep private.
-    private def update_browser_context(context)
-      @browser_context = context
-      @timeout_settings = TimeoutSettings.new(context.send(:_timeout_settings))
-    end
-
     # called from Frame with send(:timeout_settings)
     private def timeout_settings
       @timeout_settings
@@ -798,5 +773,11 @@ module Playwright
     private def has_bindings?(name)
       @bindings.key?(name)
     end
+
+    # Expose guid for library developers.
+    # Not intended to be used by users.
+    def guid
+      @guid
+    end
   end
 end