grover 1.1.10 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89de769dbb4ef96309c640d664ac90d9771968c02f596b6e6370d2f77b10cd1e
-  data.tar.gz: 5df2d5e82e1155757d859c95e01b0ed24dd49fdae6d4d8cb5c23276ef774603d
+  metadata.gz: 50a8ec2a93d7be70d77b4aefd45f6a87296cbd0201f3fba5a2d962fce511f4b7
+  data.tar.gz: 340a18b36da574c7cf57c897c3d767e890385279b681e345e2ba29cc5bf3430e
 SHA512:
-  metadata.gz: 9a6b7be08fb0d719cd464033d1d9ebf63343f8cf7126ea4dfead19eb2b022d9bf124898b58b6842690714f7d7d05fc01e847340a9ed47f9966b6c8eddfb768fe
-  data.tar.gz: 90acf98c742ad66686108735828b0a378776c07375562df8c4db6f483a9f1669c7a0409381764caddb9a788c6ddbe9cfc7802edfa05961bedeb4c7896da4558d
+  metadata.gz: 13124e1d70416020c29695bbf59f2618015def0d46d4d194c5ba514b4f4c48a2622adc6238c32254717601b50acaadc3beac5065fb19ffbdf864b5d8f4bda868
+  data.tar.gz: dae49b29ab27b64b990f8f71f7571afb00e01c18a7a3b94571af2a1b74bd578248db4b712241e571674683052b196a8b4164095db449058a95d9e8f2509d9119

data/lib/grover/configuration.rb

@@ -7,9 +7,10 @@ class Grover
   class Configuration
     attr_accessor :options, :meta_tag_prefix, :ignore_path, :ignore_request,
                   :root_url, :use_pdf_middleware, :use_png_middleware,
-                  :use_jpeg_middleware, :node_env_vars, :allow_file_uris
+                  :use_jpeg_middleware, :js_runtime_bin,
+                  :node_env_vars, :allow_file_uris
 
-    def initialize
+    def initialize # rubocop:disable Metrics/MethodLength
       @options = {}
       @meta_tag_prefix = 'grover-'
       @ignore_path = nil
@@ -18,6 +19,7 @@ class Grover
       @use_pdf_middleware = true
       @use_png_middleware = false
       @use_jpeg_middleware = false
+      @js_runtime_bin = ['node']
       @node_env_vars = {}
       @allow_file_uris = false
     end

data/lib/grover/errors.rb

@@ -11,6 +11,18 @@ class Grover
   module JavaScript # rubocop:disable Style/Documentation
     Error = Class.new(::Grover::Error)
     UnknownError = Class.new(Error)
+
+    ErrorWithDetails = Class.new(Error) do
+      def initialize(name, error_details)
+        super(name)
+        @error_details = Grover::Utils.deep_transform_keys_in_object error_details, &:to_sym
+      end
+
+      attr_reader :error_details
+    end
+    RequestFailedError = Class.new(ErrorWithDetails)
+    PageRenderError = Class.new(ErrorWithDetails)
+
     def self.const_missing(name)
       const_set name, Class.new(Error)
     end

data/lib/grover/js/processor.cjs

@@ -26,8 +26,32 @@ const fs = require('fs');
 const os = require('os');
 const path = require('path');
 
