@applitools/eyes-storybook 3.53.6 → 3.53.7

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # 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)
 
 

package/dist/getClientAPI.js

@@ -190,7 +190,7 @@ function __getClientAPI(...args) {
     throw new Error('Cannot get client API: no frameWindow');
   }
 
-  async function getClientAPIWithRetries({timeout = 10000} = {}) {
+  async function getClientAPIWithRetries({timeout = 5000} = {}) {
     let error = 'Unknown error';
     const RETRY_INTERVAL = 100;
     const totalAttempts = timeout / RETRY_INTERVAL;

package/dist/getStories.js

@@ -190,7 +190,7 @@ function __getStories(...args) {
     throw new Error('Cannot get client API: no frameWindow');
   }
 
-  async function getClientAPIWithRetries({timeout = 10000} = {}) {
+  async function getClientAPIWithRetries({timeout = 5000} = {}) {
     let error = 'Unknown error';
     const RETRY_INTERVAL = 100;
     const totalAttempts = timeout / RETRY_INTERVAL;
@@ -210,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();
@@ -297,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}`);
@@ -376,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({timeout});
-        } 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

@@ -190,7 +190,7 @@ function __renderStoryWithClientAPI(...args) {
     throw new Error('Cannot get client API: no frameWindow');
   }
 
-  async function getClientAPIWithRetries({timeout = 10000} = {}) {
+  async function getClientAPIWithRetries({timeout = 5000} = {}) {
     let error = 'Unknown error';
     const RETRY_INTERVAL = 100;
     const totalAttempts = timeout / RETRY_INTERVAL;

package/dist/runRunAfterScript.js

@@ -190,7 +190,7 @@ function __runRunAfterScript(...args) {
     throw new Error('Cannot get client API: no frameWindow');
   }
 
-  async function getClientAPIWithRetries({timeout = 10000} = {}) {
+  async function getClientAPIWithRetries({timeout = 5000} = {}) {
     let error = 'Unknown error';
     const RETRY_INTERVAL = 100;
     const totalAttempts = timeout / RETRY_INTERVAL;

package/dist/runRunBeforeScript.js

@@ -190,7 +190,7 @@ function __runRunBeforeScript(...args) {
     throw new Error('Cannot get client API: no frameWindow');
   }
 
-  async function getClientAPIWithRetries({timeout = 10000} = {}) {
+  async function getClientAPIWithRetries({timeout = 5000} = {}) {
     let error = 'Unknown error';
     const RETRY_INTERVAL = 100;
     const totalAttempts = timeout / RETRY_INTERVAL;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-storybook",
-  "version": "3.53.6",
+  "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.31.0",
+    "@applitools/core": "4.31.2",
     "@applitools/driver": "1.20.4",
-    "@applitools/eyes": "1.32.0",
+    "@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.24",
-    "@applitools/ufg-client": "1.16.3",
+    "@applitools/ufg-client": "1.16.4",
     "@applitools/utils": "1.7.7",
     "boxen": "4.2.0",
     "chalk": "3.0.0",

package/src/browser/getClientAPI.js

@@ -187,7 +187,7 @@ function getFrameWindow() {
   throw new Error('Cannot get client API: no frameWindow');
 }
 
-async function getClientAPIWithRetries({timeout = 10000} = {}) {
+async function getClientAPIWithRetries({timeout = 5000} = {}) {
   let error = 'Unknown error';
   const RETRY_INTERVAL = 100;
   const totalAttempts = timeout / RETRY_INTERVAL;

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({timeout});
-      } 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/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,7 +232,7 @@ async function eyesStorybook({
       throw new Error();
     }
 
-    const [getStoriesErr, stories] = await readStoriesWithRetry(MAX_RETRIES);
+    const [getStoriesErr, stories] = await presult(readStoriesWithRetry());
 
     if (getStoriesErr) {
       logger.log('Error when reading stories:', getStoriesErr);
@@ -283,21 +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 {
-      remainingRetries--;
-      if (getStoriesErr) {
-        logger.log('Error in getStories:', getStoriesErr, `, ${remainingRetries} retries are left`);
-      } else {
-        logger.log(`Got 0 stories, ${remainingRetries} retries 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);
     }
   }
 }

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

@@ -2,10 +2,7 @@
 const getStoryUrl = require('./getStoryUrl');
 const getStoryBaselineName = require('./getStoryBaselineName');
 const ora = require('ora');
-const {presult, delay} = require('@applitools/functional-commons');
-
-const MAX_RETRIES = 30;
-const RETRY_INTERVAL = 1000;
+const {presult} = require('@applitools/functional-commons');
 
 function makeRenderStories({
   getStoryData,
@@ -14,7 +11,7 @@ function makeRenderStories({
   storybookUrl,
   logger,
   stream,
-  getClientAPI,
+  sanityCheckForPage,
   maxPageTTL = 60000,
 }) {
   let newPageIdToAdd;
@@ -154,33 +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, {timeout: 10000}));
-    if (!err || remainingRetries == 0) {
-      return [err];
-    } else if (err) {
-      logger.log(
-        `Error in getClientAPI: ${err.message} 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'},
-  ),
-);