@applitools/eyes-storybook 3.25.2 → 3.25.3

package/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+ ## 3.25.3 - 2021/11/1
+
+ - add a retry machanisem for cases we get 0 stories
 
 ## 3.25.2 - 2021/10/30
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-storybook",
-  "version": "3.25.2",
+  "version": "3.25.3",
   "description": "",
   "engines": {
     "node": ">=8.6.0"
@@ -25,10 +25,12 @@
     "storybook": "start-storybook -c test/fixtures/appWithStorybook -p 9001 -s test/fixtures",
     "storybook:jslayout": "start-storybook -c test/fixtures/jsLayoutStorybookLocal -p 9001 -s test/fixtures",
     "storybook:heavy": "start-storybook -c test/fixtures/heavyStorybook -p 9002 -s test/fixtures",
+    "storybook:zeroStories": "start-storybook -c test/fixtures/zeroStoriesRetry -p 9003 -s test/fixtures",
     "eyes-storybook": "node bin/eyes-storybook.js -f test/fixtures/applitools.config.js",
     "eyes-storybook:jslayout": "node bin/eyes-storybook.js -f test/e2e/happy-config/layout-breakpoints-local.config.js",
     "eyes-storybook:heavy": "node bin/eyes-storybook.js -f test/fixtures/heavyStorybook/applitools.config.js",
     "eyes-storybook:configured": "node bin/eyes-storybook.js -f scripts/preconfigured.config.js",
+    "eyes-storybook:zeroStories": "node bin/eyes-storybook.js -f test/fixtures/zeroStoriesRetry/applitools.config.js",
     "changelog": "git changelog -x -p -f v$npm_package_version > History.md && git add ./History.md && git commit -am 'changelog'",
     "changelog:init": "git config changelog.format \"* %s [[%h]($(echo $npm_package_repository_url|cut -d+ -f2|cut -d. -f1-2)/commit/%H)]\"",
     "changelog:install": "sudo apt-get install git-extras",

package/src/eyesStorybook.js

@@ -2,7 +2,7 @@
 const puppeteer = require('puppeteer');
 const getStories = require('../dist/getStories');
 const {makeVisualGridClient} = require('@applitools/visual-grid-client');
-const {presult} = require('@applitools/functional-commons');
+const {presult, delay} = require('@applitools/functional-commons');
 const chalk = require('./chalkify');
 const makeInitPage = require('./initPage');
 const makeRenderStory = require('./renderStory');
@@ -24,6 +24,8 @@ const {splitConfigsByBrowser} = require('./shouldRenderIE');
 const executeRenders = require('./executeRenders');
 
 const CONCURRENT_PAGES = 3;
+const MAX_RETRIES = 10;
+const RETRY_INTERVAL = 1000;
 
 async function eyesStorybook({
   config,
@@ -203,9 +205,9 @@ async function eyesStorybook({
       spinner.fail(failMsg);
       throw new Error();
     }
-    const [getStoriesErr, stories] = await presult(
-      page.evaluate(getStories, {timeout: readStoriesTimeout}),
-    );
+
+    const [getStoriesErr, stories] = await readStoriesWithRetry(MAX_RETRIES);
+
     if (getStoriesErr) {
       logger.log('Error in getStories:', getStoriesErr);
       const failMsg = refineErrorMessage({
@@ -257,6 +259,19 @@ async function eyesStorybook({
   function getTransitiongIntoIE() {
     return transitioning;
   }
+
+  async function readStoriesWithRetry(remainingRetries) {
+    const [getStoriesErr, stories] = await presult(
+      page.evaluate(getStories, {timeout: readStoriesTimeout}),
+    );
+    if (getStoriesErr || stories.length > 0 || remainingRetries == 0) {
+      return [getStoriesErr, stories];
+    } else {
+      logger.log(`Got 0 stories, retrying to read stories... ${remainingRetries - 1} are left`);
+      await delay(RETRY_INTERVAL);
+      return await readStoriesWithRetry(remainingRetries - 1);
+    }
+  }
 }
 
 module.exports = eyesStorybook;