grover 0.11.4 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 130c5f7d5181084098d85f0c6c8ff4afa0ba285746a3532cea2cbf6b3f28eb26
-  data.tar.gz: dbd1c01477c9c8133511e0c0999ceef67eb92be82b113ce06761678e82019542
+  metadata.gz: 18d371bdb009b39ba004d06f24c35ddb4f51a0cd253082481d04b1c1dac45b57
+  data.tar.gz: f20bfd80f394ef4c3c7e98128a6d0d5615387af7c1c6733f867ee24ead91c9e5
 SHA512:
-  metadata.gz: 9454063053df73117ce711fc4560ba38be688310399ba5f16f806ce9fe572529b84d152cd22ce51c94ac582866e26db253dd011bbf8fcb807ef7648cf5e19208
-  data.tar.gz: 921c5e905f3f1416f543037cb85c358552558b27cd8535a6720cc62f6aa1c7d3d3c7a62b07481543ccdfc704c533c3a610ff312061089c1f7b2c304c91e1848d
+  metadata.gz: 280be92cb4f2fd14c94341d75b3564add657ec7acc496fe3cffd0b1d0d7bcde86ab492112fec7522fe6c666cc95045f8f5eaf06e5e6cd6d034abab443c8955ed
+  data.tar.gz: 5a30bf3b21ea80eeb6b6f54c559f0fe7d0fd0559941028cebc71fd96fbd00dae24b2d67ecec29a413931cc0f883b4323282cc3308f69f370649720bd7a64639d

data/lib/grover.rb

@@ -5,144 +5,20 @@ require 'grover/version'
 require 'grover/utils'
 require 'active_support_ext/object/deep_dup' unless defined?(ActiveSupport)
 
+require 'grover/errors'
 require 'grover/html_preprocessor'
 require 'grover/middleware'
 require 'grover/configuration'
 require 'grover/options_builder'
+require 'grover/processor'
 
 require 'nokogiri'
-require 'schmooze'
 require 'yaml'
 
 #
 # Grover interface for converting HTML to PDF
 #
 class Grover
-  #
-  # Processor helper class for calling out to Puppeteer NodeJS library
-  #
-  class Processor < Schmooze::Base
-    dependencies puppeteer: 'puppeteer'
-
-    def self.launch_params
-      ENV['GROVER_NO_SANDBOX'] == 'true' ? "{args: ['--no-sandbox', '--disable-setuid-sandbox']}" : '{args: []}'
-    end
-
-    def self.convert_function(convert_action)
-      <<~FUNCTION
-        async (url_or_html, options) => {
-          let browser;
-          try {
-            let launchParams = #{launch_params};
-
-            // Configure puppeteer debugging options
-            const debug = options.debug; delete options.debug;
-            if (typeof debug === 'object' && !!debug) {
-              if (debug.headless != undefined) { launchParams.headless = debug.headless; }
-              if (debug.devtools != undefined) { launchParams.devtools = debug.devtools; }
-            }
-
-            // Configure additional launch arguments
-            const args = options.launchArgs; delete options.launchArgs;
-            if (Array.isArray(args)) {
-              launchParams.args = launchParams.args.concat(args);
-            }
-
-            // Set executable path if given
-            const executablePath = options.executablePath; delete options.executablePath;
-            if (executablePath) {
-              launchParams.executablePath = executablePath;
-            }
-
-            // Launch the browser and create a page
-            browser = await puppeteer.launch(launchParams);
-            const page = await browser.newPage();
-
-            // Basic auth
-            const username = options.username; delete options.username
-            const password = options.password; delete options.password
-            if (username != undefined && password != undefined) {
-              await page.authenticate({ username, password });
-            }
-
-            // Setting cookies
-            const cookies = options.cookies; delete options.cookies
-            if (Array.isArray(cookies)) {
-              await page.setCookie(...cookies);
-            }
-
-            // Set caching flag (if provided)
-            const cache = options.cache; delete options.cache;
-            if (cache != undefined) {
-              await page.setCacheEnabled(cache);
-            }
-
-            // Setup timeout option (if provided)
-            let request_options = {};
-            const timeout = options.timeout; delete options.timeout;
-            if (timeout != undefined) {
-              request_options.timeout = timeout;
-            }
-
-            // Setup viewport options (if provided)
-            const viewport = options.viewport; delete options.viewport;
-            if (viewport != undefined) {
-              await page.setViewport(viewport);
-            }
-
-            const waitUntil = options.waitUntil; delete options.waitUntil;
-            if (url_or_html.match(/^http/i)) {
-              // Request is for a URL, so request it
-              request_options.waitUntil = waitUntil || 'networkidle2';
-              await page.goto(url_or_html, request_options);
-            } else {
-              // Request is some HTML content. Use request interception to assign the body
-              request_options.waitUntil = waitUntil || 'networkidle0';
-              await page.setRequestInterception(true);
-              page.once('request', request => {
-                request.respond({ body: url_or_html });
-                // Reset the request interception
-                // (we only want to intercept the first request - ie our HTML)
-                page.on('request', request => request.continue());
-              });
-              const displayUrl = options.displayUrl; delete options.displayUrl;
-              await page.goto(displayUrl || 'http://example.com', request_options);
-            }
-
-            // If specified, emulate the media type
-            const emulateMedia = options.emulateMedia; delete options.emulateMedia;
-            if (emulateMedia != undefined) {
-              if (typeof page.emulateMediaType == 'function') {
-                await page.emulateMediaType(emulateMedia);
-              } else {
-                await page.emulateMedia(emulateMedia);
-              }
-            }
-
-            // If specified, evaluate script on the page
-            const executeScript = options.executeScript; delete options.executeScript;
-            if (executeScript != undefined) {
-              await page.evaluate(executeScript);
-            }
-
-            // If we're running puppeteer in headless mode, return the converted PDF
-            if (debug == undefined || (typeof debug === 'object' && (debug.headless == undefined || debug.headless))) {
-              return await page.#{convert_action}(options);
-            }
-          } finally {
-            if (browser) {
-              await browser.close();
-            }
-          }
-        }
-      FUNCTION
-    end
-
-    method :convert_pdf, convert_function('pdf')
-    method :convert_screenshot, convert_function('screenshot')
-  end
-  private_constant :Processor
-
   DEFAULT_HEADER_TEMPLATE = "<div class='date text left'></div><div class='title text center'></div>"
   DEFAULT_FOOTER_TEMPLATE = <<~HTML
     <div class='url text left grow'></div>
