playwright-ruby-client 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c54a8690be4b1b2e33cecb6cda92071cd1d6867647fe939b004bf0434c31c74e
-  data.tar.gz: 1c2c784a5970c7a89bffc6bdb12cf7c8e1353a676881a99862bb9bbe30dd3dea
+  metadata.gz: 243ef6d83fffde209cb8effe291c49b80fb90f7fd1fab7dacd451a524793f78a
+  data.tar.gz: 877db73a65179e2409423c73aa1fdf72b0da40ebe2d44bf22bce34533c438c98
 SHA512:
-  metadata.gz: e9ca66a5edc3d168e16b552f3c84e4b4a939a7e8610da439fdea8350a87fed0656a9b5c715e4ac384d23b1d089ab23fa61ccd06288b1f11045aa83a3351a4f94
-  data.tar.gz: cad563aa4e2f81a026f08a04a7fd3caf1295f6419b01f1601d324583243dd839bb4b7f3aec73967555c4dbb6b8ffb8b65e7607836ec2c11231512c6e45fbf526
+  metadata.gz: 01ea7a14404c07a54acd5112ad3704ce0d00ccd562061cbf46b0ec190c26ff0df850c613cddde6ff2d922de390063d6398a02a33f44fad88dd6d5d6ab1918893
+  data.tar.gz: 5e965b61082503371431d72a8b243c6212d5d2f3b6a232d62faf6fed2c85a920c041e259ea8f2d646722bf9e14eb4fcefebc9f40e86dca3a8ec2aa931c63d95b

data/lib/playwright.rb

@@ -15,9 +15,11 @@ require 'playwright/utils'
 
 require 'playwright/channel'
 require 'playwright/channel_owner'
+require 'playwright/input_type'
 require 'playwright/connection'
 require 'playwright/timeout_settings'
 require 'playwright/transport'
+require 'playwright/url_matcher'
 require 'playwright/version'
 require 'playwright/wait_helper'
 

data/lib/playwright/channel_owners/element_handle.rb

@@ -3,6 +3,81 @@ require_relative './js_handle'
 module Playwright
   module ChannelOwners
     class ElementHandle < JSHandle
+      def click(
+            button: nil,
+            clickCount: nil,
+            delay: nil,
+            force: nil,
+            modifiers: nil,
+            noWaitAfter: nil,
+            position: nil,
+            timeout: nil)
+
+        params = {
+          button: button,
+          clickCount: clickCount,
+          delay: delay,
+          force: force,
+          modifiers: modifiers,
+          noWaitAfter: noWaitAfter,
+          position: position,
+          timeout: timeout,
+        }.compact
+        @channel.send_message_to_server('click', params)
+
+        nil
+      end
+
+      def type_text(text, delay: nil, noWaitAfter: nil, timeout: nil)
+        params = {
+          text: text,
+          delay: delay,
+          noWaitAfter: noWaitAfter,
+          timeout: timeout,
+        }.compact
+        @channel.send_message_to_server('type', params)
+
+        nil
+      end
+
+      def press(key, delay: nil, noWaitAfter: nil, timeout: nil)
+        params = {
+          key: key,
+          delay: delay,
+          noWaitAfter: noWaitAfter,
+          timeout: timeout,
+        }.compact
+        @channel.send_message_to_server('press', params)
+
+        nil
+      end
+
+      def query_selector(selector)
+        resp = @channel.send_message_to_server('querySelector', selector: selector)
+        ChannelOwners::ElementHandle.from_nullable(resp)
+      end
+
+      def query_selector_all(selector)
+        @channel.send_message_to_server('querySelectorAll', selector: selector).map do |el|
+          ChannelOwners::ElementHandle.from(el)
+        end
+      end
+
+      def eval_on_selector(selector, pageFunction, arg: nil)
+        if JavaScript.function?(pageFunction)
+          JavaScript::Function.new(pageFunction, arg).eval_on_selector(@channel, selector)
+        else
+          JavaScript::Expression.new(pageFunction).eval_on_selector(@channel, selector)
+        end
+      end
+
+      def eval_on_selector_all(selector, pageFunction, arg: nil)
+        if JavaScript.function?(pageFunction)
+          JavaScript::Function.new(pageFunction, arg).eval_on_selector_all(@channel, selector)
+        else
+          JavaScript::Expression.new(pageFunction).eval_on_selector_all(@channel, selector)
+        end
+      end
     end
   end
 end

data/lib/playwright/channel_owners/frame.rb

@@ -53,6 +53,69 @@ module Playwright
       ChannelOwners::Response.from_nullable(resp)
     end
 
