apparition 0.0.1

data/lib/capybara/apparition/errors.rb

@@ -0,0 +1,230 @@
+# frozen_string_literal: true
+
+module Capybara
+  module Apparition
+    class Error < StandardError; end
+    class NoSuchWindowError < Error; end
+
+    class ClientError < Error
+      attr_reader :response
+
+      def initialize(response)
+        @response = response
+      end
+    end
+
+    class CDPError < Error
+      attr_reader :message, :code
+
+      def initialize(error)
+        @message = error['message']
+        @code = error['code']
+      end
+    end
+
+    class JSErrorItem
+      attr_reader :message, :stack
+
+      def initialize(message, stack)
+        @message = message
+        @stack   = stack
+      end
+
+      def to_s
+        [message, stack].join("\n")
+      end
+    end
+
+    class BrowserError < ClientError
+      def name
+        response['name']
+      end
+
+      def error_parameters
+        (response['args'] || []).join("\n")
+      end
+
+      def message
+        'There was an error inside the Puppeteer portion of Apparition. ' \
+          'If this is the error returned, and not the cause of a more detailed error response, ' \
+          'this is probably a bug, so please report it. ' \
+          "\n\n#{name}: #{error_parameters}"
+      end
+    end
+
+    class JavascriptError < ClientError
+      # def javascript_errors
+      #   response['args'].first.map { |data| JSErrorItem.new(data['message'], data['stack']) }
+      # end
+      def javascript_errors
+        [response]
+      end
+
+      def message
+        'One or more errors were raised in the Javascript code on the page. ' \
+          "If you don't care about these errors, you can ignore them by " \
+          'setting js_errors: false in your Apparition configuration (see ' \
+          'documentation for details).' \
+          "\n\n#{javascript_errors.map(&:to_s).join("\n")}"
+      end
+    end
+
+    class StatusFailError < ClientError
+      def url
+        response['args'].first
+      end
+
+      def details
+        response['args'][1]
+      end
+
+      def message
+        msg = "Request to '#{url}' failed to reach server, check DNS and/or server status"
+        msg += " - #{details}" if details
+        msg
+      end
+    end
+
+    class FrameNotFound < ClientError
+      def name
+        response['args'].first
+      end
+
+      def message
+        "The frame '#{name}' was not found."
+      end
+    end
+
+    class InvalidSelector < ClientError
+      def method
+        response['args'][0]
+      end
+
+      def selector
+        response['args'][1]
+      end
+
+      def message
+        'The browser raised a syntax error while trying to evaluate ' \
+          "#{method} selector #{selector.inspect}"
+      end
+    end
+
+    class NodeError < ClientError
+      attr_reader :node
+
+      def initialize(node, response)
+        @node = node
+        super(response)
+      end
+    end
+
+    class ObsoleteNode < NodeError
+      def message
+        'The element you are trying to interact with is either not part of the DOM, or is ' \
+          'not currently visible on the page (perhaps display: none is set). ' \
+          "It's possible the element has been replaced by another element and you meant to interact with " \
+          "the new element. If so you need to do a new 'find' in order to get a reference to the " \
+          'new element.'
+      end
+    end
+
+    class WrongWorld < ObsoleteNode
+      def message
+        'The element you are trying to access is not from the current page'
+      end
+    end
+
+    class UnsupportedFeature < ClientError
+      def name
+        response['name']
+      end
+
+      def unsupported_message
+        response['args'][0]
+      end
+
+      def version
+        response['args'][1].values_at('major', 'minor', 'patch').join '.'
+      end
+
+      def message
+        "Running version of Chrome #{version} does not support some feature: #{unsupported_message}"
+      end
+    end
+
+    class MouseEventFailed < NodeError
+      def name
+        response['args'][0]
+      end
+
+      def selector
+        response['args'][1]
+      end
+
+      def position
+        [response['args'][2][:x], response['args'][2][:y]]
+      end
+
+      def message
+        "Firing a #{name} at co-ordinates [#{position.join(', ')}] failed. Apparition detected " \
+          "another element with CSS selector '#{selector}' at this position. " \
+          'It may be overlapping the element you are trying to interact with. '
+      end
+    end
+
+    class MouseEventImpossible < MouseEventFailed
+      def name
+        response['args'][0]
+      end
+
+      def selector
+        nil
+      end
+
+      def position
+        nil
+      end
+
+      def message
+        "Firing a #{name} event is not possible since the element has no visible position on the page."
+      end
+    end
+
+    class KeyError < ::ArgumentError
+      def initialize(key)
+        super(key)
+      end
+    end
+
+    class TimeoutError < Error
+      def initialize(message = nil)
+        @message = message
+      end
+
+      def message
+        "Timed out waiting for response to #{@message}. It's possible that this happened " \
+          'because something took a very long time (for example a page load was slow). ' \
+          'If so, setting the Apparition :timeout option to a higher value will help ' \
+          '(see the docs for details). If increasing the timeout does not help, this is ' \
+          'probably a bug in Apparition - please report it to the issue tracker.'
+      end
+    end
+
+    class ScriptTimeoutError < Error
+      def message
+        'Timed out waiting for evaluated script to resturn a value'
+      end
+    end
+
+    class DeadClient < Error
+      def initialize(message)
+        @message = message
+      end
+
+      def message
+        "Chrome client died while processing #{@message}"
+      end
+    end
+  end
+end

