Add manual renderDelay support using window.callPhantom

marcbachmann · marcbachmann · commit 6830076fbd41 · 2017-09-27T02:30:49.000+02:00
diff --git a/lib/scripts/pdf_a4_portrait.js b/lib/scripts/pdf_a4_portrait.js
@@ -33,34 +33,21 @@ if (!json.html || !json.html.trim()) exit('Did not receive any html')
 var options = json.options
 var page = webpage.create()
 
-if (options.httpHeaders) page.customHeaders = options.httpHeaders
-if (options.viewportSize) page.viewportSize = options.viewportSize
-if (options.zoomFactor) page.zoomFactor = options.zoomFactor
-if (options.base) page.setContent(json.html, options.base)
-else page.setContent(json.html, null)
-
-page.onError = function (msg, trace) {
-  exit(buildStack('Evaluation - ' + msg, trace))
-}
-
-// Force cleanup after 2 minutes
-// Add 2 seconds to make sure master process triggers kill
-// before to the phantom process
-var timeout = (options.timeout || 120000) + 2000
-setTimeout(function () {
-  exit('Force timeout')
-}, timeout)
-
 // Completely load page & end process
 // ----------------------------------
 var rendered = false
 var renderTimeout
 
 // If renderDelay is manual, then listen for an event and don't automatically render
-if (options.renderDelay === 'manual') page.onCallback = renderNow
+if (options.renderDelay === 'manual') {
+  page.onCallback = function (message) {
+    setTimeout(renderNow, 0)
+    return message
+  }
+}
 
 page.onLoadFinished = function () {
-  if (typeof options.renderDelay === 'manual') return
+  if (options.renderDelay === 'manual') return
   renderTimeout = setTimeout(renderNow, Math.floor(options.renderDelay) || 0)
 }
 
@@ -76,14 +63,33 @@ function renderNow () {
   }
 
   var filename = options.filename || (options.directory || '/tmp') + '/html-pdf-' + system.pid + '.' + fileOptions.type
-
   page.render(filename, fileOptions)
 
   // Output to parent process
   system.stdout.write(JSON.stringify({filename: filename}))
   exit(null)
 }
 
+// Set Content and begin loading
+// -----------------------------
+if (options.httpHeaders) page.customHeaders = options.httpHeaders
+if (options.viewportSize) page.viewportSize = options.viewportSize
+if (options.zoomFactor) page.zoomFactor = options.zoomFactor
+if (options.base) page.setContent(json.html, options.base)
+else page.setContent(json.html, null)
+
+page.onError = function (msg, trace) {
+  exit(buildStack('Evaluation - ' + msg, trace))
+}
+
+// Force cleanup after 2 minutes
+// Add 2 seconds to make sure master process triggers kill
+// before to the phantom process
+var timeout = (options.timeout || 120000) + 2000
+setTimeout(function () {
+  exit('Force timeout')
+}, timeout)
+
 // Returns a hash of HTML content
 // ------------------------------
 function getContent (page) {
diff --git a/test/callback.html b/test/callback.html
@@ -0,0 +1,30 @@
+<html>
+  <head>
+    <meta charset="utf-8">
+    <style>
+      body {
+        font-family: "Helvetica Neue", sans-serif;
+        background: #F0F0F0;
+        color: #333;
+      }
+
+      * {
+        border: 0;
+        margin: 0;
+        padding: 0;
+      }
+    </style>
+  </head>
+  <body>
+    <div id="pageHeader">Header</div>
+    <div id="pageContent"></div>
+    <div id="pageFooter">Footer</div>
+
+    <script>
+      setTimeout(function () {
+        var res = window.callPhantom({success: 'true'})
+        document.getElementById('pageContent').innerHTML = JSON.stringify(res)
+      }, 1000)
+    </script>
+  </body>
+</html>
diff --git a/test/index.js b/test/index.js
@@ -83,6 +83,22 @@ test('pdf.create(html, {renderDelay: 1000}).toBuffer(callback)', function (t) {
   })
 })
 
+test('window.callPhantom renders page', function (t) {
+  t.plan(3)
+
+  var callbackHtml = fs.readFileSync(path.join(__dirname, 'callback.html'), 'utf8')
+  var file = path.join(__dirname, 'callback.pdf')
+  var startTime = new Date().getTime()
+
+  pdf.create(callbackHtml, {renderDelay: 'manual'}).toFile(file, function (err, pdf) {
+    var endTime = new Date().getTime()
+    t.error(err)
+
+    var time = endTime - startTime
+    t.assert(time > 1000 && time < 2000, 'rendered in response to callPhantom')
+    t.assert(fs.existsSync(file), 'writes the file to the given destination')
+  })
+})
 
 test('pdf.create(html[, options]).toStream(callback)', function (t) {
   t.plan(3)
