@browserless/pdf 10.7.13 → 10.8.0-beta.1

package/package.json

@@ -2,7 +2,7 @@
   "name": "@browserless/pdf",
   "description": "Sensible good defaults for exporting a website as PDF",
   "homepage": "https://browserless.js.org/#/?id=pdfurl-options",
-  "version": "10.7.13",
+  "version": "10.8.0-beta.1",
   "main": "src",
   "repository": {
     "directory": "packages/pdf",
@@ -24,7 +24,8 @@
     "screen"
   ],
   "dependencies": {
-    "@browserless/goto": "^10.7.13"
+    "@browserless/goto": "^10.7.13",
+    "@browserless/screenshot": "^10.8.0-beta.0"
   },
   "engines": {
     "node": ">= 12"
@@ -37,5 +38,5 @@
     "test": "exit 0"
   },
   "license": "MIT",
-  "gitHead": "9ed950add1325d6f93d072d6475f1603e4b97d45"
+  "gitHead": "c94f407b23a2ad309f71069c1a3e4a9b74c09fd5"
 }

package/src/index.js

@@ -1,6 +1,9 @@
 'use strict'
 
+const { takeScreenshot } = require('@browserless/screenshot')
+const debug = require('debug-logfmt')('browserless:pdf')
 const createGoto = require('@browserless/goto')
+const timeSpan = require('@kikobeats/time-span')({ format: require('pretty-ms') })
 
 const getMargin = unit => {
   if (!unit) return unit
@@ -16,15 +19,50 @@ const getMargin = unit => {
 module.exports = ({ goto, ...gotoOpts } = {}) => {
   goto = goto || createGoto(gotoOpts)
 
-  return page =>
-    async (url, { margin = '0.35cm', scale = 0.65, printBackground = true, ...opts } = {}) => {
-      await goto(page, { ...opts, url })
+  return function pdf (page) {
+    return async (
+      url,
+      { margin = '0.35cm', scale = 0.65, printBackground = true, waitUntil = 'auto', ...opts } = {}
+    ) => {
+      let pdfBuffer
 
-      return page.pdf({
-        ...opts,
-        margin: getMargin(margin),
-        printBackground,
-        scale
-      })
+      const generatePdf = page =>
+        page.pdf({
+          ...opts,
+          margin: getMargin(margin),
+          printBackground,
+          scale
+        })
+
+      const timePdf = timeSpan()
+
+      if (waitUntil !== 'auto') {
+        await goto(page, { ...opts, url, waitUntil })
+        pdfBuffer = await generatePdf(page)
+      } else {
+        await goto(page, { ...opts, url, waitUntil, waitUntilAuto })
+        async function waitUntilAuto (page) {
+          let isWhite = false
+          let retryCount = 0
+          const maxRetries = 3
+
+          do {
+            const screenshotResult = await takeScreenshot({ page, goto, opts })
+            isWhite = screenshotResult.isWhite
+
+            if (isWhite && retryCount < maxRetries) {
+              retryCount++
+              debug('screenshot:retry', { waitUntil, isWhite, retryCount, maxRetries })
+              await goto.waitUntilAuto(page, { timeout: opts.timeout })
+            }
+          } while (isWhite && retryCount < maxRetries)
+
+          pdfBuffer = await generatePdf(page)
+          debug('screenshot', { waitUntil, isWhite, retryCount, duration: timePdf() })
+        }
+      }
+
+      return pdfBuffer
     }
+  }
 }