@applitools/eyes-storybook 3.53.1 → 3.53.2

package/CHANGELOG.md

@@ -1,5 +1,65 @@
 # Changelog
 
+## [3.53.2](https://github.com/Applitools-Dev/sdk/compare/js/eyes-storybook@3.53.1...js/eyes-storybook@3.53.2) (2025-01-13)
+
+
+### Bug Fixes
+
+* remove side-eyes and fix code scanning issues ([#2712](https://github.com/Applitools-Dev/sdk/issues/2712)) ([cda98e4](https://github.com/Applitools-Dev/sdk/commit/cda98e4748c73cd97c11f646a2b5e26ff9416892))
+* storybook navigation timeouts ([#2701](https://github.com/Applitools-Dev/sdk/issues/2701)) ([64e3a40](https://github.com/Applitools-Dev/sdk/commit/64e3a40a524ae76ec457ae9c2d1170fbaea5e982))
+
+
+### Dependencies
+
+* @applitools/dom-snapshot bumped to 4.11.14
+  #### Bug Fixes
+
+  * remove side-eyes and fix code scanning issues ([#2712](https://github.com/Applitools-Dev/sdk/issues/2712)) ([cda98e4](https://github.com/Applitools-Dev/sdk/commit/cda98e4748c73cd97c11f646a2b5e26ff9416892))
+
+
+
+* @applitools/snippets bumped to 2.6.4
+  #### Bug Fixes
+
+  * remove side-eyes and fix code scanning issues ([#2712](https://github.com/Applitools-Dev/sdk/issues/2712)) ([cda98e4](https://github.com/Applitools-Dev/sdk/commit/cda98e4748c73cd97c11f646a2b5e26ff9416892))
+* @applitools/dom-capture bumped to 11.5.4
+  #### Bug Fixes
+
+  * remove side-eyes and fix code scanning issues ([#2712](https://github.com/Applitools-Dev/sdk/issues/2712)) ([cda98e4](https://github.com/Applitools-Dev/sdk/commit/cda98e4748c73cd97c11f646a2b5e26ff9416892))
+* @applitools/eyes bumped to 1.31.0
+  #### Features
+
+  * jsonFilePath in offline mode ([#2734](https://github.com/Applitools-Dev/sdk/issues/2734)) ([2f9fbe8](https://github.com/Applitools-Dev/sdk/commit/2f9fbe8fc3c5212db6b7cc58a98b041c3ffd5572))
+
+
+
+* @applitools/driver bumped to 1.20.3
+
+* @applitools/spec-driver-webdriver bumped to 1.1.23
+
+* @applitools/spec-driver-selenium bumped to 1.5.94
+
+* @applitools/spec-driver-puppeteer bumped to 1.4.23
+
+* @applitools/screenshoter bumped to 3.10.3
+
+* @applitools/nml-client bumped to 1.8.22
+
+* @applitools/ec-client bumped to 1.10.1
+
+* @applitools/core bumped to 4.29.0
+  #### Features
+
+  * jsonFilePath in offline mode ([#2734](https://github.com/Applitools-Dev/sdk/issues/2734)) ([2f9fbe8](https://github.com/Applitools-Dev/sdk/commit/2f9fbe8fc3c5212db6b7cc58a98b041c3ffd5572))
+
+
+  #### Bug Fixes
+
+  * support batching tests in distributed env - close batch only when required ([#2733](https://github.com/Applitools-Dev/sdk/issues/2733)) ([2e59e4a](https://github.com/Applitools-Dev/sdk/commit/2e59e4a76edcc02b8888dfc78a42749bae76f79c))
+
+
+
+
 ## [3.53.1](https://github.com/Applitools-Dev/sdk/compare/js/eyes-storybook@3.53.0...js/eyes-storybook@3.53.1) (2024-12-31)
 
 

package/dist/getClientAPI.js

@@ -181,7 +181,20 @@ function __getClientAPI(...args) {
     throw new Error('Cannot get client API: no frameWindow');
   }
 
-  var getClientAPI_1 = getClientAPI;
+  async function getClientAPIWithRetries() {
+    let error = 'Unknown error';
+    for (let attempt = 1; attempt <= 100; attempt++) {
+      await new Promise(resolve => setTimeout(resolve, 100));
+      try {
+        return getClientAPI();
+      } catch (e) {
+        error = e;
+      }
+    }
+    throw error;
+  }
+
+  var getClientAPI_1 = getClientAPIWithRetries;
 
   return getClientAPI_1;
 

package/dist/getStories.js

@@ -181,7 +181,20 @@ function __getStories(...args) {
     throw new Error('Cannot get client API: no frameWindow');
   }
 
-  var getClientAPI_1 = getClientAPI;
+  async function getClientAPIWithRetries() {
+    let error = 'Unknown error';
+    for (let attempt = 1; attempt <= 100; attempt++) {
+      await new Promise(resolve => setTimeout(resolve, 100));
+      try {
+        return getClientAPI();
+      } catch (e) {
+        error = e;
+      }
+    }
+    throw error;
+  }
+
+  var getClientAPI_1 = getClientAPIWithRetries;
 
   const DEFAULT_TIMEOUT = 60000;
 

package/dist/renderStoryWithClientAPI.js

@@ -181,13 +181,26 @@ function __renderStoryWithClientAPI(...args) {
     throw new Error('Cannot get client API: no frameWindow');
   }
 
-  var getClientAPI_1 = getClientAPI;
+  async function getClientAPIWithRetries() {
+    let error = 'Unknown error';
+    for (let attempt = 1; attempt <= 100; attempt++) {
+      await new Promise(resolve => setTimeout(resolve, 100));
+      try {
+        return getClientAPI();
+      } catch (e) {
+        error = e;
+      }
+    }
+    throw error;
+  }
+
+  var getClientAPI_1 = getClientAPIWithRetries;
 
   function renderStoryWithClientAPI(index, id) {
     return new Promise(async resolve => {
       let api;
       try {
-        api = getClientAPI_1();
+        api = await getClientAPI_1();
         await api.selectStory(index, id);
         api.onStoryRendered(resolve);
       } catch (ex) {

package/dist/runRunAfterScript.js

@@ -181,12 +181,25 @@ function __runRunAfterScript(...args) {
     throw new Error('Cannot get client API: no frameWindow');
   }
 
-  var getClientAPI_1 = getClientAPI;
+  async function getClientAPIWithRetries() {
+    let error = 'Unknown error';
+    for (let attempt = 1; attempt <= 100; attempt++) {
+      await new Promise(resolve => setTimeout(resolve, 100));
+      try {
+        return getClientAPI();
+      } catch (e) {
+        error = e;
+      }
+    }
+    throw error;
+  }
+
+  var getClientAPI_1 = getClientAPIWithRetries;
 
   async function getStoryByIndex(index) {
     let api;
     try {
-      api = getClientAPI_1();
+      api = await getClientAPI_1();
       const stories = await api.getStories();
       if (!stories[index]) {
         console.log('error cannot get story', index);

package/dist/runRunBeforeScript.js

@@ -181,12 +181,25 @@ function __runRunBeforeScript(...args) {
     throw new Error('Cannot get client API: no frameWindow');
   }
 
-  var getClientAPI_1 = getClientAPI;
+  async function getClientAPIWithRetries() {
+    let error = 'Unknown error';
+    for (let attempt = 1; attempt <= 100; attempt++) {
+      await new Promise(resolve => setTimeout(resolve, 100));
+      try {
+        return getClientAPI();
+      } catch (e) {
+        error = e;
+      }
+    }
+    throw error;
+  }
+
+  var getClientAPI_1 = getClientAPIWithRetries;
 
   async function getStoryByIndex(index) {
     let api;
     try {
-      api = getClientAPI_1();
+      api = await getClientAPI_1();
       const stories = await api.getStories();
       if (!stories[index]) {
         console.log('error cannot get story', index);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-storybook",
-  "version": "3.53.1",
+  "version": "3.53.2",
   "description": "",
   "keywords": [
     "applitools",
@@ -54,13 +54,13 @@
     "up:framework": "cd test/fixtures/storybook-versions/${APPLITOOLS_FRAMEWORK_VERSION} && npm ci"
   },
   "dependencies": {
-    "@applitools/core": "4.28.0",
-    "@applitools/driver": "1.20.2",
-    "@applitools/eyes": "1.30.0",
+    "@applitools/core": "4.29.0",
+    "@applitools/driver": "1.20.3",
+    "@applitools/eyes": "1.31.0",
     "@applitools/functional-commons": "1.6.0",
     "@applitools/logger": "2.1.0",
     "@applitools/monitoring-commons": "1.0.19",
-    "@applitools/spec-driver-puppeteer": "1.4.22",
+    "@applitools/spec-driver-puppeteer": "1.4.23",
     "@applitools/ufg-client": "1.16.0",
     "@applitools/utils": "1.7.7",
     "boxen": "4.2.0",

package/src/browser/getClientAPI.js

@@ -178,4 +178,17 @@ function getFrameWindow() {
   throw new Error('Cannot get client API: no frameWindow');
 }
 
-module.exports = getClientAPI;
+async function getClientAPIWithRetries() {
+  let error = 'Unknown error';
+  for (let attempt = 1; attempt <= 100; attempt++) {
+    await new Promise(resolve => setTimeout(resolve, 100));
+    try {
+      return getClientAPI();
+    } catch (e) {
+      error = e;
+    }
+  }
+  throw error;
+}
+
+module.exports = getClientAPIWithRetries;

package/src/browser/getStoryByIndex.js

@@ -3,7 +3,7 @@ const getClientAPI = require('./getClientAPI');
 async function getStoryByIndex(index) {
   let api;
   try {
-    api = getClientAPI();
+    api = await getClientAPI();
     const stories = await api.getStories();
     if (!stories[index]) {
       console.log('error cannot get story', index);

package/src/browser/renderStoryWithClientAPI.js

@@ -4,7 +4,7 @@ function renderStoryWithClientAPI(index, id) {
   return new Promise(async resolve => {
     let api;
     try {
-      api = getClientAPI();
+      api = await getClientAPI();
       await api.selectStory(index, id);
       api.onStoryRendered(resolve);
     } catch (ex) {

package/src/defaultConfig.js

@@ -18,4 +18,5 @@ module.exports = {
   reloadPagePerStory: false,
   include: undefined,
   startStorybookServerTimeout: 300,
+  navigationWaitUntil: undefined,
 };

package/src/eyesStorybook.js

@@ -42,7 +42,7 @@ async function eyesStorybook({
     : Number(process.env.APPLITOOLS_CONCURRENT_TABS);
   logger.log(`Running with ${CONCURRENT_TABS} concurrent tabs`);
 
-  const {storybookUrl, readStoriesTimeout, reloadPagePerStory} = config;
+  const {storybookUrl, readStoriesTimeout, reloadPagePerStory, navigationWaitUntil} = config;
 
   let iframeUrl;
   try {
@@ -150,6 +150,7 @@ async function eyesStorybook({
       logger,
       takeDomSnapshots: doTakeDomSnapshots,
       reloadPagePerStory,
+      navigationWaitUntil,
     });
     const renderStory = makeRenderStory({
       logger: logger.extend({label: 'renderStory'}),
@@ -220,7 +221,9 @@ async function eyesStorybook({
     const spinner = ora({text: 'Reading stories', stream: outputStream});
     spinner.start();
     logger.log('navigating to storybook url:', storybookUrl);
-    const [navigateErr] = await presult(page.goto(storybookUrl, {timeout: readStoriesTimeout}));
+    const [navigateErr] = await presult(
+      page.goto(storybookUrl, {timeout: readStoriesTimeout, waitUntil: navigationWaitUntil}),
+    );
     if (navigateErr) {
       logger.log('Error when loading storybook', navigateErr);
       const failMsg = refineErrorMessage({
@@ -284,10 +287,14 @@ async function eyesStorybook({
     const [getStoriesErr, stories] = await presult(
       page.evaluate(getStories, {timeout: readStoriesTimeout}),
     );
-    if (getStoriesErr || stories.length > 0 || remainingRetries == 0) {
+    if (stories?.length > 0 || remainingRetries == 0) {
       return [getStoriesErr, stories];
     } else {
-      logger.log(`Got 0 stories, retrying to read stories... ${remainingRetries - 1} are left`);
+      if (getStoriesErr) {
+        logger.log('Error in getStories:', getStoriesErr);
+      } else {
+        logger.log(`Got 0 stories, retrying to read stories... ${remainingRetries - 1} are left`);
+      }
       await delay(RETRY_INTERVAL);
       return await readStoriesWithRetry(remainingRetries - 1);
     }

package/src/getStoryData.js

@@ -12,7 +12,7 @@ const PAGE_EVALUATE_TIMEOUT = process.env.APPLITOOLS_PAGE_EVALUATE_TIMEOUT || 12
 const DOM_SNAPSHOTS_TIMEOUT = 5 * 60 * 1000;
 const utils = require('@applitools/utils');
 
-function makeGetStoryData({logger, takeDomSnapshots, reloadPagePerStory}) {
+function makeGetStoryData({logger, takeDomSnapshots, reloadPagePerStory, navigationWaitUntil}) {
   return async function getStoryData({story, storyUrl, page}) {
     const title = getStoryBaselineName(story);
     logger.log(`getting data from story`, title);
@@ -88,7 +88,9 @@ function makeGetStoryData({logger, takeDomSnapshots, reloadPagePerStory}) {
 
     async function renderStoryLegacy() {
       logger.log(`getting data from story ${storyUrl}`);
-      const [err] = await presult(page.goto(storyUrl, {timeout: PAGE_EVALUATE_TIMEOUT}));
+      const [err] = await presult(
+        page.goto(storyUrl, {timeout: PAGE_EVALUATE_TIMEOUT, waitUntil: navigationWaitUntil}),
+      );
       if (err) {
         logger.log(`error navigating to story ${storyUrl}`, err);
         throw err;

package/src/initPage.js

@@ -46,7 +46,12 @@ function makeInitPage({iframeUrl, config, browser, logger, getTransitiongIntoIE,
       await fakeIE({logger, page, pageId});
     }
 
-    const [err] = await presult(page.goto(iframeUrl, {timeout: config.readStoriesTimeout}));
+    const [err] = await presult(
+      page.goto(iframeUrl, {
+        timeout: config.readStoriesTimeout,
+        waitUntil: config.navigationWaitUntil,
+      }),
+    );
     if (err) {
       logger.log(`error navigating to iframe.html`, err);
       if (pagePool.isInPool(pageId)) {

package/src/yargsOptions.js

@@ -62,6 +62,13 @@ module.exports = {
     },
   },
 
+  navigationWaitUntil: {
+    alias: ['navigation-wait-until'],
+    description: 'When to consider navigation to be finished',
+    requiresArg: false,
+    choices: ['load', 'domcontentloaded', 'networkidle0', 'networkidle2'], // PuppeteerLifeCycleEvent values - https://pptr.dev/api/puppeteer.puppeteerlifecycleevent
+  },
+
   // general
   exitcode: {
     alias: 'e',