chromate-rb 0.0.2.pre → 0.0.3.pre

data/lib/chromate/browser.rb

@@ -6,10 +6,15 @@ require 'securerandom'
 require 'net/http'
 require 'websocket-client-simple'
 require_relative 'helpers'
+require_relative 'binary'
 require_relative 'client'
-require_relative 'element'
 require_relative 'hardwares'
+require_relative 'element'
 require_relative 'elements/select'
+require_relative 'elements/option'
+require_relative 'elements/tags'
+require_relative 'elements/radio'
+require_relative 'elements/checkbox'
 require_relative 'user_agent'
 require_relative 'actions/navigate'
 require_relative 'actions/screenshot'
@@ -41,19 +46,13 @@ module Chromate
       @xfvb           = @options.fetch(:xfvb)
       @native_control = @options.fetch(:native_control)
       @record         = @options.fetch(:record, false)
-      @process        = nil
-      @xfvb_process   = nil
+      @binary         = nil
       @record_process = nil
       @client         = nil
-      @args           = [
-        @chrome_path,
-        "--user-data-dir=#{@user_data_dir}"
-      ]
+      @args           = []
 
       trap('INT') { stop_and_exit }
       trap('TERM') { stop_and_exit }
-
-      at_exit { stop }
     end
 
     # @return [self]
@@ -72,25 +71,34 @@ module Chromate
 
       Hardwares::MouseController.reset_mouse_position
       Chromate::CLogger.log("Starting browser with args: #{@args}", level: :debug)
-      @process = spawn(*@args, err: 'chrome_errors.log', out: 'chrome_output.log')
-      sleep 2
+      @binary = Binary.new(@chrome_path, @args)
 
+      @binary.start
       @client.start
 
       start_video_recording if @record
 
       patch if config.patch?
 
+      update_config!
+
       self
     end
 
+    # @return [Boolean]
+    def started?
+      @binary&.started? || false
+    end
+
     # @return [self]
     def stop
-      stop_process(@process)        if @process
       stop_process(@record_process) if @record_process
-      stop_process(@xfvb_process)   if @xfvb_process
+      @binary.stop                  if started?
       @client&.stop
 
+      @binary = nil
+      @record_process = nil
+
       self
     end
 
@@ -104,30 +112,67 @@ module Chromate
     # @return [Integer]
     def start_video_recording
       outname = @record.is_a?(String) ? @record : "output_video_#{Time.now.to_i}.mp4"
-      outfile = File.join(Dir.pwd, outname)
-      # TODO: get screen resolution dynamically
-      @record_process = spawn(
-        "ffmpeg -f x11grab -draw_mouse 1 -r 30 -s 1920x1080 -i #{ENV.fetch("DISPLAY")} -c:v libx264 -preset ultrafast -pix_fmt yuv420p -y #{outfile}"
-      )
+      outfile = File.join(Dir.pwd, outname).to_s
+      args = [
+        '-f',
+        'x11grab',
+        '-draw_mouse',
+        '1',
+        '-r',
+        '30',
+        '-s',
+        '1920x1080',
+        '-i',
+        ENV.fetch('DISPLAY'),
+        '-c:v',
+        'libx264',
+        '-preset',
+        'ultrafast',
+        '-pix_fmt',
+        'yuv420p',
+        '-y',
+        outfile
+      ]
+      binary = Binary.new('ffmpeg', args)
+      binary.start
+      @record_process = binary.pid
     end
 
     # @return [Array<String>]
     def build_args
       exclude_switches = config.exclude_switches || []
       exclude_switches += @options[:exclude_switches] if @options[:exclude_switches]
+      @user_agent = @options[:user_agent] || UserAgent.call
 
-      if @options.dig(:options, :args)
-        @args += @options[:options][:args]
-        @args << "--exclude-switches=#{exclude_switches.join(",")}" if exclude_switches.any?
-        return @args
-      end
-      @args += config.generate_arguments(**@options)
-      @args << "--user-agent=#{@options[:user_agent] || UserAgent.call}"
+      @args = if @options.dig(:options, :args)
+                @options[:options][:args]
+              else
+                config.generate_arguments(**@options)
+              end
+
+      @args << "--user-agent=#{@user_agent}"
       @args << "--exclude-switches=#{exclude_switches.join(",")}" if exclude_switches.any?
+      @args << "--user-data-dir=#{@user_data_dir}"
 
       @args
     end
 