+    private def setup_navigation_wait_helper(timeout:)
+      WaitHelper.new.tap do |helper|
+        helper.reject_on_event(@page, Events::Page::Close, AlreadyClosedError.new)
+        helper.reject_on_event(@page, Events::Page::Crash, CrashedError.new)
+        helper.reject_on_event(@page, Events::Page::FrameDetached, FrameAlreadyDetachedError.new)
+        helper.reject_on_timeout(timeout, "Timeout #{timeout}ms exceeded.")
+      end
+    end
+
+    def wait_for_navigation(timeout: nil, url: nil, waitUntil: nil, &block)
+      option_wait_until = waitUntil || 'load'
+      option_timeout = timeout || @page.send(:timeout_settings).navigation_timeout
+      time_start = Time.now
+
+      wait_helper = setup_navigation_wait_helper(timeout: option_timeout)
+
+      predicate =
+        if url
+          matcher = UrlMatcher.new(url)
+          ->(event) { event['error'] || matcher.match?(event['url']) }
+        else
+          ->(_) { true }
+        end
+
+      wait_helper.wait_for_event(@event_emitter, 'navigated', predicate: predicate)
+
+      block&.call
+
+      event = wait_helper.promise.value!
+      if event['error']
+        raise event['error']
+      end
+
+      unless @load_states.include?(option_wait_until)
+        elapsed_time = Time.now - time_start
+        if elapsed_time < option_timeout
+          wait_for_load_state(state: option_wait_until, timeout: option_timeout - elapsed_time)
+        end
+      end
+
+      request_json = event.dig('newDocument', 'request')
+      request = ChannelOwners::Request.from_nullable(request_json)
+      request&.response
+    end
+
+    def wait_for_load_state(state: nil, timeout: nil)
+      option_state = state || 'load'
+      unless %w(load domcontentloaded networkidle).include?(option_state)
+        raise ArgumentError.new('state: expected one of (load|domcontentloaded|networkidle)')
+      end
+      if @load_states.include?(option_state)
+        return
+      end
+
+      wait_helper = setup_navigation_wait_helper(timeout: timeout)
+
+      predicate = ->(state) { state == option_state }
+      wait_helper.wait_for_event(@event_emitter, 'loadstate', predicate: predicate)
+      wait_helper.promise.value!
+
+      nil
+    end
+
     def evaluate(pageFunction, arg: nil)
       if JavaScript.function?(pageFunction)
         JavaScript::Function.new(pageFunction, arg).evaluate(@channel)
@@ -69,6 +132,33 @@ module Playwright
       end
     end
 
+    def query_selector(selector)
+      resp = @channel.send_message_to_server('querySelector', selector: selector)
+      ChannelOwners::ElementHandle.from_nullable(resp)
+    end
+
+    def query_selector_all(selector)
+      @channel.send_message_to_server('querySelectorAll', selector: selector).map do |el|
+        ChannelOwners::ElementHandle.from(el)
+      end
+    end
+
+    def eval_on_selector(selector, pageFunction, arg: nil)
+      if JavaScript.function?(pageFunction)
+        JavaScript::Function.new(pageFunction, arg).eval_on_selector(@channel, selector)
+      else
+        JavaScript::Expression.new(pageFunction).eval_on_selector(@channel, selector)
+      end
+    end
+
+    def eval_on_selector_all(selector, pageFunction, arg: nil)
+      if JavaScript.function?(pageFunction)
+        JavaScript::Function.new(pageFunction, arg).eval_on_selector_all(@channel, selector)
+      else
+        JavaScript::Expression.new(pageFunction).eval_on_selector_all(@channel, selector)
+      end
+    end
+
     def content
       @channel.send_message_to_server('content')
     end
@@ -85,6 +175,33 @@ module Playwright
       nil
     end
 
+    def click(
+          selector,
+          button: nil,
+          clickCount: nil,
+          delay: nil,
+          force: nil,
+          modifiers: nil,
+          noWaitAfter: nil,
+          position: nil,
+          timeout: nil)
+
+      params = {
+        selector: selector,
+        button: button,
+        clickCount: clickCount,
+        delay: delay,
+        force: force,
+        modifiers: modifiers,
+        noWaitAfter: noWaitAfter,
+        position: position,
+        timeout: timeout,
+      }.compact
+      @channel.send_message_to_server('click', params)
+
+      nil
+    end
+
     def focus(selector, timeout: nil)
       params = { selector: selector, timeout: timeout }.compact
       @channel.send_message_to_server('focus', params)

data/lib/playwright/channel_owners/page.rb

@@ -10,9 +10,9 @@ module Playwright
       @browser_context = @parent
       @timeout_settings = TimeoutSettings.new(@browser_context.send(:_timeout_settings))
       @accessibility = Accessibility.new(@channel)
-      @keyboard = Keyboard.new(@channel)
-      @mouse = Mouse.new(@channel)
-      @touchscreen = Touchscreen.new(@channel)
+      @keyboard = InputTypes::Keyboard.new(@channel)
+      @mouse = InputTypes::Mouse.new(@channel)
+      @touchscreen = InputTypes::Touchscreen.new(@channel)
 
       @viewport_size = @initializer['viewportSize']
       @closed = false
@@ -103,6 +103,14 @@ module Playwright
       @frames.to_a
     end
 
+    def query_selector(selector)
+      @main_frame.query_selector(selector)
+    end
+
+    def query_selector_all(selector)
+      @main_frame.query_selector_all(selector)
+    end
+
     def evaluate(pageFunction, arg: nil)
       @main_frame.evaluate(pageFunction, arg: arg)
     end
@@ -111,6 +119,14 @@ module Playwright
       @main_frame.evaluate_handle(pageFunction, arg: arg)
     end
 