@@ -171,10 +47,7 @@ class Grover
   # @return [String] The resulting PDF data
   #
   def to_pdf(path = nil)
-    result = processor.convert_pdf @url, normalized_options(path: path)
-    return unless result
-
-    result['data'].pack('C*')
+    processor.convert :pdf, @url, normalized_options(path: path)
   end
 
   #
@@ -186,11 +59,8 @@ class Grover
   #
   def screenshot(path: nil, format: nil)
     options = normalized_options(path: path)
-    options['type'] = format if format.is_a? ::String
-    result = processor.convert_screenshot @url, options
-    return unless result
-
-    result['data'].pack('C*')
+    options['type'] = format if %w[png jpeg].include? format
+    processor.convert :screenshot, @url, options
   end
 
   #
@@ -200,7 +70,7 @@ class Grover
   # @return [String] The resulting PNG data
   #
   def to_png(path = nil)
-    screenshot(path: path, format: 'png')
+    screenshot path: path, format: 'png'
   end
 
   #
@@ -210,7 +80,7 @@ class Grover
   # @return [String] The resulting JPEG data
   #
   def to_jpeg(path = nil)
-    screenshot(path: path, format: 'jpeg')
+    screenshot path: path, format: 'jpeg'
   end
 
   #

data/lib/grover/errors.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class Grover
+  #
+  # Error classes for calling out to Puppeteer NodeJS library
+  #
+  # Heavily based on the Schmooze library https://github.com/Shopify/schmooze
+  #
+  Error = Class.new(StandardError)
+  DependencyError = Class.new(Error)
+  module JavaScript # rubocop:disable Style/Documentation
+    Error = Class.new(::Grover::Error)
+    UnknownError = Class.new(Error)
+    def self.const_missing(name)
+      const_set name, Class.new(Error)
+    end
+  end
+end

data/lib/grover/js/processor.js