data/lib/capybara/apparition/frame.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Capybara::Apparition
+  class Frame
+    attr_reader :id, :parent_id
+    attr_accessor :element_id
+
+    def initialize(page, params)
+      @page = page
+      @id = params[:frameId] || params['frameId'] || params['id']
+      @parent_id = params['parentFrameId'] || params['parentId']
+      @context_id = nil
+      @state = nil
+      @element_id = nil
+      @frame_mutex = Mutex.new
+      @loader_id = @prev_loader_id = nil
+    end
+
+    def context_id
+      @frame_mutex.synchronize do
+        @context_id
+      end
+    end
+
+    def context_id=(id)
+      @frame_mutex.synchronize do
+        @context_id = id
+      end
+    end
+
+    def state=(state)
+      @frame_mutex.synchronize do
+        @state = state
+      end
+    end
+
+    def state
+      @frame_mutex.synchronize do
+        @state
+      end
+    end
+
+    def loader_id
+      @frame_mutex.synchronize do
+        @loader_id
+      end
+    end
+
+    def loading(id)
+      self.loader_id = id
+    end
+
+    def reloading!
+      self.loader_id = @prev_loader_id
+    end
+
+    def loading?
+      !@loader_id.nil?
+    end
+
+    def loaded?
+      @loader_id.nil?
+    end
+
+    def loaded!
+      @prev_loader_id = loader_id
+      self.loader_id = nil
+    end
+
+    def obsolete!
+      self.state = :obsolete
+    end
+
+    def obsolete?
+      state == :obsolete
+    end
+
+    def usable?
+      context_id && !loading?
+    end
+
+  private
+
+    def loader_id=(id)
+      @frame_mutex.synchronize do
+        @loader_id = id
+      end
+    end
+  end
+end

data/lib/capybara/apparition/frame_manager.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'capybara/apparition/frame'
+
+module Capybara::Apparition
+  class FrameManager
+    def initialize(id)
+      @frames = {}
+      @frames_mutex = Mutex.new
+      add(id)
+      @main_id = @current_id = id
+    end
+
+    def main
+      get(@main_id)
+    end
+
+    def current
+      get(@current_id)
+    end
+
+    def pop_frame(top:)
+      @current_id = if top
+        @main_id
+      else
+        get(@current_id).parent_id
+      end
+      cleanup_unused_obsolete
+    end
+
+    def push_frame(id)
+      @current_id = id
+    end
+
+    def add(id, frame_params = {})
+      @frames_mutex.synchronize do
+        @frames[id] = Frame.new(nil, frame_params.merge(frameId: id))
+      end
+    end
+
+    def get(id)
+      @frames_mutex.synchronize do
+        @frames[id]
+      end
+    end
+
+    def delete(id)
+      @frames_mutex.synchronize do
+        if @current_id == id
+          @frames[id].obsolete!
+        else
+          @frames.delete(id)
+        end
+      end
+    end
+
+    def exists?(id)
+      @frames_mutex.synchronize do
+        @frames.key?(id)
+      end
+    end
+
+    def destroy_context(ctx_id)
+      @frames_mutex.synchronize do
+        @frames.each_value do |f|
+          f.context_id = nil if f.context_id == ctx_id
+        end
+      end
+    end
+
+  private
+
+    def cleanup_unused_obsolete
+      @frames_mutex.synchronize do
+        @frames.delete_if do |_id, f|
+          f.obsolete? && (f.id != @current_id)
+        end
+      end
+    end
+  end
+end

data/lib/capybara/apparition/inspector.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Capybara::Apparition
+  class Inspector
+    # TODO: IS this necessary anymore?
+    BROWSERS     = %w[chromium chromium-browser google-chrome open].freeze
+    DEFAULT_PORT = 9664
+
+    def self.detect_browser
+      @browser ||= BROWSERS.find { |name| browser_binary_exists?(name) }
+    end
+
+    attr_reader :port
+
+    def initialize(browser = nil, port = DEFAULT_PORT)
+      @browser = browser.respond_to?(:to_str) ? browser : nil
+      @port    = port
+    end
+
+    def browser
+      @browser ||= self.class.detect_browser
+    end
+
+    def url(scheme)
+      "#{scheme}://localhost:#{port}/"
+    end
+
+    def open(scheme)
+      if browser
+        Process.spawn(browser, url(scheme))
+      else
+        raise Error, "Could not find a browser executable to open #{url(scheme)}. " \
+                     "You can specify one manually using e.g. `:inspector => 'chromium'` " \
+                     'as a configuration option for Apparition.'
+      end
+    end
+
+    def self.browser_binary_exists?(browser)
+      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts.each do |ext|
+          exe = "#{path}#{File::SEPARATOR}#{browser}#{ext}"
+          return exe if File.executable? exe
+        end
+      end
+      nil
+    end
+  end
+end