grover 1.1.9 → 1.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82b9a3edaa4f0d20c326f3e79d61b1d2a0190454ac9ffb6867191a9607ec1ea0
-  data.tar.gz: 4e71234c41bf19c88a5b44c0a043a1c2ae5a74f94d0606fb0cd627c02e8511a2
+  metadata.gz: 07f9183a814d7d598e29ee39cc4d7af3df619ba262aa1bef5be2de0cd9e7da3c
+  data.tar.gz: 368d618c68428ff2f02832962463532a305ca48a2d6b8956dd978a80dc375052
 SHA512:
-  metadata.gz: 737079399ecd8ef4c6a88c535495a2aa52fcb9e2e8fa0ca171d3453b58134d795237e606487a9f3dd06afad73baac8fac834a76a33445a1099e168f929f13835
-  data.tar.gz: 767e6ebf33ce60336d9afd71859e004b54765910136387ed81b44a12489de7728ff88d0b5f33890dea45314a58476972d31a1f3e9e5e7834f6d68979acf0eb19
+  metadata.gz: 0deb217329f6141c3a7ed3da596945aa79213ca2216dbc914bb6b1e17104283bff1f8f45057f4fa099689fd8295560f9e0e2d023fa0e93551599a447649dace2
+  data.tar.gz: 6e9b91209b59e8bc91ef38aa42906468c2b79614950f6d9e345d002468248519a633b69cbaeb4e6ad6e520e5f8acafa2356e084c1b167ac7717c344a287bcd72

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
@@ -282,7 +309,7 @@ const _processPage = (async (convertAction, uriOrHtml, options) => {
 
     // 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);
+      return Buffer.from(await page[convertAction](options));
     }
   } finally {
     if (browser) {
@@ -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/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

@@ -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.9'
+  VERSION = '1.1.11'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grover
 version: !ruby/object:Gem::Version
-  version: 1.1.9
+  version: 1.1.11
 platform: ruby
 authors:
 - Andrew Bromwich
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-02 00:00:00.000000000 Z
+date: 2024-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: combine_pdf