@applitools/eyes-storybook 3.31.4 → 3.32.0

package/CHANGELOG.md

@@ -3,6 +3,20 @@
 ## Unreleased
 
 
+## 3.32.0 - 2023/3/30
+
+### Features
+- Add support for configuration per subsets of stories
+### Bug fixes
+- Improve performance in DOM snapshot
+
+## 3.31.5 - 2023/3/28
+
+### Features
+### Bug fixes
+- Optimized number of requests during polling
+- Write result files without throwing error
+
 ## 3.31.4 - 2023/3/17
 
 ### Features

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-storybook",
-  "version": "3.31.4",
+  "version": "3.32.0",
   "description": "",
   "keywords": [
     "applitools",
@@ -73,14 +73,14 @@
     }
   },
   "dependencies": {
-    "@applitools/core": "2.4.2",
+    "@applitools/core": "2.4.4",
     "@applitools/driver": "1.11.37",
     "@applitools/functional-commons": "1.6.0",
     "@applitools/logger": "1.1.48",
     "@applitools/monitoring-commons": "1.0.19",
     "@applitools/spec-driver-puppeteer": "1.1.49",
     "@applitools/test-server": "1.1.28",
-    "@applitools/ufg-client": "1.2.3",
+    "@applitools/ufg-client": "1.2.4",
     "@applitools/utils": "1.3.32",
     "boxen": "4.2.0",
     "chalk": "3.0.0",
@@ -94,7 +94,7 @@
     "yargs": "15.4.1"
   },
   "devDependencies": {
-    "@applitools/bongo": "^3.0.1",
+    "@applitools/bongo": "^3.0.3",
     "@applitools/sdk-shared": "0.9.15",
     "@applitools/snaptdout": "^1.0.1",
     "@storybook/addon-interactions": "^6.4.18",

package/src/checkSettingsParams.js

@@ -0,0 +1,29 @@
+'use strict';
+
+const checkSettingsParams = [
+  'browser',
+  'ignoreCaret',
+  'matchLevel',
+  'waitBeforeCapture',
+  'ignoreDisplacements',
+  'ignoreRegions',
+  'floatingRegions',
+  'layoutRegions',
+  'strictRegions',
+  'contentRegions',
+  'accessibilityRegions',
+  'accessibilityValidation',
+  'layoutBreakpoints',
+  'sendDom',
+  'useDom',
+  'enablePatterns',
+  'visualGridOptions',
+  'scriptHooks',
+  'target',
+  'region',
+  'selector',
+  'fully',
+  'fakeIE',
+];
+
+module.exports = {checkSettingsParams};

package/src/cli.js

@@ -7,7 +7,7 @@ const eyesStorybook = require('./eyesStorybook');
 const processResults = require('./processResults');
 const validateAndPopulateConfig = require('./validateAndPopulateConfig');
 const yargsOptions = require('./yargsOptions');
-const generateConfig = require('./generateConfig');
+const {generateConfig} = require('./generateConfig');
 const defaultConfig = require('./defaultConfig');
 const configDigest = require('./configDigest');
 const {makeTiming} = require('@applitools/monitoring-commons');
@@ -42,7 +42,7 @@ const {performance, timeItAsync} = makeTiming();
       process.exit(config.exitcode ? config.exitcode : 0);
     } else {
       const totalTime = performance['eyesStorybook'];
-      const {exitCode, formatter, outputStr} = processResults({
+      const {exitCode, summary, outputStr} = processResults({
         results,
         totalTime,
         testConcurrency: config.testConcurrency,
@@ -50,13 +50,13 @@ const {performance, timeItAsync} = makeTiming();
       });
       console.log(outputStr);
       if (config.jsonFilePath) {
-        handleJsonFile(config.jsonFilePath, formatter);
+        handleJsonFile(config.jsonFilePath, summary);
       }
       if (config.tapFilePath) {
-        handleTapFile(config.tapFilePath, formatter);
+        handleTapFile(config.tapFilePath, summary);
       }
       if (config.xmlFilePath) {
-        handleXmlFile(config.xmlFilePath, formatter, {totalTime});
+        handleXmlFile(config.xmlFilePath, summary, {totalTime});
       }
       process.exit(config.exitcode ? exitCode : 0);
     }

package/src/executeRenders.js

@@ -1,30 +1,32 @@
-const {shouldRenderIE} = require('./shouldRenderIE');
-
 async function executeRenders({
   timeItAsync,
   setTransitioningIntoIE,
   renderStories,
-  configs,
   pagePool,
-  stories,
+  storiesByBrowserWithConfig,
   logger,
   setRenderIE,
 }) {
   const results = [];
-  for (const config of configs) {
-    logger.verbose(`executing render story with ${JSON.stringify(config)}`);
-    if (shouldRenderIE(config)) {
-      setRenderIE(true);
-      setTransitioningIntoIE(true);
-      await pagePool.drain();
-      setTransitioningIntoIE(false);
-    }
-
-    const result = await timeItAsync('renderStories', () => renderStories(stories, config));
-
+  if (storiesByBrowserWithConfig.stories.length) {
+    logger.verbose(`executing render stories for non fakeIE browsers`);
+    const result = await timeItAsync('renderStories', () =>
+      renderStories(storiesByBrowserWithConfig.stories, false),
+    );
     results.push(...result);
   }
+  if (storiesByBrowserWithConfig.storiesWithIE.length) {
+    logger.verbose(`executing render stories for fakeIE`);
+    setRenderIE(true);
+    setTransitioningIntoIE(true);
+    await pagePool.drain();
+    setTransitioningIntoIE(false);
 
+    const result = await timeItAsync('renderStories', () =>
+      renderStories(storiesByBrowserWithConfig.storiesWithIE, true),
+    );
+    results.push(...result);
+  }
   return results;
 }
 

package/src/eyesStorybook.js

@@ -19,10 +19,10 @@ const {takeDomSnapshots} = require('@applitools/core');
 const {Driver} = require('@applitools/driver');
 const spec = require('@applitools/spec-driver-puppeteer');
 const {refineErrorMessage} = require('./errMessages');
-const {splitConfigsByBrowser} = require('./shouldRenderIE');
 const executeRenders = require('./executeRenders');
 const {makeCore} = require('@applitools/core');
 const {makeUFGClient} = require('@applitools/ufg-client');
+const makeGetStoriesWithConfig = require('./getStoriesWithConfig');
 
 const CONCURRENT_PAGES = 3;
 const MAX_RETRIES = 10;
@@ -65,19 +65,13 @@ async function eyesStorybook({
   if (config.puppeteerExtraHTTPHeaders) {
     await page.setExtraHTTPHeaders(config.puppeteerExtraHTTPHeaders);
   }
-  const core = await makeCore({
-    spec,
-    concurrency: testConcurrency,
-    logger,
-    agentId,
-  });
+  const core = await makeCore({spec, agentId, logger});
   const manager = await core.makeManager({
-    spec,
-    concurrency: testConcurrency,
-    agentId,
-    logger,
-    core,
     type: 'ufg',
+    settings: {
+      concurrency: testConcurrency,
+    },
+    logger,
   });
 
   const settings = {
@@ -88,6 +82,8 @@ async function eyesStorybook({
   };
   const [error, account] = await presult(core.getAccountInfo({settings, logger}));
 
+  const getStoriesWithConfig = makeGetStoriesWithConfig({config});
+
   if (error && error.message && error.message.includes('Unauthorized(401)')) {
     const failMsg = 'Incorrect API Key';
     logger.log(failMsg);
@@ -161,7 +157,18 @@ async function eyesStorybook({
       config,
     });
 
-    logger.log(`starting to run ${storiesIncludingVariations.length} stories`);
+    logger.log(
+      `there are ${storiesIncludingVariations.length} stories after filtering and adding variations `,
+    );
+
+    const storiesByBrowserWithConfig = getStoriesWithConfig({
+      stories: storiesIncludingVariations,
+      logger,
+    });
+
+    logger.log(
+      `starting to run ${storiesByBrowserWithConfig.stories.length} normal stories ("non fake IE") and ${storiesByBrowserWithConfig.storiesWithIE.length} "fake IE stories"`,
+    );
 
     const getStoryData = makeGetStoryData({
       logger,
@@ -197,14 +204,13 @@ async function eyesStorybook({
     });
 
     logger.log('finished creating functions');
-    const configs = config.fakeIE ? splitConfigsByBrowser(config) : [config];
+
     const [error, results] = await presult(
       executeRenders({
         renderStories,
         setRenderIE,
         setTransitioningIntoIE,
-        configs,
-        stories: storiesIncludingVariations,
+        storiesByBrowserWithConfig,
         pagePool,
         logger,
         timeItAsync,

package/src/generateConfig.js

@@ -40,7 +40,7 @@ function generateConfig({argv = {}, defaultConfig = {}, externalConfigParams = [
     result.waitBeforeCapture = Number(result.waitBeforeCapture);
   }
 
-  if (result.showLogs === '1') {
+  if (result.showLogs === '1' || process.env.APPLITOOLS_SHOW_LOGS === 'true') {
     result.showLogs = true;
   }
 
@@ -77,18 +77,31 @@ function generateConfig({argv = {}, defaultConfig = {}, externalConfigParams = [
     );
   }
 
-  if (!result.browser) {
+  transformBrowser(result);
+  if (!result.renderers) {
     result.renderers = [{name: 'chrome', width: 1024, height: 768}];
-  } else {
+  }
+
+  return result;
+}
+
+function transformBrowser(result) {
+  if (result.browser) {
     result.renderers = [];
     if (!Array.isArray(result.browser)) {
       result.browser = [result.browser];
     }
     result.renderers = result.browser.map(browser => {
-      return browser.deviceName ? {chromeEmulationInfo: browser} : browser;
+      if (browser.deviceName) {
+        return {chromeEmulationInfo: browser};
+      } else if (!browser.name) {
+        return {...browser, name: 'chrome'};
+      } else {
+        return browser;
+      }
     });
   }
   delete result.browser;
   return result;
 }
-module.exports = generateConfig;
+module.exports = {generateConfig, transformBrowser};

package/src/getStoriesWithConfig.js

@@ -0,0 +1,102 @@
+const {splitConfigsByBrowser, shouldRenderIE} = require('./shouldRenderIE');
+const getStoryTitle = require('./getStoryTitle');
+const {transformBrowser} = require('./generateConfig');
+const {checkSettingsParams} = require('./checkSettingsParams');
+const getStoryBaselineName = require('./getStoryBaselineName');
+
+function makeGetStoriesWithConfig({config}) {
+  const storiesWithConfig = new Map();
+  const storiesWithConfigIE = new Map();
+  const basicConfig = {...config};
+  delete basicConfig.storyConfiguration;
+
+  return function getStoriesWithConfig({stories, logger = console}) {
+    const storiesWithTitle = addStoryTitleAndBaselineName(stories);
+    if (!config.storyConfiguration) {
+      addConfigToStories({config, stories: storiesWithTitle});
+    } else {
+      const storyConfigurations = Array.isArray(config.storyConfiguration)
+        ? config.storyConfiguration
+        : [config.storyConfiguration];
+      let remainingStories = [...storiesWithTitle];
+      for (const storyConfig of storyConfigurations) {
+        const filterStories = storyConfig.stories;
+        delete storyConfig.stories;
+
+        if (filterStories) {
+          const storiesSubset = storiesWithTitle
+            .filter(story => {
+              try {
+                return filterStories(story);
+              } catch (err) {
+                logger.log(`An error was thrown from substory function: ${err}`);
+                return;
+              }
+            })
+            .filter(Boolean);
+          addConfigToStories({
+            config: transformBrowser(allowedProps(storyConfig)),
+            stories: storiesSubset,
+          });
+
+          remainingStories = remainingStories.filter(story => !storiesSubset.includes(story));
+        }
+      }
+
+      if (remainingStories.length) {
+        addConfigToStories({config: basicConfig, stories: remainingStories});
+      }
+    }
+    return {
+      stories: Array.from(storiesWithConfig.values()),
+      storiesWithIE: Array.from(storiesWithConfigIE.values()),
+    };
+  };
+
+  function addConfigToStories({config, stories}) {
+    const configs = config.fakeIE ? splitConfigsByBrowser(config) : [config];
+    for (const config of configs) {
+      for (const story of stories) {
+        addConfigToStoy({
+          story,
+          config,
+          isIE: shouldRenderIE(config),
+        });
+      }
+    }
+  }
+
+  function addConfigToStoy({story, config, isIE}) {
+    const storiesToUpdate = isIE ? storiesWithConfigIE : storiesWithConfig;
+    storiesToUpdate.set(story.baselineName, {
+      ...story,
+      config: {
+        ...basicConfig,
+        ...storiesToUpdate.get(story.baselineName)?.config,
+        ...config,
+      },
+    });
+  }
+
+  function addStoryTitleAndBaselineName(stories) {
+    return stories.map(story => {
+      return {
+        ...story,
+        storyTitle: getStoryTitle(story),
+        baselineName: getStoryBaselineName(story),
+      };
+    });
+  }
+
+  function allowedProps(config) {
+    const configKeys = Object.keys(config);
+    for (const key of configKeys) {
+      if (!checkSettingsParams.includes(key)) {
+        delete config[key];
+      }
+    }
+    return config;
+  }
+}
+
+module.exports = makeGetStoriesWithConfig;

package/src/handleJsonFile.js

@@ -2,10 +2,11 @@
 
 const fs = require('fs');
 const {resolve} = require('path');
+const {formatters} = require('@applitools/core');
 
-function handleJsonFile(jsonFilePath, formatter) {
+function handleJsonFile(jsonFilePath, summary) {
   const path = resolve(jsonFilePath, 'eyes.json');
-  fs.writeFileSync(path, formatter.toJsonOutput());
+  fs.writeFileSync(path, formatters.toJsonOutput(summary));
   return path;
 }
 

package/src/handleTapFile.js

@@ -2,10 +2,17 @@
 
 const fs = require('fs');
 const {resolve} = require('path');
+const {formatters} = require('@applitools/core');
 
-function handleTapFile(tapFilePath, formatter) {
+function handleTapFile(tapFilePath, summary) {
   const path = resolve(tapFilePath, 'eyes.tap');
-  fs.writeFileSync(path, formatter.asHierarchicTAPString(false, true));
+  fs.writeFileSync(
+    path,
+    formatters.toHierarchicTAPString(summary.results, {
+      includeSubTests: false,
+      markNewAsPassed: true,
+    }),
+  );
   return path;
 }
 

package/src/handleXmlFile.js

@@ -2,10 +2,11 @@
 
 const fs = require('fs');
 const {resolve} = require('path');
+const {formatters} = require('@applitools/core');
 
-function handleXmlFile(xmlFilePath, formatter, {suiteName = 'Eyes Storybook', totalTime} = {}) {
+function handleXmlFile(xmlFilePath, summary, {suiteName = 'Eyes Storybook', totalTime} = {}) {
   const path = resolve(xmlFilePath, 'eyes.xml');
-  fs.writeFileSync(path, formatter.toXmlOutput({suiteName, totalTime}));
+  fs.writeFileSync(path, formatters.toXmlOutput(summary.results, {suiteName, totalTime}));
   return path;
 }
 

package/src/processResults.js

@@ -4,9 +4,8 @@ const chalk = require('chalk');
 const utils = require('@applitools/utils');
 const uniq = require('./uniq');
 const concurrencyMsg = require('./concurrencyMsg');
-const {formatters} = require('@applitools/core');
 
-function processResults({results = [], totalTime, testConcurrency, saveNewTests = true}) {
+function processResults({results, totalTime, testConcurrency, saveNewTests = true}) {
   let outputStr = '\n';
   const pluralize = utils.general.pluralize;
   let testResults = flatten(results.summary.results);
@@ -102,12 +101,11 @@ function processResults({results = [], totalTime, testConcurrency, saveNewTests
     // TODO require from core
     outputStr += `\n${concurrencyMsg}\n`;
   }
-  const formatter = formatters.toJsonOutput(results.summary);
   const exitCode =
     !warnForUnsavedNewTests && passedOrNew.length && !errors.length && !unresolved.length ? 0 : 1;
   return {
     outputStr,
-    formatter,
+    summary: results.summary,
     exitCode,
   };
 }

package/src/renderStories.js

@@ -3,7 +3,6 @@ const getStoryUrl = require('./getStoryUrl');
 const getStoryBaselineName = require('./getStoryBaselineName');
 const ora = require('ora');
 const {presult} = require('@applitools/functional-commons');
-const {shouldRenderIE} = require('./shouldRenderIE');
 
 function makeRenderStories({
   getStoryData,
@@ -17,7 +16,7 @@ function makeRenderStories({
 }) {
   let newPageIdToAdd;
 
-  return async function renderStories(stories, config) {
+  return async function renderStories(stories, isIE) {
     let doneStories = 0;
     const allTestResults = [];
     let allStoriesPromise = Promise.resolve();
@@ -66,7 +65,7 @@ function makeRenderStories({
             getStoryData({
               story,
               storyUrl,
-              renderers: config.renderers,
+              renderers: story.config.renderers,
               page,
               waitBeforeStory: waitBeforeCapture,
             }),
@@ -92,7 +91,7 @@ function makeRenderStories({
               getStoryData({
                 story,
                 storyUrl,
-                renderers: config.renderers,
+                renderers: story.config.renderers,
                 page: newPageObj.page,
                 waitBeforeStory: waitBeforeCapture,
               }),
@@ -113,7 +112,6 @@ function makeRenderStories({
             snapshots: storyData,
             url: storyUrl,
             story,
-            config,
           });
           return onDoneStory(testResults, story);
         } catch (ex) {
@@ -134,11 +132,11 @@ function makeRenderStories({
     }
 
     function updateSpinnerText(number, length) {
-      return `Done ${number} stories out of ${length} ${shouldRenderIE(config) ? '(IE)' : ''}`;
+      return `Done ${number} stories out of ${length} ${isIE ? '(IE)' : ''}`;
     }
 
     function onDoneStory(resultsOrErr, story) {
-      spinner.text = updateSpinnerText(++doneStories, stories.length);
+      spinner.text = updateSpinnerText(++doneStories, stories.length, story.config);
       const title = getStoryBaselineName(story);
       allTestResults.push({title, resultsOrErr});
       return {title, resultsOrErr};

package/src/renderStory.js

@@ -1,6 +1,4 @@
 'use strict';
-const getStoryTitle = require('./getStoryTitle');
-const getStoryBaselineName = require('./getStoryBaselineName');
 const {deprecationWarning} = require('./errMessages');
 const throat = require('throat');
 
@@ -15,10 +13,11 @@ function makeRenderStory({
   serverSettings,
 }) {
   const throttle = throat(storyDataGap);
-  return function renderStory({config, story, snapshots, url}) {
+  return function renderStory({story, snapshots, url}) {
+    const config = story.config;
     const {name, kind, parameters, hasPlayFunction} = story;
-    const baselineName = getStoryBaselineName({name, kind, parameters});
-    const title = getStoryTitle({name, kind, parameters});
+    const baselineName = story.baselineName;
+    const title = story.storyTitle;
     const eyesParameters = (parameters && parameters.eyes) || {};
     const eyesOptions = {
       ...config,
@@ -38,7 +37,6 @@ function makeRenderStory({
       target,
       fully,
       selector,
-      region,
       tag,
       properties,
       ignore,
@@ -111,10 +109,8 @@ function makeRenderStory({
       renderers,
       hooks: scriptHooks,
       sizeMode,
-      target,
+      region: target === 'region' ? selector : undefined,
       fully,
-      selector,
-      region,
       tag,
       sendDom,
       ufgOptions: visualGridOptions,
@@ -134,6 +130,23 @@ function makeRenderStory({
         : undefined,
     };
 
+    return timeItAsync(baselineName, async () => {
+      const {checkAndClose} = await openEyes({settings: openParams});
+      return new Promise((resolve, reject) => {
+        throttle(async () => {
+          try {
+            const checkResults = await checkAndClose({
+              settings: {...checkParams, ...closeSettings, throwEx: false},
+              target: snapshots,
+            });
+            resolve(checkResults);
+          } catch (ex) {
+            reject(ex);
+          }
+        });
+      });
+    }).then(onDoneStory);
+
     function mapAccessibilityRegions(accessabilityRegions) {
       if (!accessabilityRegions) return;
       if (!Array.isArray(accessabilityRegions)) accessabilityRegions = [accessabilityRegions];
@@ -196,23 +209,6 @@ function makeRenderStory({
       }
     }
 
-    return timeItAsync(baselineName, async () => {
-      const {checkAndClose} = await openEyes({settings: openParams});
-      return new Promise((resolve, reject) => {
-        throttle(async () => {
-          try {
-            const checkResults = await checkAndClose({
-              settings: {...checkParams, ...closeSettings, throwEx: false},
-              target: snapshots,
-            });
-            resolve(checkResults);
-          } catch (ex) {
-            reject(ex);
-          }
-        });
-      });
-    }).then(onDoneStory);
-
     function onDoneStory(results) {
       logger.log('finished story', baselineName, 'in', performance[baselineName]);
       return results;