+function GroverError(name, errors) {
+  this.name = name;
+  this.message = errors.map(e => e.message).join("\n");
+  this.errors = errors;
+}
+GroverError.prototype = Error.prototype;
+
 const _processPage = (async (convertAction, uriOrHtml, options) => {
-  let browser, page, errors = [], tmpDir, wsConnection = false;
+  let browser, page, tmpDir, wsConnection = false;
+  const requestErrors = [], pageErrors = [];
+
+  const captureRequestError = (request) => {
+    const requestError = { url: request.url() };
+
+    if (request.failure()) {
+      requestError.reason = request.failure().errorText;
+      requestError.message = requestError.reason + " at " + requestError.url;
+    } else if (request.response() && request.response().status()) {
+      requestError.status = request.response().status();
+      requestError.message = requestError.status + " " + requestError.url;
+    } else {
+      requestError.message = "UnknownError " + requestError.url;
+    }
+
+    requestErrors.push(requestError);
+  };
 
   try {
     // Configure puppeteer debugging options
@@ -163,12 +187,24 @@ const _processPage = (async (convertAction, uriOrHtml, options) => {
     const raiseOnRequestFailure = options.raiseOnRequestFailure; delete options.raiseOnRequestFailure;
     if (raiseOnRequestFailure) {
       page.on('requestfinished', (request) => {
-        if (request.response() && !(request.response().ok() || request.response().status() === 304) && !request.redirectChain().length > 0) {
-          errors.push(request);
+        if (request.response() &&
+            !(request.response().ok() || request.response().status() === 304) &&
+            !request.redirectChain().length > 0) {
+          captureRequestError(request);
         }
       });
       page.on('requestfailed', (request) => {
-        errors.push(request);
+        captureRequestError(request);
+      });
+    }
+
+    const raiseOnJSError = options.raiseOnJSError; delete options.raiseOnJSError;
+    if (raiseOnJSError) {
+      page.on('pageerror', (error) => {
+        pageErrors.push({
+          message: error.toString().replace(new RegExp('^' + error.name + ': '), ''),
+          type: error.name || 'Error'
+        });
       });
     }
 
@@ -257,21 +293,12 @@ const _processPage = (async (convertAction, uriOrHtml, options) => {
       await page.hover(hoverSelector);
     }
 
-    if (errors.length > 0) {
-      function RequestFailedError(errors) {
-        this.name = "RequestFailedError";
-        this.message = errors.map(e => {
-          if (e.failure()) {
-            return e.failure().errorText + " at " + e.url();
-          } else if (e.response() && e.response().status()) {
-            return e.response().status() + " " + e.url();
-          } else {
-            return "UnknownError " + e.url()
-          }
-        }).join("\n");
-      }
-      RequestFailedError.prototype = Error.prototype;
-      throw new RequestFailedError(errors);
+    if (requestErrors.length > 0) {
+      throw new GroverError("RequestFailedError", requestErrors);
+    }
+
+    if (pageErrors.length > 0) {
+      throw new GroverError("PageRenderError", pageErrors);
     }
 
     // Setup conversion timeout
@@ -301,7 +328,9 @@ const _processPage = (async (convertAction, uriOrHtml, options) => {
 });
 
 function _handleError(error) {
-  if (error instanceof Error) {
+  if (error instanceof GroverError) {
+    process.stdout.write(JSON.stringify(['err', error.message, error.name, error.errors]));
+  } else if (error instanceof Error) {
     process.stdout.write(
       JSON.stringify(['err', error.toString().replace(new RegExp('^' + error.name + ': '), ''), error.name])
     );

data/lib/grover/middleware.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'combine_pdf'
-
 class Grover
   #
   # Rack middleware for catching PDF requests and returning the upstream HTML as a PDF
@@ -132,12 +130,19 @@ class Grover
     end
 
     def add_cover_content(grover)
+      load_combine_pdf
       pdf = CombinePDF.parse grover.to_pdf
       pdf >> fetch_cover_pdf(grover.front_cover_path) if grover.show_front_cover?
       pdf << fetch_cover_pdf(grover.back_cover_path) if grover.show_back_cover?
       pdf.to_pdf
     end
 
+    def load_combine_pdf
+      require 'combine_pdf'
+    rescue ::LoadError
+      raise Grover::Error, 'Please add/install the "combine_pdf" gem to use the front/back cover page feature'
+    end
+
     def fetch_cover_pdf(path)
       temp_env = env.deep_dup
       scrub_env! temp_env

data/lib/grover/options_fixer.rb

@@ -34,7 +34,8 @@ class Grover
     def fix_boolean_options!
       fix_options!(
         'display_header_footer', 'full_page', 'landscape', 'omit_background', 'prefer_css_page_size',
-        'print_background', 'viewport.has_touch', 'viewport.is_landscape', 'viewport.is_mobile', 'bypass_csp'
+        'print_background', 'viewport.has_touch', 'viewport.is_landscape', 'viewport.is_mobile', 'bypass_csp',
+        'raise_on_request_failure', 'raise_on_js_error'
       ) { |value| !FALSE_VALUES.include?(value) }
     end
 

data/lib/grover/processor.rb

@@ -33,7 +33,7 @@ class Grover
     def spawn_process
       @stdin, @stdout, @stderr, @wait_thr = Open3.popen3(
         Grover.configuration.node_env_vars,
-        'node',
+        *Grover.configuration.js_runtime_bin,
         File.expand_path(File.join(__dir__, 'js/processor.cjs')),
         chdir: app_root
       )
@@ -83,14 +83,14 @@ class Grover
       input = stdout.gets
       raise Errno::EPIPE, "Can't read from worker" if input.nil?
 
-      status, message, error_class = JSON.parse(input)
+      status, message, error_class, errors = 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
+        raise Grover::JavaScript.const_get(error_class, false).new(*[message, errors].compact)
       end
     rescue JSON::ParserError
       raise Grover::Error, 'Malformed worker response'

data/lib/grover/utils.rb

@@ -8,7 +8,8 @@ class Grover
     ACRONYMS = {
       'css' => 'CSS',
       'csp' => 'CSP',
-      'http' => 'HTTP'
+      'http' => 'HTTP',
+      'js' => 'JS'
     }.freeze
     private_constant :ACRONYMS
 

data/lib/grover/version.rb

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

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: grover
 version: !ruby/object:Gem::Version
-  version: 1.1.10
+  version: 1.2.0
 platform: ruby
 authors:
 - Andrew Bromwich
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-01 00:00:00.000000000 Z
+date: 2024-11-19 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: combine_pdf
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1'
 description: Transform HTML into PDF/PNG/JPEG using Google Puppeteer/Chromium
 email:
 - abromwich@studiosity.com