puppeteer-ruby 0.44.2 → 0.44.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 122e93a49a21ba31268f981920fb45ddf3bbc4e5b5e37705337c7f0fcfb416d8
-  data.tar.gz: '0940d06d294a8a069d23fd02dee7a1f00b99a3a0c787b4520d8854be0103f1cf'
+  metadata.gz: 9e3ce791016a5018ed76902a9baa63110032fb28681b52d6beeb2e0b629ec0b1
+  data.tar.gz: d449886d836e7b2d65e6764e8a73745b53117bc01437a05699efbff911d92dbc
 SHA512:
-  metadata.gz: 8253f32cb5b92f3413ba88e5179494f76b7e3c6b7a7b58e1544691586ae771ded9992cb9404f94998e72a958e6da7fbb21df4eb00e04c7446a875b0ce4cb005f
-  data.tar.gz: 07114ec059413a71c444e467cc61a35428c5091a1cc015b1b33447f1bfae0c543fc419a36020824e40a3ad7d8e79438c7a69770a850578eea1c8e6f3ab6b4aa3
+  metadata.gz: 74fce38ce98fffd7a47273e34d6d1b66a8e171656255fe431caf9d78c33fde9c6fc81316253091681521afed796b11a374d123edde4934253a892b9a69947666
+  data.tar.gz: 5fa58e64d918f1ff5d59de1c57cbb0a04728e9c9866a0376c8c0bc2d2729277391a631dbfb3a56cc25b7c43f00ac7208e478c5b66bd1d35afb28c32428569d18

data/CHANGELOG.md

@@ -1,6 +1,10 @@
-### main [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.44.2...main)]
+### main [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.44.3...main)]
 
-- xxx
+### 0.44.3 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.44.2...0.44.3)]
+
+Bugfix
+
+- Revive Firefox automation :tada:
 
 ### 0.44.2 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.44.1...0.44.2)]
 

data/docs/api_coverage.md

@@ -1,6 +1,6 @@
 # API coverages
 - Puppeteer version: v17.1.3
-- puppeteer-ruby version: 0.44.2
+- puppeteer-ruby version: 0.44.3
 
 ## Puppeteer
 

data/lib/puppeteer/element_handle.rb

@@ -159,8 +159,31 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     begin
       @remote_object.scroll_into_view_if_needed(@client)
     rescue => err
-      # Just ignore 'Node does not have a layout object' for backward-compatibility.
-      raise unless err.message =~ /Node does not have a layout object/
+      # Fallback to Element.scrollIntoView if DOM.scrollIntoViewIfNeeded is not supported
+      js = <<~JAVASCRIPT
+        async (element, pageJavascriptEnabled) => {
+          const visibleRatio = async () => {
+            return await new Promise(resolve => {
+              const observer = new IntersectionObserver(entries => {
+                resolve(entries[0].intersectionRatio);
+                observer.disconnect();
+              });
+              observer.observe(element);
+            });
+          };
+          if (!pageJavascriptEnabled || (await visibleRatio()) !== 1.0) {
+            element.scrollIntoView({
+              block: 'center',
+              inline: 'center',
+              // @ts-expect-error Chrome still supports behavior: instant but
+              // it's not in the spec so TS shouts We don't want to make this
+              // breaking change in Puppeteer yet so we'll ignore the line.
+              behavior: 'instant',
+            });
+          }
+        }
+      JAVASCRIPT
+      evaluate(js, page.javascript_enabled?)
     end
 
     # clickpoint is often calculated before scrolling is completed.

data/lib/puppeteer/execution_context.rb

@@ -118,12 +118,12 @@ class Puppeteer::ExecutionContext
       ) # .catch(rewriteError);
 
       exception_details = result['exceptionDetails']
-      remote_object = Puppeteer::RemoteObject.new(result['result'])
-
       if exception_details
         raise EvaluationError.new("Evaluation failed: #{exception_details}")
       end
 
+      remote_object = Puppeteer::RemoteObject.new(result['result'])
+
       if @return_by_value
         remote_object.value
       else

data/lib/puppeteer/firefox_target_manager.rb

@@ -66,9 +66,8 @@ class Puppeteer::FirefoxTargetManager
   end
 
   private def remove_session_listeners(session)
