puppeteer-ruby 0.34.3 → 0.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40020c8b6fa98e08295fe19758d81b6bb88c5d828d19b25a567d8f699db90267
-  data.tar.gz: 309d5de2c5a715a531b2909d0ac8408205f95a78204fbdf8f6a619d8630719eb
+  metadata.gz: 7386b90fffcd353eb933d6dcb35d1e7cab9482fa70eaa536bf7bd19bba594edf
+  data.tar.gz: a4bad8a9ab93025fd2864e2a4cd4ff9c6e972156a19898f6cefab84397a9526e
 SHA512:
-  metadata.gz: ed631a2b52c199404eed1559ac2f1d450af94d8139d70b466f2be72f801799f3548bed0ce344e114295f9374edff4323e8970e6b98cba3b7bc3ee384c517cba7
-  data.tar.gz: a8fab38d9172110fe68d3d93034b5d67dec74ea821eee809fd35347ffdbe5d9bb0acb3c197f727feb273ae838c672f2a6d497f8ca580c5afbad10424df72c3ab
+  metadata.gz: d884728c758d4109ac19e72845a36677186b02d723f1be5e5dc5f5e7eb688b7e87ec17d134a1c02818a68273eeb5aaa49759f2b8554a2200ab1ea7a149c9df7a
+  data.tar.gz: 2fb46af25d069bd75411abc56a5787b04ba0d2af000c06a046df2f300b096c191978628ed5d68d12653dd8b61bb2131008da90baaf0a190942caa10daf9f6cdc

data/CHANGELOG.md

@@ -1,7 +1,13 @@
-### master [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.34.3...master)]
+### master [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.35.0...master)]
 
 * xxx
 
+### 0.35.0 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.34.3...0.35.0)]
+
+New features:
+
+* Add `channel` parameter for Puppeteer.launch. Now `channel: chrome` or `channel: chrome-canary` (chrome-beta, chrome-dev is also available) automatically detects the executablePath of Google Chrome. Windows/macOS users can also use `channel: msedge`.
+
 ### 0.34.3 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.34.2...0.34.3)]
 
 Bugfix:

data/docs/api_coverage.md

@@ -1,6 +1,6 @@
 # API coverages
-- Puppeteer version: v10.0.0
-- puppeteer-ruby version: 0.34.3
+- Puppeteer version: v10.1.0
+- puppeteer-ruby version: 0.35.0
 
 ## Puppeteer
 
@@ -78,8 +78,10 @@
 * content
 * cookies
 * coverage
+* createPDFStream => `#create_pdf_stream`
 * deleteCookie => `#delete_cookie`
 * emulate
+* ~~emulateCPUThrottling~~
 * emulateIdleState => `#emulate_idle_state`
 * emulateMediaFeatures => `#emulate_media_features`
 * emulateMediaType => `#emulate_media_type`
@@ -97,6 +99,7 @@
 * goto
 * hover
 * isClosed => `#closed?`
+* ~~isDragInterceptionEnabled~~
 * isJavaScriptEnabled => `#javascript_enabled?`
 * keyboard
 * mainFrame => `#main_frame`
@@ -113,6 +116,7 @@
 * setCookie => `#set_cookie`
 * setDefaultNavigationTimeout => `#default_navigation_timeout=`
 * setDefaultTimeout => `#default_timeout=`
+* ~~setDragInterception~~
 * setExtraHTTPHeaders => `#extra_http_headers=`
 * setGeolocation => `#geolocation=`
 * setJavaScriptEnabled => `#javascript_enabled=`
@@ -162,6 +166,11 @@
 
 * click
 * down
+* ~~drag~~
+* ~~dragAndDrop~~
+* ~~dragEnter~~
+* ~~dragOver~~
+* ~~drop~~
 * move
 * up
 * wheel
@@ -260,8 +269,14 @@
 * boundingBox => `#bounding_box`
 * boxModel => `#box_model`
 * click
+* clickablePoint => `#clickable_point`
 * contentFrame => `#content_frame`
 * dispose
+* ~~drag~~
+* ~~dragAndDrop~~
+* ~~dragEnter~~
+* ~~dragOver~~
+* ~~drop~~
 * evaluate
 * evaluateHandle => `#evaluate_handle`
 * executionContext => `#execution_context`

data/lib/puppeteer/launcher.rb

