@applitools/eyes-storybook 3.53.7 → 3.53.9

package/CHANGELOG.md

@@ -1,5 +1,36 @@
 # Changelog
 
+## [3.53.9](https://github.com/Applitools-Dev/sdk/compare/js/eyes-storybook@3.53.8...js/eyes-storybook@3.53.9) (2025-02-23)
+
+
+### Bug Fixes
+
+* page pool hang ([#2803](https://github.com/Applitools-Dev/sdk/issues/2803)) ([249043a](https://github.com/Applitools-Dev/sdk/commit/249043a4a31b358cbc3a06728d0fc493156d3c83))
+
+
+### Dependencies
+
+* @applitools/ufg-client bumped to 1.16.5
+  #### Bug Fixes
+
+  * fix offline - url was replaced before resource fetched for url resources ([#2802](https://github.com/Applitools-Dev/sdk/issues/2802)) ([a67f86a](https://github.com/Applitools-Dev/sdk/commit/a67f86aabd56c59fb6cfa58578b1e8b3c31d2197))
+* @applitools/core bumped to 4.31.3
+  #### Bug Fixes
+
+  * fix offline - url was replaced before resource fetched for url resources ([#2802](https://github.com/Applitools-Dev/sdk/issues/2802)) ([a67f86a](https://github.com/Applitools-Dev/sdk/commit/a67f86aabd56c59fb6cfa58578b1e8b3c31d2197))
+
+
+
+* @applitools/eyes bumped to 1.32.2
+
+
+## [3.53.8](https://github.com/Applitools-Dev/sdk/compare/js/eyes-storybook@3.53.7...js/eyes-storybook@3.53.8) (2025-02-11)
+
+
+### Bug Fixes
+
+* add logs to page sanity check ([#2783](https://github.com/Applitools-Dev/sdk/issues/2783)) ([056c5bc](https://github.com/Applitools-Dev/sdk/commit/056c5bc0b91babd82a406e1ef57ca7ded8dcffdd))
+
 ## [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)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-storybook",
-  "version": "3.53.7",
+  "version": "3.53.9",
   "description": "",
   "keywords": [
     "applitools",
@@ -25,13 +25,13 @@
     "build": "rollup -c rollup.config.js",
     "build:heavy": "node scripts/bitmap.js",
     "test": "yarn build && yarn test:mocha",
-    "test:mocha": "run --top-level mocha --trace-warnings 'test/{unit,it,e2e}/*.test.js'",
-    "test:unit": "run --top-level mocha --trace-warnings 'test/unit/*.test.js'",
-    "test:it": "run --top-level mocha --trace-warnings 'test/it/*.test.js'",
+    "test:mocha": "run --top-level mocha 'test/{unit,it,e2e}/*.test.js'",
+    "test:unit": "run --top-level mocha 'test/unit/*.test.js'",
+    "test:it": "run --top-level mocha 'test/it/*.test.js'",
     "test:versions": "yarn build && yarn test:e2e:versions && yarn lint",
-    "test:e2e": "MOCHA_GROUP=e2e run --top-level mocha --trace-warnings 'test/e2e/*.e2e.test.js'",
-    "test:e2e:versions": "MOCHA_GROUP=e2e_versions run --top-level mocha --trace-warnings test/versions/*.e2e.versions.test.js",
-    "test:sanity": "run --top-level mocha --trace-warnings 'test/sanity/*.test.js'",
+    "test:e2e": "MOCHA_GROUP=e2e run --top-level mocha 'test/e2e/*.e2e.test.js'",
+    "test:e2e:versions": "MOCHA_GROUP=e2e_versions run --top-level mocha test/versions/*.e2e.versions.test.js",
+    "test:sanity": "run --top-level mocha 'test/sanity/*.test.js'",
     "test:heavy": "node bin/eyes-storybook.js -f test/fixtures/heavyStorybook/applitools.config.js",
     "storybook": "start-storybook -c test/fixtures/appWithStorybook -p 9001 -s test/fixtures",
     "storybook:httpHeaders": "start-storybook -c test/fixtures/appWithCustomHttpHeaders -p 9007",
@@ -53,14 +53,14 @@
     "up:framework": "cd test/fixtures/storybook-versions/${APPLITOOLS_FRAMEWORK_VERSION} && npm ci"
   },
   "dependencies": {
-    "@applitools/core": "4.31.2",
+    "@applitools/core": "4.31.3",
     "@applitools/driver": "1.20.4",
-    "@applitools/eyes": "1.32.1",
+    "@applitools/eyes": "1.32.2",
     "@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.4",
+    "@applitools/ufg-client": "1.16.5",
     "@applitools/utils": "1.7.7",
     "boxen": "4.2.0",
     "chalk": "3.0.0",

package/src/eyesStorybook.js

@@ -45,6 +45,7 @@ async function eyesStorybook({
   let iframeUrl;
   try {
     iframeUrl = getIframeUrl(storybookUrl);
+    logger.log('iframeUrl:', iframeUrl);
   } catch (ex) {
     logger.log(ex);
     throw new Error(`Storybook URL is not valid: ${storybookUrl}`);
@@ -118,13 +119,6 @@ async function eyesStorybook({
   try {
     const stories = await getStoriesWithSpinner();
 
-    await Promise.all(
-      Array.from({length: CONCURRENT_TABS}, async () => {
-        const {pageId} = await pagePool.createPage();
-        pagePool.addToPool(pageId);
-      }),
-    );
-
     const filteredStories = filterStories({stories, config});
     const storiesIncludingVariations = addVariationStories({
       stories: filteredStories,
@@ -173,6 +167,8 @@ async function eyesStorybook({
 
     logger.log('finished creating functions');
 
+    await initializeTabs();
+
     const [error, results] = await presult(
       executeRenders({
         renderStories,
@@ -307,22 +303,54 @@ async function eyesStorybook({
     }
   }
 
-  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({page, pageId}) {
+    try {
+      await executeWithRetry(_sanityCheckForPage, {
+        timeout: readStoriesTimeout,
+        delayBetweenRetries: 1000,
+        initialErrMessage: `Could not get client API in sanity check since readStoriesTimeout is too short (${readStoriesTimeout}ms)`,
+      });
+    } catch (err) {
+      logger.log(`[page ${pageId}] Sanity check failed. Getting page HTML for inspection`);
+      try {
+        const html = await page.content();
+        logger.log(`[page ${pageId}] Page HTML: ${html}`);
+      } catch (htmlErr) {
+        logger.log(`[page ${pageId}] Error getting page HTML:`, htmlErr);
+      }
+      throw err;
+    }
 
     async function _sanityCheckForPage() {
       try {
         await page.evaluate(getClientAPI);
       } catch (err) {
-        logger.log('Error in getClientAPI during sanity check:', err, ', retrying...');
+        logger.log(`[page ${pageId}] Error in getClientAPI during sanity check. Retrying...`, err);
         throw err;
       }
     }
   }
+
+  async function initializeTabs() {
+    logger.log('initializing tabs');
+    try {
+      await Promise.all(
+        Array.from({length: CONCURRENT_TABS}, async () => {
+          const {page, pageId} = await pagePool.createPage();
+          await sanityCheckForPage({page, pageId});
+          pagePool.addToPool(pageId);
+        }),
+      );
+    } catch (initializeTabsError) {
+      const msg = refineErrorMessage({
+        prefix: 'Error initializing browser tabs with storybook:',
+        error: initializeTabsError,
+      });
+      logger.log(msg);
+      ora({text: msg, stream: outputStream}).fail();
+      throw new Error();
+    }
+  }
 }
 
 module.exports = eyesStorybook;

package/src/pagePool.js

@@ -1,6 +1,6 @@
 'use strict';
 
-function createPagePool({initPage, logger}) {
+function createPagePool({initPage, logger, freePageTimeout = 300_000}) {
   let counter = 0;
   const fullPageObjs = [];
   logger.log(`[page pool] created`);
@@ -48,22 +48,38 @@ function createPagePool({initPage, logger}) {
     pagePool.addToPool(newPageId);
   }
 
-  async function getFreePage() {
-    logger.log(`[page pool] waiting for free page`);
+  async function getFreePage(tryCount = 0) {
+    logger.log(`[page pool] waiting for free page, tryCount=${tryCount}`);
     await currWaitOnFreePage;
+    const availablePages = fullPageObjs.filter(p => p.isInPool());
+    // wait up to 5 minutes
+    if (availablePages.length === 0) {
+      const INTERVAL = 500;
+      if (tryCount < freePageTimeout / INTERVAL) {
+        logger.log(`[page pool] no available pages, retrying to get free page...`);
+        await new Promise(r => setTimeout(r, INTERVAL));
+        return getFreePage(tryCount + 1);
+      } else {
+        throw new Error('Could not find free page, timed out after waiting 5 minutes');
+      }
+    }
+    logger.log(`[page pool] waiting on pages ${availablePages.map(({pageId}) => pageId)}`);
     currWaitOnFreePage = Promise.race(
-      fullPageObjs
-        .filter(p => p.isInPool())
-        .map(async p => {
-          await p.waitUntilFree();
-          return p;
-        }),
+      availablePages.map(async p => {
+        await p.waitUntilFree();
+        return p;
+      }),
     );
 
     const fullPageObj = await currWaitOnFreePage;
-    fullPageObj.occupyPage();
-    logger.log(`[page pool] free page found: ${fullPageObj.pageId}`);
-    return toSmallPageObj(fullPageObj);
+    if (fullPageObj.isInPool()) {
+      fullPageObj.occupyPage();
+      logger.log(`[page pool] free page found: ${fullPageObj.pageId}`);
+      return toSmallPageObj(fullPageObj);
+    } else {
+      logger.log(`[page pool] free page found, but it is no longer in pool: ${fullPageObj.pageId}`);
+      return getFreePage(tryCount + 1);
+    }
   }
 
   async function createPage() {
@@ -91,7 +107,9 @@ function createPagePool({initPage, logger}) {
     }
 
     async function waitUntilFree() {
+      logger.log(`[page ${pageId}] waitUntilFree before`);
       await workPromise;
+      logger.log(`[page ${pageId}] waitUntilFree after`);
     }
 
     function occupyPage() {
@@ -101,10 +119,13 @@ function createPagePool({initPage, logger}) {
     }
 
     function removePage() {
+      logger.log(`[page ${pageId}] removePage`);
       fullPageObjs.splice(
         fullPageObjs.findIndex(p => p.pageId === pageId),
         1,
       );
+      isActive = false;
+      resolveWork && resolveWork();
     }
 
     function isInPool() {
@@ -112,6 +133,7 @@ function createPagePool({initPage, logger}) {
     }
 
     function addToPool() {
+      logger.log(`[page ${pageId}] addToPool`);
       isActive = true;
       createdAt = Date.now();
     }

package/src/renderStories.js

@@ -152,7 +152,7 @@ function makeRenderStories({
       const {pageId, page} = pageObj;
       logger.log(`[prepareNewPage] new page is ready: ${pageId}`);
       try {
-        await sanityCheckForPage(page);
+        await sanityCheckForPage({page, pageId});
         logger.log(`[prepareNewPage] setting new page for replacement: ${pageId}`);
         newPageIdToAdd = pageId;
       } catch (errorInSanity) {