@applitools/eyes-storybook 3.44.1 → 3.44.3

package/CHANGELOG.md

@@ -1,5 +1,82 @@
 # Changelog
 
+## [3.44.3](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-storybook@3.44.2...js/eyes-storybook@3.44.3) (2023-11-07)
+
+
+### Bug Fixes
+
+* add .cmd for storybook binary for windows for local binaries ([#1964](https://github.com/applitools/eyes.sdk.javascript1/issues/1964)) ([b6ee7d9](https://github.com/applitools/eyes.sdk.javascript1/commit/b6ee7d90d13a85f4ccc999cdcbaedb868d94b307))
+
+
+### Dependencies
+
+* @applitools/dom-shared bumped to 1.0.11
+  #### Bug Fixes
+
+  * (java/eyes-appium-java5): fix incorrect stitchMode mapping in checkSettings ([c70428e](https://github.com/applitools/eyes.sdk.javascript1/commit/c70428ec83e26b8b5e398ff11814f8376ca97d56))
+* @applitools/dom-capture bumped to 11.2.4
+  #### Bug Fixes
+
+  * (java/eyes-appium-java5): fix incorrect stitchMode mapping in checkSettings ([c70428e](https://github.com/applitools/eyes.sdk.javascript1/commit/c70428ec83e26b8b5e398ff11814f8376ca97d56))
+
+
+
+* @applitools/dom-snapshot bumped to 4.7.13
+  #### Bug Fixes
+
+  * (java/eyes-appium-java5): fix incorrect stitchMode mapping in checkSettings ([c70428e](https://github.com/applitools/eyes.sdk.javascript1/commit/c70428ec83e26b8b5e398ff11814f8376ca97d56))
+  * handled duplicated style properties in inline style tags ([#2014](https://github.com/applitools/eyes.sdk.javascript1/issues/2014)) ([2f8bada](https://github.com/applitools/eyes.sdk.javascript1/commit/2f8bada9cd44c65a69e54cbd08f57534632f12d2))
+
+
+
+* @applitools/driver bumped to 1.15.0
+  #### Features
+
+  * added warning when driver used with capabilities that may conflict with applitools lib workflow ([#2011](https://github.com/applitools/eyes.sdk.javascript1/issues/2011)) ([081006d](https://github.com/applitools/eyes.sdk.javascript1/commit/081006d879894db03a2713129b66586496b6eb02))
+* @applitools/screenshoter bumped to 3.8.15
+
+* @applitools/nml-client bumped to 1.5.15
+
+* @applitools/ufg-client bumped to 1.9.7
+  #### Bug Fixes
+
+  * added retries on ufg requests that respond with 503 status code ([7d78917](https://github.com/applitools/eyes.sdk.javascript1/commit/7d78917d559fa182c6723ca34cef2118cf08a036))
+* @applitools/spec-driver-webdriver bumped to 1.0.49
+
+* @applitools/spec-driver-selenium bumped to 1.5.63
+
+* @applitools/spec-driver-puppeteer bumped to 1.2.5
+
+* @applitools/ec-client bumped to 1.7.15
+
+* @applitools/core bumped to 4.1.0
+  #### Features
+
+  * added warning when driver used with capabilities that may conflict with applitools lib workflow ([#2011](https://github.com/applitools/eyes.sdk.javascript1/issues/2011)) ([081006d](https://github.com/applitools/eyes.sdk.javascript1/commit/081006d879894db03a2713129b66586496b6eb02))
+
+
+  #### Bug Fixes
+
+  * fixed issue that caused dom snapshots to be taken for different viewport sizes when layout breakpoints were explicitly turned off ([4121876](https://github.com/applitools/eyes.sdk.javascript1/commit/4121876189f133b6023cfea52ca91c02c31079fb))
+
+
+
+
+## [3.44.2](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-storybook@3.44.1...js/eyes-storybook@3.44.2) (2023-10-30)
+
+
+### Bug Fixes
+
+* docs for eyes setup and concurrency message output ([#1953](https://github.com/applitools/eyes.sdk.javascript1/issues/1953)) ([13704da](https://github.com/applitools/eyes.sdk.javascript1/commit/13704dac39fa899c5e8bdb268539cd46aee5ccfb))
+
+
+### Dependencies
+
+* @applitools/core bumped to 4.0.2
+  #### Bug Fixes
+
+  * generate safe selectors as close as possible to taking dom snapshot ([#1987](https://github.com/applitools/eyes.sdk.javascript1/issues/1987)) ([102208b](https://github.com/applitools/eyes.sdk.javascript1/commit/102208b909c0b149808f6e4c24a0a662305b1b78))
+
 ## [3.44.1](https://github.com/applitools/eyes.sdk.javascript1/compare/js/eyes-storybook@3.44.0...js/eyes-storybook@3.44.1) (2023-10-25)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-storybook",
-  "version": "3.44.1",
+  "version": "3.44.3",
   "description": "",
   "keywords": [
     "applitools",
@@ -28,10 +28,11 @@
     "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:versions": "yarn build && yarn test:e2e:versions && yarn lint",
+    "test:e2e": "MOCHA_GROUP=e2e run --top-level mocha --no-timeouts --trace-warnings 'test/e2e/*.e2e.test.js'",
+    "test:e2e:versions": "MOCHA_GROUP=e2e_versions run --top-level mocha --no-timeouts --trace-warnings 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:sanity": "run --top-level mocha --no-timeouts --trace-warnings '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",
@@ -50,16 +51,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"
+    "postinstall": "node src/postinstall",
+    "up:framework": "yarn add --dev --caret @storybook/react${APPLITOOLS_FRAMEWORK_VERSION:+@$APPLITOOLS_FRAMEWORK_VERSION}"
   },
   "dependencies": {
-    "@applitools/core": "4.0.1",
-    "@applitools/driver": "1.14.4",
+    "@applitools/core": "4.1.0",
+    "@applitools/driver": "1.15.0",
     "@applitools/functional-commons": "1.6.0",
     "@applitools/logger": "2.0.12",
     "@applitools/monitoring-commons": "1.0.19",
-    "@applitools/spec-driver-puppeteer": "1.2.4",
-    "@applitools/ufg-client": "1.9.6",
+    "@applitools/spec-driver-puppeteer": "1.2.5",
+    "@applitools/ufg-client": "1.9.7",
     "@applitools/utils": "1.6.2",
     "boxen": "4.2.0",
     "chalk": "3.0.0",
@@ -73,7 +75,7 @@
     "yargs": "17.7.2"
   },
   "devDependencies": {
-    "@applitools/bongo": "^5.7.0",
+    "@applitools/bongo": "^5.7.4",
     "@applitools/sdk-shared": "0.9.15",
     "@applitools/snaptdout": "^1.0.1",
     "@applitools/test-server": "^1.2.2",

package/src/concurrencyMsg.js

@@ -4,6 +4,6 @@ const chalk = require('chalk');
 module.exports = chalk.yellow(`
 Important notice: Your Applitools visual tests are currently running with a concurrency value of 5.
 This means that only up to 5 visual tests can run in parallel, and therefore the execution might be slower.
-If your Applitools license supports a higher concurrency level, learn how to configure it here: https://www.npmjs.com/package/@applitools/eyes-storybook#concurrency.
+If your Applitools license supports a higher concurrency level, set the "testConcurrency" parameter as explained here: https://applitools.com/docs/api-ref/sdk-api/storybook/config.
 Need a higher concurrency in your account? Email us @ sdr@applitools.com with your required concurrency level.
 `);

package/src/findNpmModuleCommandPath.js

@@ -9,16 +9,9 @@ const path = require('path');
  * @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' : ''),
-    );
+    const commandPath = path.join(checkRootPath, 'node_modules', '.bin', npmModuleCommand);
     if (await doesFileExist(commandPath)) return commandPath;
 
     const nextPath = path.dirname(checkRootPath);

package/src/utils/determineStorybookVersion.js

@@ -0,0 +1,34 @@
+const {resolve} = require('path');
+const fs = require('fs');
+const findNpmModuleCommandPath = require('../findNpmModuleCommandPath');
+
+async function determineStorybookVersion({packagePath, isWindows}) {
+  let sbArg,
+    storybookPath,
+    isVersion7 = false;
+
+  const commandV6 = 'start-storybook' + (isWindows ? '.cmd' : '');
+  const commandV7 = 'sb' + (isWindows ? '.cmd' : '');
+  const storybookPathV6 = resolve(packagePath, 'node_modules/.bin', commandV6);
+  const storybookPathV7 = resolve(packagePath, 'node_modules/.bin', commandV7);
+
+  // 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(commandV6, packagePath);
+    if (!storybookPath) {
+      storybookPath = await findNpmModuleCommandPath(commandV7, packagePath);
+      isVersion7 = true;
+      sbArg = 'dev';
+    }
+  }
+
+  return {storybookPath, isVersion7, sbArg};
+}
+module.exports = determineStorybookVersion;

package/src/validateAndPopulateConfig.js

@@ -12,8 +12,7 @@ const {
 const startStorybookServer = require('./startStorybookServer');
 const {isIE} = require('./shouldRenderIE');
 const {makeLogger} = require('@applitools/logger');
-const findNpmModuleCommandPath = require('./findNpmModuleCommandPath');
-const {resolve} = require('path');
+const determineStorybookVersion = require('./utils/determineStorybookVersion');
 
 async function validateAndPopulateConfig({config, packagePath = '', logger = makeLogger()}) {
   if (!config.apiKey) {
@@ -22,7 +21,10 @@ async function validateAndPopulateConfig({config, packagePath = '', logger = mak
 
   const packageJsonPath = `${packagePath}/package.json`;
   const packageJson = fs.existsSync(packageJsonPath) ? require(packageJsonPath) : undefined;
-  const {storybookPath, isVersion7, sbArg} = await determineStorybookVersion(packagePath);
+  const {storybookPath, isVersion7, sbArg} = await determineStorybookVersion({
+    packagePath,
+    isWindows: process.platform.startsWith('win'),
+  });
   logger.log(
     `[validateAndPopulateConfig] storybookPath=${storybookPath} isVersion7=${isVersion7} sbArg=${sbArg}`,
   );
@@ -76,34 +78,4 @@ async function validateAndPopulateConfig({config, packagePath = '', logger = mak
   }
   return isVersion7;
 }
-
-async function determineStorybookVersion(packagePath) {
-  let sbArg,
-    storybookPath,
-    isVersion7 = false;
-
-  const storybookPathV6 = resolve(packagePath, 'node_modules/.bin/start-storybook');
-  const storybookPathV7 = resolve(packagePath, 'node_modules/.bin/sb');
-
-  // 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;
-    }
-  }
-
-  return {storybookPath, isVersion7, sbArg};
-}
 module.exports = validateAndPopulateConfig;