+    def set_hardwares
+      config.mouse_controller = Hardwares.mouse(client: @client, element: nil)
+      config.keyboard_controller = Hardwares.keyboard(client: @client, element: nil)
+    end
+
+    # @return [void]
+    def update_config!
+      config.args = @args
+      config.user_data_dir = @user_data_dir
+      config.headless = @headless
+      config.xfvb = @xfvb
+      config.native_control = @native_control
+
+      set_hardwares
+    end
+
     # @param pid [Integer] PID of the process to stop
     # @param timeout [Integer] Timeout in seconds to wait for the process to stop
     # @return [void]
@@ -144,7 +189,6 @@ module Chromate
         # If the process does not stop gracefully, send SIGKILL
         CLogger.log("Process #{pid} did not stop gracefully. Sending SIGKILL...", level: :debug)
         Process.kill('KILL', pid)
-        Process.wait(pid)
       end
     rescue Errno::ESRCH
       # The process has already stopped

data/lib/chromate/c_logger.rb

@@ -12,6 +12,7 @@ module Chromate
       self.formatter = proc do |severity, datetime, _progname, msg|
         "[Chromate] #{datetime.strftime("%Y-%m-%d %H:%M:%S")} #{severity}: #{msg}\n"
       end
+      self.level = ENV['CHROMATE_DEBUG'] ? :debug : :info
     end
 
     # @return [Chromate::CLogger]

data/lib/chromate/client.rb

@@ -2,6 +2,7 @@
 
 require 'websocket-client-simple'
 require 'chromate/helpers'
+require 'chromate/exceptions'
 
 module Chromate
   class Client
@@ -117,16 +118,32 @@ module Chromate
 
     # @return [String]
     def fetch_websocket_debug_url
-      uri = URI("http://localhost:#{@port}/json/list")
-      response = Net::HTTP.get(uri)
-      targets = JSON.parse(response)
+      retries = 0
+      max_retries = 5
+      base_delay = 0.5
 
-      page_target = targets.find { |target| target['type'] == 'page' }
+      begin
+        uri = URI("http://localhost:#{@port}/json/list")
+        response = Net::HTTP.get(uri)
+        targets = JSON.parse(response)
+
+        page_target = targets.find { |target| target['type'] == 'page' }
+        websocket_url = if page_target
+                          page_target['webSocketDebuggerUrl']
+                        else
+                          create_new_page_target
+                        end
+        raise Exceptions::DebugURLError, 'Can\'t get WebSocket URL' if websocket_url.nil?
+
+        websocket_url
+      rescue StandardError => e
+        retries += 1
+        raise Exceptions::ConnectionTimeoutError, "Can't get WebSocket URL after #{max_retries} retries" if retries >= max_retries
 
-      if page_target
-        page_target['webSocketDebuggerUrl']
-      else
-        create_new_page_target
+        delay = base_delay * (2**retries) # Exponential delay: 0.5s, 1s, 2s, 4s, 8s
+        Chromate::CLogger.log("Attempting to reconnect in #{delay} seconds, #{e.message}", level: :debug)
+        sleep delay
+        retry
       end
     end
 

data/lib/chromate/configuration.rb

@@ -17,7 +17,6 @@ module Chromate
       '--no-sandbox', # Required for chrome devtools to work
       '--test-type', # Remove the not allowed message for --no-sandbox flag
       '--disable-dev-shm-usage', # Disable /dev/shm usage
-      '--disable-gpu', # Disable the GPU
       '--disable-popup-blocking', # Disable popup blocking
       '--ignore-certificate-errors', # Ignore certificate errors
       '--window-size=1920,1080', # TODO: Make this automatic
@@ -48,7 +47,8 @@ module Chromate
     ].freeze
 
     attr_accessor :user_data_dir, :headless, :xfvb, :native_control, :startup_patch,
-                  :args, :headless_args, :xfvb_args, :exclude_switches, :proxy, :disable_features
+                  :args, :headless_args, :xfvb_args, :exclude_switches, :proxy, :disable_features,
+                  :mouse_controller, :keyboard_controller
 
     def initialize
       @user_data_dir      = File.expand_path('~/.config/google-chrome/Default')

data/lib/chromate/element.rb

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
+require 'chromate/elements/tags'
+
 module Chromate
   class Element
+    include Elements::Tags
+
     class NotFoundError < StandardError
       def initialize(selector, root_id)
         super("Element not found with selector: #{selector} under root_id: #{root_id}")