@@ -1,4 +1,3 @@
-require_relative './launcher/base'
 require_relative './launcher/browser_options'
 require_relative './launcher/chrome'
 require_relative './launcher/chrome_arg_options'

data/lib/puppeteer/launcher/chrome.rb

@@ -2,7 +2,13 @@ require 'tmpdir'
 
 # https://github.com/puppeteer/puppeteer/blob/main/src/node/Launcher.ts
 module Puppeteer::Launcher
-  class Chrome < Base
+  class Chrome
+    def initialize(project_root:, preferred_revision:, is_puppeteer_core:)
+      @project_root = project_root
+      @preferred_revision = preferred_revision
+      @is_puppeteer_core = is_puppeteer_core
+    end
+
     # @param {!(Launcher.LaunchOptions & Launcher.ChromeArgOptions & Launcher.BrowserOptions)=} options
     # @return {!Promise<!Browser>}
     def launch(options = {})
@@ -38,7 +44,12 @@ module Puppeteer::Launcher
         chrome_arguments << "--user-data-dir=#{temporary_user_data_dir}"
       end
 
-      chrome_executable = @launch_options.executable_path || resolve_executable_path
+      chrome_executable =
+        if @launch_options.channel
+          executable_path_for_channel(@launch_options.channel.to_s)
+        else
+          @launch_options.executable_path || executable_path_for_channel('chrome')
+        end
       use_pipe = chrome_arguments.include?('--remote-debugging-pipe')
       runner = Puppeteer::BrowserRunner.new(chrome_executable, chrome_arguments, temporary_user_data_dir)
       runner.start(
@@ -201,8 +212,57 @@ module Puppeteer::Launcher
     end
 
     # @return {string}
-    def executable_path
-      resolve_executable_path
+    def executable_path(channel: nil)
+      if channel
+        executable_path_for_channel(channel.to_s)
+      else
+        executable_path_for_channel('chrome')
+      end
+    end
+
+    CHROMIUM_CHANNELS = {
+      windows: {
+        'chrome' => "#{ENV['PROGRAMFILES']}\\Google\\Chrome\\Application\\chrome.exe",
+        'chrome-beta' => "#{ENV['PROGRAMFILES']}\\Google\\Chrome Beta\\Application\\chrome.exe",
+        'chrome-canary' => "#{ENV['PROGRAMFILES']}\\Google\\Chrome SxS\\Application\\chrome.exe",
+        'chrome-dev' => "#{ENV['PROGRAMFILES']}\\Google\\Chrome Dev\\Application\\chrome.exe",
+        'msedge' => "#{ENV['PROGRAMFILES(X86)']}\\Microsoft\\Edge\\Application\\msedge.exe",
+      },
+      darwin: {
+        'chrome' => '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome',
+        'chrome-beta' => '/Applications/Google Chrome Beta.app/Contents/MacOS/Google Chrome Beta',
+        'chrome-canary' => '/Applications/Google Chrome Canary.app/Contents/MacOS/Google Chrome Canary',
+        'chrome-dev' => '/Applications/Google Chrome Dev.app/Contents/MacOS/Google Chrome Dev',
+        'msedge' => '/Applications/Microsoft Edge.app/Contents/MacOS/Microsoft Edge',
+      },
+      linux: {
+        'chrome' => '/opt/google/chrome/chrome',
+        'chrome-beta' => '/opt/google/chrome-beta/chrome',
+        'chrome-dev' => '/opt/google/chrome-unstable/chrome',
+      },
+    }.freeze
+
+    # @param channel [String]
+    private def executable_path_for_channel(channel)
+      chrome_path_map =
+        if Puppeteer.env.windows?
+          CHROMIUM_CHANNELS[:windows]
+        elsif Puppeteer.env.darwin?
+          CHROMIUM_CHANNELS[:darwin]
+        else
+          CHROMIUM_CHANNELS[:linux]
+        end
+
+      chrome_path = chrome_path_map[channel]
+      unless chrome_path
+        raise ArgumentError.new("Invalid channel: '#{channel}'. Allowed channel is #{chrome_path_map.keys}")
+      end
+
+      unless File.exist?(chrome_path)
+        raise "#{channel} is not installed on this system.\nExpected path: #{chrome_path}"
+      end
+
+      chrome_path
     end
 
     def product

data/lib/puppeteer/launcher/firefox.rb

@@ -2,7 +2,13 @@ require 'tmpdir'
 
 # https://github.com/puppeteer/puppeteer/blob/main/src/node/Launcher.ts
 module Puppeteer::Launcher
-  class Firefox < Base
+  class Firefox
+    def initialize(project_root:, preferred_revision:, is_puppeteer_core:)
+      @project_root = project_root
+      @preferred_revision = preferred_revision
+      @is_puppeteer_core = is_puppeteer_core
+    end
+
     # @param {!(Launcher.LaunchOptions & Launcher.ChromeArgOptions & Launcher.BrowserOptions)=} options
     # @return {!Promise<!Browser>}
     def launch(options = {})
@@ -32,7 +38,12 @@ module Puppeteer::Launcher
         firefox_arguments << temporary_user_data_dir
       end
 
-      firefox_executable = @launch_options.executable_path || resolve_executable_path
+      firefox_executable =
+        if @launch_options.channel
+          executable_path_for_channel(@launch_options.channel.to_s)
+        else
+          @launch_options.executable_path || executable_path_for_channel('nightly')
+        end
       runner = Puppeteer::BrowserRunner.new(firefox_executable, firefox_arguments, temporary_user_data_dir)
       runner.start(
         handle_SIGHUP: @launch_options.handle_SIGHUP?,
@@ -123,8 +134,41 @@ module Puppeteer::Launcher
     end
 
     # @return {string}
-    def executable_path
-      resolve_executable_path
+    def executable_path(channel: nil)
+      if channel
+        executable_path_for_channel(channel.to_s)
+      else
+        executable_path_for_channel('firefox')
+      end
+    end
+
+    FIREFOX_EXECUTABLE_PATHS = {
+      windows: "#{ENV['PROGRAMFILES']}\\Firefox Nightly\\firefox.exe",
+      darwin: '/Applications/Firefox Nightly.app/Contents/MacOS/firefox',
+      linux: '/usr/bin/firefox',
+    }.freeze
+
+    # @param channel [String]
+    private def executable_path_for_channel(channel)
+      allowed = ['firefox', 'firefox-nightly', 'nightly']
+      unless allowed.include?(channel)
+        raise ArgumentError.new("Invalid channel: '#{channel}'. Allowed channel is #{allowed}")
+      end
+
+      firefox_path =
+        if Puppeteer.env.windows?
+          FIREFOX_EXECUTABLE_PATHS[:windows]
+        elsif Puppeteer.env.darwin?
+          FIREFOX_EXECUTABLE_PATHS[:darwin]
+        else
+          FIREFOX_EXECUTABLE_PATHS[:linux]
+        end
+
+      unless File.exist?(firefox_path)
+        raise "Nightly version of Firefox is not installed on this system.\nExpected path: #{firefox_path}"
+      end
+
+      firefox_path
     end
 
     def product

data/lib/puppeteer/launcher/launch_options.rb

@@ -32,6 +32,7 @@ module Puppeteer::Launcher
     # @property {!Object<string, string | undefined>=} env
     # @property {boolean=} pipe
     def initialize(options)
+      @channel = options[:channel]
       @executable_path = options[:executable_path]
       @ignore_default_args = options[:ignore_default_args] || false
       @handle_SIGINT = options[:handle_SIGINT] || true
@@ -43,7 +44,7 @@ module Puppeteer::Launcher
       @pipe = options[:pipe] || false
     end
 
-    attr_reader :executable_path, :ignore_default_args, :timeout, :env
+    attr_reader :channel, :executable_path, :ignore_default_args, :timeout, :env
 
     def handle_SIGINT?
       @handle_SIGINT

data/lib/puppeteer/puppeteer.rb

@@ -11,6 +11,7 @@ class Puppeteer::Puppeteer
   class NoViewport ; end
 
   # @param product [String]
+  # @param channel [String|Symbol]
   # @param executable_path [String]
   # @param ignore_default_args [Array<String>|nil]
   # @param handle_SIGINT [Boolean]
@@ -30,6 +31,7 @@ class Puppeteer::Puppeteer
   # @return [Puppeteer::Browser]
   def launch(
     product: nil,
+    channel: nil,
     executable_path: nil,
     ignore_default_args: nil,
     handle_SIGINT: nil,
@@ -48,6 +50,7 @@ class Puppeteer::Puppeteer
     slow_mo: nil
   )
     options = {
+      channel: channel&.to_s,
       executable_path: executable_path,
       ignore_default_args: ignore_default_args,
       handle_SIGINT: handle_SIGINT,
@@ -118,8 +121,8 @@ class Puppeteer::Puppeteer
   end
 
   # @return [String]
-  def executable_path
-    launcher.executable_path
+  def executable_path(channel: nil)
+    launcher.executable_path(channel: channel)
   end
 
   private def launcher

data/lib/puppeteer/version.rb

@@ -1,3 +1,3 @@
 module Puppeteer
-  VERSION = '0.34.3'
+  VERSION = '0.35.0'
 end

data/puppeteer-ruby.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rollbar'
   spec.add_development_dependency 'rspec', '~> 3.10.0 '
   spec.add_development_dependency 'rspec_junit_formatter' # for CircleCI.
-  spec.add_development_dependency 'rubocop', '~> 1.17.0'
+  spec.add_development_dependency 'rubocop', '~> 1.18.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.34.3
+  version: 0.35.0
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-27 00:00:00.000000000 Z
+date: 2021-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.0
+        version: 1.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.0
+        version: 1.18.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -294,7 +294,6 @@ files:
 - lib/puppeteer/keyboard/key_description.rb
 - lib/puppeteer/keyboard/us_keyboard_layout.rb
 - lib/puppeteer/launcher.rb
-- lib/puppeteer/launcher/base.rb
 - lib/puppeteer/launcher/browser_options.rb
 - lib/puppeteer/launcher/chrome.rb
 - lib/puppeteer/launcher/chrome_arg_options.rb

data/lib/puppeteer/launcher/base.rb

@@ -1,66 +0,0 @@
-module Puppeteer::Launcher
-  class Base
-    # @param {string} projectRoot
-    # @param {string} preferredRevision
-    def initialize(project_root:, preferred_revision:, is_puppeteer_core:)
-      @project_root = project_root
-      @preferred_revision = preferred_revision
-      @is_puppeteer_core = is_puppeteer_core
-    end
-
-    class ExecutablePathNotFound < StandardError; end
-
-    # @returns [String] Chrome Executable file path.
-    # @raise [ExecutablePathNotFound]
-    def resolve_executable_path
-      if !@is_puppeteer_core
-        # puppeteer-core doesn't take into account PUPPETEER_* env variables.
-        executable_path = ENV['PUPPETEER_EXECUTABLE_PATH']
-        if FileTest.exist?(executable_path)
-          return executable_path
-        end
-        raise ExecutablePathNotFound.new(
-          "Tried to use PUPPETEER_EXECUTABLE_PATH env variable to launch browser but did not find any executable at: #{executable_path}",
-        )
-      end
-
-      # temporal logic.
-      if Puppeteer.env.darwin?
-        case self
-        when Chrome
-          '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome'
-        when Firefox
-          '/Applications/Firefox Nightly.app/Contents/MacOS/firefox'
-        end
-      elsif Puppeteer.env.windows?
-        case self
-        when Chrome
-          'C:\Program Files\Google\Chrome\Application\chrome.exe'
-          # 'C:\Program Files (x86)\Microsoft\Edge\Application\msedge.exe'
-        when Firefox
-          'C:\Program Files\Firefox Nightly\firefox.exe'
-        end
-      else
-        case self
-        when Chrome
-          '/usr/bin/google-chrome'
-        when Firefox
-          '/usr/bin/firefox'
-        end
-      end
-
-      # const browserFetcher = new BrowserFetcher(launcher._projectRoot);
-      # if (!launcher._isPuppeteerCore) {
-      #   const revision = process.env['PUPPETEER_CHROMIUM_REVISION'];
-      #   if (revision) {
-      #     const revisionInfo = browserFetcher.revisionInfo(revision);
-      #     const missingText = !revisionInfo.local ? 'Tried to use PUPPETEER_CHROMIUM_REVISION env variable to launch browser but did not find executable at: ' + revisionInfo.executablePath : null;
-      #     return {executablePath: revisionInfo.executablePath, missingText};
-      #   }
-      # }
-      # const revisionInfo = browserFetcher.revisionInfo(launcher._preferredRevision);
-      # const missingText = !revisionInfo.local ? `Browser is not downloaded. Run "npm install" or "yarn install"` : null;
-      # return {executablePath: revisionInfo.executablePath, missingText};
-    end
-  end
-end