@applitools/eyes-storybook 3.35.0 → 3.37.0

package/CHANGELOG.md

@@ -4,6 +4,119 @@
 
 
 
+## [3.37.0](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-storybook@3.36.0...js/eyes-storybook@3.37.0) (2023-07-18)
+
+
+### Features
+
+* support retries on stuck requests ([#1773](https://github.com/applitools/eyes.sdk.javascript1/issues/1773)) ([4db470e](https://github.com/applitools/eyes.sdk.javascript1/commit/4db470ee6829c13cfaf7e521ef91e20854266edd))
+
+
+### Bug Fixes
+
+* fix lint config and remove extranous deps ([aea605c](https://github.com/applitools/eyes.sdk.javascript1/commit/aea605c4a1d6cca37d84b464af369cdbff3c6234))
+
+
+### Dependencies
+
+* @applitools/req bumped from 1.4.0 to 1.5.0
+  #### Features
+
+  * support retries on stuck requests ([be673bb](https://github.com/applitools/eyes.sdk.javascript1/commit/be673bb505c9b21d6aea37d86e88513e95e3cb02))
+* @applitools/ufg-client bumped from 1.4.1 to 1.5.0
+  #### Features
+
+  * support retries on stuck requests ([be673bb](https://github.com/applitools/eyes.sdk.javascript1/commit/be673bb505c9b21d6aea37d86e88513e95e3cb02))
+
+
+
+* @applitools/core bumped to 3.6.2
+
+* @applitools/core-base bumped from 1.4.0 to 1.4.1
+
+* @applitools/ec-client bumped from 1.7.0 to 1.7.1
+
+* @applitools/tunnel-client bumped from 1.1.0 to 1.1.1
+
+* @applitools/nml-client bumped from 1.5.2 to 1.5.3
+
+
+## [3.36.0](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-storybook-v3.35.1...js/eyes-storybook@3.36.0) (2023-07-05)
+
+
+### Features
+
+* added support for storybook installed in parent module ([#1060](https://github.com/applitools/eyes.sdk.javascript1/issues/1060)) ([e2b9fbb](https://github.com/applitools/eyes.sdk.javascript1/commit/e2b9fbbb41938b2363a2c675874ad28e41859076))
+* support dns caching ([#1680](https://github.com/applitools/eyes.sdk.javascript1/issues/1680)) ([9bbff34](https://github.com/applitools/eyes.sdk.javascript1/commit/9bbff34f50c9d18758b55a6bcb45571ca1148180))
+
+
+### Dependencies
+
+* @applitools/core bumped from 3.4.0 to 3.5.0
+  #### Features
+
+  * added auto applitools lib detection ([#1707](https://github.com/applitools/eyes.sdk.javascript1/issues/1707)) ([7d439b5](https://github.com/applitools/eyes.sdk.javascript1/commit/7d439b52af55f3b0596c9d35d6ba85c717448023))
+  * support dns caching ([#1680](https://github.com/applitools/eyes.sdk.javascript1/issues/1680)) ([9bbff34](https://github.com/applitools/eyes.sdk.javascript1/commit/9bbff34f50c9d18758b55a6bcb45571ca1148180))
+
+
+  #### Bug Fixes
+
+  * some fix ([660a137](https://github.com/applitools/eyes.sdk.javascript1/commit/660a1376a49dd28f8f399690502cd3d1f77665fa))
+
+
+
+* @applitools/core-base bumped from 1.2.1 to 1.3.0
+  #### Features
+
+  * support dns caching ([#1680](https://github.com/applitools/eyes.sdk.javascript1/issues/1680)) ([9bbff34](https://github.com/applitools/eyes.sdk.javascript1/commit/9bbff34f50c9d18758b55a6bcb45571ca1148180))
+
+
+
+* @applitools/req bumped from 1.3.3 to 1.4.0
+  #### Features
+
+  * support dns caching ([#1680](https://github.com/applitools/eyes.sdk.javascript1/issues/1680)) ([9bbff34](https://github.com/applitools/eyes.sdk.javascript1/commit/9bbff34f50c9d18758b55a6bcb45571ca1148180))
+* @applitools/driver bumped from 1.12.4 to 1.13.0
+  #### Features
+
+  * added auto applitools lib detection ([#1707](https://github.com/applitools/eyes.sdk.javascript1/issues/1707)) ([7d439b5](https://github.com/applitools/eyes.sdk.javascript1/commit/7d439b52af55f3b0596c9d35d6ba85c717448023))
+* @applitools/ec-client bumped from 1.5.0 to 1.6.0
+  #### Features
+
+  * added support of regional execution cloud servers ([#1711](https://github.com/applitools/eyes.sdk.javascript1/issues/1711)) ([2e26c69](https://github.com/applitools/eyes.sdk.javascript1/commit/2e26c6944bb15f6121fb37c1dba95aba162c1f6a))
+  * support dns caching ([#1680](https://github.com/applitools/eyes.sdk.javascript1/issues/1680)) ([9bbff34](https://github.com/applitools/eyes.sdk.javascript1/commit/9bbff34f50c9d18758b55a6bcb45571ca1148180))
+
+
+  #### Bug Fixes
+
+  * fixed auto tunnel cleanup after unexpected end of the process ([3c1ad08](https://github.com/applitools/eyes.sdk.javascript1/commit/3c1ad0837d2d3560becc6d89370aa878becb3270))
+
+
+
+* @applitools/tunnel-client bumped from 0.1.1 to 1.0.0
+  #### Features
+
+  * added binaries and made them available in jfrog ([92033fe](https://github.com/applitools/eyes.sdk.javascript1/commit/92033fed7edc58bbc4a4e37269068418fe3afc3d))
+  * release as 1.0.0 ([93bf312](https://github.com/applitools/eyes.sdk.javascript1/commit/93bf31205b07d19bc2cb4f50b974c7bad0f49cea))
+
+
+
+* @applitools/ufg-client bumped from 1.2.22 to 1.3.0
+  #### Features
+
+  * support dns caching ([#1680](https://github.com/applitools/eyes.sdk.javascript1/issues/1680)) ([9bbff34](https://github.com/applitools/eyes.sdk.javascript1/commit/9bbff34f50c9d18758b55a6bcb45571ca1148180))
+
+
+
+* @applitools/spec-driver-webdriver bumped from 1.0.36 to 1.0.37
+
+* @applitools/nml-client bumped from 1.5.0 to 1.5.1
+
+* @applitools/screenshoter bumped from 3.8.1 to 3.8.2
+
+* @applitools/spec-driver-puppeteer bumped from 1.1.67 to 1.1.68
+
+
 ## 3.35.0 - 2023/6/13
 
 ### Features

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-storybook",
-  "version": "3.35.0",
+  "version": "3.37.0",
   "description": "",
   "keywords": [
     "applitools",
@@ -18,30 +18,24 @@
   },
   "license": "SEE LICENSE IN LICENSE",
   "author": "Applitools Team <team@applitools.com>",
-  "aliases": [
-    "storybook"
-  ],
-  "bin": {
-    "eyes-storybook": "./bin/eyes-storybook.js"
-  },
+  "bin": "./bin/eyes-storybook.js",
   "files": [
     "src",
     "bin",
     "dist"
   ],
   "scripts": {
-    "lint": "eslint '**/*.js'",
+    "lint": "run --top-level eslint '**/*.js'",
     "build": "rollup -c rollup.config.js",
     "build:heavy": "node scripts/bitmap.js",
     "test": "yarn build && yarn test:mocha && yarn lint",
-    "test:sanity": "yarn test:unit && yarn test:it",
-    "test:mocha": "mocha --no-timeouts --trace-warnings 'test/{unit,it,e2e}/*.test.js'",
-    "test:unit": "mocha --no-timeouts --trace-warnings 'test/unit/*.test.js'",
-    "test:it": "mocha --no-timeouts --trace-warnings 'test/it/*.test.js'",
-    "test:versions": "yarn build && yarn test:e2e:versions && yarn lint",
-    "test:e2e": "mocha --no-timeouts --trace-warnings 'test/e2e/*.e2e.test.js'",
+    "test:mocha": "run --top-level mocha --no-timeouts --trace-warnings 'test/{unit,it,e2e}/*.test.js'",
+    "test:unit": "run --top-level mocha --no-timeouts --trace-warnings 'test/unit/*.test.js'",
+    "test:it": "run --top-level mocha --no-timeouts --trace-warnings 'test/it/*.test.js'",
+    "test:versions": "run --top-level yarn build && yarn test:e2e:versions && yarn lint",
+    "test:e2e": "run --top-level mocha --no-timeouts --trace-warnings 'test/e2e/*.e2e.test.js'",
     "test:e2e:versions": "npx mocha --no-timeouts --trace-warnings --require test/fixtures/storybook-versions/mochaHooks.js test/versions/*.e2e.versions.test.js",
-    "test:e2e:versions_local": "STORYBOOK_VERSION=latest npx mocha --no-timeouts --trace-warnings --require test/fixtures/storybook-versions/mochaHooks.js test/versions/*.e2e.versions.test.js",
+    "test:e2e:versions_local": "APPLITOOLS_FRAMEWORK_VERSION=latest npx mocha --no-timeouts --trace-warnings --require test/fixtures/storybook-versions/mochaHooks.js test/versions/*.e2e.versions.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",
@@ -60,66 +54,44 @@
     "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",
-    "gh:publish": "gh workflow run publish-storybook.yml --ref $(git rev-parse --abbrev-ref HEAD)",
-    "prepublish:setup": "echo 'setup is a no-op. Move along, nothing to see here.'",
-    "deps": "bongo deps",
-    "postinstall": "node src/postinstall",
-    "preversion": "bongo preversion --verifyPendingChanges",
-    "version": "bongo version --withPendingChanges",
-    "postversion": "bongo postversion"
-  },
-  "husky": {
-    "hooks": {
-      "pre-push": "yarn bongo lint"
-    }
+    "postinstall": "node src/postinstall"
   },
   "dependencies": {
-    "@applitools/core": "3.2.1",
-    "@applitools/driver": "1.12.1",
+    "@applitools/core": "^3.6.2",
+    "@applitools/driver": "^1.13.1",
     "@applitools/functional-commons": "1.6.0",
-    "@applitools/logger": "2.0.2",
+    "@applitools/logger": "^2.0.5",
     "@applitools/monitoring-commons": "1.0.19",
-    "@applitools/spec-driver-puppeteer": "1.1.64",
-    "@applitools/test-server": "1.2.2",
-    "@applitools/ufg-client": "1.2.18",
-    "@applitools/utils": "1.3.37",
+    "@applitools/spec-driver-puppeteer": "^1.1.69",
+    "@applitools/ufg-client": "^1.5.0",
+    "@applitools/utils": "^1.5.0",
     "boxen": "4.2.0",
     "chalk": "3.0.0",
     "detect-port": "1.3.0",
     "lodash.flatten": "4.4.0",
     "lodash.pick": "4.4.0",
     "ora": "3.4.0",
-    "puppeteer": "19.5.0",
+    "puppeteer": "19.8.0",
     "strip-ansi": "6.0.0",
     "throat": "6.0.1",
-    "yargs": "15.4.1"
+    "yargs": "17.7.2"
   },
   "devDependencies": {
-    "@applitools/bongo": "^4.0.0",
+    "@applitools/bongo": "^5.0.4",
     "@applitools/sdk-shared": "0.9.15",
     "@applitools/snaptdout": "^1.0.1",
+    "@applitools/test-server": "^1.2.2",
+    "@babel/eslint-parser": "^7.22.9",
     "@storybook/addon-interactions": "^6.4.18",
     "@storybook/react": "^6.4.18",
     "@storybook/testing-library": "^0.0.9",
     "@testing-library/dom": "^5.6.1",
-    "babel-core": "^6.26.3",
-    "babel-eslint": "^10.1.0",
-    "babel-loader": "^8.0.6",
-    "babel-preset-env": "^1.7.0",
-    "babel-preset-react": "^6.24.1",
     "bitmap-manipulation": "^2.0.0",
     "chai": "^4.2.0",
     "core-js": "^3.6.1",
-    "eslint": "^6.6.0",
-    "eslint-plugin-mocha-no-only": "^1.1.0",
-    "eslint-plugin-node": "^10.0.0",
-    "eslint-plugin-prettier": "^3.1.1",
     "express": "^4.17.1",
     "filenamify": "^4.1.0",
-    "husky": "^4.3.8",
-    "mocha": "^8.0.1",
     "node-fetch": "^2.6.0",
-    "prettier": "^1.19.1",
     "react": "^16.12.0",
     "react-dom": "^16.12.0",
     "rollup": "^1.28.0",
@@ -127,6 +99,9 @@
     "ua-parser-js": "^0.7.21"
   },
   "engines": {
-    "node": ">=12.13.0"
+    "node": ">=14.15.0"
+  },
+  "publishConfig": {
+    "access": "public"
   }
-}
+}

package/src/cli.js

@@ -18,7 +18,7 @@ const {presult} = require('@applitools/functional-commons');
 const chalk = require('chalk');
 const {performance, timeItAsync} = makeTiming();
 
-(async function() {
+(async function () {
   try {
     const argv = yargs
       .usage('Usage: $0 [options]')

package/src/eyesStorybook.js

@@ -47,7 +47,14 @@ async function eyesStorybook({
     : Number(process.env.APPLITOOLS_CONCURRENT_TABS);
   logger.log(`Running with ${CONCURRENT_TABS} concurrent tabs`);
 
-  const {storybookUrl, readStoriesTimeout, reloadPagePerStory, proxy, testConcurrency} = config;
+  const {
+    storybookUrl,
+    readStoriesTimeout,
+    reloadPagePerStory,
+    proxy,
+    testConcurrency,
+    useDnsCache,
+  } = config;
 
   let iframeUrl;
   try {
@@ -57,6 +64,7 @@ async function eyesStorybook({
     throw new Error(`Storybook URL is not valid: ${storybookUrl}`);
   }
   const agentId = `eyes-storybook/${require('../package.json').version}`;
+  process.env.PUPPETEER_DISABLE_HEADLESS_WARNING = true;
   const browser = await puppeteer.launch(config.puppeteerOptions);
   logger.log('browser launched');
   const page = await browser.newPage();
@@ -78,6 +86,7 @@ async function eyesStorybook({
     serverUrl: config.serverUrl,
     apiKey: config.apiKey,
     agentId,
+    useDnsCache,
   };
   const [error, account] = await presult(core.getAccountInfo({settings, logger}));
 
@@ -96,6 +105,7 @@ async function eyesStorybook({
       ...account,
       proxy,
       concurrency: testConcurrency,
+      useDnsCache,
     },
     logger,
   });

package/src/findNpmModuleCommandPath.js

@@ -0,0 +1,46 @@
+const fs = require('fs');
+const path = require('path');
+
+/**
+ * Find the path to the given npm command.
+ * It goes recursively up the directory tree until it finds the command, like npm itself does.
+ * @param {string} npmModuleCommand - The npm command to find.
+ * @param {string} packageJsonDirPath - the directory in which to start searching for the command.
+ * @returns {Promise<string|null>} The path to the command.
+ */
+module.exports = async function findNpmModuleCommandPath(npmModuleCommand, packageJsonDirPath) {
+  const isWindows = process.platform.startsWith('win');
+
+  let checkRootPath = path.resolve(packageJsonDirPath);
+  while (checkRootPath !== '') {
+    const commandPath = path.join(
+      checkRootPath,
+      'node_modules',
+      '.bin',
+      npmModuleCommand + (isWindows ? '.cmd' : ''),
+    );
+    if (await doesFileExist(commandPath)) return commandPath;
+
+    const nextPath = path.dirname(checkRootPath);
+    if (nextPath === checkRootPath) break; // the top of the file tree is reached
+
+    checkRootPath = nextPath;
+  }
+
+  return null;
+};
+
+/**
+ * Check whether a file exists asynchronously.
+ * @param {string} filePath
+ * @returns {Promise<boolean>}
+ */
+function doesFileExist(filePath) {
+  return new Promise(resolve => {
+    fs.stat(filePath, (err, stats) => {
+      if (err) resolve(false);
+      else if (stats != null && stats.isFile()) resolve(true);
+      else resolve(false);
+    });
+  });
+}

package/src/processResults.js

@@ -79,10 +79,10 @@ function processResults({
       `\nA total of ${unresolved.length} difference${pluralize(unresolved, [
         's were',
         ' was',
-      ])} found and ${errors.length} stor${pluralize(errors, [
-        'ies',
-        'y',
-      ])} failed for ${pluralize(errors, ['', 'an '])}unexpected error${pluralize(errors)}.`,
+      ])} found and ${errors.length} stor${pluralize(errors, ['ies', 'y'])} failed for ${pluralize(
+        errors,
+        ['', 'an '],
+      )}unexpected error${pluralize(errors)}.`,
     );
   } else if (warnForUnsavedNewTests) {
     const countText =

package/src/storybookConnector.js

@@ -15,7 +15,7 @@ class StorybookConnector extends EventEmitter {
     sbArg,
   }) {
     super();
-    this._storybookPath = `${storybookPath}${isWindows ? '.cmd' : ''}`;
+    this._storybookPath = storybookPath;
     this._storybookPort = storybookPort;
     this._storybookHost = storybookHost;
     this._storybookConfigDir = storybookConfigDir;

package/src/validateAndPopulateConfig.js

@@ -11,13 +11,9 @@ const {
 } = require('./errMessages');
 const startStorybookServer = require('./startStorybookServer');
 const {isIE} = require('./shouldRenderIE');
-const {resolve} = require('path');
-const {exec} = require('child_process');
-const {promisify: p} = require('util');
-const pexec = p(exec);
-// eslint-disable-next-line
-const semver = require('semver');
 const {makeLogger} = require('@applitools/logger');
+const findNpmModuleCommandPath = require('./findNpmModuleCommandPath');
+const {resolve} = require('path');
 
 async function validateAndPopulateConfig({config, packagePath = '', logger = makeLogger()}) {
   if (!config.apiKey) {
@@ -82,23 +78,30 @@ async function validateAndPopulateConfig({config, packagePath = '', logger = mak
 }
 
 async function determineStorybookVersion(packagePath) {
-  let storybookPath,
-    sbArg,
+  let sbArg,
+    storybookPath,
     isVersion7 = false;
+
   const storybookPathV6 = resolve(packagePath, 'node_modules/.bin/start-storybook');
   const storybookPathV7 = resolve(packagePath, 'node_modules/.bin/sb');
 
-  if (fs.existsSync(storybookPathV7)) {
-    const version = await pexec(`${storybookPathV7} --version`);
-    if (semver.satisfies(version.stdout, '<7.0.0')) {
-      storybookPath = storybookPathV6;
-    } else {
-      storybookPath = storybookPathV7;
-      sbArg = 'dev';
+  // first we look for the binaries in the local node_modules/.bin folder in case there are multiple versions of storybook installed
+  if (fs.existsSync(storybookPathV6)) {
+    storybookPath = storybookPathV6;
+  } else if (fs.existsSync(storybookPathV7)) {
+    storybookPath = storybookPathV7;
+    isVersion7 = true;
+    sbArg = 'dev';
+  } else {
+    // the binary is not in the local node_modules/.bin folder, so we need to find it
+    storybookPath = await findNpmModuleCommandPath('start-storybook', packagePath);
+    if (!storybookPath) {
+      storybookPath = await findNpmModuleCommandPath('sb', packagePath);
       isVersion7 = true;
+      sbArg = 'dev';
+    } else {
+      isVersion7 = false;
     }
-  } else {
-    storybookPath = storybookPathV6;
   }
 
   return {storybookPath, isVersion7, sbArg};

package/src/wrapBundle.js

@@ -2,7 +2,7 @@
 
 function wrapBundle(filename) {
   return {
-    generateBundle: function(_outputOptions, bundle) {
+    generateBundle: function (_outputOptions, bundle) {
       const bundleFile = bundle[`${filename}.js`];
 
       bundleFile.code = `

package/src/yargsOptions.js

@@ -54,7 +54,7 @@ module.exports = {
       'A string that represents a story title or a regex (starts and ends with /) to match stories title',
     requiresArg: false,
     string: true,
-    coerce: function(arg) {
+    coerce: function (arg) {
       if (arg.startsWith('/') && arg.endsWith('/')) {
         // create a regex and remove slashes from the start and end of the input
         return new RegExp(arg.substring(1, arg.length - 1));