apparition 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b51cb57f961f9825c56ce38377bbf4fd5477a5cdad6d75a2dac1aab827b81561
-  data.tar.gz: 29e9b0c81cdcd3be2820a8d9a2719708750d3099f56a6c403c474a77bb254bce
+  metadata.gz: 138fab423026ba9b7e93b02a3dbbd4a4e438dfbf8bcf48500126dc9251dabd0d
+  data.tar.gz: af667994c4bf65674368b6e1e0a7e0a7d29ba4adf2a2d161eeb8dd1b16d98a45
 SHA512:
-  metadata.gz: 95be5f025a29554e4909b5e4500d2694f580b20ee92b9cf555c7fcf2a9bc1962871d95c81730d9800a55d8cc38f99656713f88cd10f0f7bd8e880083819c0edc
-  data.tar.gz: 34c0d53702b1b0be001cd65ebf0bfcb17ab6d3e86505851a23bbe39bd9bd80d4c0cb6d3d95a990804bd3ee123090ebce155892ddadd2ab4484782219ad0535b3
+  metadata.gz: 0e1f58fcdf5b3942bb219462ffd72e9f961747c0334c9fad0103e79cd0ff0dc3318a6c80988f5be0f045a1fc40d7c2695630b458ab79328accc0a3d17996a400
+  data.tar.gz: 4470dcb096886417f7d4b7ddcd0842f5be59d6a574173b3cda69c0878ad27047b9927696b4e7939579fadc90bbddcee6137fa6b91871f1ad7b2c746e3ba73c20

data/README.md

@@ -27,7 +27,7 @@ gem 'apparition'
 or
 
 ``` ruby
-gem apparition', github: 'twalpole/apparition'
+gem 'apparition', github: 'twalpole/apparition'
 ```
 
 to your Gemfile and run `bundle install`.

data/lib/capybara/apparition/browser.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 require 'capybara/apparition/errors'
-require 'capybara/apparition/dev_tools_protocol/target_manager'
 require 'capybara/apparition/page'
 require 'capybara/apparition/console'
+require 'capybara/apparition/dev_tools_protocol/session'
 require 'capybara/apparition/browser/header'
 require 'capybara/apparition/browser/window'
 require 'capybara/apparition/browser/render'
@@ -30,7 +30,7 @@ module Capybara::Apparition
     def initialize(client, logger = nil)
       @client = client
       @current_page_handle = nil
-      @targets = Capybara::Apparition::DevToolsProtocol::TargetManager.new(self)
+      @pages = {}
       @context_id = nil
       @js_errors = true
       @ignore_https_errors = false
@@ -41,11 +41,8 @@ module Capybara::Apparition
       initialize_handlers
 
       command('Target.setDiscoverTargets', discover: true)
-      while @current_page_handle.nil?
-        puts 'waiting for target...'
-        sleep 0.1
-      end
-      @context_id = current_target.context_id
+      yield self if block_given?
+      reset
     end
 
     def restart
@@ -81,34 +78,83 @@ module Capybara::Apparition
     include Auth
 
     def reset
-      current_page_targets = @targets.of_type('page').values
-
       new_context_id = command('Target.createBrowserContext')['browserContextId']
-      new_target_response = client.send_cmd('Target.createTarget', url: 'about:blank', browserContextId: new_context_id)
+      # current_pages = @pages.keys
 
-      current_page_targets.each do |target|
+      new_target_response = client.send_cmd('Target.createTarget', url: 'about:blank', browserContextId: new_context_id)
+      @pages.each do |id, page|
         begin
-          client.send_cmd('Target.disposeBrowserContext', browserContextId: target.context_id).discard_result
+          client.send_cmd('Target.disposeBrowserContext', browserContextId: page.browser_context_id).discard_result
         rescue WrongWorld
           puts 'Unknown browserContextId'
         end
-        @targets.delete(target.id)
+        @pages.delete(id)
       end
 
       new_target_id = new_target_response['targetId']
 
+      session_id = command('Target.attachToTarget', targetId: new_target_id)['sessionId']
+      session = Capybara::Apparition::DevToolsProtocol::Session.new(self, client, session_id)
+
+      @pages[new_target_id] = Page.create(self, session, new_target_id, new_context_id,
+                                          ignore_https_errors: ignore_https_errors,
+                                          js_errors: js_errors, extensions: @extensions,
+                                          url_blacklist: @url_blacklist,
+                                          url_whitelist: @url_whitelist) # .inherit(@info.delete('inherit'))
+      @pages[new_target_id].send(:main_frame).loaded!
+
       timer = Capybara::Helpers.timer(expire_in: 10)
