Feature: printToPDFTimeout (#48)

NielsSteensma · Feb 18, 2022 · e3bb4a3 · e3bb4a3
1 parent 1549aa6
commit e3bb4a3
Show file tree

Hide file tree

Showing 8 changed files with 204 additions and 95 deletions.
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    Dhalang (0.6.2)
+    Dhalang (0.6.4)
 
 GEM
   remote: https://rubygems.org/
@@ -35,6 +35,7 @@ GEM
     ttfunk (1.7.0)
 
 PLATFORMS
+  arm64-darwin-21
   x86-mingw32
 
 DEPENDENCIES

diff --git a/README.md b/README.md
@@ -87,6 +87,7 @@ Below table lists all possible configuration parameters that can be set:
 | Key                | Description                                                                             | Default                         |
 |--------------------|-----------------------------------------------------------------------------------------|---------------------------------|
 | navigationTimeout  | Amount of milliseconds until Puppeteer while timeout when navigating to the given page  | 10000                           |
+| printToPDFTimeout  | Amount of milliseconds until Puppeteer while timeout when calling Page.printToPDF       | 0 (unlimited)                   |
 | navigationWaitForSelector | If set, Dhalang will wait for the specified selector to appear before creating the screenshot or PDF | None        |
 | navigationWaitForXPath | If set, Dhalang will wait for the specified XPath to appear before creating the screenshot or PDF | None              |
 | userAgent          | User agent to send with the request                                                     | Default Puppeteer one           |

diff --git a/lib/Dhalang/puppeteer.rb b/lib/Dhalang/puppeteer.rb
@@ -5,16 +5,17 @@ class Puppeteer
         private_constant :NODE_MODULES_PATH
 
         USER_OPTIONS = {
-                navigationTimeout: 10000,
-                navigationWaitUntil: 'load',
-                navigationWaitForSelector: '',
-                navigationWaitForXPath: '',
-                userAgent: '',
-                isHeadless: true,
-                viewPort: '',
-                httpAuthenticationCredentials: '',
-                isAutoHeight: false,
-                chromeOptions: []
+            navigationTimeout: 10000,
+            printToPDFTimeout: 0, # unlimited
+            navigationWaitUntil: 'load',
+            navigationWaitForSelector: '',
+            navigationWaitForXPath: '',
+            userAgent: '',
+            isHeadless: true,
+            viewPort: '',
+            httpAuthenticationCredentials: '',
+            isAutoHeight: false,
+            chromeOptions: []
         }
         private_constant :USER_OPTIONS
 

diff --git a/lib/Dhalang/version.rb b/lib/Dhalang/version.rb
@@ -1,3 +1,3 @@
 module Dhalang
-  VERSION = "0.6.3"
+  VERSION = "0.6.4"
 end
diff --git a/lib/js/dhalang.js b/lib/js/dhalang.js
@@ -116,6 +116,7 @@ exports.getConfiguredPdfOptions = async function (page, configuration) {
             // ignoring file related errors
         }
     }
+
     if (pdfOptions['footerTemplateFile'] !== '') {
         try {
             pdfOptions['footerTemplate'] = fs.readFileSync(pdfOptions['footerTemplateFile'], 'utf8')
@@ -133,6 +134,8 @@ exports.getConfiguredPdfOptions = async function (page, configuration) {
         }
     }
 
+    pdfOptions['timeout'] = configuration.userOptions.printToPDFTimeout
+
     return pdfOptions
 }