-    return unless @attachment_listener_ids
-    listener_ids = @attachment_listener_ids.delete(session)
-    return if listener_ids.empty?
+    listener_ids = @attachment_listener_ids&.delete(session)
+    return if !listener_ids || listener_ids.empty?
     session.remove_event_listener(*listener_ids)
   end
 

data/lib/puppeteer/frame.rb

@@ -310,7 +310,7 @@ class Puppeteer::Frame
 
     # Ensure loaderId updated.
     # The order of [Page.lifecycleEvent name="init"] and [Page.frameNavigated] is random... for some reason...
-    @loader_id = frame_payload['loaderId']
+    @loader_id = frame_payload['loaderId'] if frame_payload['loaderId']
   end
 
   # @param url [String]

data/lib/puppeteer/isolated_world.rb

@@ -57,7 +57,7 @@ class Puppeteer::IsolaatedWorld
     @frame = frame
     @timeout_settings = timeout_settings
     @context_promise = resolvable_future
-    @wait_tasks = Set.new
+    @task_manager = Puppeteer::TaskManager.new
     @bound_functions = {}
     @ctx_bindings = Set.new
     @detached = false
@@ -65,12 +65,7 @@ class Puppeteer::IsolaatedWorld
     @client.on_event('Runtime.bindingCalled', &method(:handle_binding_called))
   end
 
-  attr_reader :frame
-
-  # only used in Puppeteer::WaitTask#initialize
-  private def _wait_tasks
-    @wait_tasks
-  end
+  attr_reader :frame, :task_manager
 
   # only used in Puppeteer::WaitTask#initialize
   private def _bound_functions
@@ -84,7 +79,7 @@ class Puppeteer::IsolaatedWorld
       unless @context_promise.resolved?
         @context_promise.fulfill(context)
       end
-      @wait_tasks.each(&:async_rerun)
+      @task_manager.async_rerun_all
     else
       raise ArgumentError.new("context should now be nil. Use #delete_context for clearing document.")
     end
@@ -101,9 +96,7 @@ class Puppeteer::IsolaatedWorld
 
   def detach
     @detached = true
-    @wait_tasks.each do |wait_task|
-      wait_task.terminate(Puppeteer::WaitTask::TerminatedError.new('waitForFunction failed: frame got detached.'))
-    end
+    @task_manager.terminate_all(Puppeteer::WaitTask::TerminatedError.new('waitForFunction failed: frame got detached.'))
   end
 
   class DetachedError < StandardError; end

data/lib/puppeteer/launcher/firefox.rb

@@ -324,6 +324,11 @@ module Puppeteer::Launcher
         # Make sure opening about:addons will not hit the network
         'extensions.webservice.discoverURL': "http://#{server}/dummy/discoveryURL",
 
+        # Temporarily force disable BFCache in parent (https://bit.ly/bug-1732263)
+        'fission.bfcacheInParent': false,
+        # Force all web content to use a single content process
+        'fission.webContentIsolationStrategy': 0,
+
         # Allow the application to have focus even it runs in the background
         'focusmanager.testmode': true,
         # Disable useragent updates

data/lib/puppeteer/page/screenshot_options.rb

@@ -105,15 +105,10 @@ class Puppeteer::Page
         else
           options[:capture_beyond_viewport]
         end
-      @from_surface =
-        if options[:from_surface].nil?
-          true
-        else
-          options[:from_surface]
-        end
+      @from_surface = options[:from_surface]
     end
 
-    attr_reader :type, :quality, :path, :clip, :encoding
+    attr_reader :type, :quality, :path, :clip, :encoding, :from_surface
 
     def full_page?
       @full_page
@@ -126,9 +121,5 @@ class Puppeteer::Page
     def capture_beyond_viewport?
       @capture_beyond_viewport
     end
-
-    def from_surface?
-      @from_surface
-    end
   end
 end

data/lib/puppeteer/page.rb

@@ -1104,7 +1104,7 @@ class Puppeteer::Page
       quality: screenshot_options.quality,
       clip: clip,
       captureBeyondViewport: screenshot_options.capture_beyond_viewport?,
-      fromSurface: screenshot_options.from_surface?,
+      fromSurface: screenshot_options.from_surface,
     }.compact
     result = @client.send_message('Page.captureScreenshot', screenshot_params)
     reset_default_background_color if should_set_default_background

