@applitools/eyes-storybook 3.29.3 → 3.29.4

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 ## Unreleased
 
 
+## 3.29.4 - 2022/9/12
+
+### Features
+### Bug fixes
+- Prevent Eyes-Storybook from hanging when there is a failure to take DOM
+
 ## 3.29.3 - 2022/8/18
 
 ### Features

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-storybook",
-  "version": "3.29.3",
+  "version": "3.29.4",
   "description": "",
   "keywords": [
     "applitools",
@@ -70,15 +70,15 @@
     }
   },
   "dependencies": {
-    "@applitools/driver": "1.9.21",
-    "@applitools/eyes-sdk-core": "13.8.22",
+    "@applitools/driver": "1.9.26",
+    "@applitools/eyes-sdk-core": "13.8.26",
     "@applitools/functional-commons": "1.6.0",
     "@applitools/logger": "1.1.16",
     "@applitools/monitoring-commons": "1.0.19",
     "@applitools/spec-driver-puppeteer": "1.1.8",
     "@applitools/test-server": "1.1.4",
     "@applitools/utils": "1.3.10",
-    "@applitools/visual-grid-client": "15.13.16",
+    "@applitools/visual-grid-client": "15.13.21",
     "boxen": "4.2.0",
     "chalk": "3.0.0",
     "detect-port": "1.3.0",
@@ -90,7 +90,7 @@
     "yargs": "15.4.1"
   },
   "devDependencies": {
-    "@applitools/bongo": "^2.1.6",
+    "@applitools/bongo": "^2.2.0",
     "@applitools/scripts": "^1.1.0",
     "@applitools/sdk-shared": "0.9.13",
     "@applitools/snaptdout": "^1.0.1",

package/src/getStoryData.js

@@ -8,6 +8,7 @@ const {URL} = require('url');
 const runRunAfterScript = require('../dist/runRunAfterScript');
 const waitFor = require('./waitFor');
 const PAGE_EVALUATE_TIMEOUT = 120000;
+const DOM_SNAPSHOTS_TIMEOUT = 5 * 60 * 1000;
 
 function makeGetStoryData({logger, takeDomSnapshots, waitBeforeCapture, reloadPagePerStory}) {
   return async function getStoryData({story, storyUrl, page, browser, waitBeforeStory}) {
@@ -23,9 +24,9 @@ function makeGetStoryData({logger, takeDomSnapshots, waitBeforeCapture, reloadPa
           const err = await ptimeoutWithError(
             page.evaluate(renderStoryWithClientAPI, story.index),
             PAGE_EVALUATE_TIMEOUT,
-            'page evaluate timed out!',
+            new Error('page evaluate timed out!'),
           );
-          logger.log(`[story data] done with page evaluate for story index: ${story.index}`);
+          logger.log(`[story data] done with page evaluate for story ${title}`);
           err && handleRenderStoryError(err);
         } catch (ex) {
           if (ex.message && !ex.message.includes('Eyes could not render stories properly'))
@@ -59,7 +60,7 @@ function makeGetStoryData({logger, takeDomSnapshots, waitBeforeCapture, reloadPa
 
     logger.log(`running takeDomSnapshot(s) for story ${title}`);
 
-    const result = await takeDomSnapshots({
+    const domSnapshotsPromise = takeDomSnapshots({
       page,
       browser,
       layoutBreakpoints: eyesParameters ? eyesParameters.layoutBreakpoints : undefined,
@@ -71,6 +72,14 @@ function makeGetStoryData({logger, takeDomSnapshots, waitBeforeCapture, reloadPa
         : undefined,
     });
 
+    const result = await ptimeoutWithError(
+      domSnapshotsPromise,
+      DOM_SNAPSHOTS_TIMEOUT,
+      new Error(`timeout reached when trying to take DOM for story ${title}`),
+    );
+
+    logger.log(`done getting DOM for story ${title}`);
+
     if (eyesParameters && eyesParameters.runAfter) {
       await page.evaluate(runRunAfterScript, story.index).catch(err => {
         logger.log(`error during runAfter: ${err}`);

package/src/renderStories.js

@@ -75,7 +75,12 @@ function makeRenderStories({
             }),
           );
 
-          if (error && /(Protocol error|Execution context was destroyed)/.test(error.message)) {
+          if (
+            error &&
+            /(Protocol error|Execution context was destroyed|timeout reached when trying to take DOM for story)/.test(
+              error.message,
+            )
+          ) {
             logger.log(
               `Puppeteer error from [page ${pageId}] while getting story data. Replacing page. ${error.message}`,
             );