@applitools/eyes-storybook 3.53.5 → 3.53.7

package/CHANGELOG.md

@@ -1,5 +1,85 @@
 # Changelog
 
+## [3.53.7](https://github.com/Applitools-Dev/sdk/compare/js/eyes-storybook@3.53.6...js/eyes-storybook@3.53.7) (2025-02-10)
+
+
+### Bug Fixes
+
+* remove deprecated postinstall script ([#2729](https://github.com/Applitools-Dev/sdk/issues/2729)) ([28075c1](https://github.com/Applitools-Dev/sdk/commit/28075c10342c1e169040ac8b720f5c273bc9bf31))
+* respect readStoriesTimeout ([#2776](https://github.com/Applitools-Dev/sdk/issues/2776)) ([8c841f4](https://github.com/Applitools-Dev/sdk/commit/8c841f492641759f056af889dbac68e711782b26))
+
+
+### Dependencies
+
+* @applitools/ufg-client bumped to 1.16.4
+  #### Bug Fixes
+
+  * environment without type in ios should be considered web ([#2779](https://github.com/Applitools-Dev/sdk/issues/2779)) ([1a0dc18](https://github.com/Applitools-Dev/sdk/commit/1a0dc186d782ee8dacccf4ea9d10b513416b7492))
+  * specifying chrome version in UFG chrome emulations ([#2773](https://github.com/Applitools-Dev/sdk/issues/2773)) ([e86af5d](https://github.com/Applitools-Dev/sdk/commit/e86af5d8d616fb54a6cbe0a23db691d0b190b0f6))
+* @applitools/core bumped to 4.31.2
+  #### Bug Fixes
+
+  * environment without type in ios should be considered web ([#2779](https://github.com/Applitools-Dev/sdk/issues/2779)) ([1a0dc18](https://github.com/Applitools-Dev/sdk/commit/1a0dc186d782ee8dacccf4ea9d10b513416b7492))
+  * move log line for closing batch in offline cli ([#2768](https://github.com/Applitools-Dev/sdk/issues/2768)) ([bfb51a9](https://github.com/Applitools-Dev/sdk/commit/bfb51a94d8e7d51020aac62dd78038fdeb819a68))
+
+
+
+* @applitools/eyes bumped to 1.32.1
+
+
+## [3.53.6](https://github.com/Applitools-Dev/sdk/compare/js/eyes-storybook@3.53.5...js/eyes-storybook@3.53.6) (2025-01-30)
+
+
+### Bug Fixes
+
+* storybook exception and add logs ([#2760](https://github.com/Applitools-Dev/sdk/issues/2760)) ([357193a](https://github.com/Applitools-Dev/sdk/commit/357193ad0f18eae729b4064d14d781e2401c70f7))
+
+
+### Dependencies
+
+* @applitools/dom-snapshot bumped to 4.11.15
+
+* @applitools/driver bumped to 1.20.4
+  #### Bug Fixes
+
+  * handle device screen info extraction gracefully ([#2757](https://github.com/Applitools-Dev/sdk/issues/2757)) ([92d0118](https://github.com/Applitools-Dev/sdk/commit/92d0118137b77e49d780092d110973df8ed8b40c))
+* @applitools/eyes bumped to 1.32.0
+  #### Features
+
+  * remove iPhoneX from list of available UFG Safari devices ([#2756](https://github.com/Applitools-Dev/sdk/issues/2756)) ([e24d054](https://github.com/Applitools-Dev/sdk/commit/e24d054328df900fbc4988fdbf8213aadffa9a37))
+
+
+
+* @applitools/spec-driver-webdriver bumped to 1.1.25
+
+* @applitools/spec-driver-selenium bumped to 1.5.95
+
+* @applitools/spec-driver-puppeteer bumped to 1.4.24
+
+* @applitools/screenshoter bumped to 3.10.5
+
+* @applitools/nml-client bumped to 1.8.24
+
+* @applitools/ufg-client bumped to 1.16.3
+  #### Bug Fixes
+
+  * unthrottle renders in offline mode ([#2754](https://github.com/Applitools-Dev/sdk/issues/2754)) ([b65d816](https://github.com/Applitools-Dev/sdk/commit/b65d81610504ae725b7b52611282a1bb28a049fe))
+* @applitools/ec-client bumped to 1.10.3
+
+* @applitools/core bumped to 4.31.0
+  #### Features
+
+  * remove iPhoneX from list of available UFG Safari devices ([#2756](https://github.com/Applitools-Dev/sdk/issues/2756)) ([e24d054](https://github.com/Applitools-Dev/sdk/commit/e24d054328df900fbc4988fdbf8213aadffa9a37))
+
+
+  #### Bug Fixes
+
+  * handle device screen info extraction gracefully ([#2757](https://github.com/Applitools-Dev/sdk/issues/2757)) ([92d0118](https://github.com/Applitools-Dev/sdk/commit/92d0118137b77e49d780092d110973df8ed8b40c))
+  * unthrottle renders in offline mode ([#2754](https://github.com/Applitools-Dev/sdk/issues/2754)) ([b65d816](https://github.com/Applitools-Dev/sdk/commit/b65d81610504ae725b7b52611282a1bb28a049fe))
+
+
+
+
 ## [3.53.5](https://github.com/Applitools-Dev/sdk/compare/js/eyes-storybook@3.53.4...js/eyes-storybook@3.53.5) (2025-01-23)
 
 

package/dist/getClientAPI.js

@@ -38,7 +38,16 @@ function __getClientAPI(...args) {
       ) {
         return API_VERSIONS.v4;
       } else {
-        throw new Error("Cannot get client API: couldn't detect storybook version");
+        const storybookVariablesOnWindow = Object.keys(frameWindow).filter(key =>
+          key.includes('STORYBOOK'),
+        );
+        throw new Error(
+          `Cannot get client API: couldn't detect storybook version.${
+          storybookVariablesOnWindow.length
+            ? ` Found the following storybook variables: ${storybookVariablesOnWindow.join(', ')}`
+            : ' - no STORYBOOK variables found in global scope'
+        }`,
+        );
       }
     }
     function onStoryRendered(callback) {
@@ -181,13 +190,18 @@ function __getClientAPI(...args) {
     throw new Error('Cannot get client API: no frameWindow');
   }
 
-  async function getClientAPIWithRetries() {
+  async function getClientAPIWithRetries({timeout = 5000} = {}) {
     let error = 'Unknown error';
-    for (let attempt = 1; attempt <= 100; attempt++) {
-      await new Promise(resolve => setTimeout(resolve, 100));
+    const RETRY_INTERVAL = 100;
+    const totalAttempts = timeout / RETRY_INTERVAL;
+    for (let attempt = 1; attempt <= totalAttempts; attempt++) {
+      await new Promise(resolve => setTimeout(resolve, RETRY_INTERVAL));
       try {
         return getClientAPI();
       } catch (e) {
+        if (!(attempt % 10)) {
+          console.log(`Error in getClientAPI: ${e.message}, attempt ${attempt}/${totalAttempts}`);
+        }
         error = e;
       }
     }

package/dist/getStories.js

@@ -38,7 +38,16 @@ function __getStories(...args) {
       ) {
         return API_VERSIONS.v4;
       } else {
-        throw new Error("Cannot get client API: couldn't detect storybook version");
+        const storybookVariablesOnWindow = Object.keys(frameWindow).filter(key =>
+          key.includes('STORYBOOK'),
+        );
+        throw new Error(
+          `Cannot get client API: couldn't detect storybook version.${
+          storybookVariablesOnWindow.length
+            ? ` Found the following storybook variables: ${storybookVariablesOnWindow.join(', ')}`
+            : ' - no STORYBOOK variables found in global scope'
+        }`,
+        );
       }
     }
     function onStoryRendered(callback) {
@@ -181,13 +190,18 @@ function __getStories(...args) {
     throw new Error('Cannot get client API: no frameWindow');
   }
 
-  async function getClientAPIWithRetries() {
+  async function getClientAPIWithRetries({timeout = 5000} = {}) {
     let error = 'Unknown error';
-    for (let attempt = 1; attempt <= 100; attempt++) {
-      await new Promise(resolve => setTimeout(resolve, 100));
+    const RETRY_INTERVAL = 100;
+    const totalAttempts = timeout / RETRY_INTERVAL;
+    for (let attempt = 1; attempt <= totalAttempts; attempt++) {
+      await new Promise(resolve => setTimeout(resolve, RETRY_INTERVAL));
       try {
         return getClientAPI();
       } catch (e) {
+        if (!(attempt % 10)) {
+          console.log(`Error in getClientAPI: ${e.message}, attempt ${attempt}/${totalAttempts}`);
+        }
         error = e;
       }
     }
@@ -196,9 +210,7 @@ function __getStories(...args) {
 
   var getClientAPI_1 = getClientAPIWithRetries;
 
-  const DEFAULT_TIMEOUT = 60000;
-
-  async function getStories({timeout = DEFAULT_TIMEOUT} = {timeout: DEFAULT_TIMEOUT}) {
+  async function getStories() {
     const Stories = {
       _getStoriesV2: () => {
         let categories = getCategoriesV2();
@@ -283,7 +295,7 @@ function __getStories(...args) {
       },
     };
 
-    const clientApi = await waitForClientAPI();
+    const clientApi = await getClientAPI_1().catch(() => null);
 
     if (clientApi) {
       console.log(`getting stories from storybook via API. ${clientApi.version}`);
@@ -362,36 +374,6 @@ function __getStories(...args) {
         s => s.innerText === 'loading story',
       );
     }
-
-    function waitForClientAPI() {
-      return ptimeoutWithValue(_waitForClientAPI, timeout, undefined);
-
-      async function _waitForClientAPI() {
-        try {
-          return getClientAPI_1();
-        } catch (ex) {
-          await delay(100);
-          return _waitForClientAPI();
-        }
-      }
-    }
-
-    async function delay(time) {
-      return new Promise(res => {
-        setTimeout(res, time);
-      });
-    }
-
-    async function ptimeoutWithValue(getPromise, delay, value) {
-      let _res, _rej;
-      const result = new Promise((res, rej) => ((_res = res), (_rej = rej)));
-      const cancel = setTimeout(() => _res(value), delay);
-      getPromise()
-        .then(v => _res(v))
-        .catch(e => _rej(e))
-        .finally(() => clearTimeout(cancel));
-      return result;
-    }
   }
 
   var getStories_1 = getStories;

package/dist/renderStoryWithClientAPI.js

@@ -38,7 +38,16 @@ function __renderStoryWithClientAPI(...args) {
       ) {
         return API_VERSIONS.v4;
       } else {
-        throw new Error("Cannot get client API: couldn't detect storybook version");
+        const storybookVariablesOnWindow = Object.keys(frameWindow).filter(key =>
+          key.includes('STORYBOOK'),
+        );
+        throw new Error(
+          `Cannot get client API: couldn't detect storybook version.${
+          storybookVariablesOnWindow.length
+            ? ` Found the following storybook variables: ${storybookVariablesOnWindow.join(', ')}`
+            : ' - no STORYBOOK variables found in global scope'
+        }`,
+        );
       }
     }
     function onStoryRendered(callback) {
@@ -181,13 +190,18 @@ function __renderStoryWithClientAPI(...args) {
     throw new Error('Cannot get client API: no frameWindow');
   }
 
-  async function getClientAPIWithRetries() {
+  async function getClientAPIWithRetries({timeout = 5000} = {}) {
     let error = 'Unknown error';
-    for (let attempt = 1; attempt <= 100; attempt++) {
-      await new Promise(resolve => setTimeout(resolve, 100));
+    const RETRY_INTERVAL = 100;
+    const totalAttempts = timeout / RETRY_INTERVAL;
+    for (let attempt = 1; attempt <= totalAttempts; attempt++) {
+      await new Promise(resolve => setTimeout(resolve, RETRY_INTERVAL));
       try {
         return getClientAPI();
       } catch (e) {
+        if (!(attempt % 10)) {
+          console.log(`Error in getClientAPI: ${e.message}, attempt ${attempt}/${totalAttempts}`);
+        }
         error = e;
       }
     }

package/dist/runRunAfterScript.js

@@ -38,7 +38,16 @@ function __runRunAfterScript(...args) {
       ) {
         return API_VERSIONS.v4;
       } else {
-        throw new Error("Cannot get client API: couldn't detect storybook version");
+        const storybookVariablesOnWindow = Object.keys(frameWindow).filter(key =>
+          key.includes('STORYBOOK'),
+        );
+        throw new Error(
+          `Cannot get client API: couldn't detect storybook version.${
+          storybookVariablesOnWindow.length
+            ? ` Found the following storybook variables: ${storybookVariablesOnWindow.join(', ')}`
+            : ' - no STORYBOOK variables found in global scope'
+        }`,
+        );
       }
     }
     function onStoryRendered(callback) {
@@ -181,13 +190,18 @@ function __runRunAfterScript(...args) {
     throw new Error('Cannot get client API: no frameWindow');
   }
 
-  async function getClientAPIWithRetries() {
+  async function getClientAPIWithRetries({timeout = 5000} = {}) {
     let error = 'Unknown error';
-    for (let attempt = 1; attempt <= 100; attempt++) {
-      await new Promise(resolve => setTimeout(resolve, 100));
+    const RETRY_INTERVAL = 100;
+    const totalAttempts = timeout / RETRY_INTERVAL;
+    for (let attempt = 1; attempt <= totalAttempts; attempt++) {
+      await new Promise(resolve => setTimeout(resolve, RETRY_INTERVAL));
       try {
         return getClientAPI();
       } catch (e) {
+        if (!(attempt % 10)) {
+          console.log(`Error in getClientAPI: ${e.message}, attempt ${attempt}/${totalAttempts}`);
+        }
         error = e;
       }
     }

package/dist/runRunBeforeScript.js

@@ -38,7 +38,16 @@ function __runRunBeforeScript(...args) {
       ) {
         return API_VERSIONS.v4;
       } else {
-        throw new Error("Cannot get client API: couldn't detect storybook version");
+        const storybookVariablesOnWindow = Object.keys(frameWindow).filter(key =>
+          key.includes('STORYBOOK'),
+        );
+        throw new Error(
+          `Cannot get client API: couldn't detect storybook version.${
+          storybookVariablesOnWindow.length
+            ? ` Found the following storybook variables: ${storybookVariablesOnWindow.join(', ')}`
+            : ' - no STORYBOOK variables found in global scope'
+        }`,
+        );
       }
     }
     function onStoryRendered(callback) {
@@ -181,13 +190,18 @@ function __runRunBeforeScript(...args) {
     throw new Error('Cannot get client API: no frameWindow');
   }
 
-  async function getClientAPIWithRetries() {
+  async function getClientAPIWithRetries({timeout = 5000} = {}) {
     let error = 'Unknown error';
-    for (let attempt = 1; attempt <= 100; attempt++) {
-      await new Promise(resolve => setTimeout(resolve, 100));
+    const RETRY_INTERVAL = 100;
+    const totalAttempts = timeout / RETRY_INTERVAL;
+    for (let attempt = 1; attempt <= totalAttempts; attempt++) {
+      await new Promise(resolve => setTimeout(resolve, RETRY_INTERVAL));
       try {
         return getClientAPI();
       } catch (e) {
+        if (!(attempt % 10)) {
+          console.log(`Error in getClientAPI: ${e.message}, attempt ${attempt}/${totalAttempts}`);
+        }
         error = e;
       }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-storybook",
-  "version": "3.53.5",
+  "version": "3.53.7",
   "description": "",
   "keywords": [
     "applitools",
@@ -50,18 +50,17 @@
     "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",
-    "postinstall": "node src/postinstall",
     "up:framework": "cd test/fixtures/storybook-versions/${APPLITOOLS_FRAMEWORK_VERSION} && npm ci"
   },
   "dependencies": {
-    "@applitools/core": "4.30.1",
-    "@applitools/driver": "1.20.3",
-    "@applitools/eyes": "1.31.3",
+    "@applitools/core": "4.31.2",
+    "@applitools/driver": "1.20.4",
+    "@applitools/eyes": "1.32.1",
     "@applitools/functional-commons": "1.6.0",
     "@applitools/logger": "2.1.0",
     "@applitools/monitoring-commons": "1.0.19",
-    "@applitools/spec-driver-puppeteer": "1.4.23",
-    "@applitools/ufg-client": "1.16.2",
+    "@applitools/spec-driver-puppeteer": "1.4.24",
+    "@applitools/ufg-client": "1.16.4",
     "@applitools/utils": "1.7.7",
     "boxen": "4.2.0",
     "chalk": "3.0.0",

package/src/browser/getClientAPI.js

@@ -35,7 +35,16 @@ function getClientAPI() {
     ) {
       return API_VERSIONS.v4;
     } else {
-      throw new Error("Cannot get client API: couldn't detect storybook version");
+      const storybookVariablesOnWindow = Object.keys(frameWindow).filter(key =>
+        key.includes('STORYBOOK'),
+      );
+      throw new Error(
+        `Cannot get client API: couldn't detect storybook version.${
+          storybookVariablesOnWindow.length
+            ? ` Found the following storybook variables: ${storybookVariablesOnWindow.join(', ')}`
+            : ' - no STORYBOOK variables found in global scope'
+        }`,
+      );
     }
   }
   function onStoryRendered(callback) {
@@ -178,13 +187,18 @@ function getFrameWindow() {
   throw new Error('Cannot get client API: no frameWindow');
 }
 
-async function getClientAPIWithRetries() {
+async function getClientAPIWithRetries({timeout = 5000} = {}) {
   let error = 'Unknown error';
-  for (let attempt = 1; attempt <= 100; attempt++) {
-    await new Promise(resolve => setTimeout(resolve, 100));
+  const RETRY_INTERVAL = 100;
+  const totalAttempts = timeout / RETRY_INTERVAL;
+  for (let attempt = 1; attempt <= totalAttempts; attempt++) {
+    await new Promise(resolve => setTimeout(resolve, RETRY_INTERVAL));
     try {
       return getClientAPI();
     } catch (e) {
+      if (!(attempt % 10)) {
+        console.log(`Error in getClientAPI: ${e.message}, attempt ${attempt}/${totalAttempts}`);
+      }
       error = e;
     }
   }

package/src/browser/getStories.js

@@ -1,8 +1,6 @@
 const getClientAPI = require('./getClientAPI');
 
-const DEFAULT_TIMEOUT = 60000;
-
-async function getStories({timeout = DEFAULT_TIMEOUT} = {timeout: DEFAULT_TIMEOUT}) {
+async function getStories() {
   const Stories = {
     _getStoriesV2: () => {
       let categories = getCategoriesV2();
@@ -87,7 +85,7 @@ async function getStories({timeout = DEFAULT_TIMEOUT} = {timeout: DEFAULT_TIMEOU
     },
   };
 
-  const clientApi = await waitForClientAPI();
+  const clientApi = await getClientAPI().catch(() => null);
 
   if (clientApi) {
     console.log(`getting stories from storybook via API. ${clientApi.version}`);
@@ -166,36 +164,6 @@ async function getStories({timeout = DEFAULT_TIMEOUT} = {timeout: DEFAULT_TIMEOU
       s => s.innerText === 'loading story',
     );
   }
-
-  function waitForClientAPI() {
-    return ptimeoutWithValue(_waitForClientAPI, timeout, undefined);
-
-    async function _waitForClientAPI() {
-      try {
-        return getClientAPI();
-      } catch (ex) {
-        await delay(100);
-        return _waitForClientAPI();
-      }
-    }
-  }
-
-  async function delay(time) {
-    return new Promise(res => {
-      setTimeout(res, time);
-    });
-  }
-
-  async function ptimeoutWithValue(getPromise, delay, value) {
-    let _res, _rej;
-    const result = new Promise((res, rej) => ((_res = res), (_rej = rej)));
-    const cancel = setTimeout(() => _res(value), delay);
-    getPromise()
-      .then(v => _res(v))
-      .catch(e => _rej(e))
-      .finally(() => clearTimeout(cancel));
-    return result;
-  }
 }
 
 module.exports = getStories;

package/src/configParams.js

@@ -43,6 +43,7 @@ const configParams = [
   'notifyOnCompletion',
   'batchNotify',
   'dontCloseBatches',
+  'showBrowserLogs',
 ];
 
 module.exports = {configParams};

package/src/eyesStorybook.js

@@ -1,7 +1,8 @@
 'use strict';
 const puppeteer = require('puppeteer');
 const getStories = require('../dist/getStories');
-const {presult, delay} = require('@applitools/functional-commons');
+const {presult} = require('@applitools/functional-commons');
+const {executeWithRetry} = require('./utils/executeWithRetry');
 const chalk = require('chalk');
 const makeInitPage = require('./initPage');
 const makeRenderStory = require('./renderStory');
@@ -23,9 +24,6 @@ const {extractEnvironment} = require('./extractEnvironment');
 const {makeCore} = require('@applitools/core');
 const makeGetStoriesWithConfig = require('./getStoriesWithConfig');
 
-const MAX_RETRIES = 30;
-const RETRY_INTERVAL = 1000;
-
 async function eyesStorybook({
   config,
   logger,
@@ -166,7 +164,7 @@ async function eyesStorybook({
     const renderStories = makeRenderStories({
       getStoryData,
       renderStory,
-      getClientAPI,
+      sanityCheckForPage,
       storybookUrl,
       logger,
       stream: outputStream,
@@ -234,10 +232,10 @@ async function eyesStorybook({
       throw new Error();
     }
 
-    const [getStoriesErr, stories] = await readStoriesWithRetry(MAX_RETRIES);
+    const [getStoriesErr, stories] = await presult(readStoriesWithRetry());
 
     if (getStoriesErr) {
-      logger.log('Error in getStories:', getStoriesErr);
+      logger.log('Error when reading stories:', getStoriesErr);
       const failMsg = refineErrorMessage({
         prefix: 'Error when reading stories:',
         error: getStoriesErr,
@@ -283,20 +281,46 @@ async function eyesStorybook({
     return transitioning;
   }
 
-  async function readStoriesWithRetry(remainingRetries) {
-    const [getStoriesErr, stories] = await presult(
-      page.evaluate(getStories, {timeout: readStoriesTimeout}),
+  async function readStoriesWithRetry() {
+    return executeWithRetry(
+      _readStoriesWithRetry,
+      {
+        timeout: readStoriesTimeout,
+        delayBetweenRetries: 1000,
+        initialErrMessage: `Could not get stories since readStoriesTimeout is too short (${readStoriesTimeout}ms)`,
+      },
+      readStoriesTimeout,
     );
-    if (stories?.length > 0 || remainingRetries == 0) {
-      return [getStoriesErr, stories];
-    } else {
-      if (getStoriesErr) {
-        logger.log('Error in getStories:', getStoriesErr);
-      } else {
-        logger.log(`Got 0 stories, retrying to read stories... ${remainingRetries - 1} are left`);
+
+    async function _readStoriesWithRetry() {
+      try {
+        const stories = await page.evaluate(getStories);
+        if (stories.length > 0) {
+          return stories;
+        } else {
+          throw new Error('Got 0 stories');
+        }
+      } catch (err) {
+        logger.log('Error in _readStoriesWithRetry:', err, ', retrying...');
+        throw err;
+      }
+    }
+  }
+
+  async function sanityCheckForPage(page) {
+    return executeWithRetry(_sanityCheckForPage, {
+      timeout: readStoriesTimeout,
+      delayBetweenRetries: 1000,
+      initialErrMessage: `Could not get client API in sanity check since readStoriesTimeout is too short (${readStoriesTimeout}ms)`,
+    });
+
+    async function _sanityCheckForPage() {
+      try {
+        await page.evaluate(getClientAPI);
+      } catch (err) {
+        logger.log('Error in getClientAPI during sanity check:', err, ', retrying...');
+        throw err;
       }
-      await delay(RETRY_INTERVAL);
-      return await readStoriesWithRetry(remainingRetries - 1);
     }
   }
 }

package/src/getStoryData.js

@@ -13,9 +13,9 @@ const DOM_SNAPSHOTS_TIMEOUT = 5 * 60 * 1000;
 const utils = require('@applitools/utils');
 
 function makeGetStoryData({logger, takeDomSnapshots, reloadPagePerStory, navigationWaitUntil}) {
-  return async function getStoryData({story, storyUrl, page}) {
+  return async function getStoryData({story, storyUrl, page, pageId = 'mock'}) {
     const title = getStoryBaselineName(story);
-    logger.log(`getting data from story`, title);
+    logger.log(`[page ${pageId}] getting data from story`, title);
 
     const eyesParameters = story.parameters && story.parameters.eyes;
     if (story.isApi && !reloadPagePerStory) {
@@ -26,9 +26,9 @@ function makeGetStoryData({logger, takeDomSnapshots, reloadPagePerStory, navigat
           const err = await ptimeoutWithError(
             page.evaluate(renderStoryWithClientAPI, story.index, story.id),
             PAGE_EVALUATE_TIMEOUT,
-            new Error('page evaluate timed out!'),
+            new Error(`[page ${pageId}] page evaluate timed out!`),
           );
-          logger.log(`[story data] done with page evaluate for story ${title}`);
+          logger.log(`[page ${pageId}] done with page evaluate for story ${title}`);
           err && handleRenderStoryError(err);
         } catch (ex) {
           if (ex.message && !ex.message.includes('Eyes could not render stories properly'))
@@ -53,17 +53,17 @@ function makeGetStoryData({logger, takeDomSnapshots, reloadPagePerStory, navigat
 
     if (eyesParameters && eyesParameters.runBefore) {
       await page.evaluate(runRunBeforeScript, story.index).catch(err => {
-        logger.log(`error during runBefore: ${err}`); // it might be good to aggregate these errors and output them at the end of the run
+        logger.log(`[page ${pageId}] error during runBefore: ${err}`); // it might be good to aggregate these errors and output them at the end of the run
       });
     }
 
-    logger.log(`running takeDomSnapshot(s) for story ${title}`);
+    logger.log(`[page ${pageId}] running takeDomSnapshot(s) for story ${title}`);
     const domSnapshotsPromise = takeDomSnapshots({
       page,
       ...storyToCheckSettings({story}),
       waitBeforeCapture: wait
         ? async () => {
-            logger.log(`waiting before screenshot of ${title} ${wait}`);
+            logger.log(`[page ${pageId}] waiting before screenshot of ${title} ${wait}`);
             await waitFor(page, wait);
           }
         : undefined,
@@ -72,27 +72,27 @@ function makeGetStoryData({logger, takeDomSnapshots, reloadPagePerStory, navigat
     const result = await ptimeoutWithError(
       domSnapshotsPromise,
       DOM_SNAPSHOTS_TIMEOUT,
-      new Error(`timeout reached when trying to take DOM for story ${title}`),
+      new Error(`[page ${pageId}] timeout reached when trying to take DOM for story ${title}`),
     );
 
-    logger.log(`done getting DOM for story ${title}`);
+    logger.log(`[page ${pageId}] done getting DOM for story ${title}`);
 
     if (eyesParameters && eyesParameters.runAfter) {
       await page.evaluate(runRunAfterScript, story.index).catch(err => {
-        logger.log(`error during runAfter: ${err}`);
+        logger.log(`[page ${pageId}] error during runAfter: ${err}`);
       });
     }
 
-    logger.log(`done getting data from story`, title);
+    logger.log(`[page ${pageId}] done getting data from story`, title);
     return result;
 
     async function renderStoryLegacy() {
-      logger.log(`getting data from story ${storyUrl}`);
+      logger.log(`[page ${pageId}] getting data from story ${storyUrl}`);
       const [err] = await presult(
         page.goto(storyUrl, {timeout: PAGE_EVALUATE_TIMEOUT, waitUntil: navigationWaitUntil}),
       );
       if (err) {
-        logger.log(`error navigating to story ${storyUrl}`, err);
+        logger.log(`[page ${pageId}] error navigating to story ${storyUrl}`, err);
         throw err;
       }
     }
@@ -101,7 +101,7 @@ function makeGetStoryData({logger, takeDomSnapshots, reloadPagePerStory, navigat
       try {
         url = new URL(url);
       } catch (err) {
-        logger.error('Error during parsing page url', err);
+        logger.error(`[page ${pageId}] Error during parsing page url`, err);
         return false;
       }
 
@@ -124,7 +124,7 @@ function makeGetStoryData({logger, takeDomSnapshots, reloadPagePerStory, navigat
 
     // TODO (amit): handle this error in the caller (probably renderStories)
     function handleRenderStoryError(error) {
-      logger.log(error.message);
+      logger.log(`[page ${pageId}] ${error.message}`);
       const versionMsg = error.version
         ? ` The detected version of storybook is ${error.version}.`
         : '';

package/src/initPage.js

@@ -16,7 +16,9 @@ function makeInitPage({iframeUrl, config, browser, logger, getTransitiongIntoIE,
       browserLog({
         page,
         onLog: text => {
-          if (text.match(/\[dom-snapshot\]/)) {
+          if (config.showBrowserLogs) {
+            logger.log(`tab ${pageId}: ${text}`);
+          } else if (text.match(/\[dom-snapshot\]/)) {
             logger.log(`tab ${pageId}: ${text}`);
           }
         },

package/src/pagePool.js

@@ -86,6 +86,7 @@ function createPagePool({initPage, logger}) {
     };
 
     function markPageAsFree() {
+      logger.log('[page pool] marking page as free', pageId);
       resolveWork();
     }
 

package/src/renderStories.js

@@ -4,9 +4,6 @@ const getStoryBaselineName = require('./getStoryBaselineName');
 const ora = require('ora');
 const {presult} = require('@applitools/functional-commons');
 
-const MAX_RETRIES = 30;
-const RETRY_INTERVAL = 1000;
-
 function makeRenderStories({
   getStoryData,
   pagePool,
@@ -14,7 +11,7 @@ function makeRenderStories({
   storybookUrl,
   logger,
   stream,
-  getClientAPI,
+  sanityCheckForPage,
   maxPageTTL = 60000,
 }) {
   let newPageIdToAdd;
@@ -67,6 +64,7 @@ function makeRenderStories({
               story,
               storyUrl,
               page,
+              pageId,
             }),
           );
 
@@ -91,6 +89,7 @@ function makeRenderStories({
                 story,
                 storyUrl,
                 page: newPageObj.page,
+                pageId: newPageObj.pageId,
               }),
             );
             error = newError;
@@ -152,31 +151,19 @@ function makeRenderStories({
 
       const {pageId, page} = pageObj;
       logger.log(`[prepareNewPage] new page is ready: ${pageId}`);
-      const [errorInSanity] = await getClientAPIWithRetry(page, MAX_RETRIES);
-      if (errorInSanity) {
+      try {
+        await sanityCheckForPage(page);
+        logger.log(`[prepareNewPage] setting new page for replacement: ${pageId}`);
+        newPageIdToAdd = pageId;
+      } catch (errorInSanity) {
         logger.log(
-          `[prepareNewPage] new page ${pageId} is corrupted. preparing new page. ${errorInSanity}`,
+          `[prepareNewPage] new page ${pageId} is corrupted. preparing new page.`,
+          errorInSanity,
         );
         prepareNewPage();
-        return;
       }
-
-      logger.log(`[prepareNewPage] setting new page for replacement: ${pageId}`);
-
-      newPageIdToAdd = pageId;
     }
   };
-
-  async function getClientAPIWithRetry(page, remainingRetries) {
-    const [err] = await presult(page.evaluate(getClientAPI));
-    if (!err || remainingRetries == 0) {
-      return [err];
-    } else if (err) {
-      logger.log('Error in getClientAPI:', err, `retrying... ${remainingRetries - 1} are left`);
-      await delay(RETRY_INTERVAL);
-      return await getClientAPIWithRetry(page, remainingRetries - 1);
-    }
-  }
 }
 
 module.exports = makeRenderStories;

package/src/utils/executeWithRetry.js

@@ -0,0 +1,22 @@
+const {delay, ptimeoutWithFunction} = require('@applitools/functional-commons');
+
+async function executeWithRetry(fn, {timeout, initialErrMessage, delayBetweenRetries}) {
+  let err = new Error(initialErrMessage);
+
+  return ptimeoutWithFunction(_executeWithRetry, timeout, () => Promise.reject(err));
+
+  async function _executeWithRetry(hasAborted) {
+    try {
+      return await fn();
+    } catch (fnErr) {
+      err = fnErr;
+    }
+
+    if (!hasAborted()) {
+      await delay(delayBetweenRetries);
+      return await _executeWithRetry(hasAborted);
+    }
+  }
+}
+
+module.exports = {executeWithRetry};

package/src/postinstall.js

@@ -1,16 +0,0 @@
-const chalk = require('chalk');
-const boxen = require('boxen');
-console.log(
-  boxen(
-    `This is version 3 of ${chalk.cyan('@applitools/eyes-storybook')}.
-This version includes a wide variety of performance improvements and features.
-We recommend checking out the release notes:
-${chalk.yellow('https://github.com/applitools/eyes-storybook/blob/v3.0.1/docs/release-notes-v3.md')}
-
-If you experience a difference in behavior between v2 and v3, it's possible to opt out of the optimization
-by configuring ${chalk.cyan('reloadPagePerStory')} to ${chalk.cyan(
-      'true',
-    )}. And, do read the release notes - they explain it perfectly :-)`,
-    {padding: 1, borderColor: 'cyan', align: 'center'},
-  ),
-);