-      until @targets.get(new_target_id)&.page&.usable?
+      until @pages[new_target_id].usable?
         if timer.expired?
           puts 'Timedout waiting for reset'
           raise TimeoutError.new('reset')
         end
         sleep 0.01
       end
+      console.clear
       @current_page_handle = new_target_id
       true
     end
 
+    def refresh_pages(opener:)
+      new_pages = command('Target.getTargets')['targetInfos'].select do |ti|
+        (ti['openerId'] == opener.target_id) && (ti['type'] == 'page') && (ti['attached'] == false)
+      end
+      sessions = new_pages.map do |page|
+        target_id = page['targetId']
+        session_result = client.send_cmd('Target.attachToTarget', targetId: target_id)
+        [target_id, session_result]
+      end
+
+      sessions = sessions.map do |(target_id, session_result)|
+        session = Capybara::Apparition::DevToolsProtocol::Session.new(self, client, session_result.result['sessionId'])
+        [target_id, session]
+      end
+
+      sessions.each do |(_target_id, session)|
+        session.async_commands 'Page.enable', 'Network.enable', 'Runtime.enable', 'Security.enable', 'DOM.enable'
+      end
+
+      # sessions.each do |(target_id, session_result)|
+      #   session = Capybara::Apparition::DevToolsProtocol::Session.new(self, client, session_result.result['sessionId'])
+      sessions.each do |(target_id, session)|
+        page_options = { ignore_https_errors: ignore_https_errors, js_errors: js_errors,
+                         url_blacklist: @url_blacklist, url_whitelist: @url_whitelist }
+        new_page = Page.create(self, session, target_id, opener.browser_context_id, page_options).inherit(opener)
+        @pages[target_id] = new_page
+      end
+
+      # new_pages.each do |page|
+      #   target_id = page['targetId']
+      #   session_id = command('Target.attachToTarget', targetId: target_id)['sessionId']
+      #   session = Capybara::Apparition::DevToolsProtocol::Session.new(self, client, session_id)
+      #   page_options = { ignore_https_errors: ignore_https_errors, js_errors: js_errors,
+      #                  url_blacklist: @url_blacklist, url_whitelist: @url_whitelist }
+      #   new_page = Page.create(self, session, page['targetId'], opener.browser_context_id, page_options).inherit(opener)
+      #   @pages[target_id] = new_page
+      # end
+    end
+
     def resize(width, height, screen: nil)
       current_page.set_viewport width: width, height: height, screen: screen
     end
@@ -127,20 +173,22 @@ module Capybara::Apparition
     def extensions=(filenames)
       @extensions = filenames
       Array(filenames).each do |name|
-        begin
-          current_page.command('Page.addScriptToEvaluateOnNewDocument', source: File.read(name))
-        rescue Errno::ENOENT
-          raise ::Capybara::Apparition::BrowserError.new('name' => "Unable to load extension: #{name}", 'args' => nil)
-        end
+        current_page(allow_nil: true)&.add_extension(name)
       end
     end
 
     def url_whitelist=(whitelist)
-      current_page&.url_whitelist = whitelist
+      @url_whitelist = whitelist
+      @pages.each do |_id, page|
+        page.url_whitelist = whitelist
+      end
     end
 
     def url_blacklist=(blacklist)
-      current_page&.url_blacklist = blacklist
+      @url_blacklist = blacklist
+      @pages.each do |_id, page|
+        page.url_blacklist = blacklist
+      end
     end
 
     attr_writer :debug
@@ -166,8 +214,14 @@ module Capybara::Apparition
       raise
     end
 
-    def current_page
-      current_target.page
+    def current_page(allow_nil: false)
+      @pages[@current_page_handle] || begin
+        puts "No current page: #{@current_page_handle} : #{caller}" if ENV['DEBUG']
+        @current_page_handle = nil
+        raise NoSuchWindowError unless allow_nil
+
+        @current_page_handle
+      end
     end
 
     def console_messages(type = nil)
@@ -176,15 +230,6 @@ module Capybara::Apparition
 
   private
 
-    def current_target
-      @targets.get(@current_page_handle) || begin
-        puts "No current page: #{@current_page_handle}"
-        puts caller
-        @current_page_handle = nil
-        raise NoSuchWindowError
-      end
-    end
-
     def log(message)
       @logger&.puts message if ENV['DEBUG']
     end