+    def eval_on_selector(selector, pageFunction, arg: nil)
+      @main_frame.eval_on_selector(selector, pageFunction, arg: arg)
+    end
+
+    def eval_on_selector_all(selector, pageFunction, arg: nil)
+      @main_frame.eval_on_selector_all(selector, pageFunction, arg: arg)
+    end
+
     def url
       @main_frame.url
     end
@@ -177,6 +193,30 @@ module Playwright
       @closed
     end
 
+    def click(
+          selector,
+          button: nil,
+          clickCount: nil,
+          delay: nil,
+          force: nil,
+          modifiers: nil,
+          noWaitAfter: nil,
+          position: nil,
+          timeout: nil)
+
+      @main_frame.click(
+        selector,
+        button: button,
+        clickCount: clickCount,
+        delay: delay,
+        force: force,
+        modifiers: modifiers,
+        noWaitAfter: noWaitAfter,
+        position: position,
+        timeout: timeout,
+      )
+    end
+
     def focus(selector, timeout: nil)
       @main_frame.focus(selector, timeout: timeout)
     end
@@ -213,6 +253,12 @@ module Playwright
       end
     end
 
+    class FrameAlreadyDetachedError < StandardError
+      def initialize
+        super('Navigating frame was detached!')
+      end
+    end
+
     def wait_for_event(event, optionsOrPredicate: nil, &block)
       predicate, timeout =
         case optionsOrPredicate
@@ -243,13 +289,20 @@ module Playwright
       wait_helper.promise.value!
     end
 
+    def wait_for_navigation(timeout: nil, url: nil, waitUntil: nil, &block)
+      @main_frame.wait_for_navigation(
+        timeout: timeout,
+        url: url,
+        waitUntil: waitUntil,
+        &block)
+    end
+
     def wait_for_request(urlOrPredicate, timeout: nil)
       predicate =
         case urlOrPredicate
-        when String
-          -> (req){ req.url == urlOrPredicate }
-        when Regexp
-          -> (req){ urlOrPredicate.match?(req.url) }
+        when String, Regexp
+          url_matcher = UrlMatcher.new(urlOrPredicate)
+          -> (req){ url_matcher.match?(req.url) }
         when Proc
           urlOrPredicate
         else
@@ -262,10 +315,9 @@ module Playwright
     def wait_for_response(urlOrPredicate, timeout: nil)
       predicate =
         case urlOrPredicate
-        when String
-          -> (res){ res.url == urlOrPredicate }
-        when Regexp
-          -> (res){ urlOrPredicate.match?(res.url) }
+        when String, Regexp
+          url_matcher = UrlMatcher.new(urlOrPredicate)
+          -> (req){ url_matcher.match?(req.url) }
         when Proc
           urlOrPredicate
         else
@@ -280,5 +332,10 @@ module Playwright
       @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
+    end
   end
 end

data/lib/playwright/channel_owners/request.rb

@@ -1,5 +1,95 @@
+require 'base64'
+
 module Playwright
   # @ref https://github.com/microsoft/playwright-python/blob/master/playwright/_impl/_network.py
   define_channel_owner :Request do
+    def after_initialize
+      @redirected_from = ChannelOwners::Request.from_nullable(@initializer['redirectedFrom'])
+      @redirected_from&.send(:update_redirected_to, self)
+      @timing = {
+        startTime: 0,
+        domainLookupStart: -1,
+        domainLookupEnd: -1,
+        connectStart: -1,
+        secureConnectionStart: -1,
+        connectEnd: -1,
+        requestStart: -1,
+        responseStart: -1,
+        responseEnd: -1,
+      }
+      @headers = parse_headers(@initializer['headers'])
+    end
+
+    def url
+      @initializer['url']
+    end
+
+    def resource_type
+      @initializer['resourceType']
+    end
+
+    def method
+      @initialize['method']
+    end
+
+    def post_data
+      post_data_buffer
+    end
+
+    def post_data_json
+      data = post_data
+      return unless data
+
+      content_type = @headers['content-type']
+      return unless content_type
+
+      if content_type == "application/x-www-form-urlencoded"
+        URI.decode_www_form(data).to_h
+      else
+        JSON.parse(data)
+      end
+    end
+
+    def post_data_buffer
+      base64_content = @initializer['postData']
+      if base64_content
+        Base64.strict_decode64(base64_content)
+      else
+        nil
+      end
+    end
+
+    def headers
+      @headers
+    end
+
+    def response
+      resp = @channel.send_message_to_server('response')
+      ChannelOwners::Response.from_nullable(resp)
+    end
+
+    def frame
+      @initializer['frame']
+    end
+
+    def navigation_request?
+      @initializer['isNavigationRequest']
+    end
+
+    def failure
+      @failure_text
+    end
+
+    attr_reader :headers, :redirected_from, :redirected_to, :timing
+
+    private def update_redirected_to(request)
+      @redirected_to = request
+    end
+
+    private def parse_headers(headers)
+      headers.map do |header|
+        [header['name'].downcase, header['value']]
+      end.to_h
+    end
   end
 end