@browserless/screenshot 13.1.6 → 13.1.7

package/package.json

@@ -2,7 +2,7 @@
   "name": "@browserless/screenshot",
   "description": "Capture high-quality screenshots of websites with overlay support, device emulation, and automated image optimization.",
   "homepage": "https://browserless.js.org/#/?id=screenshoturl-options",
-  "version": "13.1.6",
+  "version": "13.1.7",
   "main": "src/index.js",
   "author": {
     "email": "hello@microlink.io",
@@ -32,7 +32,8 @@
     "web-capture"
   ],
   "dependencies": {
-    "@browserless/goto": "13.1.6",
+    "@browserless/errors": "13.1.7",
+    "@browserless/goto": "13.1.7",
     "@kikobeats/content-type": "~1.0.4",
     "@kikobeats/time-span": "~1.0.12",
     "automad-prism-themes": "~0.3.7",
@@ -51,7 +52,7 @@
     "svg-gradient": "~1.0.4"
   },
   "devDependencies": {
-    "@browserless/test": "13.1.6",
+    "@browserless/test": "13.1.7",
     "ava": "5"
   },
   "engines": {
@@ -70,5 +71,5 @@
     "timeout": "2m",
     "workerThreads": false
   },
-  "gitHead": "6e72f371de1e8515b309b9a22e7632a564af27b0"
+  "gitHead": "cb9a0c6fc11176da209ba9bc33bca5a47c3aabbe"
 }

package/src/index.js

@@ -1,18 +1,34 @@
 'use strict'
 
 const debug = require('debug-logfmt')('browserless:screenshot')
+const { isContextDestroyed } = require('@browserless/errors')
 const createGoto = require('@browserless/goto')
 const pReflect = require('p-reflect')
 
 const isWhiteScreenshot = require('./is-white-screenshot')
 const waitForPrism = require('./pretty')
-const timeSpan = require('./time-span')
+const prettyTimeSpan = require('./time-span')
 const overlay = require('./overlay')
 const { waitForDomStability, resolveWaitForDom, DEFAULT_WAIT_FOR_DOM } = require('./wait-for-dom')
 
-const createElapsed = () => {
-  const start = Date.now()
-  return () => Date.now() - start
+const timeSpan = require('@kikobeats/time-span')()
+
+// Retry a page capture (screenshot/pdf) that races with a client-side
+// navigation. When the execution context is destroyed mid-capture, the page is
+// navigating: wait for it to settle via `waitUntilAuto` and retry in-place,
+// bounded by `timeout`, rather than failing the whole request. SPAs (e.g.
+// scribd) navigate client-side after load, so the initial capture often races.
+const captureWithNavigationRetry = async (capture, { page, goto, timeout }) => {
+  const elapsed = timeSpan()
+  while (true) {
+    try {
+      return await capture()
+    } catch (error) {
+      if (!isContextDestroyed(error) || elapsed() >= timeout) throw error
+      debug('captureWithNavigationRetry', { error: error.message })
+      await goto.waitUntilAuto(page, { timeout })
+    }
+  }
 }
 
 const getPageSnapshot = page =>
@@ -170,13 +186,17 @@ module.exports = ({ goto, ...gotoOpts }) => {
 
       const takeScreenshot = async opts => {
         const timeout = goto.timeouts.action(opts.timeout)
-        const elapsed = createElapsed()
+        const elapsed = timeSpan()
         let retry = 0
         let isWhite = false
         let isReady = false
 
         do {
-          screenshot = await page.screenshot(opts)
+          screenshot = await captureWithNavigationRetry(() => page.screenshot(opts), {
+            page,
+            goto,
+            timeout
+          })
           isWhite = await isWhiteScreenshot(screenshot)
           const snapshotResult = await pReflect(getPageSnapshot(page))
           const pageSnapshot = snapshotResult.isRejected ? {} : snapshotResult.value
@@ -205,12 +225,15 @@ module.exports = ({ goto, ...gotoOpts }) => {
       page.on('dialog', onDialog)
 
       try {
-        const timeScreenshot = timeSpan()
+        const timeScreenshot = prettyTimeSpan()
 
         if (waitUntil !== 'auto') {
           ;({ response } = await goto(page, { ...opts, url, waitUntil }))
           const screenshotOpts = await beforeScreenshot(page, response, opts)
-          screenshot = await page.screenshot({ ...opts, ...screenshotOpts })
+          screenshot = await captureWithNavigationRetry(
+            () => page.screenshot({ ...opts, ...screenshotOpts }),
+            { page, goto, timeout: goto.timeouts.action(opts.timeout) }
+          )
           debug('screenshot', { waitUntil, duration: timeScreenshot() })
         } else {
           ;({ response } = await goto(page, { ...opts, url, waitUntil, waitUntilAuto }))
@@ -242,6 +265,7 @@ module.exports = ({ goto, ...gotoOpts }) => {
   }
 }
 
+module.exports.captureWithNavigationRetry = captureWithNavigationRetry
 module.exports.isWhiteScreenshot = isWhiteScreenshot
 module.exports.waitForDomStability = waitForDomStability
 module.exports.resolveWaitForDom = resolveWaitForDom