@@ -13,7 +17,7 @@ module Chromate
         super("Unable to resolve element with selector: #{selector}")
       end
     end
-    attr_reader :selector, :client
+    attr_reader :selector, :client, :root_id, :object_id, :node_id
 
     # @param [String] selector
     # @param [Chromate::Client] client
@@ -25,18 +29,18 @@ module Chromate
       @client     = client
       @object_id  = object_id
       @node_id    = node_id
-      @object_id, @node_id = find(selector, root_id) unless @object_id && @node_id
+      @object_id, @node_id = magick_find(selector, root_id) unless @object_id && @node_id
       @root_id = root_id || document['root']['nodeId']
     end
 
     # @return [Chromate::Hardwares::MouseController]
     def mouse
-      @mouse ||= Hardwares.mouse(client: client, element: self)
+      Chromate.configuration.mouse_controller.set_element(self)
     end
 
     # @return [Chromate::Hardwares::KeyboardController]
     def keyboard
-      @keyboard ||= Hardwares.keyboard(client: client, element: self)
+      Chromate.configuration.keyboard_controller.set_element(self)
     end
 
     # @return [String]
@@ -47,8 +51,12 @@ module Chromate
 
     # @return [String]
     def text
-      result = client.send_message('Runtime.callFunctionOn', functionDeclaration: 'function() { return this.innerText; }', objectId: @object_id)
-      result['result']['value']
+      evaluate_script('function() { return this.innerText; }')
+    end
+
+    # @return [String]
+    def value
+      evaluate_script('function() { return this.value; }')
     end
 
     # @return [String]
@@ -63,6 +71,11 @@ module Chromate
       Hash[*result['attributes']]
     end
 
+    # @return [String]
+    def tag_name
+      evaluate_script('function() { return this.tagName.toLowerCase(); }')
+    end
+
     # @param [String] name
     # @param [String] value
     # @return [self]
@@ -196,6 +209,19 @@ module Chromate
       end
     end
 
+    # @param [String] script
+    # @return [String]
+    def evaluate_script(script, options = {})
+      result = client.send_message(
+        'Runtime.callFunctionOn',
+        functionDeclaration: script,
+        objectId: @object_id,
+        returnByValue: true,
+        **options
+      )
+      result['result']['value']
+    end
+
     private
 
     # @param [String] event
@@ -216,10 +242,39 @@ module Chromate
       [node_info['object']['objectId'], result['nodeId']]
     end
 
+    # @param [String] selector
+    # @option [Integer] root_id
+    # @return [Chromate::Element, nil]
+    def magick_find(selector, root_id = nil)
+      find(selector, root_id)
+    rescue NotFoundError, InvalidSelectorError
+      el = find_in_shadow_recursively(selector)
+      raise NotFoundError.new(selector, @root_id) unless el
+
+      el
+    end
+
+    # @param [String] selector
+    # @return [Chromate::Element, nil]
+    def find_in_shadow_recursively(selector)
+      shadow_children = find_shadow_children('*')
+      shadow_children.each do |child|
+        found_element = child.find_element(selector) || child.find_in_shadow_recursively(selector)
+        return found_element if found_element
+      end
+
+      nil
+    end
+
+    # @return [Hash]
     def document
       @document ||= client.send_message('DOM.getDocument')
     end
 
+    # Allows to submit the parent form of the element
+    # can be used to submit a form
+    #
+    # @return [void]
     def submit_parent_form
       script = <<~JAVASCRIPT
         function() {
@@ -236,9 +291,7 @@ module Chromate
         }
       JAVASCRIPT
 
-      client.send_message('Runtime.callFunctionOn',
-                          functionDeclaration: script,
-                          objectId: @object_id)
+      evaluate_script(script)
     end
   end
 end

data/lib/chromate/elements/checkbox.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'chromate/element'
+
+module Chromate
+  module Elements
+    class Checkbox < Element
+      def initialize(selector, client, **options)
+        super
+        raise InvalidSelectorError, selector unless checkbox?
+      end
+
+      # @return [Boolean]
+      def checked?
+        attributes['checked'] == 'true'
+      end
+
+      # @return [self]
+      def check
+        click unless checked?
+
+        self
+      end
+
+      # @return [self]
+      def uncheck
+        click if checked?
+
+        self
+      end
+
+      # @return [self]
+      def toggle
+        click
+
+        self
+      end
+    end
+  end
+end