data/lib/puppeteer/query_handler_manager.rb

@@ -7,6 +7,7 @@ class Puppeteer::QueryHandlerManager
     @query_handlers ||= {
       aria: Puppeteer::AriaQueryHandler.new,
       xpath: xpath_handler,
+      text: text_query_handler,
     }
   end
 
@@ -51,6 +52,156 @@ class Puppeteer::QueryHandlerManager
     )
   end
 
+  private def text_query_handler
+    text_content_js = <<~JAVASCRIPT
+    const TRIVIAL_VALUE_INPUT_TYPES = new Set(['checkbox', 'image', 'radio']);
+
+    /**
+     * Determines if the node has a non-trivial value property.
+     */
+    const isNonTrivialValueNode = (node) => {
+      if (node instanceof HTMLSelectElement) {
+        return true;
+      }
+      if (node instanceof HTMLTextAreaElement) {
+        return true;
+      }
+      if (
+        node instanceof HTMLInputElement &&
+        !TRIVIAL_VALUE_INPUT_TYPES.has(node.type)
+      ) {
+        return true;
+      }
+      return false;
+    };
+
+    const UNSUITABLE_NODE_NAMES = new Set(['SCRIPT', 'STYLE']);
+
+    /**
+    * Determines whether a given node is suitable for text matching.
+    */
+    const isSuitableNodeForTextMatching = (node) => {
+      return (
+        !UNSUITABLE_NODE_NAMES.has(node.nodeName) && !document.head?.contains(node)
+      );
+    };
+
+    /**
+    * Maps {@link Node}s to their computed {@link TextContent}.
+    */
+    const textContentCache = new Map();
+
+    /**
+    * Builds the text content of a node using some custom logic.
+    *
+    * @remarks
+    * The primary reason this function exists is due to {@link ShadowRoot}s not having
+    * text content.
+    *
+    * @internal
+    */
+    const createTextContent = (root) => {
+      let value = textContentCache.get(root);
+      if (value) {
+        return value;
+      }
+      value = {full: '', immediate: []};
+      if (!isSuitableNodeForTextMatching(root)) {
+        return value;
+      }
+      let currentImmediate = '';
+      if (isNonTrivialValueNode(root)) {
+        value.full = root.value;
+        value.immediate.push(root.value);
+      } else {
+        for (let child = root.firstChild; child; child = child.nextSibling) {
+          if (child.nodeType === Node.TEXT_NODE) {
+            value.full += child.nodeValue ?? '';
+            currentImmediate += child.nodeValue ?? '';
+            continue;
+          }
+          if (currentImmediate) {
+            value.immediate.push(currentImmediate);
+          }
+          currentImmediate = '';
+          if (child.nodeType === Node.ELEMENT_NODE) {
+            value.full += createTextContent(child).full;
+          }
+        }
+        if (currentImmediate) {
+          value.immediate.push(currentImmediate);
+        }
+        if (root instanceof Element && root.shadowRoot) {
+          value.full += createTextContent(root.shadowRoot).full;
+        }
+      }
+      textContentCache.set(root, value);
+      return value;
+    };
+    JAVASCRIPT
+
+    @text_query_handler ||= Puppeteer::CustomQueryHandler.new(
+      query_one: <<~JAVASCRIPT,
+      (element, selector) => {
+        #{text_content_js}
+
+        const search = (root) => {
+          for (const node of root.childNodes) {
+            if (node instanceof Element) {
+              let matchedNode;
+              if (node.shadowRoot) {
+                matchedNode = search(node.shadowRoot);
+              } else {
+                matchedNode = search(node);
+              }
+              if (matchedNode) {
+                return matchedNode;
+              }
+            }
+          }
+          const textContent = createTextContent(root);
+          if (textContent.full.includes(selector)) {
+            return root;
+          }
+          return null;
+        };
+        return search(element);
+      }
+      JAVASCRIPT
+
+      query_all: <<~JAVASCRIPT,
+      (element, selector) => {
+        #{text_content_js}
+
+        const search = (root) => {
+          let results = [];
+          for (const node of root.childNodes) {
+            if (node instanceof Element) {
+              let matchedNodes;
+              if (node.shadowRoot) {
+                matchedNodes = search(node.shadowRoot);
+              } else {
+                matchedNodes = search(node);
+              }
+              results = results.concat(matchedNodes);
+            }
+          }
+          if (results.length > 0) {
+            return results;
+          }
+
+          const textContent = createTextContent(root);
+          if (textContent.full.includes(selector)) {
+            return [root];
+          }
+          return [];
+        };
+        return search(element);
+      }
+      JAVASCRIPT
+    )
+  end
+
   class Result
     def initialize(query_handler:, selector:)
       @query_handler = query_handler