@@ -256,35 +301,36 @@ module Capybara::Apparition
     # end
 
     def initialize_handlers
-      @client.on 'Target.targetCreated' do |info|
-        puts "Target Created Info: #{info}" if ENV['DEBUG']
-        target_info = info['targetInfo']
-        if !@targets.target?(target_info['targetId'])
-          # @targets.add(target_info['targetId'], DevToolsProtocol::Target.new(self, target_info))
-          @targets.add(target_info['targetId'], target_info)
-          puts "**** Target Added #{info}" if ENV['DEBUG']
-        elsif ENV['DEBUG']
-          puts "Target already existed #{info}"
-        end
-        @current_page_handle ||= target_info['targetId'] if target_info['type'] == 'page'
-      end
+      # @client.on 'Target.targetCreated' do |info|
+      #   byebug
+      #   puts "Target Created Info: #{info}" if ENV['DEBUG']
+      #   target_info = info['targetInfo']
+      #   if !@pages.key?(target_info['targetId'])
+      #     @pages.add(target_info['targetId'], target_info)
+      #     puts "**** Target Added #{info}" if ENV['DEBUG']
+      #   elsif ENV['DEBUG']
+      #     puts "Target already existed #{info}"
+      #   end
+      #   @current_page_handle ||= target_info['targetId'] if target_info['type'] == 'page'
+      # end
 
       @client.on 'Target.targetDestroyed' do |info|
         puts "**** Target Destroyed Info: #{info}" if ENV['DEBUG']
-        @targets.delete(info['targetId'])
+        @pages.delete(info['targetId'])
       end
 
-      @client.on 'Target.targetInfoChanged' do |info|
-        puts "**** Target Info Changed: #{info}" if ENV['DEBUG']
-        target_info = info['targetInfo']
-        target = @targets.get(target_info['targetId'])
-        if target
-          target.update(target_info)
-        else
-          puts '****No target for the info change- creating****' if ENV['DEBUG']
-          @targets.add(target_info['targetId'], target_info)
-        end
-      end
+      # @client.on 'Target.targetInfoChanged' do |info|
+      #   byebug
+      #   puts "**** Target Info Changed: #{info}" if ENV['DEBUG']
+      #   target_info = info['targetInfo']
+      #   page = @pages[target_info['targetId']]
+      #   if page
+      #     page.update(target_info)
+      #   else
+      #     puts '****No target for the info change- creating****' if ENV['DEBUG']
+      #     @pages.add(target_info['targetId'], target_info)
+      #   end
+      # end
     end
   end
 end

data/lib/capybara/apparition/browser/header.rb

@@ -8,7 +8,7 @@ module Capybara::Apparition
       end
 
       def headers=(headers)
-        @targets.pages.each do |page|
+        @pages.each do |_id, page|
           page.perm_headers = headers.dup
           page.temp_headers = {}
           page.temp_no_redirect_headers = {}
@@ -23,7 +23,7 @@ module Capybara::Apparition
 
       def add_header(header, permanent: true, **_options)
         if permanent == true
-          @targets.pages.each do |page|
+          @pages.each do |_id, page|
             page.perm_headers.merge! header
             page.update_headers
           end

data/lib/capybara/apparition/browser/window.rb

@@ -3,64 +3,64 @@
 module Capybara::Apparition
   class Browser
     module Window
-      def window_handle
+      def current_window_handle
         @current_page_handle
       end
 
       def window_handles
-        @targets.window_handles
+        @pages.keys
       end
 
       def switch_to_window(handle)
-        target = @targets.get(handle)
-        raise NoSuchWindowError unless target&.page
+        page = @pages[handle]
+        unless page
+          page = @pages[find_window_handle(handle)]
+          warn 'Finding window by name, title, or url is deprecated, please use a block/proc ' \
+               'with Session#within_window/Session#switch_to_window instead.'
+        end
+        raise NoSuchWindowError unless page
 
-        target.page.wait_for_loaded
-        @current_page_handle = handle
+        page.wait_for_loaded
+        @current_page_handle = page.target_id
       end
 
       def open_new_window