data/lib/chromate/elements/option.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'chromate/element'
+
+module Chromate
+  module Elements
+    class Option < Element
+      attr_reader :value
+
+      # @param [String] value
+      def initialize(value, client, node_id: nil, object_id: nil, root_id: nil)
+        super("option[value='#{value}']", client, node_id: node_id, object_id: object_id, root_id: root_id)
+
+        @value = value
+      end
+
+      def bounding_box
+        script = <<~JAVASCRIPT
+          function() {
+            const select = this.closest('select');
+            const rect = select.getBoundingClientRect();
+            return {
+              x: rect.x,
+              y: rect.y,
+              width: rect.width,
+              height: rect.height
+            };
+          }
+        JAVASCRIPT
+
+        result = evaluate_script(script)
+        # TODO: fix this
+        # The offset is due to the fact that the option return the wrong coordinates
+        # can be fixed by mesuring an option and use the offset multiply by the index of the option
+        {
+          'content' => [result['x'] + 100, result['y'] + 100],
+          'width' => result['width'],
+          'height' => result['height']
+        }
+      end
+    end
+  end
+end

data/lib/chromate/elements/radio.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'chromate/element'
+
+module Chromate
+  module Elements
+    class Radio < Element
+      def initialize(selector = nil, client = nil, **options)
+        if selector
+          super
+          raise InvalidSelectorError, selector unless radio?
+        else
+          super(**options)
+        end
+      end
+
+      # @return [Boolean]
+      def checked?
+        attributes['checked'] == 'true'
+      end
+
+      # @return [self]
+      def check
+        click unless checked?
+
+        self
+      end
+
+      # @return [self]
+      def uncheck
+        click if checked?
+
+        self
+      end
+    end
+  end
+end

data/lib/chromate/elements/select.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'chromate/element'
+require 'chromate/elements/option'
 
 module Chromate
   module Elements
@@ -8,39 +9,30 @@ module Chromate
       # @param [String] value
       # @return [self]
       def select_option(value)
-        script = javascript
+        click
 
-        client.send_message('Runtime.callFunctionOn',
-                            functionDeclaration: script,
-                            objectId: @object_id,
-                            arguments: [{ value: value }])
+        evaluate_script(javascript, arguments: [{ value: value }]) unless Chromate.configuration.native_control
 
-        self
-      rescue StandardError => e
-        raise ArgumentError, "Option '#{value}' not found in select" if e.message.include?('Option')
+        Option.new(value, client).click
 
-        raise e
+        self
       end
 
       # @return [String|nil]
       def selected_value
-        result = client.send_message('Runtime.callFunctionOn',
-                                     functionDeclaration: 'function() { return this.value; }',
-                                     objectId: @object_id)
-        result.dig('result', 'value')
+        evaluate_script('function() { return this.value; }')
       end
 
       # @return [String|nil]
       def selected_text
-        result = client.send_message('Runtime.callFunctionOn',
-                                     functionDeclaration: 'function() {
+        evaluate_script('function() {
             const option = this.options[this.selectedIndex];
             return option ? option.textContent.trim() : null;
-          }',
-                                     objectId: @object_id)
-        result.dig('result', 'value')
+          }')
       end
 
+      private
+
       # @return [String]
       def javascript
         <<~JAVASCRIPT

data/lib/chromate/elements/tags.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'chromate/element'
+
+module Chromate
+  module Elements
+    module Tags
+      def select?
+        tag_name == 'select'
+      end
+
+      def option?
+        tag_name == 'option'
+      end
+
+      def radio?
+        tag_name == 'input' && attributes['type'] == 'radio'
+      end
+
+      def checkbox?
+        tag_name == 'input' && attributes['type'] == 'checkbox'
+      end
+
+      def base?
+        !select? && !option? && !radio? && !checkbox?
+      end
+    end
+  end
+end

data/lib/chromate/exceptions.rb

@@ -5,5 +5,7 @@ module Chromate
     class ChromateError < StandardError; end
     class InvalidBrowserError < ChromateError; end
     class InvalidPlatformError < ChromateError; end
+    class ConnectionTimeoutError < StandardError; end
+    class DebugURLError < StandardError; end
   end
 end

data/lib/chromate/files/agents.json

@@ -0,0 +1,11 @@
+{
+  "windows": [
+    "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36"
+  ],
+  "mac": [
+    "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36"
+  ],
+  "linux": [
+    "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36"
+  ]
+}