Merge remote-tracking branch 'upstream/master' into position

Mifrill · Mifrill · commit 4f26e3c0a1c9 · 2021-02-26T12:00:52.000+05:00
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -1,5 +1,9 @@
 name: Tests
-on: [push]
+on:
+  push:
+    branches:
+      - master
+  pull_request:
 
 jobs:
   tests:
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -0,0 +1,26 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.4
+  NewCops: enable
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Naming/MethodParameterName:
+  AllowedNames:
+    - x
+    - y
+    - id
+    - to
+
+Naming/FileName:
+  Exclude:
+    - 'gemfiles/websocket-driver-*.gemfile'
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
@@ -0,0 +1,61 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-08-25 19:54:53 UTC using RuboCop version 0.89.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 24
+# Configuration parameters: IgnoredMethods.
+Metrics/AbcSize:
+  Max: 66
+
+# Offense count: 5
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 258
+
+# Offense count: 6
+# Configuration parameters: IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Max: 14
+
+# Offense count: 35
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 52
+
+# Offense count: 9
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ModuleLength:
+  Max: 602
+
+# Offense count: 5
+# Configuration parameters: IgnoredMethods.
+Metrics/PerceivedComplexity:
+  Max: 14
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: Keywords.
+# Keywords: TODO, FIXME, OPTIMIZE, HACK, REVIEW
+Style/CommentAnnotation:
+  Exclude:
+    - 'spec/node_spec.rb'
+
+# Offense count: 45
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 7
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: compact, exploded
+Style/RaiseArgs:
+  Exclude:
+    - 'lib/ferrum/browser/client.rb'
+    - 'lib/ferrum/browser/command.rb'
+    - 'lib/ferrum/browser/process.rb'
+    - 'lib/ferrum/browser/xvfb.rb'
+    - 'lib/ferrum/frame/runtime.rb'
diff --git a/README.md b/README.md
@@ -740,6 +740,20 @@ simple value.
 browser.execute(%(1 + 1)) # => true
 ```
 
+#### evaluate_on_new_document(expression)
+
+Evaluate JavaScript to modify things before a page load
+
+* expression `String` should be valid JavaScript
+
+```ruby
+browser.evaluate_on_new_document <<~JS
+  Object.defineProperty(navigator, "languages", {
+    get: function() { return ["tlh"]; }
+  });
+JS
+```
+
 #### add_script_tag(\*\*options) : `Boolean`
 
 * options `Hash`
diff --git a/lib/ferrum/browser.rb b/lib/ferrum/browser.rb
@@ -77,6 +77,10 @@ def extensions
       end
     end
 
+    def evaluate_on_new_document(expression)
+      extensions << expression
+    end
+
     def timeout
       @timeout || DEFAULT_TIMEOUT
     end
diff --git a/lib/ferrum/browser/options/chrome.rb b/lib/ferrum/browser/options/chrome.rb
@@ -36,6 +36,7 @@ class Chrome < Base
           "metrics-recording-only" => nil,
           "safebrowsing-disable-auto-update" => nil,
           "password-store" => "basic",
+          "no-startup-window" => nil,
           # Note: --no-sandbox is not needed if you properly setup a user in the container.
           # https://github.com/ebidel/lighthouse-ci/blob/master/builder/Dockerfile#L35-L40
           # "no-sandbox" => nil,
diff --git a/lib/ferrum/context.rb b/lib/ferrum/context.rb
@@ -72,6 +72,10 @@ def dispose
       @contexts.dispose(@id)
     end
 
+    def has_target?(target_id)
+      @targets.keys.include?(target_id)
+    end
+
     def inspect
       %(#<#{self.class} @id=#{@id.inspect} @targets=#{@targets.inspect} @default_target=#{@default_target.inspect}>)
     end
diff --git a/lib/ferrum/contexts.rb b/lib/ferrum/contexts.rb
@@ -7,7 +7,7 @@ class Contexts
     attr_reader :contexts
 
     def initialize(browser)
-      @contexts = Concurrent::Hash.new
+      @contexts = Concurrent::Map.new
       @browser = browser
       subscribe
       discover
@@ -18,7 +18,9 @@ def default_context
     end
 
     def find_by(target_id:)
-      @contexts.find { |_, c| c.targets.keys.include?(target_id) }&.last
+      context = nil
+      @contexts.each_value { |c| context = c if c.has_target?(target_id) }
+      context
     end
 
     def create
diff --git a/lib/ferrum/frame/runtime.rb b/lib/ferrum/frame/runtime.rb
@@ -118,27 +118,26 @@ def add_style_tag(url: nil, path: nil, content: nil)
       private
 
       def call(expression:, arguments: [], on: nil, wait: 0, handle: true, **options)
-        params = options.dup
         errors = [NodeNotFoundError, NoExecutionContextError]
         attempts, sleep = INTERMITTENT_ATTEMPTS, INTERMITTENT_SLEEP
 
         Ferrum.with_attempts(errors: errors, max: attempts, wait: sleep) do
+          params = options.dup
+
           if on
             response = @page.command("DOM.resolveNode", nodeId: on.node_id)
             object_id = response.dig("object", "objectId")
-            params.merge!(objectId: object_id)
-          elsif params[:executionContextId].nil?
-            params.merge!(executionContextId: execution_id)
-          else
-            # executionContextId is passed, nop
+            params = params.merge(objectId: object_id)
           end
 
-          params.merge!(functionDeclaration: expression,
-                        arguments: prepare_args(arguments))
+          if params[:executionContextId].nil? && params[:objectId].nil?
+            params = params.merge(executionContextId: execution_id)
+          end
 
           response = @page.command("Runtime.callFunctionOn",
                                    wait: wait, slowmoable: true,
-                                   **params)
+                                   **params.merge(functionDeclaration: expression,
+                                                  arguments: prepare_args(arguments)))
           handle_error(response)
           response = response["result"]
 
diff --git a/lib/ferrum/node.rb b/lib/ferrum/node.rb
@@ -30,6 +30,13 @@ def focus
       tap { page.command("DOM.focus", slowmoable: true, nodeId: node_id) }
     end
 
+    def focusable?
+      focus
+      true
+    rescue BrowserError => e
+      e.message == "Element is not focusable" ? false : raise
+    end
+
     def blur
       tap { evaluate("this.blur()") }
     end
diff --git a/lib/ferrum/page/frames.rb b/lib/ferrum/page/frames.rb
@@ -71,12 +71,14 @@ def frames_subscribe
         end
 
         on("Runtime.executionContextCreated") do |params|
+          setting_up_main_frame = false
           context_id = params.dig("context", "id")
           frame_id = params.dig("context", "auxData", "frameId")
 
           unless @main_frame.id
             root_frame = command("Page.getFrameTree").dig("frameTree", "frame", "id")
             if frame_id == root_frame
+              setting_up_main_frame = true
               @main_frame.id = frame_id
               @frames[frame_id] = @main_frame
             end
@@ -85,6 +87,9 @@ def frames_subscribe
           frame = @frames[frame_id] || Frame.new(frame_id, self)
           frame.set_execution_id(context_id)
 
+          # Set event because `execution_id` might raise NoExecutionContextError
+          @event.set if setting_up_main_frame
+
           @frames[frame_id] ||= frame
         end
 
diff --git a/lib/ferrum/version.rb b/lib/ferrum/version.rb
@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ferrum
-  VERSION = "0.9"
+  VERSION = "0.10.2"
 end
diff --git a/spec/browser_spec.rb b/spec/browser_spec.rb
@@ -211,6 +211,24 @@ module Ferrum
           browser&.quit
         end
       end
+
+      it "supports evaluation of JavaScript before page loads" do
+        begin
+          browser = Browser.new(base_url: base_url)
+
+          browser.evaluate_on_new_document <<~JS
+            Object.defineProperty(navigator, "languages", {
+              get: function() { return ["tlh"]; }
+            });
+          JS
+
+          browser.go_to("/ferrum/with_user_js")
+          language = browser.at_xpath("//*[@id='browser-languages']/text()").text
+          expect(language).to eq("tlh")
+        ensure
+          browser&.quit
+        end
+      end
     end
 
     context "javascript errors" do
diff --git a/spec/node_spec.rb b/spec/node_spec.rb
@@ -42,6 +42,43 @@ module Ferrum
       expect { browser.at_xpath("//a[text() = 'JS redirect']") }.not_to raise_error
     end
 
+    it "#at_xpath searches relatively current node" do
+      browser.go_to("/ferrum/with_js")
+
+      p = browser.at_xpath("//p[@id='with_content']")
+
+      expect(p.at_xpath("a").text).to eq("Open for match")
+      expect(p.at_xpath(".//a").text).to eq("Open for match")
+    end
+
+    it "#xpath searches relatively current node" do
+      browser.go_to("/ferrum/with_js")
+
+      p = browser.at_xpath("//p[@id='with_content']")
+      links = p.xpath("a")
+
+      expect(links.size).to eq(1)
+      expect(links.first.text).to eq("Open for match")
+    end
+
+    it "#at_css searches relatively current node" do
+      browser.go_to("/ferrum/with_js")
+
+      p = browser.at_css("p#with_content")
+
+      expect(p.at_css("a").text).to eq("Open for match")
+    end
+
+    it "#css searches relatively current node" do
+      browser.go_to("/ferrum/with_js")
+
+      p = browser.at_xpath("//p[@id='with_content']")
+      links = p.css("a")
+
+      expect(links.size).to eq(1)
+      expect(links.first.text).to eq("Open for match")
+    end
+
     context "when the element is not in the viewport" do
       before do
         browser.go_to("/ferrum/with_js")
@@ -118,5 +155,19 @@ module Ferrum
         expect(el1 == el2).to be false
       end
     end
+
+    describe "#focusable?" do
+      before do
+        browser.go_to("/ferrum/form")
+      end
+
+      context "with hidden input" do
+        it { expect(browser.at_css("#hidden_input").focusable?).to eq(false) }
+      end
+
+      context "with regular input" do
+        it { expect(browser.at_css("#form_name").focusable?).to eq(true) }
+      end
+    end
   end
 end
diff --git a/spec/runtime_spec.rb b/spec/runtime_spec.rb
@@ -2,13 +2,15 @@
 
 module Ferrum
   describe Frame::Runtime do
-    it "supports executing multiple lines of javascript" do
-      browser.execute <<-JS
-        var a = 1
-        var b = 2
-        window.result = a + b
-      JS
-      expect(browser.evaluate("window.result")).to eq(3)
+    context "execute" do
+      it "supports executing multiple lines of javascript" do
+        browser.execute <<-JS
+          var a = 1
+          var b = 2
+          window.result = a + b
+        JS
+        expect(browser.evaluate("window.result")).to eq(3)
+      end
     end
 
     context "evaluate" do
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -66,11 +66,22 @@ def save_exception_aftifacts(browser, meta)
     line_number = meta[:line_number]
     timestamp = "#{time_now.strftime("%Y-%m-%d-%H-%M-%S.")}#{"%03d" % (time_now.usec/1000).to_i}"
 
+    save_exception_log(browser, filename, line_number, timestamp)
+    save_exception_screenshot(browser, filename, line_number, timestamp)
+  end
+
+  def save_exception_screenshot(browser, filename, line_number, timestamp)
     screenshot_name = "screenshot-#{filename}-#{line_number}-#{timestamp}.png"
     screenshot_path = "/tmp/ferrum/#{screenshot_name}"
     browser.screenshot(path: screenshot_path, full: true)
+  rescue => e
+    puts "#{e.class}: #{e.message}"
+  end
 
+  def save_exception_log(browser, filename, line_number, timestamp)
     log_name = "logfile-#{filename}-#{line_number}-#{timestamp}.txt"
     File.open("/tmp/ferrum/#{log_name}", "wb") { |file| file.write(FERRUM_LOGGER.string) }
+  rescue => e
+    puts "#{e.class}: #{e.message}"
   end
 end
diff --git a/spec/support/views/form.erb b/spec/support/views/form.erb
@@ -668,3 +668,7 @@ New line after and before textarea tag
 <p>
   <input id="special" {custom}="abcdef" value="custom attribute"/>
 </p>
+
+<p>
+  <input id="hidden_input" style="display: none"/>
+</p>
diff --git a/spec/support/views/with_user_js.erb b/spec/support/views/with_user_js.erb