-        context_id = current_target.context_id
-        info = command('Target.createTarget', url: 'about:blank', browserContextId: context_id)
-        target_id = info['targetId']
-        target = DevToolsProtocol::Target.new(self, info.merge('type' => 'page', 'inherit' => current_page))
-        target.page # Ensure page object construction happens
-        begin
-          puts "Adding #{target_id} - #{target.info}" if ENV['DEBUG']
-          @targets.add(target_id, target)
-        rescue ArgumentError
-          puts 'Target already existed' if ENV['DEBUG']
-        end
+        context_id = current_page.browser_context_id
+        target_id = command('Target.createTarget', url: 'about:blank', browserContextId: context_id)['targetId']
+        session_id = command('Target.attachToTarget', targetId: target_id)['sessionId']
+        session = Capybara::Apparition::DevToolsProtocol::Session.new(self, client, session_id)
+        @pages[target_id] = Page.create(self, session, target_id, context_id,
+                                        ignore_https_errors: ignore_https_errors,
+                                        js_errors: js_errors,
+                                        url_whitelist: @url_whitelist,
+                                        extensions: @extensions,
+                                        url_blacklist: @url_blacklist).inherit(current_page(allow_nil: true))
+        @pages[target_id].send(:main_frame).loaded!
         target_id
       end
 
       def close_window(handle)
         @current_page_handle = nil if @current_page_handle == handle
-        win_target = @targets.delete(handle)
-        warn 'Window was already closed unexpectedly' if win_target.nil?
-        win_target&.close
-      end
+        page = @pages.delete(handle)
 
-      def within_window(locator)
-        original = window_handle
-        handle = find_window_handle(locator)
-        switch_to_window(handle)
-        yield
-      ensure
-        switch_to_window(original)
+        warn 'Window was already closed unexpectedly' unless page
+        command('Target.closeTarget', targetId: handle)
       end
     end
 
   private
 
     def find_window_handle(locator)
+      original = current_window_handle
       return locator if window_handles.include? locator
 
       window_handles.each do |handle|
         switch_to_window(handle)
-        return handle if evaluate('window.name') == locator
+        return handle if evaluate('[window.name, document.title, window.location.href]').include? locator
       end
       raise NoSuchWindowError
+    ensure
+      switch_to_window(original) if original
     end
   end
 end

data/lib/capybara/apparition/configuration.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Capybara::Apparition
+  class Configuration
+    class << self
+    private # rubocop:disable Layout/IndentationWidth
+
+      def instance
+        @instance ||= new
+      end
+    end
+
+    def self.to_hash
+      instance.freeze.to_hash
+    end
+
+    def self.modify
+      raise 'All configuration must take place before the driver starts' if instance.frozen?
+    end
+
+    attr_accessor :allowed_urls
+    attr_writer :block_unknown_urls
+    attr_accessor :blocked_urls
+    attr_accessor :debug
+    attr_writer :ignore_ssl_errors
+    attr_accessor :proxy
+    attr_accessor :stderr
+    attr_accessor :timeout
+    attr_writer :skip_image_loading
+    attr_accessor :raise_javascript_errors
+
+    def initialize
+      @allowed_urls = []
+      @blocked_urls = []
+      @block_unknown_urls = false
+      @debug = false
+      @ignore_ssl_errors = false
+      @proxy = nil
+      @skip_image_loading = false
+      @stderr = $stderr
+      @timeout = -1
+      @raise_javascript_errors = false
+    end
+
+    def allow_url(url)
+      @allowed_urls << url
+    end
+
+    def block_url(url)
+      @blocked_urls << url
+    end
+
+    def block_unknown_urls
+      @block_unknown_urls = true
+    end
+
+    def block_unknown_urls?
+      @block_unknown_urls
+    end
+
+    def allow_unknown_urls
+      allow_url('*')
+    end
+
+    def ignore_ssl_errors
+      @ignore_ssl_errors = true
+    end
+
+    def ignore_ssl_errors?
+      @ignore_ssl_errors
+    end
+
+    def skip_image_loading
+      @skip_image_loading = true
+    end
+
+    def skip_image_loading?
+      @skip_image_loading
+    end
+
+    def use_proxy(proxy)
+      @proxy = proxy
+    end
+
+    def to_hash
+      {
+        url_whitelist: allowed_urls,
+        block_unknown_urls: block_unknown_urls?,
+        url_blacklist: blocked_urls,
+        debug: debug,
+        ignore_ssl_errors: ignore_ssl_errors?,
+        proxy: proxy,
+        skip_image_loading: skip_image_loading?,
+        stderr: stderr,
+        timeout: timeout,
+        js_errors: raise_javascript_errors
+      }
+    end
+  end
+end