@@ -0,0 +1,147 @@
+// Setup imports
+try {
+  const Module = require('module');
+  // resolve puppeteer from the CWD instead of where this script is located
+  var puppeteer = require(require.resolve('puppeteer', { paths: Module._nodeModulePaths(process.cwd()) }));
+} catch (e) {
+  process.stdout.write(JSON.stringify(['err', e.toString()]));
+  process.stdout.write("\n");
+  process.exit(1);
+}
+process.stdout.write("[\"ok\"]\n");
+
+const _processPage = (async (convertAction, urlOrHtml, options) => {
+  let browser;
+  try {
+    const launchParams = {
+      args: process.env.GROVER_NO_SANDBOX === 'true' ? ['--no-sandbox', '--disable-setuid-sandbox'] : []
+    };
+
+    // Configure puppeteer debugging options
+    const debug = options.debug; delete options.debug;
+    if (typeof debug === 'object' && !!debug) {
+      if (debug.headless !== undefined) { launchParams.headless = debug.headless; }
+      if (debug.devtools !== undefined) { launchParams.devtools = debug.devtools; }
+    }
+
+    // Configure additional launch arguments
+    const args = options.launchArgs; delete options.launchArgs;
+    if (Array.isArray(args)) {
+      launchParams.args = launchParams.args.concat(args);
+    }
+
+    // Set executable path if given
+    const executablePath = options.executablePath; delete options.executablePath;
+    if (executablePath) {
+      launchParams.executablePath = executablePath;
+    }
+
+    // Launch the browser and create a page
+    browser = await puppeteer.launch(launchParams);
+    const page = await browser.newPage();
+
+    // Basic auth
+    const username = options.username; delete options.username
+    const password = options.password; delete options.password
+    if (username !== undefined && password !== undefined) {
+      await page.authenticate({ username, password });
+    }
+
+    // Setting cookies
+    const cookies = options.cookies; delete options.cookies
+    if (Array.isArray(cookies)) {
+      await page.setCookie(...cookies);
+    }
+
+    // Set caching flag (if provided)
+    const cache = options.cache; delete options.cache;
+    if (cache !== undefined) {
+      await page.setCacheEnabled(cache);
+    }
+
+    // Setup timeout option (if provided)
+    let requestOptions = {};
+    const timeout = options.timeout; delete options.timeout;
+    if (timeout !== undefined) {
+      requestOptions.timeout = timeout;
+    }
+
+    // Setup viewport options (if provided)
+    const viewport = options.viewport; delete options.viewport;
+    if (viewport !== undefined) {
+      await page.setViewport(viewport);
+    }
+
+    const waitUntil = options.waitUntil; delete options.waitUntil;
+    if (urlOrHtml.match(/^http/i)) {
+      // Request is for a URL, so request it
+      requestOptions.waitUntil = waitUntil || 'networkidle2';
+      await page.goto(urlOrHtml, requestOptions);
+    } else {
+      // Request is some HTML content. Use request interception to assign the body
+      requestOptions.waitUntil = waitUntil || 'networkidle0';
+      await page.setRequestInterception(true);
+      page.once('request', request => {
+        request.respond({ body: urlOrHtml });
+        // Reset the request interception
+        // (we only want to intercept the first request - ie our HTML)
+        page.on('request', request => request.continue());
+      });
+      const displayUrl = options.displayUrl; delete options.displayUrl;
+      await page.goto(displayUrl || 'http://example.com', requestOptions);
+    }
+
+    // If specified, emulate the media type
+    const emulateMedia = options.emulateMedia; delete options.emulateMedia;
+    if (emulateMedia !== undefined) {
+      if (typeof page.emulateMediaType == 'function') {
+        await page.emulateMediaType(emulateMedia);
+      } else {
+        await page.emulateMedia(emulateMedia);
+      }
+    }
+
+    // If specified, evaluate script on the page
+    const executeScript = options.executeScript; delete options.executeScript;
+    if (executeScript !== undefined) {
+      await page.evaluate(executeScript);
+    }
+
+    // If we're running puppeteer in headless mode, return the converted PDF
+    if (debug === undefined || (typeof debug === 'object' && (debug.headless === undefined || debug.headless))) {
+      return await page[convertAction](options);
+    }
+  } finally {
+    if (browser) {
+      await browser.close();
+    }
+  }
+});
+
+function _handleError(error) {
+  if (error instanceof Error) {
+    process.stdout.write(
+      JSON.stringify(['err', error.toString().replace(new RegExp('^' + error.name + ': '), ''), error.name])
+    );
+  } else {
+    process.stdout.write(JSON.stringify(['err', error.toString()]));
+  }
+  process.stdout.write("\n");
+}
+
+// Interface for communicating between Ruby processor and Node processor
+require('readline').createInterface({
+  input: process.stdin,
+  terminal: false,
+}).on('line', function(line) {
+  try {
+    Promise.resolve(_processPage.apply(null, JSON.parse(line)))
+      .then(function (result) {
+        process.stdout.write(JSON.stringify(['ok', result]));
+        process.stdout.write("\n");
+      })
+      .catch(_handleError);
+  } catch(error) {
+    _handleError(error);
+  }
+});