data/lib/puppeteer/task_manager.rb

@@ -0,0 +1,24 @@
+class Puppeteer::TaskManager
+  def initialize
+    @tasks = Set.new
+  end
+
+  def add(task)
+    @tasks << task
+  end
+
+  def delete(task)
+    @tasks.delete(task)
+  end
+
+  def terminate_all(error)
+    @tasks.each do |task|
+      task.terminate(error)
+    end
+    @tasks.clear
+  end
+
+  def async_rerun_all
+    Concurrent::Promises.zip(*@tasks.map(&:async_rerun))
+  end
+end

data/lib/puppeteer/version.rb

@@ -1,3 +1,3 @@
 module Puppeteer
-  VERSION = '0.44.2'
+  VERSION = '0.44.3'
 end

data/lib/puppeteer/wait_task.rb

@@ -30,7 +30,7 @@ class Puppeteer::WaitTask
     @args = args
     @binding_function = binding_function
     @run_count = 0
-    @dom_world.send(:_wait_tasks).add(self)
+    @dom_world.task_manager.add(self)
     if binding_function
       @dom_world.send(:_bound_functions)[binding_function.name] = binding_function
     end
@@ -117,10 +117,10 @@ class Puppeteer::WaitTask
 
   private def cleanup
     @timeout_cleared = true
-    @dom_world.send(:_wait_tasks).delete(self)
+    @dom_world.task_manager.delete(self)
   end
 
-  private define_async_method :async_rerun
+  define_async_method :async_rerun
 
   WAIT_FOR_PREDICATE_PAGE_FUNCTION = <<~JAVASCRIPT
   async function _(root, predicateBody, polling, timeout, ...args) {

data/lib/puppeteer.rb

@@ -58,6 +58,7 @@ require 'puppeteer/puppeteer'
 require 'puppeteer/query_handler_manager'
 require 'puppeteer/remote_object'
 require 'puppeteer/target'
+require 'puppeteer/task_manager'
 require 'puppeteer/tracing'
 require 'puppeteer/timeout_helper'
 require 'puppeteer/timeout_settings'

data/puppeteer-ruby.gemspec

@@ -24,15 +24,15 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'concurrent-ruby', '~> 1.1.0'
   spec.add_dependency 'websocket-driver', '>= 0.6.0'
   spec.add_dependency 'mime-types', '>= 3.0'
-  spec.add_development_dependency 'bundler', '~> 2.3.4'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'chunky_png'
   spec.add_development_dependency 'dry-inflector'
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rake', '~> 13.0.3'
   spec.add_development_dependency 'rollbar'
-  spec.add_development_dependency 'rspec', '~> 3.11.0'
+  spec.add_development_dependency 'rspec', '~> 3.12.0'
   spec.add_development_dependency 'rspec_junit_formatter' # for CircleCI.
-  spec.add_development_dependency 'rubocop', '~> 1.36.0'
+  spec.add_development_dependency 'rubocop', '~> 1.42.0'
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'sinatra'
   spec.add_development_dependency 'webrick'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppeteer-ruby
 version: !ruby/object:Gem::Version
-  version: 0.44.2
+  version: 0.44.3
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-06 00:00:00.000000000 Z
+date: 2023-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -56,16 +56,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.4
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.4
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: chunky_png
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: 3.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: 3.12.0
 - !ruby/object:Gem::Dependency
   name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.36.0
+        version: 1.42.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.36.0
+        version: 1.42.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -321,6 +321,7 @@ files:
 - lib/puppeteer/query_handler_manager.rb
 - lib/puppeteer/remote_object.rb
 - lib/puppeteer/target.rb
+- lib/puppeteer/task_manager.rb
 - lib/puppeteer/timeout_helper.rb
 - lib/puppeteer/timeout_settings.rb
 - lib/puppeteer/touch_screen.rb
@@ -350,7 +351,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: A ruby port of puppeteer