data/lib/grover/processor.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'open3'
+
+class Grover
+  #
+  # Processor helper class for calling out to Puppeteer NodeJS library
+  #
+  # Heavily based on the Schmooze library https://github.com/Shopify/schmooze
+  #
+  class Processor
+    def initialize(app_root)
+      @app_root = app_root
+    end
+
+    def convert(method, url_or_html, options)
+      spawn_process
+      ensure_packages_are_initiated
+      result = call_js_method method, url_or_html, options
+      return unless result
+
+      result['data'].pack('C*')
+    ensure
+      cleanup_process
+    end
+
+    private
+
+    attr_reader :app_root, :stdin, :stdout, :stderr, :wait_thr
+
+    def spawn_process
+      @stdin, @stdout, @stderr, @wait_thr = Open3.popen3(
+        'node',
+        File.expand_path(File.join(__dir__, 'js/processor.js')),
+        chdir: app_root
+      )
+    end
+
+    def ensure_packages_are_initiated
+      input = stdout.gets
+      raise Grover::Error, "Failed to instantiate worker process:\n#{stderr.read}" if input.nil?
+
+      result = JSON.parse(input)
+      return if result[0] == 'ok'
+
+      cleanup_process
+      parse_package_error result[1]
+    end
+
+    def parse_package_error(error_message) # rubocop:disable Metrics/MethodLength
+      package_name = error_message[/^Error: Cannot find module '(.*)'$/, 1]
+      raise Grover::Error, error_message unless package_name
+
+      begin
+        %w[dependencies devDependencies].each do |key|
+          next unless package_json.key?(key) && package_json[key].key?(package_name)
+
+          raise Grover::DependencyError, Utils.squish(<<~ERROR)
+            Cannot find module '#{package_name}'.
+            The module was found in '#{package_json_path}' however, please run 'npm install' from '#{app_root}'
+          ERROR
+        end
+      rescue Errno::ENOENT # rubocop:disable Lint/SuppressedException
+      end
+      raise Grover::DependencyError, Utils.squish(<<~ERROR)
+        Cannot find module '#{package_name}'. You need to add it to '#{package_json_path}' and run 'npm install'
+      ERROR
+    end
+
+    def package_json_path
+      @package_json_path ||= File.join(app_root, 'package.json')
+    end
+
+    def package_json
+      @package_json ||= JSON.parse(File.read(package_json_path))
+    end
+
+    def call_js_method(method, url_or_html, options) # rubocop:disable Metrics/MethodLength
+      stdin.puts JSON.dump([method, url_or_html, options])
+      input = stdout.gets
+      raise Errno::EPIPE, "Can't read from worker" if input.nil?
+
+      status, message, error_class = JSON.parse(input)
+
+      if status == 'ok'
+        message
+      elsif error_class.nil?
+        raise Grover::JavaScript::UnknownError, message
+      else
+        raise Grover::JavaScript.const_get(error_class, false), message
+      end
+    rescue Errno::EPIPE, IOError
+      raise Grover::Error, "Worker process failed:\n#{stderr.read}"
+    end
+
+    def cleanup_process
+      stdin.close
+      stdout.close
+      stderr.close
+      wait_thr.join
+    end
+  end
+end

data/lib/grover/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Grover
-  VERSION = '0.11.4'
+  VERSION = '0.12.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grover
 version: !ruby/object:Gem::Version
-  version: 0.11.4
+  version: 0.12.1
 platform: ruby
 authors:
 - Andrew Bromwich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-24 00:00:00.000000000 Z
+date: 2020-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: combine_pdf
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: schmooze
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: mini_magick
   requirement: !ruby/object:Gem::Requirement
@@ -181,10 +167,13 @@ files:
 - lib/active_support_ext/object/duplicable.rb
 - lib/grover.rb
 - lib/grover/configuration.rb
+- lib/grover/errors.rb
 - lib/grover/html_preprocessor.rb
+- lib/grover/js/processor.js
 - lib/grover/middleware.rb
 - lib/grover/options_builder.rb
 - lib/grover/options_fixer.rb
+- lib/grover/processor.rb
 - lib/grover/utils.rb
 - lib/grover/version.rb
 homepage: https://github.com/Studiosity/grover